URI HTTP methods Schemas Properties See also

ListReadinessChecks, CreateReadinessCheck

URI

/readinesschecks

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`	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.

Responses
Status code	Response model	Description
`200`	`ReadinessCheckOutput`	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


{
  "readinessCheckName": "string",
  "resourceSetName": "string",
  "tags": {
  }
}

Response bodies


{
  "nextToken": "string",
  "readinessChecks": [
    {
      "resourceSet": "string",
      "readinessCheckName": "string",
      "readinessCheckArn": "string",
      "tags": {
      }
    }
  ]
}


{
  "resourceSet": "string",
  "readinessCheckName": "string",
  "readinessCheckArn": "string",
  "tags": {
  }
}

Properties

ListReadinessChecksResult

The result of a successful ListReadinessChecks request.

Property	Type	Required	Description
`nextToken`	string	False	The token that identifies which batch of results you want to see.
`readinessChecks`	Array of type ReadinessCheckOutput	False	A list of readiness checks associated with the account.

ReadinessCheckCreateParameters

Parameters used to create or update a readiness check.

Property	Type	Required	Description
`readinessCheckName`	string	True	The name of the readiness check to create.
`resourceSetName`	string	True	The name of the resource set to check.
`tags`	Tags	False

ReadinessCheckOutput

A readiness check.

Property	Type	Required	Description
`readinessCheckArn`	string MaxLength: 256	True	The Amazon Resource Name (ARN) associated with a readiness check.
`readinessCheckName`	string Pattern: `\A[a-zA-Z0-9_]+\z` MaxLength: 64	False	Name of a readiness check.
`resourceSet`	string Pattern: `\A[a-zA-Z0-9_]+\z` MaxLength: 64	True	Name of the resource set to be checked.
`tags`	Tags	False