AgentsforBedrock / Paginator / ListIngestionJobs

ListIngestionJobs#

class AgentsforBedrock.Paginator.ListIngestionJobs#
paginator = client.get_paginator('list_ingestion_jobs')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from AgentsforBedrock.Client.list_ingestion_jobs().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    dataSourceId='string',
    filters=[
        {
            'attribute': 'STATUS',
            'operator': 'EQ',
            'values': [
                'string',
            ]
        },
    ],
    knowledgeBaseId='string',
    sortBy={
        'attribute': 'STATUS'|'STARTED_AT',
        'order': 'ASCENDING'|'DESCENDING'
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • dataSourceId (string) –

    [REQUIRED]

    The unique identifier of the data source for the list of data ingestion jobs.

  • filters (list) –

    Contains information about the filters for filtering the data.

    • (dict) –

      The definition of a filter to filter the data.

      • attribute (string) – [REQUIRED]

        The name of field or attribute to apply the filter.

      • operator (string) – [REQUIRED]

        The operation to apply to the field or attribute.

      • values (list) – [REQUIRED]

        A list of values that belong to the field or attribute.

        • (string) –

  • knowledgeBaseId (string) –

    [REQUIRED]

    The unique identifier of the knowledge base for the list of data ingestion jobs.

  • sortBy (dict) –

    Contains details about how to sort the data.

    • attribute (string) – [REQUIRED]

      The name of field or attribute to apply sorting of data.

    • order (string) – [REQUIRED]

      The order for sorting the data.

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'ingestionJobSummaries': [
        {
            'dataSourceId': 'string',
            'description': '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)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • ingestionJobSummaries (list) –

      A list of data ingestion jobs with information about each job.

      • (dict) –

        Contains details about a 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.

        • ingestionJobId (string) –

          The unique identifier of the data ingestion job.

        • knowledgeBaseId (string) –

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

        • startedAt (datetime) –

          The time the data ingestion job started.

        • statistics (dict) –

          Contains statistics for 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.

    • NextToken (string) –

      A token to resume pagination.