Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.IoTJobsData.Types

Contents

Service Configuration
Errors
JobExecutionStatus
JobExecution
JobExecutionState
JobExecutionSummary

Description

Synopsis

defaultService :: Service
_TerminalStateException :: AsError a => Getting (First ServiceError) a ServiceError
_InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError
_CertificateValidationException :: AsError a => Getting (First ServiceError) a ServiceError
_ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError
_ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError
_InvalidStateTransitionException :: AsError a => Getting (First ServiceError) a ServiceError
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
newtype JobExecutionStatus where
- JobExecutionStatus' {
  - fromJobExecutionStatus :: Text
  }
- pattern JobExecutionStatus_CANCELED :: JobExecutionStatus
- pattern JobExecutionStatus_FAILED :: JobExecutionStatus
- pattern JobExecutionStatus_IN_PROGRESS :: JobExecutionStatus
- pattern JobExecutionStatus_QUEUED :: JobExecutionStatus
- pattern JobExecutionStatus_REJECTED :: JobExecutionStatus
- pattern JobExecutionStatus_REMOVED :: JobExecutionStatus
- pattern JobExecutionStatus_SUCCEEDED :: JobExecutionStatus
- pattern JobExecutionStatus_TIMED_OUT :: JobExecutionStatus
data JobExecution = JobExecution' {
- status :: Maybe JobExecutionStatus
- jobId :: Maybe Text
- lastUpdatedAt :: Maybe Integer
- approximateSecondsBeforeTimedOut :: Maybe Integer
- queuedAt :: Maybe Integer
- jobDocument :: Maybe Text
- statusDetails :: Maybe (HashMap Text Text)
- executionNumber :: Maybe Integer
- versionNumber :: Maybe Integer
- startedAt :: Maybe Integer
- thingName :: Maybe Text
}
newJobExecution :: JobExecution
jobExecution_status :: Lens' JobExecution (Maybe JobExecutionStatus)
jobExecution_jobId :: Lens' JobExecution (Maybe Text)
jobExecution_lastUpdatedAt :: Lens' JobExecution (Maybe Integer)
jobExecution_approximateSecondsBeforeTimedOut :: Lens' JobExecution (Maybe Integer)
jobExecution_queuedAt :: Lens' JobExecution (Maybe Integer)
jobExecution_jobDocument :: Lens' JobExecution (Maybe Text)
jobExecution_statusDetails :: Lens' JobExecution (Maybe (HashMap Text Text))
jobExecution_executionNumber :: Lens' JobExecution (Maybe Integer)
jobExecution_versionNumber :: Lens' JobExecution (Maybe Integer)
jobExecution_startedAt :: Lens' JobExecution (Maybe Integer)
jobExecution_thingName :: Lens' JobExecution (Maybe Text)
data JobExecutionState = JobExecutionState' {
- status :: Maybe JobExecutionStatus
- statusDetails :: Maybe (HashMap Text Text)
- versionNumber :: Maybe Integer
}
newJobExecutionState :: JobExecutionState
jobExecutionState_status :: Lens' JobExecutionState (Maybe JobExecutionStatus)
jobExecutionState_statusDetails :: Lens' JobExecutionState (Maybe (HashMap Text Text))
jobExecutionState_versionNumber :: Lens' JobExecutionState (Maybe Integer)
data JobExecutionSummary = JobExecutionSummary' {
- jobId :: Maybe Text
- lastUpdatedAt :: Maybe Integer
- queuedAt :: Maybe Integer
- executionNumber :: Maybe Integer
- versionNumber :: Maybe Integer
- startedAt :: Maybe Integer
}
newJobExecutionSummary :: JobExecutionSummary
jobExecutionSummary_jobId :: Lens' JobExecutionSummary (Maybe Text)
jobExecutionSummary_lastUpdatedAt :: Lens' JobExecutionSummary (Maybe Integer)
jobExecutionSummary_queuedAt :: Lens' JobExecutionSummary (Maybe Integer)
jobExecutionSummary_executionNumber :: Lens' JobExecutionSummary (Maybe Integer)
jobExecutionSummary_versionNumber :: Lens' JobExecutionSummary (Maybe Integer)
jobExecutionSummary_startedAt :: Lens' JobExecutionSummary (Maybe Integer)

Service Configuration

defaultService :: Service Source #

API version 2017-09-29 of the Amazon IoT Jobs Data Plane SDK configuration.

Errors

_TerminalStateException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The job is in a terminal state.

_InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The contents of the request were invalid. For example, this code is returned when an UpdateJobExecution request contains invalid status details. The message contains details about the error.

_CertificateValidationException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The certificate is invalid.

_ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The rate exceeds the limit.

_ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The service is temporarily unavailable.

_InvalidStateTransitionException :: AsError a => Getting (First ServiceError) a ServiceError Source #

An update attempted to change the job execution to a state that is invalid because of the job execution's current state (for example, an attempt to change a request in state SUCCESS to state IN_PROGRESS). In this case, the body of the error message also contains the executionState field.

_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The specified resource does not exist.

JobExecutionStatus

newtype JobExecutionStatus Source #

Constructors

JobExecutionStatus'
Fields fromJobExecutionStatus :: Text

Bundled Patterns

pattern JobExecutionStatus_CANCELED :: JobExecutionStatus
pattern JobExecutionStatus_FAILED :: JobExecutionStatus
pattern JobExecutionStatus_IN_PROGRESS :: JobExecutionStatus
pattern JobExecutionStatus_QUEUED :: JobExecutionStatus
pattern JobExecutionStatus_REJECTED :: JobExecutionStatus
pattern JobExecutionStatus_REMOVED :: JobExecutionStatus
pattern JobExecutionStatus_SUCCEEDED :: JobExecutionStatus
pattern JobExecutionStatus_TIMED_OUT :: JobExecutionStatus

Instances

Instances details

