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

ListApps

Lists your AWS Resilience Hub applications.

Note

You can filter applications using only one filter at a time or without using any filter. If you try to filter applications using multiple filters, you will get the following error:

An error occurred (ValidationException) when calling the ListApps operation: Only one filter is supported for this operation.

Request Syntax


GET /list-apps?appArn=appArn&awsApplicationArn=awsApplicationArn&fromLastAssessmentTime=fromLastAssessmentTime&maxResults=maxResults&name=name&nextToken=nextToken&reverseOrder=reverseOrder&toLastAssessmentTime=toLastAssessmentTime 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}$

awsApplicationArn

Amazon Resource Name (ARN) of AWS Resource Groups group that is integrated with an AppRegistry application. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

fromLastAssessmentTime

Lower limit of the range that is used to filter applications based on their last assessment times.

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.

name

The name for the one of the listed applications.

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

nextToken

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

Pattern: ^\S{1,2000}$

reverseOrder

The application list is sorted based on the values of lastAppComplianceEvaluationTime field. By default, application list is sorted in ascending order. To sort the application list in descending order, set this field to True.

toLastAssessmentTime

Upper limit of the range that is used to filter the applications based on their last assessment times.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "appSummaries": [ 
      { 
         "appArn": "string",
         "assessmentSchedule": "string",
         "awsApplicationArn": "string",
         "complianceStatus": "string",
         "creationTime": number,
         "description": "string",
         "driftStatus": "string",
         "lastAppComplianceEvaluationTime": number,
         "name": "string",
         "resiliencyScore": number,
         "rpoInSecs": number,
         "rtoInSecs": number,
         "status": "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.

appSummaries

Summaries for the AWS Resilience Hub application.

Type: Array of AppSummary 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

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