feat(client-resiliencehub): Introduced the ability to filter applicat…

…ions by their last assessment date and time and have included metrics for the application's estimated workload Recovery Time Objective (RTO) and estimated workload Recovery Point Objective (RPO).
aws · Oct 30, 2023 · 4b0a2d0 · 4b0a2d0
1 parent d05a332
commit 4b0a2d0
Show file tree

Hide file tree

Showing 11 changed files with 364 additions and 214 deletions.
diff --git a/clients/client-resiliencehub/src/commands/AddDraftAppVersionResourceMappingsCommand.ts b/clients/client-resiliencehub/src/commands/AddDraftAppVersionResourceMappingsCommand.ts
@@ -45,8 +45,7 @@ export interface AddDraftAppVersionResourceMappingsCommandOutput
 
 /**
  * @public
- * <p>Adds the resource mapping for the draft application version. You can also update an
- *       existing resource mapping to a new physical resource.</p>
+ * <p>Adds the source of resource-maps to the draft version of an application. During assessment, Resilience Hub will use these resource-maps to resolve the latest physical ID for each resource in the application template. For more information about different types of resources suported by Resilience Hub and how to add them in your application, see <a href="https://docs.aws.amazon.com/resilience-hub/latest/userguide/how-app-manage.html">Step 2: How is your application managed?</a> in the Resilience Hub User Guide.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-resiliencehub/src/commands/CreateAppCommand.ts b/clients/client-resiliencehub/src/commands/CreateAppCommand.ts
@@ -43,10 +43,9 @@ export interface CreateAppCommandOutput extends CreateAppResponse, __MetadataBea
 /**
  * @public
  * <p>Creates an Resilience Hub application. An Resilience Hub application is a
- *       collection of Amazon Web Services resources structured to prevent and recover Amazon Web Services application disruptions. To describe a Resilience Hub application, you provide an
- *       application name, resources from one or more CloudFormation stacks, Resource Groups, Terraform state files, AppRegistry applications, and an appropriate
- *       resiliency policy. In addition, you can also add resources that are located on Amazon Elastic Kubernetes Service (Amazon EKS) clusters as optional resources. For more information
- *       about the number of resources supported per application, see <a href="https://docs.aws.amazon.com/general/latest/gr/resiliencehub.html#limits_resiliencehub">Service
+ *       collection of Amazon Web Services resources structured to prevent and recover Amazon Web Services application disruptions. To describe a Resilience Hub application,
+ *       you provide an application name, resources from one or more CloudFormation stacks, Resource Groups, Terraform state files, AppRegistry applications, and an appropriate
+ *       resiliency policy. In addition, you can also add resources that are located on Amazon Elastic Kubernetes Service (Amazon EKS) clusters as optional resources. For more information about the number of resources supported per application, see <a href="https://docs.aws.amazon.com/general/latest/gr/resiliencehub.html#limits_resiliencehub">Service
  *       quotas</a>.</p>
  *          <p>After you create an Resilience Hub application, you publish it so that you can run a resiliency
  *       assessment on it. You can then use recommendations from the assessment to improve resiliency
@@ -117,6 +116,8 @@ export interface CreateAppCommandOutput extends CreateAppResponse, __MetadataBea
  * //     ],
  * //     driftStatus: "STRING_VALUE",
  * //     lastDriftEvaluationTime: new Date("TIMESTAMP"),
+ * //     rtoInSecs: Number("int"),
+ * //     rpoInSecs: Number("int"),
  * //   },
  * // };
  *

diff --git a/clients/client-resiliencehub/src/commands/CreateResiliencyPolicyCommand.ts b/clients/client-resiliencehub/src/commands/CreateResiliencyPolicyCommand.ts
@@ -43,6 +43,13 @@ export interface CreateResiliencyPolicyCommandOutput extends CreateResiliencyPol
 /**
  * @public
  * <p>Creates a resiliency policy for an application.</p>
+ *          <note>
+ *             <p>Resilience Hub allows you to provide a value of zero for <code>rtoInSecs</code> and
+ *           <code>rpoInSecs</code> of your resiliency policy. But, while assessing your application, the lowest possible assessment result is near zero. Hence, if you provide value
+ *         zero for <code>rtoInSecs</code> and <code>rpoInSecs</code>, the estimated workload RTO and estimated workload RPO result will be near zero and the <b>Compliance
+ *           status</b> for your application will be set to <b>Policy
+ *           breached</b>.</p>
+ *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-resiliencehub/src/commands/DescribeAppCommand.ts b/clients/client-resiliencehub/src/commands/DescribeAppCommand.ts
@@ -81,6 +81,8 @@ export interface DescribeAppCommandOutput extends DescribeAppResponse, __Metadat
  * //     ],
  * //     driftStatus: "STRING_VALUE",
  * //     lastDriftEvaluationTime: new Date("TIMESTAMP"),
+ * //     rtoInSecs: Number("int"),
+ * //     rpoInSecs: Number("int"),
  * //   },
  * // };
  *

diff --git a/clients/client-resiliencehub/src/commands/DescribeResiliencyPolicyCommand.ts b/clients/client-resiliencehub/src/commands/DescribeResiliencyPolicyCommand.ts
@@ -41,9 +41,9 @@ export interface DescribeResiliencyPolicyCommandOutput extends DescribeResilienc
 
 /**
  * @public
- * <p>Describes a specified resiliency policy for an Resilience Hub application. The returned
- *       policy object includes creation time, data location constraints, the Amazon Resource Name
- *       (ARN) for the policy, tags, tier, and more.</p>
+ * <p>Describes a specified resiliency policy for an Resilience Hub application. The
+ *       returned policy object includes creation time, data location constraints, the Amazon Resource
+ *       Name (ARN) for the policy, tags, tier, and more.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-resiliencehub/src/commands/ListAppsCommand.ts b/clients/client-resiliencehub/src/commands/ListAppsCommand.ts
@@ -58,6 +58,9 @@ export interface ListAppsCommandOutput extends ListAppsResponse, __MetadataBeare
  *   maxResults: Number("int"),
  *   name: "STRING_VALUE",
  *   appArn: "STRING_VALUE",
+ *   fromLastAssessmentTime: new Date("TIMESTAMP"),
+ *   toLastAssessmentTime: new Date("TIMESTAMP"),
+ *   reverseOrder: true || false,
  * };
  * const command = new ListAppsCommand(input);
  * const response = await client.send(command);
@@ -73,6 +76,9 @@ export interface ListAppsCommandOutput extends ListAppsResponse, __MetadataBeare
  * //       assessmentSchedule: "STRING_VALUE",
  * //       status: "STRING_VALUE",
  * //       driftStatus: "STRING_VALUE",
+ * //       lastAppComplianceEvaluationTime: new Date("TIMESTAMP"),
+ * //       rtoInSecs: Number("int"),
+ * //       rpoInSecs: Number("int"),
  * //     },
  * //   ],
  * //   nextToken: "STRING_VALUE",

diff --git a/clients/client-resiliencehub/src/commands/UpdateAppCommand.ts b/clients/client-resiliencehub/src/commands/UpdateAppCommand.ts
@@ -99,6 +99,8 @@ export interface UpdateAppCommandOutput extends UpdateAppResponse, __MetadataBea
  * //     ],
  * //     driftStatus: "STRING_VALUE",
  * //     lastDriftEvaluationTime: new Date("TIMESTAMP"),
+ * //     rtoInSecs: Number("int"),
+ * //     rpoInSecs: Number("int"),
  * //   },
  * // };
  *

diff --git a/clients/client-resiliencehub/src/commands/UpdateResiliencyPolicyCommand.ts b/clients/client-resiliencehub/src/commands/UpdateResiliencyPolicyCommand.ts
@@ -42,6 +42,15 @@ export interface UpdateResiliencyPolicyCommandOutput extends UpdateResiliencyPol
 /**
  * @public
  * <p>Updates a resiliency policy.</p>
+ *          <note>
+ *             <p>Resilience Hub allows you to provide a value of zero for <code>rtoInSecs</code> and
+ *           <code>rpoInSecs</code> of your resiliency policy. But, while assessing your application,
+ *         the lowest possible assessment result is near zero. Hence, if you provide value
+ *         zero for <code>rtoInSecs</code> and <code>rpoInSecs</code>, the estimated workload RTO and
+ *         estimated workload RPO result will be near zero and the <b>Compliance
+ *           status</b> for your application will be set to <b>Policy
+ *           breached</b>.</p>
+ *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript