DataSourceSyncJob ¶

class DataSourceSyncJob(TypedDict, closed=True):
    execution_id: NotRequired["capo_kendra.types.string.String"]
    """<p>A identifier for the synchronization job.</p>"""
    start_time: NotRequired["capo_kendra.types.timestamp.Timestamp"]
    """<p>The Unix timestamp when the synchronization job started.</p>"""
    end_time: NotRequired["capo_kendra.types.timestamp.Timestamp"]
    """<p>The Unix timestamp when the synchronization job completed.</p>"""
    status: NotRequired[
        "capo_kendra.types.data_source_sync_job_status.DataSourceSyncJobStatus"
    ]
    """<p>The execution status of the synchronization job. When the <code>Status</code> field is set to <code>SUCCEEDED</code>, the synchronization job is done. If the status code is set to <code>FAILED</code>, the <code>ErrorCode</code> and <code>ErrorMessage</code> fields give you the reason for the failure.</p>"""
    error_message: NotRequired["capo_kendra.types.error_message.ErrorMessage"]
    """<p>If the <code>Status</code> field is set to <code>ERROR</code>, the <code>ErrorMessage</code> field contains a description of the error that caused the synchronization to fail.</p>"""
    error_code: NotRequired["capo_kendra.types.error_code.ErrorCode"]
    """<p>If the <code>Status</code> field is set to <code>FAILED</code>, the <code>ErrorCode</code> field indicates the reason the synchronization failed.</p>"""
    data_source_error_code: NotRequired["capo_kendra.types.string.String"]
    """<p>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.</p>"""
    metrics: NotRequired[
        "capo_kendra.types.data_source_sync_job_metrics.DataSourceSyncJobMetrics"
    ]
    """<p>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.</p>"""