AgentsforBedrock / Client / stop_ingestion_job

stop_ingestion_job

AgentsforBedrock.Client.stop_ingestion_job(**kwargs)

Stops a currently running data ingestion job. You can send a StartIngestionJob request again to ingest the rest of your data when you are ready.

See also: AWS API Documentation

Request Syntax

response = client.stop_ingestion_job(
    dataSourceId='string',
    ingestionJobId='string',
    knowledgeBaseId='string'
)

Parameters:

• dataSourceId (string) –

  [REQUIRED]

  The unique identifier of the data source for the data ingestion job you want to stop.

• ingestionJobId (string) –

  [REQUIRED]

  The unique identifier of the data ingestion job you want to stop.

• knowledgeBaseId (string) –

  [REQUIRED]

  The unique identifier of the knowledge base for the data ingestion job you want to stop.

Return type:

dict

Returns:

Response Syntax

{
    'ingestionJob': {
        'dataSourceId': 'string',
        'description': 'string',
        'failureReasons': [
            'string',
        ],
        'ingestionJobId': 'string',
        'knowledgeBaseId': 'string',
        'startedAt': datetime(2015, 1, 1),
        'statistics': {
            'numberOfDocumentsDeleted': 123,
            'numberOfDocumentsFailed': 123,
            'numberOfDocumentsScanned': 123,
            'numberOfMetadataDocumentsModified': 123,
            'numberOfMetadataDocumentsScanned': 123,
            'numberOfModifiedDocumentsIndexed': 123,
            'numberOfNewDocumentsIndexed': 123
        },
        'status': 'STARTING'|'IN_PROGRESS'|'COMPLETE'|'FAILED'|'STOPPING'|'STOPPED',
        'updatedAt': datetime(2015, 1, 1)
    }
}

Response Structure

• (dict) –

  • ingestionJob (dict) –

    Contains information about the stopped data ingestion job.

    • dataSourceId (string) –

      The unique identifier of the data source for the data ingestion job.

    • description (string) –

      The description of the data ingestion job.

    • failureReasons (list) –

      A list of reasons that the data ingestion job failed.

      • (string) –

    • ingestionJobId (string) –

      The unique identifier of the data ingestion job.

    • knowledgeBaseId (string) –

      The unique identifier of the knowledge for the data ingestion job.

    • startedAt (datetime) –

      The time the data ingestion job started.

      If you stop a data ingestion job, the startedAt time is the time the job was started before the job was stopped.

    • statistics (dict) –

      Contains statistics about the data ingestion job.

      • numberOfDocumentsDeleted (integer) –

        The number of source documents that were deleted.

      • numberOfDocumentsFailed (integer) –

        The number of source documents that failed to be ingested.

      • numberOfDocumentsScanned (integer) –

        The total number of source documents that were scanned. Includes new, updated, and unchanged documents.

      • numberOfMetadataDocumentsModified (integer) –

        The number of metadata files that were updated or deleted.

      • numberOfMetadataDocumentsScanned (integer) –

        The total number of metadata files that were scanned. Includes new, updated, and unchanged files.

      • numberOfModifiedDocumentsIndexed (integer) –

        The number of modified source documents in the data source that were successfully indexed.

      • numberOfNewDocumentsIndexed (integer) –

        The number of new source documents in the data source that were successfully indexed.

    • status (string) –

      The status of the data ingestion job.

    • updatedAt (datetime) –

      The time the data ingestion job was last updated.

      If you stop a data ingestion job, the updatedAt time is the time the job was stopped.

Exceptions

• AgentsforBedrock.Client.exceptions.ThrottlingException

• AgentsforBedrock.Client.exceptions.AccessDeniedException

• AgentsforBedrock.Client.exceptions.ValidationException

• AgentsforBedrock.Client.exceptions.InternalServerException

• AgentsforBedrock.Client.exceptions.ResourceNotFoundException

• AgentsforBedrock.Client.exceptions.ConflictException