Route53RecoveryReadiness / Paginator / ListRules

ListRules

class Route53RecoveryReadiness.Paginator.ListRules

paginator = client.get_paginator('list_rules')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ResourceType='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• ResourceType (string) – The resource type that a readiness rule applies to.

• 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

{
    'Rules': [
        {
            'ResourceType': 'string',
            'RuleDescription': 'string',
            'RuleId': 'string'
        },
    ]
}

Response Structure

• (dict) –

  200 response - Success.

  • Rules (list) –

    A list of readiness rules for a specific resource type.

    • (dict) –

      Readiness rule information, including the resource type, rule ID, and rule description.

      • ResourceType (string) –

        The resource type that the readiness rule applies to.

      • RuleDescription (string) –

        The description of a readiness rule.

      • RuleId (string) –

        The ID for the readiness rule.