URI HTTP methods Schemas Properties See also

ListControlPanels

URI

/controlpanels

HTTP methods

GET

Operation ID: ListControlPanels

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

Query parameters
Name	Type	Required	Description
`ClusterArn`	String	False	The Amazon Resource Name (ARN) of a cluster.
`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`	`ListControlPanelsResponse`	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

Responses
Status code	Response model	Description
`200`	None	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.

Property	Type	Required	Description
`message`	string	True

ControlPanel

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

Property	Type	Required	Description
`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. Note that only ASCII characters are supported for control panel names, and each name must be unique within a control panel.
`RoutingControlCount`	integer Format: int32	False	The number of routing controls in the control panel.
`Status`	Status	False	The deployment status of the control panel. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.

InternalServerException

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

Property	Type	Required	Description
`message`	string	True

ListControlPanelsResponse

The result of a successful ListControlPanel request.

Property Type Required Description

Property	Type	Required	Description
`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.

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.

Property	Type	Required	Description
`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.

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