Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.ResilienceHub.Lens

Contents

Operations
Types

Description

Synopsis

Operations

AddDraftAppVersionResourceMappings

addDraftAppVersionResourceMappings_appArn :: Lens' AddDraftAppVersionResourceMappings Text Source #

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

addDraftAppVersionResourceMappings_resourceMappings :: Lens' AddDraftAppVersionResourceMappings [ResourceMapping] Source #

Mappings used to map logical resources from the template to physical resources. You can use the mapping type CFN_STACK if the application template uses a logical stack name. Or you can map individual resources by using the mapping type RESOURCE. We recommend using the mapping type CFN_STACK if the application is backed by a CloudFormation stack.

addDraftAppVersionResourceMappingsResponse_httpStatus :: Lens' AddDraftAppVersionResourceMappingsResponse Int Source #

The response's http status code.

addDraftAppVersionResourceMappingsResponse_appArn :: Lens' AddDraftAppVersionResourceMappingsResponse Text Source #

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

addDraftAppVersionResourceMappingsResponse_appVersion :: Lens' AddDraftAppVersionResourceMappingsResponse Text Source #

The version of the application.

addDraftAppVersionResourceMappingsResponse_resourceMappings :: Lens' AddDraftAppVersionResourceMappingsResponse [ResourceMapping] Source #

Mappings used to map logical resources from the template to physical resources. You can use the mapping type CFN_STACK if the application template uses a logical stack name. Or you can map individual resources by using the mapping type RESOURCE. We recommend using the mapping type CFN_STACK if the application is backed by a CloudFormation stack.

CreateApp

createApp_assessmentSchedule :: Lens' CreateApp (Maybe AppAssessmentScheduleType) Source #

Assessment execution schedule with 'Daily' or 'Disabled' values.

createApp_clientToken :: Lens' CreateApp (Maybe Text) Source #

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.

createApp_description :: Lens' CreateApp (Maybe Text) Source #

The optional description for an app.

createApp_policyArn :: Lens' CreateApp (Maybe Text) Source #

The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

createApp_tags :: Lens' CreateApp (Maybe (HashMap Text Text)) Source #

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.

createApp_name :: Lens' CreateApp Text Source #

The name for the application.

createAppResponse_httpStatus :: Lens' CreateAppResponse Int Source #

The response's http status code.

createAppResponse_app :: Lens' CreateAppResponse App Source #

The created application returned as an object with details including compliance status, creation time, description, resiliency score, and more.

CreateRecommendationTemplate

createRecommendationTemplate_bucketName :: Lens' CreateRecommendationTemplate (Maybe Text) Source #

The name of the Amazon S3 bucket that will contain the recommendation template.

createRecommendationTemplate_clientToken :: Lens' CreateRecommendationTemplate (Maybe Text) Source #

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.

createRecommendationTemplate_format :: Lens' CreateRecommendationTemplate (Maybe TemplateFormat) Source #

The format for the recommendation template.

CfnJson: The template is CloudFormation JSON.
CfnYaml: The template is CloudFormation YAML.

createRecommendationTemplate_recommendationIds :: Lens' CreateRecommendationTemplate (Maybe (NonEmpty Text)) Source #

Identifiers for the recommendations used to create a recommendation template.

createRecommendationTemplate_recommendationTypes :: Lens' CreateRecommendationTemplate (Maybe (NonEmpty RenderRecommendationType)) Source #

An array of strings that specify the recommendation template type or types.

Alarm: The template is an AlarmRecommendation template.
Sop: The template is a SopRecommendation template.
Test: The template is a TestRecommendation template.

createRecommendationTemplate_tags :: Lens' CreateRecommendationTemplate (Maybe (HashMap Text Text)) Source #

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.

createRecommendationTemplate_assessmentArn :: Lens' CreateRecommendationTemplate Text Source #

The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

createRecommendationTemplate_name :: Lens' CreateRecommendationTemplate Text Source #

The name for the recommendation template.

createRecommendationTemplateResponse_recommendationTemplate :: Lens' CreateRecommendationTemplateResponse (Maybe RecommendationTemplate) Source #

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.

createRecommendationTemplateResponse_httpStatus :: Lens' CreateRecommendationTemplateResponse Int Source #

The response's http status code.

CreateResiliencyPolicy

createResiliencyPolicy_clientToken :: Lens' CreateResiliencyPolicy (Maybe Text) Source #

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.

createResiliencyPolicy_dataLocationConstraint :: Lens' CreateResiliencyPolicy (Maybe DataLocationConstraint) Source #

Specifies a high-level geographical location constraint for where your resilience policy data can be stored.

createResiliencyPolicy_policyDescription :: Lens' CreateResiliencyPolicy (Maybe Text) Source #

The description for the policy.

createResiliencyPolicy_tags :: Lens' CreateResiliencyPolicy (Maybe (HashMap Text Text)) Source #

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.

createResiliencyPolicy_policy :: Lens' CreateResiliencyPolicy (HashMap DisruptionType FailurePolicy) Source #

The type of resiliency policy to be created, including the recovery time objective (RTO) and recovery point objective (RPO) in seconds.

createResiliencyPolicy_policyName :: Lens' CreateResiliencyPolicy Text Source #

The name of the policy

createResiliencyPolicy_tier :: Lens' CreateResiliencyPolicy ResiliencyPolicyTier Source #

The tier for this resiliency policy, ranging from the highest severity (MissionCritical) to lowest (NonCritical).

createResiliencyPolicyResponse_httpStatus :: Lens' CreateResiliencyPolicyResponse Int Source #

The response's http status code.

createResiliencyPolicyResponse_policy :: Lens' CreateResiliencyPolicyResponse ResiliencyPolicy Source #

The type of resiliency policy that was created, including the recovery time objective (RTO) and recovery point objective (RPO) in seconds.

DeleteApp

deleteApp_clientToken :: Lens' DeleteApp (Maybe Text) Source #

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.

deleteApp_forceDelete :: Lens' DeleteApp (Maybe Bool) Source #

A boolean option to force the deletion of a Resilience Hub application.

deleteApp_appArn :: Lens' DeleteApp Text Source #

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

deleteAppResponse_httpStatus :: Lens' DeleteAppResponse Int Source #

The response's http status code.

deleteAppResponse_appArn :: Lens' DeleteAppResponse Text Source #

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

DeleteAppAssessment

deleteAppAssessment_clientToken :: Lens' DeleteAppAssessment (Maybe Text) Source #

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.

deleteAppAssessment_assessmentArn :: Lens' DeleteAppAssessment Text Source #

The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

deleteAppAssessmentResponse_httpStatus :: Lens' DeleteAppAssessmentResponse Int Source #

The response's http status code.

deleteAppAssessmentResponse_assessmentArn :: Lens' DeleteAppAssessmentResponse Text Source #

The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

deleteAppAssessmentResponse_assessmentStatus :: Lens' DeleteAppAssessmentResponse AssessmentStatus Source #

The current status of the assessment for the resiliency policy.

DeleteRecommendationTemplate

deleteRecommendationTemplate_clientToken :: Lens' DeleteRecommendationTemplate (Maybe Text) Source #

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.

