URI HTTP methods Schemas Properties See also

GetReadinessCheckStatus

URI

/readinesschecks/readinessCheckName/status

HTTP methods

GET

Operation ID: GetReadinessCheckStatus

Gets the readiness status for an individual readiness check. To see the overall readiness status for a recovery group, that considers the readiness status for all the readiness checks in a recovery group, use GetRecoveryGroupReadinessSummary.

Path parameters
Name	Type	Required	Description
`readinessCheckName`	String	True	Name of a readiness check.

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`	`GetReadinessCheckStatusOutput`	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.
`404`	None	404 response - Malformed query string. The query string contains a syntax error or resource not found.
`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.

Path parameters
Name	Type	Required	Description
`readinessCheckName`	String	True	Name of a readiness check.

Responses
Status code	Response model	Description
`200`	None	200 response - Success.

Schemas

Response bodies


{
  "nextToken": "string",
  "readiness": enum,
  "messages": [
    {
      "messageText": "string"
    }
  ],
  "resources": [
    {
      "componentId": "string",
      "readiness": enum,
      "resourceArn": "string",
      "lastCheckedTimestamp": "string"
    }
  ]
}

Properties

GetReadinessCheckStatusOutput

Result of a GetReadinessCheckStatus operation.

Property	Type	Required	Description
`messages`	Array of type Message	True	Top level messages for readiness check status
`nextToken`	string	True	The token that identifies which batch of results you want to see.
`readiness`	Readiness	True	The readiness at rule level.
`resources`	Array of type ResourceResult	True	Summary of the readiness of resources.

Message

Information relating to readiness check status.

Property	Type	Required	Description
`messageText`	string	False	The text of a readiness check message.

Readiness

The readiness status.

READY
NOT_READY
UNKNOWN
NOT_AUTHORIZED

ResourceResult

The result of a successful Resource request, with status for an individual resource.

Property	Type	Required	Description
`componentId`	string	False	The component id of the resource.
`lastCheckedTimestamp`	string	True	The time (UTC) that the resource was last checked for readiness, in ISO-8601 format.
`readiness`	Readiness	True	The readiness of a resource.
`resourceArn`	string	False	The Amazon Resource Name (ARN) of the resource.