Route53RecoveryControlConfig / Paginator / ListRoutingControls

ListRoutingControls

class Route53RecoveryControlConfig.Paginator.ListRoutingControls

paginator = client.get_paginator('list_routing_controls')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Route53RecoveryControlConfig.Client.list_routing_controls().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• ControlPanelArn (string) –

  [REQUIRED]

  The Amazon Resource Name (ARN) of the control panel.

• 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

{
    'RoutingControls': [
        {
            'ControlPanelArn': 'string',
            'Name': 'string',
            'RoutingControlArn': 'string',
            'Status': 'PENDING'|'DEPLOYED'|'PENDING_DELETION'
        },
    ]
}

Response Structure

• (dict) –

  200 response - Success.

  • RoutingControls (list) –

    An array of routing controls.

    • (dict) –

      A routing control has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control traffic routing.

      • ControlPanelArn (string) –

        The Amazon Resource Name (ARN) of the control panel that includes the routing control.

      • Name (string) –

        The name of the routing control.

      • RoutingControlArn (string) –

        The Amazon Resource Name (ARN) of the routing control.

      • Status (string) –

        The deployment status of a routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.