ListControlPanels - Amazon Route 53 Application Recovery Controller

ListControlPanels

URI

/controlpanels

HTTP methods

GET

Operation ID: ListControlPanels

Returns an array of control panels in an account or in a cluster.

Query parameters
NameTypeRequiredDescription
ClusterArnStringFalse

The Amazon Resource Name (ARN) of a cluster.

MaxResultsStringFalse

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

NextTokenStringFalse

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

Responses
Status codeResponse modelDescription
200ListControlPanelsResponse

200 response - Success.

400ValidationException

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.

403AccessDeniedException

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

404ResourceNotFoundException

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

429ThrottlingException

429 response - LimitExceededException or TooManyRequestsException.

500InternalServerException

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

OPTIONS

Responses
Status codeResponse modelDescription
200None

200 response - Success.

Schemas

Response bodies

{ "ControlPanels": [ { "ClusterArn": "string", "Status": enum, "ControlPanelArn": "string", "DefaultControlPanel": boolean, "RoutingControlCount": integer, "Name": "string" } ], "NextToken": "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.

PropertyTypeRequiredDescription
message

string

True

ControlPanel

A control panel represents a group of routing controls that can be changed together in a single transaction.

PropertyTypeRequiredDescription
ClusterArn

string

False

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

ControlPanelArn

string

False

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

DefaultControlPanel

boolean

False

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.

Name

string

Pattern: ^\S+$

MinLength: 1

MaxLength: 64

False

The name of the control panel. You can use any non-white space character in the name.

RoutingControlCount

integer

Format: int32

False

The number of routing controls in the control panel.

Status

Status

False

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

InternalServerException

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

PropertyTypeRequiredDescription
message

string

True

ListControlPanelsResponse

The result of a successful ListControlPanel request.

PropertyTypeRequiredDescription
ControlPanels

Array of type ControlPanel

False

The result of a successful ListControlPanel request.

NextToken

string

MaxLength: 8096

False

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

ResourceNotFoundException

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

PropertyTypeRequiredDescription
message

string

True

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.

PropertyTypeRequiredDescription
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.

PropertyTypeRequiredDescription
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:

ListControlPanels