Route53RecoveryCluster / Client / list_routing_controls

list_routing_controls#

Route53RecoveryCluster.Client.list_routing_controls(**kwargs)#

List routing control names and Amazon Resource Names (ARNs), as well as the routing control state for each routing control, along with the control panel name and control panel ARN for the routing controls. If you specify a control panel ARN, this call lists the routing controls in the control panel. Otherwise, it lists all the routing controls in the cluster.

A routing control is a simple on/off switch in Route 53 ARC 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.

Before you can create a routing control, you must first create a cluster, and then host the control in a control panel on the cluster. For more information, see Create routing control structures in the Amazon Route 53 Application Recovery Controller Developer Guide. You access one of the endpoints for the cluster to get or update the routing control state to redirect traffic for your application.

You must specify Regional endpoints when you work with API cluster operations to use this API operation to list routing controls in Route 53 ARC.

Learn more about working with routing controls in the following topics in the Amazon Route 53 Application Recovery Controller Developer Guide:

See also: AWS API Documentation

Request Syntax

response = client.list_routing_controls(
    ControlPanelArn='string',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • ControlPanelArn (string) – The Amazon Resource Name (ARN) of the control panel of the routing controls to list.

  • NextToken (string) – The token for the next set of results. You receive this token from a previous call.

  • MaxResults (integer) – The number of routing controls objects that you want to return with this call. The default value is 500.

Return type:

dict

Returns:

Response Syntax

{
    'RoutingControls': [
        {
            'ControlPanelArn': 'string',
            'ControlPanelName': 'string',
            'RoutingControlArn': 'string',
            'RoutingControlName': 'string',
            'RoutingControlState': 'On'|'Off',
            'Owner': 'string'
        },
    ],
    'NextToken': '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.

    • NextToken (string) –

      The token for the next set of results. You receive this token from a previous call.

Exceptions

  • Route53RecoveryCluster.Client.exceptions.AccessDeniedException

  • Route53RecoveryCluster.Client.exceptions.InternalServerException

  • Route53RecoveryCluster.Client.exceptions.ResourceNotFoundException

  • Route53RecoveryCluster.Client.exceptions.ValidationException

  • Route53RecoveryCluster.Client.exceptions.ThrottlingException

  • Route53RecoveryCluster.Client.exceptions.EndpointTemporarilyUnavailableException