You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::Kendra::Types::DataSourceSyncJob
- Inherits:
-
Struct
- Object
- Struct
- Aws::Kendra::Types::DataSourceSyncJob
- Defined in:
- (unknown)
Overview
Provides information about a synchronization job.
Instance Attribute Summary collapse
-
#data_source_error_code ⇒ String
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 ⇒ Time
The UNIX datetime that the synchronization job was completed.
-
#error_code ⇒ String
If the
Status
field is set toFAILED
, theErrorCode
field contains a the reason that the synchronization failed. -
#error_message ⇒ String
If the
Status
field is set toERROR
, theErrorMessage
field contains a description of the error that caused the synchronization to fail. -
#execution_id ⇒ String
A unique identifier for the synchronization job.
-
#metrics ⇒ Types::DataSourceSyncJobMetrics
Maps a batch delete document request to a specific data source sync job.
-
#start_time ⇒ Time
The UNIX datetime that the synchronization job was started.
-
#status ⇒ String
The execution status of the synchronization job.
Instance Attribute Details
#data_source_error_code ⇒ String
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 ⇒ Time
The UNIX datetime that the synchronization job was completed.
#error_code ⇒ String
If the Status
field is set to FAILED
, the ErrorCode
field contains
a the reason that the synchronization failed.
Possible values:
- InternalError
- InvalidRequest
#error_message ⇒ String
If the Status
field is set to ERROR
, the ErrorMessage
field
contains a description of the error that caused the synchronization to
fail.
#execution_id ⇒ String
A unique identifier for the synchronization job.
#metrics ⇒ Types::DataSourceSyncJobMetrics
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 ⇒ Time
The UNIX datetime that the synchronization job was started.
#status ⇒ String
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.
Possible values:
- FAILED
- SUCCEEDED
- SYNCING
- INCOMPLETE
- STOPPING
- ABORTED
- SYNCING_INDEXING