# Actions The following actions are supported: + [GetRoutingControlState](API_GetRoutingControlState.md) + [ListRoutingControls](API_ListRoutingControls.md) + [UpdateRoutingControlState](API_UpdateRoutingControlState.md) + [UpdateRoutingControlStates](API_UpdateRoutingControlStates.md) # 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) ** 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) ** 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) ** The routing control name. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^\S+$` ** [RoutingControlState](#API_GetRoutingControlState_ResponseSyntax) ** 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) # ListRoutingControls List routing control names and Amazon Resource Names (ARNs), as well as the routing control state for each routing control, along with the control panel name and control panel ARN for the routing controls. If you specify a control panel ARN, this call lists the routing controls in the control panel. Otherwise, it lists all the routing controls in the cluster. A routing control is a simple on/off switch in Route 53 ARC 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 use this API operation to list routing controls in Route 53 ARC.* 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 ``` { "ControlPanelArn": "string", "MaxResults": number, "NextToken": "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. ** [ControlPanelArn](#API_ListRoutingControls_RequestSyntax) ** The Amazon Resource Name (ARN) of the control panel of the routing controls to list. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[A-Za-z0-9:.\/_-]*$` Required: No ** [MaxResults](#API_ListRoutingControls_RequestSyntax) ** The number of routing controls objects that you want to return with this call. The default value is 500. Type: Integer Valid Range: Minimum value of 1. Required: No ** [NextToken](#API_ListRoutingControls_RequestSyntax) ** The token for the next set of results. You receive this token from a previous call. Type: String Length Constraints: Minimum length of 1. Maximum length of 8096. Pattern: `[\S]*` Required: No ## Response Syntax ``` { "NextToken": "string", "RoutingControls": [ { "ControlPanelArn": "string", "ControlPanelName": "string", "Owner": "string", "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. ** [NextToken](#API_ListRoutingControls_ResponseSyntax) ** The token for the next set of results. You receive this token from a previous call. Type: String Length Constraints: Minimum length of 1. Maximum length of 8096. Pattern: `[\S]*` ** [RoutingControls](#API_ListRoutingControls_ResponseSyntax) ** The list of routing controls. Type: Array of [RoutingControl](API_RoutingControl.md) objects ## 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/ListRoutingControls) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/route53-recovery-cluster-2019-12-02/ListRoutingControls) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/route53-recovery-cluster-2019-12-02/ListRoutingControls) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/route53-recovery-cluster-2019-12-02/ListRoutingControls) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/route53-recovery-cluster-2019-12-02/ListRoutingControls) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/route53-recovery-cluster-2019-12-02/ListRoutingControls) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/route53-recovery-cluster-2019-12-02/ListRoutingControls) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/route53-recovery-cluster-2019-12-02/ListRoutingControls) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/route53-recovery-cluster-2019-12-02/ListRoutingControls) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/route53-recovery-cluster-2019-12-02/ListRoutingControls) # UpdateRoutingControlState Set the state of the routing control to reroute traffic. You can set the value to ON or OFF. When the state is ON, traffic flows to a cell. When the state is OFF, traffic does not flow. With Route 53 ARC, you can add safety rules for routing controls, which are safeguards for routing control state updates that help prevent unexpected outcomes, like fail open traffic routing. However, there are scenarios when you might want to bypass the routing control safeguards that are enforced with safety rules that you've configured. For example, you might want to fail over quickly for disaster recovery, and one or more safety rules might be unexpectedly preventing you from updating a routing control state to reroute traffic. In a "break glass" scenario like this, you can override one or more safety rules to change a routing control state and fail over your application. The `SafetyRulesToOverride` property enables you override one or more safety rules and update routing control states. For more information, see [ Override safety rules to reroute traffic](https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.override-safety-rule.html) in the Amazon Route 53 Application Recovery Controller Developer Guide. *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. + [ Viewing and updating routing control states](https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.html) + [Working with routing controls overall](https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html) ## Request Syntax ``` { "RoutingControlArn": "string", "RoutingControlState": "string", "SafetyRulesToOverride": [ "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_UpdateRoutingControlState_RequestSyntax) ** The Amazon Resource Name (ARN) for the routing control that you want to update the state for. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[A-Za-z0-9:.\/_-]*$` Required: Yes ** [RoutingControlState](#API_UpdateRoutingControlState_RequestSyntax) ** The state of the routing control. You can set the value to ON or OFF. Type: String Valid Values: `On | Off` Required: Yes ** [SafetyRulesToOverride](#API_UpdateRoutingControlState_RequestSyntax) ** The Amazon Resource Names (ARNs) for the safety rules that you want to override when you're updating the state of a routing control. You can override one safety rule or multiple safety rules by including one or more ARNs, separated by commas. For more information, see [ Override safety rules to reroute traffic](https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.override-safety-rule.html) in the Amazon Route 53 Application Recovery Controller Developer Guide. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[A-Za-z0-9:.\/_-]*$` Required: No ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## 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 ** ConflictException ** There was a conflict with this request. Try again. 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/UpdateRoutingControlState) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/route53-recovery-cluster-2019-12-02/UpdateRoutingControlState) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/route53-recovery-cluster-2019-12-02/UpdateRoutingControlState) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/route53-recovery-cluster-2019-12-02/UpdateRoutingControlState) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/route53-recovery-cluster-2019-12-02/UpdateRoutingControlState) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/route53-recovery-cluster-2019-12-02/UpdateRoutingControlState) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/route53-recovery-cluster-2019-12-02/UpdateRoutingControlState) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/route53-recovery-cluster-2019-12-02/UpdateRoutingControlState) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/route53-recovery-cluster-2019-12-02/UpdateRoutingControlState) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/route53-recovery-cluster-2019-12-02/UpdateRoutingControlState) # UpdateRoutingControlStates Set multiple routing control states. You can set the value for each state to be ON or OFF. When the state is ON, traffic flows to a cell. When it's OFF, traffic does not flow. With Route 53 ARC, you can add safety rules for routing controls, which are safeguards for routing control state updates that help prevent unexpected outcomes, like fail open traffic routing. However, there are scenarios when you might want to bypass the routing control safeguards that are enforced with safety rules that you've configured. For example, you might want to fail over quickly for disaster recovery, and one or more safety rules might be unexpectedly preventing you from updating a routing control state to reroute traffic. In a "break glass" scenario like this, you can override one or more safety rules to change a routing control state and fail over your application. The `SafetyRulesToOverride` property enables you override one or more safety rules and update routing control states. For more information, see [ Override safety rules to reroute traffic](https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.override-safety-rule.html) in the Amazon Route 53 Application Recovery Controller Developer Guide. *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. + [ Viewing and updating routing control states](https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.html) + [Working with routing controls overall](https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html) ## Request Syntax ``` { "SafetyRulesToOverride": [ "string" ], "UpdateRoutingControlStateEntries": [ { "RoutingControlArn": "string", "RoutingControlState": "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. ** [SafetyRulesToOverride](#API_UpdateRoutingControlStates_RequestSyntax) ** The Amazon Resource Names (ARNs) for the safety rules that you want to override when you're updating routing control states. You can override one safety rule or multiple safety rules by including one or more ARNs, separated by commas. For more information, see [ Override safety rules to reroute traffic](https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.override-safety-rule.html) in the Amazon Route 53 Application Recovery Controller Developer Guide. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[A-Za-z0-9:.\/_-]*$` Required: No ** [UpdateRoutingControlStateEntries](#API_UpdateRoutingControlStates_RequestSyntax) ** A set of routing control entries that you want to update. Type: Array of [UpdateRoutingControlStateEntry](API_UpdateRoutingControlStateEntry.md) objects Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## 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 ** ConflictException ** There was a conflict with this request. Try again. 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 ** ServiceLimitExceededException ** The request can't update that many routing control states at the same time. Try again with fewer routing control states. ** limitCode ** The code of the limit that was exceeded. ** resourceId ** The resource identifier of the limit that was exceeded. ** resourceType ** The resource type of the limit that was exceeded. ** serviceCode ** The service code of the limit that was exceeded. 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/UpdateRoutingControlStates) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/route53-recovery-cluster-2019-12-02/UpdateRoutingControlStates) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/route53-recovery-cluster-2019-12-02/UpdateRoutingControlStates) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/route53-recovery-cluster-2019-12-02/UpdateRoutingControlStates) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/route53-recovery-cluster-2019-12-02/UpdateRoutingControlStates) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/route53-recovery-cluster-2019-12-02/UpdateRoutingControlStates) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/route53-recovery-cluster-2019-12-02/UpdateRoutingControlStates) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/route53-recovery-cluster-2019-12-02/UpdateRoutingControlStates) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/route53-recovery-cluster-2019-12-02/UpdateRoutingControlStates) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/route53-recovery-cluster-2019-12-02/UpdateRoutingControlStates)