# AssessmentSummary
<a name="API_AssessmentSummary"></a>

Contains summary information about a failure mode assessment.

## Contents
<a name="API_AssessmentSummary_Contents"></a>

 ** assessmentId **   <a name="ngresiliencehub-Type-AssessmentSummary-assessmentId"></a>
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 **   <a name="ngresiliencehub-Type-AssessmentSummary-serviceArn"></a>
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 **   <a name="ngresiliencehub-Type-AssessmentSummary-achievability"></a>
The achievability results from the assessment.  
Type: [Achievability](API_Achievability.md) object  
Required: No

 ** assessmentCost **   <a name="ngresiliencehub-Type-AssessmentSummary-assessmentCost"></a>
The cost of the assessment.  
Type: [AssessmentCost](API_AssessmentCost.md) object  
Required: No

 ** assessmentStatus **   <a name="ngresiliencehub-Type-AssessmentSummary-assessmentStatus"></a>
The current status of the assessment.  
Type: String  
Valid Values: `NOT_STARTED | PENDING | IN_PROGRESS | FAILED | SUCCESS`   
Required: No

 ** assessmentStep **   <a name="ngresiliencehub-Type-AssessmentSummary-assessmentStep"></a>
The current step of the assessment process.  
Type: String  
Valid Values: `TOPOLOGY_ENHANCEMENT | SERVICE_FUNCTION_GENERATION | RESILIENCE_ASSESSMENT`   
Required: No

 ** billableAssessmentUnitCount **   <a name="ngresiliencehub-Type-AssessmentSummary-billableAssessmentUnitCount"></a>
The number of billable assessment units consumed by the assessment.  
Type: Integer  
Required: No

 ** endedAt **   <a name="ngresiliencehub-Type-AssessmentSummary-endedAt"></a>
The timestamp when the assessment ended.  
Type: Timestamp  
Required: No

 ** errorCode **   <a name="ngresiliencehub-Type-AssessmentSummary-errorCode"></a>
The error code if the assessment failed.  
Type: String  
Valid Values: `INVALID_PERMISSIONS | CMK_ACCESS_DENIED | AGENT_ERROR | INTERNAL_ERROR | DESIGN_FILE_ACCESS_DENIED`   
Required: No

 ** errorMessage **   <a name="ngresiliencehub-Type-AssessmentSummary-errorMessage"></a>
A message describing the error if the assessment failed.  
Type: String  
Required: No

 ** startedAt **   <a name="ngresiliencehub-Type-AssessmentSummary-startedAt"></a>
The timestamp when the assessment started.  
Type: Timestamp  
Required: No

 ** totalFindings **   <a name="ngresiliencehub-Type-AssessmentSummary-totalFindings"></a>
The total number of findings generated by the assessment.  
Type: Integer  
Required: No

## See Also
<a name="API_AssessmentSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/resiliencehubv2-2026-02-17/AssessmentSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/resiliencehubv2-2026-02-17/AssessmentSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/resiliencehubv2-2026-02-17/AssessmentSummary)