libZSservicesZSamazonka-iot-jobs-dataplaneZSamazonka-iot-jobs-dataplane
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.IoTJobsData.Types.JobExecution

Description

 
Synopsis

Documentation

data JobExecution Source #

Contains data about a job execution.

See: newJobExecution smart constructor.

Constructors

JobExecution' 

Fields

Instances

Instances details
Eq JobExecution Source # 
Instance details

Defined in Amazonka.IoTJobsData.Types.JobExecution

Read JobExecution Source # 
Instance details

Defined in Amazonka.IoTJobsData.Types.JobExecution

Show JobExecution Source # 
Instance details

Defined in Amazonka.IoTJobsData.Types.JobExecution

Generic JobExecution Source # 
Instance details

Defined in Amazonka.IoTJobsData.Types.JobExecution

Associated Types

type Rep JobExecution :: Type -> Type #

NFData JobExecution Source # 
Instance details

Defined in Amazonka.IoTJobsData.Types.JobExecution

Methods

rnf :: JobExecution -> () #

Hashable JobExecution Source # 
Instance details

Defined in Amazonka.IoTJobsData.Types.JobExecution

FromJSON JobExecution Source # 
Instance details

Defined in Amazonka.IoTJobsData.Types.JobExecution

type Rep JobExecution Source # 
Instance details

Defined in Amazonka.IoTJobsData.Types.JobExecution

type Rep JobExecution = D1 ('MetaData "JobExecution" "Amazonka.IoTJobsData.Types.JobExecution" "libZSservicesZSamazonka-iot-jobs-dataplaneZSamazonka-iot-jobs-dataplane" 'False) (C1 ('MetaCons "JobExecution'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobExecutionStatus)) :*: S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "lastUpdatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: (S1 ('MetaSel ('Just "approximateSecondsBeforeTimedOut") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "queuedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))))) :*: ((S1 ('MetaSel ('Just "jobDocument") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "statusDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "executionNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))) :*: (S1 ('MetaSel ('Just "versionNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: (S1 ('MetaSel ('Just "startedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "thingName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newJobExecution :: JobExecution Source #

Create a value of JobExecution 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:status:JobExecution', jobExecution_status - The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS", "FAILED", "SUCCESS", "CANCELED", "REJECTED", or "REMOVED".

$sel:jobId:JobExecution', jobExecution_jobId - The unique identifier you assigned to this job when it was created.

$sel:lastUpdatedAt:JobExecution', jobExecution_lastUpdatedAt - The time, in milliseconds since the epoch, when the job execution was last updated.

$sel:approximateSecondsBeforeTimedOut:JobExecution', jobExecution_approximateSecondsBeforeTimedOut - The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT.

$sel:queuedAt:JobExecution', jobExecution_queuedAt - The time, in milliseconds since the epoch, when the job execution was enqueued.

$sel:jobDocument:JobExecution', jobExecution_jobDocument - The content of the job document.

$sel:statusDetails:JobExecution', jobExecution_statusDetails - A collection of name/value pairs that describe the status of the job execution.

$sel:executionNumber:JobExecution', jobExecution_executionNumber - A number that identifies a particular job execution on a particular device. It can be used later in commands that return or update job execution information.

$sel:versionNumber:JobExecution', jobExecution_versionNumber - The version of the job execution. Job execution versions are incremented each time they are updated by a device.

$sel:startedAt:JobExecution', jobExecution_startedAt - The time, in milliseconds since the epoch, when the job execution was started.

$sel:thingName:JobExecution', jobExecution_thingName - The name of the thing that is executing the job.

jobExecution_status :: Lens' JobExecution (Maybe JobExecutionStatus) Source #

The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS", "FAILED", "SUCCESS", "CANCELED", "REJECTED", or "REMOVED".

jobExecution_jobId :: Lens' JobExecution (Maybe Text) Source #

The unique identifier you assigned to this job when it was created.

jobExecution_lastUpdatedAt :: Lens' JobExecution (Maybe Integer) Source #

The time, in milliseconds since the epoch, when the job execution was last updated.

jobExecution_approximateSecondsBeforeTimedOut :: Lens' JobExecution (Maybe Integer) Source #

The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT.

jobExecution_queuedAt :: Lens' JobExecution (Maybe Integer) Source #

The time, in milliseconds since the epoch, when the job execution was enqueued.

jobExecution_jobDocument :: Lens' JobExecution (Maybe Text) Source #

The content of the job document.

jobExecution_statusDetails :: Lens' JobExecution (Maybe (HashMap Text Text)) Source #

A collection of name/value pairs that describe the status of the job execution.

jobExecution_executionNumber :: Lens' JobExecution (Maybe Integer) Source #

A number that identifies a particular job execution on a particular device. It can be used later in commands that return or update job execution information.

jobExecution_versionNumber :: Lens' JobExecution (Maybe Integer) Source #

The version of the job execution. Job execution versions are incremented each time they are updated by a device.

jobExecution_startedAt :: Lens' JobExecution (Maybe Integer) Source #

The time, in milliseconds since the epoch, when the job execution was started.

jobExecution_thingName :: Lens' JobExecution (Maybe Text) Source #

The name of the thing that is executing the job.