URI HTTP methods Schemas Properties See also

DescribeRoutingControl, DeleteRoutingControl

URI

/routingcontrol/RoutingControlArn

HTTP methods

GET

Operation ID: DescribeRoutingControl

Displays details about a routing control. A routing control has one of two states: ON or OFF. When you change routing control states, Route 53 ARC updates Amazon Route 53 health checks, which reroute traffic for your application.

To get or update the routing control state, see the GetRoutingControlState API in the Routing Control (Recovery Cluster) API Reference Guide for Amazon Route 53 Application Recovery Controller.

Path parameters
Name	Type	Required	Description
`RoutingControlArn`	String	True	The Amazon Resource Name (ARN) of the routing control.

Responses
Status code	Response model	Description
`200`	`DescribeRoutingControlResponse`	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.
`409`	`ConflictException`	409 response - ConflictException. You might be using a predefined variable.
`429`	`ThrottlingException`	429 response - LimitExceededException or TooManyRequestsException.
`500`	`InternalServerException`	500 response - InternalServiceError. Temporary service error. Retry the request.

DELETE

Operation ID: DeleteRoutingControl

Deletes a routing control.

Path parameters
Name	Type	Required	Description
`RoutingControlArn`	String	True	The Amazon Resource Name (ARN) of the routing control that you're deleting.

Responses
Status code	Response model	Description
`200`	`DeleteRoutingControlResponse`	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.
`409`	`ConflictException`	409 response - ConflictException. You might be using a predefined variable.
`429`	`ThrottlingException`	429 response - LimitExceededException or TooManyRequestsException.
`500`	`InternalServerException`	500 response - InternalServiceError. Temporary service error. Retry the request.

OPTIONS

Path parameters
Name	Type	Required	Description
`RoutingControlArn`	String	True	The Amazon Resource Name (ARN) of a routing control.

Responses
Status code	Response model	Description
`200`	None	200 response - Success.

Schemas

Response bodies


{
  "RoutingControl": {
    "Status": enum,
    "RoutingControlArn": "string",
    "ControlPanelArn": "string",
    "Name": "string"
  }
}

{
}


{
  "message": "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

ConflictException

409 response - ConflictException. You might be using a predefined variable.

Property	Type	Required	Description
`message`	string	True

DeleteRoutingControlResponse

A successful DeleteRoutingControl request returns no response.

DescribeRoutingControlResponse

The result of a successful DescribeRoutingControl request.

Property	Type	Required	Description
`RoutingControl`	RoutingControl	True	Information about the routing control.

InternalServerException

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

Property	Type	Required	Description
`message`	string	True

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: `^\S+$` 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`	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

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