AssessmentSummary
Contains summary information about a failure mode assessment.
Contents
- assessmentId
-
The unique identifier of the assessment.
Type: String
Length Constraints: Fixed length of 36.
Pattern:
[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}Required: Yes
- serviceArn
-
ARN identifier.
Type: String
Length Constraints: Minimum length of 31.
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
- achievability
-
The achievability results from the assessment.
Type: Achievability object
Required: No
- assessmentCost
-
The cost of the assessment.
Type: AssessmentCost object
Required: No
- assessmentStatus
-
The current status of the assessment.
Type: String
Valid Values:
NOT_STARTED | PENDING | IN_PROGRESS | FAILED | SUCCESSRequired: No
- assessmentStep
-
The current step of the assessment process.
Type: String
Valid Values:
TOPOLOGY_ENHANCEMENT | SERVICE_FUNCTION_GENERATION | RESILIENCE_ASSESSMENTRequired: No
- billableAssessmentUnitCount
-
The number of billable assessment units consumed by the assessment.
Type: Integer
Required: No
- endedAt
-
The timestamp when the assessment ended.
Type: Timestamp
Required: No
- errorCode
-
The error code if the assessment failed.
Type: String
Valid Values:
INVALID_PERMISSIONS | CMK_ACCESS_DENIED | AGENT_ERROR | INTERNAL_ERROR | DESIGN_FILE_ACCESS_DENIEDRequired: No
- errorMessage
-
A message describing the error if the assessment failed.
Type: String
Required: No
- startedAt
-
The timestamp when the assessment started.
Type: Timestamp
Required: No
- totalFindings
-
The total number of findings generated by the assessment.
Type: Integer
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
