UpdateRoutingControlState - Routing Control API Reference Guide

UpdateRoutingControlState

Set the state of the routing control to reroute traffic. You can set the value to be On or Off. When the state is On, traffic flows to a cell. When it's Off, traffic does not flow.

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", "RoutingControlState": "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 update the state for.

Type: String

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

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

Required: Yes

RoutingControlState

The state of the routing control. You can set the value to be On or Off.

Type: String

Valid Values: On | Off

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 Errors.

AccessDeniedException

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

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 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: