Amazonka.Kendra.Types.DataSourceSyncJob

Documentation

data DataSourceSyncJob

Provides information about a data source synchronization job.

See: newDataSourceSyncJob smart constructor.

Constructors

DataSourceSyncJob'

Fields

• dataSourceErrorCode :: Maybe Text

  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.

• endTime :: Maybe POSIX

  The UNIX datetime that the synchronization job completed.

• errorCode :: Maybe ErrorCode

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

• errorMessage :: Maybe Text

  If the Status field is set to ERROR, the ErrorMessage field contains a description of the error that caused the synchronization to fail.

• executionId :: Maybe Text

  A identifier for the synchronization job.

• metrics :: Maybe 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.

• startTime :: Maybe POSIX

  The UNIX datetime that the synchronization job started.

• status :: Maybe DataSourceSyncJobStatus

  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.

Instances

FromJSON DataSourceSyncJob

Defined in Amazonka.Kendra.Types.DataSourceSyncJob

Methods

parseJSON :: Value -> Parser DataSourceSyncJob

parseJSONList :: Value -> Parser [DataSourceSyncJob]

Generic DataSourceSyncJob

Defined in Amazonka.Kendra.Types.DataSourceSyncJob

Associated Types

type Rep DataSourceSyncJob :: Type -> Type

Methods

from :: DataSourceSyncJob -> Rep DataSourceSyncJob x

to :: Rep DataSourceSyncJob x -> DataSourceSyncJob

Read DataSourceSyncJob

Defined in Amazonka.Kendra.Types.DataSourceSyncJob

Methods

readsPrec :: Int -> ReadS DataSourceSyncJob

readList :: ReadS [DataSourceSyncJob]

readPrec :: ReadPrec DataSourceSyncJob

readListPrec :: ReadPrec [DataSourceSyncJob]

Show DataSourceSyncJob

Defined in Amazonka.Kendra.Types.DataSourceSyncJob

Methods

showsPrec :: Int -> DataSourceSyncJob -> ShowS

show :: DataSourceSyncJob -> String

showList :: [DataSourceSyncJob] -> ShowS

NFData DataSourceSyncJob

Defined in Amazonka.Kendra.Types.DataSourceSyncJob

Methods

rnf :: DataSourceSyncJob -> ()

Eq DataSourceSyncJob

Defined in Amazonka.Kendra.Types.DataSourceSyncJob

Methods

(==) :: DataSourceSyncJob -> DataSourceSyncJob -> Bool

(/=) :: DataSourceSyncJob -> DataSourceSyncJob -> Bool

Hashable DataSourceSyncJob

Defined in Amazonka.Kendra.Types.DataSourceSyncJob

Methods

hashWithSalt :: Int -> DataSourceSyncJob -> Int

hash :: DataSourceSyncJob -> Int

type Rep DataSourceSyncJob

Defined in Amazonka.Kendra.Types.DataSourceSyncJob

type Rep DataSourceSyncJob = D1 ('MetaData "DataSourceSyncJob" "Amazonka.Kendra.Types.DataSourceSyncJob" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DataSourceSyncJob'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "dataSourceErrorCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "errorCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ErrorCode)) :*: S1 ('MetaSel ('Just "errorMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "executionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "metrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSourceSyncJobMetrics))) :*: (S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSourceSyncJobStatus))))))

newDataSourceSyncJob :: DataSourceSyncJob

Create a value of DataSourceSyncJob with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dataSourceErrorCode:DataSourceSyncJob', dataSourceSyncJob_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.

$sel:endTime:DataSourceSyncJob', dataSourceSyncJob_endTime - The UNIX datetime that the synchronization job completed.

$sel:errorCode:DataSourceSyncJob', dataSourceSyncJob_errorCode - If the Status field is set to FAILED, the ErrorCode field indicates the reason the synchronization failed.

$sel:errorMessage:DataSourceSyncJob', dataSourceSyncJob_errorMessage - If the Status field is set to ERROR, the ErrorMessage field contains a description of the error that caused the synchronization to fail.

$sel:executionId:DataSourceSyncJob', dataSourceSyncJob_executionId - A identifier for the synchronization job.

$sel:metrics:DataSourceSyncJob', dataSourceSyncJob_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.

$sel:startTime:DataSourceSyncJob', dataSourceSyncJob_startTime - The UNIX datetime that the synchronization job started.

$sel:status:DataSourceSyncJob', dataSourceSyncJob_status - 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.

dataSourceSyncJob_dataSourceErrorCode :: Lens' DataSourceSyncJob (Maybe Text)

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.

dataSourceSyncJob_endTime :: Lens' DataSourceSyncJob (Maybe UTCTime)

The UNIX datetime that the synchronization job completed.

dataSourceSyncJob_errorCode :: Lens' DataSourceSyncJob (Maybe ErrorCode)

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

dataSourceSyncJob_errorMessage :: Lens' DataSourceSyncJob (Maybe Text)

If the Status field is set to ERROR, the ErrorMessage field contains a description of the error that caused the synchronization to fail.

dataSourceSyncJob_executionId :: Lens' DataSourceSyncJob (Maybe Text)

A identifier for the synchronization job.

dataSourceSyncJob_metrics :: Lens' DataSourceSyncJob (Maybe 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.

dataSourceSyncJob_startTime :: Lens' DataSourceSyncJob (Maybe UTCTime)

The UNIX datetime that the synchronization job started.

dataSourceSyncJob_status :: Lens' DataSourceSyncJob (Maybe DataSourceSyncJobStatus)

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.