3737 lines
146 KiB
JSON
3737 lines
146 KiB
JSON
{
|
||
"version":"2.0",
|
||
"metadata":{
|
||
"apiVersion":"2020-04-30",
|
||
"endpointPrefix":"resiliencehub",
|
||
"jsonVersion":"1.1",
|
||
"protocol":"rest-json",
|
||
"serviceFullName":"AWS Resilience Hub",
|
||
"serviceId":"resiliencehub",
|
||
"signatureVersion":"v4",
|
||
"signingName":"resiliencehub",
|
||
"uid":"resiliencehub-2020-04-30"
|
||
},
|
||
"operations":{
|
||
"AddDraftAppVersionResourceMappings":{
|
||
"name":"AddDraftAppVersionResourceMappings",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/add-draft-app-version-resource-mappings",
|
||
"responseCode":200
|
||
},
|
||
"input":{"shape":"AddDraftAppVersionResourceMappingsRequest"},
|
||
"output":{"shape":"AddDraftAppVersionResourceMappingsResponse"},
|
||
"errors":[
|
||
{"shape":"InternalServerException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ConflictException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"ValidationException"},
|
||
{"shape":"AccessDeniedException"}
|
||
],
|
||
"documentation":"<p>Adds the resource mapping for the draft application version.</p>"
|
||
},
|
||
"CreateApp":{
|
||
"name":"CreateApp",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/create-app",
|
||
"responseCode":200
|
||
},
|
||
"input":{"shape":"CreateAppRequest"},
|
||
"output":{"shape":"CreateAppResponse"},
|
||
"errors":[
|
||
{"shape":"InternalServerException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ConflictException"},
|
||
{"shape":"ServiceQuotaExceededException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"ValidationException"},
|
||
{"shape":"AccessDeniedException"}
|
||
],
|
||
"documentation":"<p>Creates a Resilience Hub application. A 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–up to five–CloudFormation stacks, and an appropriate resiliency policy.</p> <p>After you create a 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).</p>"
|
||
},
|
||
"CreateRecommendationTemplate":{
|
||
"name":"CreateRecommendationTemplate",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/create-recommendation-template",
|
||
"responseCode":200
|
||
},
|
||
"input":{"shape":"CreateRecommendationTemplateRequest"},
|
||
"output":{"shape":"CreateRecommendationTemplateResponse"},
|
||
"errors":[
|
||
{"shape":"InternalServerException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ConflictException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"ValidationException"},
|
||
{"shape":"AccessDeniedException"}
|
||
],
|
||
"documentation":"<p>Creates a new recommendation template.</p>"
|
||
},
|
||
"CreateResiliencyPolicy":{
|
||
"name":"CreateResiliencyPolicy",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/create-resiliency-policy",
|
||
"responseCode":200
|
||
},
|
||
"input":{"shape":"CreateResiliencyPolicyRequest"},
|
||
"output":{"shape":"CreateResiliencyPolicyResponse"},
|
||
"errors":[
|
||
{"shape":"InternalServerException"},
|
||
{"shape":"ConflictException"},
|
||
{"shape":"ServiceQuotaExceededException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"ValidationException"},
|
||
{"shape":"AccessDeniedException"}
|
||
],
|
||
"documentation":"<p>Creates a resiliency policy for an application.</p>"
|
||
},
|
||
"DeleteApp":{
|
||
"name":"DeleteApp",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/delete-app",
|
||
"responseCode":200
|
||
},
|
||
"input":{"shape":"DeleteAppRequest"},
|
||
"output":{"shape":"DeleteAppResponse"},
|
||
"errors":[
|
||
{"shape":"InternalServerException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ConflictException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"ValidationException"}
|
||
],
|
||
"documentation":"<p>Deletes an AWS Resilience Hub application. This is a destructive action that can't be undone.</p>"
|
||
},
|
||
"DeleteAppAssessment":{
|
||
"name":"DeleteAppAssessment",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/delete-app-assessment",
|
||
"responseCode":200
|
||
},
|
||
"input":{"shape":"DeleteAppAssessmentRequest"},
|
||
"output":{"shape":"DeleteAppAssessmentResponse"},
|
||
"errors":[
|
||
{"shape":"InternalServerException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ConflictException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"ValidationException"},
|
||
{"shape":"AccessDeniedException"}
|
||
],
|
||
"documentation":"<p>Deletes an AWS Resilience Hub application assessment. This is a destructive action that can't be undone.</p>"
|
||
},
|
||
"DeleteRecommendationTemplate":{
|
||
"name":"DeleteRecommendationTemplate",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/delete-recommendation-template",
|
||
"responseCode":200
|
||
},
|
||
"input":{"shape":"DeleteRecommendationTemplateRequest"},
|
||
"output":{"shape":"DeleteRecommendationTemplateResponse"},
|
||
"errors":[
|
||
{"shape":"InternalServerException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"ValidationException"},
|
||
{"shape":"AccessDeniedException"}
|
||
],
|
||
"documentation":"<p>Deletes a recommendation template. This is a destructive action that can't be undone.</p>"
|
||
},
|
||
"DeleteResiliencyPolicy":{
|
||
"name":"DeleteResiliencyPolicy",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/delete-resiliency-policy",
|
||
"responseCode":200
|
||
},
|
||
"input":{"shape":"DeleteResiliencyPolicyRequest"},
|
||
"output":{"shape":"DeleteResiliencyPolicyResponse"},
|
||
"errors":[
|
||
{"shape":"InternalServerException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ConflictException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"ValidationException"},
|
||
{"shape":"AccessDeniedException"}
|
||
],
|
||
"documentation":"<p>Deletes a resiliency policy. This is a destructive action that can't be undone.</p>"
|
||
},
|
||
"DescribeApp":{
|
||
"name":"DescribeApp",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/describe-app",
|
||
"responseCode":200
|
||
},
|
||
"input":{"shape":"DescribeAppRequest"},
|
||
"output":{"shape":"DescribeAppResponse"},
|
||
"errors":[
|
||
{"shape":"InternalServerException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"ValidationException"},
|
||
{"shape":"AccessDeniedException"}
|
||
],
|
||
"documentation":"<p>Describes an AWS Resilience Hub application.</p>"
|
||
},
|
||
"DescribeAppAssessment":{
|
||
"name":"DescribeAppAssessment",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/describe-app-assessment",
|
||
"responseCode":200
|
||
},
|
||
"input":{"shape":"DescribeAppAssessmentRequest"},
|
||
"output":{"shape":"DescribeAppAssessmentResponse"},
|
||
"errors":[
|
||
{"shape":"InternalServerException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"ValidationException"},
|
||
{"shape":"AccessDeniedException"}
|
||
],
|
||
"documentation":"<p>Describes an assessment for an AWS Resilience Hub application.</p>"
|
||
},
|
||
"DescribeAppVersionResourcesResolutionStatus":{
|
||
"name":"DescribeAppVersionResourcesResolutionStatus",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/describe-app-version-resources-resolution-status",
|
||
"responseCode":200
|
||
},
|
||
"input":{"shape":"DescribeAppVersionResourcesResolutionStatusRequest"},
|
||
"output":{"shape":"DescribeAppVersionResourcesResolutionStatusResponse"},
|
||
"errors":[
|
||
{"shape":"InternalServerException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"ValidationException"},
|
||
{"shape":"AccessDeniedException"}
|
||
],
|
||
"documentation":"<p>Returns the resolution status for the specified resolution identifier for an application version. If <code>resolutionId</code> is not specified, the current resolution status is returned.</p>"
|
||
},
|
||
"DescribeAppVersionTemplate":{
|
||
"name":"DescribeAppVersionTemplate",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/describe-app-version-template",
|
||
"responseCode":200
|
||
},
|
||
"input":{"shape":"DescribeAppVersionTemplateRequest"},
|
||
"output":{"shape":"DescribeAppVersionTemplateResponse"},
|
||
"errors":[
|
||
{"shape":"InternalServerException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"ValidationException"},
|
||
{"shape":"AccessDeniedException"}
|
||
],
|
||
"documentation":"<p>Describes details about an AWS Resilience Hub </p>"
|
||
},
|
||
"DescribeDraftAppVersionResourcesImportStatus":{
|
||
"name":"DescribeDraftAppVersionResourcesImportStatus",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/describe-draft-app-version-resources-import-status",
|
||
"responseCode":200
|
||
},
|
||
"input":{"shape":"DescribeDraftAppVersionResourcesImportStatusRequest"},
|
||
"output":{"shape":"DescribeDraftAppVersionResourcesImportStatusResponse"},
|
||
"errors":[
|
||
{"shape":"InternalServerException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"ValidationException"},
|
||
{"shape":"AccessDeniedException"}
|
||
],
|
||
"documentation":"<p>Describes the status of importing resources to an application version.</p>"
|
||
},
|
||
"DescribeResiliencyPolicy":{
|
||
"name":"DescribeResiliencyPolicy",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/describe-resiliency-policy",
|
||
"responseCode":200
|
||
},
|
||
"input":{"shape":"DescribeResiliencyPolicyRequest"},
|
||
"output":{"shape":"DescribeResiliencyPolicyResponse"},
|
||
"errors":[
|
||
{"shape":"InternalServerException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"ValidationException"},
|
||
{"shape":"AccessDeniedException"}
|
||
],
|
||
"documentation":"<p>Describes a specified resiliency policy for an AWS Resilience Hub application. The returned policy object includes creation time, data location constraints, the Amazon Resource Name (ARN) for the policy, tags, tier, and more.</p>"
|
||
},
|
||
"ImportResourcesToDraftAppVersion":{
|
||
"name":"ImportResourcesToDraftAppVersion",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/import-resources-to-draft-app-version",
|
||
"responseCode":200
|
||
},
|
||
"input":{"shape":"ImportResourcesToDraftAppVersionRequest"},
|
||
"output":{"shape":"ImportResourcesToDraftAppVersionResponse"},
|
||
"errors":[
|
||
{"shape":"InternalServerException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ConflictException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"ValidationException"},
|
||
{"shape":"AccessDeniedException"}
|
||
],
|
||
"documentation":"<p>Imports resources from sources such as a CloudFormation stack, resource-groups, or application registry app to a draft application version.</p>"
|
||
},
|
||
"ListAlarmRecommendations":{
|
||
"name":"ListAlarmRecommendations",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/list-alarm-recommendations",
|
||
"responseCode":200
|
||
},
|
||
"input":{"shape":"ListAlarmRecommendationsRequest"},
|
||
"output":{"shape":"ListAlarmRecommendationsResponse"},
|
||
"errors":[
|
||
{"shape":"InternalServerException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"ValidationException"},
|
||
{"shape":"AccessDeniedException"}
|
||
],
|
||
"documentation":"<p>Lists the alarm recommendations for a AWS Resilience Hub application.</p>"
|
||
},
|
||
"ListAppAssessments":{
|
||
"name":"ListAppAssessments",
|
||
"http":{
|
||
"method":"GET",
|
||
"requestUri":"/list-app-assessments",
|
||
"responseCode":200
|
||
},
|
||
"input":{"shape":"ListAppAssessmentsRequest"},
|
||
"output":{"shape":"ListAppAssessmentsResponse"},
|
||
"errors":[
|
||
{"shape":"InternalServerException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"ValidationException"},
|
||
{"shape":"AccessDeniedException"}
|
||
],
|
||
"documentation":"<p>Lists the assessments for an AWS Resilience Hub application. You can use request parameters to refine the results for the response object.</p>"
|
||
},
|
||
"ListAppComponentCompliances":{
|
||
"name":"ListAppComponentCompliances",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/list-app-component-compliances",
|
||
"responseCode":200
|
||
},
|
||
"input":{"shape":"ListAppComponentCompliancesRequest"},
|
||
"output":{"shape":"ListAppComponentCompliancesResponse"},
|
||
"errors":[
|
||
{"shape":"InternalServerException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"ValidationException"},
|
||
{"shape":"AccessDeniedException"}
|
||
],
|
||
"documentation":"<p>Lists the compliances for an AWS Resilience Hub component.</p>"
|
||
},
|
||
"ListAppComponentRecommendations":{
|
||
"name":"ListAppComponentRecommendations",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/list-app-component-recommendations",
|
||
"responseCode":200
|
||
},
|
||
"input":{"shape":"ListAppComponentRecommendationsRequest"},
|
||
"output":{"shape":"ListAppComponentRecommendationsResponse"},
|
||
"errors":[
|
||
{"shape":"InternalServerException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"ValidationException"},
|
||
{"shape":"AccessDeniedException"}
|
||
],
|
||
"documentation":"<p>Lists the recommendations for an AWS Resilience Hub component.</p>"
|
||
},
|
||
"ListAppVersionResourceMappings":{
|
||
"name":"ListAppVersionResourceMappings",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/list-app-version-resource-mappings",
|
||
"responseCode":200
|
||
},
|
||
"input":{"shape":"ListAppVersionResourceMappingsRequest"},
|
||
"output":{"shape":"ListAppVersionResourceMappingsResponse"},
|
||
"errors":[
|
||
{"shape":"InternalServerException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"ValidationException"},
|
||
{"shape":"AccessDeniedException"}
|
||
],
|
||
"documentation":"<p>Lists how the resources in an application version are mapped/sourced from. Mappings can be physical resource identifiers, CloudFormation stacks, resource-groups, or an application registry app.</p>"
|
||
},
|
||
"ListAppVersionResources":{
|
||
"name":"ListAppVersionResources",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/list-app-version-resources",
|
||
"responseCode":200
|
||
},
|
||
"input":{"shape":"ListAppVersionResourcesRequest"},
|
||
"output":{"shape":"ListAppVersionResourcesResponse"},
|
||
"errors":[
|
||
{"shape":"InternalServerException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ConflictException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"ValidationException"},
|
||
{"shape":"AccessDeniedException"}
|
||
],
|
||
"documentation":"<p>Lists all the resources in an application version.</p>"
|
||
},
|
||
"ListAppVersions":{
|
||
"name":"ListAppVersions",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/list-app-versions",
|
||
"responseCode":200
|
||
},
|
||
"input":{"shape":"ListAppVersionsRequest"},
|
||
"output":{"shape":"ListAppVersionsResponse"},
|
||
"errors":[
|
||
{"shape":"InternalServerException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ValidationException"},
|
||
{"shape":"AccessDeniedException"}
|
||
],
|
||
"documentation":"<p>Lists the different versions for the Resilience Hub applications.</p>"
|
||
},
|
||
"ListApps":{
|
||
"name":"ListApps",
|
||
"http":{
|
||
"method":"GET",
|
||
"requestUri":"/list-apps",
|
||
"responseCode":200
|
||
},
|
||
"input":{"shape":"ListAppsRequest"},
|
||
"output":{"shape":"ListAppsResponse"},
|
||
"errors":[
|
||
{"shape":"InternalServerException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"ValidationException"},
|
||
{"shape":"AccessDeniedException"}
|
||
],
|
||
"documentation":"<p>Lists your Resilience Hub applications.</p>"
|
||
},
|
||
"ListRecommendationTemplates":{
|
||
"name":"ListRecommendationTemplates",
|
||
"http":{
|
||
"method":"GET",
|
||
"requestUri":"/list-recommendation-templates",
|
||
"responseCode":200
|
||
},
|
||
"input":{"shape":"ListRecommendationTemplatesRequest"},
|
||
"output":{"shape":"ListRecommendationTemplatesResponse"},
|
||
"errors":[
|
||
{"shape":"InternalServerException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"ValidationException"},
|
||
{"shape":"AccessDeniedException"}
|
||
],
|
||
"documentation":"<p>Lists the recommendation templates for the Resilience Hub applications.</p>"
|
||
},
|
||
"ListResiliencyPolicies":{
|
||
"name":"ListResiliencyPolicies",
|
||
"http":{
|
||
"method":"GET",
|
||
"requestUri":"/list-resiliency-policies",
|
||
"responseCode":200
|
||
},
|
||
"input":{"shape":"ListResiliencyPoliciesRequest"},
|
||
"output":{"shape":"ListResiliencyPoliciesResponse"},
|
||
"errors":[
|
||
{"shape":"InternalServerException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"ValidationException"},
|
||
{"shape":"AccessDeniedException"}
|
||
],
|
||
"documentation":"<p>Lists the resiliency policies for the Resilience Hub applications.</p>"
|
||
},
|
||
"ListSopRecommendations":{
|
||
"name":"ListSopRecommendations",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/list-sop-recommendations",
|
||
"responseCode":200
|
||
},
|
||
"input":{"shape":"ListSopRecommendationsRequest"},
|
||
"output":{"shape":"ListSopRecommendationsResponse"},
|
||
"errors":[
|
||
{"shape":"InternalServerException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ConflictException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"ValidationException"},
|
||
{"shape":"AccessDeniedException"}
|
||
],
|
||
"documentation":"<p>Lists the standard operating procedure (SOP) recommendations for the Resilience Hub applications.</p>"
|
||
},
|
||
"ListSuggestedResiliencyPolicies":{
|
||
"name":"ListSuggestedResiliencyPolicies",
|
||
"http":{
|
||
"method":"GET",
|
||
"requestUri":"/list-suggested-resiliency-policies",
|
||
"responseCode":200
|
||
},
|
||
"input":{"shape":"ListSuggestedResiliencyPoliciesRequest"},
|
||
"output":{"shape":"ListSuggestedResiliencyPoliciesResponse"},
|
||
"errors":[
|
||
{"shape":"InternalServerException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"ValidationException"},
|
||
{"shape":"AccessDeniedException"}
|
||
],
|
||
"documentation":"<p>Lists the suggested resiliency policies for the Resilience Hub applications.</p>"
|
||
},
|
||
"ListTagsForResource":{
|
||
"name":"ListTagsForResource",
|
||
"http":{
|
||
"method":"GET",
|
||
"requestUri":"/tags/{resourceArn}",
|
||
"responseCode":200
|
||
},
|
||
"input":{"shape":"ListTagsForResourceRequest"},
|
||
"output":{"shape":"ListTagsForResourceResponse"},
|
||
"errors":[
|
||
{"shape":"InternalServerException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"ValidationException"},
|
||
{"shape":"AccessDeniedException"}
|
||
],
|
||
"documentation":"<p>Lists the tags for your resources in your Resilience Hub applications.</p>"
|
||
},
|
||
"ListTestRecommendations":{
|
||
"name":"ListTestRecommendations",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/list-test-recommendations",
|
||
"responseCode":200
|
||
},
|
||
"input":{"shape":"ListTestRecommendationsRequest"},
|
||
"output":{"shape":"ListTestRecommendationsResponse"},
|
||
"errors":[
|
||
{"shape":"InternalServerException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ConflictException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"ValidationException"},
|
||
{"shape":"AccessDeniedException"}
|
||
],
|
||
"documentation":"<p>Lists the test recommendations for the Resilience Hub application.</p>"
|
||
},
|
||
"ListUnsupportedAppVersionResources":{
|
||
"name":"ListUnsupportedAppVersionResources",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/list-unsupported-app-version-resources",
|
||
"responseCode":200
|
||
},
|
||
"input":{"shape":"ListUnsupportedAppVersionResourcesRequest"},
|
||
"output":{"shape":"ListUnsupportedAppVersionResourcesResponse"},
|
||
"errors":[
|
||
{"shape":"InternalServerException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ConflictException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"ValidationException"},
|
||
{"shape":"AccessDeniedException"}
|
||
],
|
||
"documentation":"<p>Lists the resources that are not currently supported in AWS 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.</p>"
|
||
},
|
||
"PublishAppVersion":{
|
||
"name":"PublishAppVersion",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/publish-app-version",
|
||
"responseCode":200
|
||
},
|
||
"input":{"shape":"PublishAppVersionRequest"},
|
||
"output":{"shape":"PublishAppVersionResponse"},
|
||
"errors":[
|
||
{"shape":"InternalServerException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ConflictException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"ValidationException"},
|
||
{"shape":"AccessDeniedException"}
|
||
],
|
||
"documentation":"<p>Publishes a new version of a specific Resilience Hub application.</p>"
|
||
},
|
||
"PutDraftAppVersionTemplate":{
|
||
"name":"PutDraftAppVersionTemplate",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/put-draft-app-version-template",
|
||
"responseCode":200
|
||
},
|
||
"input":{"shape":"PutDraftAppVersionTemplateRequest"},
|
||
"output":{"shape":"PutDraftAppVersionTemplateResponse"},
|
||
"errors":[
|
||
{"shape":"InternalServerException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ConflictException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"ValidationException"},
|
||
{"shape":"AccessDeniedException"}
|
||
],
|
||
"documentation":"<p>Adds or updates the app template for a draft version of a Resilience Hub app.</p>"
|
||
},
|
||
"RemoveDraftAppVersionResourceMappings":{
|
||
"name":"RemoveDraftAppVersionResourceMappings",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/remove-draft-app-version-resource-mappings",
|
||
"responseCode":200
|
||
},
|
||
"input":{"shape":"RemoveDraftAppVersionResourceMappingsRequest"},
|
||
"output":{"shape":"RemoveDraftAppVersionResourceMappingsResponse"},
|
||
"errors":[
|
||
{"shape":"InternalServerException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ConflictException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"ValidationException"},
|
||
{"shape":"AccessDeniedException"}
|
||
],
|
||
"documentation":"<p>Removes resource mappings from a draft application version.</p>"
|
||
},
|
||
"ResolveAppVersionResources":{
|
||
"name":"ResolveAppVersionResources",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/resolve-app-version-resources",
|
||
"responseCode":200
|
||
},
|
||
"input":{"shape":"ResolveAppVersionResourcesRequest"},
|
||
"output":{"shape":"ResolveAppVersionResourcesResponse"},
|
||
"errors":[
|
||
{"shape":"InternalServerException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ConflictException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"ValidationException"},
|
||
{"shape":"AccessDeniedException"}
|
||
],
|
||
"documentation":"<p>Resolves the resources for an application version.</p>"
|
||
},
|
||
"StartAppAssessment":{
|
||
"name":"StartAppAssessment",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/start-app-assessment",
|
||
"responseCode":200
|
||
},
|
||
"input":{"shape":"StartAppAssessmentRequest"},
|
||
"output":{"shape":"StartAppAssessmentResponse"},
|
||
"errors":[
|
||
{"shape":"InternalServerException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ConflictException"},
|
||
{"shape":"ServiceQuotaExceededException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"ValidationException"},
|
||
{"shape":"AccessDeniedException"}
|
||
],
|
||
"documentation":"<p>Creates a new application assessment for an application.</p>"
|
||
},
|
||
"TagResource":{
|
||
"name":"TagResource",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/tags/{resourceArn}",
|
||
"responseCode":200
|
||
},
|
||
"input":{"shape":"TagResourceRequest"},
|
||
"output":{"shape":"TagResourceResponse"},
|
||
"errors":[
|
||
{"shape":"InternalServerException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"ValidationException"},
|
||
{"shape":"AccessDeniedException"}
|
||
],
|
||
"documentation":"<p>Applies one or more tags to a resource.</p>"
|
||
},
|
||
"UntagResource":{
|
||
"name":"UntagResource",
|
||
"http":{
|
||
"method":"DELETE",
|
||
"requestUri":"/tags/{resourceArn}",
|
||
"responseCode":200
|
||
},
|
||
"input":{"shape":"UntagResourceRequest"},
|
||
"output":{"shape":"UntagResourceResponse"},
|
||
"errors":[
|
||
{"shape":"InternalServerException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"ValidationException"},
|
||
{"shape":"AccessDeniedException"}
|
||
],
|
||
"documentation":"<p>Removes one or more tags from a resource.</p>"
|
||
},
|
||
"UpdateApp":{
|
||
"name":"UpdateApp",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/update-app",
|
||
"responseCode":200
|
||
},
|
||
"input":{"shape":"UpdateAppRequest"},
|
||
"output":{"shape":"UpdateAppResponse"},
|
||
"errors":[
|
||
{"shape":"InternalServerException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ConflictException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"ValidationException"},
|
||
{"shape":"AccessDeniedException"}
|
||
],
|
||
"documentation":"<p>Updates an application.</p>"
|
||
},
|
||
"UpdateResiliencyPolicy":{
|
||
"name":"UpdateResiliencyPolicy",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/update-resiliency-policy",
|
||
"responseCode":200
|
||
},
|
||
"input":{"shape":"UpdateResiliencyPolicyRequest"},
|
||
"output":{"shape":"UpdateResiliencyPolicyResponse"},
|
||
"errors":[
|
||
{"shape":"InternalServerException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ConflictException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"ValidationException"},
|
||
{"shape":"AccessDeniedException"}
|
||
],
|
||
"documentation":"<p>Updates a resiliency policy.</p>"
|
||
}
|
||
},
|
||
"shapes":{
|
||
"AccessDeniedException":{
|
||
"type":"structure",
|
||
"members":{
|
||
"message":{"shape":"String500"}
|
||
},
|
||
"documentation":"<p>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.</p>",
|
||
"error":{
|
||
"httpStatusCode":403,
|
||
"senderFault":true
|
||
},
|
||
"exception":true
|
||
},
|
||
"AddDraftAppVersionResourceMappingsRequest":{
|
||
"type":"structure",
|
||
"required":[
|
||
"appArn",
|
||
"resourceMappings"
|
||
],
|
||
"members":{
|
||
"appArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app/<code>app-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
|
||
},
|
||
"resourceMappings":{
|
||
"shape":"ResourceMappingList",
|
||
"documentation":"<p> Mappings used to map logical resources from the template to physical resources. You can use the mapping type <code>CFN_STACK</code> if the application template uses a logical stack name. Or you can map individual resources by using the mapping type <code>RESOURCE</code>. We recommend using the mapping type <code>CFN_STACK</code> if the application is backed by a CloudFormation stack.</p>"
|
||
}
|
||
}
|
||
},
|
||
"AddDraftAppVersionResourceMappingsResponse":{
|
||
"type":"structure",
|
||
"required":[
|
||
"appArn",
|
||
"appVersion",
|
||
"resourceMappings"
|
||
],
|
||
"members":{
|
||
"appArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p> The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app/<code>app-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
|
||
},
|
||
"appVersion":{
|
||
"shape":"EntityVersion",
|
||
"documentation":"<p>The version of the application.</p>"
|
||
},
|
||
"resourceMappings":{
|
||
"shape":"ResourceMappingList",
|
||
"documentation":"<p>Mappings used to map logical resources from the template to physical resources. You can use the mapping type <code>CFN_STACK</code> if the application template uses a logical stack name. Or you can map individual resources by using the mapping type <code>RESOURCE</code>. We recommend using the mapping type <code>CFN_STACK</code> if the application is backed by a CloudFormation stack.</p>"
|
||
}
|
||
}
|
||
},
|
||
"AlarmRecommendation":{
|
||
"type":"structure",
|
||
"required":[
|
||
"name",
|
||
"recommendationId",
|
||
"referenceId",
|
||
"type"
|
||
],
|
||
"members":{
|
||
"appComponentName":{
|
||
"shape":"EntityId",
|
||
"documentation":"<p>The application component for the CloudWatch alarm recommendation.</p>"
|
||
},
|
||
"description":{
|
||
"shape":"EntityDescription",
|
||
"documentation":"<p>The description of the recommendation.</p>"
|
||
},
|
||
"items":{
|
||
"shape":"RecommendationItemList",
|
||
"documentation":"<p>The list of CloudWatch alarm recommendations.</p>"
|
||
},
|
||
"name":{
|
||
"shape":"String500",
|
||
"documentation":"<p>The name of the alarm recommendation.</p>"
|
||
},
|
||
"prerequisite":{
|
||
"shape":"String500",
|
||
"documentation":"<p>The prerequisite for the alarm recommendation.</p>"
|
||
},
|
||
"recommendationId":{
|
||
"shape":"Uuid",
|
||
"documentation":"<p>The identifier of the alarm recommendation.</p>"
|
||
},
|
||
"referenceId":{
|
||
"shape":"SpecReferenceId",
|
||
"documentation":"<p>The reference identifier of the alarm recommendation.</p>"
|
||
},
|
||
"type":{
|
||
"shape":"AlarmType",
|
||
"documentation":"<p>The type of alarm recommendation.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>Defines a recommendation for a CloudWatch alarm.</p>"
|
||
},
|
||
"AlarmRecommendationList":{
|
||
"type":"list",
|
||
"member":{"shape":"AlarmRecommendation"}
|
||
},
|
||
"AlarmReferenceIdList":{
|
||
"type":"list",
|
||
"member":{"shape":"String500"},
|
||
"max":200,
|
||
"min":1
|
||
},
|
||
"AlarmType":{
|
||
"type":"string",
|
||
"enum":[
|
||
"Metric",
|
||
"Composite",
|
||
"Canary",
|
||
"Logs",
|
||
"Event"
|
||
]
|
||
},
|
||
"App":{
|
||
"type":"structure",
|
||
"required":[
|
||
"appArn",
|
||
"creationTime",
|
||
"name"
|
||
],
|
||
"members":{
|
||
"appArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app/<code>app-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
|
||
},
|
||
"assessmentSchedule":{
|
||
"shape":"AppAssessmentScheduleType",
|
||
"documentation":"<p> Assessment execution schedule with 'Daily' or 'Disabled' values. </p>"
|
||
},
|
||
"complianceStatus":{
|
||
"shape":"AppComplianceStatusType",
|
||
"documentation":"<p>The current status of compliance for the resiliency policy.</p>"
|
||
},
|
||
"creationTime":{
|
||
"shape":"TimeStamp",
|
||
"documentation":"<p>The timestamp for when the app was created.</p>"
|
||
},
|
||
"description":{
|
||
"shape":"EntityDescription",
|
||
"documentation":"<p>The optional description for an app.</p>"
|
||
},
|
||
"lastAppComplianceEvaluationTime":{
|
||
"shape":"TimeStamp",
|
||
"documentation":"<p>The timestamp for the most recent compliance evaluation.</p>"
|
||
},
|
||
"lastResiliencyScoreEvaluationTime":{
|
||
"shape":"TimeStamp",
|
||
"documentation":"<p>The timestamp for the most recent resiliency score evaluation.</p>"
|
||
},
|
||
"name":{
|
||
"shape":"EntityName",
|
||
"documentation":"<p>The name for the application.</p>"
|
||
},
|
||
"policyArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:resiliency-policy/<code>policy-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
|
||
},
|
||
"resiliencyScore":{
|
||
"shape":"Double",
|
||
"documentation":"<p>The current resiliency score for the application.</p>"
|
||
},
|
||
"status":{
|
||
"shape":"AppStatusType",
|
||
"documentation":"<p>The status of the application.</p>"
|
||
},
|
||
"tags":{
|
||
"shape":"TagMap",
|
||
"documentation":"<p>The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>Defines a Resilience Hub application.</p>"
|
||
},
|
||
"AppAssessment":{
|
||
"type":"structure",
|
||
"required":[
|
||
"assessmentArn",
|
||
"assessmentStatus",
|
||
"invoker"
|
||
],
|
||
"members":{
|
||
"appArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app/<code>app-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
|
||
},
|
||
"appVersion":{
|
||
"shape":"EntityVersion",
|
||
"documentation":"<p>The version of the application.</p>"
|
||
},
|
||
"assessmentArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app-assessment/<code>app-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
|
||
},
|
||
"assessmentName":{
|
||
"shape":"EntityName",
|
||
"documentation":"<p>The name of the assessment.</p>"
|
||
},
|
||
"assessmentStatus":{
|
||
"shape":"AssessmentStatus",
|
||
"documentation":"<p>The current status of the assessment for the resiliency policy.</p>"
|
||
},
|
||
"compliance":{
|
||
"shape":"AssessmentCompliance",
|
||
"documentation":"<p>The application compliance against the resiliency policy.</p>"
|
||
},
|
||
"complianceStatus":{
|
||
"shape":"ComplianceStatus",
|
||
"documentation":"<p>The current status of the compliance for the resiliency policy.</p>"
|
||
},
|
||
"cost":{
|
||
"shape":"Cost",
|
||
"documentation":"<p>The cost for the application.</p>"
|
||
},
|
||
"endTime":{
|
||
"shape":"TimeStamp",
|
||
"documentation":"<p>The end time for the action.</p>"
|
||
},
|
||
"invoker":{
|
||
"shape":"AssessmentInvoker",
|
||
"documentation":"<p>The entity that invoked the assessment.</p>"
|
||
},
|
||
"message":{
|
||
"shape":"String500",
|
||
"documentation":"<p>Error or warning message from the assessment execution</p>"
|
||
},
|
||
"policy":{
|
||
"shape":"ResiliencyPolicy",
|
||
"documentation":"<p>The resiliency policy.</p>"
|
||
},
|
||
"resiliencyScore":{
|
||
"shape":"ResiliencyScore",
|
||
"documentation":"<p>The current resiliency score for the application.</p>"
|
||
},
|
||
"resourceErrorsDetails":{
|
||
"shape":"ResourceErrorsDetails",
|
||
"documentation":"<p> A resource error object containing a list of errors retrieving an application's resources. </p>"
|
||
},
|
||
"startTime":{
|
||
"shape":"TimeStamp",
|
||
"documentation":"<p>The starting time for the action.</p>"
|
||
},
|
||
"tags":{
|
||
"shape":"TagMap",
|
||
"documentation":"<p>The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>Defines an application assessment.</p>"
|
||
},
|
||
"AppAssessmentScheduleType":{
|
||
"type":"string",
|
||
"enum":[
|
||
"Disabled",
|
||
"Daily"
|
||
]
|
||
},
|
||
"AppAssessmentSummary":{
|
||
"type":"structure",
|
||
"required":[
|
||
"assessmentArn",
|
||
"assessmentStatus"
|
||
],
|
||
"members":{
|
||
"appArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app/<code>app-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
|
||
},
|
||
"appVersion":{
|
||
"shape":"EntityVersion",
|
||
"documentation":"<p>The version of the application.</p>"
|
||
},
|
||
"assessmentArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app-assessment/<code>app-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
|
||
},
|
||
"assessmentName":{
|
||
"shape":"EntityName",
|
||
"documentation":"<p>The name of the assessment.</p>"
|
||
},
|
||
"assessmentStatus":{
|
||
"shape":"AssessmentStatus",
|
||
"documentation":"<p>The current status of the assessment for the resiliency policy.</p>"
|
||
},
|
||
"complianceStatus":{
|
||
"shape":"ComplianceStatus",
|
||
"documentation":"<p>The current status of compliance for the resiliency policy.</p>"
|
||
},
|
||
"cost":{
|
||
"shape":"Cost",
|
||
"documentation":"<p>The cost for the application.</p>"
|
||
},
|
||
"endTime":{
|
||
"shape":"TimeStamp",
|
||
"documentation":"<p>The end time for the action.</p>"
|
||
},
|
||
"invoker":{
|
||
"shape":"AssessmentInvoker",
|
||
"documentation":"<p>The entity that invoked the assessment.</p>"
|
||
},
|
||
"message":{
|
||
"shape":"String500",
|
||
"documentation":"<p>The message from the assessment run.</p>"
|
||
},
|
||
"resiliencyScore":{
|
||
"shape":"Double",
|
||
"documentation":"<p>The current resiliency score for the application.</p>"
|
||
},
|
||
"startTime":{
|
||
"shape":"TimeStamp",
|
||
"documentation":"<p>The starting time for the action.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>Defines an application assessment summary.</p>"
|
||
},
|
||
"AppAssessmentSummaryList":{
|
||
"type":"list",
|
||
"member":{"shape":"AppAssessmentSummary"}
|
||
},
|
||
"AppComplianceStatusType":{
|
||
"type":"string",
|
||
"enum":[
|
||
"PolicyBreached",
|
||
"PolicyMet",
|
||
"NotAssessed",
|
||
"ChangesDetected"
|
||
]
|
||
},
|
||
"AppComponent":{
|
||
"type":"structure",
|
||
"required":[
|
||
"name",
|
||
"type"
|
||
],
|
||
"members":{
|
||
"name":{
|
||
"shape":"String255",
|
||
"documentation":"<p>The name of the application component.</p>"
|
||
},
|
||
"type":{
|
||
"shape":"String255",
|
||
"documentation":"<p>The type of application component.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>Defines an application component.</p>"
|
||
},
|
||
"AppComponentCompliance":{
|
||
"type":"structure",
|
||
"members":{
|
||
"appComponentName":{
|
||
"shape":"EntityId",
|
||
"documentation":"<p>The name of the application component.</p>"
|
||
},
|
||
"compliance":{
|
||
"shape":"AssessmentCompliance",
|
||
"documentation":"<p>The compliance of the application component against the resiliency policy.</p>"
|
||
},
|
||
"cost":{
|
||
"shape":"Cost",
|
||
"documentation":"<p>The cost for the application.</p>"
|
||
},
|
||
"message":{
|
||
"shape":"String500",
|
||
"documentation":"<p>The compliance message.</p>"
|
||
},
|
||
"resiliencyScore":{
|
||
"shape":"ResiliencyScore",
|
||
"documentation":"<p>The current resiliency score for the application.</p>"
|
||
},
|
||
"status":{
|
||
"shape":"ComplianceStatus",
|
||
"documentation":"<p>The status of the action.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>Defines the compliance of an application component against the resiliency policy.</p>"
|
||
},
|
||
"AppComponentList":{
|
||
"type":"list",
|
||
"member":{"shape":"AppComponent"}
|
||
},
|
||
"AppStatusType":{
|
||
"type":"string",
|
||
"enum":[
|
||
"Active",
|
||
"Deleting"
|
||
]
|
||
},
|
||
"AppSummary":{
|
||
"type":"structure",
|
||
"required":[
|
||
"appArn",
|
||
"creationTime",
|
||
"name"
|
||
],
|
||
"members":{
|
||
"appArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app/<code>app-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
|
||
},
|
||
"assessmentSchedule":{
|
||
"shape":"AppAssessmentScheduleType",
|
||
"documentation":"<p> Assessment execution schedule with 'Daily' or 'Disabled' values. </p>"
|
||
},
|
||
"complianceStatus":{
|
||
"shape":"AppComplianceStatusType",
|
||
"documentation":"<p>The current status of compliance for the resiliency policy.</p>"
|
||
},
|
||
"creationTime":{
|
||
"shape":"TimeStamp",
|
||
"documentation":"<p>The timestamp for when the app was created.</p>"
|
||
},
|
||
"description":{
|
||
"shape":"EntityDescription",
|
||
"documentation":"<p>The optional description for an app.</p>"
|
||
},
|
||
"name":{
|
||
"shape":"EntityName",
|
||
"documentation":"<p>The name of the application.</p>"
|
||
},
|
||
"resiliencyScore":{
|
||
"shape":"Double",
|
||
"documentation":"<p>The current resiliency score for the application.</p>"
|
||
},
|
||
"status":{
|
||
"shape":"AppStatusType",
|
||
"documentation":"<p>The status of the application.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>Defines an application summary.</p>"
|
||
},
|
||
"AppSummaryList":{
|
||
"type":"list",
|
||
"member":{"shape":"AppSummary"}
|
||
},
|
||
"AppTemplateBody":{
|
||
"type":"string",
|
||
"max":204800,
|
||
"min":0,
|
||
"pattern":"^[\\w\\s:,-\\.'{}\\[\\]:\"]+$"
|
||
},
|
||
"AppVersionList":{
|
||
"type":"list",
|
||
"member":{"shape":"AppVersionSummary"}
|
||
},
|
||
"AppVersionSummary":{
|
||
"type":"structure",
|
||
"required":["appVersion"],
|
||
"members":{
|
||
"appVersion":{
|
||
"shape":"EntityVersion",
|
||
"documentation":"<p>The version of the application.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>The version of the application.</p>"
|
||
},
|
||
"Arn":{
|
||
"type":"string",
|
||
"pattern":"^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+=,@.-]{0,1023}$"
|
||
},
|
||
"ArnList":{
|
||
"type":"list",
|
||
"member":{"shape":"Arn"}
|
||
},
|
||
"AssessmentCompliance":{
|
||
"type":"map",
|
||
"key":{"shape":"DisruptionType"},
|
||
"value":{"shape":"DisruptionCompliance"}
|
||
},
|
||
"AssessmentInvoker":{
|
||
"type":"string",
|
||
"enum":[
|
||
"User",
|
||
"System"
|
||
]
|
||
},
|
||
"AssessmentStatus":{
|
||
"type":"string",
|
||
"enum":[
|
||
"Pending",
|
||
"InProgress",
|
||
"Failed",
|
||
"Success"
|
||
]
|
||
},
|
||
"AssessmentStatusList":{
|
||
"type":"list",
|
||
"member":{"shape":"AssessmentStatus"},
|
||
"max":10,
|
||
"min":1
|
||
},
|
||
"AwsRegion":{
|
||
"type":"string",
|
||
"pattern":"^[a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]$"
|
||
},
|
||
"BooleanOptional":{
|
||
"type":"boolean",
|
||
"box":true
|
||
},
|
||
"ClientToken":{
|
||
"type":"string",
|
||
"max":63,
|
||
"min":1,
|
||
"pattern":"^[A-za-z0-9_.-]{0,63}$"
|
||
},
|
||
"ComplianceStatus":{
|
||
"type":"string",
|
||
"enum":[
|
||
"PolicyBreached",
|
||
"PolicyMet"
|
||
]
|
||
},
|
||
"ComponentCompliancesList":{
|
||
"type":"list",
|
||
"member":{"shape":"AppComponentCompliance"}
|
||
},
|
||
"ComponentRecommendation":{
|
||
"type":"structure",
|
||
"required":[
|
||
"appComponentName",
|
||
"configRecommendations",
|
||
"recommendationStatus"
|
||
],
|
||
"members":{
|
||
"appComponentName":{
|
||
"shape":"EntityId",
|
||
"documentation":"<p>The name of the application component.</p>"
|
||
},
|
||
"configRecommendations":{
|
||
"shape":"ConfigRecommendationList",
|
||
"documentation":"<p>The list of recommendations.</p>"
|
||
},
|
||
"recommendationStatus":{
|
||
"shape":"RecommendationComplianceStatus",
|
||
"documentation":"<p>The recommendation status.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>Defines recommendations for a Resilience Hub application component, returned as an object. This object contains component names, configuration recommendations, and recommendation statuses.</p>"
|
||
},
|
||
"ComponentRecommendationList":{
|
||
"type":"list",
|
||
"member":{"shape":"ComponentRecommendation"}
|
||
},
|
||
"ConfigRecommendation":{
|
||
"type":"structure",
|
||
"required":[
|
||
"name",
|
||
"optimizationType",
|
||
"referenceId"
|
||
],
|
||
"members":{
|
||
"appComponentName":{
|
||
"shape":"EntityId",
|
||
"documentation":"<p>The application component name.</p>"
|
||
},
|
||
"compliance":{
|
||
"shape":"AssessmentCompliance",
|
||
"documentation":"<p>The current compliance against the resiliency policy before applying the configuration change.</p>"
|
||
},
|
||
"cost":{
|
||
"shape":"Cost",
|
||
"documentation":"<p>The cost for the application.</p>"
|
||
},
|
||
"description":{
|
||
"shape":"EntityDescription",
|
||
"documentation":"<p>The optional description for an app.</p>"
|
||
},
|
||
"haArchitecture":{
|
||
"shape":"HaArchitecture",
|
||
"documentation":"<p>The architecture type.</p>"
|
||
},
|
||
"name":{
|
||
"shape":"EntityName",
|
||
"documentation":"<p>The name of the recommendation configuration.</p>"
|
||
},
|
||
"optimizationType":{
|
||
"shape":"ConfigRecommendationOptimizationType",
|
||
"documentation":"<p>The type of optimization.</p>"
|
||
},
|
||
"recommendationCompliance":{
|
||
"shape":"RecommendationCompliance",
|
||
"documentation":"<p>The expected compliance against the resiliency policy after applying the configuration change.</p>"
|
||
},
|
||
"referenceId":{
|
||
"shape":"SpecReferenceId",
|
||
"documentation":"<p>The reference identifier for the recommendation configuration.</p>"
|
||
},
|
||
"suggestedChanges":{
|
||
"shape":"SuggestedChangesList",
|
||
"documentation":"<p>List of the suggested configuration changes.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>Defines a configuration recommendation.</p>"
|
||
},
|
||
"ConfigRecommendationList":{
|
||
"type":"list",
|
||
"member":{"shape":"ConfigRecommendation"}
|
||
},
|
||
"ConfigRecommendationOptimizationType":{
|
||
"type":"string",
|
||
"enum":[
|
||
"LeastCost",
|
||
"LeastChange",
|
||
"BestAZRecovery",
|
||
"LeastErrors",
|
||
"BestAttainable",
|
||
"BestRegionRecovery"
|
||
]
|
||
},
|
||
"ConflictException":{
|
||
"type":"structure",
|
||
"members":{
|
||
"message":{"shape":"String500"},
|
||
"resourceId":{
|
||
"shape":"ResourceId",
|
||
"documentation":"<p>The identifier of the resource that the exception applies to.</p>"
|
||
},
|
||
"resourceType":{
|
||
"shape":"ResourceType",
|
||
"documentation":"<p>The type of the resource that the exception applies to.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>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.</p>",
|
||
"error":{
|
||
"httpStatusCode":409,
|
||
"senderFault":true
|
||
},
|
||
"exception":true
|
||
},
|
||
"Cost":{
|
||
"type":"structure",
|
||
"required":[
|
||
"amount",
|
||
"currency",
|
||
"frequency"
|
||
],
|
||
"members":{
|
||
"amount":{
|
||
"shape":"Double",
|
||
"documentation":"<p>The cost amount.</p>"
|
||
},
|
||
"currency":{
|
||
"shape":"CurrencyCode",
|
||
"documentation":"<p>The cost currency, for example <code>USD</code>.</p>"
|
||
},
|
||
"frequency":{
|
||
"shape":"CostFrequency",
|
||
"documentation":"<p>The cost frequency.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>Defines a cost object.</p>"
|
||
},
|
||
"CostFrequency":{
|
||
"type":"string",
|
||
"enum":[
|
||
"Hourly",
|
||
"Daily",
|
||
"Monthly",
|
||
"Yearly"
|
||
]
|
||
},
|
||
"CreateAppRequest":{
|
||
"type":"structure",
|
||
"required":["name"],
|
||
"members":{
|
||
"assessmentSchedule":{
|
||
"shape":"AppAssessmentScheduleType",
|
||
"documentation":"<p> Assessment execution schedule with 'Daily' or 'Disabled' values. </p>"
|
||
},
|
||
"clientToken":{
|
||
"shape":"ClientToken",
|
||
"documentation":"<p>Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.</p>",
|
||
"idempotencyToken":true
|
||
},
|
||
"description":{
|
||
"shape":"EntityDescription",
|
||
"documentation":"<p>The optional description for an app.</p>"
|
||
},
|
||
"name":{
|
||
"shape":"EntityName",
|
||
"documentation":"<p>The name for the application.</p>"
|
||
},
|
||
"policyArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:resiliency-policy/<code>policy-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
|
||
},
|
||
"tags":{
|
||
"shape":"TagMap",
|
||
"documentation":"<p>The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.</p>"
|
||
}
|
||
}
|
||
},
|
||
"CreateAppResponse":{
|
||
"type":"structure",
|
||
"required":["app"],
|
||
"members":{
|
||
"app":{
|
||
"shape":"App",
|
||
"documentation":"<p>The created application returned as an object with details including compliance status, creation time, description, resiliency score, and more.</p>"
|
||
}
|
||
}
|
||
},
|
||
"CreateRecommendationTemplateRequest":{
|
||
"type":"structure",
|
||
"required":[
|
||
"assessmentArn",
|
||
"name"
|
||
],
|
||
"members":{
|
||
"assessmentArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app-assessment/<code>app-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
|
||
},
|
||
"bucketName":{
|
||
"shape":"EntityName",
|
||
"documentation":"<p>The name of the Amazon S3 bucket that will contain the recommendation template.</p>"
|
||
},
|
||
"clientToken":{
|
||
"shape":"ClientToken",
|
||
"documentation":"<p>Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.</p>",
|
||
"idempotencyToken":true
|
||
},
|
||
"format":{
|
||
"shape":"TemplateFormat",
|
||
"documentation":"<p>The format for the recommendation template.</p> <dl> <dt>CfnJson</dt> <dd> <p>The template is CloudFormation JSON.</p> </dd> <dt>CfnYaml</dt> <dd> <p>The template is CloudFormation YAML.</p> </dd> </dl>"
|
||
},
|
||
"name":{
|
||
"shape":"EntityName",
|
||
"documentation":"<p>The name for the recommendation template.</p>"
|
||
},
|
||
"recommendationIds":{
|
||
"shape":"RecommendationIdList",
|
||
"documentation":"<p>Identifiers for the recommendations used to create a recommendation template.</p>"
|
||
},
|
||
"recommendationTypes":{
|
||
"shape":"RenderRecommendationTypeList",
|
||
"documentation":"<p>An array of strings that specify the recommendation template type or types.</p> <dl> <dt>Alarm</dt> <dd> <p>The template is an <a>AlarmRecommendation</a> template.</p> </dd> <dt>Sop</dt> <dd> <p>The template is a <a>SopRecommendation</a> template.</p> </dd> <dt>Test</dt> <dd> <p>The template is a <a>TestRecommendation</a> template.</p> </dd> </dl>"
|
||
},
|
||
"tags":{
|
||
"shape":"TagMap",
|
||
"documentation":"<p>The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.</p>"
|
||
}
|
||
}
|
||
},
|
||
"CreateRecommendationTemplateResponse":{
|
||
"type":"structure",
|
||
"members":{
|
||
"recommendationTemplate":{
|
||
"shape":"RecommendationTemplate",
|
||
"documentation":"<p>The newly created recommendation template, returned as an object. This object includes the template's name, format, status, tags, Amazon S3 bucket location, and more.</p>"
|
||
}
|
||
}
|
||
},
|
||
"CreateResiliencyPolicyRequest":{
|
||
"type":"structure",
|
||
"required":[
|
||
"policy",
|
||
"policyName",
|
||
"tier"
|
||
],
|
||
"members":{
|
||
"clientToken":{
|
||
"shape":"ClientToken",
|
||
"documentation":"<p>Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.</p>",
|
||
"idempotencyToken":true
|
||
},
|
||
"dataLocationConstraint":{
|
||
"shape":"DataLocationConstraint",
|
||
"documentation":"<p>Specifies a high-level geographical location constraint for where your resilience policy data can be stored.</p>"
|
||
},
|
||
"policy":{
|
||
"shape":"DisruptionPolicy",
|
||
"documentation":"<p>The type of resiliency policy to be created, including the recovery time objective (RTO) and recovery point objective (RPO) in seconds.</p>"
|
||
},
|
||
"policyDescription":{
|
||
"shape":"EntityDescription",
|
||
"documentation":"<p>The description for the policy.</p>"
|
||
},
|
||
"policyName":{
|
||
"shape":"EntityName",
|
||
"documentation":"<p>The name of the policy</p>"
|
||
},
|
||
"tags":{
|
||
"shape":"TagMap",
|
||
"documentation":"<p>The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.</p>"
|
||
},
|
||
"tier":{
|
||
"shape":"ResiliencyPolicyTier",
|
||
"documentation":"<p>The tier for this resiliency policy, ranging from the highest severity (<code>MissionCritical</code>) to lowest (<code>NonCritical</code>).</p>"
|
||
}
|
||
}
|
||
},
|
||
"CreateResiliencyPolicyResponse":{
|
||
"type":"structure",
|
||
"required":["policy"],
|
||
"members":{
|
||
"policy":{
|
||
"shape":"ResiliencyPolicy",
|
||
"documentation":"<p>The type of resiliency policy that was created, including the recovery time objective (RTO) and recovery point objective (RPO) in seconds.</p>"
|
||
}
|
||
}
|
||
},
|
||
"CurrencyCode":{
|
||
"type":"string",
|
||
"max":3,
|
||
"min":0
|
||
},
|
||
"CustomerId":{
|
||
"type":"string",
|
||
"pattern":"^[0-9]{12}$"
|
||
},
|
||
"DataLocationConstraint":{
|
||
"type":"string",
|
||
"enum":[
|
||
"AnyLocation",
|
||
"SameContinent",
|
||
"SameCountry"
|
||
]
|
||
},
|
||
"DeleteAppAssessmentRequest":{
|
||
"type":"structure",
|
||
"required":["assessmentArn"],
|
||
"members":{
|
||
"assessmentArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app-assessment/<code>app-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
|
||
},
|
||
"clientToken":{
|
||
"shape":"ClientToken",
|
||
"documentation":"<p>Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.</p>",
|
||
"idempotencyToken":true
|
||
}
|
||
}
|
||
},
|
||
"DeleteAppAssessmentResponse":{
|
||
"type":"structure",
|
||
"required":[
|
||
"assessmentArn",
|
||
"assessmentStatus"
|
||
],
|
||
"members":{
|
||
"assessmentArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app-assessment/<code>app-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
|
||
},
|
||
"assessmentStatus":{
|
||
"shape":"AssessmentStatus",
|
||
"documentation":"<p>The current status of the assessment for the resiliency policy.</p>"
|
||
}
|
||
}
|
||
},
|
||
"DeleteAppRequest":{
|
||
"type":"structure",
|
||
"required":["appArn"],
|
||
"members":{
|
||
"appArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app/<code>app-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
|
||
},
|
||
"clientToken":{
|
||
"shape":"ClientToken",
|
||
"documentation":"<p>Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.</p>",
|
||
"idempotencyToken":true
|
||
},
|
||
"forceDelete":{
|
||
"shape":"BooleanOptional",
|
||
"documentation":"<p>A boolean option to force the deletion of a Resilience Hub application. </p>"
|
||
}
|
||
}
|
||
},
|
||
"DeleteAppResponse":{
|
||
"type":"structure",
|
||
"required":["appArn"],
|
||
"members":{
|
||
"appArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app/<code>app-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
|
||
}
|
||
}
|
||
},
|
||
"DeleteRecommendationTemplateRequest":{
|
||
"type":"structure",
|
||
"required":["recommendationTemplateArn"],
|
||
"members":{
|
||
"clientToken":{
|
||
"shape":"ClientToken",
|
||
"documentation":"<p>Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.</p>",
|
||
"idempotencyToken":true
|
||
},
|
||
"recommendationTemplateArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) for a recommendation template.</p>"
|
||
}
|
||
}
|
||
},
|
||
"DeleteRecommendationTemplateResponse":{
|
||
"type":"structure",
|
||
"required":[
|
||
"recommendationTemplateArn",
|
||
"status"
|
||
],
|
||
"members":{
|
||
"recommendationTemplateArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) for a recommendation template.</p>"
|
||
},
|
||
"status":{
|
||
"shape":"RecommendationTemplateStatus",
|
||
"documentation":"<p>The status of the action.</p>"
|
||
}
|
||
}
|
||
},
|
||
"DeleteResiliencyPolicyRequest":{
|
||
"type":"structure",
|
||
"required":["policyArn"],
|
||
"members":{
|
||
"clientToken":{
|
||
"shape":"ClientToken",
|
||
"documentation":"<p>Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.</p>",
|
||
"idempotencyToken":true
|
||
},
|
||
"policyArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:resiliency-policy/<code>policy-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
|
||
}
|
||
}
|
||
},
|
||
"DeleteResiliencyPolicyResponse":{
|
||
"type":"structure",
|
||
"required":["policyArn"],
|
||
"members":{
|
||
"policyArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:resiliency-policy/<code>policy-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
|
||
}
|
||
}
|
||
},
|
||
"DescribeAppAssessmentRequest":{
|
||
"type":"structure",
|
||
"required":["assessmentArn"],
|
||
"members":{
|
||
"assessmentArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app-assessment/<code>app-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
|
||
}
|
||
}
|
||
},
|
||
"DescribeAppAssessmentResponse":{
|
||
"type":"structure",
|
||
"required":["assessment"],
|
||
"members":{
|
||
"assessment":{
|
||
"shape":"AppAssessment",
|
||
"documentation":"<p>The assessment for an AWS Resilience Hub application, returned as an object. This object includes Amazon Resource Names (ARNs), compliance information, compliance status, cost, messages, resiliency scores, and more.</p>"
|
||
}
|
||
}
|
||
},
|
||
"DescribeAppRequest":{
|
||
"type":"structure",
|
||
"required":["appArn"],
|
||
"members":{
|
||
"appArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app/<code>app-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
|
||
}
|
||
}
|
||
},
|
||
"DescribeAppResponse":{
|
||
"type":"structure",
|
||
"required":["app"],
|
||
"members":{
|
||
"app":{
|
||
"shape":"App",
|
||
"documentation":"<p>The specified application, returned as an object with details including compliance status, creation time, description, resiliency score, and more.</p>"
|
||
}
|
||
}
|
||
},
|
||
"DescribeAppVersionResourcesResolutionStatusRequest":{
|
||
"type":"structure",
|
||
"required":[
|
||
"appArn",
|
||
"appVersion"
|
||
],
|
||
"members":{
|
||
"appArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app/<code>app-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
|
||
},
|
||
"appVersion":{
|
||
"shape":"EntityVersion",
|
||
"documentation":"<p>The version of the application.</p>"
|
||
},
|
||
"resolutionId":{
|
||
"shape":"String255",
|
||
"documentation":"<p>The identifier for a specific resolution.</p>"
|
||
}
|
||
}
|
||
},
|
||
"DescribeAppVersionResourcesResolutionStatusResponse":{
|
||
"type":"structure",
|
||
"required":[
|
||
"appArn",
|
||
"appVersion",
|
||
"resolutionId",
|
||
"status"
|
||
],
|
||
"members":{
|
||
"appArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app/<code>app-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
|
||
},
|
||
"appVersion":{
|
||
"shape":"EntityVersion",
|
||
"documentation":"<p>The version of the application.</p>"
|
||
},
|
||
"errorMessage":{
|
||
"shape":"String500",
|
||
"documentation":"<p>The returned error message for the request.</p>"
|
||
},
|
||
"resolutionId":{
|
||
"shape":"String255",
|
||
"documentation":"<p>The identifier for a specific resolution.</p>"
|
||
},
|
||
"status":{
|
||
"shape":"ResourceResolutionStatusType",
|
||
"documentation":"<p>The status of the action.</p>"
|
||
}
|
||
}
|
||
},
|
||
"DescribeAppVersionTemplateRequest":{
|
||
"type":"structure",
|
||
"required":[
|
||
"appArn",
|
||
"appVersion"
|
||
],
|
||
"members":{
|
||
"appArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app/<code>app-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
|
||
},
|
||
"appVersion":{
|
||
"shape":"EntityVersion",
|
||
"documentation":"<p>The version of the application.</p>"
|
||
}
|
||
}
|
||
},
|
||
"DescribeAppVersionTemplateResponse":{
|
||
"type":"structure",
|
||
"required":[
|
||
"appArn",
|
||
"appTemplateBody",
|
||
"appVersion"
|
||
],
|
||
"members":{
|
||
"appArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app/<code>app-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
|
||
},
|
||
"appTemplateBody":{
|
||
"shape":"AppTemplateBody",
|
||
"documentation":"<p>The body of the template.</p>"
|
||
},
|
||
"appVersion":{
|
||
"shape":"EntityVersion",
|
||
"documentation":"<p>The version of the application.</p>"
|
||
}
|
||
}
|
||
},
|
||
"DescribeDraftAppVersionResourcesImportStatusRequest":{
|
||
"type":"structure",
|
||
"required":["appArn"],
|
||
"members":{
|
||
"appArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app/<code>app-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
|
||
}
|
||
}
|
||
},
|
||
"DescribeDraftAppVersionResourcesImportStatusResponse":{
|
||
"type":"structure",
|
||
"required":[
|
||
"appArn",
|
||
"appVersion",
|
||
"status",
|
||
"statusChangeTime"
|
||
],
|
||
"members":{
|
||
"appArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app/<code>app-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
|
||
},
|
||
"appVersion":{
|
||
"shape":"EntityVersion",
|
||
"documentation":"<p>The version of the application.</p>"
|
||
},
|
||
"errorMessage":{
|
||
"shape":"String500",
|
||
"documentation":"<p>The returned error message for the request.</p>"
|
||
},
|
||
"status":{
|
||
"shape":"ResourceImportStatusType",
|
||
"documentation":"<p>The status of the action.</p>"
|
||
},
|
||
"statusChangeTime":{
|
||
"shape":"TimeStamp",
|
||
"documentation":"<p>The timestamp for when the status last changed.</p>"
|
||
}
|
||
}
|
||
},
|
||
"DescribeResiliencyPolicyRequest":{
|
||
"type":"structure",
|
||
"required":["policyArn"],
|
||
"members":{
|
||
"policyArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:resiliency-policy/<code>policy-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
|
||
}
|
||
}
|
||
},
|
||
"DescribeResiliencyPolicyResponse":{
|
||
"type":"structure",
|
||
"required":["policy"],
|
||
"members":{
|
||
"policy":{
|
||
"shape":"ResiliencyPolicy",
|
||
"documentation":"<p>Information about the specific resiliency policy, returned as an object. This object includes creation time, data location constraints, its name, description, tags, the recovery time objective (RTO) and recovery point objective (RPO) in seconds, and more.</p>"
|
||
}
|
||
}
|
||
},
|
||
"DisruptionCompliance":{
|
||
"type":"structure",
|
||
"required":["complianceStatus"],
|
||
"members":{
|
||
"achievableRpoInSecs":{
|
||
"shape":"Seconds",
|
||
"documentation":"<p>The Recovery Point Objective (RPO) that is achievable, in seconds.</p>"
|
||
},
|
||
"achievableRtoInSecs":{
|
||
"shape":"Seconds",
|
||
"documentation":"<p>The Recovery Time Objective (RTO) that is achievable, in seconds</p>"
|
||
},
|
||
"complianceStatus":{
|
||
"shape":"ComplianceStatus",
|
||
"documentation":"<p>The current status of compliance for the resiliency policy.</p>"
|
||
},
|
||
"currentRpoInSecs":{
|
||
"shape":"Seconds",
|
||
"documentation":"<p>The current RPO, in seconds.</p>"
|
||
},
|
||
"currentRtoInSecs":{
|
||
"shape":"Seconds",
|
||
"documentation":"<p>The current RTO, in seconds.</p>"
|
||
},
|
||
"message":{
|
||
"shape":"String500",
|
||
"documentation":"<p>The disruption compliance message.</p>"
|
||
},
|
||
"rpoDescription":{
|
||
"shape":"String500",
|
||
"documentation":"<p>The RPO description.</p>"
|
||
},
|
||
"rpoReferenceId":{
|
||
"shape":"String500",
|
||
"documentation":"<p>The RPO reference identifier.</p>"
|
||
},
|
||
"rtoDescription":{
|
||
"shape":"String500",
|
||
"documentation":"<p>The RTO description.</p>"
|
||
},
|
||
"rtoReferenceId":{
|
||
"shape":"String500",
|
||
"documentation":"<p>The RTO reference identifier.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>Defines the compliance against the resiliency policy for a disruption.</p>"
|
||
},
|
||
"DisruptionPolicy":{
|
||
"type":"map",
|
||
"key":{"shape":"DisruptionType"},
|
||
"value":{"shape":"FailurePolicy"}
|
||
},
|
||
"DisruptionResiliencyScore":{
|
||
"type":"map",
|
||
"key":{"shape":"DisruptionType"},
|
||
"value":{"shape":"Double"}
|
||
},
|
||
"DisruptionType":{
|
||
"type":"string",
|
||
"enum":[
|
||
"Software",
|
||
"Hardware",
|
||
"AZ",
|
||
"Region"
|
||
]
|
||
},
|
||
"DocumentName":{
|
||
"type":"string",
|
||
"max":500,
|
||
"min":1
|
||
},
|
||
"Double":{"type":"double"},
|
||
"EntityDescription":{
|
||
"type":"string",
|
||
"max":500,
|
||
"min":0
|
||
},
|
||
"EntityId":{
|
||
"type":"string",
|
||
"pattern":"^\\S{1,100}$"
|
||
},
|
||
"EntityName":{
|
||
"type":"string",
|
||
"pattern":"^[A-Za-z0-9][A-Za-z0-9_\\-]{1,59}$"
|
||
},
|
||
"EntityNameList":{
|
||
"type":"list",
|
||
"member":{"shape":"EntityName"}
|
||
},
|
||
"EntityVersion":{
|
||
"type":"string",
|
||
"pattern":"^\\S{1,50}$"
|
||
},
|
||
"ErrorMessage":{
|
||
"type":"string",
|
||
"max":500,
|
||
"min":0
|
||
},
|
||
"EstimatedCostTier":{
|
||
"type":"string",
|
||
"enum":[
|
||
"L1",
|
||
"L2",
|
||
"L3",
|
||
"L4"
|
||
]
|
||
},
|
||
"FailurePolicy":{
|
||
"type":"structure",
|
||
"required":[
|
||
"rpoInSecs",
|
||
"rtoInSecs"
|
||
],
|
||
"members":{
|
||
"rpoInSecs":{
|
||
"shape":"Seconds",
|
||
"documentation":"<p>The Recovery Point Objective (RPO), in seconds.</p>"
|
||
},
|
||
"rtoInSecs":{
|
||
"shape":"Seconds",
|
||
"documentation":"<p>The Recovery Time Objective (RTO), in seconds.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>Defines a failure policy.</p>"
|
||
},
|
||
"HaArchitecture":{
|
||
"type":"string",
|
||
"enum":[
|
||
"MultiSite",
|
||
"WarmStandby",
|
||
"PilotLight",
|
||
"BackupAndRestore",
|
||
"NoRecoveryPlan"
|
||
]
|
||
},
|
||
"ImportResourcesToDraftAppVersionRequest":{
|
||
"type":"structure",
|
||
"required":["appArn"],
|
||
"members":{
|
||
"appArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app/<code>app-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
|
||
},
|
||
"sourceArns":{
|
||
"shape":"ArnList",
|
||
"documentation":"<p>The Amazon Resource Names (ARNs) for the resources that you want to import.</p>"
|
||
},
|
||
"terraformSources":{
|
||
"shape":"TerraformSourceList",
|
||
"documentation":"<p> A list of terraform file s3 URLs you need to import. </p>"
|
||
}
|
||
}
|
||
},
|
||
"ImportResourcesToDraftAppVersionResponse":{
|
||
"type":"structure",
|
||
"required":[
|
||
"appArn",
|
||
"appVersion",
|
||
"status"
|
||
],
|
||
"members":{
|
||
"appArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app/<code>app-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
|
||
},
|
||
"appVersion":{
|
||
"shape":"EntityVersion",
|
||
"documentation":"<p>The version of the application.</p>"
|
||
},
|
||
"sourceArns":{
|
||
"shape":"ArnList",
|
||
"documentation":"<p>The Amazon Resource Names (ARNs) for the resources that you imported.</p>"
|
||
},
|
||
"status":{
|
||
"shape":"ResourceImportStatusType",
|
||
"documentation":"<p>The status of the action.</p>"
|
||
},
|
||
"terraformSources":{
|
||
"shape":"TerraformSourceList",
|
||
"documentation":"<p> A list of terraform file s3 URLs you need to import. </p>"
|
||
}
|
||
}
|
||
},
|
||
"InternalServerException":{
|
||
"type":"structure",
|
||
"members":{
|
||
"message":{"shape":"String500"}
|
||
},
|
||
"documentation":"<p>This exception occurs when there is an internal failure in the AWS Resilience Hub service.</p>",
|
||
"error":{"httpStatusCode":500},
|
||
"exception":true,
|
||
"fault":true
|
||
},
|
||
"ListAlarmRecommendationsRequest":{
|
||
"type":"structure",
|
||
"required":["assessmentArn"],
|
||
"members":{
|
||
"assessmentArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app-assessment/<code>app-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
|
||
},
|
||
"maxResults":{
|
||
"shape":"MaxResults",
|
||
"documentation":"<p>The maximum number of results to include in the response. If more results exist than the specified <code>MaxResults</code> value, a token is included in the response so that the remaining results can be retrieved.</p>"
|
||
},
|
||
"nextToken":{
|
||
"shape":"NextToken",
|
||
"documentation":"<p>Null, or the token from a previous call to get the next set of results.</p>"
|
||
}
|
||
}
|
||
},
|
||
"ListAlarmRecommendationsResponse":{
|
||
"type":"structure",
|
||
"required":["alarmRecommendations"],
|
||
"members":{
|
||
"alarmRecommendations":{
|
||
"shape":"AlarmRecommendationList",
|
||
"documentation":"<p>The alarm recommendations for an AWS 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.</p>"
|
||
},
|
||
"nextToken":{
|
||
"shape":"NextToken",
|
||
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>"
|
||
}
|
||
}
|
||
},
|
||
"ListAppAssessmentsRequest":{
|
||
"type":"structure",
|
||
"members":{
|
||
"appArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app/<code>app-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>",
|
||
"location":"querystring",
|
||
"locationName":"appArn"
|
||
},
|
||
"assessmentName":{
|
||
"shape":"EntityName",
|
||
"documentation":"<p>The name for the assessment.</p>",
|
||
"location":"querystring",
|
||
"locationName":"assessmentName"
|
||
},
|
||
"assessmentStatus":{
|
||
"shape":"AssessmentStatusList",
|
||
"documentation":"<p>The current status of the assessment for the resiliency policy.</p>",
|
||
"location":"querystring",
|
||
"locationName":"assessmentStatus"
|
||
},
|
||
"complianceStatus":{
|
||
"shape":"ComplianceStatus",
|
||
"documentation":"<p>The current status of compliance for the resiliency policy.</p>",
|
||
"location":"querystring",
|
||
"locationName":"complianceStatus"
|
||
},
|
||
"invoker":{
|
||
"shape":"AssessmentInvoker",
|
||
"documentation":"<p>Specifies the entity that invoked a specific assessment, either a <code>User</code> or the <code>System</code>.</p>",
|
||
"location":"querystring",
|
||
"locationName":"invoker"
|
||
},
|
||
"maxResults":{
|
||
"shape":"MaxResults",
|
||
"documentation":"<p>The maximum number of results to include in the response. If more results exist than the specified <code>MaxResults</code> value, a token is included in the response so that the remaining results can be retrieved.</p>",
|
||
"location":"querystring",
|
||
"locationName":"maxResults"
|
||
},
|
||
"nextToken":{
|
||
"shape":"NextToken",
|
||
"documentation":"<p>Null, or the token from a previous call to get the next set of results.</p>",
|
||
"location":"querystring",
|
||
"locationName":"nextToken"
|
||
},
|
||
"reverseOrder":{
|
||
"shape":"BooleanOptional",
|
||
"documentation":"<p>The default is to sort by ascending <b>startTime</b>. To sort by descending <b>startTime</b>, set reverseOrder to <code>true</code>.</p>",
|
||
"location":"querystring",
|
||
"locationName":"reverseOrder"
|
||
}
|
||
}
|
||
},
|
||
"ListAppAssessmentsResponse":{
|
||
"type":"structure",
|
||
"required":["assessmentSummaries"],
|
||
"members":{
|
||
"assessmentSummaries":{
|
||
"shape":"AppAssessmentSummaryList",
|
||
"documentation":"<p>The summaries for the specified assessments, returned as an object. This object includes application versions, associated Amazon Resource Numbers (ARNs), cost, messages, resiliency scores, and more.</p>"
|
||
},
|
||
"nextToken":{
|
||
"shape":"NextToken",
|
||
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>"
|
||
}
|
||
}
|
||
},
|
||
"ListAppComponentCompliancesRequest":{
|
||
"type":"structure",
|
||
"required":["assessmentArn"],
|
||
"members":{
|
||
"assessmentArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app-assessment/<code>app-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
|
||
},
|
||
"maxResults":{
|
||
"shape":"MaxResults",
|
||
"documentation":"<p>The maximum number of results to include in the response. If more results exist than the specified <code>MaxResults</code> value, a token is included in the response so that the remaining results can be retrieved.</p>"
|
||
},
|
||
"nextToken":{
|
||
"shape":"NextToken",
|
||
"documentation":"<p>Null, or the token from a previous call to get the next set of results.</p>"
|
||
}
|
||
}
|
||
},
|
||
"ListAppComponentCompliancesResponse":{
|
||
"type":"structure",
|
||
"required":["componentCompliances"],
|
||
"members":{
|
||
"componentCompliances":{
|
||
"shape":"ComponentCompliancesList",
|
||
"documentation":"<p>The compliances for an AWS Resilience Hub application component, returned as an object. This object contains component names, compliances, costs, resiliency scores, outage scores, and more.</p>"
|
||
},
|
||
"nextToken":{
|
||
"shape":"NextToken",
|
||
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>"
|
||
}
|
||
}
|
||
},
|
||
"ListAppComponentRecommendationsRequest":{
|
||
"type":"structure",
|
||
"required":["assessmentArn"],
|
||
"members":{
|
||
"assessmentArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app-assessment/<code>app-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
|
||
},
|
||
"maxResults":{
|
||
"shape":"MaxResults",
|
||
"documentation":"<p>The maximum number of results to include in the response. If more results exist than the specified <code>MaxResults</code> value, a token is included in the response so that the remaining results can be retrieved.</p>"
|
||
},
|
||
"nextToken":{
|
||
"shape":"NextToken",
|
||
"documentation":"<p>Null, or the token from a previous call to get the next set of results.</p>"
|
||
}
|
||
}
|
||
},
|
||
"ListAppComponentRecommendationsResponse":{
|
||
"type":"structure",
|
||
"required":["componentRecommendations"],
|
||
"members":{
|
||
"componentRecommendations":{
|
||
"shape":"ComponentRecommendationList",
|
||
"documentation":"<p>The recommendations for an Resilience Hub application component, returned as an object. This object contains component names, configuration recommendations, and recommendation statuses.</p>"
|
||
},
|
||
"nextToken":{
|
||
"shape":"NextToken",
|
||
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>"
|
||
}
|
||
}
|
||
},
|
||
"ListAppVersionResourceMappingsRequest":{
|
||
"type":"structure",
|
||
"required":[
|
||
"appArn",
|
||
"appVersion"
|
||
],
|
||
"members":{
|
||
"appArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app/<code>app-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
|
||
},
|
||
"appVersion":{
|
||
"shape":"EntityVersion",
|
||
"documentation":"<p>The version of the application.</p>"
|
||
},
|
||
"maxResults":{
|
||
"shape":"MaxResults",
|
||
"documentation":"<p>The maximum number of results to include in the response. If more results exist than the specified <code>MaxResults</code> value, a token is included in the response so that the remaining results can be retrieved.</p>"
|
||
},
|
||
"nextToken":{
|
||
"shape":"NextToken",
|
||
"documentation":"<p>Null, or the token from a previous call to get the next set of results.</p>"
|
||
}
|
||
}
|
||
},
|
||
"ListAppVersionResourceMappingsResponse":{
|
||
"type":"structure",
|
||
"required":["resourceMappings"],
|
||
"members":{
|
||
"nextToken":{
|
||
"shape":"NextToken",
|
||
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>"
|
||
},
|
||
"resourceMappings":{
|
||
"shape":"ResourceMappingList",
|
||
"documentation":"<p>Mappings used to map logical resources from the template to physical resources. You can use the mapping type <code>CFN_STACK</code> if the application template uses a logical stack name. Or you can map individual resources by using the mapping type <code>RESOURCE</code>. We recommend using the mapping type <code>CFN_STACK</code> if the application is backed by a CloudFormation stack.</p>"
|
||
}
|
||
}
|
||
},
|
||
"ListAppVersionResourcesRequest":{
|
||
"type":"structure",
|
||
"required":[
|
||
"appArn",
|
||
"appVersion"
|
||
],
|
||
"members":{
|
||
"appArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app/<code>app-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
|
||
},
|
||
"appVersion":{
|
||
"shape":"EntityVersion",
|
||
"documentation":"<p>The version of the application.</p>"
|
||
},
|
||
"maxResults":{
|
||
"shape":"MaxResults",
|
||
"documentation":"<p>The maximum number of results to include in the response. If more results exist than the specified <code>MaxResults</code> value, a token is included in the response so that the remaining results can be retrieved.</p>"
|
||
},
|
||
"nextToken":{
|
||
"shape":"NextToken",
|
||
"documentation":"<p>Null, or the token from a previous call to get the next set of results.</p>"
|
||
},
|
||
"resolutionId":{
|
||
"shape":"String255",
|
||
"documentation":"<p>The identifier for a specific resolution.</p>"
|
||
}
|
||
}
|
||
},
|
||
"ListAppVersionResourcesResponse":{
|
||
"type":"structure",
|
||
"required":[
|
||
"physicalResources",
|
||
"resolutionId"
|
||
],
|
||
"members":{
|
||
"nextToken":{
|
||
"shape":"NextToken",
|
||
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>"
|
||
},
|
||
"physicalResources":{
|
||
"shape":"PhysicalResourceList",
|
||
"documentation":"<p>The physical resources in the application version.</p>"
|
||
},
|
||
"resolutionId":{
|
||
"shape":"String255",
|
||
"documentation":"<p>The identifier for a specific resolution.</p>"
|
||
}
|
||
}
|
||
},
|
||
"ListAppVersionsRequest":{
|
||
"type":"structure",
|
||
"required":["appArn"],
|
||
"members":{
|
||
"appArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app/<code>app-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
|
||
},
|
||
"maxResults":{
|
||
"shape":"MaxResults",
|
||
"documentation":"<p>The maximum number of results to include in the response. If more results exist than the specified <code>MaxResults</code> value, a token is included in the response so that the remaining results can be retrieved.</p>"
|
||
},
|
||
"nextToken":{
|
||
"shape":"NextToken",
|
||
"documentation":"<p>Null, or the token from a previous call to get the next set of results.</p>"
|
||
}
|
||
}
|
||
},
|
||
"ListAppVersionsResponse":{
|
||
"type":"structure",
|
||
"required":["appVersions"],
|
||
"members":{
|
||
"appVersions":{
|
||
"shape":"AppVersionList",
|
||
"documentation":"<p>The version of the application.</p>"
|
||
},
|
||
"nextToken":{
|
||
"shape":"NextToken",
|
||
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>"
|
||
}
|
||
}
|
||
},
|
||
"ListAppsRequest":{
|
||
"type":"structure",
|
||
"members":{
|
||
"appArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app/<code>app-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>",
|
||
"location":"querystring",
|
||
"locationName":"appArn"
|
||
},
|
||
"maxResults":{
|
||
"shape":"MaxResults",
|
||
"documentation":"<p>The maximum number of results to include in the response. If more results exist than the specified <code>MaxResults</code> value, a token is included in the response so that the remaining results can be retrieved.</p>",
|
||
"location":"querystring",
|
||
"locationName":"maxResults"
|
||
},
|
||
"name":{
|
||
"shape":"EntityName",
|
||
"documentation":"<p>The name for the one of the listed applications.</p>",
|
||
"location":"querystring",
|
||
"locationName":"name"
|
||
},
|
||
"nextToken":{
|
||
"shape":"NextToken",
|
||
"documentation":"<p>Null, or the token from a previous call to get the next set of results.</p>",
|
||
"location":"querystring",
|
||
"locationName":"nextToken"
|
||
}
|
||
}
|
||
},
|
||
"ListAppsResponse":{
|
||
"type":"structure",
|
||
"required":["appSummaries"],
|
||
"members":{
|
||
"appSummaries":{
|
||
"shape":"AppSummaryList",
|
||
"documentation":"<p>Summaries for the Resilience Hub application.</p>"
|
||
},
|
||
"nextToken":{
|
||
"shape":"NextToken",
|
||
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>"
|
||
}
|
||
}
|
||
},
|
||
"ListRecommendationTemplatesRequest":{
|
||
"type":"structure",
|
||
"required":["assessmentArn"],
|
||
"members":{
|
||
"assessmentArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app-assessment/<code>app-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>",
|
||
"location":"querystring",
|
||
"locationName":"assessmentArn"
|
||
},
|
||
"maxResults":{
|
||
"shape":"MaxResults",
|
||
"documentation":"<p>The maximum number of results to include in the response. If more results exist than the specified <code>MaxResults</code> value, a token is included in the response so that the remaining results can be retrieved.</p>",
|
||
"location":"querystring",
|
||
"locationName":"maxResults"
|
||
},
|
||
"name":{
|
||
"shape":"EntityName",
|
||
"documentation":"<p>The name for one of the listed recommendation templates.</p>",
|
||
"location":"querystring",
|
||
"locationName":"name"
|
||
},
|
||
"nextToken":{
|
||
"shape":"NextToken",
|
||
"documentation":"<p>Null, or the token from a previous call to get the next set of results.</p>",
|
||
"location":"querystring",
|
||
"locationName":"nextToken"
|
||
},
|
||
"recommendationTemplateArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) for a recommendation template.</p>",
|
||
"location":"querystring",
|
||
"locationName":"recommendationTemplateArn"
|
||
},
|
||
"reverseOrder":{
|
||
"shape":"BooleanOptional",
|
||
"documentation":"<p>The default is to sort by ascending <b>startTime</b>. To sort by descending <b>startTime</b>, set reverseOrder to <code>true</code>.</p>",
|
||
"location":"querystring",
|
||
"locationName":"reverseOrder"
|
||
},
|
||
"status":{
|
||
"shape":"RecommendationTemplateStatusList",
|
||
"documentation":"<p>The status of the action.</p>",
|
||
"location":"querystring",
|
||
"locationName":"status"
|
||
}
|
||
}
|
||
},
|
||
"ListRecommendationTemplatesResponse":{
|
||
"type":"structure",
|
||
"members":{
|
||
"nextToken":{
|
||
"shape":"NextToken",
|
||
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>"
|
||
},
|
||
"recommendationTemplates":{
|
||
"shape":"RecommendationTemplateList",
|
||
"documentation":"<p>The recommendation templates for the Resilience Hub applications.</p>"
|
||
}
|
||
}
|
||
},
|
||
"ListResiliencyPoliciesRequest":{
|
||
"type":"structure",
|
||
"members":{
|
||
"maxResults":{
|
||
"shape":"MaxResults",
|
||
"documentation":"<p>The maximum number of results to include in the response. If more results exist than the specified <code>MaxResults</code> value, a token is included in the response so that the remaining results can be retrieved.</p>",
|
||
"location":"querystring",
|
||
"locationName":"maxResults"
|
||
},
|
||
"nextToken":{
|
||
"shape":"NextToken",
|
||
"documentation":"<p>Null, or the token from a previous call to get the next set of results.</p>",
|
||
"location":"querystring",
|
||
"locationName":"nextToken"
|
||
},
|
||
"policyName":{
|
||
"shape":"EntityName",
|
||
"documentation":"<p>The name of the policy</p>",
|
||
"location":"querystring",
|
||
"locationName":"policyName"
|
||
}
|
||
}
|
||
},
|
||
"ListResiliencyPoliciesResponse":{
|
||
"type":"structure",
|
||
"required":["resiliencyPolicies"],
|
||
"members":{
|
||
"nextToken":{
|
||
"shape":"NextToken",
|
||
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>"
|
||
},
|
||
"resiliencyPolicies":{
|
||
"shape":"ResiliencyPolicies",
|
||
"documentation":"<p>The resiliency policies for the Resilience Hub applications.</p>"
|
||
}
|
||
}
|
||
},
|
||
"ListSopRecommendationsRequest":{
|
||
"type":"structure",
|
||
"required":["assessmentArn"],
|
||
"members":{
|
||
"assessmentArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app-assessment/<code>app-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
|
||
},
|
||
"maxResults":{
|
||
"shape":"MaxResults",
|
||
"documentation":"<p>The maximum number of results to include in the response. If more results exist than the specified <code>MaxResults</code> value, a token is included in the response so that the remaining results can be retrieved.</p>"
|
||
},
|
||
"nextToken":{
|
||
"shape":"NextToken",
|
||
"documentation":"<p>Null, or the token from a previous call to get the next set of results.</p>"
|
||
}
|
||
}
|
||
},
|
||
"ListSopRecommendationsResponse":{
|
||
"type":"structure",
|
||
"required":["sopRecommendations"],
|
||
"members":{
|
||
"nextToken":{
|
||
"shape":"NextToken",
|
||
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>"
|
||
},
|
||
"sopRecommendations":{
|
||
"shape":"SopRecommendationList",
|
||
"documentation":"<p>The standard operating procedure (SOP) recommendations for the Resilience Hub applications.</p>"
|
||
}
|
||
}
|
||
},
|
||
"ListSuggestedResiliencyPoliciesRequest":{
|
||
"type":"structure",
|
||
"members":{
|
||
"maxResults":{
|
||
"shape":"MaxResults",
|
||
"documentation":"<p>The maximum number of results to include in the response. If more results exist than the specified <code>MaxResults</code> value, a token is included in the response so that the remaining results can be retrieved.</p>",
|
||
"location":"querystring",
|
||
"locationName":"maxResults"
|
||
},
|
||
"nextToken":{
|
||
"shape":"NextToken",
|
||
"documentation":"<p>Null, or the token from a previous call to get the next set of results.</p>",
|
||
"location":"querystring",
|
||
"locationName":"nextToken"
|
||
}
|
||
}
|
||
},
|
||
"ListSuggestedResiliencyPoliciesResponse":{
|
||
"type":"structure",
|
||
"required":["resiliencyPolicies"],
|
||
"members":{
|
||
"nextToken":{
|
||
"shape":"NextToken",
|
||
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>"
|
||
},
|
||
"resiliencyPolicies":{
|
||
"shape":"ResiliencyPolicies",
|
||
"documentation":"<p>The suggested resiliency policies for the Resilience Hub applications.</p>"
|
||
}
|
||
}
|
||
},
|
||
"ListTagsForResourceRequest":{
|
||
"type":"structure",
|
||
"required":["resourceArn"],
|
||
"members":{
|
||
"resourceArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) for a specific resource in your Resilience Hub application.</p>",
|
||
"location":"uri",
|
||
"locationName":"resourceArn"
|
||
}
|
||
}
|
||
},
|
||
"ListTagsForResourceResponse":{
|
||
"type":"structure",
|
||
"members":{
|
||
"tags":{
|
||
"shape":"TagMap",
|
||
"documentation":"<p>The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.</p>"
|
||
}
|
||
}
|
||
},
|
||
"ListTestRecommendationsRequest":{
|
||
"type":"structure",
|
||
"required":["assessmentArn"],
|
||
"members":{
|
||
"assessmentArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app-assessment/<code>app-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
|
||
},
|
||
"maxResults":{
|
||
"shape":"MaxResults",
|
||
"documentation":"<p>The maximum number of results to include in the response. If more results exist than the specified <code>MaxResults</code> value, a token is included in the response so that the remaining results can be retrieved.</p>"
|
||
},
|
||
"nextToken":{
|
||
"shape":"NextToken",
|
||
"documentation":"<p>Null, or the token from a previous call to get the next set of results.</p>"
|
||
}
|
||
}
|
||
},
|
||
"ListTestRecommendationsResponse":{
|
||
"type":"structure",
|
||
"required":["testRecommendations"],
|
||
"members":{
|
||
"nextToken":{
|
||
"shape":"NextToken",
|
||
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>"
|
||
},
|
||
"testRecommendations":{
|
||
"shape":"TestRecommendationList",
|
||
"documentation":"<p>The test recommendations for the Resilience Hub application.</p>"
|
||
}
|
||
}
|
||
},
|
||
"ListUnsupportedAppVersionResourcesRequest":{
|
||
"type":"structure",
|
||
"required":[
|
||
"appArn",
|
||
"appVersion"
|
||
],
|
||
"members":{
|
||
"appArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app/<code>app-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
|
||
},
|
||
"appVersion":{
|
||
"shape":"EntityVersion",
|
||
"documentation":"<p>The version of the application.</p>"
|
||
},
|
||
"maxResults":{
|
||
"shape":"MaxResults",
|
||
"documentation":"<p>The maximum number of results to include in the response. If more results exist than the specified <code>MaxResults</code> value, a token is included in the response so that the remaining results can be retrieved.</p>"
|
||
},
|
||
"nextToken":{
|
||
"shape":"NextToken",
|
||
"documentation":"<p>Null, or the token from a previous call to get the next set of results.</p>"
|
||
},
|
||
"resolutionId":{
|
||
"shape":"String255",
|
||
"documentation":"<p>The identifier for a specific resolution.</p>"
|
||
}
|
||
}
|
||
},
|
||
"ListUnsupportedAppVersionResourcesResponse":{
|
||
"type":"structure",
|
||
"required":[
|
||
"resolutionId",
|
||
"unsupportedResources"
|
||
],
|
||
"members":{
|
||
"nextToken":{
|
||
"shape":"NextToken",
|
||
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>"
|
||
},
|
||
"resolutionId":{
|
||
"shape":"String255",
|
||
"documentation":"<p>The identifier for a specific resolution.</p>"
|
||
},
|
||
"unsupportedResources":{
|
||
"shape":"UnsupportedResourceList",
|
||
"documentation":"<p>The unsupported resources for the application.</p>"
|
||
}
|
||
}
|
||
},
|
||
"LogicalResourceId":{
|
||
"type":"structure",
|
||
"required":["identifier"],
|
||
"members":{
|
||
"identifier":{
|
||
"shape":"String255",
|
||
"documentation":"<p>The identifier of the resource.</p>"
|
||
},
|
||
"logicalStackName":{
|
||
"shape":"String255",
|
||
"documentation":"<p>The name of the CloudFormation stack this resource belongs to.</p>"
|
||
},
|
||
"resourceGroupName":{
|
||
"shape":"EntityName",
|
||
"documentation":"<p>The name of the resource group that this resource belongs to.</p>"
|
||
},
|
||
"terraformSourceName":{
|
||
"shape":"String255",
|
||
"documentation":"<p> The name of the Terraform S3 state file this resource belongs to. </p>"
|
||
}
|
||
},
|
||
"documentation":"<p>Defines a logical resource identifier.</p>"
|
||
},
|
||
"MaxResults":{
|
||
"type":"integer",
|
||
"box":true,
|
||
"max":100,
|
||
"min":1
|
||
},
|
||
"NextToken":{
|
||
"type":"string",
|
||
"pattern":"^\\S{1,2000}$"
|
||
},
|
||
"PhysicalIdentifierType":{
|
||
"type":"string",
|
||
"enum":[
|
||
"Arn",
|
||
"Native"
|
||
]
|
||
},
|
||
"PhysicalResource":{
|
||
"type":"structure",
|
||
"required":[
|
||
"logicalResourceId",
|
||
"physicalResourceId",
|
||
"resourceType"
|
||
],
|
||
"members":{
|
||
"appComponents":{
|
||
"shape":"AppComponentList",
|
||
"documentation":"<p>The application components that belong to this resource.</p>"
|
||
},
|
||
"logicalResourceId":{
|
||
"shape":"LogicalResourceId",
|
||
"documentation":"<p>The logical identifier of the resource.</p>"
|
||
},
|
||
"physicalResourceId":{
|
||
"shape":"PhysicalResourceId",
|
||
"documentation":"<p>The physical identifier of the resource.</p>"
|
||
},
|
||
"resourceName":{
|
||
"shape":"EntityName",
|
||
"documentation":"<p>The name of the resource.</p>"
|
||
},
|
||
"resourceType":{
|
||
"shape":"String255",
|
||
"documentation":"<p>The type of resource.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>Defines a physical resource. A physical resource is a resource that exists in your account. It can be identified using an Amazon Resource Name (ARN) or a Resilience Hub-native identifier. </p>"
|
||
},
|
||
"PhysicalResourceId":{
|
||
"type":"structure",
|
||
"required":[
|
||
"identifier",
|
||
"type"
|
||
],
|
||
"members":{
|
||
"awsAccountId":{
|
||
"shape":"CustomerId",
|
||
"documentation":"<p>The Amazon Web Services account that owns the physical resource.</p>"
|
||
},
|
||
"awsRegion":{
|
||
"shape":"AwsRegion",
|
||
"documentation":"<p>The Amazon Web Services Region that the physical resource is located in.</p>"
|
||
},
|
||
"identifier":{
|
||
"shape":"String255",
|
||
"documentation":"<p>The identifier of the physical resource.</p>"
|
||
},
|
||
"type":{
|
||
"shape":"PhysicalIdentifierType",
|
||
"documentation":"<p>Specifies the type of physical resource identifier.</p> <dl> <dt>Arn</dt> <dd> <p>The resource identifier is an Amazon Resource Name (ARN) .</p> </dd> <dt>Native</dt> <dd> <p>The resource identifier is a Resilience Hub-native identifier.</p> </dd> </dl>"
|
||
}
|
||
},
|
||
"documentation":"<p>Defines a physical resource identifier.</p>"
|
||
},
|
||
"PhysicalResourceList":{
|
||
"type":"list",
|
||
"member":{"shape":"PhysicalResource"}
|
||
},
|
||
"PublishAppVersionRequest":{
|
||
"type":"structure",
|
||
"required":["appArn"],
|
||
"members":{
|
||
"appArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app/<code>app-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
|
||
}
|
||
}
|
||
},
|
||
"PublishAppVersionResponse":{
|
||
"type":"structure",
|
||
"required":["appArn"],
|
||
"members":{
|
||
"appArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app/<code>app-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
|
||
},
|
||
"appVersion":{
|
||
"shape":"EntityVersion",
|
||
"documentation":"<p>The version of the application.</p>"
|
||
}
|
||
}
|
||
},
|
||
"PutDraftAppVersionTemplateRequest":{
|
||
"type":"structure",
|
||
"required":[
|
||
"appArn",
|
||
"appTemplateBody"
|
||
],
|
||
"members":{
|
||
"appArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app/<code>app-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
|
||
},
|
||
"appTemplateBody":{
|
||
"shape":"AppTemplateBody",
|
||
"documentation":"<p>A JSON string that contains the body of the app template.</p>"
|
||
}
|
||
}
|
||
},
|
||
"PutDraftAppVersionTemplateResponse":{
|
||
"type":"structure",
|
||
"members":{
|
||
"appArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app/<code>app-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
|
||
},
|
||
"appVersion":{
|
||
"shape":"EntityVersion",
|
||
"documentation":"<p>The version of the application.</p>"
|
||
}
|
||
}
|
||
},
|
||
"RecommendationCompliance":{
|
||
"type":"map",
|
||
"key":{"shape":"DisruptionType"},
|
||
"value":{"shape":"RecommendationDisruptionCompliance"}
|
||
},
|
||
"RecommendationComplianceStatus":{
|
||
"type":"string",
|
||
"enum":[
|
||
"BreachedUnattainable",
|
||
"BreachedCanMeet",
|
||
"MetCanImprove"
|
||
]
|
||
},
|
||
"RecommendationDisruptionCompliance":{
|
||
"type":"structure",
|
||
"required":["expectedComplianceStatus"],
|
||
"members":{
|
||
"expectedComplianceStatus":{
|
||
"shape":"ComplianceStatus",
|
||
"documentation":"<p>The expected compliance status after applying the recommended configuration change.</p>"
|
||
},
|
||
"expectedRpoDescription":{
|
||
"shape":"String500",
|
||
"documentation":"<p>The expected Recovery Point Objective (RPO) description after applying the recommended configuration change.</p>"
|
||
},
|
||
"expectedRpoInSecs":{
|
||
"shape":"Seconds",
|
||
"documentation":"<p>The expected RPO after applying the recommended configuration change.</p>"
|
||
},
|
||
"expectedRtoDescription":{
|
||
"shape":"String500",
|
||
"documentation":"<p>The expected Recovery Time Objective (RTO) description after applying the recommended configuration change.</p>"
|
||
},
|
||
"expectedRtoInSecs":{
|
||
"shape":"Seconds",
|
||
"documentation":"<p>The expected RTO after applying the recommended configuration change.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>Defines a disruption compliance recommendation.</p>"
|
||
},
|
||
"RecommendationIdList":{
|
||
"type":"list",
|
||
"member":{"shape":"Uuid"},
|
||
"max":200,
|
||
"min":1
|
||
},
|
||
"RecommendationItem":{
|
||
"type":"structure",
|
||
"members":{
|
||
"alreadyImplemented":{
|
||
"shape":"BooleanOptional",
|
||
"documentation":"<p>Specifies if the recommendation has already been implemented.</p>"
|
||
},
|
||
"resourceId":{
|
||
"shape":"String500",
|
||
"documentation":"<p>The resource identifier.</p>"
|
||
},
|
||
"targetAccountId":{
|
||
"shape":"CustomerId",
|
||
"documentation":"<p>The target account identifier.</p>"
|
||
},
|
||
"targetRegion":{
|
||
"shape":"AwsRegion",
|
||
"documentation":"<p>The target region.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>Defines a recommendation.</p>"
|
||
},
|
||
"RecommendationItemList":{
|
||
"type":"list",
|
||
"member":{"shape":"RecommendationItem"}
|
||
},
|
||
"RecommendationTemplate":{
|
||
"type":"structure",
|
||
"required":[
|
||
"assessmentArn",
|
||
"format",
|
||
"name",
|
||
"recommendationTemplateArn",
|
||
"recommendationTypes",
|
||
"status"
|
||
],
|
||
"members":{
|
||
"appArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app/<code>app-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
|
||
},
|
||
"assessmentArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app-assessment/<code>app-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
|
||
},
|
||
"endTime":{
|
||
"shape":"TimeStamp",
|
||
"documentation":"<p>The end time for the action.</p>"
|
||
},
|
||
"format":{
|
||
"shape":"TemplateFormat",
|
||
"documentation":"<p>The format of the recommendation template.</p> <dl> <dt>CfnJson</dt> <dd> <p>The template is CloudFormation JSON.</p> </dd> <dt>CfnYaml</dt> <dd> <p>The template is CloudFormation YAML.</p> </dd> </dl>"
|
||
},
|
||
"message":{
|
||
"shape":"String500",
|
||
"documentation":"<p>The message for the recommendation template.</p>"
|
||
},
|
||
"name":{
|
||
"shape":"EntityName",
|
||
"documentation":"<p>The name for the recommendation template.</p>"
|
||
},
|
||
"needsReplacements":{
|
||
"shape":"BooleanOptional",
|
||
"documentation":"<p>Indicates if replacements are needed.</p>"
|
||
},
|
||
"recommendationIds":{
|
||
"shape":"RecommendationIdList",
|
||
"documentation":"<p>Identifiers for the recommendations used in the recommendation template.</p>"
|
||
},
|
||
"recommendationTemplateArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) for the recommendation template.</p>"
|
||
},
|
||
"recommendationTypes":{
|
||
"shape":"RenderRecommendationTypeList",
|
||
"documentation":"<p>An array of strings that specify the recommendation template type or types.</p> <dl> <dt>Alarm</dt> <dd> <p>The template is an <a>AlarmRecommendation</a> template.</p> </dd> <dt>Sop</dt> <dd> <p>The template is a <a>SopRecommendation</a> template.</p> </dd> <dt>Test</dt> <dd> <p>The template is a <a>TestRecommendation</a> template.</p> </dd> </dl>"
|
||
},
|
||
"startTime":{
|
||
"shape":"TimeStamp",
|
||
"documentation":"<p>The start time for the action.</p>"
|
||
},
|
||
"status":{
|
||
"shape":"RecommendationTemplateStatus",
|
||
"documentation":"<p>The status of the action.</p>"
|
||
},
|
||
"tags":{
|
||
"shape":"TagMap",
|
||
"documentation":"<p>The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.</p>"
|
||
},
|
||
"templatesLocation":{
|
||
"shape":"S3Location",
|
||
"documentation":"<p>The file location of the template.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>Defines a recommendation template created with the <a>CreateRecommendationTemplate</a> action.</p>"
|
||
},
|
||
"RecommendationTemplateList":{
|
||
"type":"list",
|
||
"member":{"shape":"RecommendationTemplate"}
|
||
},
|
||
"RecommendationTemplateStatus":{
|
||
"type":"string",
|
||
"enum":[
|
||
"Pending",
|
||
"InProgress",
|
||
"Failed",
|
||
"Success"
|
||
]
|
||
},
|
||
"RecommendationTemplateStatusList":{
|
||
"type":"list",
|
||
"member":{"shape":"RecommendationTemplateStatus"},
|
||
"max":4,
|
||
"min":1
|
||
},
|
||
"RemoveDraftAppVersionResourceMappingsRequest":{
|
||
"type":"structure",
|
||
"required":["appArn"],
|
||
"members":{
|
||
"appArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app/<code>app-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
|
||
},
|
||
"appRegistryAppNames":{
|
||
"shape":"EntityNameList",
|
||
"documentation":"<p>The names of the registered applications to remove from the resource mappings.</p>"
|
||
},
|
||
"logicalStackNames":{
|
||
"shape":"String255List",
|
||
"documentation":"<p>The names of the CloudFormation stacks to remove from the resource mappings.</p>"
|
||
},
|
||
"resourceGroupNames":{
|
||
"shape":"EntityNameList",
|
||
"documentation":"<p>The names of the resource groups to remove from the resource mappings.</p>"
|
||
},
|
||
"resourceNames":{
|
||
"shape":"EntityNameList",
|
||
"documentation":"<p>The names of the resources to remove from the resource mappings.</p>"
|
||
},
|
||
"terraformSourceNames":{
|
||
"shape":"String255List",
|
||
"documentation":"<p> <pre><code></p> </code></pre>"
|
||
}
|
||
}
|
||
},
|
||
"RemoveDraftAppVersionResourceMappingsResponse":{
|
||
"type":"structure",
|
||
"members":{
|
||
"appArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app/<code>app-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
|
||
},
|
||
"appVersion":{
|
||
"shape":"EntityVersion",
|
||
"documentation":"<p>The version of the application.</p>"
|
||
}
|
||
}
|
||
},
|
||
"RenderRecommendationType":{
|
||
"type":"string",
|
||
"enum":[
|
||
"Alarm",
|
||
"Sop",
|
||
"Test"
|
||
]
|
||
},
|
||
"RenderRecommendationTypeList":{
|
||
"type":"list",
|
||
"member":{"shape":"RenderRecommendationType"},
|
||
"max":4,
|
||
"min":1
|
||
},
|
||
"ResiliencyPolicies":{
|
||
"type":"list",
|
||
"member":{"shape":"ResiliencyPolicy"}
|
||
},
|
||
"ResiliencyPolicy":{
|
||
"type":"structure",
|
||
"members":{
|
||
"creationTime":{
|
||
"shape":"TimeStamp",
|
||
"documentation":"<p>The timestamp for when the resiliency policy was created.</p>"
|
||
},
|
||
"dataLocationConstraint":{
|
||
"shape":"DataLocationConstraint",
|
||
"documentation":"<p>Specifies a high-level geographical location constraint for where your resilience policy data can be stored.</p>"
|
||
},
|
||
"estimatedCostTier":{
|
||
"shape":"EstimatedCostTier",
|
||
"documentation":"<p>Specifies the estimated cost tier of the resiliency policy.</p>"
|
||
},
|
||
"policy":{
|
||
"shape":"DisruptionPolicy",
|
||
"documentation":"<p>The resiliency policy.</p>"
|
||
},
|
||
"policyArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:resiliency-policy/<code>policy-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
|
||
},
|
||
"policyDescription":{
|
||
"shape":"EntityDescription",
|
||
"documentation":"<p>The description for the policy.</p>"
|
||
},
|
||
"policyName":{
|
||
"shape":"EntityName",
|
||
"documentation":"<p>The name of the policy</p>"
|
||
},
|
||
"tags":{
|
||
"shape":"TagMap",
|
||
"documentation":"<p>The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.</p>"
|
||
},
|
||
"tier":{
|
||
"shape":"ResiliencyPolicyTier",
|
||
"documentation":"<p>The tier for this resiliency policy, ranging from the highest severity (<code>MissionCritical</code>) to lowest (<code>NonCritical</code>).</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>Defines a resiliency policy.</p>"
|
||
},
|
||
"ResiliencyPolicyTier":{
|
||
"type":"string",
|
||
"enum":[
|
||
"MissionCritical",
|
||
"Critical",
|
||
"Important",
|
||
"CoreServices",
|
||
"NonCritical"
|
||
]
|
||
},
|
||
"ResiliencyScore":{
|
||
"type":"structure",
|
||
"required":[
|
||
"disruptionScore",
|
||
"score"
|
||
],
|
||
"members":{
|
||
"disruptionScore":{
|
||
"shape":"DisruptionResiliencyScore",
|
||
"documentation":"<p>The disruption score for a valid key.</p>"
|
||
},
|
||
"score":{
|
||
"shape":"Double",
|
||
"documentation":"<p>The outage score for a valid key.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>The overall resiliency score, returned as an object that includes the disruption score and outage score.</p>"
|
||
},
|
||
"ResolveAppVersionResourcesRequest":{
|
||
"type":"structure",
|
||
"required":[
|
||
"appArn",
|
||
"appVersion"
|
||
],
|
||
"members":{
|
||
"appArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app/<code>app-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
|
||
},
|
||
"appVersion":{
|
||
"shape":"EntityVersion",
|
||
"documentation":"<p>The version of the application.</p>"
|
||
}
|
||
}
|
||
},
|
||
"ResolveAppVersionResourcesResponse":{
|
||
"type":"structure",
|
||
"required":[
|
||
"appArn",
|
||
"appVersion",
|
||
"resolutionId",
|
||
"status"
|
||
],
|
||
"members":{
|
||
"appArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app/<code>app-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
|
||
},
|
||
"appVersion":{
|
||
"shape":"EntityVersion",
|
||
"documentation":"<p>The version of the application.</p>"
|
||
},
|
||
"resolutionId":{
|
||
"shape":"String255",
|
||
"documentation":"<p>The identifier for a specific resolution.</p>"
|
||
},
|
||
"status":{
|
||
"shape":"ResourceResolutionStatusType",
|
||
"documentation":"<p>The status of the action.</p>"
|
||
}
|
||
}
|
||
},
|
||
"ResourceError":{
|
||
"type":"structure",
|
||
"members":{
|
||
"logicalResourceId":{
|
||
"shape":"String255",
|
||
"documentation":"<p> This is the identifier of the resource. </p>"
|
||
},
|
||
"physicalResourceId":{
|
||
"shape":"String255",
|
||
"documentation":"<p> This is the identifier of the physical resource. </p>"
|
||
},
|
||
"reason":{
|
||
"shape":"ErrorMessage",
|
||
"documentation":"<p> This is the error message. </p>"
|
||
}
|
||
},
|
||
"documentation":"<p> Defines application resource errors. </p>"
|
||
},
|
||
"ResourceErrorList":{
|
||
"type":"list",
|
||
"member":{"shape":"ResourceError"}
|
||
},
|
||
"ResourceErrorsDetails":{
|
||
"type":"structure",
|
||
"members":{
|
||
"hasMoreErrors":{
|
||
"shape":"BooleanOptional",
|
||
"documentation":"<p> This indicates if there are more errors not listed in the resourceErrors list. </p>"
|
||
},
|
||
"resourceErrors":{
|
||
"shape":"ResourceErrorList",
|
||
"documentation":"<p> A list of errors retrieving an application's resources. </p>"
|
||
}
|
||
},
|
||
"documentation":"<p> A list of errors retrieving an application's resources. </p>"
|
||
},
|
||
"ResourceId":{
|
||
"type":"string",
|
||
"pattern":".*"
|
||
},
|
||
"ResourceImportStatusType":{
|
||
"type":"string",
|
||
"enum":[
|
||
"Pending",
|
||
"InProgress",
|
||
"Failed",
|
||
"Success"
|
||
]
|
||
},
|
||
"ResourceMapping":{
|
||
"type":"structure",
|
||
"required":[
|
||
"mappingType",
|
||
"physicalResourceId"
|
||
],
|
||
"members":{
|
||
"appRegistryAppName":{
|
||
"shape":"EntityName",
|
||
"documentation":"<p>The name of the application this resource is mapped to.</p>"
|
||
},
|
||
"logicalStackName":{
|
||
"shape":"String255",
|
||
"documentation":"<p>The name of the CloudFormation stack this resource is mapped to.</p>"
|
||
},
|
||
"mappingType":{
|
||
"shape":"ResourceMappingType",
|
||
"documentation":"<p>Specifies the type of resource mapping.</p> <dl> <dt>AppRegistryApp</dt> <dd> <p>The resource is mapped to another application. The name of the application is contained in the <code>appRegistryAppName</code> property.</p> </dd> <dt>CfnStack</dt> <dd> <p>The resource is mapped to a CloudFormation stack. The name of the CloudFormation stack is contained in the <code>logicalStackName</code> property.</p> </dd> <dt>Resource</dt> <dd> <p>The resource is mapped to another resource. The name of the resource is contained in the <code>resourceName</code> property.</p> </dd> <dt>ResourceGroup</dt> <dd> <p>The resource is mapped to a resource group. The name of the resource group is contained in the <code>resourceGroupName</code> property.</p> </dd> </dl>"
|
||
},
|
||
"physicalResourceId":{
|
||
"shape":"PhysicalResourceId",
|
||
"documentation":"<p>The identifier of this resource.</p>"
|
||
},
|
||
"resourceGroupName":{
|
||
"shape":"EntityName",
|
||
"documentation":"<p>The name of the resource group this resource is mapped to.</p>"
|
||
},
|
||
"resourceName":{
|
||
"shape":"EntityName",
|
||
"documentation":"<p>The name of the resource this resource is mapped to.</p>"
|
||
},
|
||
"terraformSourceName":{
|
||
"shape":"String255",
|
||
"documentation":"<p> The short name of the Terraform source. </p>"
|
||
}
|
||
},
|
||
"documentation":"<p>Defines a resource mapping.</p>"
|
||
},
|
||
"ResourceMappingList":{
|
||
"type":"list",
|
||
"member":{"shape":"ResourceMapping"}
|
||
},
|
||
"ResourceMappingType":{
|
||
"type":"string",
|
||
"enum":[
|
||
"CfnStack",
|
||
"Resource",
|
||
"AppRegistryApp",
|
||
"ResourceGroup",
|
||
"Terraform"
|
||
]
|
||
},
|
||
"ResourceNotFoundException":{
|
||
"type":"structure",
|
||
"members":{
|
||
"message":{"shape":"String500"},
|
||
"resourceId":{
|
||
"shape":"ResourceId",
|
||
"documentation":"<p>The identifier of the resource that the exception applies to.</p>"
|
||
},
|
||
"resourceType":{
|
||
"shape":"ResourceType",
|
||
"documentation":"<p>The type of the resource that the exception applies to.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>The specified resource could not be found.</p>",
|
||
"error":{
|
||
"httpStatusCode":404,
|
||
"senderFault":true
|
||
},
|
||
"exception":true
|
||
},
|
||
"ResourceResolutionStatusType":{
|
||
"type":"string",
|
||
"enum":[
|
||
"Pending",
|
||
"InProgress",
|
||
"Failed",
|
||
"Success"
|
||
]
|
||
},
|
||
"ResourceType":{
|
||
"type":"string",
|
||
"pattern":".*"
|
||
},
|
||
"RetryAfterSeconds":{
|
||
"type":"integer",
|
||
"box":true
|
||
},
|
||
"S3Location":{
|
||
"type":"structure",
|
||
"members":{
|
||
"bucket":{
|
||
"shape":"String500",
|
||
"documentation":"<p>The name of the Amazon S3 bucket.</p>"
|
||
},
|
||
"prefix":{
|
||
"shape":"String500",
|
||
"documentation":"<p>The prefix for the Amazon S3 bucket.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>The location of the Amazon S3 bucket.</p>"
|
||
},
|
||
"S3Url":{
|
||
"type":"string",
|
||
"max":2000,
|
||
"min":0,
|
||
"pattern":"^((https://([^/]+)\\.s3((-|\\.)[^/]+)?\\.amazonaws\\.com(.cn)?)|(s3://([^/]+)))/\\S{1,2000}$"
|
||
},
|
||
"Seconds":{
|
||
"type":"integer",
|
||
"min":0
|
||
},
|
||
"ServiceQuotaExceededException":{
|
||
"type":"structure",
|
||
"members":{
|
||
"message":{"shape":"String500"}
|
||
},
|
||
"documentation":"<p>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.</p>",
|
||
"error":{
|
||
"httpStatusCode":402,
|
||
"senderFault":true
|
||
},
|
||
"exception":true
|
||
},
|
||
"SopRecommendation":{
|
||
"type":"structure",
|
||
"required":[
|
||
"recommendationId",
|
||
"referenceId",
|
||
"serviceType"
|
||
],
|
||
"members":{
|
||
"appComponentName":{
|
||
"shape":"EntityId",
|
||
"documentation":"<p>The application component name.</p>"
|
||
},
|
||
"description":{
|
||
"shape":"String500",
|
||
"documentation":"<p>The description of the SOP recommendation.</p>"
|
||
},
|
||
"items":{
|
||
"shape":"RecommendationItemList",
|
||
"documentation":"<p>The recommendation items.</p>"
|
||
},
|
||
"name":{
|
||
"shape":"DocumentName",
|
||
"documentation":"<p>The name of the SOP recommendation.</p>"
|
||
},
|
||
"prerequisite":{
|
||
"shape":"String500",
|
||
"documentation":"<p>The prerequisite for the SOP recommendation.</p>"
|
||
},
|
||
"recommendationId":{
|
||
"shape":"Uuid",
|
||
"documentation":"<p>Identifier for the SOP recommendation.</p>"
|
||
},
|
||
"referenceId":{
|
||
"shape":"SpecReferenceId",
|
||
"documentation":"<p>The reference identifier for the SOP recommendation.</p>"
|
||
},
|
||
"serviceType":{
|
||
"shape":"SopServiceType",
|
||
"documentation":"<p>The service type.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>Defines a standard operating procedure (SOP) recommendation.</p>"
|
||
},
|
||
"SopRecommendationList":{
|
||
"type":"list",
|
||
"member":{"shape":"SopRecommendation"}
|
||
},
|
||
"SopServiceType":{
|
||
"type":"string",
|
||
"enum":["SSM"]
|
||
},
|
||
"SpecReferenceId":{
|
||
"type":"string",
|
||
"max":500,
|
||
"min":1
|
||
},
|
||
"StartAppAssessmentRequest":{
|
||
"type":"structure",
|
||
"required":[
|
||
"appArn",
|
||
"appVersion",
|
||
"assessmentName"
|
||
],
|
||
"members":{
|
||
"appArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app/<code>app-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
|
||
},
|
||
"appVersion":{
|
||
"shape":"EntityVersion",
|
||
"documentation":"<p>The version of the application.</p>"
|
||
},
|
||
"assessmentName":{
|
||
"shape":"EntityName",
|
||
"documentation":"<p>The name for the assessment.</p>"
|
||
},
|
||
"clientToken":{
|
||
"shape":"ClientToken",
|
||
"documentation":"<p>Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.</p>",
|
||
"idempotencyToken":true
|
||
},
|
||
"tags":{
|
||
"shape":"TagMap",
|
||
"documentation":"<p>The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.</p>"
|
||
}
|
||
}
|
||
},
|
||
"StartAppAssessmentResponse":{
|
||
"type":"structure",
|
||
"required":["assessment"],
|
||
"members":{
|
||
"assessment":{
|
||
"shape":"AppAssessment",
|
||
"documentation":"<p>The assessment created.</p>"
|
||
}
|
||
}
|
||
},
|
||
"String255":{
|
||
"type":"string",
|
||
"max":255,
|
||
"min":1
|
||
},
|
||
"String255List":{
|
||
"type":"list",
|
||
"member":{"shape":"String255"}
|
||
},
|
||
"String500":{
|
||
"type":"string",
|
||
"max":500,
|
||
"min":1
|
||
},
|
||
"SuggestedChangesList":{
|
||
"type":"list",
|
||
"member":{"shape":"EntityDescription"}
|
||
},
|
||
"TagKey":{
|
||
"type":"string",
|
||
"max":128,
|
||
"min":1,
|
||
"pattern":"^(?!aws:)[^\\x00-\\x1f\\x22]+$"
|
||
},
|
||
"TagKeyList":{
|
||
"type":"list",
|
||
"member":{"shape":"TagKey"},
|
||
"max":50,
|
||
"min":1,
|
||
"sensitive":true
|
||
},
|
||
"TagMap":{
|
||
"type":"map",
|
||
"key":{"shape":"TagKey"},
|
||
"value":{"shape":"TagValue"},
|
||
"max":50,
|
||
"min":1,
|
||
"sensitive":true
|
||
},
|
||
"TagResourceRequest":{
|
||
"type":"structure",
|
||
"required":[
|
||
"resourceArn",
|
||
"tags"
|
||
],
|
||
"members":{
|
||
"resourceArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the resource. </p>",
|
||
"location":"uri",
|
||
"locationName":"resourceArn"
|
||
},
|
||
"tags":{
|
||
"shape":"TagMap",
|
||
"documentation":"<p>The tags to assign to the resource. Each tag consists of a key/value pair.</p>"
|
||
}
|
||
}
|
||
},
|
||
"TagResourceResponse":{
|
||
"type":"structure",
|
||
"members":{
|
||
}
|
||
},
|
||
"TagValue":{
|
||
"type":"string",
|
||
"max":256,
|
||
"min":0,
|
||
"pattern":"^[^\\x00-\\x1f\\x22]*$"
|
||
},
|
||
"TemplateFormat":{
|
||
"type":"string",
|
||
"enum":[
|
||
"CfnYaml",
|
||
"CfnJson"
|
||
]
|
||
},
|
||
"TerraformSource":{
|
||
"type":"structure",
|
||
"required":["s3StateFileUrl"],
|
||
"members":{
|
||
"s3StateFileUrl":{
|
||
"shape":"S3Url",
|
||
"documentation":"<p> The Terraform s3 state file you need to import. </p>"
|
||
}
|
||
},
|
||
"documentation":"<p> The Terraform s3 state file you need to import. </p>"
|
||
},
|
||
"TerraformSourceList":{
|
||
"type":"list",
|
||
"member":{"shape":"TerraformSource"}
|
||
},
|
||
"TestRecommendation":{
|
||
"type":"structure",
|
||
"required":["referenceId"],
|
||
"members":{
|
||
"appComponentName":{
|
||
"shape":"EntityId",
|
||
"documentation":"<p>The name of the application component.</p>"
|
||
},
|
||
"dependsOnAlarms":{
|
||
"shape":"AlarmReferenceIdList",
|
||
"documentation":"<p> A list of recommended alarms that are used in the test and must be exported before or with the test. </p>"
|
||
},
|
||
"description":{
|
||
"shape":"String500",
|
||
"documentation":"<p>The description for the test recommendation.</p>"
|
||
},
|
||
"intent":{
|
||
"shape":"EntityDescription",
|
||
"documentation":"<p>The intent of the test recommendation.</p>"
|
||
},
|
||
"items":{
|
||
"shape":"RecommendationItemList",
|
||
"documentation":"<p>The test recommendation items.</p>"
|
||
},
|
||
"name":{
|
||
"shape":"DocumentName",
|
||
"documentation":"<p>The name of the test recommendation.</p>"
|
||
},
|
||
"prerequisite":{
|
||
"shape":"String500",
|
||
"documentation":"<p>The prerequisite of the test recommendation.</p>"
|
||
},
|
||
"recommendationId":{
|
||
"shape":"Uuid",
|
||
"documentation":"<p>Identifier for the test recommendation.</p>"
|
||
},
|
||
"referenceId":{
|
||
"shape":"SpecReferenceId",
|
||
"documentation":"<p>The reference identifier for the test recommendation.</p>"
|
||
},
|
||
"risk":{
|
||
"shape":"TestRisk",
|
||
"documentation":"<p>The level of risk for this test recommendation.</p>"
|
||
},
|
||
"type":{
|
||
"shape":"TestType",
|
||
"documentation":"<p>The type of test recommendation.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>Defines a test recommendation.</p>"
|
||
},
|
||
"TestRecommendationList":{
|
||
"type":"list",
|
||
"member":{"shape":"TestRecommendation"}
|
||
},
|
||
"TestRisk":{
|
||
"type":"string",
|
||
"enum":[
|
||
"Small",
|
||
"Medium",
|
||
"High"
|
||
]
|
||
},
|
||
"TestType":{
|
||
"type":"string",
|
||
"enum":[
|
||
"Software",
|
||
"Hardware",
|
||
"AZ",
|
||
"Region"
|
||
]
|
||
},
|
||
"ThrottlingException":{
|
||
"type":"structure",
|
||
"members":{
|
||
"message":{"shape":"String500"},
|
||
"retryAfterSeconds":{
|
||
"shape":"RetryAfterSeconds",
|
||
"documentation":"<p>The number of seconds to wait before retrying the operation.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>The limit on the number of requests per second was exceeded.</p>",
|
||
"error":{
|
||
"httpStatusCode":429,
|
||
"senderFault":true
|
||
},
|
||
"exception":true
|
||
},
|
||
"TimeStamp":{"type":"timestamp"},
|
||
"UnsupportedResource":{
|
||
"type":"structure",
|
||
"required":[
|
||
"logicalResourceId",
|
||
"physicalResourceId",
|
||
"resourceType"
|
||
],
|
||
"members":{
|
||
"logicalResourceId":{
|
||
"shape":"LogicalResourceId",
|
||
"documentation":"<p>The logical resource identifier for the unsupported resource.</p>"
|
||
},
|
||
"physicalResourceId":{
|
||
"shape":"PhysicalResourceId",
|
||
"documentation":"<p>The physical resource identifier for the unsupported resource.</p>"
|
||
},
|
||
"resourceType":{
|
||
"shape":"String255",
|
||
"documentation":"<p>The type of resource.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>Defines a resource that is not supported by Resilience Hub.</p>"
|
||
},
|
||
"UnsupportedResourceList":{
|
||
"type":"list",
|
||
"member":{"shape":"UnsupportedResource"}
|
||
},
|
||
"UntagResourceRequest":{
|
||
"type":"structure",
|
||
"required":[
|
||
"resourceArn",
|
||
"tagKeys"
|
||
],
|
||
"members":{
|
||
"resourceArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the resource. </p>",
|
||
"location":"uri",
|
||
"locationName":"resourceArn"
|
||
},
|
||
"tagKeys":{
|
||
"shape":"TagKeyList",
|
||
"documentation":"<p>The keys of the tags to remove.</p>",
|
||
"location":"querystring",
|
||
"locationName":"tagKeys"
|
||
}
|
||
}
|
||
},
|
||
"UntagResourceResponse":{
|
||
"type":"structure",
|
||
"members":{
|
||
}
|
||
},
|
||
"UpdateAppRequest":{
|
||
"type":"structure",
|
||
"required":["appArn"],
|
||
"members":{
|
||
"appArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app/<code>app-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
|
||
},
|
||
"assessmentSchedule":{
|
||
"shape":"AppAssessmentScheduleType",
|
||
"documentation":"<p> Assessment execution schedule with 'Daily' or 'Disabled' values. </p>"
|
||
},
|
||
"clearResiliencyPolicyArn":{
|
||
"shape":"BooleanOptional",
|
||
"documentation":"<p>Specifies if the resiliency policy ARN should be cleared.</p>"
|
||
},
|
||
"description":{
|
||
"shape":"EntityDescription",
|
||
"documentation":"<p>The optional description for an app.</p>"
|
||
},
|
||
"policyArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:resiliency-policy/<code>policy-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
|
||
}
|
||
}
|
||
},
|
||
"UpdateAppResponse":{
|
||
"type":"structure",
|
||
"required":["app"],
|
||
"members":{
|
||
"app":{
|
||
"shape":"App",
|
||
"documentation":"<p>The specified application, returned as an object with details including compliance status, creation time, description, resiliency score, and more.</p>"
|
||
}
|
||
}
|
||
},
|
||
"UpdateResiliencyPolicyRequest":{
|
||
"type":"structure",
|
||
"required":["policyArn"],
|
||
"members":{
|
||
"dataLocationConstraint":{
|
||
"shape":"DataLocationConstraint",
|
||
"documentation":"<p>Specifies a high-level geographical location constraint for where your resilience policy data can be stored.</p>"
|
||
},
|
||
"policy":{
|
||
"shape":"DisruptionPolicy",
|
||
"documentation":"<p>The type of resiliency policy to be created, including the recovery time objective (RTO) and recovery point objective (RPO) in seconds.</p>"
|
||
},
|
||
"policyArn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:resiliency-policy/<code>policy-id</code>. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"> Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
|
||
},
|
||
"policyDescription":{
|
||
"shape":"EntityDescription",
|
||
"documentation":"<p>The description for the policy.</p>"
|
||
},
|
||
"policyName":{
|
||
"shape":"EntityName",
|
||
"documentation":"<p>The name of the policy</p>"
|
||
},
|
||
"tier":{
|
||
"shape":"ResiliencyPolicyTier",
|
||
"documentation":"<p>The tier for this resiliency policy, ranging from the highest severity (<code>MissionCritical</code>) to lowest (<code>NonCritical</code>).</p>"
|
||
}
|
||
}
|
||
},
|
||
"UpdateResiliencyPolicyResponse":{
|
||
"type":"structure",
|
||
"required":["policy"],
|
||
"members":{
|
||
"policy":{
|
||
"shape":"ResiliencyPolicy",
|
||
"documentation":"<p>The type of resiliency policy that was updated, including the recovery time objective (RTO) and recovery point objective (RPO) in seconds.</p>"
|
||
}
|
||
}
|
||
},
|
||
"Uuid":{
|
||
"type":"string",
|
||
"pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$"
|
||
},
|
||
"ValidationException":{
|
||
"type":"structure",
|
||
"members":{
|
||
"message":{"shape":"String500"}
|
||
},
|
||
"documentation":"<p>Indicates that a request was not valid.</p>",
|
||
"error":{
|
||
"httpStatusCode":400,
|
||
"senderFault":true
|
||
},
|
||
"exception":true
|
||
}
|
||
},
|
||
"documentation":"<p>AWS Resilience Hub helps you proactively prepare and protect your Amazon Web Services applications from disruptions. Resilience Hub offers continuous resiliency assessment and validation that integrates into your software development lifecycle. This enables you to uncover resiliency weaknesses, ensure recovery time objective (RTO) and recovery point objective (RPO) targets for your applications are met, and resolve issues before they are released into production. </p>"
|
||
}
|