GetReadinessCheckStatus

class Route53RecoveryReadiness.Paginator.GetReadinessCheckStatus
paginator = client.get_paginator('get_readiness_check_status')
paginate(**kwargs)

Creates an iterator that will paginate through responses from Route53RecoveryReadiness.Client.get_readiness_check_status().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ReadinessCheckName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • ReadinessCheckName (string) --

    [REQUIRED]

    Name of a readiness check.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Messages': [
        {
            'MessageText': '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.

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