ListRoutingControls - Routing Control API Reference Guide

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 On, traffic flows to a cell. When the state is 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 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:

Request Syntax

{ "ControlPanelArn": "string", "MaxResults": number, "NextToken": "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.

ControlPanelArn

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

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

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", "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

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

The list of routing controls.

Type: Array of RoutingControl objects

Errors

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

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: