list_control_panels

list_control_panels(**kwargs)

Returns an array of control panels in an account or in a cluster.

See also: AWS API Documentation

Request Syntax

response = client.list_control_panels(
    ClusterArn='string',
    MaxResults=123,
    NextToken='string'
)

Parameters

• ClusterArn (string) -- The Amazon Resource Name (ARN) of a cluster.
• 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

{
    'ControlPanels': [
        {
            'ClusterArn': 'string',
            'ControlPanelArn': 'string',
            'DefaultControlPanel': True|False,
            'Name': 'string',
            'RoutingControlCount': 123,
            'Status': 'PENDING'|'DEPLOYED'|'PENDING_DELETION'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  200 response - Success.

  • ControlPanels (list) --

    The result of a successful ListControlPanel request.

    • (dict) --

      A control panel represents a group of routing controls that can be changed together in a single transaction.

      • ClusterArn (string) --

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

      • ControlPanelArn (string) --

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

      • DefaultControlPanel (boolean) --

        A flag that Amazon Route 53 Application Recovery Controller sets to true to designate the default control panel for a cluster. When you create a cluster, Amazon Route 53 Application Recovery Controller creates a control panel, and sets this flag for that control panel. If you create a control panel yourself, this flag is set to false.

      • Name (string) --

        The name of the control panel. You can use any non-white space character in the name.

      • RoutingControlCount (integer) --

        The number of routing controls in the control panel.

      • Status (string) --

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

  • NextToken (string) --

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

Exceptions

• Route53RecoveryControlConfig.Client.exceptions.ResourceNotFoundException
• Route53RecoveryControlConfig.Client.exceptions.ThrottlingException
• Route53RecoveryControlConfig.Client.exceptions.ValidationException
• Route53RecoveryControlConfig.Client.exceptions.InternalServerException
• Route53RecoveryControlConfig.Client.exceptions.AccessDeniedException