ARCRegionswitch / Paginator / ListRoute53HealthChecks

ListRoute53HealthChecks

class ARCRegionswitch.Paginator.ListRoute53HealthChecks

paginator = client.get_paginator('list_route53_health_checks')

paginate(**kwargs)

Creates an iterator that will paginate through responses from ARCRegionswitch.Client.list_route53_health_checks().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• arn (string) –

  [REQUIRED]

  The Amazon Resource Name (ARN) of the Amazon Route 53 health check request.

• hostedZoneId (string) – The hosted zone ID for the health checks.

• recordName (string) – The record name for the health checks.

• 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

{
    'healthChecks': [
        {
            'hostedZoneId': 'string',
            'recordName': 'string',
            'healthCheckId': 'string',
            'region': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • healthChecks (list) –

    List of the health checks requested.

    • (dict) –

      The Amazon Route 53 health check.

      • hostedZoneId (string) –

        The Amazon Route 53 health check hosted zone ID.

      • recordName (string) –

        The Amazon Route 53 record name.

      • healthCheckId (string) –

        The Amazon Route 53 health check ID.

      • region (string) –

        The Amazon Route 53 Region.

  • NextToken (string) –

    A token to resume pagination.