:doc:`QBusiness <../../qbusiness>` / Paginator / ListDataSourceSyncJobs

**********************
ListDataSourceSyncJobs
**********************



.. py:class:: QBusiness.Paginator.ListDataSourceSyncJobs

  ::

    
    paginator = client.get_paginator('list_data_source_sync_jobs')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`QBusiness.Client.list_data_source_sync_jobs`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListDataSourceSyncJobs>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          dataSourceId='string',
          applicationId='string',
          indexId='string',
          startTime=datetime(2015, 1, 1),
          endTime=datetime(2015, 1, 1),
          statusFilter='FAILED'|'SUCCEEDED'|'SYNCING'|'INCOMPLETE'|'STOPPING'|'ABORTED'|'SYNCING_INDEXING',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type dataSourceId: string
    :param dataSourceId: **[REQUIRED]** 

      The identifier of the data source connector.

      

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

      The identifier of the Amazon Q Business application connected to the data source.

      

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

      The identifier of the index used with the Amazon Q Business data source connector.

      

    
    :type startTime: datetime
    :param startTime: 

      The start time of the data source connector sync.

      

    
    :type endTime: datetime
    :param endTime: 

      The end time of the data source connector sync.

      

    
    :type statusFilter: string
    :param statusFilter: 

      Only returns synchronization jobs with the ``Status`` field equal to the specified status.

      

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

      
      ::

        {
            'history': [
                {
                    'executionId': 'string',
                    'startTime': datetime(2015, 1, 1),
                    'endTime': datetime(2015, 1, 1),
                    'status': 'FAILED'|'SUCCEEDED'|'SYNCING'|'INCOMPLETE'|'STOPPING'|'ABORTED'|'SYNCING_INDEXING',
                    'error': {
                        'errorMessage': 'string',
                        'errorCode': 'InternalError'|'InvalidRequest'|'ResourceInactive'|'ResourceNotFound'
                    },
                    'dataSourceErrorCode': 'string',
                    'metrics': {
                        'documentsAdded': 'string',
                        'documentsModified': 'string',
                        'documentsDeleted': 'string',
                        'documentsFailed': 'string',
                        'documentsScanned': 'string'
                    }
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **history** *(list) --* 

          A history of synchronization jobs for the data source connector.

          
          

          - *(dict) --* 

            Provides information about an Amazon Q Business data source connector synchronization job.

            
            

            - **executionId** *(string) --* 

              The identifier of a data source synchronization job.

              
            

            - **startTime** *(datetime) --* 

              The Unix time stamp when the data source synchronization job started.

              
            

            - **endTime** *(datetime) --* 

              The Unix timestamp when the synchronization job completed.

              
            

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

              The status of the synchronization job. When the ``Status`` field is set to ``SUCCEEDED``, the synchronization job is done. If the status code is ``FAILED``, the ``ErrorCode`` and ``ErrorMessage`` fields give you the reason for the failure.

              
            

            - **error** *(dict) --* 

              If the ``Status`` field is set to ``FAILED``, the ``ErrorCode`` field indicates the reason the synchronization failed.

              
              

              - **errorMessage** *(string) --* 

                The message explaining the Amazon Q Business request error.

                
              

              - **errorCode** *(string) --* 

                The code associated with the Amazon Q Business request error.

                
          
            

            - **dataSourceErrorCode** *(string) --* 

              If the reason that the synchronization failed is due to an error with the underlying data source, this field contains a code that identifies the error.

              
            

            - **metrics** *(dict) --* 

              Maps a batch delete document request to a specific data source sync job. This is optional and should only be supplied when documents are deleted by a data source connector.

              
              

              - **documentsAdded** *(string) --* 

                The current count of documents added from the data source during the data source sync.

                
              

              - **documentsModified** *(string) --* 

                The current count of documents modified in the data source during the data source sync.

                
              

              - **documentsDeleted** *(string) --* 

                The current count of documents deleted from the data source during the data source sync.

                
              

              - **documentsFailed** *(string) --* 

                The current count of documents that failed to sync from the data source during the data source sync.

                
              

              - **documentsScanned** *(string) --* 

                The current count of documents crawled by the ongoing sync job in the data source.

                
          
        
      
        

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

          A token to resume pagination.

          
    