AuroraDSQL / Client / delete_cluster

delete_cluster#

AuroraDSQL.Client.delete_cluster(**kwargs)#

Deletes a cluster in Amazon Aurora DSQL.

Request Syntax

response = client.delete_cluster(
    identifier='string',
    clientToken='string'
)

Parameters:

identifier (string) –
[REQUIRED]

The ID of the cluster to delete.
clientToken (string) –
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.

This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'identifier': 'string',
    'arn': 'string',
    'status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'DELETED'|'FAILED',
    'creationTime': datetime(2015, 1, 1),
    'deletionProtectionEnabled': True|False
}

Response Structure

(dict) –

Output Mixin
- identifier (string) –
  
  The ID of the deleted cluster.
- arn (string) –
  
  The ARN of the deleted cluster.
- status (string) –
  
  The status of the cluster.
- creationTime (datetime) –
  
  The time of when the cluster was created.
- deletionProtectionEnabled (boolean) –
  
  Specifies whether deletion protection was enabled on the cluster.

Exceptions

AuroraDSQL.Client.exceptions.ThrottlingException
AuroraDSQL.Client.exceptions.AccessDeniedException
AuroraDSQL.Client.exceptions.ValidationException
AuroraDSQL.Client.exceptions.InternalServerException
AuroraDSQL.Client.exceptions.ResourceNotFoundException
AuroraDSQL.Client.exceptions.ConflictException