Route53RecoveryCluster / Paginator / ListRoutingControls

ListRoutingControls#

class Route53RecoveryCluster.Paginator.ListRoutingControls#
paginator = client.get_paginator('list_routing_controls')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from Route53RecoveryCluster.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) – The Amazon Resource Name (ARN) of the control panel of the routing controls to list.

  • 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',
            'ControlPanelName': 'string',
            'RoutingControlArn': 'string',
            'RoutingControlName': 'string',
            'RoutingControlState': 'On'|'Off',
            'Owner': 'string'
        },
    ],

}

Response Structure

  • (dict) –

    • RoutingControls (list) –

      The list of routing controls.

      • (dict) –

        A routing control, which is a simple on/off switch that you can use to route traffic to cells. When a routing control state is set to ON, traffic flows to a cell. When the state is set to OFF, traffic does not flow.

        • ControlPanelArn (string) –

          The Amazon Resource Name (ARN) of the control panel where the routing control is located.

        • ControlPanelName (string) –

          The name of the control panel where the routing control is located. Only ASCII characters are supported for control panel names.

        • RoutingControlArn (string) –

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

        • RoutingControlName (string) –

          The name of the routing control.

        • RoutingControlState (string) –

          The current state of the routing control. When a routing control state is set to ON, traffic flows to a cell. When the state is set to OFF, traffic does not flow.

        • Owner (string) –

          The Amazon Web Services account ID of the routing control owner.