deleteRecommendationTemplate_recommendationTemplateArn :: Lens' DeleteRecommendationTemplate Text Source #

The Amazon Resource Name (ARN) for a recommendation template.

deleteRecommendationTemplateResponse_httpStatus :: Lens' DeleteRecommendationTemplateResponse Int Source #

The response's http status code.

deleteRecommendationTemplateResponse_recommendationTemplateArn :: Lens' DeleteRecommendationTemplateResponse Text Source #

The Amazon Resource Name (ARN) for a recommendation template.

deleteRecommendationTemplateResponse_status :: Lens' DeleteRecommendationTemplateResponse RecommendationTemplateStatus Source #

The status of the action.

DeleteResiliencyPolicy

deleteResiliencyPolicy_clientToken :: Lens' DeleteResiliencyPolicy (Maybe Text) Source #

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.

deleteResiliencyPolicy_policyArn :: Lens' DeleteResiliencyPolicy Text Source #

The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

deleteResiliencyPolicyResponse_httpStatus :: Lens' DeleteResiliencyPolicyResponse Int Source #

The response's http status code.

deleteResiliencyPolicyResponse_policyArn :: Lens' DeleteResiliencyPolicyResponse Text Source #

The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

DescribeApp

describeApp_appArn :: Lens' DescribeApp Text Source #

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

describeAppResponse_httpStatus :: Lens' DescribeAppResponse Int Source #

The response's http status code.

describeAppResponse_app :: Lens' DescribeAppResponse App Source #

The specified application, returned as an object with details including compliance status, creation time, description, resiliency score, and more.

DescribeAppAssessment

describeAppAssessment_assessmentArn :: Lens' DescribeAppAssessment Text Source #

The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

describeAppAssessmentResponse_httpStatus :: Lens' DescribeAppAssessmentResponse Int Source #

The response's http status code.

describeAppAssessmentResponse_assessment :: Lens' DescribeAppAssessmentResponse AppAssessment Source #

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.

DescribeAppVersionResourcesResolutionStatus

describeAppVersionResourcesResolutionStatus_resolutionId :: Lens' DescribeAppVersionResourcesResolutionStatus (Maybe Text) Source #

The identifier for a specific resolution.

describeAppVersionResourcesResolutionStatus_appArn :: Lens' DescribeAppVersionResourcesResolutionStatus Text Source #

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

describeAppVersionResourcesResolutionStatus_appVersion :: Lens' DescribeAppVersionResourcesResolutionStatus Text Source #

The version of the application.

describeAppVersionResourcesResolutionStatusResponse_errorMessage :: Lens' DescribeAppVersionResourcesResolutionStatusResponse (Maybe Text) Source #

The returned error message for the request.

describeAppVersionResourcesResolutionStatusResponse_httpStatus :: Lens' DescribeAppVersionResourcesResolutionStatusResponse Int Source #

The response's http status code.

describeAppVersionResourcesResolutionStatusResponse_appArn :: Lens' DescribeAppVersionResourcesResolutionStatusResponse Text Source #

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

describeAppVersionResourcesResolutionStatusResponse_appVersion :: Lens' DescribeAppVersionResourcesResolutionStatusResponse Text Source #

The version of the application.

describeAppVersionResourcesResolutionStatusResponse_resolutionId :: Lens' DescribeAppVersionResourcesResolutionStatusResponse Text Source #

The identifier for a specific resolution.

describeAppVersionResourcesResolutionStatusResponse_status :: Lens' DescribeAppVersionResourcesResolutionStatusResponse ResourceResolutionStatusType Source #

The status of the action.

DescribeAppVersionTemplate

describeAppVersionTemplate_appArn :: Lens' DescribeAppVersionTemplate Text Source #

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

describeAppVersionTemplate_appVersion :: Lens' DescribeAppVersionTemplate Text Source #

The version of the application.

describeAppVersionTemplateResponse_httpStatus :: Lens' DescribeAppVersionTemplateResponse Int Source #

The response's http status code.

describeAppVersionTemplateResponse_appArn :: Lens' DescribeAppVersionTemplateResponse Text Source #

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

describeAppVersionTemplateResponse_appTemplateBody :: Lens' DescribeAppVersionTemplateResponse Text Source #

The body of the template.

describeAppVersionTemplateResponse_appVersion :: Lens' DescribeAppVersionTemplateResponse Text Source #

The version of the application.

DescribeDraftAppVersionResourcesImportStatus

describeDraftAppVersionResourcesImportStatus_appArn :: Lens' DescribeDraftAppVersionResourcesImportStatus Text Source #

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

describeDraftAppVersionResourcesImportStatusResponse_errorMessage :: Lens' DescribeDraftAppVersionResourcesImportStatusResponse (Maybe Text) Source #

The returned error message for the request.

describeDraftAppVersionResourcesImportStatusResponse_httpStatus :: Lens' DescribeDraftAppVersionResourcesImportStatusResponse Int Source #

The response's http status code.

describeDraftAppVersionResourcesImportStatusResponse_appArn :: Lens' DescribeDraftAppVersionResourcesImportStatusResponse Text Source #

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

describeDraftAppVersionResourcesImportStatusResponse_appVersion :: Lens' DescribeDraftAppVersionResourcesImportStatusResponse Text Source #

The version of the application.

describeDraftAppVersionResourcesImportStatusResponse_status :: Lens' DescribeDraftAppVersionResourcesImportStatusResponse ResourceImportStatusType Source #

The status of the action.

describeDraftAppVersionResourcesImportStatusResponse_statusChangeTime :: Lens' DescribeDraftAppVersionResourcesImportStatusResponse UTCTime Source #

The timestamp for when the status last changed.

DescribeResiliencyPolicy

describeResiliencyPolicy_policyArn :: Lens' DescribeResiliencyPolicy Text Source #

The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

describeResiliencyPolicyResponse_httpStatus :: Lens' DescribeResiliencyPolicyResponse Int Source #

The response's http status code.

describeResiliencyPolicyResponse_policy :: Lens' DescribeResiliencyPolicyResponse ResiliencyPolicy Source #

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.

ImportResourcesToDraftAppVersion

importResourcesToDraftAppVersion_sourceArns :: Lens' ImportResourcesToDraftAppVersion (Maybe [Text]) Source #

The Amazon Resource Names (ARNs) for the resources that you want to import.

importResourcesToDraftAppVersion_terraformSources :: Lens' ImportResourcesToDraftAppVersion (Maybe [TerraformSource]) Source #

A list of terraform file s3 URLs you need to import.

importResourcesToDraftAppVersion_appArn :: Lens' ImportResourcesToDraftAppVersion Text Source #

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

importResourcesToDraftAppVersionResponse_sourceArns :: Lens' ImportResourcesToDraftAppVersionResponse (Maybe [Text]) Source #

The Amazon Resource Names (ARNs) for the resources that you imported.

importResourcesToDraftAppVersionResponse_terraformSources :: Lens' ImportResourcesToDraftAppVersionResponse (Maybe [TerraformSource]) Source #

A list of terraform file s3 URLs you need to import.

importResourcesToDraftAppVersionResponse_httpStatus :: Lens' ImportResourcesToDraftAppVersionResponse Int Source #

The response's http status code.

importResourcesToDraftAppVersionResponse_appArn :: Lens' ImportResourcesToDraftAppVersionResponse Text Source #

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

importResourcesToDraftAppVersionResponse_appVersion :: Lens' ImportResourcesToDraftAppVersionResponse Text Source #

The version of the application.

importResourcesToDraftAppVersionResponse_status :: Lens' ImportResourcesToDraftAppVersionResponse ResourceImportStatusType Source #

The status of the action.

ListAlarmRecommendations

listAlarmRecommendations_maxResults :: Lens' ListAlarmRecommendations (Maybe Natural) Source #

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

listAlarmRecommendations_nextToken :: Lens' ListAlarmRecommendations (Maybe Text) Source #

Null, or the token from a previous call to get the next set of results.

listAlarmRecommendations_assessmentArn :: Lens' ListAlarmRecommendations Text Source #

The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

listAlarmRecommendationsResponse_nextToken :: Lens' ListAlarmRecommendationsResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listAlarmRecommendationsResponse_httpStatus :: Lens' ListAlarmRecommendationsResponse Int Source #

The response's http status code.

listAlarmRecommendationsResponse_alarmRecommendations :: Lens' ListAlarmRecommendationsResponse [AlarmRecommendation] Source #

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.

ListAppAssessments

listAppAssessments_appArn :: Lens' ListAppAssessments (Maybe Text) Source #

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

listAppAssessments_assessmentName :: Lens' ListAppAssessments (Maybe Text) Source #

The name for the assessment.

listAppAssessments_assessmentStatus :: Lens' ListAppAssessments (Maybe (NonEmpty AssessmentStatus)) Source #

The current status of the assessment for the resiliency policy.

listAppAssessments_complianceStatus :: Lens' ListAppAssessments (Maybe ComplianceStatus) Source #

The current status of compliance for the resiliency policy.

listAppAssessments_invoker :: Lens' ListAppAssessments (Maybe AssessmentInvoker) Source #

Specifies the entity that invoked a specific assessment, either a User or the System.

listAppAssessments_maxResults :: Lens' ListAppAssessments (Maybe Natural) Source #

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

listAppAssessments_nextToken :: Lens' ListAppAssessments (Maybe Text) Source #

Null, or the token from a previous call to get the next set of results.

listAppAssessments_reverseOrder :: Lens' ListAppAssessments (Maybe Bool) Source #

The default is to sort by ascending startTime. To sort by descending startTime, set reverseOrder to true.

listAppAssessmentsResponse_nextToken :: Lens' ListAppAssessmentsResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listAppAssessmentsResponse_httpStatus :: Lens' ListAppAssessmentsResponse Int Source #

The response's http status code.

listAppAssessmentsResponse_assessmentSummaries :: Lens' ListAppAssessmentsResponse [AppAssessmentSummary] Source #

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.

ListAppComponentCompliances

listAppComponentCompliances_maxResults :: Lens' ListAppComponentCompliances (Maybe Natural) Source #

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

listAppComponentCompliances_nextToken :: Lens' ListAppComponentCompliances (Maybe Text) Source #

Null, or the token from a previous call to get the next set of results.

listAppComponentCompliances_assessmentArn :: Lens' ListAppComponentCompliances Text Source #

The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

listAppComponentCompliancesResponse_nextToken :: Lens' ListAppComponentCompliancesResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listAppComponentCompliancesResponse_httpStatus :: Lens' ListAppComponentCompliancesResponse Int Source #

The response's http status code.

listAppComponentCompliancesResponse_componentCompliances :: Lens' ListAppComponentCompliancesResponse [AppComponentCompliance] Source #

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.

ListAppComponentRecommendations

listAppComponentRecommendations_maxResults :: Lens' ListAppComponentRecommendations (Maybe Natural) Source #

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

listAppComponentRecommendations_nextToken :: Lens' ListAppComponentRecommendations (Maybe Text) Source #

Null, or the token from a previous call to get the next set of results.

listAppComponentRecommendations_assessmentArn :: Lens' ListAppComponentRecommendations Text Source #

The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

listAppComponentRecommendationsResponse_nextToken :: Lens' ListAppComponentRecommendationsResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listAppComponentRecommendationsResponse_httpStatus :: Lens' ListAppComponentRecommendationsResponse Int Source #

The response's http status code.

listAppComponentRecommendationsResponse_componentRecommendations :: Lens' ListAppComponentRecommendationsResponse [ComponentRecommendation] Source #

The recommendations for an Resilience Hub application component, returned as an object. This object contains component names, configuration recommendations, and recommendation statuses.

ListAppVersionResourceMappings

listAppVersionResourceMappings_maxResults :: Lens' ListAppVersionResourceMappings (Maybe Natural) Source #

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

listAppVersionResourceMappings_nextToken :: Lens' ListAppVersionResourceMappings (Maybe Text) Source #

Null, or the token from a previous call to get the next set of results.

listAppVersionResourceMappings_appArn :: Lens' ListAppVersionResourceMappings Text Source #

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

listAppVersionResourceMappings_appVersion :: Lens' ListAppVersionResourceMappings Text Source #

The version of the application.

listAppVersionResourceMappingsResponse_nextToken :: Lens' ListAppVersionResourceMappingsResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listAppVersionResourceMappingsResponse_httpStatus :: Lens' ListAppVersionResourceMappingsResponse Int Source #

The response's http status code.

listAppVersionResourceMappingsResponse_resourceMappings :: Lens' ListAppVersionResourceMappingsResponse [ResourceMapping] Source #

Mappings used to map logical resources from the template to physical resources. You can use the mapping type CFN_STACK if the application template uses a logical stack name. Or you can map individual resources by using the mapping type RESOURCE. We recommend using the mapping type CFN_STACK if the application is backed by a CloudFormation stack.

ListAppVersionResources

listAppVersionResources_maxResults :: Lens' ListAppVersionResources (Maybe Natural) Source #

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

listAppVersionResources_nextToken :: Lens' ListAppVersionResources (Maybe Text) Source #

Null, or the token from a previous call to get the next set of results.

listAppVersionResources_resolutionId :: Lens' ListAppVersionResources (Maybe Text) Source #

The identifier for a specific resolution.

listAppVersionResources_appArn :: Lens' ListAppVersionResources Text Source #

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

listAppVersionResources_appVersion :: Lens' ListAppVersionResources Text Source #

The version of the application.

listAppVersionResourcesResponse_nextToken :: Lens' ListAppVersionResourcesResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listAppVersionResourcesResponse_httpStatus :: Lens' ListAppVersionResourcesResponse Int Source #

The response's http status code.

listAppVersionResourcesResponse_physicalResources :: Lens' ListAppVersionResourcesResponse [PhysicalResource] Source #

The physical resources in the application version.

listAppVersionResourcesResponse_resolutionId :: Lens' ListAppVersionResourcesResponse Text Source #

The identifier for a specific resolution.

ListAppVersions

listAppVersions_maxResults :: Lens' ListAppVersions (Maybe Natural) Source #

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

listAppVersions_nextToken :: Lens' ListAppVersions (Maybe Text) Source #

Null, or the token from a previous call to get the next set of results.

listAppVersions_appArn :: Lens' ListAppVersions Text Source #

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

listAppVersionsResponse_nextToken :: Lens' ListAppVersionsResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listAppVersionsResponse_httpStatus :: Lens' ListAppVersionsResponse Int Source #

The response's http status code.

listAppVersionsResponse_appVersions :: Lens' ListAppVersionsResponse [AppVersionSummary] Source #

The version of the application.

ListApps

listApps_appArn :: Lens' ListApps (Maybe Text) Source #

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

listApps_maxResults :: Lens' ListApps (Maybe Natural) Source #

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

listApps_name :: Lens' ListApps (Maybe Text) Source #

The name for the one of the listed applications.

listApps_nextToken :: Lens' ListApps (Maybe Text) Source #

Null, or the token from a previous call to get the next set of results.

listAppsResponse_nextToken :: Lens' ListAppsResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listAppsResponse_httpStatus :: Lens' ListAppsResponse Int Source #

The response's http status code.

listAppsResponse_appSummaries :: Lens' ListAppsResponse [AppSummary] Source #

Summaries for the Resilience Hub application.

ListRecommendationTemplates

listRecommendationTemplates_maxResults :: Lens' ListRecommendationTemplates (Maybe Natural) Source #

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

listRecommendationTemplates_name :: Lens' ListRecommendationTemplates (Maybe Text) Source #

The name for one of the listed recommendation templates.

listRecommendationTemplates_nextToken :: Lens' ListRecommendationTemplates (Maybe Text) Source #

Null, or the token from a previous call to get the next set of results.

listRecommendationTemplates_recommendationTemplateArn :: Lens' ListRecommendationTemplates (Maybe Text) Source #

The Amazon Resource Name (ARN) for a recommendation template.

listRecommendationTemplates_reverseOrder :: Lens' ListRecommendationTemplates (Maybe Bool) Source #

The default is to sort by ascending startTime. To sort by descending startTime, set reverseOrder to true.

listRecommendationTemplates_status :: Lens' ListRecommendationTemplates (Maybe (NonEmpty RecommendationTemplateStatus)) Source #

The status of the action.

listRecommendationTemplates_assessmentArn :: Lens' ListRecommendationTemplates Text Source #

The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

listRecommendationTemplatesResponse_nextToken :: Lens' ListRecommendationTemplatesResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listRecommendationTemplatesResponse_recommendationTemplates :: Lens' ListRecommendationTemplatesResponse (Maybe [RecommendationTemplate]) Source #

The recommendation templates for the Resilience Hub applications.

listRecommendationTemplatesResponse_httpStatus :: Lens' ListRecommendationTemplatesResponse Int Source #

The response's http status code.

ListResiliencyPolicies

listResiliencyPolicies_maxResults :: Lens' ListResiliencyPolicies (Maybe Natural) Source #

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

listResiliencyPolicies_nextToken :: Lens' ListResiliencyPolicies (Maybe Text) Source #

Null, or the token from a previous call to get the next set of results.

listResiliencyPolicies_policyName :: Lens' ListResiliencyPolicies (Maybe Text) Source #

The name of the policy

listResiliencyPoliciesResponse_nextToken :: Lens' ListResiliencyPoliciesResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listResiliencyPoliciesResponse_httpStatus :: Lens' ListResiliencyPoliciesResponse Int Source #

The response's http status code.

listResiliencyPoliciesResponse_resiliencyPolicies :: Lens' ListResiliencyPoliciesResponse [ResiliencyPolicy] Source #

The resiliency policies for the Resilience Hub applications.

ListSopRecommendations

listSopRecommendations_maxResults :: Lens' ListSopRecommendations (Maybe Natural) Source #

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

listSopRecommendations_nextToken :: Lens' ListSopRecommendations (Maybe Text) Source #

Null, or the token from a previous call to get the next set of results.

listSopRecommendations_assessmentArn :: Lens' ListSopRecommendations Text Source #

The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

listSopRecommendationsResponse_nextToken :: Lens' ListSopRecommendationsResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listSopRecommendationsResponse_httpStatus :: Lens' ListSopRecommendationsResponse Int Source #

The response's http status code.

listSopRecommendationsResponse_sopRecommendations :: Lens' ListSopRecommendationsResponse [SopRecommendation] Source #

The standard operating procedure (SOP) recommendations for the Resilience Hub applications.

ListSuggestedResiliencyPolicies

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

Null, or the token from a previous call to get the next set of results.

The token for the next set of results, or null if there are no more results.

The response's http status code.

The suggested resiliency policies for the Resilience Hub applications.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The Amazon Resource Name (ARN) for a specific resource in your Resilience Hub application.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text)) Source #

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.

listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #

The response's http status code.

ListTestRecommendations

listTestRecommendations_maxResults :: Lens' ListTestRecommendations (Maybe Natural) Source #

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

listTestRecommendations_nextToken :: Lens' ListTestRecommendations (Maybe Text) Source #

Null, or the token from a previous call to get the next set of results.

listTestRecommendations_assessmentArn :: Lens' ListTestRecommendations Text Source #

The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

listTestRecommendationsResponse_nextToken :: Lens' ListTestRecommendationsResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listTestRecommendationsResponse_httpStatus :: Lens' ListTestRecommendationsResponse Int Source #

The response's http status code.

listTestRecommendationsResponse_testRecommendations :: Lens' ListTestRecommendationsResponse [TestRecommendation] Source #

The test recommendations for the Resilience Hub application.

ListUnsupportedAppVersionResources

listUnsupportedAppVersionResources_maxResults :: Lens' ListUnsupportedAppVersionResources (Maybe Natural) Source #

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

listUnsupportedAppVersionResources_nextToken :: Lens' ListUnsupportedAppVersionResources (Maybe Text) Source #

Null, or the token from a previous call to get the next set of results.

listUnsupportedAppVersionResources_resolutionId :: Lens' ListUnsupportedAppVersionResources (Maybe Text) Source #

The identifier for a specific resolution.

listUnsupportedAppVersionResources_appArn :: Lens' ListUnsupportedAppVersionResources Text Source #

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

listUnsupportedAppVersionResources_appVersion :: Lens' ListUnsupportedAppVersionResources Text Source #

The version of the application.

listUnsupportedAppVersionResourcesResponse_nextToken :: Lens' ListUnsupportedAppVersionResourcesResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listUnsupportedAppVersionResourcesResponse_httpStatus :: Lens' ListUnsupportedAppVersionResourcesResponse Int Source #

The response's http status code.

listUnsupportedAppVersionResourcesResponse_resolutionId :: Lens' ListUnsupportedAppVersionResourcesResponse Text Source #

The identifier for a specific resolution.

listUnsupportedAppVersionResourcesResponse_unsupportedResources :: Lens' ListUnsupportedAppVersionResourcesResponse [UnsupportedResource] Source #

