# 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 a routing control state is set to ON, traffic flows to a cell. When the state is set to OFF, traffic does not flow. 

Before you can create a routing control, you must first create a cluster, and then host the control in a control panel on the cluster. For more information, see [ Create routing control structures](https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.create.html) in the Amazon Route 53 Application Recovery Controller Developer Guide. You access one of the endpoints for the cluster to get or update the routing control state to redirect traffic for your application. 

 *You must specify Regional endpoints when you work with API cluster operations to get or update routing control states in Route 53 ARC.* 

To see a code example for getting a routing control state, including accessing Regional cluster endpoints in sequence, see [API examples](https://docs.aws.amazon.com/r53recovery/latest/dg/service_code_examples_actions.html) in the Amazon Route 53 Application Recovery Controller Developer Guide.

Learn more about working with routing controls in the following topics in the Amazon Route 53 Application Recovery Controller Developer Guide:
+  [ Viewing and updating routing control states](https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.html) 
+  [Working with routing controls in Route 53 ARC](https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html) 

## Request Syntax


```
{
   "RoutingControlArn": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [RoutingControlArn](#API_GetRoutingControlState_RequestSyntax) **   <a name="r53recovery-GetRoutingControlState-request-RoutingControlArn"></a>
The Amazon Resource Name (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",
   "RoutingControlName": "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](#API_GetRoutingControlState_ResponseSyntax) **   <a name="r53recovery-GetRoutingControlState-response-RoutingControlArn"></a>
The Amazon Resource Name (ARN) of the response.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[A-Za-z0-9:.\/_-]*$` 

 ** [RoutingControlName](#API_GetRoutingControlState_ResponseSyntax) **   <a name="r53recovery-GetRoutingControlState-response-RoutingControlName"></a>
The routing control name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^\S+$` 

 ** [RoutingControlState](#API_GetRoutingControlState_ResponseSyntax) **   <a name="r53recovery-GetRoutingControlState-response-RoutingControlState"></a>
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 Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient permissions to perform this action.  
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 or control panel 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:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/route53-recovery-cluster-2019-12-02/GetRoutingControlState) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/route53-recovery-cluster-2019-12-02/GetRoutingControlState) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/route53-recovery-cluster-2019-12-02/GetRoutingControlState) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/route53-recovery-cluster-2019-12-02/GetRoutingControlState) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/route53-recovery-cluster-2019-12-02/GetRoutingControlState) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/route53-recovery-cluster-2019-12-02/GetRoutingControlState) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/route53-recovery-cluster-2019-12-02/GetRoutingControlState) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/route53-recovery-cluster-2019-12-02/GetRoutingControlState) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/route53-recovery-cluster-2019-12-02/GetRoutingControlState) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/route53-recovery-cluster-2019-12-02/GetRoutingControlState)