AppAssessment
Defines an application assessment.
Contents
- assessmentArn
-
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 guide.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
- assessmentStatus
-
Current status of the assessment for the resiliency policy.
Type: String
Valid Values:
Pending | InProgress | Failed | SuccessRequired: Yes
- invoker
-
The entity that invoked the assessment.
Type: String
Valid Values:
User | SystemRequired: Yes
- appArn
-
Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn:
partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.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
-
Version of an application.
Type: String
Pattern:
^\S{1,50}$Required: No
- assessmentName
-
Name of the assessment.
Type: String
Pattern:
^[A-Za-z0-9][A-Za-z0-9_\-]{1,59}$Required: No
- compliance
-
Application compliance against the resiliency policy.
Type: String to DisruptionCompliance object map
Valid Keys:
Software | Hardware | AZ | RegionRequired: No
- complianceStatus
-
Current status of the compliance for the resiliency policy.
Type: String
Valid Values:
PolicyBreached | PolicyMet | NotApplicable | MissingPolicyRequired: No
- cost
-
Cost for the application.
Type: Cost object
Required: No
- driftStatus
-
Indicates if compliance drifts (deviations) were detected while running an assessment for your application.
Type: String
Valid Values:
NotChecked | NotDetected | DetectedRequired: No
- endTime
-
End time for the action.
Type: Timestamp
Required: No
- message
-
Error or warning message from the assessment execution
Type: String
Length Constraints: Minimum length of 1. Maximum length of 500.
Required: No
- policy
-
Resiliency policy of an application.
Type: ResiliencyPolicy object
Required: No
- resiliencyScore
-
Current resiliency score for an 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
-
Starting time for the action.
Type: Timestamp
Required: No
- summary
-
Indicates the AI-generated summary for the AWS Resilience Hub assessment, providing a concise overview that highlights the top risks and recommendations.
Note
This property is available only in the US East (N. Virginia) Region.
Type: AssessmentSummary object
Required: No
-
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:
^[^\x00-\x1f\x22]+$Value Length Constraints: Minimum length of 0. Maximum length of 256.
Value Pattern:
^[^\x00-\x1f\x22]*$Required: No
- versionName
-
Version name of the published application.
Type: String
Pattern:
^\S{1,50}$Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
