Route53RecoveryReadiness / Client / get_readiness_check_status

get_readiness_check_status#

Route53RecoveryReadiness.Client.get_readiness_check_status(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.get_readiness_check_status(
    MaxResults=123,
    NextToken='string',
    ReadinessCheckName='string'
)
Parameters:

  • MaxResults (integer) – The number of objects that you want to return with this call.

  • NextToken (string) – The token that identifies which batch of results you want to see.

  • ReadinessCheckName (string) –

    [REQUIRED]

    Name of a readiness check.

Return type:

dict

Returns:

Response Syntax

{
    'Messages': [
        {
            'MessageText': 'string'
        },
    ],
    'NextToken': 'string',
    'Readiness': 'READY'|'NOT_READY'|'UNKNOWN'|'NOT_AUTHORIZED',
    'Resources': [
        {
            'ComponentId': 'string',
            'LastCheckedTimestamp': datetime(2015, 1, 1),
            'Readiness': 'READY'|'NOT_READY'|'UNKNOWN'|'NOT_AUTHORIZED',
            'ResourceArn': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    200 response - Success.

    • Messages (list) –

      Top level messages for readiness check status

      • (dict) –

        Information relating to readiness check status.

        • MessageText (string) –

          The text of a readiness check message.

    • NextToken (string) –

      The token that identifies which batch of results you want to see.

    • Readiness (string) –

      The readiness at rule level.

    • Resources (list) –

      Summary of the readiness of resources.

      • (dict) –

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

        • ComponentId (string) –

          The component id of the resource.

        • LastCheckedTimestamp (datetime) –

          The time (UTC) that the resource was last checked for readiness, in ISO-8601 format.

        • Readiness (string) –

          The readiness of a resource.

        • ResourceArn (string) –

          The Amazon Resource Name (ARN) of the resource.

Exceptions