Deletes a cluster in Amazon Aurora DSQL.
Parameters:
-
identifier
(ClusterId)
–
The ID of the cluster to delete.
-
client_token
(Optional[ClientToken], default:
None
)
–
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully. The subsequent retries with the same client token return the result from the original successful request and they have no additional effect.
If you don't specify a client token, the Amazon Web Services SDK automatically generates one.
Raises:
Examples:
Delete Cluster
>>> client.delete_cluster(identifier='kiqenqglxyl2snyvkvnj2c3s2e')
Source code in docs_src/capo_dsql/_services/dsql.py
| def delete_cluster(
self,
identifier: "capo_dsql.types.cluster_id.ClusterId",
*,
config_overrides: Optional[DSQLClientConfig] = None,
client_token: Optional["capo_dsql.types.client_token.ClientToken"] = None,
) -> "capo_dsql.types.delete_cluster_output.DeleteClusterOutput":
"""<p>Deletes a cluster in Amazon Aurora DSQL.</p>
Args:
identifier: <p>The ID of the cluster to delete.</p>
client_token: <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully. The subsequent retries with the same client token return the result from the original successful request and they have no additional effect.</p> <p>If you don't specify a client token, the Amazon Web Services SDK automatically generates one.</p>
Raises:
capo_dsql.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
capo_dsql.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception or failure.</p>
capo_dsql.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
capo_dsql.errors.validation_exception.ValidationException: <p>The input failed to satisfy the constraints specified by an Amazon Web Services service.</p>
capo_dsql.errors.conflict_exception.ConflictException: <p>The submitted action has conflicts.</p>
capo_dsql.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource could not be found.</p>
capo_dsql.errors.UnknownServiceError: The service returned an error code this client does not model.
Examples:
Delete Cluster
>>> client.delete_cluster(identifier='kiqenqglxyl2snyvkvnj2c3s2e')
"""
def _handler(
req: "OperationRequest[capo_dsql.types.delete_cluster_input.DeleteClusterInput]",
) -> OperationResponse[
"capo_dsql.types.delete_cluster_output.DeleteClusterOutput"
]:
import capo_dsql._operations.dsql.delete_cluster
output, http_response = (
capo_dsql._operations.dsql.delete_cluster.delete_cluster(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DeleteCluster")
)
input_: capo_dsql.types.delete_cluster_input.DeleteClusterInput = {
"identifier": identifier
}
if client_token is None:
client_token = str(uuid.uuid4())
input_["client_token"] = client_token
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|