Returns an array of control panels in an account or in a cluster.
Parameters:
-
cluster_arn
(Optional[__string], default:
None
)
–
The Amazon Resource Name (ARN) of a cluster.
-
max_results
(Optional[MaxResults], default:
None
)
–
The number of objects that you want to return with this call.
-
next_token
(Optional[__string], default:
None
)
–
The token that identifies which batch of results you want to see.
Raises:
-
AccessDeniedException
–
403 response - You do not have sufficient access to perform this action.
-
InternalServerException
–
500 response - InternalServiceError. Temporary service error. Retry the request.
-
ResourceNotFoundException
–
404 response - MalformedQueryString. The query string contains a syntax error or resource not found.
-
ThrottlingException
–
429 response - LimitExceededException or TooManyRequestsException.
-
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.
-
UnknownServiceError
–
The service returned an error code this client does not model.
Source code in docs_src/capo_route53_recovery_control_config/_services/route53_recovery_control_config.py
| def list_control_panels(
self,
*,
config_overrides: Optional[Route53RecoveryControlConfigClientConfig] = None,
cluster_arn: Optional[
"capo_route53_recovery_control_config.types.__string.__string"
] = None,
max_results: Optional[
"capo_route53_recovery_control_config.types.max_results.MaxResults"
] = None,
next_token: Optional[
"capo_route53_recovery_control_config.types.__string.__string"
] = None,
) -> "capo_route53_recovery_control_config.types.list_control_panels_response.ListControlPanelsResponse":
"""<p>Returns an array of control panels in an account or in a cluster.</p>
Args:
cluster_arn: <p>The Amazon Resource Name (ARN) of a cluster.</p>
max_results: <p>The number of objects that you want to return with this call.</p>
next_token: <p>The token that identifies which batch of results you want to see.</p>
Raises:
capo_route53_recovery_control_config.errors.access_denied_exception.AccessDeniedException: <p>403 response - You do not have sufficient access to perform this action.</p>
capo_route53_recovery_control_config.errors.internal_server_exception.InternalServerException: <p>500 response - InternalServiceError. Temporary service error. Retry the request.</p>
capo_route53_recovery_control_config.errors.resource_not_found_exception.ResourceNotFoundException: <p>404 response - MalformedQueryString. The query string contains a syntax error or resource not found.</p>
capo_route53_recovery_control_config.errors.throttling_exception.ThrottlingException: <p>429 response - LimitExceededException or TooManyRequestsException.</p>
capo_route53_recovery_control_config.errors.validation_exception.ValidationException: <p>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.</p>
capo_route53_recovery_control_config.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_route53_recovery_control_config.types.list_control_panels_request.ListControlPanelsRequest]",
) -> OperationResponse[
"capo_route53_recovery_control_config.types.list_control_panels_response.ListControlPanelsResponse"
]:
import capo_route53_recovery_control_config._operations.route53_recovery_control_config.list_control_panels
output, http_response = (
capo_route53_recovery_control_config._operations.route53_recovery_control_config.list_control_panels.list_control_panels(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListControlPanels")
)
input_: capo_route53_recovery_control_config.types.list_control_panels_request.ListControlPanelsRequest = {}
if cluster_arn is not None:
input_["cluster_arn"] = cluster_arn
if max_results is not None:
input_["max_results"] = max_results
if next_token is not None:
input_["next_token"] = next_token
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|