ListRoutingControls - Amazon Route 53 Application Recovery Controller

ListRoutingControls

URI

/controlpanel/ControlPanelArn/routingcontrols

HTTP methods

GET

Operation ID: ListRoutingControls

Returns an array of routing controls for a control panel. A routing control is an Amazon Route 53 Application Recovery Controller construct that has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control routing.

Path parameters
Name Type Required Description
ControlPanelArn String True

The Amazon Resource Name (ARN) of the control panel.

Query parameters
Name Type Required Description
MaxResults String False

The number of objects that you want to return with this call.

NextToken String False

The token that identifies which batch of results you want to see.

Responses
Status code Response model Description
200 ListRoutingControlsResponse

200 response - Success.

400 ValidationException

400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you used parameters together incorrectly.

403 AccessDeniedException

403 response - AccessDeniedException. You do not hace sufficient access to perform this action.

404 ResourceNotFoundException

404 response - MalformedQueryString. The query string contains a syntax error or resource not found.

429 ThrottlingException

429 response - LimitExceededException or TooManyRequestsException.

500 InternalServerException

500 response - InternalServiceError. Temporary service error. Retry the request.

OPTIONS

Responses
Status code Response model Description
200 None

200 response - Success.

Schemas

Response bodies

{ "NextToken": "string", "RoutingControls": [ { "Status": enum, "RoutingControlArn": "string", "ControlPanelArn": "string", "Name": "string" } ] }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }

Properties

AccessDeniedException

Property Type Required Description
message

string

True

InternalServerException

Property Type Required Description
message

string

True

ListRoutingControlsResponse

The result of a successful ListRoutingControl request.

Property Type Required Description
NextToken

string

MaxLength: 8096

False

The token that identifies which batch of results you want to see.

RoutingControls

Array of type RoutingControl

False

An array of routing controls.

ResourceNotFoundException

Property Type Required Description
message

string

True

RoutingControl

A routing control has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control traffic routing.

Property Type Required Description
ControlPanelArn

string

False

The Amazon Resource Name (ARN) of the control panel that includes the routing control.

Name

string

Pattern: ^\S+$

MinLength: 1

MaxLength: 64

False

The name of the routing control.

RoutingControlArn

string

False

The Amazon Resource Name (ARN) of the routing control.

Status

Status

False

The deployment status of a routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.

Status

The deployment status of a resource. Status can be one of the following:

PENDING: Amazon Route 53 Application Recovery Controller is creating the resource.

DEPLOYED: The resource is deployed and ready to use.

PENDING_DELETION: Amazon Route 53 Application Recovery Controller is deleting the resource.

  • PENDING

  • DEPLOYED

  • PENDING_DELETION

ThrottlingException

Property Type Required Description
message

string

True

ValidationException

Property Type Required Description
message

string

True

See also

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

ListRoutingControls