Route53RecoveryControlConfig / Client / describe_control_panel

describe_control_panel#

Route53RecoveryControlConfig.Client.describe_control_panel(**kwargs)#

Displays details about a control panel.

Request Syntax

response = client.describe_control_panel(
    ControlPanelArn='string'
)

Parameters:

ControlPanelArn (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'ControlPanel': {
        'ClusterArn': 'string',
        'ControlPanelArn': 'string',
        'DefaultControlPanel': True|False,
        'Name': 'string',
        'RoutingControlCount': 123,
        'Status': 'PENDING'|'DEPLOYED'|'PENDING_DELETION'
    }
}

Response Structure

(dict) –

200 response - Success.
- ControlPanel (dict) –
  
  Information about the control panel.
  - 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.

Exceptions

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