AgentsforBedrock / Client / list_ingestion_jobs

list_ingestion_jobs

AgentsforBedrock.Client.list_ingestion_jobs(**kwargs)

List ingestion jobs

See also: AWS API Documentation

Request Syntax

response = client.list_ingestion_jobs(
    knowledgeBaseId='string',
    dataSourceId='string',
    filters=[
        {
            'attribute': 'STATUS',
            'operator': 'EQ',
            'values': [
                'string',
            ]
        },
    ],
    sortBy={
        'attribute': 'STATUS'|'STARTED_AT',
        'order': 'ASCENDING'|'DESCENDING'
    },
    maxResults=123,
    nextToken='string'
)

Parameters:

• knowledgeBaseId (string) –

  [REQUIRED]

  Identifier for a resource.

• dataSourceId (string) –

  [REQUIRED]

  Identifier for a resource.

• filters (list) –

  List of IngestionJobFilters

  • (dict) –

    Filters the response returned by ListIngestionJobs operation.

    • attribute (string) – [REQUIRED]

      The name of the field to filter ingestion jobs.

    • operator (string) – [REQUIRED]

      The operator used to filter ingestion jobs.

    • values (list) – [REQUIRED]

      The list of values used to filter ingestion jobs.

      • (string) –

        The value used to filter ingestion jobs.

• sortBy (dict) –

  Sorts the response returned by ListIngestionJobs operation.

  • attribute (string) – [REQUIRED]

    The name of the field to sort ingestion jobs.

  • order (string) – [REQUIRED]

    Order to sort results by.

• maxResults (integer) – Max Results.

• nextToken (string) – Opaque continuation token of previous paginated response.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

  • ingestionJobSummaries (list) –

    List of IngestionJobSummaries

    • (dict) –

      Summary 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.

      • startedAt (datetime) –

        Time Stamp.

      • updatedAt (datetime) –

        Time Stamp.

      • 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

  • nextToken (string) –

    Opaque continuation token of previous paginated response.

Exceptions

• AgentsforBedrock.Client.exceptions.ThrottlingException

• AgentsforBedrock.Client.exceptions.AccessDeniedException

• AgentsforBedrock.Client.exceptions.ValidationException

• AgentsforBedrock.Client.exceptions.InternalServerException

• AgentsforBedrock.Client.exceptions.ResourceNotFoundException