Class: Aws::Kendra::Types::DataSourceSyncJob

Inherits:

Struct

• Object
• Struct
• Aws::Kendra::Types::DataSourceSyncJob

Defined in:

gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb

Overview

Provides information about a data source synchronization job.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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 timestamp when the synchronization job completed.

• #error_code ⇒ String

  If the Status field is set to FAILED, the ErrorCode field indicates the reason the synchronization failed.

• #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 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 timestamp when the synchronization job 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.

Returns:

• (String)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3031

class DataSourceSyncJob < Struct.new(
  :execution_id,
  :start_time,
  :end_time,
  :status,
  :error_message,
  :error_code,
  :data_source_error_code,
  :metrics)
  SENSITIVE = []
  include Aws::Structure
end

#end_time ⇒ Time

The Unix timestamp when the synchronization job completed.

Returns:

• (Time)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3031

class DataSourceSyncJob < Struct.new(
  :execution_id,
  :start_time,
  :end_time,
  :status,
  :error_message,
  :error_code,
  :data_source_error_code,
  :metrics)
  SENSITIVE = []
  include Aws::Structure
end

#error_code ⇒ String

If the Status field is set to FAILED, the ErrorCode field indicates the reason the synchronization failed.

Returns:

• (String)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3031

class DataSourceSyncJob < Struct.new(
  :execution_id,
  :start_time,
  :end_time,
  :status,
  :error_message,
  :error_code,
  :data_source_error_code,
  :metrics)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

• (String)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3031

class DataSourceSyncJob < Struct.new(
  :execution_id,
  :start_time,
  :end_time,
  :status,
  :error_message,
  :error_code,
  :data_source_error_code,
  :metrics)
  SENSITIVE = []
  include Aws::Structure
end

#execution_id ⇒ String

A identifier for the synchronization job.

Returns:

• (String)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3031

class DataSourceSyncJob < Struct.new(
  :execution_id,
  :start_time,
  :end_time,
  :status,
  :error_message,
  :error_code,
  :data_source_error_code,
  :metrics)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

• (Types::DataSourceSyncJobMetrics)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3031

class DataSourceSyncJob < Struct.new(
  :execution_id,
  :start_time,
  :end_time,
  :status,
  :error_message,
  :error_code,
  :data_source_error_code,
  :metrics)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

The Unix timestamp when the synchronization job started.

Returns:

• (Time)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3031

class DataSourceSyncJob < Struct.new(
  :execution_id,
  :start_time,
  :end_time,
  :status,
  :error_message,
  :error_code,
  :data_source_error_code,
  :metrics)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

• (String)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3031

class DataSourceSyncJob < Struct.new(
  :execution_id,
  :start_time,
  :end_time,
  :status,
  :error_message,
  :error_code,
  :data_source_error_code,
  :metrics)
  SENSITIVE = []
  include Aws::Structure
end