URI HTTP methods Schemas Properties See also

GetReadinessCheckResourceStatus

URI

/readinesschecks/readinessCheckName/resource/resourceIdentifier/status

HTTP methods

GET

Operation ID: GetReadinessCheckResourceStatus

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

Path parameters
Name	Type	Required	Description
`readinessCheckName`	String	True	Name of a readiness check.
`resourceIdentifier`	String	True	The resource identifier, which is the Amazon Resource Name (ARN) or the identifier generated for the resource by Application Recovery Controller (for example, for a DNS target resource).

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

Path parameters
Name	Type	Required	Description
`readinessCheckName`	String	True	Name of a readiness check.
`resourceIdentifier`	String	True	The resource identifier, which is the Amazon Resource Name (ARN) or the identifier generated for the resource by Application Recovery Controller (for example, for a DNS target resource).

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

Schemas

Response bodies


{
  "nextToken": "string",
  "readiness": enum,
  "rules": [
    {
      "readiness": enum,
      "messages": [
        {
          "messageText": "string"
        }
      ],
      "lastCheckedTimestamp": "string",
      "ruleId": "string"
    }
  ]
}

Properties

GetReadinessCheckResourceStatusOutput

Result of a GetReadinessCheckResourceStatus operation.

Property	Type	Required	Description
`nextToken`	string	True	The token that identifies which batch of results you want to see.
`readiness`	Readiness	True	The readiness at a rule level.
`rules`	Array of type RuleResult	True	Details of the rule's results.

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

RuleResult

The result of a successful Rule request, with status for an individual rule.

Property	Type	Required	Description
`lastCheckedTimestamp`	string	True	The time the resource was last checked for readiness, in ISO-8601 format, UTC.
`messages`	Array of type Message	True	Details about the resource's readiness.
`readiness`	Readiness	True	The readiness at rule level.
`ruleId`	string	True	The identifier of the rule.