AuroraDSQL / Paginator / ListStreams

ListStreams¶

class AuroraDSQL.Paginator.ListStreams¶

paginator = client.get_paginator('list_streams')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from AuroraDSQL.Client.list_streams().

Request Syntax

response_iterator = paginator.paginate(
    clusterIdentifier='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

clusterIdentifier (string) –
[REQUIRED]

The ID of the cluster for which to list streams.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) –
  
  The size of each page.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –
- 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.
- NextToken (string) –
  
  A token to resume pagination.