DataSourceSyncJob
Provides information about a data source synchronization job.
Contents
- DataSourceErrorCode
-
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
-
The Unix timestamp when the synchronization job completed.
Type: Timestamp
Required: No
- ErrorCode
-
If the
Statusfield is set toFAILED, theErrorCodefield indicates the reason the synchronization failed.Type: String
Valid Values:
InternalError | InvalidRequestRequired: No
- ErrorMessage
-
If the
Statusfield is set toERROR, theErrorMessagefield 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 identifier for the synchronization job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
- Metrics
-
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 object
Required: No
- StartTime
-
The Unix timestamp when the synchronization job started.
Type: Timestamp
Required: No
- Status
-
The execution status of the synchronization job. When the
Statusfield is set toSUCCEEDED, the synchronization job is done. If the status code is set toFAILED, theErrorCodeandErrorMessagefields give you the reason for the failure.Type: String
Valid Values:
FAILED | SUCCEEDED | SYNCING | INCOMPLETE | STOPPING | ABORTED | SYNCING_INDEXINGRequired: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
