:doc:`AgentsforBedrock <../../bedrock-agent>` / Paginator / ListIngestionJobs

*****************
ListIngestionJobs
*****************



.. py:class:: AgentsforBedrock.Paginator.ListIngestionJobs

  ::

    
    paginator = client.get_paginator('list_ingestion_jobs')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`AgentsforBedrock.Client.list_ingestion_jobs`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListIngestionJobs>`_    


    **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'
          }
      )
      
    :type knowledgeBaseId: string
    :param knowledgeBaseId: **[REQUIRED]** 

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

      

    
    :type dataSourceId: string
    :param dataSourceId: **[REQUIRED]** 

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

      

    
    :type filters: list
    :param filters: 

      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) --* 

          
      
      
  
    :type sortBy: dict
    :param sortBy: 

      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.

        

      
    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'ingestionJobSummaries': [
                {
                    'knowledgeBaseId': 'string',
                    'dataSourceId': 'string',
                    'ingestionJobId': 'string',
                    'description': 'string',
                    'status': 'STARTING'|'IN_PROGRESS'|'COMPLETE'|'FAILED'|'STOPPING'|'STOPPED',
                    'startedAt': datetime(2015, 1, 1),
                    'updatedAt': datetime(2015, 1, 1),
                    'statistics': {
                        'numberOfDocumentsScanned': 123,
                        'numberOfMetadataDocumentsScanned': 123,
                        'numberOfNewDocumentsIndexed': 123,
                        'numberOfModifiedDocumentsIndexed': 123,
                        'numberOfMetadataDocumentsModified': 123,
                        'numberOfDocumentsDeleted': 123,
                        'numberOfDocumentsFailed': 123
                    }
                },
            ],
            '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.

            
            

            - **knowledgeBaseId** *(string) --* 

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

              
            

            - **dataSourceId** *(string) --* 

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

              
            

            - **ingestionJobId** *(string) --* 

              The unique identifier of the data ingestion job.

              
            

            - **description** *(string) --* 

              The description of the data ingestion job.

              
            

            - **status** *(string) --* 

              The status of the data ingestion job.

              
            

            - **startedAt** *(datetime) --* 

              The time the data ingestion job started.

              
            

            - **updatedAt** *(datetime) --* 

              The time the data ingestion job was last updated.

              
            

            - **statistics** *(dict) --* 

              Contains statistics for the data ingestion job.

              
              

              - **numberOfDocumentsScanned** *(integer) --* 

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

                
              

              - **numberOfMetadataDocumentsScanned** *(integer) --* 

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

                
              

              - **numberOfNewDocumentsIndexed** *(integer) --* 

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

                
              

              - **numberOfModifiedDocumentsIndexed** *(integer) --* 

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

                
              

              - **numberOfMetadataDocumentsModified** *(integer) --* 

                The number of metadata files that were updated or deleted.

                
              

              - **numberOfDocumentsDeleted** *(integer) --* 

                The number of source documents that were deleted.

                
              

              - **numberOfDocumentsFailed** *(integer) --* 

                The number of source documents that failed to be ingested.

                
          
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    