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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-kendra/types.rb

Overview

Provides information about a synchronization job.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#data_source_error_codeString

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)

2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
# File 'lib/aws-sdk-kendra/types.rb', line 2479

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_timeTime

The UNIX datetime that the synchronization job was completed.

Returns:

  • (Time)

2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
# File 'lib/aws-sdk-kendra/types.rb', line 2479

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_codeString

If the `Status` field is set to `FAILED`, the `ErrorCode` field contains a the reason that the synchronization failed.

Returns:

  • (String)

2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
# File 'lib/aws-sdk-kendra/types.rb', line 2479

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_messageString

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)

2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
# File 'lib/aws-sdk-kendra/types.rb', line 2479

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_idString

A unique identifier for the synchronization job.

Returns:

  • (String)

2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
# File 'lib/aws-sdk-kendra/types.rb', line 2479

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

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


2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
# File 'lib/aws-sdk-kendra/types.rb', line 2479

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_timeTime

The UNIX datetime that the synchronization job was started.

Returns:

  • (Time)

2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
# File 'lib/aws-sdk-kendra/types.rb', line 2479

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

#statusString

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)

2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
# File 'lib/aws-sdk-kendra/types.rb', line 2479

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