Type: Array of type string Required: True
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following:
ListCrossAccountAuthorizations
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateCrossAccountAuthorization
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
ListReadinessChecks, CreateReadinessCheck
URI
/readinesschecks
HTTP methods
HTTP methods
GET
Operation ID: ListReadinessChecks Lists the readiness checks for an account.
Query parameters
Name Type Required Description
nextToken String False The token that
identifies which batch of results you want to see.
maxResults String False The number of objects
that you want to return with this call.
Responses
Status code Response model Description
200 ListReadinessChecksResult (p. 59)200 response - Success.
400 None 400 response - Multiple causes.
For example, you might have a malformed query string, an input parameter might be out of range, or you used parameters together incorrectly.
403 None 403 response - Access denied
exception. You do not have sufficient access to perform this action.
429 None 429 response - Limit exceeded
exception or too many requests exception.
500 None 500 response - Internal service
error or temporary service error.
Retry the request.
POST
Operation ID: CreateReadinessCheck
Creates a readiness check in an account. A readiness check monitors a resource set in your application, such as a set of Amazon Aurora instances, that Application Recovery Controller is auditing recovery readiness for. The audits run once every minute on every resource that's associated with a readiness check.
Schemas
Responses
Status code Response model Description
200 ReadinessCheckOutput (p. 59)200 response - Success.
400 None 400 response - Multiple causes.
For example, you might have a malformed query string, an input parameter might be out of range, or you used parameters together incorrectly.
403 None 403 response - Access denied
exception. You do not have sufficient access to perform this action.
409 None 409 response - Conflict
exception. You might be using a predefined variable.
429 None 429 response - Limit exceeded
exception or too many requests exception.
500 None 500 response - Internal service
error or temporary service error.
Retry the request.
OPTIONS
Enables CORS by returning correct headers.
Responses
Status code Response model Description
200 None 200 response - Success.
Schemas
Request bodies
POST schema
{ "readinessCheckName": "string", "resourceSetName": "string", "tags": {
} }
Response bodies
Properties ListReadinessChecksResult schema
{
"nextToken": "string", "readinessChecks": [ {
"resourceSet": "string",
"readinessCheckName": "string", "readinessCheckArn": "string", "tags": {
} } ] }
ReadinessCheckOutput schema
{ "resourceSet": "string", "readinessCheckName": "string", "readinessCheckArn": "string", "tags": {
}}
Properties
ListReadinessChecksResult
The result of a successful ListReadinessChecks request.
nextToken
The token that identifies which batch of results you want to see.
Type: string Required: False
readinessChecks
A list of readiness checks associated with the account.
Type: Array of type ReadinessCheckOutput (p. 60) Required: False
ReadinessCheckCreateParameters
Parameters used to create or update a readiness check.
readinessCheckName
The name of the readiness check to create.
Type: string
Properties Required: True
resourceSetName
The name of the resource set to check.
Type: string Required: True
tags
Type: Tags (p. 60) Required: False
ReadinessCheckOutput
A readiness check.
resourceSet
Name of the resource set to be checked.
Type: string Required: True
Pattern: \A[a-zA-Z0-9_]+\z MaxLength: 64
readinessCheckName
Name of a readiness check.Type: string Required: False
Pattern: \A[a-zA-Z0-9_]+\z MaxLength: 64
readinessCheckArn
The Amazon Resource Name (ARN) associated with a readiness check.
Type: string Required: True MaxLength: 256
tags
Type: Tags (p. 60) Required: False
Tags
A collection of tags associated with a resource.
See also
key-value pairs
Type: string
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following:
ListReadinessChecks
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateReadinessCheck
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
ListRecoveryGroups, CreateRecoveryGroup
URI
/recoverygroups
HTTP methods
GET
Operation ID: ListRecoveryGroups
HTTP methods Lists the recovery groups in an account.
Query parameters
Name Type Required Description
nextToken String False The token that
identifies which batch of results you want to see.
maxResults String False The number of objects
that you want to return with this call.
Responses
Status code Response model Description
200 ListRecoveryGroupsResult (p. 63)200 response - Success.
400 None 400 response - Multiple causes.
For example, you might have a malformed query string, an input parameter might be out of range, or you used parameters together incorrectly.
403 None 403 response - Access denied
exception. You do not have sufficient access to perform this action.
429 None 429 response - Limit exceeded
exception or too many requests exception.
500 None 500 response - Internal service
error or temporary service error.
Retry the request.
POST
Operation ID: CreateRecoveryGroup
Creates a recovery group in an account. A recovery group corresponds to an application and includes a list of the cells that make up the application.
Responses
Status code Response model Description
200 RecoveryGroupOutput (p. 64)200 response - Success.
400 None 400 response - Multiple causes.
For example, you might have a malformed query string, an input parameter might be out of
Schemas
Status code Response model Description
range, or you used parameters together incorrectly.
403 None 403 response - Access denied
exception. You do not have sufficient access to perform this action.
409 None 409 response - Conflict
exception. You might be using a predefined variable.
429 None 429 response - Limit exceeded
exception or too many requests exception.
500 None 500 response - Internal service
error or temporary service error.
Retry the request.
OPTIONS
Enable CORS by returning correct headers
Responses
Status code Response model Description
200 None 200 response - Success.
Schemas
Request bodies
POST schema
{ "cells": [ "string"
], "recoveryGroupName": "string", "tags": {
}}
Response bodies
ListRecoveryGroupsResult schema
{
"nextToken": "string", "recoveryGroups": [
Properties {
"cells": [ "string"
],
"recoveryGroupName": "string", "recoveryGroupArn": "string", "tags": {
} } ]}
RecoveryGroupOutput schema
{ "cells": [ "string"
],
"recoveryGroupName": "string", "recoveryGroupArn": "string", "tags": {
}}
Properties
ListRecoveryGroupsResult
The result of a successful ListRecoveryGroups request.
nextToken
The token that identifies which batch of results you want to see.
Type: string Required: False