AppAssessment - AWS Resilience Hub

AppAssessment

Defines an application assessment.

Contents

appArn

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.

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}$

Required: No

appVersion

The version of the application.

Type: String

Pattern: ^\S{1,50}$

Required: No

assessmentArn

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.

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}$

Required: Yes

assessmentName

The name of the assessment.

Type: String

Pattern: ^[A-Za-z0-9][A-Za-z0-9_\-]{1,59}$

Required: No

assessmentStatus

The current status of the assessment for the resiliency policy.

Type: String

Valid Values: Pending | InProgress | Failed | Success

Required: Yes

compliance

The application compliance against the resiliency policy.

Type: String to DisruptionCompliance object map

Valid Keys: Software | Hardware | AZ | Region

Required: No

complianceStatus

The current status of the compliance for the resiliency policy.

Type: String

Valid Values: PolicyBreached | PolicyMet

Required: No

cost

The cost for the application.

Type: Cost object

Required: No

endTime

The end time for the action.

Type: Timestamp

Required: No

invoker

The entity that invoked the assessment.

Type: String

Valid Values: User | System

Required: Yes

message

Error or warning message from the assessment execution

Type: String

Length Constraints: Minimum length of 1. Maximum length of 500.

Required: No

policy

The resiliency policy.

Type: ResiliencyPolicy object

Required: No

resiliencyScore

The current resiliency score for the application.

Type: ResiliencyScore object

Required: No

resourceErrorsDetails

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

Type: ResourceErrorsDetails object

Required: No

startTime

The starting time for the action.

Type: Timestamp

Required: No

tags

The tags assigned to the resource. A tag is a label that you assign to an AWS resource. Each tag consists of a key/value pair.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(?!aws:)[^\x00-\x1f\x22]+$

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Value Pattern: ^[^\x00-\x1f\x22]*$

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: