OpenSearchServiceServerless / Paginator / ListIngestionStreams

ListIngestionStreams¶

class OpenSearchServiceServerless.Paginator.ListIngestionStreams¶

paginator = client.get_paginator('list_ingestion_streams')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from OpenSearchServiceServerless.Client.list_ingestion_streams().

Request Syntax

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

Parameters:

collectionId (string) –
[REQUIRED]

The unique identifier of the collection to list ingestion streams for.
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

{
    'ingestionStreamSummaries': [
        {
            'ingestionStreamId': 'string',
            'arn': 'string',
            'ingestionStreamName': 'string',
            'indexName': 'string',
            'status': 'CREATING'|'ACTIVE'|'DELETING'|'DELETED'|'CREATE_FAILED'|'DELETE_FAILED',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- ingestionStreamSummaries (list) –
  
  Summary information about each ingestion stream.
  - (dict) –
    
    Summary information about an ingestion stream.
    - ingestionStreamId (string) –
      
      The unique identifier of the ingestion stream.
    - arn (string) –
      
      The Amazon Resource Name (ARN) of the ingestion stream.
    - ingestionStreamName (string) –
      
      The name of the ingestion stream.
    - indexName (string) –
      
      The name of the index that documents are ingested into.
    - status (string) –
      
      The current lifecycle status of the ingestion stream.
    - createdAt (datetime) –
      
      The date and time when the ingestion stream was created.
    - updatedAt (datetime) –
      
      The date and time when the ingestion stream was last updated.
- NextToken (string) –
  
  A token to resume pagination.