DataSourceSyncJob¶
Structure Class¶
dataclass
¶
Provides information about an Amazon Q Business data source connector synchronization job.
Attributes¶
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.
class-attribute
instance-attribute
¶
end_time: datetime | None = None
The Unix timestamp when the synchronization job completed.
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.
class-attribute
instance-attribute
¶
execution_id: str | None = None
The identifier of a data source synchronization job.
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.
class-attribute
instance-attribute
¶
start_time: datetime | None = None
The Unix time stamp when the data source synchronization job started.
class-attribute
instance-attribute
¶
status: DataSourceSyncJobStatus | 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.