Accepts the resource grouping recommendations suggested by Resilience Hub for your application.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ResiliencehubClient, AcceptResourceGroupingRecommendationsCommand } from "@aws-sdk/client-resiliencehub"; // ES Modules import + * // const { ResiliencehubClient, AcceptResourceGroupingRecommendationsCommand } = require("@aws-sdk/client-resiliencehub"); // CommonJS import + * const client = new ResiliencehubClient(config); + * const input = { // AcceptResourceGroupingRecommendationsRequest + * appArn: "STRING_VALUE", // required + * entries: [ // AcceptGroupingRecommendationEntries // required + * { // AcceptGroupingRecommendationEntry + * groupingRecommendationId: "STRING_VALUE", // required + * }, + * ], + * }; + * const command = new AcceptResourceGroupingRecommendationsCommand(input); + * const response = await client.send(command); + * // { // AcceptResourceGroupingRecommendationsResponse + * // appArn: "STRING_VALUE", // required + * // failedEntries: [ // FailedGroupingRecommendationEntries // required + * // { // FailedGroupingRecommendationEntry + * // groupingRecommendationId: "STRING_VALUE", // required + * // errorMessage: "STRING_VALUE", // required + * // }, + * // ], + * // }; + * + * ``` + * + * @param AcceptResourceGroupingRecommendationsCommandInput - {@link AcceptResourceGroupingRecommendationsCommandInput} + * @returns {@link AcceptResourceGroupingRecommendationsCommandOutput} + * @see {@link AcceptResourceGroupingRecommendationsCommandInput} for command's `input` shape. + * @see {@link AcceptResourceGroupingRecommendationsCommandOutput} for command's `response` shape. + * @see {@link ResiliencehubClientResolvedConfig | config} for ResiliencehubClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have permissions to perform the requested operation. The user or role that is + * making the request must have at least one IAM permissions policy attached that grants the + * required permissions.
+ * + * @throws {@link InternalServerException} (server fault) + *This exception occurs when there is an internal failure in the Resilience Hub + * service.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *This exception occurs when the specified resource could not be found.
+ * + * @throws {@link ThrottlingException} (client fault) + *This exception occurs when you have exceeded the limit on the number of requests per second.
+ * + * @throws {@link ValidationException} (client fault) + *This exception occurs when a request is not valid.
+ * + * @throws {@link ResiliencehubServiceException} + *Base exception class for all service exceptions from Resiliencehub service.
+ * + * @public + */ +export class AcceptResourceGroupingRecommendationsCommand extends $Command + .classBuilder< + AcceptResourceGroupingRecommendationsCommandInput, + AcceptResourceGroupingRecommendationsCommandOutput, + ResiliencehubClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep({ + ...commonParams, + }) + .m(function (this: any, Command: any, cs: any, config: ResiliencehubClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AwsResilienceHub", "AcceptResourceGroupingRecommendations", {}) + .n("ResiliencehubClient", "AcceptResourceGroupingRecommendationsCommand") + .f(void 0, void 0) + .ser(se_AcceptResourceGroupingRecommendationsCommand) + .de(de_AcceptResourceGroupingRecommendationsCommand) + .build() {} diff --git a/clients/client-resiliencehub/src/commands/AddDraftAppVersionResourceMappingsCommand.ts b/clients/client-resiliencehub/src/commands/AddDraftAppVersionResourceMappingsCommand.ts index 0971034b5a051..a4886c81c636d 100644 --- a/clients/client-resiliencehub/src/commands/AddDraftAppVersionResourceMappingsCommand.ts +++ b/clients/client-resiliencehub/src/commands/AddDraftAppVersionResourceMappingsCommand.ts @@ -36,7 +36,12 @@ export interface AddDraftAppVersionResourceMappingsCommandOutput __MetadataBearer {} /** - *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 Step 2: How is your application managed? in the Resilience Hub User Guide.
+ *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 supported by Resilience Hub and how to add them in your application, see + * Step + * 2: How is your application managed? in the Resilience Hub User Guide.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -113,6 +118,10 @@ export interface AddDraftAppVersionResourceMappingsCommandOutput * @throws {@link ResourceNotFoundException} (client fault) *This exception occurs when the specified resource could not be found.
* + * @throws {@link ServiceQuotaExceededException} (client fault) + *This exception occurs when you have exceeded your service quota. To perform the requested action, remove some of the + * relevant resources, or use Service Quotas to request a service quota increase.
+ * * @throws {@link ThrottlingException} (client fault) *This exception occurs when you have exceeded the limit on the number of requests per second.
* diff --git a/clients/client-resiliencehub/src/commands/CreateAppCommand.ts b/clients/client-resiliencehub/src/commands/CreateAppCommand.ts index d4bf7f220481f..5c768b92f8cf0 100644 --- a/clients/client-resiliencehub/src/commands/CreateAppCommand.ts +++ b/clients/client-resiliencehub/src/commands/CreateAppCommand.ts @@ -34,14 +34,15 @@ export interface CreateAppCommandOutput extends CreateAppResponse, __MetadataBea /** *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 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 Service * quotas.
- *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 - * by running another assessment, comparing results, and then iterating the process until you - * achieve your goals for recovery time objective (RTO) and recovery point objective + *
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 by running another assessment, comparing results, and then iterating the process + * until you achieve your goals for recovery time objective (RTO) and recovery point objective * (RPO).
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-resiliencehub/src/commands/CreateAppVersionAppComponentCommand.ts b/clients/client-resiliencehub/src/commands/CreateAppVersionAppComponentCommand.ts index b386a360adf64..aaf69cacd16cb 100644 --- a/clients/client-resiliencehub/src/commands/CreateAppVersionAppComponentCommand.ts +++ b/clients/client-resiliencehub/src/commands/CreateAppVersionAppComponentCommand.ts @@ -35,7 +35,9 @@ export interface CreateAppVersionAppComponentCommandOutput /** *Creates a new Application Component in the Resilience Hub application.
*This API updates the Resilience Hub application draft version. To use this Application Component for running assessments, you must publish the Resilience Hub application using the PublishAppVersion API.
This API updates the Resilience Hub application draft version. To use this
+ * Application Component for running assessments, you must publish the Resilience Hub
+ * application using the PublishAppVersion API.
Adds a resource to the Resilience Hub application and assigns it to the specified - * Application Components. If you specify a new Application Component, Resilience Hub will automatically - * create the Application Component.
+ * Application Components. If you specify a new Application Component, Resilience Hub will + * automatically create the Application Component. *This action has no effect outside Resilience Hub.
*This API updates the Resilience Hub application draft version. To use this resource
- * for running resiliency assessments, you must publish the Resilience Hub application using
- * the PublishAppVersion API.
This API updates the Resilience Hub application draft version. To use this
+ * resource for running resiliency assessments, you must publish the Resilience Hub
+ * application using the PublishAppVersion API.
To update application version with new physicalResourceID, you must
diff --git a/clients/client-resiliencehub/src/commands/CreateResiliencyPolicyCommand.ts b/clients/client-resiliencehub/src/commands/CreateResiliencyPolicyCommand.ts
index 6b06c52b874df..3a17716d32683 100644
--- a/clients/client-resiliencehub/src/commands/CreateResiliencyPolicyCommand.ts
+++ b/clients/client-resiliencehub/src/commands/CreateResiliencyPolicyCommand.ts
@@ -35,9 +35,11 @@ export interface CreateResiliencyPolicyCommandOutput extends CreateResiliencyPol
/**
*
Creates a resiliency policy for an application.
*Resilience Hub allows you to provide a value of zero for rtoInSecs and
- * rpoInSecs of your resiliency policy. But, while assessing your application, the lowest possible assessment result is near zero. Hence, if you provide value
- * zero for rtoInSecs and rpoInSecs, the estimated workload RTO and estimated workload RPO result will be near zero and the Compliance
+ *
Resilience Hub allows you to provide a value of zero for rtoInSecs
+ * and rpoInSecs of your resiliency policy. But, while assessing your application,
+ * the lowest possible assessment result is near zero. Hence, if you provide value zero for
+ * rtoInSecs and rpoInSecs, the estimated workload RTO and
+ * estimated workload RPO result will be near zero and the Compliance
* status for your application will be set to Policy
* breached.
Deletes an Resilience Hub application assessment. This is a destructive action that can't - * be undone.
+ *Deletes an Resilience Hub application assessment. This is a destructive action + * that can't be undone.
* @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/DeleteAppInputSourceCommand.ts b/clients/client-resiliencehub/src/commands/DeleteAppInputSourceCommand.ts index b9a8479f476f6..091dea1a2212a 100644 --- a/clients/client-resiliencehub/src/commands/DeleteAppInputSourceCommand.ts +++ b/clients/client-resiliencehub/src/commands/DeleteAppInputSourceCommand.ts @@ -28,7 +28,8 @@ export interface DeleteAppInputSourceCommandInput extends DeleteAppInputSourceRe export interface DeleteAppInputSourceCommandOutput extends DeleteAppInputSourceResponse, __MetadataBearer {} /** - *Deletes the input source and all of its imported resources from the Resilience Hub application.
+ *Deletes the input source and all of its imported resources from the Resilience Hub + * application.
* @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/DeleteAppVersionAppComponentCommand.ts b/clients/client-resiliencehub/src/commands/DeleteAppVersionAppComponentCommand.ts index 4d65b2c24db7c..e4938cc13e32a 100644 --- a/clients/client-resiliencehub/src/commands/DeleteAppVersionAppComponentCommand.ts +++ b/clients/client-resiliencehub/src/commands/DeleteAppVersionAppComponentCommand.ts @@ -37,10 +37,13 @@ export interface DeleteAppVersionAppComponentCommandOutput *This API updates the Resilience Hub application draft version. To use this Application Component for running assessments, you must publish the Resilience Hub application using the PublishAppVersion API.
This API updates the Resilience Hub application draft version. To use this
+ * Application Component for running assessments, you must publish the Resilience Hub
+ * application using the PublishAppVersion API.
You will not be able to delete an Application Component if it has resources associated with it.
+ *You will not be able to delete an Application Component if it has resources associated + * with it.
*You can only delete a manually added resource. To exclude non-manually added resources, use the UpdateAppVersionResource API.
You can only delete a manually added resource. To exclude non-manually added
+ * resources, use the UpdateAppVersionResource API.
This action has no effect outside Resilience Hub.
*This API updates the Resilience Hub application draft version. To use this resource for running resiliency assessments, you must publish the Resilience Hub application using the PublishAppVersion API.
This API updates the Resilience Hub application draft version. To use this
+ * resource for running resiliency assessments, you must publish the Resilience Hub
+ * application using the PublishAppVersion API.
Describes a resource of the Resilience Hub application.
*This API accepts only one of the following parameters to descibe the resource:
+ *This API accepts only one of the following parameters to describe the resource:
*@@ -44,8 +44,8 @@ export interface DescribeAppVersionResourceCommandOutput extends DescribeAppVers *
- * physicalResourceId (Along with physicalResourceId, you can also
- * provide awsAccountId, and awsRegion)
physicalResourceId (Along with physicalResourceId, you can
+ * also provide awsAccountId, and awsRegion)
* If you get a 404 error with
* ResourceImportStatusNotFoundAppMetadataException, you must call
- * importResourcesToDraftAppVersion after creating the application and before
+ * importResourcesToDraftAppVersion after creating the application and before
* calling describeDraftAppVersionResourcesImportStatus to obtain the
* status.
Describes the resource grouping recommendation tasks run by Resilience Hub for your application.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ResiliencehubClient, DescribeResourceGroupingRecommendationTaskCommand } from "@aws-sdk/client-resiliencehub"; // ES Modules import + * // const { ResiliencehubClient, DescribeResourceGroupingRecommendationTaskCommand } = require("@aws-sdk/client-resiliencehub"); // CommonJS import + * const client = new ResiliencehubClient(config); + * const input = { // DescribeResourceGroupingRecommendationTaskRequest + * appArn: "STRING_VALUE", // required + * groupingId: "STRING_VALUE", + * }; + * const command = new DescribeResourceGroupingRecommendationTaskCommand(input); + * const response = await client.send(command); + * // { // DescribeResourceGroupingRecommendationTaskResponse + * // groupingId: "STRING_VALUE", // required + * // status: "STRING_VALUE", // required + * // errorMessage: "STRING_VALUE", + * // }; + * + * ``` + * + * @param DescribeResourceGroupingRecommendationTaskCommandInput - {@link DescribeResourceGroupingRecommendationTaskCommandInput} + * @returns {@link DescribeResourceGroupingRecommendationTaskCommandOutput} + * @see {@link DescribeResourceGroupingRecommendationTaskCommandInput} for command's `input` shape. + * @see {@link DescribeResourceGroupingRecommendationTaskCommandOutput} for command's `response` shape. + * @see {@link ResiliencehubClientResolvedConfig | config} for ResiliencehubClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have permissions to perform the requested operation. The user or role that is + * making the request must have at least one IAM permissions policy attached that grants the + * required permissions.
+ * + * @throws {@link InternalServerException} (server fault) + *This exception occurs when there is an internal failure in the Resilience Hub + * service.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *This exception occurs when the specified resource could not be found.
+ * + * @throws {@link ThrottlingException} (client fault) + *This exception occurs when you have exceeded the limit on the number of requests per second.
+ * + * @throws {@link ValidationException} (client fault) + *This exception occurs when a request is not valid.
+ * + * @throws {@link ResiliencehubServiceException} + *Base exception class for all service exceptions from Resiliencehub service.
+ * + * @public + */ +export class DescribeResourceGroupingRecommendationTaskCommand extends $Command + .classBuilder< + DescribeResourceGroupingRecommendationTaskCommandInput, + DescribeResourceGroupingRecommendationTaskCommandOutput, + ResiliencehubClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep({ + ...commonParams, + }) + .m(function (this: any, Command: any, cs: any, config: ResiliencehubClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AwsResilienceHub", "DescribeResourceGroupingRecommendationTask", {}) + .n("ResiliencehubClient", "DescribeResourceGroupingRecommendationTaskCommand") + .f(void 0, void 0) + .ser(se_DescribeResourceGroupingRecommendationTaskCommand) + .de(de_DescribeResourceGroupingRecommendationTaskCommand) + .build() {} diff --git a/clients/client-resiliencehub/src/commands/ImportResourcesToDraftAppVersionCommand.ts b/clients/client-resiliencehub/src/commands/ImportResourcesToDraftAppVersionCommand.ts index 3092b2b8885ff..96f65ba97d892 100644 --- a/clients/client-resiliencehub/src/commands/ImportResourcesToDraftAppVersionCommand.ts +++ b/clients/client-resiliencehub/src/commands/ImportResourcesToDraftAppVersionCommand.ts @@ -33,8 +33,9 @@ export interface ImportResourcesToDraftAppVersionCommandOutput __MetadataBearer {} /** - *Imports resources to Resilience Hub application draft version from different input sources. For more information about the input sources supported by Resilience Hub, see Discover - * the structure and describe your Resilience Hub application.
+ *Imports resources to Resilience Hub application draft version from different input + * sources. For more information about the input sources supported by Resilience Hub, see + * Discover the structure and describe your Resilience Hub application.
* @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/ListAppAssessmentResourceDriftsCommand.ts b/clients/client-resiliencehub/src/commands/ListAppAssessmentResourceDriftsCommand.ts index 564783580d972..601a4d6aa8a56 100644 --- a/clients/client-resiliencehub/src/commands/ListAppAssessmentResourceDriftsCommand.ts +++ b/clients/client-resiliencehub/src/commands/ListAppAssessmentResourceDriftsCommand.ts @@ -33,7 +33,8 @@ export interface ListAppAssessmentResourceDriftsCommandOutput __MetadataBearer {} /** - *Indicates the list of resource drifts that were detected while running an assessment.
+ *Indicates the list of resource drifts that were detected while running an + * assessment.
* @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/ListAppAssessmentsCommand.ts b/clients/client-resiliencehub/src/commands/ListAppAssessmentsCommand.ts index e4d4efb7be7a2..eceeb7cd7662e 100644 --- a/clients/client-resiliencehub/src/commands/ListAppAssessmentsCommand.ts +++ b/clients/client-resiliencehub/src/commands/ListAppAssessmentsCommand.ts @@ -28,8 +28,8 @@ export interface ListAppAssessmentsCommandInput extends ListAppAssessmentsReques export interface ListAppAssessmentsCommandOutput extends ListAppAssessmentsResponse, __MetadataBearer {} /** - *Lists the assessments for an Resilience Hub application. You can use request parameters to - * refine the results for the response object.
+ *Lists the assessments for an Resilience Hub application. You can use request + * parameters to refine the results for the response object.
* @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/ListAppInputSourcesCommand.ts b/clients/client-resiliencehub/src/commands/ListAppInputSourcesCommand.ts index 1893de4ffffde..4995d2690d270 100644 --- a/clients/client-resiliencehub/src/commands/ListAppInputSourcesCommand.ts +++ b/clients/client-resiliencehub/src/commands/ListAppInputSourcesCommand.ts @@ -28,8 +28,8 @@ export interface ListAppInputSourcesCommandInput extends ListAppInputSourcesRequ export interface ListAppInputSourcesCommandOutput extends ListAppInputSourcesResponse, __MetadataBearer {} /** - *Lists all the input sources of the Resilience Hub application. For more information about the
- * input sources supported by Resilience Hub, see Discover
+ * Lists all the input sources of the Resilience Hub application. For more
+ * information about the input sources supported by Resilience Hub, see Discover
* the structure and describe your Resilience Hub application. Lists the resource grouping recommendations suggested by Resilience Hub for your application. You don't have permissions to perform the requested operation. The user or role that is
+ * making the request must have at least one IAM permissions policy attached that grants the
+ * required permissions. This exception occurs when there is an internal failure in the Resilience Hub
+ * service. This exception occurs when the specified resource could not be found. This exception occurs when you have exceeded the limit on the number of requests per second. This exception occurs when a request is not valid. Base exception class for all service exceptions from Resiliencehub service. Lists the standard operating procedure (SOP) recommendations for the Resilience Hub
- * applications. Lists the standard operating procedure (SOP) recommendations for the Resilience Hub applications. Lists the suggested resiliency policies for the Resilience Hub applications. Lists the suggested resiliency policies for the Resilience Hub
+ * applications. Lists the resources that are not currently supported in Resilience Hub. An unsupported
- * resource is a resource that exists in the object that was used to create an app, but is not
- * supported by Resilience Hub. Lists the resources that are not currently supported in Resilience Hub. An
+ * unsupported resource is a resource that exists in the object that was used to create an app,
+ * but is not supported by Resilience Hub. Adds or updates the app template for an Resilience Hub application draft version. Adds or updates the app template for an Resilience Hub application draft
+ * version. Rejects resource grouping recommendations. You don't have permissions to perform the requested operation. The user or role that is
+ * making the request must have at least one IAM permissions policy attached that grants the
+ * required permissions. This exception occurs when there is an internal failure in the Resilience Hub
+ * service. This exception occurs when the specified resource could not be found. This exception occurs when you have exceeded the limit on the number of requests per second. This exception occurs when a request is not valid. Base exception class for all service exceptions from Resiliencehub service. Starts grouping recommendation task. You don't have permissions to perform the requested operation. The user or role that is
+ * making the request must have at least one IAM permissions policy attached that grants the
+ * required permissions. This exception occurs when a conflict with a previous successful write is detected. This generally occurs
+ * when the previous write did not have time to propagate to the host serving the current
+ * request. A retry (with appropriate backoff logic) is the recommended response to this
+ * exception. This exception occurs when there is an internal failure in the Resilience Hub
+ * service. This exception occurs when the specified resource could not be found. This exception occurs when you have exceeded the limit on the number of requests per second. This exception occurs when a request is not valid. Base exception class for all service exceptions from Resiliencehub service. Updates an existing Application Component in the Resilience Hub application. This API updates the Resilience Hub application draft version. To use this Application Component for running assessments, you must publish the Resilience Hub application using the This API updates the Resilience Hub application draft version. To use this
+ * Application Component for running assessments, you must publish the Resilience Hub
+ * application using the Updates the Resilience Hub application version. This API updates the Resilience Hub application draft version. To use this information
- * for running resiliency assessments, you must publish the Resilience Hub application using the
- * This API updates the Resilience Hub application draft version. To use this
+ * information for running resiliency assessments, you must publish the Resilience Hub
+ * application using the This action has no effect outside Resilience Hub.PublishAppVersion API.PublishAppVersion API.PublishAppVersion API.PublishAppVersion API.
This API updates the Resilience Hub application draft version. To use this resource for running resiliency assessments, you must publish the Resilience Hub application using the PublishAppVersion API.
This API updates the Resilience Hub application draft version. To use this
+ * resource for running resiliency assessments, you must publish the Resilience Hub
+ * application using the PublishAppVersion API.
To update application version with new physicalResourceID, you must call
- * ResolveAppVersionResources API.
To update application version with new physicalResourceID, you must
+ * call ResolveAppVersionResources API.
Updates a resiliency policy.
*Resilience Hub allows you to provide a value of zero for rtoInSecs and
- * rpoInSecs of your resiliency policy. But, while assessing your application,
- * the lowest possible assessment result is near zero. Hence, if you provide value
- * zero for rtoInSecs and rpoInSecs, the estimated workload RTO and
+ *
Resilience Hub allows you to provide a value of zero for rtoInSecs
+ * and rpoInSecs of your resiliency policy. But, while assessing your application,
+ * the lowest possible assessment result is near zero. Hence, if you provide value zero for
+ * rtoInSecs and rpoInSecs, the estimated workload RTO and
* estimated workload RPO result will be near zero and the Compliance
* status for your application will be set to Policy
* breached.
Indicates the grouping recommendation you have accepted to include in your application.
+ * @public + */ +export interface AcceptGroupingRecommendationEntry { + /** + *Indicates the identifier of the grouping recommendation.
+ * @public + */ + groupingRecommendationId: string | undefined; +} + +/** + * @public + */ +export interface AcceptResourceGroupingRecommendationsRequest { + /** + *Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is:
+ * arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs,
+ * see
+ * Amazon Resource Names (ARNs) in the
+ * Amazon Web Services General Reference guide.
Indicates the list of resource grouping recommendations you want to include in your application.
+ * @public + */ + entries: AcceptGroupingRecommendationEntry[] | undefined; +} + +/** + *Indicates the accepted grouping recommendation whose implementation failed.
+ * @public + */ +export interface FailedGroupingRecommendationEntry { + /** + *Indicates the identifier of the grouping recommendation.
+ * @public + */ + groupingRecommendationId: string | undefined; + + /** + *Indicates the error that occurred while implementing a grouping recommendation.
+ * @public + */ + errorMessage: string | undefined; +} + +/** + * @public + */ +export interface AcceptResourceGroupingRecommendationsResponse { + /** + *Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is:
+ * arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs,
+ * see
+ * Amazon Resource Names (ARNs) in the
+ * Amazon Web Services General Reference guide.
Indicates the list of resource grouping recommendations that could not be included in your application.
+ * @public + */ + failedEntries: FailedGroupingRecommendationEntry[] | undefined; +} + /** *You don't have permissions to perform the requested operation. The user or role that is * making the request must have at least one IAM permissions policy attached that grants the @@ -25,6 +97,108 @@ export class AccessDeniedException extends __BaseException { } } +/** + *
This exception occurs when there is an internal failure in the Resilience Hub + * service.
+ * @public + */ +export class InternalServerException extends __BaseException { + readonly name: "InternalServerException" = "InternalServerException"; + readonly $fault: "server" = "server"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThis exception occurs when the specified resource could not be found.
+ * @public + */ +export class ResourceNotFoundException extends __BaseException { + readonly name: "ResourceNotFoundException" = "ResourceNotFoundException"; + readonly $fault: "client" = "client"; + /** + *The identifier of the resource that the exception applies to.
+ * @public + */ + resourceId?: string; + + /** + *The type of the resource that the exception applies to.
+ * @public + */ + resourceType?: string; + + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThis exception occurs when you have exceeded the limit on the number of requests per second.
+ * @public + */ +export class ThrottlingException extends __BaseException { + readonly name: "ThrottlingException" = "ThrottlingException"; + readonly $fault: "client" = "client"; + /** + *The number of seconds to wait before retrying the operation.
+ * @public + */ + retryAfterSeconds?: number; + + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThis exception occurs when a request is not valid.
+ * @public + */ +export class ValidationException extends __BaseException { + readonly name: "ValidationException" = "ValidationException"; + readonly $fault: "client" = "client"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThis exception occurs when there is an internal failure in the Resilience Hub - * service.
- * @public - */ -export class InternalServerException extends __BaseException { - readonly name: "InternalServerException" = "InternalServerException"; - readonly $fault: "server" = "server"; - /** - * @internal - */ - constructor(opts: __ExceptionOptionTypeThis exception occurs when the specified resource could not be found.
- * @public - */ -export class ResourceNotFoundException extends __BaseException { - readonly name: "ResourceNotFoundException" = "ResourceNotFoundException"; - readonly $fault: "client" = "client"; - /** - *The identifier of the resource that the exception applies to.
- * @public - */ - resourceId?: string; - - /** - *The type of the resource that the exception applies to.
- * @public - */ - resourceType?: string; - - /** - * @internal - */ - constructor(opts: __ExceptionOptionTypeThis exception occurs when you have exceeded the limit on the number of requests per second.
- * @public - */ -export class ThrottlingException extends __BaseException { - readonly name: "ThrottlingException" = "ThrottlingException"; - readonly $fault: "client" = "client"; - /** - *The number of seconds to wait before retrying the operation.
- * @public - */ - retryAfterSeconds?: number; - - /** - * @internal - */ - constructor(opts: __ExceptionOptionTypeThis exception occurs when a request is not valid.
+ *This exception occurs when you have exceeded your service quota. To perform the requested action, remove some of the + * relevant resources, or use Service Quotas to request a service quota increase.
* @public */ -export class ValidationException extends __BaseException { - readonly name: "ValidationException" = "ValidationException"; +export class ServiceQuotaExceededException extends __BaseException { + readonly name: "ServiceQuotaExceededException" = "ServiceQuotaExceededException"; readonly $fault: "client" = "client"; /** * @internal */ - constructor(opts: __ExceptionOptionTypeThis indicates if there are more errors not listed in the resourceErrors list.
+ * This indicates if there are more errors not listed in the
+ * resourceErrors
+ * list.
Indicates a specific risk identified in the Resilience Hub assessment and the corresponding recommendation provided to address that risk.
+ *The assessment summary generated by large language models (LLMs) on Amazon Bedrock are only suggestions. + * The current level of generative AI technology is not perfect and LLMs are not infallible. + * Bias and incorrect answers, although rare, should be expected. Review each recommendation in the assessment summary before you use the output from an LLM. + *
+ *This property is available only in the US East (N. Virginia) Region.
+ *Indicates the description of the potential risk identified in the application as part of the Resilience Hub assessment.
+ *This property is available only in the US East (N. Virginia) Region.
+ *Indicates the recommendation provided by the Resilience Hub to address the identified + * risks in the application.
+ *This property is available only in the US East (N. Virginia) Region.
+ *Indicates the Application Components (AppComponents) that were assessed as part of the + * assessnent and are associated with the identified risk and recommendation.
+ *This property is available only in the US East (N. Virginia) Region.
+ *Indicates the AI-generated summary for the Resilience Hub assessment, providing a concise overview that highlights the top risks and recommendations.
+ *This property is available only in the US East (N. Virginia) Region.
+ *Indicates a concise summary that provides an overview of the Resilience Hub assessment.
+ *This property is available only in the US East (N. Virginia) Region.
+ *Indicates the top risks and recommendations identified by the Resilience Hub assessment, + * each representing a specific risk and the corresponding recommendation to address it.
+ *This property is available only in the US East (N. Virginia) Region.
+ *Defines an application assessment.
* @public @@ -1515,6 +1686,12 @@ export interface AppAssessment { * @public */ driftStatus?: DriftStatus; + + /** + *Indicates a concise summary that provides an overview of the Resilience Hub assessment.
+ * @public + */ + summary?: AssessmentSummary; } /** @@ -1585,7 +1762,8 @@ export interface AppAssessmentSummary { assessmentArn: string | undefined; /** - *TCurrent status of compliance for the resiliency policy.
+ *Current + * status of compliance for the resiliency policy.
* @public */ complianceStatus?: ComplianceStatus; @@ -1967,7 +2145,8 @@ export interface BatchUpdateRecommendationStatusRequest { appArn: string | undefined; /** - *Defines the list of operational recommendations that need to be included or excluded.
+ *Defines the list of operational recommendations that need to be included or + * excluded.
* @public */ requestEntries: UpdateRecommendationStatusRequestEntry[] | undefined; @@ -2054,7 +2233,8 @@ export interface BatchUpdateRecommendationStatusResponse { successfulEntries: BatchUpdateRecommendationStatusSuccessfulEntry[] | undefined; /** - *A list of items with error details about each item, which could not be included or excluded.
+ *A list of items with error details about each item, which could not be included or + * excluded.
* @public */ failedEntries: BatchUpdateRecommendationStatusFailedEntry[] | undefined; @@ -2101,9 +2281,7 @@ export interface CreateAppRequest { clientToken?: string; /** - *- * Assessment execution schedule with 'Daily' or 'Disabled' values. - *
+ *Assessment execution schedule with 'Daily' or 'Disabled' values.
* @public */ assessmentSchedule?: AppAssessmentScheduleType; @@ -2116,7 +2294,9 @@ export interface CreateAppRequest { permissionModel?: PermissionModel; /** - *The list of events you would like to subscribe and get notification for. Currently, Resilience Hub supports only Drift detected and Scheduled assessment failure events notification.
+ *The list of events you would like to subscribe and get notification for. Currently, + * Resilience Hub supports only Drift detected and + * Scheduled assessment failure events notification.
* @public */ eventSubscriptions?: EventSubscription[]; @@ -2134,27 +2314,6 @@ export interface CreateAppResponse { app: App | undefined; } -/** - *This exception occurs when you have exceeded your service quota. To perform the requested action, remove some of the - * relevant resources, or use Service Quotas to request a service quota increase.
- * @public - */ -export class ServiceQuotaExceededException extends __BaseException { - readonly name: "ServiceQuotaExceededException" = "ServiceQuotaExceededException"; - readonly $fault: "client" = "client"; - /** - * @internal - */ - constructor(opts: __ExceptionOptionTypeThe Amazon Resource Name (ARN) of the imported resource you want to remove from the - * Resilience Hub application. For more information about ARNs, + * Resilience Hub application. For more information about ARNs, * see * Amazon Resource Names (ARNs) in the * Amazon Web Services General Reference guide.
@@ -2903,7 +3062,8 @@ export interface DeleteAppInputSourceRequest { sourceArn?: string; /** - *The imported Terraform s3 state file you want to remove from the Resilience Hub application.
+ *The imported Terraform s3 state file you want to remove from the Resilience Hub + * application.
* @public */ terraformSource?: TerraformSource; @@ -2916,7 +3076,8 @@ export interface DeleteAppInputSourceRequest { clientToken?: string; /** - *The namespace on your Amazon Elastic Kubernetes Service cluster that you want to delete from the Resilience Hub application.
+ *The namespace on your Amazon Elastic Kubernetes Service cluster that you want to delete from the + * Resilience Hub application.
* @public */ eksSourceClusterNamespace?: EksSourceClusterNamespace; @@ -3196,8 +3357,8 @@ export interface DescribeAppAssessmentRequest { */ export interface DescribeAppAssessmentResponse { /** - *The assessment for an Resilience Hub application, returned as an object. This object - * includes Amazon Resource Names (ARNs), compliance information, compliance status, cost, + *
The assessment for an Resilience Hub application, returned as an object. This + * object includes Amazon Resource Names (ARNs), compliance information, compliance status, cost, * messages, resiliency scores, and more.
* @public */ @@ -3514,7 +3675,7 @@ export interface DescribeAppVersionTemplateResponse { /** *A JSON string that provides information about your application structure. To learn more
* about the appTemplateBody template, see the sample template provided in the
- * Examples section.
The appTemplateBody JSON string has the following structure:
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is:
+ * arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs,
+ * see
+ * Amazon Resource Names (ARNs) in the
+ * Amazon Web Services General Reference guide.
Indicates the identifier of the grouping recommendation task.
+ * @public + */ + groupingId?: string; +} + +/** + * @public + * @enum + */ +export const ResourcesGroupingRecGenStatusType = { + FAILED: "Failed", + IN_PROGRESS: "InProgress", + PENDING: "Pending", + SUCCESS: "Success", +} as const; + +/** + * @public + */ +export type ResourcesGroupingRecGenStatusType = + (typeof ResourcesGroupingRecGenStatusType)[keyof typeof ResourcesGroupingRecGenStatusType]; + +/** + * @public + */ +export interface DescribeResourceGroupingRecommendationTaskResponse { + /** + *Indicates the identifier of the grouping recommendation task.
+ * @public + */ + groupingId: string | undefined; + + /** + *Status of the action.
+ * @public + */ + status: ResourcesGroupingRecGenStatusType | undefined; + + /** + *Indicates the error that occurred while generating a grouping recommendation.
+ * @public + */ + errorMessage?: string; } /** @@ -3984,9 +4206,7 @@ export interface ImportResourcesToDraftAppVersionResponse { status: ResourceImportStatusType | undefined; /** - *- * A list of terraform file s3 URLs you have imported. - *
+ *A list of terraform file s3 URLs you have imported.
* @public */ terraformSources?: TerraformSource[]; @@ -4031,8 +4251,8 @@ export interface ListAlarmRecommendationsRequest { */ export interface ListAlarmRecommendationsResponse { /** - *The alarm recommendations for an Resilience Hub application, returned as an object. This - * object includes Application Component names, descriptions, information about whether a + *
The alarm recommendations for an Resilience Hub application, returned as an + * object. This object includes Application Component names, descriptions, information about whether a * recommendation has already been implemented or not, prerequisites, and more.
* @public */ @@ -4060,13 +4280,13 @@ export interface ListAppAssessmentComplianceDriftsRequest { assessmentArn: string | undefined; /** - *Indicates the unique token number of the next application to be checked for compliance and regulatory requirements from the list of applications.
+ *Null, or the token from a previous call to get the next set of results.
* @public */ nextToken?: string; /** - *Indicates the maximum number of applications requested.
+ *Indicates the maximum number of compliance drifts requested.
* @public */ maxResults?: number; @@ -4166,7 +4386,8 @@ export interface ComplianceDrift { /** *Difference type between actual and expected recovery point objective (RPO) and recovery - * time objective (RTO) values. Currently, Resilience Hub supports only NotEqual difference type.
+ * time objective (RTO) values. Currently, Resilience Hub supports only + *NotEqual difference type.
* @public
*/
diffType?: DifferenceType;
@@ -4177,13 +4398,14 @@ export interface ComplianceDrift {
*/
export interface ListAppAssessmentComplianceDriftsResponse {
/**
- * Indicates compliance drifts (recovery time objective (RTO) and recovery point objective (RPO)) detected for an assessed entity.
+ *Indicates compliance drifts (recovery time objective (RTO) and recovery point objective + * (RPO)) detected for an assessed entity.
* @public */ complianceDrifts: ComplianceDrift[] | undefined; /** - *Token number of the next application to be checked for compliance and regulatory requirements from the list of applications.
+ *Null, or the token from a previous call to get the next set of results.
* @public */ nextToken?: string; @@ -4210,7 +4432,9 @@ export interface ListAppAssessmentResourceDriftsRequest { nextToken?: string; /** - *Indicates the maximum number of drift results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
Indicates the maximum number of drift results to include in the response. If more results
+ * exist than the specified MaxResults value, a token is included in the response so
+ * that the remaining results can be retrieved.
The compliances for an Resilience Hub Application Component, returned as an object. This - * object contains the names of the Application Components, compliances, costs, resiliency scores, outage scores, and - * more.
+ * object contains the names of the Application Components, compliances, costs, resiliency scores, + * outage scores, and more. * @public */ componentCompliances: AppComponentCompliance[] | undefined; @@ -4595,6 +4819,7 @@ export const RecommendationComplianceStatus = { BREACHED_CAN_MEET: "BreachedCanMeet", BREACHED_UNATTAINABLE: "BreachedUnattainable", MET_CAN_IMPROVE: "MetCanImprove", + MISSING_POLICY: "MissingPolicy", } as const; /** @@ -4634,9 +4859,9 @@ export interface ComponentRecommendation { */ export interface ListAppComponentRecommendationsResponse { /** - *The recommendations for an Resilience Hub Application Component, returned as an object. This - * object contains the names of the Application Components, configuration recommendations, and recommendation - * statuses.
+ *The recommendations for an Resilience Hub Application Component, returned as an object. + * This object contains the names of the Application Components, configuration recommendations, and + * recommendation statuses.
* @public */ componentRecommendations: ComponentRecommendation[] | undefined; @@ -4675,7 +4900,8 @@ export interface ListAppInputSourcesRequest { nextToken?: string; /** - *Maximum number of input sources to be displayed per Resilience Hub application.
+ *Maximum number of input sources to be displayed per Resilience Hub + * application.
* @public */ maxResults?: number; @@ -4732,19 +4958,24 @@ export interface ListAppsRequest { appArn?: string; /** - *Indicates the lower limit of the range that is used to filter applications based on their last assessment times.
+ *Indicates the lower limit of the range that is used to filter applications based on their + * last assessment times.
* @public */ fromLastAssessmentTime?: Date; /** - *Indicates the upper limit of the range that is used to filter the applications based on their last assessment times.
+ *Indicates the upper limit of the range that is used to filter the applications based on + * their last assessment times.
* @public */ toLastAssessmentTime?: Date; /** - *The application list is sorted based on the values of lastAppComplianceEvaluationTime field. By default, application list is sorted in ascending order. To sort the appliation list in descending order, set this field to True.
The application list is sorted based on the values of
+ * lastAppComplianceEvaluationTime field. By default, application list is sorted
+ * in ascending order. To sort the application list in descending order, set this field to
+ * True.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is:
+ * arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs,
+ * see
+ * Amazon Resource Names (ARNs) in the
+ * Amazon Web Services General Reference guide.
Null, or the token from a previous call to get the next set of results.
+ * @public + */ + nextToken?: string; + + /** + *Maximum number of grouping recommendations to be displayed per Resilience Hub application.
+ * @public + */ + maxResults?: number; +} + +/** + * @public + * @enum + */ +export const GroupingRecommendationConfidenceLevel = { + HIGH: "High", + MEDIUM: "Medium", +} as const; + +/** + * @public + */ +export type GroupingRecommendationConfidenceLevel = + (typeof GroupingRecommendationConfidenceLevel)[keyof typeof GroupingRecommendationConfidenceLevel]; + +/** + *Creates a new recommended Application Component (AppComponent).
+ * @public + */ +export interface GroupingAppComponent { + /** + *Indicates the identifier of an AppComponent.
+ * @public + */ + appComponentId: string | undefined; + + /** + *Indicates the type of an AppComponent.
+ * @public + */ + appComponentType: string | undefined; + + /** + *Indicates the name of an AppComponent.
+ * @public + */ + appComponentName: string | undefined; +} + +/** + * @public + * @enum + */ +export const GroupingRecommendationRejectionReason = { + DISTINCT_BUSINESS_PURPOSE: "DistinctBusinessPurpose", + DISTINCT_USER_GROUP_HANDLING: "DistinctUserGroupHandling", + OTHER: "Other", + SEPARATE_DATA_CONCERN: "SeparateDataConcern", +} as const; + +/** + * @public + */ +export type GroupingRecommendationRejectionReason = + (typeof GroupingRecommendationRejectionReason)[keyof typeof GroupingRecommendationRejectionReason]; + +/** + *Indicates the resource that will be grouped in the recommended Application Component (AppComponent).
+ * @public + */ +export interface GroupingResource { + /** + *Indicates the resource name.
+ * @public + */ + resourceName: string | undefined; + + /** + *Indicates the resource type.
+ * @public + */ + resourceType: string | undefined; + + /** + *Indicates the physical identifier of the resource.
+ * @public + */ + physicalResourceId: PhysicalResourceId | undefined; + + /** + *Indicates the logical identifier of the resource.
+ * @public + */ + logicalResourceId: LogicalResourceId | undefined; + + /** + *Indicates the identifier of the source AppComponents in which the resources were previously grouped into.
+ * @public + */ + sourceAppComponentIds: string[] | undefined; +} + +/** + * @public + * @enum + */ +export const GroupingRecommendationStatusType = { + ACCEPTED: "Accepted", + PENDING_DECISION: "PendingDecision", + REJECTED: "Rejected", +} as const; + +/** + * @public + */ +export type GroupingRecommendationStatusType = + (typeof GroupingRecommendationStatusType)[keyof typeof GroupingRecommendationStatusType]; + +/** + *Creates a new grouping recommendation.
+ * @public + */ +export interface GroupingRecommendation { + /** + *Indicates all the reasons available for rejecting a grouping recommendation.
+ * @public + */ + groupingRecommendationId: string | undefined; + + /** + *Indicates the name of the recommended Application Component (AppComponent).
+ * @public + */ + groupingAppComponent: GroupingAppComponent | undefined; + + /** + *Indicates the resources that are grouped in a recommended AppComponent.
+ * @public + */ + resources: GroupingResource[] | undefined; + + /** + *Indicates the confidence level of the grouping recommendation.
+ * @public + */ + score: number | undefined; + + /** + *Indicates all the reasons available for rejecting a grouping recommendation.
+ * @public + */ + recommendationReasons: string[] | undefined; + + /** + *Indicates the status of grouping resources into AppComponents.
+ * @public + */ + status: GroupingRecommendationStatusType | undefined; + + /** + *Indicates the confidence level of Resilience Hub on the grouping recommendation.
+ * @public + */ + confidenceLevel: GroupingRecommendationConfidenceLevel | undefined; + + /** + *Indicates the creation time of the grouping recommendation.
+ * @public + */ + creationTime: Date | undefined; + + /** + *Indicates the reason you had selected while rejecting a grouping recommendation.
+ * @public + */ + rejectionReason?: GroupingRecommendationRejectionReason; +} + +/** + * @public + */ +export interface ListResourceGroupingRecommendationsResponse { + /** + *List of resource grouping recommendations generated by Resilience Hub.
+ * @public + */ + groupingRecommendations: GroupingRecommendation[] | undefined; + + /** + *Null, or the token from a previous call to get the next set of results.
+ * @public + */ + nextToken?: string; +} + /** * @public */ @@ -5900,6 +6343,66 @@ export interface PutDraftAppVersionTemplateResponse { appVersion?: string; } +/** + *Indicates the rejected grouping recommendation.
+ * @public + */ +export interface RejectGroupingRecommendationEntry { + /** + *Indicates the identifier of the grouping recommendation.
+ * @public + */ + groupingRecommendationId: string | undefined; + + /** + *Indicates the reason you had selected while rejecting a grouping recommendation.
+ * @public + */ + rejectionReason?: GroupingRecommendationRejectionReason; +} + +/** + * @public + */ +export interface RejectResourceGroupingRecommendationsRequest { + /** + *Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is:
+ * arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs,
+ * see
+ * Amazon Resource Names (ARNs) in the
+ * Amazon Web Services General Reference guide.
Indicates the list of resource grouping recommendations you have selected to exclude from your application.
+ * @public + */ + entries: RejectGroupingRecommendationEntry[] | undefined; +} + +/** + * @public + */ +export interface RejectResourceGroupingRecommendationsResponse { + /** + *Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is:
+ * arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs,
+ * see
+ * Amazon Resource Names (ARNs) in the
+ * Amazon Web Services General Reference guide.
Indicates the list of resource grouping recommendations that failed to get excluded in your application.
+ * @public + */ + failedEntries: FailedGroupingRecommendationEntry[] | undefined; +} + /** * @public */ @@ -5927,7 +6430,8 @@ export interface RemoveDraftAppVersionResourceMappingsRequest { logicalStackNames?: string[]; /** - *The names of the registered applications you want to remove from the resource mappings.
+ *The names of the registered applications you want to remove from the resource + * mappings.
* @public */ appRegistryAppNames?: string[]; @@ -5945,7 +6449,8 @@ export interface RemoveDraftAppVersionResourceMappingsRequest { terraformSourceNames?: string[]; /** - *The names of the Amazon Elastic Kubernetes Service clusters and namespaces you want to remove from the resource mappings.
+ *The names of the Amazon Elastic Kubernetes Service clusters and namespaces you want to remove from + * the resource mappings.
*This parameter accepts values in "eks-cluster/namespace" format.
*Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is:
+ * arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs,
+ * see
+ * Amazon Resource Names (ARNs) in the
+ * Amazon Web Services General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is:
+ * arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs,
+ * see
+ * Amazon Resource Names (ARNs) in the
+ * Amazon Web Services General Reference guide.
Indicates the identifier of the grouping recommendation task.
+ * @public + */ + groupingId: string | undefined; + + /** + *Status of the action.
+ * @public + */ + status: ResourcesGroupingRecGenStatusType | undefined; + + /** + *Indicates the error that occurred while executing a grouping recommendation task.
+ * @public + */ + errorMessage?: string; +} + /** * @public */ @@ -6162,9 +6715,7 @@ export interface UpdateAppRequest { clearResiliencyPolicyArn?: boolean; /** - *- * Assessment execution schedule with 'Daily' or 'Disabled' values. - *
+ *Assessment execution schedule with 'Daily' or 'Disabled' values.
* @public */ assessmentSchedule?: AppAssessmentScheduleType; @@ -6178,8 +6729,8 @@ export interface UpdateAppRequest { permissionModel?: PermissionModel; /** - *The list of events you would like to subscribe and get notification for. - * Currently, Resilience Hub supports notifications only for Drift + *
The list of events you would like to subscribe and get notification for. Currently, + * Resilience Hub supports notifications only for Drift * detected and Scheduled assessment failure * events.
* @public @@ -6388,7 +6939,8 @@ export interface UpdateAppVersionResourceRequest { /** *Indicates if a resource is excluded from an Resilience Hub application.
*You can exclude only imported resources from an Resilience Hub application.
+ *You can exclude only imported resources from an Resilience Hub + * application.
*Indicates the identifier of the grouping recommendation.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Indicates the grouping recommendation you have accepted to include in your application.
" + } + }, + "com.amazonaws.resiliencehub#AcceptResourceGroupingRecommendations": { + "type": "operation", + "input": { + "target": "com.amazonaws.resiliencehub#AcceptResourceGroupingRecommendationsRequest" + }, + "output": { + "target": "com.amazonaws.resiliencehub#AcceptResourceGroupingRecommendationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.resiliencehub#AccessDeniedException" + }, + { + "target": "com.amazonaws.resiliencehub#InternalServerException" + }, + { + "target": "com.amazonaws.resiliencehub#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.resiliencehub#ThrottlingException" + }, + { + "target": "com.amazonaws.resiliencehub#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Accepts the resource grouping recommendations suggested by Resilience Hub for your application.
", + "smithy.api#http": { + "method": "POST", + "uri": "/accept-resource-grouping-recommendations", + "code": 200 + } + } + }, + "com.amazonaws.resiliencehub#AcceptResourceGroupingRecommendationsRequest": { + "type": "structure", + "members": { + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n Amazon Web Services General Reference guide.
Indicates the list of resource grouping recommendations you want to include in your application.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.resiliencehub#AcceptResourceGroupingRecommendationsResponse": { + "type": "structure", + "members": { + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n Amazon Web Services General Reference guide.
Indicates the list of resource grouping recommendations that could not be included in your application.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.resiliencehub#AccessDeniedException": { "type": "structure", "members": { @@ -35,6 +140,9 @@ { "target": "com.amazonaws.resiliencehub#ResourceNotFoundException" }, + { + "target": "com.amazonaws.resiliencehub#ServiceQuotaExceededException" + }, { "target": "com.amazonaws.resiliencehub#ThrottlingException" }, @@ -43,7 +151,7 @@ } ], "traits": { - "smithy.api#documentation": "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 Step 2: How is your application managed? in the Resilience Hub User Guide.
", + "smithy.api#documentation": "Adds the source of resource-maps to the draft version of an application. During\n assessment, Resilience Hub will use these resource-maps to resolve the latest physical\n ID for each resource in the application template. For more information about different types\n of resources supported by Resilience Hub and how to add them in your application, see\n Step\n 2: How is your application managed? in the Resilience Hub User Guide.
", "smithy.api#http": { "method": "POST", "uri": "/add-draft-app-version-resource-mappings", @@ -470,6 +578,12 @@ "traits": { "smithy.api#documentation": "Indicates if compliance drifts (deviations) were detected while running an assessment for\n your application.
" } + }, + "summary": { + "target": "com.amazonaws.resiliencehub#AssessmentSummary", + "traits": { + "smithy.api#documentation": "Indicates a concise summary that provides an overview of the Resilience Hub assessment.
" + } } }, "traits": { @@ -553,7 +667,7 @@ "complianceStatus": { "target": "com.amazonaws.resiliencehub#ComplianceStatus", "traits": { - "smithy.api#documentation": "TCurrent status of compliance for the resiliency policy.
" + "smithy.api#documentation": "Current\n status of compliance for the resiliency policy.
" } }, "cost": { @@ -611,6 +725,14 @@ { "value": "ChangesDetected", "name": "CHANGES_DETECTED" + }, + { + "value": "NotApplicable", + "name": "NOT_APPLICABLE" + }, + { + "value": "MissingPolicy", + "name": "MISSING_POLICY" } ] } @@ -619,7 +741,7 @@ "type": "structure", "members": { "name": { - "target": "com.amazonaws.resiliencehub#String255", + "target": "com.amazonaws.resiliencehub#EntityName255", "traits": { "smithy.api#documentation": "Name of the Application Component.
", "smithy.api#required": {} @@ -633,7 +755,7 @@ } }, "id": { - "target": "com.amazonaws.resiliencehub#String255", + "target": "com.amazonaws.resiliencehub#EntityName255", "traits": { "smithy.api#documentation": "Identifier of the Application Component.
" } @@ -966,6 +1088,38 @@ ] } }, + "com.amazonaws.resiliencehub#AssessmentRiskRecommendation": { + "type": "structure", + "members": { + "risk": { + "target": "com.amazonaws.resiliencehub#String255", + "traits": { + "smithy.api#documentation": "Indicates the description of the potential risk identified in the application as part of the Resilience Hub assessment.
\nThis property is available only in the US East (N. Virginia) Region.
\nIndicates the recommendation provided by the Resilience Hub to address the identified\n risks in the application.
\nThis property is available only in the US East (N. Virginia) Region.
\nIndicates the Application Components (AppComponents) that were assessed as part of the\n assessnent and are associated with the identified risk and recommendation.
\nThis property is available only in the US East (N. Virginia) Region.
\nIndicates a specific risk identified in the Resilience Hub assessment and the corresponding recommendation provided to address that risk.
\nThe assessment summary generated by large language models (LLMs) on Amazon Bedrock are only suggestions. \n The current level of generative AI technology is not perfect and LLMs are not infallible. \n Bias and incorrect answers, although rare, should be expected. Review each recommendation in the assessment summary before you use the output from an LLM.\n
\nThis property is available only in the US East (N. Virginia) Region.
\nIndicates a concise summary that provides an overview of the Resilience Hub assessment.
\nThis property is available only in the US East (N. Virginia) Region.
\nIndicates the top risks and recommendations identified by the Resilience Hub assessment, \n each representing a specific risk and the corresponding recommendation to address it.
\nThis property is available only in the US East (N. Virginia) Region.
\nIndicates the AI-generated summary for the Resilience Hub assessment, providing a concise overview that highlights the top risks and recommendations.
\nThis property is available only in the US East (N. Virginia) Region.
\nDefines the list of operational recommendations that need to be included or excluded.
", + "smithy.api#documentation": "Defines the list of operational recommendations that need to be included or\n excluded.
", "smithy.api#required": {} } } @@ -2176,7 +2365,7 @@ "failedEntries": { "target": "com.amazonaws.resiliencehub#BatchUpdateRecommendationStatusFailedEntries", "traits": { - "smithy.api#documentation": "A list of items with error details about each item, which could not be included or excluded.
", + "smithy.api#documentation": "A list of items with error details about each item, which could not be included or\n excluded.
", "smithy.api#required": {} } } @@ -2306,7 +2495,7 @@ "diffType": { "target": "com.amazonaws.resiliencehub#DifferenceType", "traits": { - "smithy.api#documentation": "Difference type between actual and expected recovery point objective (RPO) and recovery\n time objective (RTO) values. Currently, Resilience Hub supports only NotEqual difference type.
" + "smithy.api#documentation": "Difference type between actual and expected recovery point objective (RPO) and recovery\n time objective (RTO) values. Currently, Resilience Hub supports only\n NotEqual difference type.
Creates an Resilience Hub application. An Resilience Hub application is a\n collection of Amazon Web Services resources structured to prevent and recover Amazon Web Services application disruptions. To describe a Resilience Hub application,\n you provide an application name, resources from one or more CloudFormation stacks, Resource Groups, Terraform state files, AppRegistry applications, and an appropriate\n 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 Service\n quotas.
\nAfter you create an Resilience Hub application, you publish it so that you can run a resiliency\n assessment on it. You can then use recommendations from the assessment to improve resiliency\n by running another assessment, comparing results, and then iterating the process until you\n achieve your goals for recovery time objective (RTO) and recovery point objective\n (RPO).
", + "smithy.api#documentation": "Creates an Resilience Hub application. An Resilience Hub application is a\n 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\n application name, resources from one or more CloudFormation stacks, Resource Groups, Terraform state files, AppRegistry applications, and an appropriate\n 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\n about the number of resources supported per application, see Service\n quotas.
\nAfter you create an Resilience Hub application, you publish it so that you can run\n a resiliency assessment on it. You can then use recommendations from the assessment to improve\n resiliency by running another assessment, comparing results, and then iterating the process\n until you achieve your goals for recovery time objective (RTO) and recovery point objective\n (RPO).
", "smithy.api#http": { "method": "POST", "uri": "/create-app", @@ -2640,7 +2837,7 @@ "assessmentSchedule": { "target": "com.amazonaws.resiliencehub#AppAssessmentScheduleType", "traits": { - "smithy.api#documentation": "\n Assessment execution schedule with 'Daily' or 'Disabled' values.\n
" + "smithy.api#documentation": "Assessment execution schedule with 'Daily' or 'Disabled' values.
" } }, "permissionModel": { @@ -2652,7 +2849,7 @@ "eventSubscriptions": { "target": "com.amazonaws.resiliencehub#EventSubscriptionList", "traits": { - "smithy.api#documentation": "The list of events you would like to subscribe and get notification for. Currently, Resilience Hub supports only Drift detected and Scheduled assessment failure events notification.
" + "smithy.api#documentation": "The list of events you would like to subscribe and get notification for. Currently,\n Resilience Hub supports only Drift detected and\n Scheduled assessment failure events notification.
" } } } @@ -2701,7 +2898,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new Application Component in the Resilience Hub application.
\nThis API updates the Resilience Hub application draft version. To use this Application Component for running assessments, you must publish the Resilience Hub application using the PublishAppVersion API.
Creates a new Application Component in the Resilience Hub application.
\nThis API updates the Resilience Hub application draft version. To use this\n Application Component for running assessments, you must publish the Resilience Hub\n application using the PublishAppVersion API.
Adds a resource to the Resilience Hub application and assigns it to the specified\n Application Components. If you specify a new Application Component, Resilience Hub will automatically\n create the Application Component.
\nThis action has no effect outside Resilience Hub.
\nThis API updates the Resilience Hub application draft version. To use this resource\n for running resiliency assessments, you must publish the Resilience Hub application using\n the PublishAppVersion API.
To update application version with new physicalResourceID, you must\n call ResolveAppVersionResources API.
Adds a resource to the Resilience Hub application and assigns it to the specified\n Application Components. If you specify a new Application Component, Resilience Hub will\n automatically create the Application Component.
\nThis action has no effect outside Resilience Hub.
\nThis API updates the Resilience Hub application draft version. To use this\n resource for running resiliency assessments, you must publish the Resilience Hub\n application using the PublishAppVersion API.
To update application version with new physicalResourceID, you must\n call ResolveAppVersionResources API.
Creates a resiliency policy for an application.
\nResilience Hub allows you to provide a value of zero for rtoInSecs and\n rpoInSecs of your resiliency policy. But, while assessing your application, the lowest possible assessment result is near zero. Hence, if you provide value\n zero for rtoInSecs and rpoInSecs, the estimated workload RTO and estimated workload RPO result will be near zero and the Compliance\n status for your application will be set to Policy\n breached.
Creates a resiliency policy for an application.
\nResilience Hub allows you to provide a value of zero for rtoInSecs\n and rpoInSecs of your resiliency policy. But, while assessing your application,\n the lowest possible assessment result is near zero. Hence, if you provide value zero for\n rtoInSecs and rpoInSecs, the estimated workload RTO and\n estimated workload RPO result will be near zero and the Compliance\n status for your application will be set to Policy\n breached.
Deletes an Resilience Hub application assessment. This is a destructive action that can't\n be undone.
", + "smithy.api#documentation": "Deletes an Resilience Hub application assessment. This is a destructive action\n that can't be undone.
", "smithy.api#http": { "method": "POST", "uri": "/delete-app-assessment", @@ -3294,7 +3491,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the input source and all of its imported resources from the Resilience Hub application.
", + "smithy.api#documentation": "Deletes the input source and all of its imported resources from the Resilience Hub\n application.
", "smithy.api#http": { "method": "POST", "uri": "/delete-app-input-source", @@ -3315,13 +3512,13 @@ "sourceArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the imported resource you want to remove from the\n Resilience Hub application. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n Amazon Web Services General Reference guide.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the imported resource you want to remove from the\n Resilience Hub application. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n Amazon Web Services General Reference guide.
" } }, "terraformSource": { "target": "com.amazonaws.resiliencehub#TerraformSource", "traits": { - "smithy.api#documentation": "The imported Terraform s3 state file you want to remove from the Resilience Hub application.
" + "smithy.api#documentation": "The imported Terraform s3 state file you want to remove from the Resilience Hub\n application.
" } }, "clientToken": { @@ -3334,7 +3531,7 @@ "eksSourceClusterNamespace": { "target": "com.amazonaws.resiliencehub#EksSourceClusterNamespace", "traits": { - "smithy.api#documentation": "The namespace on your Amazon Elastic Kubernetes Service cluster that you want to delete from the Resilience Hub application.
" + "smithy.api#documentation": "The namespace on your Amazon Elastic Kubernetes Service cluster that you want to delete from the\n Resilience Hub application.
" } } } @@ -3422,7 +3619,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an Application Component from the Resilience Hub application.
\nThis API updates the Resilience Hub application draft version. To use this Application Component for running assessments, you must publish the Resilience Hub application using the PublishAppVersion API.
You will not be able to delete an Application Component if it has resources associated with it.
\nDeletes an Application Component from the Resilience Hub application.
\nThis API updates the Resilience Hub application draft version. To use this\n Application Component for running assessments, you must publish the Resilience Hub\n application using the PublishAppVersion API.
You will not be able to delete an Application Component if it has resources associated\n with it.
\nDeletes a resource from the Resilience Hub application.
\nYou can only delete a manually added resource. To exclude non-manually added resources, use the UpdateAppVersionResource API.
This action has no effect outside Resilience Hub.
\nThis API updates the Resilience Hub application draft version. To use this resource for running resiliency assessments, you must publish the Resilience Hub application using the PublishAppVersion API.
Deletes a resource from the Resilience Hub application.
\nYou can only delete a manually added resource. To exclude non-manually added\n resources, use the UpdateAppVersionResource API.
This action has no effect outside Resilience Hub.
\nThis API updates the Resilience Hub application draft version. To use this\n resource for running resiliency assessments, you must publish the Resilience Hub\n application using the PublishAppVersion API.
The assessment for an Resilience Hub application, returned as an object. This object\n includes Amazon Resource Names (ARNs), compliance information, compliance status, cost,\n messages, resiliency scores, and more.
", + "smithy.api#documentation": "The assessment for an Resilience Hub application, returned as an object. This\n object includes Amazon Resource Names (ARNs), compliance information, compliance status, cost,\n messages, resiliency scores, and more.
", "smithy.api#required": {} } } @@ -4018,7 +4215,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes a resource of the Resilience Hub application.
\nThis API accepts only one of the following parameters to descibe the resource:
\n\n resourceName\n
\n logicalResourceId\n
\n physicalResourceId (Along with physicalResourceId, you can also\n provide awsAccountId, and awsRegion)
Describes a resource of the Resilience Hub application.
\nThis API accepts only one of the following parameters to describe the resource:
\n\n resourceName\n
\n logicalResourceId\n
\n physicalResourceId (Along with physicalResourceId, you can\n also provide awsAccountId, and awsRegion)
A JSON string that provides information about your application structure. To learn more\n about the appTemplateBody template, see the sample template provided in the\n Examples section.
The appTemplateBody JSON string has the following structure:
\n \n resources\n \n
The list of logical resources that must be included in the Resilience Hub\n application.
\nType: Array
\nDon't add the resources that you want to exclude.
\nEach resources array item includes the following fields:
\n \n logicalResourceId\n \n
Logical identifier of the resource.
\nType: Object
\nEach logicalResourceId object includes the following fields:
\n identifier\n
Identifier of the resource.
\nType: String
\n\n logicalStackName\n
The name of the CloudFormation stack this resource belongs to.
\nType: String
\n\n resourceGroupName\n
The name of the resource group this resource belongs to.
\nType: String
\n\n terraformSourceName\n
The name of the Terraform S3 state file this resource belongs to.
\nType: String
\n\n eksSourceName\n
Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.
\nThis parameter accepts values in \"eks-cluster/namespace\" format.
\nType: String
\n\n \n type\n \n
The type of resource.
\nType: string
\n\n \n name\n \n
The name of the resource.
\nType: String
\n\n additionalInfo\n
Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.
Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.
\nKey: \"failover-regions\"\n
Value: \"[{\"region\":\"<REGION>\", \"accounts\":[{\"id\":\"<ACCOUNT_ID>\"}]}]\"\n
\n \n appComponents\n \n
List of Application Components that this resource belongs to. If an Application Component is not part of the Resilience Hub application, it will be added.
\nType: Array
\nEach appComponents array item includes the following fields:
\n name\n
Name of the Application Component.
\nType: String
\n\n type\n
Type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent.
\nType: String
\n\n resourceNames\n
The list of included resources that are assigned to the Application Component.
\nType: Array of strings
\n\n additionalInfo\n
Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.
Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.
\nKey: \"failover-regions\"\n
Value: \"[{\"region\":\"<REGION>\", \"accounts\":[{\"id\":\"<ACCOUNT_ID>\"}]}]\"\n
\n \n excludedResources\n \n
The list of logical resource identifiers to be excluded from the application.
\nType: Array
\nDon't add the resources that you want to include.
\nEach excludedResources array item includes the following fields:
\n \n logicalResourceIds\n \n
Logical identifier of the resource.
\nType: Object
\nYou can configure only one of the following fields:
\n\n logicalStackName\n
\n resourceGroupName\n
\n terraformSourceName\n
\n eksSourceName\n
Each logicalResourceIds object includes the following fields:
\n identifier\n
Identifier of the resource.
\nType: String
\n\n logicalStackName\n
The name of the CloudFormation stack this resource belongs to.
\nType: String
\n\n resourceGroupName\n
The name of the resource group this resource belongs to.
\nType: String
\n\n terraformSourceName\n
The name of the Terraform S3 state file this resource belongs to.
\nType: String
\n\n eksSourceName\n
Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.
\nThis parameter accepts values in \"eks-cluster/namespace\" format.
\nType: String
\n\n \n version\n \n
Resilience Hub application version.
\n\n additionalInfo\n
Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.
Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.
\nKey: \"failover-regions\"\n
Value: \"[{\"region\":\"<REGION>\", \"accounts\":[{\"id\":\"<ACCOUNT_ID>\"}]}]\"\n
A JSON string that provides information about your application structure. To learn more\n about the appTemplateBody template, see the sample template provided in the\n Examples section.
The appTemplateBody JSON string has the following structure:
\n \n resources\n \n
The list of logical resources that must be included in the Resilience Hub\n application.
\nType: Array
\nDon't add the resources that you want to exclude.
\nEach resources array item includes the following fields:
\n \n logicalResourceId\n \n
Logical identifier of the resource.
\nType: Object
\nEach logicalResourceId object includes the following fields:
\n identifier\n
Identifier of the resource.
\nType: String
\n\n logicalStackName\n
The name of the CloudFormation stack this resource belongs to.
\nType: String
\n\n resourceGroupName\n
The name of the resource group this resource belongs to.
\nType: String
\n\n terraformSourceName\n
The name of the Terraform S3 state file this resource belongs to.
\nType: String
\n\n eksSourceName\n
Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.
\nThis parameter accepts values in \"eks-cluster/namespace\" format.
\nType: String
\n\n \n type\n \n
The type of resource.
\nType: string
\n\n \n name\n \n
The name of the resource.
\nType: String
\n\n additionalInfo\n
Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.
Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.
\nKey: \"failover-regions\"\n
Value: \"[{\"region\":\"<REGION>\", \"accounts\":[{\"id\":\"<ACCOUNT_ID>\"}]}]\"\n
\n \n appComponents\n \n
List of Application Components that this resource belongs to. If an Application Component is not part of the Resilience Hub application, it will be added.
\nType: Array
\nEach appComponents array item includes the following fields:
\n name\n
Name of the Application Component.
\nType: String
\n\n type\n
Type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent.
\nType: String
\n\n resourceNames\n
The list of included resources that are assigned to the Application Component.
\nType: Array of strings
\n\n additionalInfo\n
Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.
Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.
\nKey: \"failover-regions\"\n
Value: \"[{\"region\":\"<REGION>\", \"accounts\":[{\"id\":\"<ACCOUNT_ID>\"}]}]\"\n
\n \n excludedResources\n \n
The list of logical resource identifiers to be excluded from the application.
\nType: Array
\nDon't add the resources that you want to include.
\nEach excludedResources array item includes the following fields:
\n \n logicalResourceIds\n \n
Logical identifier of the resource.
\nType: Object
\nYou can configure only one of the following fields:
\n\n logicalStackName\n
\n resourceGroupName\n
\n terraformSourceName\n
\n eksSourceName\n
Each logicalResourceIds object includes the following fields:
\n identifier\n
Identifier of the resource.
\nType: String
\n\n logicalStackName\n
The name of the CloudFormation stack this resource belongs to.
\nType: String
\n\n resourceGroupName\n
The name of the resource group this resource belongs to.
\nType: String
\n\n terraformSourceName\n
The name of the Terraform S3 state file this resource belongs to.
\nType: String
\n\n eksSourceName\n
Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.
\nThis parameter accepts values in \"eks-cluster/namespace\" format.
\nType: String
\n\n \n version\n \n
Resilience Hub application version.
\n\n additionalInfo\n
Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.
Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.
\nKey: \"failover-regions\"\n
Value: \"[{\"region\":\"<REGION>\", \"accounts\":[{\"id\":\"<ACCOUNT_ID>\"}]}]\"\n
Describes the status of importing resources to an application version.
\nIf you get a 404 error with\n ResourceImportStatusNotFoundAppMetadataException, you must call\n importResourcesToDraftAppVersion after creating the application and before\n calling describeDraftAppVersionResourcesImportStatus to obtain the\n status.
Describes the status of importing resources to an application version.
\nIf you get a 404 error with\n ResourceImportStatusNotFoundAppMetadataException, you must call\n importResourcesToDraftAppVersion after creating the application and before\n calling describeDraftAppVersionResourcesImportStatus to obtain the\n status.
Describes the resource grouping recommendation tasks run by Resilience Hub for your application.
", + "smithy.api#http": { + "method": "POST", + "uri": "/describe-resource-grouping-recommendation-task", + "code": 200 + } + } + }, + "com.amazonaws.resiliencehub#DescribeResourceGroupingRecommendationTaskRequest": { + "type": "structure", + "members": { + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n Amazon Web Services General Reference guide.
Indicates the identifier of the grouping recommendation task.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.resiliencehub#DescribeResourceGroupingRecommendationTaskResponse": { + "type": "structure", + "members": { + "groupingId": { + "target": "com.amazonaws.resiliencehub#String255", + "traits": { + "smithy.api#documentation": "Indicates the identifier of the grouping recommendation task.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.resiliencehub#ResourcesGroupingRecGenStatusType", + "traits": { + "smithy.api#documentation": "Status of the action.
", + "smithy.api#required": {} + } + }, + "errorMessage": { + "target": "com.amazonaws.resiliencehub#String500", + "traits": { + "smithy.api#documentation": "Indicates the error that occurred while generating a grouping recommendation.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.resiliencehub#DifferenceType": { "type": "string", "traits": { @@ -4714,6 +4994,12 @@ "smithy.api#pattern": "^[A-Za-z0-9][A-Za-z0-9_\\-]{1,59}$" } }, + "com.amazonaws.resiliencehub#EntityName255": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[A-Za-z0-9][A-Za-z0-9_\\-]{0,254}$" + } + }, "com.amazonaws.resiliencehub#EntityNameList": { "type": "list", "member": { @@ -4832,6 +5118,34 @@ ] } }, + "com.amazonaws.resiliencehub#FailedGroupingRecommendationEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.resiliencehub#FailedGroupingRecommendationEntry" + } + }, + "com.amazonaws.resiliencehub#FailedGroupingRecommendationEntry": { + "type": "structure", + "members": { + "groupingRecommendationId": { + "target": "com.amazonaws.resiliencehub#String255", + "traits": { + "smithy.api#documentation": "Indicates the identifier of the grouping recommendation.
", + "smithy.api#required": {} + } + }, + "errorMessage": { + "target": "com.amazonaws.resiliencehub#ErrorMessage", + "traits": { + "smithy.api#documentation": "Indicates the error that occurred while implementing a grouping recommendation.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Indicates the accepted grouping recommendation whose implementation failed.
" + } + }, "com.amazonaws.resiliencehub#FailurePolicy": { "type": "structure", "members": { @@ -4856,12 +5170,224 @@ "smithy.api#documentation": "Defines a failure policy.
" } }, - "com.amazonaws.resiliencehub#HaArchitecture": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "MultiSite", + "com.amazonaws.resiliencehub#GroupingAppComponent": { + "type": "structure", + "members": { + "appComponentId": { + "target": "com.amazonaws.resiliencehub#EntityName255", + "traits": { + "smithy.api#documentation": "Indicates the identifier of an AppComponent.
", + "smithy.api#required": {} + } + }, + "appComponentType": { + "target": "com.amazonaws.resiliencehub#String255", + "traits": { + "smithy.api#documentation": "Indicates the type of an AppComponent.
", + "smithy.api#required": {} + } + }, + "appComponentName": { + "target": "com.amazonaws.resiliencehub#EntityName255", + "traits": { + "smithy.api#documentation": "Indicates the name of an AppComponent.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Creates a new recommended Application Component (AppComponent).
" + } + }, + "com.amazonaws.resiliencehub#GroupingRecommendation": { + "type": "structure", + "members": { + "groupingRecommendationId": { + "target": "com.amazonaws.resiliencehub#String255", + "traits": { + "smithy.api#documentation": "Indicates all the reasons available for rejecting a grouping recommendation.
", + "smithy.api#required": {} + } + }, + "groupingAppComponent": { + "target": "com.amazonaws.resiliencehub#GroupingAppComponent", + "traits": { + "smithy.api#documentation": "Indicates the name of the recommended Application Component (AppComponent).
", + "smithy.api#required": {} + } + }, + "resources": { + "target": "com.amazonaws.resiliencehub#GroupingResourceList", + "traits": { + "smithy.api#documentation": "Indicates the resources that are grouped in a recommended AppComponent.
", + "smithy.api#required": {} + } + }, + "score": { + "target": "com.amazonaws.resiliencehub#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Indicates the confidence level of the grouping recommendation.
", + "smithy.api#required": {} + } + }, + "recommendationReasons": { + "target": "com.amazonaws.resiliencehub#String255List", + "traits": { + "smithy.api#documentation": "Indicates all the reasons available for rejecting a grouping recommendation.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.resiliencehub#GroupingRecommendationStatusType", + "traits": { + "smithy.api#documentation": "Indicates the status of grouping resources into AppComponents.
", + "smithy.api#required": {} + } + }, + "confidenceLevel": { + "target": "com.amazonaws.resiliencehub#GroupingRecommendationConfidenceLevel", + "traits": { + "smithy.api#documentation": "Indicates the confidence level of Resilience Hub on the grouping recommendation.
", + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.resiliencehub#TimeStamp", + "traits": { + "smithy.api#documentation": "Indicates the creation time of the grouping recommendation.
", + "smithy.api#required": {} + } + }, + "rejectionReason": { + "target": "com.amazonaws.resiliencehub#GroupingRecommendationRejectionReason", + "traits": { + "smithy.api#documentation": "Indicates the reason you had selected while rejecting a grouping recommendation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Creates a new grouping recommendation.
" + } + }, + "com.amazonaws.resiliencehub#GroupingRecommendationConfidenceLevel": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "HIGH", + "value": "High" + }, + { + "name": "MEDIUM", + "value": "Medium" + } + ] + } + }, + "com.amazonaws.resiliencehub#GroupingRecommendationList": { + "type": "list", + "member": { + "target": "com.amazonaws.resiliencehub#GroupingRecommendation" + } + }, + "com.amazonaws.resiliencehub#GroupingRecommendationRejectionReason": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "DISTINCT_BUSINESS_PURPOSE", + "value": "DistinctBusinessPurpose" + }, + { + "name": "SEPARATE_DATA_CONCERN", + "value": "SeparateDataConcern" + }, + { + "name": "DISTINCT_USER_GROUP_HANDLING", + "value": "DistinctUserGroupHandling" + }, + { + "name": "OTHER", + "value": "Other" + } + ] + } + }, + "com.amazonaws.resiliencehub#GroupingRecommendationStatusType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "ACCEPTED", + "value": "Accepted" + }, + { + "name": "REJECTED", + "value": "Rejected" + }, + { + "name": "PENDING_DECISION", + "value": "PendingDecision" + } + ] + } + }, + "com.amazonaws.resiliencehub#GroupingResource": { + "type": "structure", + "members": { + "resourceName": { + "target": "com.amazonaws.resiliencehub#String255", + "traits": { + "smithy.api#documentation": "Indicates the resource name.
", + "smithy.api#required": {} + } + }, + "resourceType": { + "target": "com.amazonaws.resiliencehub#String255", + "traits": { + "smithy.api#documentation": "Indicates the resource type.
", + "smithy.api#required": {} + } + }, + "physicalResourceId": { + "target": "com.amazonaws.resiliencehub#PhysicalResourceId", + "traits": { + "smithy.api#documentation": "Indicates the physical identifier of the resource.
", + "smithy.api#required": {} + } + }, + "logicalResourceId": { + "target": "com.amazonaws.resiliencehub#LogicalResourceId", + "traits": { + "smithy.api#documentation": "Indicates the logical identifier of the resource.
", + "smithy.api#required": {} + } + }, + "sourceAppComponentIds": { + "target": "com.amazonaws.resiliencehub#String255List", + "traits": { + "smithy.api#documentation": "Indicates the identifier of the source AppComponents in which the resources were previously grouped into.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Indicates the resource that will be grouped in the recommended Application Component (AppComponent).
" + } + }, + "com.amazonaws.resiliencehub#GroupingResourceList": { + "type": "list", + "member": { + "target": "com.amazonaws.resiliencehub#GroupingResource" + } + }, + "com.amazonaws.resiliencehub#HaArchitecture": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "MultiSite", "name": "MULTI_SITE" }, { @@ -4939,7 +5465,7 @@ } ], "traits": { - "smithy.api#documentation": "Imports resources to Resilience Hub application draft version from different input sources. For more information about the input sources supported by Resilience Hub, see Discover\n the structure and describe your Resilience Hub application.
", + "smithy.api#documentation": "Imports resources to Resilience Hub application draft version from different input\n sources. For more information about the input sources supported by Resilience Hub, see\n Discover the structure and describe your Resilience Hub application.
", "smithy.api#http": { "method": "POST", "uri": "/import-resources-to-draft-app-version", @@ -5016,7 +5542,7 @@ "terraformSources": { "target": "com.amazonaws.resiliencehub#TerraformSourceList", "traits": { - "smithy.api#documentation": "\n A list of terraform file s3 URLs you have imported.\n
" + "smithy.api#documentation": "A list of terraform file s3 URLs you have imported.
" } }, "eksSources": { @@ -5118,7 +5644,7 @@ "alarmRecommendations": { "target": "com.amazonaws.resiliencehub#AlarmRecommendationList", "traits": { - "smithy.api#documentation": "The alarm recommendations for an Resilience Hub application, returned as an object. This\n object includes Application Component names, descriptions, information about whether a\n recommendation has already been implemented or not, prerequisites, and more.
", + "smithy.api#documentation": "The alarm recommendations for an Resilience Hub application, returned as an\n object. This object includes Application Component names, descriptions, information about whether a\n recommendation has already been implemented or not, prerequisites, and more.
", "smithy.api#required": {} } }, @@ -5179,13 +5705,13 @@ "nextToken": { "target": "com.amazonaws.resiliencehub#NextToken", "traits": { - "smithy.api#documentation": "Indicates the unique token number of the next application to be checked for compliance and regulatory requirements from the list of applications.
" + "smithy.api#documentation": "Null, or the token from a previous call to get the next set of results.
" } }, "maxResults": { "target": "com.amazonaws.resiliencehub#MaxResults", "traits": { - "smithy.api#documentation": "Indicates the maximum number of applications requested.
" + "smithy.api#documentation": "Indicates the maximum number of compliance drifts requested.
" } } }, @@ -5199,14 +5725,14 @@ "complianceDrifts": { "target": "com.amazonaws.resiliencehub#ComplianceDriftList", "traits": { - "smithy.api#documentation": "Indicates compliance drifts (recovery time objective (RTO) and recovery point objective (RPO)) detected for an assessed entity.
", + "smithy.api#documentation": "Indicates compliance drifts (recovery time objective (RTO) and recovery point objective\n (RPO)) detected for an assessed entity.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.resiliencehub#NextToken", "traits": { - "smithy.api#documentation": "Token number of the next application to be checked for compliance and regulatory requirements from the list of applications.
" + "smithy.api#documentation": "Null, or the token from a previous call to get the next set of results.
" } } }, @@ -5237,7 +5763,7 @@ } ], "traits": { - "smithy.api#documentation": "Indicates the list of resource drifts that were detected while running an assessment.
", + "smithy.api#documentation": "Indicates the list of resource drifts that were detected while running an\n assessment.
", "smithy.api#http": { "method": "POST", "uri": "/list-app-assessment-resource-drifts", @@ -5270,7 +5796,7 @@ "maxResults": { "target": "com.amazonaws.resiliencehub#MaxResults", "traits": { - "smithy.api#documentation": "Indicates the maximum number of drift results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
Indicates the maximum number of drift results to include in the response. If more results\n exist than the specified MaxResults value, a token is included in the response so\n that the remaining results can be retrieved.
Lists the assessments for an Resilience Hub application. You can use request parameters to\n refine the results for the response object.
", + "smithy.api#documentation": "Lists the assessments for an Resilience Hub application. You can use request\n parameters to refine the results for the response object.
", "smithy.api#http": { "method": "GET", "uri": "/list-app-assessments", @@ -5487,7 +6013,7 @@ "componentCompliances": { "target": "com.amazonaws.resiliencehub#ComponentCompliancesList", "traits": { - "smithy.api#documentation": "The compliances for an Resilience Hub Application Component, returned as an object. This\n object contains the names of the Application Components, compliances, costs, resiliency scores, outage scores, and\n more.
", + "smithy.api#documentation": "The compliances for an Resilience Hub Application Component, returned as an object. This\n object contains the names of the Application Components, compliances, costs, resiliency scores,\n outage scores, and more.
", "smithy.api#required": {} } }, @@ -5568,7 +6094,7 @@ "componentRecommendations": { "target": "com.amazonaws.resiliencehub#ComponentRecommendationList", "traits": { - "smithy.api#documentation": "The recommendations for an Resilience Hub Application Component, returned as an object. This\n object contains the names of the Application Components, configuration recommendations, and recommendation\n statuses.
", + "smithy.api#documentation": "The recommendations for an Resilience Hub Application Component, returned as an object.\n This object contains the names of the Application Components, configuration recommendations, and\n recommendation statuses.
", "smithy.api#required": {} } }, @@ -5606,7 +6132,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists all the input sources of the Resilience Hub application. For more information about the\n input sources supported by Resilience Hub, see Discover\n the structure and describe your Resilience Hub application.
", + "smithy.api#documentation": "Lists all the input sources of the Resilience Hub application. For more\n information about the input sources supported by Resilience Hub, see Discover\n the structure and describe your Resilience Hub application.
", "smithy.api#http": { "method": "POST", "uri": "/list-app-input-sources", @@ -5645,7 +6171,7 @@ "maxResults": { "target": "com.amazonaws.resiliencehub#MaxResults", "traits": { - "smithy.api#documentation": "Maximum number of input sources to be displayed per Resilience Hub application.
" + "smithy.api#documentation": "Maximum number of input sources to be displayed per Resilience Hub\n application.
" } } } @@ -6125,21 +6651,21 @@ "fromLastAssessmentTime": { "target": "com.amazonaws.resiliencehub#TimeStamp", "traits": { - "smithy.api#documentation": "Indicates the lower limit of the range that is used to filter applications based on their last assessment times.
", + "smithy.api#documentation": "Indicates the lower limit of the range that is used to filter applications based on their\n last assessment times.
", "smithy.api#httpQuery": "fromLastAssessmentTime" } }, "toLastAssessmentTime": { "target": "com.amazonaws.resiliencehub#TimeStamp", "traits": { - "smithy.api#documentation": "Indicates the upper limit of the range that is used to filter the applications based on their last assessment times.
", + "smithy.api#documentation": "Indicates the upper limit of the range that is used to filter the applications based on\n their last assessment times.
", "smithy.api#httpQuery": "toLastAssessmentTime" } }, "reverseOrder": { "target": "com.amazonaws.resiliencehub#BooleanOptional", "traits": { - "smithy.api#documentation": "The application list is sorted based on the values of lastAppComplianceEvaluationTime field. By default, application list is sorted in ascending order. To sort the appliation list in descending order, set this field to True.
The application list is sorted based on the values of\n lastAppComplianceEvaluationTime field. By default, application list is sorted\n in ascending order. To sort the application list in descending order, set this field to\n True.
Lists the resource grouping recommendations suggested by Resilience Hub for your application.
", + "smithy.api#http": { + "method": "GET", + "uri": "/list-resource-grouping-recommendations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "groupingRecommendations" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.resiliencehub#ListResourceGroupingRecommendationsRequest": { + "type": "structure", + "members": { + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n Amazon Web Services General Reference guide.
Null, or the token from a previous call to get the next set of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.resiliencehub#MaxResults", + "traits": { + "smithy.api#documentation": "Maximum number of grouping recommendations to be displayed per Resilience Hub application.
", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.resiliencehub#ListResourceGroupingRecommendationsResponse": { + "type": "structure", + "members": { + "groupingRecommendations": { + "target": "com.amazonaws.resiliencehub#GroupingRecommendationList", + "traits": { + "smithy.api#documentation": "List of resource grouping recommendations generated by Resilience Hub.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.resiliencehub#NextToken", + "traits": { + "smithy.api#documentation": "Null, or the token from a previous call to get the next set of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.resiliencehub#ListSopRecommendations": { "type": "operation", "input": { @@ -6384,7 +7001,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the standard operating procedure (SOP) recommendations for the Resilience Hub\n applications.
", + "smithy.api#documentation": "Lists the standard operating procedure (SOP) recommendations for the Resilience Hub applications.
", "smithy.api#http": { "method": "POST", "uri": "/list-sop-recommendations", @@ -6465,7 +7082,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the suggested resiliency policies for the Resilience Hub applications.
", + "smithy.api#documentation": "Lists the suggested resiliency policies for the Resilience Hub\n applications.
", "smithy.api#http": { "method": "GET", "uri": "/list-suggested-resiliency-policies", @@ -6688,7 +7305,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the resources that are not currently supported in Resilience Hub. An unsupported\n resource is a resource that exists in the object that was used to create an app, but is not\n supported by Resilience Hub.
", + "smithy.api#documentation": "Lists the resources that are not currently supported in Resilience Hub. An\n unsupported resource is a resource that exists in the object that was used to create an app,\n but is not supported by Resilience Hub.
", "smithy.api#http": { "method": "POST", "uri": "/list-unsupported-app-version-resources", @@ -7102,7 +7719,7 @@ } ], "traits": { - "smithy.api#documentation": "Adds or updates the app template for an Resilience Hub application draft version.
", + "smithy.api#documentation": "Adds or updates the app template for an Resilience Hub application draft\n version.
", "smithy.api#http": { "method": "POST", "uri": "/put-draft-app-version-template", @@ -7170,6 +7787,10 @@ { "value": "MetCanImprove", "name": "MET_CAN_IMPROVE" + }, + { + "value": "MissingPolicy", + "name": "MISSING_POLICY" } ] } @@ -7439,6 +8060,117 @@ } } }, + "com.amazonaws.resiliencehub#RejectGroupingRecommendationEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.resiliencehub#RejectGroupingRecommendationEntry" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 30 + } + } + }, + "com.amazonaws.resiliencehub#RejectGroupingRecommendationEntry": { + "type": "structure", + "members": { + "groupingRecommendationId": { + "target": "com.amazonaws.resiliencehub#String255", + "traits": { + "smithy.api#documentation": "Indicates the identifier of the grouping recommendation.
", + "smithy.api#required": {} + } + }, + "rejectionReason": { + "target": "com.amazonaws.resiliencehub#GroupingRecommendationRejectionReason", + "traits": { + "smithy.api#documentation": "Indicates the reason you had selected while rejecting a grouping recommendation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Indicates the rejected grouping recommendation.
" + } + }, + "com.amazonaws.resiliencehub#RejectResourceGroupingRecommendations": { + "type": "operation", + "input": { + "target": "com.amazonaws.resiliencehub#RejectResourceGroupingRecommendationsRequest" + }, + "output": { + "target": "com.amazonaws.resiliencehub#RejectResourceGroupingRecommendationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.resiliencehub#AccessDeniedException" + }, + { + "target": "com.amazonaws.resiliencehub#InternalServerException" + }, + { + "target": "com.amazonaws.resiliencehub#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.resiliencehub#ThrottlingException" + }, + { + "target": "com.amazonaws.resiliencehub#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Rejects resource grouping recommendations.
", + "smithy.api#http": { + "method": "POST", + "uri": "/reject-resource-grouping-recommendations", + "code": 200 + } + } + }, + "com.amazonaws.resiliencehub#RejectResourceGroupingRecommendationsRequest": { + "type": "structure", + "members": { + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n Amazon Web Services General Reference guide.
Indicates the list of resource grouping recommendations you have selected to exclude from your application.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.resiliencehub#RejectResourceGroupingRecommendationsResponse": { + "type": "structure", + "members": { + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n Amazon Web Services General Reference guide.
Indicates the list of resource grouping recommendations that failed to get excluded in your application.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.resiliencehub#RemoveDraftAppVersionResourceMappings": { "type": "operation", "input": { @@ -7501,7 +8233,7 @@ "appRegistryAppNames": { "target": "com.amazonaws.resiliencehub#EntityNameList", "traits": { - "smithy.api#documentation": "The names of the registered applications you want to remove from the resource mappings.
" + "smithy.api#documentation": "The names of the registered applications you want to remove from the resource\n mappings.
" } }, "resourceGroupNames": { @@ -7519,7 +8251,7 @@ "eksSourceNames": { "target": "com.amazonaws.resiliencehub#String255List", "traits": { - "smithy.api#documentation": "The names of the Amazon Elastic Kubernetes Service clusters and namespaces you want to remove from the resource mappings.
\nThis parameter accepts values in \"eks-cluster/namespace\" format.
\nThe names of the Amazon Elastic Kubernetes Service clusters and namespaces you want to remove from\n the resource mappings.
\nThis parameter accepts values in \"eks-cluster/namespace\" format.
\nThis indicates if there are more errors not listed in the resourceErrors list.
" + "smithy.api#documentation": " This indicates if there are more errors not listed in the\n resourceErrors\n list.
Starts grouping recommendation task.
", + "smithy.api#http": { + "method": "POST", + "uri": "/start-resource-grouping-recommendation-task", + "code": 200 + } + } + }, + "com.amazonaws.resiliencehub#StartResourceGroupingRecommendationTaskRequest": { + "type": "structure", + "members": { + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n Amazon Web Services General Reference guide.
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n Amazon Web Services General Reference guide.
Indicates the identifier of the grouping recommendation task.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.resiliencehub#ResourcesGroupingRecGenStatusType", + "traits": { + "smithy.api#documentation": "Status of the action.
", + "smithy.api#required": {} + } + }, + "errorMessage": { + "target": "com.amazonaws.resiliencehub#String500", + "traits": { + "smithy.api#documentation": "Indicates the error that occurred while executing a grouping recommendation task.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.resiliencehub#String1024": { "type": "string", "traits": { @@ -8933,7 +9775,7 @@ "assessmentSchedule": { "target": "com.amazonaws.resiliencehub#AppAssessmentScheduleType", "traits": { - "smithy.api#documentation": "\n Assessment execution schedule with 'Daily' or 'Disabled' values.\n
" + "smithy.api#documentation": "Assessment execution schedule with 'Daily' or 'Disabled' values.
" } }, "permissionModel": { @@ -8945,7 +9787,7 @@ "eventSubscriptions": { "target": "com.amazonaws.resiliencehub#EventSubscriptionList", "traits": { - "smithy.api#documentation": "The list of events you would like to subscribe and get notification for.\n Currently, Resilience Hub supports notifications only for Drift\n detected and Scheduled assessment failure\n events.
" + "smithy.api#documentation": "The list of events you would like to subscribe and get notification for. Currently,\n Resilience Hub supports notifications only for Drift\n detected and Scheduled assessment failure\n events.
" } } } @@ -8991,7 +9833,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the Resilience Hub application version.
\nThis API updates the Resilience Hub application draft version. To use this information\n for running resiliency assessments, you must publish the Resilience Hub application using the\n PublishAppVersion API.
Updates the Resilience Hub application version.
\nThis API updates the Resilience Hub application draft version. To use this\n information for running resiliency assessments, you must publish the Resilience Hub\n application using the PublishAppVersion API.
Updates an existing Application Component in the Resilience Hub application.
\nThis API updates the Resilience Hub application draft version. To use this Application Component for running assessments, you must publish the Resilience Hub application using the PublishAppVersion API.
Updates an existing Application Component in the Resilience Hub application.
\nThis API updates the Resilience Hub application draft version. To use this\n Application Component for running assessments, you must publish the Resilience Hub\n application using the PublishAppVersion API.
Updates the resource details in the Resilience Hub application.
\nThis action has no effect outside Resilience Hub.
\nThis API updates the Resilience Hub application draft version. To use this resource for running resiliency assessments, you must publish the Resilience Hub application using the PublishAppVersion API.
To update application version with new physicalResourceID, you must call\n ResolveAppVersionResources API.
Updates the resource details in the Resilience Hub application.
\nThis action has no effect outside Resilience Hub.
\nThis API updates the Resilience Hub application draft version. To use this\n resource for running resiliency assessments, you must publish the Resilience Hub\n application using the PublishAppVersion API.
To update application version with new physicalResourceID, you must\n call ResolveAppVersionResources API.
Indicates if a resource is excluded from an Resilience Hub application.
\nYou can exclude only imported resources from an Resilience Hub application.
\nIndicates if a resource is excluded from an Resilience Hub application.
\nYou can exclude only imported resources from an Resilience Hub\n application.
\nUpdates a resiliency policy.
\nResilience Hub allows you to provide a value of zero for rtoInSecs and\n rpoInSecs of your resiliency policy. But, while assessing your application,\n the lowest possible assessment result is near zero. Hence, if you provide value\n zero for rtoInSecs and rpoInSecs, the estimated workload RTO and\n estimated workload RPO result will be near zero and the Compliance\n status for your application will be set to Policy\n breached.
Updates a resiliency policy.
\nResilience Hub allows you to provide a value of zero for rtoInSecs\n and rpoInSecs of your resiliency policy. But, while assessing your application,\n the lowest possible assessment result is near zero. Hence, if you provide value zero for\n rtoInSecs and rpoInSecs, the estimated workload RTO and\n estimated workload RPO result will be near zero and the Compliance\n status for your application will be set to Policy\n breached.