OpenSearchServiceServerless / Client / list_ingestion_streams

list_ingestion_streams

OpenSearchServiceServerless.Client.list_ingestion_streams(**kwargs)

Returns a list of ingestion streams in a collection.

See also: AWS API Documentation

Request Syntax

response = client.list_ingestion_streams(
    collectionId='string',
    nextToken='string',
    maxResults=123
)
Parameters:

  • collectionId (string) –

    [REQUIRED]

    The unique identifier of the collection to list ingestion streams for.

  • nextToken (string) – If your initial ListIngestionStreams operation returns a nextToken, you can include the returned nextToken in subsequent ListIngestionStreams operations, which returns results in the next page.

  • maxResults (integer) –

    The maximum number of results to return. Valid values are 1–100. If you don’t specify a value, the default is 100. You can use nextToken to get the next page of results.

    A response can contain fewer results than maxResults, or no results, and still include a nextToken. To retrieve all results, continue to make the call with the returned nextToken until no nextToken is returned.

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) –

      When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

Exceptions