# DataSourceSyncJob


Provides information about a data source synchronization job.

## Contents


 ** DataSourceErrorCode **   <a name="kendra-Type-DataSourceSyncJob-DataSourceErrorCode"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** EndTime **   <a name="kendra-Type-DataSourceSyncJob-EndTime"></a>
The Unix timestamp when the synchronization job completed.  
Type: Timestamp  
Required: No

 ** ErrorCode **   <a name="kendra-Type-DataSourceSyncJob-ErrorCode"></a>
If the `Status` field is set to `FAILED`, the `ErrorCode` field indicates the reason the synchronization failed.  
Type: String  
Valid Values: `InternalError | InvalidRequest`   
Required: No

 ** ErrorMessage **   <a name="kendra-Type-DataSourceSyncJob-ErrorMessage"></a>
If the `Status` field is set to `ERROR`, the `ErrorMessage` field contains a description of the error that caused the synchronization to fail.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^\P{C}*$`   
Required: No

 ** ExecutionId **   <a name="kendra-Type-DataSourceSyncJob-ExecutionId"></a>
A identifier for the synchronization job.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** Metrics **   <a name="kendra-Type-DataSourceSyncJob-Metrics"></a>
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.  
Type: [DataSourceSyncJobMetrics](API_DataSourceSyncJobMetrics.md) object  
Required: No

 ** StartTime **   <a name="kendra-Type-DataSourceSyncJob-StartTime"></a>
The Unix timestamp when the synchronization job started.  
Type: Timestamp  
Required: No

 ** Status **   <a name="kendra-Type-DataSourceSyncJob-Status"></a>
The execution status of the synchronization job. When the `Status` field is set to `SUCCEEDED`, the synchronization job is done. If the status code is set to `FAILED`, the `ErrorCode` and `ErrorMessage` fields give you the reason for the failure.  
Type: String  
Valid Values: `FAILED | SUCCEEDED | SYNCING | INCOMPLETE | STOPPING | ABORTED | SYNCING_INDEXING`   
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/DataSourceSyncJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/DataSourceSyncJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/DataSourceSyncJob)