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 configure routing controls so they update Amazon Route 53 health checks, which reroute traffic for your application.
| Name | Type | Required | Description |
|---|---|---|---|
ControlPanelArn | String | True | The Amazon Resource Name (ARN) of the control panel. |
| 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. |
| 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 have 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
| Name | Type | Required | Description |
|---|---|---|---|
ControlPanelArn | String | True | The Amazon Resource Name (ARN) of a control panel. |
| 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
403 response - You do not have sufficient access to perform this action.
| Property | Type | Required | Description |
|---|---|---|---|
message | string | True |
InternalServerException
500 response - InternalServiceError. Temporary service error. Retry the request.
| 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
404 response - MalformedQueryString. The query string contains a syntax error or resource not found.
| Property | Type | Required | Description |
|---|---|---|---|
message | string | True |
RoutingControl
A routing control has one of two states: ON and OFF. You configure routing controls so they update Amazon Route 53 health checks, which reroute traffic for your application.
| Property | Type | Required | Description |
|---|---|---|---|
ControlPanelArn | string | False | The Amazon Resource Name (ARN) of the control panel that includes the routing control. |
Name | string Pattern: MinLength: 1 MaxLength: 64 | False | The name of the routing control. You can use any non-white space character in the name except the following: & > < ' (single quote) " (double quote) ; (semicolon) |
RoutingControlArn | string | False | The Amazon Resource Name (ARN) of the routing control. |
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.
PENDINGDEPLOYEDPENDING_DELETION
ThrottlingException
429 response - LimitExceededException or TooManyRequestsException.
| Property | Type | Required | Description |
|---|---|---|---|
message | string | True |
ValidationException
400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.
| 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