The unsupported resources for the application.

PublishAppVersion

publishAppVersion_appArn :: Lens' PublishAppVersion Text Source #

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

publishAppVersionResponse_appVersion :: Lens' PublishAppVersionResponse (Maybe Text) Source #

The version of the application.

publishAppVersionResponse_httpStatus :: Lens' PublishAppVersionResponse Int Source #

The response's http status code.

publishAppVersionResponse_appArn :: Lens' PublishAppVersionResponse Text Source #

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

PutDraftAppVersionTemplate

putDraftAppVersionTemplate_appArn :: Lens' PutDraftAppVersionTemplate Text Source #

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

putDraftAppVersionTemplate_appTemplateBody :: Lens' PutDraftAppVersionTemplate Text Source #

A JSON string that contains the body of the app template.

putDraftAppVersionTemplateResponse_appArn :: Lens' PutDraftAppVersionTemplateResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

putDraftAppVersionTemplateResponse_appVersion :: Lens' PutDraftAppVersionTemplateResponse (Maybe Text) Source #

The version of the application.

putDraftAppVersionTemplateResponse_httpStatus :: Lens' PutDraftAppVersionTemplateResponse Int Source #

The response's http status code.

RemoveDraftAppVersionResourceMappings

removeDraftAppVersionResourceMappings_appRegistryAppNames :: Lens' RemoveDraftAppVersionResourceMappings (Maybe [Text]) Source #

The names of the registered applications to remove from the resource mappings.

removeDraftAppVersionResourceMappings_logicalStackNames :: Lens' RemoveDraftAppVersionResourceMappings (Maybe [Text]) Source #

The names of the CloudFormation stacks to remove from the resource mappings.

removeDraftAppVersionResourceMappings_resourceGroupNames :: Lens' RemoveDraftAppVersionResourceMappings (Maybe [Text]) Source #

The names of the resource groups to remove from the resource mappings.

removeDraftAppVersionResourceMappings_resourceNames :: Lens' RemoveDraftAppVersionResourceMappings (Maybe [Text]) Source #

The names of the resources to remove from the resource mappings.

removeDraftAppVersionResourceMappings_terraformSourceNames :: Lens' RemoveDraftAppVersionResourceMappings (Maybe [Text]) Source #

</p>

removeDraftAppVersionResourceMappings_appArn :: Lens' RemoveDraftAppVersionResourceMappings Text Source #

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

removeDraftAppVersionResourceMappingsResponse_appArn :: Lens' RemoveDraftAppVersionResourceMappingsResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

removeDraftAppVersionResourceMappingsResponse_appVersion :: Lens' RemoveDraftAppVersionResourceMappingsResponse (Maybe Text) Source #

The version of the application.

removeDraftAppVersionResourceMappingsResponse_httpStatus :: Lens' RemoveDraftAppVersionResourceMappingsResponse Int Source #

The response's http status code.

ResolveAppVersionResources

resolveAppVersionResources_appArn :: Lens' ResolveAppVersionResources Text Source #

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

resolveAppVersionResources_appVersion :: Lens' ResolveAppVersionResources Text Source #

The version of the application.

resolveAppVersionResourcesResponse_httpStatus :: Lens' ResolveAppVersionResourcesResponse Int Source #

The response's http status code.

resolveAppVersionResourcesResponse_appArn :: Lens' ResolveAppVersionResourcesResponse Text Source #

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

resolveAppVersionResourcesResponse_appVersion :: Lens' ResolveAppVersionResourcesResponse Text Source #

The version of the application.

resolveAppVersionResourcesResponse_resolutionId :: Lens' ResolveAppVersionResourcesResponse Text Source #

The identifier for a specific resolution.

resolveAppVersionResourcesResponse_status :: Lens' ResolveAppVersionResourcesResponse ResourceResolutionStatusType Source #

The status of the action.

StartAppAssessment

startAppAssessment_clientToken :: Lens' StartAppAssessment (Maybe Text) Source #

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.

startAppAssessment_tags :: Lens' StartAppAssessment (Maybe (HashMap Text Text)) Source #

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.

startAppAssessment_appArn :: Lens' StartAppAssessment Text Source #

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

startAppAssessment_appVersion :: Lens' StartAppAssessment Text Source #

The version of the application.

startAppAssessment_assessmentName :: Lens' StartAppAssessment Text Source #

The name for the assessment.

startAppAssessmentResponse_httpStatus :: Lens' StartAppAssessmentResponse Int Source #

The response's http status code.

startAppAssessmentResponse_assessment :: Lens' StartAppAssessmentResponse AppAssessment Source #

The assessment created.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The Amazon Resource Name (ARN) of the resource.

tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #

The tags to assign to the resource. Each tag consists of a key/value pair.

tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int Source #

The response's http status code.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

The Amazon Resource Name (ARN) of the resource.

untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text) Source #

The keys of the tags to remove.

untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int Source #

The response's http status code.

UpdateApp

updateApp_assessmentSchedule :: Lens' UpdateApp (Maybe AppAssessmentScheduleType) Source #

Assessment execution schedule with 'Daily' or 'Disabled' values.

updateApp_clearResiliencyPolicyArn :: Lens' UpdateApp (Maybe Bool) Source #

Specifies if the resiliency policy ARN should be cleared.

updateApp_description :: Lens' UpdateApp (Maybe Text) Source #

The optional description for an app.

updateApp_policyArn :: Lens' UpdateApp (Maybe Text) Source #

The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

updateApp_appArn :: Lens' UpdateApp Text Source #

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

updateAppResponse_httpStatus :: Lens' UpdateAppResponse Int Source #

The response's http status code.

updateAppResponse_app :: Lens' UpdateAppResponse App Source #

The specified application, returned as an object with details including compliance status, creation time, description, resiliency score, and more.

UpdateResiliencyPolicy

updateResiliencyPolicy_dataLocationConstraint :: Lens' UpdateResiliencyPolicy (Maybe DataLocationConstraint) Source #

Specifies a high-level geographical location constraint for where your resilience policy data can be stored.

updateResiliencyPolicy_policy :: Lens' UpdateResiliencyPolicy (Maybe (HashMap DisruptionType FailurePolicy)) Source #

The type of resiliency policy to be created, including the recovery time objective (RTO) and recovery point objective (RPO) in seconds.

updateResiliencyPolicy_policyDescription :: Lens' UpdateResiliencyPolicy (Maybe Text) Source #

The description for the policy.

updateResiliencyPolicy_policyName :: Lens' UpdateResiliencyPolicy (Maybe Text) Source #

The name of the policy

updateResiliencyPolicy_tier :: Lens' UpdateResiliencyPolicy (Maybe ResiliencyPolicyTier) Source #

The tier for this resiliency policy, ranging from the highest severity (MissionCritical) to lowest (NonCritical).

updateResiliencyPolicy_policyArn :: Lens' UpdateResiliencyPolicy Text Source #

The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

updateResiliencyPolicyResponse_httpStatus :: Lens' UpdateResiliencyPolicyResponse Int Source #

The response's http status code.

updateResiliencyPolicyResponse_policy :: Lens' UpdateResiliencyPolicyResponse ResiliencyPolicy Source #

The type of resiliency policy that was updated, including the recovery time objective (RTO) and recovery point objective (RPO) in seconds.

Types

AlarmRecommendation

alarmRecommendation_appComponentName :: Lens' AlarmRecommendation (Maybe Text) Source #

The application component for the CloudWatch alarm recommendation.

alarmRecommendation_description :: Lens' AlarmRecommendation (Maybe Text) Source #

The description of the recommendation.

alarmRecommendation_items :: Lens' AlarmRecommendation (Maybe [RecommendationItem]) Source #

The list of CloudWatch alarm recommendations.

alarmRecommendation_prerequisite :: Lens' AlarmRecommendation (Maybe Text) Source #

The prerequisite for the alarm recommendation.

alarmRecommendation_name :: Lens' AlarmRecommendation Text Source #

The name of the alarm recommendation.

alarmRecommendation_recommendationId :: Lens' AlarmRecommendation Text Source #

The identifier of the alarm recommendation.

alarmRecommendation_referenceId :: Lens' AlarmRecommendation Text Source #

The reference identifier of the alarm recommendation.

alarmRecommendation_type :: Lens' AlarmRecommendation AlarmType Source #

The type of alarm recommendation.

App

app_assessmentSchedule :: Lens' App (Maybe AppAssessmentScheduleType) Source #

Assessment execution schedule with 'Daily' or 'Disabled' values.

app_complianceStatus :: Lens' App (Maybe AppComplianceStatusType) Source #

The current status of compliance for the resiliency policy.

app_description :: Lens' App (Maybe Text) Source #

The optional description for an app.

app_lastAppComplianceEvaluationTime :: Lens' App (Maybe UTCTime) Source #

The timestamp for the most recent compliance evaluation.

app_lastResiliencyScoreEvaluationTime :: Lens' App (Maybe UTCTime) Source #

The timestamp for the most recent resiliency score evaluation.

app_policyArn :: Lens' App (Maybe Text) Source #

The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

app_resiliencyScore :: Lens' App (Maybe Double) Source #

The current resiliency score for the application.

app_status :: Lens' App (Maybe AppStatusType) Source #

The status of the application.

app_tags :: Lens' App (Maybe (HashMap Text Text)) Source #

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.

app_appArn :: Lens' App Text Source #

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

app_creationTime :: Lens' App UTCTime Source #

The timestamp for when the app was created.

app_name :: Lens' App Text Source #

The name for the application.

AppAssessment

appAssessment_appArn :: Lens' AppAssessment (Maybe Text) Source #

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

appAssessment_appVersion :: Lens' AppAssessment (Maybe Text) Source #

The version of the application.

appAssessment_assessmentName :: Lens' AppAssessment (Maybe Text) Source #

The name of the assessment.

appAssessment_compliance :: Lens' AppAssessment (Maybe (HashMap DisruptionType DisruptionCompliance)) Source #

The application compliance against the resiliency policy.

appAssessment_complianceStatus :: Lens' AppAssessment (Maybe ComplianceStatus) Source #

The current status of the compliance for the resiliency policy.

appAssessment_cost :: Lens' AppAssessment (Maybe Cost) Source #

The cost for the application.

appAssessment_endTime :: Lens' AppAssessment (Maybe UTCTime) Source #

The end time for the action.

appAssessment_message :: Lens' AppAssessment (Maybe Text) Source #

Error or warning message from the assessment execution

appAssessment_policy :: Lens' AppAssessment (Maybe ResiliencyPolicy) Source #

The resiliency policy.

appAssessment_resiliencyScore :: Lens' AppAssessment (Maybe ResiliencyScore) Source #

The current resiliency score for the application.

appAssessment_resourceErrorsDetails :: Lens' AppAssessment (Maybe ResourceErrorsDetails) Source #

A resource error object containing a list of errors retrieving an application's resources.

appAssessment_startTime :: Lens' AppAssessment (Maybe UTCTime) Source #

The starting time for the action.

appAssessment_tags :: Lens' AppAssessment (Maybe (HashMap Text Text)) Source #

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.

appAssessment_assessmentArn :: Lens' AppAssessment Text Source #

The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

appAssessment_assessmentStatus :: Lens' AppAssessment AssessmentStatus Source #

The current status of the assessment for the resiliency policy.

appAssessment_invoker :: Lens' AppAssessment AssessmentInvoker Source #

The entity that invoked the assessment.

AppAssessmentSummary

appAssessmentSummary_appArn :: Lens' AppAssessmentSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

appAssessmentSummary_appVersion :: Lens' AppAssessmentSummary (Maybe Text) Source #

The version of the application.

appAssessmentSummary_assessmentName :: Lens' AppAssessmentSummary (Maybe Text) Source #

The name of the assessment.

appAssessmentSummary_complianceStatus :: Lens' AppAssessmentSummary (Maybe ComplianceStatus) Source #

The current status of compliance for the resiliency policy.

appAssessmentSummary_cost :: Lens' AppAssessmentSummary (Maybe Cost) Source #

The cost for the application.

appAssessmentSummary_endTime :: Lens' AppAssessmentSummary (Maybe UTCTime) Source #

The end time for the action.

appAssessmentSummary_invoker :: Lens' AppAssessmentSummary (Maybe AssessmentInvoker) Source #

The entity that invoked the assessment.

appAssessmentSummary_message :: Lens' AppAssessmentSummary (Maybe Text) Source #

The message from the assessment run.

appAssessmentSummary_resiliencyScore :: Lens' AppAssessmentSummary (Maybe Double) Source #

The current resiliency score for the application.

appAssessmentSummary_startTime :: Lens' AppAssessmentSummary (Maybe UTCTime) Source #

The starting time for the action.

appAssessmentSummary_assessmentArn :: Lens' AppAssessmentSummary Text Source #

The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

appAssessmentSummary_assessmentStatus :: Lens' AppAssessmentSummary AssessmentStatus Source #

The current status of the assessment for the resiliency policy.

AppComponent

appComponent_name :: Lens' AppComponent Text Source #

The name of the application component.

appComponent_type :: Lens' AppComponent Text Source #

The type of application component.

AppComponentCompliance

appComponentCompliance_appComponentName :: Lens' AppComponentCompliance (Maybe Text) Source #

The name of the application component.

appComponentCompliance_compliance :: Lens' AppComponentCompliance (Maybe (HashMap DisruptionType DisruptionCompliance)) Source #

The compliance of the application component against the resiliency policy.

appComponentCompliance_cost :: Lens' AppComponentCompliance (Maybe Cost) Source #

The cost for the application.

appComponentCompliance_message :: Lens' AppComponentCompliance (Maybe Text) Source #

The compliance message.

appComponentCompliance_resiliencyScore :: Lens' AppComponentCompliance (Maybe ResiliencyScore) Source #

The current resiliency score for the application.

appComponentCompliance_status :: Lens' AppComponentCompliance (Maybe ComplianceStatus) Source #

