OpenSearchServiceServerless / Client / delete_ingestion_stream

delete_ingestion_stream

OpenSearchServiceServerless.Client.delete_ingestion_stream(**kwargs)

Deletes an ingestion stream. Documents that were already indexed by the stream remain in the index.

See also: AWS API Documentation

Request Syntax

response = client.delete_ingestion_stream(
    collectionId='string',
    ingestionStreamId='string',
    clientToken='string'
)

Parameters:

• collectionId (string) –

  [REQUIRED]

  The unique identifier of the collection that the ingestion stream belongs to.

• ingestionStreamId (string) –

  [REQUIRED]

  The unique identifier of the ingestion stream to delete.

• clientToken (string) –

  Unique, case-sensitive identifier to ensure idempotency of the request.

  This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'ingestionStreamId': 'string',
    'collectionId': 'string',
    'ingestionStreamName': 'string',
    'status': 'CREATING'|'ACTIVE'|'DELETING'|'DELETED'|'CREATE_FAILED'|'DELETE_FAILED'
}

Response Structure

• (dict) –

  • ingestionStreamId (string) –

    The unique identifier of the deleted ingestion stream.

  • collectionId (string) –

    The unique identifier of the collection that the ingestion stream belonged to.

  • ingestionStreamName (string) –

    The name of the deleted ingestion stream.

  • status (string) –

    The current status of the ingestion stream.

Exceptions

• OpenSearchServiceServerless.Client.exceptions.InternalServerException

• OpenSearchServiceServerless.Client.exceptions.ConflictException

• OpenSearchServiceServerless.Client.exceptions.ResourceNotFoundException

• OpenSearchServiceServerless.Client.exceptions.ValidationException