QBusiness / Client / list_data_source_sync_jobs
list_data_source_sync_jobs#
- QBusiness.Client.list_data_source_sync_jobs(**kwargs)#
Get information about an Amazon Q Business data source connector synchronization.
See also: AWS API Documentation
Request Syntax
response = client.list_data_source_sync_jobs( applicationId='string', dataSourceId='string', endTime=datetime(2015, 1, 1), indexId='string', maxResults=123, nextToken='string', startTime=datetime(2015, 1, 1), statusFilter='FAILED'|'SUCCEEDED'|'SYNCING'|'INCOMPLETE'|'STOPPING'|'ABORTED'|'SYNCING_INDEXING' )
- Parameters:
applicationId (string) –
[REQUIRED]
The identifier of the Amazon Q Business application connected to the data source.
dataSourceId (string) –
[REQUIRED]
The identifier of the data source connector.
endTime (datetime) – The end time of the data source connector sync.
indexId (string) –
[REQUIRED]
The identifier of the index used with the Amazon Q Business data source connector.
maxResults (integer) – The maximum number of synchronization jobs to return in the response.
nextToken (string) – If the
maxResults
response was incpmplete because there is more data to retriever, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of responses.startTime (datetime) – The start time of the data source connector sync.
statusFilter (string) – Only returns synchronization jobs with the
Status
field equal to the specified status.
- Return type:
dict
- Returns:
Response Syntax
{ 'history': [ { 'dataSourceErrorCode': 'string', 'endTime': datetime(2015, 1, 1), 'error': { 'errorCode': 'InternalError'|'InvalidRequest'|'ResourceInactive'|'ResourceNotFound', 'errorMessage': 'string' }, 'executionId': 'string', 'metrics': { 'documentsAdded': 'string', 'documentsDeleted': 'string', 'documentsFailed': 'string', 'documentsModified': 'string', 'documentsScanned': 'string' }, 'startTime': datetime(2015, 1, 1), 'status': 'FAILED'|'SUCCEEDED'|'SYNCING'|'INCOMPLETE'|'STOPPING'|'ABORTED'|'SYNCING_INDEXING' }, ], '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.
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.
endTime (datetime) –
The Unix timestamp when the synchronization job completed.
error (dict) –
If the
Status
field is set toFAILED
, theErrorCode
field indicates the reason the synchronization failed.errorCode (string) –
The code associated with the data source sync error.
errorMessage (string) –
The message explaining the data source sync error.
executionId (string) –
The identifier of a data source synchronization job.
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.
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.
documentsModified (string) –
The current count of documents modified in 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.
startTime (datetime) –
The Unix time stamp when the data source synchronization job started.
status (string) –
The status of the synchronization job. When the
Status
field is set toSUCCEEDED
, the synchronization job is done. If the status code isFAILED
, theErrorCode
andErrorMessage
fields give you the reason for the failure.
nextToken (string) –
If the response is truncated, Amazon Q Business returns this token. You can use this token in any subsequent request to retrieve the next set of jobs.
Exceptions