Route53RecoveryControlConfig / Client / list_routing_controls

list_routing_controls#

Route53RecoveryControlConfig.Client.list_routing_controls(**kwargs)#

Returns an array of routing controls for a control panel. A routing control is an Amazon Route 53 Application Recovery Controller construct that 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 routing.

See also: AWS API Documentation

Request Syntax

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

  • ControlPanelArn (string) –

    [REQUIRED]

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

  • MaxResults (integer) – The number of objects that you want to return with this call.

  • NextToken (string) – The token that identifies which batch of results you want to see.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    200 response - Success.

    • NextToken (string) –

      The token that identifies which batch of results you want to see.

    • 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.

Exceptions

  • Route53RecoveryControlConfig.Client.exceptions.ResourceNotFoundException

  • Route53RecoveryControlConfig.Client.exceptions.ThrottlingException

  • Route53RecoveryControlConfig.Client.exceptions.ValidationException

  • Route53RecoveryControlConfig.Client.exceptions.InternalServerException

  • Route53RecoveryControlConfig.Client.exceptions.AccessDeniedException