The status of the action.

AppSummary

appSummary_assessmentSchedule :: Lens' AppSummary (Maybe AppAssessmentScheduleType) Source #

Assessment execution schedule with 'Daily' or 'Disabled' values.

appSummary_complianceStatus :: Lens' AppSummary (Maybe AppComplianceStatusType) Source #

The current status of compliance for the resiliency policy.

appSummary_description :: Lens' AppSummary (Maybe Text) Source #

The optional description for an app.

appSummary_resiliencyScore :: Lens' AppSummary (Maybe Double) Source #

The current resiliency score for the application.

appSummary_status :: Lens' AppSummary (Maybe AppStatusType) Source #

The status of the application.

appSummary_appArn :: Lens' AppSummary Text Source #

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

appSummary_creationTime :: Lens' AppSummary UTCTime Source #

The timestamp for when the app was created.

appSummary_name :: Lens' AppSummary Text Source #

The name of the application.

AppVersionSummary

appVersionSummary_appVersion :: Lens' AppVersionSummary Text Source #

The version of the application.

ComponentRecommendation

componentRecommendation_appComponentName :: Lens' ComponentRecommendation Text Source #

The name of the application component.

componentRecommendation_configRecommendations :: Lens' ComponentRecommendation [ConfigRecommendation] Source #

The list of recommendations.

componentRecommendation_recommendationStatus :: Lens' ComponentRecommendation RecommendationComplianceStatus Source #

The recommendation status.

ConfigRecommendation

configRecommendation_appComponentName :: Lens' ConfigRecommendation (Maybe Text) Source #

The application component name.

configRecommendation_compliance :: Lens' ConfigRecommendation (Maybe (HashMap DisruptionType DisruptionCompliance)) Source #

The current compliance against the resiliency policy before applying the configuration change.

configRecommendation_cost :: Lens' ConfigRecommendation (Maybe Cost) Source #

The cost for the application.

configRecommendation_description :: Lens' ConfigRecommendation (Maybe Text) Source #

The optional description for an app.

configRecommendation_haArchitecture :: Lens' ConfigRecommendation (Maybe HaArchitecture) Source #

The architecture type.

configRecommendation_recommendationCompliance :: Lens' ConfigRecommendation (Maybe (HashMap DisruptionType RecommendationDisruptionCompliance)) Source #

The expected compliance against the resiliency policy after applying the configuration change.

configRecommendation_suggestedChanges :: Lens' ConfigRecommendation (Maybe [Text]) Source #

List of the suggested configuration changes.

configRecommendation_name :: Lens' ConfigRecommendation Text Source #

The name of the recommendation configuration.

configRecommendation_optimizationType :: Lens' ConfigRecommendation ConfigRecommendationOptimizationType Source #

The type of optimization.

configRecommendation_referenceId :: Lens' ConfigRecommendation Text Source #

The reference identifier for the recommendation configuration.

Cost

cost_amount :: Lens' Cost Double Source #

The cost amount.

cost_currency :: Lens' Cost Text Source #

The cost currency, for example USD.

cost_frequency :: Lens' Cost CostFrequency Source #

The cost frequency.

DisruptionCompliance

disruptionCompliance_achievableRpoInSecs :: Lens' DisruptionCompliance (Maybe Natural) Source #

The Recovery Point Objective (RPO) that is achievable, in seconds.

disruptionCompliance_achievableRtoInSecs :: Lens' DisruptionCompliance (Maybe Natural) Source #

The Recovery Time Objective (RTO) that is achievable, in seconds

disruptionCompliance_currentRpoInSecs :: Lens' DisruptionCompliance (Maybe Natural) Source #

The current RPO, in seconds.

disruptionCompliance_currentRtoInSecs :: Lens' DisruptionCompliance (Maybe Natural) Source #

The current RTO, in seconds.

disruptionCompliance_message :: Lens' DisruptionCompliance (Maybe Text) Source #

The disruption compliance message.

disruptionCompliance_rpoDescription :: Lens' DisruptionCompliance (Maybe Text) Source #

The RPO description.

disruptionCompliance_rpoReferenceId :: Lens' DisruptionCompliance (Maybe Text) Source #

The RPO reference identifier.

disruptionCompliance_rtoDescription :: Lens' DisruptionCompliance (Maybe Text) Source #

The RTO description.

disruptionCompliance_rtoReferenceId :: Lens' DisruptionCompliance (Maybe Text) Source #

The RTO reference identifier.

disruptionCompliance_complianceStatus :: Lens' DisruptionCompliance ComplianceStatus Source #

The current status of compliance for the resiliency policy.

FailurePolicy

failurePolicy_rpoInSecs :: Lens' FailurePolicy Natural Source #

The Recovery Point Objective (RPO), in seconds.

failurePolicy_rtoInSecs :: Lens' FailurePolicy Natural Source #

The Recovery Time Objective (RTO), in seconds.

LogicalResourceId

logicalResourceId_logicalStackName :: Lens' LogicalResourceId (Maybe Text) Source #

The name of the CloudFormation stack this resource belongs to.

logicalResourceId_resourceGroupName :: Lens' LogicalResourceId (Maybe Text) Source #

The name of the resource group that this resource belongs to.

logicalResourceId_terraformSourceName :: Lens' LogicalResourceId (Maybe Text) Source #

The name of the Terraform S3 state file this resource belongs to.

logicalResourceId_identifier :: Lens' LogicalResourceId Text Source #

The identifier of the resource.

PhysicalResource

physicalResource_appComponents :: Lens' PhysicalResource (Maybe [AppComponent]) Source #

The application components that belong to this resource.

physicalResource_resourceName :: Lens' PhysicalResource (Maybe Text) Source #

The name of the resource.

physicalResource_logicalResourceId :: Lens' PhysicalResource LogicalResourceId Source #

The logical identifier of the resource.

physicalResource_physicalResourceId :: Lens' PhysicalResource PhysicalResourceId Source #

The physical identifier of the resource.

physicalResource_resourceType :: Lens' PhysicalResource Text Source #

The type of resource.

PhysicalResourceId

physicalResourceId_awsAccountId :: Lens' PhysicalResourceId (Maybe Text) Source #

The Amazon Web Services account that owns the physical resource.

physicalResourceId_awsRegion :: Lens' PhysicalResourceId (Maybe Text) Source #

The Amazon Web Services Region that the physical resource is located in.

physicalResourceId_identifier :: Lens' PhysicalResourceId Text Source #

The identifier of the physical resource.

physicalResourceId_type :: Lens' PhysicalResourceId PhysicalIdentifierType Source #

Specifies the type of physical resource identifier.

Arn: The resource identifier is an Amazon Resource Name (ARN) .
Native: The resource identifier is a Resilience Hub-native identifier.

RecommendationDisruptionCompliance

recommendationDisruptionCompliance_expectedRpoDescription :: Lens' RecommendationDisruptionCompliance (Maybe Text) Source #

The expected Recovery Point Objective (RPO) description after applying the recommended configuration change.

recommendationDisruptionCompliance_expectedRpoInSecs :: Lens' RecommendationDisruptionCompliance (Maybe Natural) Source #

The expected RPO after applying the recommended configuration change.

recommendationDisruptionCompliance_expectedRtoDescription :: Lens' RecommendationDisruptionCompliance (Maybe Text) Source #

The expected Recovery Time Objective (RTO) description after applying the recommended configuration change.

recommendationDisruptionCompliance_expectedRtoInSecs :: Lens' RecommendationDisruptionCompliance (Maybe Natural) Source #

The expected RTO after applying the recommended configuration change.

recommendationDisruptionCompliance_expectedComplianceStatus :: Lens' RecommendationDisruptionCompliance ComplianceStatus Source #

The expected compliance status after applying the recommended configuration change.

RecommendationItem

recommendationItem_alreadyImplemented :: Lens' RecommendationItem (Maybe Bool) Source #

Specifies if the recommendation has already been implemented.

recommendationItem_resourceId :: Lens' RecommendationItem (Maybe Text) Source #

The resource identifier.

recommendationItem_targetAccountId :: Lens' RecommendationItem (Maybe Text) Source #

The target account identifier.

recommendationItem_targetRegion :: Lens' RecommendationItem (Maybe Text) Source #

The target region.

RecommendationTemplate

recommendationTemplate_appArn :: Lens' RecommendationTemplate (Maybe Text) Source #

The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

recommendationTemplate_endTime :: Lens' RecommendationTemplate (Maybe UTCTime) Source #

The end time for the action.

recommendationTemplate_message :: Lens' RecommendationTemplate (Maybe Text) Source #

The message for the recommendation template.

recommendationTemplate_needsReplacements :: Lens' RecommendationTemplate (Maybe Bool) Source #

Indicates if replacements are needed.

recommendationTemplate_recommendationIds :: Lens' RecommendationTemplate (Maybe (NonEmpty Text)) Source #

Identifiers for the recommendations used in the recommendation template.

recommendationTemplate_startTime :: Lens' RecommendationTemplate (Maybe UTCTime) Source #

The start time for the action.

recommendationTemplate_tags :: Lens' RecommendationTemplate (Maybe (HashMap Text Text)) Source #

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.

recommendationTemplate_templatesLocation :: Lens' RecommendationTemplate (Maybe S3Location) Source #

The file location of the template.

recommendationTemplate_assessmentArn :: Lens' RecommendationTemplate Text Source #

The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

recommendationTemplate_format :: Lens' RecommendationTemplate TemplateFormat Source #

The format of the recommendation template.

CfnJson: The template is CloudFormation JSON.
CfnYaml: The template is CloudFormation YAML.

recommendationTemplate_name :: Lens' RecommendationTemplate Text Source #

The name for the recommendation template.

recommendationTemplate_recommendationTemplateArn :: Lens' RecommendationTemplate Text Source #

The Amazon Resource Name (ARN) for the recommendation template.

recommendationTemplate_recommendationTypes :: Lens' RecommendationTemplate (NonEmpty RenderRecommendationType) Source #

An array of strings that specify the recommendation template type or types.

Alarm: The template is an AlarmRecommendation template.
Sop: The template is a SopRecommendation template.
Test: The template is a TestRecommendation template.

recommendationTemplate_status :: Lens' RecommendationTemplate RecommendationTemplateStatus Source #

The status of the action.

ResiliencyPolicy

resiliencyPolicy_creationTime :: Lens' ResiliencyPolicy (Maybe UTCTime) Source #

The timestamp for when the resiliency policy was created.

resiliencyPolicy_dataLocationConstraint :: Lens' ResiliencyPolicy (Maybe DataLocationConstraint) Source #

Specifies a high-level geographical location constraint for where your resilience policy data can be stored.

resiliencyPolicy_estimatedCostTier :: Lens' ResiliencyPolicy (Maybe EstimatedCostTier) Source #

Specifies the estimated cost tier of the resiliency policy.

resiliencyPolicy_policy :: Lens' ResiliencyPolicy (Maybe (HashMap DisruptionType FailurePolicy)) Source #

The resiliency policy.

resiliencyPolicy_policyArn :: Lens' ResiliencyPolicy (Maybe Text) Source #

The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

resiliencyPolicy_policyDescription :: Lens' ResiliencyPolicy (Maybe Text) Source #

The description for the policy.

resiliencyPolicy_policyName :: Lens' ResiliencyPolicy (Maybe Text) Source #

The name of the policy

resiliencyPolicy_tags :: Lens' ResiliencyPolicy (Maybe (HashMap Text Text)) Source #

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.

resiliencyPolicy_tier :: Lens' ResiliencyPolicy (Maybe ResiliencyPolicyTier) Source #

The tier for this resiliency policy, ranging from the highest severity (MissionCritical) to lowest (NonCritical).

ResiliencyScore

resiliencyScore_disruptionScore :: Lens' ResiliencyScore (HashMap DisruptionType Double) Source #

The disruption score for a valid key.

resiliencyScore_score :: Lens' ResiliencyScore Double Source #

The outage score for a valid key.

ResourceError

resourceError_logicalResourceId :: Lens' ResourceError (Maybe Text) Source #

This is the identifier of the resource.

resourceError_physicalResourceId :: Lens' ResourceError (Maybe Text) Source #

This is the identifier of the physical resource.

resourceError_reason :: Lens' ResourceError (Maybe Text) Source #

This is the error message.

ResourceErrorsDetails

resourceErrorsDetails_hasMoreErrors :: Lens' ResourceErrorsDetails (Maybe Bool) Source #

This indicates if there are more errors not listed in the resourceErrors list.

resourceErrorsDetails_resourceErrors :: Lens' ResourceErrorsDetails (Maybe [ResourceError]) Source #

A list of errors retrieving an application's resources.

ResourceMapping

resourceMapping_appRegistryAppName :: Lens' ResourceMapping (Maybe Text) Source #

The name of the application this resource is mapped to.

resourceMapping_logicalStackName :: Lens' ResourceMapping (Maybe Text) Source #

The name of the CloudFormation stack this resource is mapped to.

resourceMapping_resourceGroupName :: Lens' ResourceMapping (Maybe Text) Source #

The name of the resource group this resource is mapped to.

resourceMapping_resourceName :: Lens' ResourceMapping (Maybe Text) Source #

The name of the resource this resource is mapped to.

resourceMapping_terraformSourceName :: Lens' ResourceMapping (Maybe Text) Source #

The short name of the Terraform source.

resourceMapping_mappingType :: Lens' ResourceMapping ResourceMappingType Source #

Specifies the type of resource mapping.

AppRegistryApp: The resource is mapped to another application. The name of the application is contained in the appRegistryAppName property.
CfnStack: The resource is mapped to a CloudFormation stack. The name of the CloudFormation stack is contained in the logicalStackName property.
Resource: The resource is mapped to another resource. The name of the resource is contained in the resourceName property.
ResourceGroup: The resource is mapped to a resource group. The name of the resource group is contained in the resourceGroupName property.

resourceMapping_physicalResourceId :: Lens' ResourceMapping PhysicalResourceId Source #

The identifier of this resource.