"ControlPanel": {
"ClusterArn": "string", "Status": enum,
"ControlPanelArn": "string", "DefaultControlPanel": boolean, "RoutingControlCount": integer, "Name": "string"
} }
DeleteControlPanelResponse schema
{
}
ValidationException schema
{
"message": "string"
}
AccessDeniedException schema
{ "message": "string"
}
ResourceNotFoundException schema
{ "message": "string"
}
ConflictException schema
{ "message": "string"
}
ThrottlingException schema
{ "message": "string"
}
InternalServerException schema
{ "message": "string"
}
Properties
AccessDeniedException
403 response - You do not have sufficient access to perform this action.
message
Type: stringRequired: True
ConflictException
409 response - ConflictException. You might be using a predefined variable.
message
Type: string Required: TrueControlPanel
A control panel represents a group of routing controls that can be changed together in a single transaction.
ClusterArn
The Amazon Resource Name (ARN) of the cluster that includes the control panel.
Type: string Required: False
Status
The deployment status of control panel. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
Type: Status (p. 45) Required: False
ControlPanelArn
The Amazon Resource Name (ARN) of the control panel.
Type: string Required: False
DefaultControlPanel
A flag that Amazon Route 53 Application Recovery Controller sets to true to designate the default control panel for a cluster. When you create a cluster, Amazon Route 53 Application Recovery Controller creates a control panel, and sets this flag for that control panel. If you create a control panel yourself, this flag is set to false.
Type: boolean Required: False
RoutingControlCount
The number of routing controls in the control panel.
Type: integer
Required: False Format: int32
Name
The name of the control panel. You can use any non-white space character in the name.
Type: string Required: False Pattern: ^\S+$
MinLength: 1 MaxLength: 64
DeleteControlPanelResponse
A successful DeleteControlPanel request returns no response.
DescribeControlPanelResponse
The result of a successful DescribeControlPanel request.
ControlPanel
Information about the control panel.
Type: ControlPanel (p. 44) Required: True
InternalServerException
500 response - InternalServiceError. Temporary service error. Retry the request.
message
Type: string Required: TrueResourceNotFoundException
404 response - MalformedQueryString. The query string contains a syntax error or resource not found.
message
Type: string Required: TrueStatus
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.
message
Type: string Required: TrueValidationException
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.
message
Type: string Required: TrueSee also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following:
DescribeControlPanel
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteControlPanel
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
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 and OFF. You configure routing controls so they update Amazon Route 53 health checks, which reroute traffic for your application.
To get or update the routing control state, see the Recovery Cluster (data plane) API actions 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 (p. 49)200 response - Success.
400 ValidationException (p. 49)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 (p. 50)403 response
-AccessDeniedException. You do not have sufficient access to perform this action.
Status code Response model Description 404 ResourceNotFoundException (p. 50)404 response
-MalformedQueryString. The query string contains a syntax error or resource not found.
409 ConflictException (p. 50) 409 response
-ConflictException. You might be using a predefined variable.
429 ThrottlingException (p. 50)429 response
-LimitExceededException or TooManyRequestsException.
500 InternalServerException (p. 50)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 (p. 49)200 response - Success.
400 ValidationException (p. 49)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 (p. 50)403 response
-AccessDeniedException. You do not have sufficient access to perform this action.
404 ResourceNotFoundException (p. 50)404 response
-MalformedQueryString. The query string contains a syntax error or resource not found.
Status code Response model Description
409 ConflictException (p. 50) 409 response
-ConflictException. You might be using a predefined variable.
429 ThrottlingException (p. 50)429 response
-LimitExceededException or TooManyRequestsException.
500 InternalServerException (p. 50)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
DescribeRoutingControlResponse schema
{
"RoutingControl": { "Status": enum,
"RoutingControlArn": "string", "ControlPanelArn": "string", "Name": "string"
}}
DeleteRoutingControlResponse schema
{}
ValidationException schema
{
"message": "string"
}
AccessDeniedException schema
{
"message": "string"
}
ResourceNotFoundException schema
{ "message": "string"
}
ConflictException schema
{ "message": "string"
}
ThrottlingException schema
{
"message": "string"
}
InternalServerException schema
{ "message": "string"
}
Properties
AccessDeniedException
403 response - You do not have sufficient access to perform this action.
message
Type: string Required: TrueConflictException
409 response - ConflictException. You might be using a predefined variable.
message
Type: string Required: TrueDeleteRoutingControlResponse
A successful DeleteRoutingControl request returns no response.
DescribeRoutingControlResponse
The result of a successful DescribeRoutingControl request.
RoutingControl
Information about the routing control.
Type: RoutingControl (p. 51) Required: True
InternalServerException
500 response - InternalServiceError. Temporary service error. Retry the request.
message
Type: string Required: TrueResourceNotFoundException
404 response - MalformedQueryString. The query string contains a syntax error or resource not found.
message
Type: string Required: TrueRoutingControl
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.
Status
The deployment status of a routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
Type: Status (p. 52) Required: False
RoutingControlArn
The Amazon Resource Name (ARN) of the routing control.
Type: string Required: False
ControlPanelArn
The Amazon Resource Name (ARN) of the control panel that includes the routing control.
Type: string Required: False
Name
The name of the routing control.
Type: string Required: False Pattern: ^\S+$
MinLength: 1 MaxLength: 64
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.
message
Type: string Required: TrueValidationException
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.
message
Type: stringRequired: True
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following:
DescribeRoutingControl
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteRoutingControl
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DescribeSafetyRule, DeleteSafetyRule
URI
/safetyrule/SafetyRuleArn
HTTP methods
GET
Operation ID: DescribeSafetyRule Returns information about a safety rule.
Path parameters
Name Type Required Description
SafetyRuleArn String True The ARN of the safety
rule.
Responses
Status code Response model Description
200 DescribeSafetyRuleResponse (p. 55)200 response - Success.
400 ValidationException (p. 56)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.
404 ResourceNotFoundException (p. 56)404 response
-MalformedQueryString. The query string contains a syntax error or resource not found.
DELETE
Operation ID: DeleteSafetyRule Deletes a safety rule.
Path parameters
Name Type Required Description
SafetyRuleArn String True The ARN of the safety
rule.
Responses
Status code Response model Description
200 DeleteSafetyRuleResponse (p. 56)200 response - Success.
400 ValidationException (p. 56)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.
404 ResourceNotFoundException (p. 56)404 response
-MalformedQueryString. The query string contains a syntax error or resource not found.
Status code Response model Description 500 InternalServerException (p. 56)500 response
-InternalServiceError. Temporary service error. Retry the request.
OPTIONS
Path parameters
Name Type Required Description
SafetyRuleArn String True The ARN of the safety
rule.
Responses
Status code Response model Description
200 None 200 response - Success.