Skip to content

QBusiness  >  Structures  >  DataSourceSyncJob

DataSourceSyncJob

Structure Class

DataSourceSyncJob dataclass

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

Attributes

data_source_error_code class-attribute instance-attribute 
data_source_error_code: str | None = None

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 class-attribute instance-attribute 
end_time: datetime | None = None

The Unix timestamp when the synchronization job completed.

error class-attribute instance-attribute 
error: ErrorDetail | None = None

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

execution_id class-attribute instance-attribute 
execution_id: str | None = None

The identifier of a data source synchronization job.

metrics class-attribute instance-attribute 
metrics: DataSourceSyncJobMetrics | None = None

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 class-attribute instance-attribute 
start_time: datetime | None = None

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

status class-attribute instance-attribute 
status: str | None = None

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.