Eq JobExecutionStatus Source #
Instance details Defined in Amazonka.IoTJobsData.Types.JobExecutionStatus Methods (==) :: JobExecutionStatus -> JobExecutionStatus -> Bool # (/=) :: JobExecutionStatus -> JobExecutionStatus -> Bool #
Ord JobExecutionStatus Source #
Instance details Defined in Amazonka.IoTJobsData.Types.JobExecutionStatus Methods compare :: JobExecutionStatus -> JobExecutionStatus -> Ordering # (<) :: JobExecutionStatus -> JobExecutionStatus -> Bool # (<=) :: JobExecutionStatus -> JobExecutionStatus -> Bool # (>) :: JobExecutionStatus -> JobExecutionStatus -> Bool # (>=) :: JobExecutionStatus -> JobExecutionStatus -> Bool # max :: JobExecutionStatus -> JobExecutionStatus -> JobExecutionStatus # min :: JobExecutionStatus -> JobExecutionStatus -> JobExecutionStatus #
Read JobExecutionStatus Source #
Instance details Defined in Amazonka.IoTJobsData.Types.JobExecutionStatus Methods readsPrec :: Int -> ReadS JobExecutionStatus # readList :: ReadS [JobExecutionStatus] # readPrec :: ReadPrec JobExecutionStatus # readListPrec :: ReadPrec [JobExecutionStatus] #
Show JobExecutionStatus Source #
Instance details Defined in Amazonka.IoTJobsData.Types.JobExecutionStatus Methods showsPrec :: Int -> JobExecutionStatus -> ShowS # show :: JobExecutionStatus -> String # showList :: [JobExecutionStatus] -> ShowS #
Generic JobExecutionStatus Source #
Instance details Defined in Amazonka.IoTJobsData.Types.JobExecutionStatus Associated Types type Rep JobExecutionStatus :: Type -> Type # Methods from :: JobExecutionStatus -> Rep JobExecutionStatus x # to :: Rep JobExecutionStatus x -> JobExecutionStatus #
NFData JobExecutionStatus Source #
Instance details Defined in Amazonka.IoTJobsData.Types.JobExecutionStatus Methods rnf :: JobExecutionStatus -> () #
Hashable JobExecutionStatus Source #
Instance details Defined in Amazonka.IoTJobsData.Types.JobExecutionStatus Methods hashWithSalt :: Int -> JobExecutionStatus -> Int # hash :: JobExecutionStatus -> Int #
ToJSON JobExecutionStatus Source #
Instance details Defined in Amazonka.IoTJobsData.Types.JobExecutionStatus Methods toJSON :: JobExecutionStatus -> Value # toEncoding :: JobExecutionStatus -> Encoding # toJSONList :: [JobExecutionStatus] -> Value # toEncodingList :: [JobExecutionStatus] -> Encoding #
ToJSONKey JobExecutionStatus Source #
Instance details Defined in Amazonka.IoTJobsData.Types.JobExecutionStatus Methods toJSONKey :: ToJSONKeyFunction JobExecutionStatus # toJSONKeyList :: ToJSONKeyFunction [JobExecutionStatus] #
FromJSON JobExecutionStatus Source #
Instance details Defined in Amazonka.IoTJobsData.Types.JobExecutionStatus Methods parseJSON :: Value -> Parser JobExecutionStatus # parseJSONList :: Value -> Parser [JobExecutionStatus] #
FromJSONKey JobExecutionStatus Source #
Instance details Defined in Amazonka.IoTJobsData.Types.JobExecutionStatus Methods fromJSONKey :: FromJSONKeyFunction JobExecutionStatus # fromJSONKeyList :: FromJSONKeyFunction [JobExecutionStatus] #
ToLog JobExecutionStatus Source #
Instance details Defined in Amazonka.IoTJobsData.Types.JobExecutionStatus Methods build :: JobExecutionStatus -> ByteStringBuilder #
ToHeader JobExecutionStatus Source #
Instance details Defined in Amazonka.IoTJobsData.Types.JobExecutionStatus Methods toHeader :: HeaderName -> JobExecutionStatus -> [Header] #
ToQuery JobExecutionStatus Source #
Instance details Defined in Amazonka.IoTJobsData.Types.JobExecutionStatus Methods toQuery :: JobExecutionStatus -> QueryString #
FromXML JobExecutionStatus Source #
Instance details Defined in Amazonka.IoTJobsData.Types.JobExecutionStatus Methods parseXML :: [Node] -> Either String JobExecutionStatus #
ToXML JobExecutionStatus Source #
Instance details Defined in Amazonka.IoTJobsData.Types.JobExecutionStatus Methods toXML :: JobExecutionStatus -> XML #
ToByteString JobExecutionStatus Source #
Instance details Defined in Amazonka.IoTJobsData.Types.JobExecutionStatus Methods toBS :: JobExecutionStatus -> ByteString #
FromText JobExecutionStatus Source #
Instance details Defined in Amazonka.IoTJobsData.Types.JobExecutionStatus Methods fromText :: Text -> Either String JobExecutionStatus #
ToText JobExecutionStatus Source #
Instance details Defined in Amazonka.IoTJobsData.Types.JobExecutionStatus Methods toText :: JobExecutionStatus -> Text #
type Rep JobExecutionStatus Source #
Instance details Defined in Amazonka.IoTJobsData.Types.JobExecutionStatus type Rep JobExecutionStatus = D1 ('MetaData "JobExecutionStatus" "Amazonka.IoTJobsData.Types.JobExecutionStatus" "libZSservicesZSamazonka-iot-jobs-dataplaneZSamazonka-iot-jobs-dataplane" 'True) (C1 ('MetaCons "JobExecutionStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromJobExecutionStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

JobExecution

data JobExecution Source #

Contains data about a job execution.

See: newJobExecution smart constructor.

Constructors

JobExecution'

Fields

status :: Maybe JobExecutionStatus
The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS", "FAILED", "SUCCESS", "CANCELED", "REJECTED", or "REMOVED".
jobId :: Maybe Text
The unique identifier you assigned to this job when it was created.
lastUpdatedAt :: Maybe Integer
The time, in milliseconds since the epoch, when the job execution was last updated.
approximateSecondsBeforeTimedOut :: Maybe Integer
The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT.
queuedAt :: Maybe Integer
The time, in milliseconds since the epoch, when the job execution was enqueued.
jobDocument :: Maybe Text
The content of the job document.
statusDetails :: Maybe (HashMap Text Text)
A collection of name/value pairs that describe the status of the job execution.
executionNumber :: Maybe Integer
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.
versionNumber :: Maybe Integer
The version of the job execution. Job execution versions are incremented each time they are updated by a device.
startedAt :: Maybe Integer
The time, in milliseconds since the epoch, when the job execution was started.
thingName :: Maybe Text
The name of the thing that is executing the job.

Instances

Instances details

Eq JobExecution Source #
Instance details Defined in Amazonka.IoTJobsData.Types.JobExecution Methods (==) :: JobExecution -> JobExecution -> Bool # (/=) :: JobExecution -> JobExecution -> Bool #
Read JobExecution Source #
Instance details Defined in Amazonka.IoTJobsData.Types.JobExecution Methods readsPrec :: Int -> ReadS JobExecution # readList :: ReadS [JobExecution] # readPrec :: ReadPrec JobExecution # readListPrec :: ReadPrec [JobExecution] #
Show JobExecution Source #
Instance details Defined in Amazonka.IoTJobsData.Types.JobExecution Methods showsPrec :: Int -> JobExecution -> ShowS # show :: JobExecution -> String # showList :: [JobExecution] -> ShowS #
Generic JobExecution Source #
Instance details Defined in Amazonka.IoTJobsData.Types.JobExecution Associated Types type Rep JobExecution :: Type -> Type # Methods from :: JobExecution -> Rep JobExecution x # to :: Rep JobExecution x -> JobExecution #
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 Methods hashWithSalt :: Int -> JobExecution -> Int # hash :: JobExecution -> Int #
FromJSON JobExecution Source #
Instance details Defined in Amazonka.IoTJobsData.Types.JobExecution Methods parseJSON :: Value -> Parser JobExecution # parseJSONList :: Value -> Parser [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.

JobExecutionState

data JobExecutionState Source #

Contains data about the state of a job execution.

See: newJobExecutionState smart constructor.

Constructors

JobExecutionState'

Fields

status :: Maybe JobExecutionStatus
The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS", "FAILED", "SUCCESS", "CANCELED", "REJECTED", or "REMOVED".
statusDetails :: Maybe (HashMap Text Text)
A collection of name/value pairs that describe the status of the job execution.
versionNumber :: Maybe Integer
The version of the job execution. Job execution versions are incremented each time they are updated by a device.

Instances

Instances details

Eq JobExecutionState Source #
Instance details Defined in Amazonka.IoTJobsData.Types.JobExecutionState Methods (==) :: JobExecutionState -> JobExecutionState -> Bool # (/=) :: JobExecutionState -> JobExecutionState -> Bool #
Read JobExecutionState Source #
Instance details Defined in Amazonka.IoTJobsData.Types.JobExecutionState Methods readsPrec :: Int -> ReadS JobExecutionState # readList :: ReadS [JobExecutionState] # readPrec :: ReadPrec JobExecutionState # readListPrec :: ReadPrec [JobExecutionState] #
Show JobExecutionState Source #
Instance details Defined in Amazonka.IoTJobsData.Types.JobExecutionState Methods showsPrec :: Int -> JobExecutionState -> ShowS # show :: JobExecutionState -> String # showList :: [JobExecutionState] -> ShowS #
Generic JobExecutionState Source #
Instance details Defined in Amazonka.IoTJobsData.Types.JobExecutionState Associated Types type Rep JobExecutionState :: Type -> Type # Methods from :: JobExecutionState -> Rep JobExecutionState x # to :: Rep JobExecutionState x -> JobExecutionState #
NFData JobExecutionState Source #
Instance details Defined in Amazonka.IoTJobsData.Types.JobExecutionState Methods rnf :: JobExecutionState -> () #
Hashable JobExecutionState Source #
Instance details Defined in Amazonka.IoTJobsData.Types.JobExecutionState Methods hashWithSalt :: Int -> JobExecutionState -> Int # hash :: JobExecutionState -> Int #
FromJSON JobExecutionState Source #
Instance details Defined in Amazonka.IoTJobsData.Types.JobExecutionState Methods parseJSON :: Value -> Parser JobExecutionState # parseJSONList :: Value -> Parser [JobExecutionState] #
type Rep JobExecutionState Source #
Instance details Defined in Amazonka.IoTJobsData.Types.JobExecutionState type Rep JobExecutionState = D1 ('MetaData "JobExecutionState" "Amazonka.IoTJobsData.Types.JobExecutionState" "libZSservicesZSamazonka-iot-jobs-dataplaneZSamazonka-iot-jobs-dataplane" 'False) (C1 ('MetaCons "JobExecutionState'" 'PrefixI 'True) (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobExecutionStatus)) :: (S1 ('MetaSel ('Just "statusDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "versionNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))))

newJobExecutionState :: JobExecutionState Source #

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

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

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

jobExecutionState_status :: Lens' JobExecutionState (Maybe JobExecutionStatus) Source #

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

jobExecutionState_statusDetails :: Lens' JobExecutionState (Maybe (HashMap Text Text)) Source #

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

jobExecutionState_versionNumber :: Lens' JobExecutionState (Maybe Integer) Source #

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

JobExecutionSummary

data JobExecutionSummary Source #

Contains a subset of information about a job execution.

See: newJobExecutionSummary smart constructor.

Constructors

JobExecutionSummary'

Fields

jobId :: Maybe Text
The unique identifier you assigned to this job when it was created.
lastUpdatedAt :: Maybe Integer
The time, in milliseconds since the epoch, when the job execution was last updated.
queuedAt :: Maybe Integer
The time, in milliseconds since the epoch, when the job execution was enqueued.
executionNumber :: Maybe Integer
A number that identifies a particular job execution on a particular device.
versionNumber :: Maybe Integer
The version of the job execution. Job execution versions are incremented each time AWS IoT Jobs receives an update from a device.
startedAt :: Maybe Integer
The time, in milliseconds since the epoch, when the job execution started.

Instances

Instances details

Eq JobExecutionSummary Source #
Instance details Defined in Amazonka.IoTJobsData.Types.JobExecutionSummary Methods (==) :: JobExecutionSummary -> JobExecutionSummary -> Bool # (/=) :: JobExecutionSummary -> JobExecutionSummary -> Bool #
Read JobExecutionSummary Source #
Instance details Defined in Amazonka.IoTJobsData.Types.JobExecutionSummary Methods readsPrec :: Int -> ReadS JobExecutionSummary # readList :: ReadS [JobExecutionSummary] # readPrec :: ReadPrec JobExecutionSummary # readListPrec :: ReadPrec [JobExecutionSummary] #
Show JobExecutionSummary Source #
Instance details Defined in Amazonka.IoTJobsData.Types.JobExecutionSummary Methods showsPrec :: Int -> JobExecutionSummary -> ShowS # show :: JobExecutionSummary -> String # showList :: [JobExecutionSummary] -> ShowS #
Generic JobExecutionSummary Source #
Instance details Defined in Amazonka.IoTJobsData.Types.JobExecutionSummary Associated Types type Rep JobExecutionSummary :: Type -> Type # Methods from :: JobExecutionSummary -> Rep JobExecutionSummary x # to :: Rep JobExecutionSummary x -> JobExecutionSummary #
NFData JobExecutionSummary Source #
Instance details Defined in Amazonka.IoTJobsData.Types.JobExecutionSummary Methods rnf :: JobExecutionSummary -> () #
Hashable JobExecutionSummary Source #
Instance details Defined in Amazonka.IoTJobsData.Types.JobExecutionSummary Methods hashWithSalt :: Int -> JobExecutionSummary -> Int # hash :: JobExecutionSummary -> Int #
FromJSON JobExecutionSummary Source #
Instance details Defined in Amazonka.IoTJobsData.Types.JobExecutionSummary Methods parseJSON :: Value -> Parser JobExecutionSummary # parseJSONList :: Value -> Parser [JobExecutionSummary] #
type Rep JobExecutionSummary Source #
Instance details Defined in Amazonka.IoTJobsData.Types.JobExecutionSummary type Rep JobExecutionSummary = D1 ('MetaData "JobExecutionSummary" "Amazonka.IoTJobsData.Types.JobExecutionSummary" "libZSservicesZSamazonka-iot-jobs-dataplaneZSamazonka-iot-jobs-dataplane" 'False) (C1 ('MetaCons "JobExecutionSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "lastUpdatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "queuedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))) :: (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))))))

newJobExecutionSummary :: JobExecutionSummary Source #

Create a value of JobExecutionSummary 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:jobId:JobExecutionSummary', jobExecutionSummary_jobId - The unique identifier you assigned to this job when it was created.

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

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

$sel:executionNumber:JobExecutionSummary', jobExecutionSummary_executionNumber - A number that identifies a particular job execution on a particular device.

$sel:versionNumber:JobExecutionSummary', jobExecutionSummary_versionNumber - The version of the job execution. Job execution versions are incremented each time AWS IoT Jobs receives an update from a device.

$sel:startedAt:JobExecutionSummary', jobExecutionSummary_startedAt - The time, in milliseconds since the epoch, when the job execution started.

jobExecutionSummary_jobId :: Lens' JobExecutionSummary (Maybe Text) Source #

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

jobExecutionSummary_lastUpdatedAt :: Lens' JobExecutionSummary (Maybe Integer) Source #

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

jobExecutionSummary_queuedAt :: Lens' JobExecutionSummary (Maybe Integer) Source #

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

jobExecutionSummary_executionNumber :: Lens' JobExecutionSummary (Maybe Integer) Source #

A number that identifies a particular job execution on a particular device.

jobExecutionSummary_versionNumber :: Lens' JobExecutionSummary (Maybe Integer) Source #

The version of the job execution. Job execution versions are incremented each time AWS IoT Jobs receives an update from a device.

jobExecutionSummary_startedAt :: Lens' JobExecutionSummary (Maybe Integer) Source #

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