AgentsforBedrock / Client / start_ingestion_job

start_ingestion_job

AgentsforBedrock.Client.start_ingestion_job(**kwargs)

Start a new ingestion job

See also: AWS API Documentation

Request Syntax

response = client.start_ingestion_job(
    knowledgeBaseId='string',
    dataSourceId='string',
    clientToken='string',
    description='string'
)

Parameters:

• knowledgeBaseId (string) –

  [REQUIRED]

  Identifier for a resource.

• dataSourceId (string) –

  [REQUIRED]

  Identifier for a resource.

• clientToken (string) –

  Client specified token used for idempotency checks

  This field is autopopulated if not provided.

• description (string) – Description of the Resource.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

  • ingestionJob (dict) –

    Contains the information of an ingestion job.

    • knowledgeBaseId (string) –

      Identifier for a resource.

    • dataSourceId (string) –

      Identifier for a resource.

    • ingestionJobId (string) –

      Identifier for a resource.

    • description (string) –

      Description of the Resource.

    • status (string) –

      The status of an ingestion job.

    • statistics (dict) –

      The document level statistics of an ingestion job

      • numberOfDocumentsScanned (integer) –

        Number of scanned documents

      • numberOfNewDocumentsIndexed (integer) –

        Number of indexed documents

      • numberOfModifiedDocumentsIndexed (integer) –

        Number of modified documents indexed

      • numberOfDocumentsDeleted (integer) –

        Number of deleted documents

      • numberOfDocumentsFailed (integer) –

        Number of failed documents

    • failureReasons (list) –

      Failure Reasons for Error.

      • (string) –

        Failure Reason for Error.

    • startedAt (datetime) –

      Time Stamp.

    • updatedAt (datetime) –

      Time Stamp.

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

• AgentsforBedrock.Client.exceptions.ServiceQuotaExceededException