Creates a new control panel. A control panel represents a group of routing controls that can be changed together in a single transaction. You can use a control panel to centrally view the operational status of applications across your organization, and trigger multi-app failovers in a single transaction, for example, to fail over an Availability Zone or Amazon Web Services Region.
Parameters:
Raises:
-
AccessDeniedException
–
403 response - You do not have sufficient access to perform this action.
-
ConflictException
–
409 response - ConflictException. You might be using a predefined variable.
-
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.
-
ServiceQuotaExceededException
–
402 response - You attempted to create more resources than the service allows based on service quotas.
-
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 create_control_panel(
self,
*,
config_overrides: Optional[Route53RecoveryControlConfigClientConfig] = None,
client_token: Optional[
"capo_route53_recovery_control_config.types.__string_min1_max64_pattern_s.__stringMin1Max64PatternS"
] = None,
cluster_arn: Optional[
"capo_route53_recovery_control_config.types.__string_min1_max256_pattern_a_za_z09.__stringMin1Max256PatternAZaZ09"
] = None,
control_panel_name: Optional[
"capo_route53_recovery_control_config.types.__string_min1_max64_pattern_s.__stringMin1Max64PatternS"
] = None,
tags: Optional[
"capo_route53_recovery_control_config.types.__map_of__string_min0_max256_pattern_s.__mapOf__stringMin0Max256PatternS"
] = None,
) -> "capo_route53_recovery_control_config.types.create_control_panel_response.CreateControlPanelResponse":
"""<p>Creates a new control panel. A control panel represents a group of routing controls that can be changed together in a single transaction. You can use a control panel to centrally view the operational status of applications across your organization, and trigger multi-app failovers in a single transaction, for example, to fail over an Availability Zone or Amazon Web Services Region.</p>
Args:
client_token: <p>A unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request with an action, specify a client token in the request.</p>
cluster_arn: <p>The Amazon Resource Name (ARN) of the cluster for the control panel.</p>
control_panel_name: <p>The name of the control panel.</p>
tags: <p>The tags associated with the control panel.</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.conflict_exception.ConflictException: <p>409 response - ConflictException. You might be using a predefined variable.</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.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>402 response - You attempted to create more resources than the service allows based on service quotas.</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.create_control_panel_request.CreateControlPanelRequest]",
) -> OperationResponse[
"capo_route53_recovery_control_config.types.create_control_panel_response.CreateControlPanelResponse"
]:
import capo_route53_recovery_control_config._operations.route53_recovery_control_config.create_control_panel
output, http_response = (
capo_route53_recovery_control_config._operations.route53_recovery_control_config.create_control_panel.create_control_panel(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("CreateControlPanel")
)
input_: capo_route53_recovery_control_config.types.create_control_panel_request.CreateControlPanelRequest = {}
if client_token is None:
client_token = str(uuid.uuid4())
input_["client_token"] = client_token
if cluster_arn is not None:
input_["cluster_arn"] = cluster_arn
if control_panel_name is not None:
input_["control_panel_name"] = control_panel_name
if tags is not None:
input_["tags"] = tags
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|