Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListAppAssessments

Lists the assessments for an AWS Resilience Hub application. You can use request parameters to refine the results for the response object.

Request Syntax


GET /list-app-assessments?appArn=appArn&assessmentName=assessmentName&assessmentStatus=assessmentStatus&complianceStatus=complianceStatus&invoker=invoker&maxResults=maxResults&nextToken=nextToken&reverseOrder=reverseOrder HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

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.

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

assessmentName

The name for the assessment.

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

assessmentStatus

The current status of the assessment for the resiliency policy.

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Valid Values: Pending | InProgress | Failed | Success

complianceStatus

The current status of compliance for the resiliency policy.

Valid Values: PolicyBreached | PolicyMet | NotApplicable | MissingPolicy

invoker

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

Valid Values: User | System

maxResults

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.

Valid Range: Minimum value of 1. Maximum value of 100.

nextToken

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

Pattern: ^\S{1,2000}$

reverseOrder

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

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "assessmentSummaries": [ 
      { 
         "appArn": "string",
         "appVersion": "string",
         "assessmentArn": "string",
         "assessmentName": "string",
         "assessmentStatus": "string",
         "complianceStatus": "string",
         "cost": { 
            "amount": number,
            "currency": "string",
            "frequency": "string"
         },
         "driftStatus": "string",
         "endTime": number,
         "invoker": "string",
         "message": "string",
         "resiliencyScore": number,
         "startTime": number,
         "versionName": "string"
      }
   ],
   "nextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

assessmentSummaries

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.

Type: Array of AppAssessmentSummary objects

nextToken

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

Type: String

Pattern: ^\S{1,2000}$

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.

HTTP Status Code: 403

InternalServerException

This exception occurs when there is an internal failure in the AWS Resilience Hub service.

HTTP Status Code: 500

ResourceNotFoundException

This exception occurs when the specified resource could not be found.

HTTP Status Code: 404

ThrottlingException

This exception occurs when you have exceeded the limit on the number of requests per second.

HTTP Status Code: 429

ValidationException

This exception occurs when a request is not valid.

HTTP Status Code: 400