OpenSearchServiceServerless / Client / cancel_ingestion_job

cancel_ingestion_job

OpenSearchServiceServerless.Client.cancel_ingestion_job(**kwargs)

Cancels an in-progress ingestion job. Documents that were already indexed before the cancellation remain in the index.

See also: AWS API Documentation

Request Syntax

response = client.cancel_ingestion_job(
    collectionId='string',
    ingestionJobId='string',
    clientToken='string'
)
Parameters:

  • collectionId (string) –

    [REQUIRED]

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

  • ingestionJobId (string) –

    [REQUIRED]

    The unique identifier of the ingestion job to cancel.

  • 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

{
    'ingestionJobId': 'string',
    'collectionId': 'string',
    'ingestionJobName': 'string',
    'status': 'CREATING'|'ACTIVE'|'COMPLETED'|'CANCELLING'|'CANCELLED'|'FAILED'|'CREATE_FAILED'|'CANCEL_FAILED'
}

Response Structure

  • (dict) –

    • ingestionJobId (string) –

      The unique identifier of the cancelled ingestion job.

    • collectionId (string) –

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

    • ingestionJobName (string) –

      The name of the cancelled ingestion job.

    • status (string) –

      The current status of the ingestion job.

Exceptions