Route53RecoveryControlConfig / Client / describe_routing_control

describe_routing_control#

Route53RecoveryControlConfig.Client.describe_routing_control(**kwargs)#

Displays details about a routing control. 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 routing.

To get or update the routing control state, see the Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recovery Controller.

See also: AWS API Documentation

Request Syntax

response = client.describe_routing_control(
    RoutingControlArn='string'
)

Parameters:

RoutingControlArn (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'RoutingControl': {
        'ControlPanelArn': 'string',
        'Name': 'string',
        'RoutingControlArn': 'string',
        'Status': 'PENDING'|'DEPLOYED'|'PENDING_DELETION'
    }
}

Response Structure

(dict) –

200 response - Success.
- RoutingControl (dict) –
  
  Information about the routing control.
  - 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.ValidationException
Route53RecoveryControlConfig.Client.exceptions.InternalServerException
Route53RecoveryControlConfig.Client.exceptions.AccessDeniedException
Route53RecoveryControlConfig.Client.exceptions.ResourceNotFoundException
Route53RecoveryControlConfig.Client.exceptions.ThrottlingException
Route53RecoveryControlConfig.Client.exceptions.ConflictException