AuroraDSQL / Client / delete_stream

delete_stream¶

AuroraDSQL.Client.delete_stream(**kwargs)¶

Deletes a stream from a cluster.

Request Syntax

response = client.delete_stream(
    clusterIdentifier='string',
    streamIdentifier='string',
    clientToken='string'
)

Parameters:

clusterIdentifier (string) –
[REQUIRED]

The ID of the cluster containing the stream to delete.
streamIdentifier (string) –
[REQUIRED]

The ID of the stream 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

{
    'clusterIdentifier': 'string',
    'streamIdentifier': 'string',
    'arn': 'string',
    'status': 'CREATING'|'ACTIVE'|'DELETING'|'DELETED'|'FAILED'|'IMPAIRED',
    'creationTime': datetime(2015, 1, 1)
}

Response Structure

(dict) –

The output from a deleted stream.
- clusterIdentifier (string) –
  
  The ID of the cluster for the deleted stream.
- streamIdentifier (string) –
  
  The ID of the deleted stream.
- arn (string) –
  
  The ARN of the deleted stream.
- status (string) –
  
  The status of the stream.
- creationTime (datetime) –
  
  The time when the stream was created.

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