ListResiliencyPolicies
Lists the resiliency policies for the AWS Resilience Hub applications.
Request Syntax
GET /list-resiliency-policies?maxResults=maxResults
&nextToken=nextToken
&policyName=policyName
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- 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}$
- policyName
-
Name of the resiliency policy.
Pattern:
^[A-Za-z0-9][A-Za-z0-9_\-]{1,59}$
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"nextToken": "string",
"resiliencyPolicies": [
{
"creationTime": number,
"dataLocationConstraint": "string",
"estimatedCostTier": "string",
"policy": {
"string" : {
"rpoInSecs": number,
"rtoInSecs": number
}
},
"policyArn": "string",
"policyDescription": "string",
"policyName": "string",
"tags": {
"string" : "string"
},
"tier": "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.
- nextToken
-
Token for the next set of results, or null if there are no more results.
Type: String
Pattern:
^\S{1,2000}$
- resiliencyPolicies
-
The resiliency policies for the AWS Resilience Hub applications.
Type: Array of ResiliencyPolicy objects
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: