data_source_sync_jobs

Creates, updates, deletes, gets or lists a data_source_sync_jobs resource.

Overview

Name	data_source_sync_jobs
Type	Resource
Id	aws.qbusiness.data_source_sync_jobs

Fields

The following fields are returned by SELECT queries:

list_data_source_sync_jobs

Name	Datatype	Description
data_source_error_code	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.
end_time	string (date-time)	The Unix timestamp when the synchronization job completed.
error	object	Provides information about a Amazon Q Business request error.
execution_id	string	The identifier of a data source synchronization job. (pattern: <code>[a-zA-Z0-9][a-zA-Z0-9-]{35}</code>)
metrics	object	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.
start_time	string (date-time)	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 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. (FAILED, SUCCEEDED, SYNCING, INCOMPLETE, STOPPING, ABORTED, SYNCING_INDEXING)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_data_source_sync_jobs	select	data_source_id, application_id, index_id, region	nextToken, maxResults, startTime, endTime, syncStatus	Get information about an Amazon Q Business data source connector synchronization.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
application_id	string	The identifier of the Amazon Q Business application connected to the data source.
data_source_id	string	The identifier of the data source connector.
index_id	string	The identifier of the index used with the Amazon Q Business data source connector.
region	string	AWS region (default: us-east-1)
endTime	string (date-time)	The end time of the data source connector sync.
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	string (date-time)	The start time of the data source connector sync.
syncStatus	string	Only returns synchronization jobs with the Status field equal to the specified status.

SELECT examples

list_data_source_sync_jobs

Get information about an Amazon Q Business data source connector synchronization.

SELECT
data_source_error_code,
end_time,
error,
execution_id,
metrics,
start_time,
status
FROM aws.qbusiness.data_source_sync_jobs
WHERE data_source_id = '{{ data_source_id }}' -- required
AND application_id = '{{ application_id }}' -- required
AND index_id = '{{ index_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
AND startTime = '{{ startTime }}'
AND endTime = '{{ endTime }}'
AND syncStatus = '{{ syncStatus }}'
;