GetRoutingControlState - Routing Control API Reference Guide

GetRoutingControlState

Get the state for a routing control. A routing control is a simple on/off switch that you can use to route traffic to cells. When the state is On, traffic flows to a cell. When it's Off, traffic does not flow.

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

You must specify Regional endpoints when you work with API cluster operations to get or update routing control states in Application Recovery Controller.

Learn more about Viewing and updating routing control states, or learn more about Working with routing controls overall in the Amazon Route 53 Application Recovery Controller Developer Guide.

To see a code example for getting a routing control state, including accessing Regional cluster endpoints in sequence, see API examples in the Amazon Route 53 Application Recovery Controller Developer Guide.

Request Syntax

{ "RoutingControlArn": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

RoutingControlArn

The Amazon Resource Number (ARN) for the routing control that you want to get the state for.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^[A-Za-z0-9:\/_-]*$

Required: Yes

Response Syntax

{ "RoutingControlArn": "string", "RoutingControlState": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

RoutingControlArn

The Amazon Resource Number (ARN) of the response.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^[A-Za-z0-9:\/_-]*$

RoutingControlState

The state of the routing control.

Type: String

Valid Values: On | Off

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have sufficient permissions to query the routing control state.

HTTP Status Code: 400

EndpointTemporarilyUnavailableException

The cluster endpoint isn't available. Try another cluster endpoint.

HTTP Status Code: 400

InternalServerException

There was an unexpected error during processing of the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a routing control that was not found.

HTTP Status Code: 400

ThrottlingException

The request was denied because of request throttling.

HTTP Status Code: 400

ValidationException

There was a validation error on the request.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: