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( knowledgeBaseId='string', dataSourceId='string', filters=[ { 'attribute': 'STATUS', 'operator': 'EQ', 'values': [ 'string', ] }, ], sortBy={ 'attribute': 'STATUS'|'STARTED_AT', 'order': 'ASCENDING'|'DESCENDING' }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': '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.
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': [ { '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) –
A token to resume pagination.