AuroraDSQL / Client / list_streams

list_streams¶

AuroraDSQL.Client.list_streams(**kwargs)¶

Retrieves information about a list of streams for a cluster.

Request Syntax

response = client.list_streams(
    clusterIdentifier='string',
    maxResults=123,
    nextToken='string'
)

Parameters:

clusterIdentifier (string) –
[REQUIRED]

The ID of the cluster for which to list streams.
maxResults (integer) – An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results. Default: 10.
nextToken (string) – If your initial ListStreams operation returns a nextToken, you can include the returned nextToken in following ListStreams operations, which returns results in the next page.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –
- nextToken (string) –
  
  If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token.
- streams (list) –
  
  An array of the returned streams.
  - (dict) –
    
    Summary information about a stream.
    - clusterIdentifier (string) –
      
      The ID of the cluster.
    - streamIdentifier (string) –
      
      The ID of the stream.
    - arn (string) –
      
      The ARN of the stream.
    - creationTime (datetime) –
      
      The timestamp when the stream was created.
    - status (string) –
      
      The current status of the stream.

Exceptions

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