Network.AWS.IoTJobsData.UpdateJobExecution

Updates the status of a job execution.

Creating a Request

updateJobExecution

Arguments

:: Text

ujeJobId

-> Text

ujeThingName

-> JobExecutionStatus

ujeStatus

-> UpdateJobExecution

Creates a value of UpdateJobExecution with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ujeIncludeJobDocument - Optional. When set to true, the response contains the job document. The default is false.
• ujeStatusDetails - Optional. A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.
• ujeExecutionNumber - Optional. A number that identifies a particular job execution on a particular device.
• ujeExpectedVersion - Optional. The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.)
• ujeIncludeJobExecutionState - Optional. When included and set to true, the response contains the JobExecutionState data. The default is false.
• ujeJobId - The unique identifier assigned to this job when it was created.
• ujeThingName - The name of the thing associated with the device.
• ujeStatus - The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update.

data UpdateJobExecution

See: updateJobExecution smart constructor.

Instances

Eq UpdateJobExecution

Methods

(==) :: UpdateJobExecution -> UpdateJobExecution -> Bool

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

Data UpdateJobExecution

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateJobExecution -> c UpdateJobExecution

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateJobExecution

toConstr :: UpdateJobExecution -> Constr

dataTypeOf :: UpdateJobExecution -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c UpdateJobExecution)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateJobExecution)

gmapT :: (forall b. Data b => b -> b) -> UpdateJobExecution -> UpdateJobExecution

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateJobExecution -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateJobExecution -> r

gmapQ :: (forall d. Data d => d -> u) -> UpdateJobExecution -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateJobExecution -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateJobExecution -> m UpdateJobExecution

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateJobExecution -> m UpdateJobExecution

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateJobExecution -> m UpdateJobExecution

Read UpdateJobExecution

Methods

readsPrec :: Int -> ReadS UpdateJobExecution

readList :: ReadS [UpdateJobExecution]

readPrec :: ReadPrec UpdateJobExecution

readListPrec :: ReadPrec [UpdateJobExecution]

Show UpdateJobExecution

Methods

showsPrec :: Int -> UpdateJobExecution -> ShowS

show :: UpdateJobExecution -> String

showList :: [UpdateJobExecution] -> ShowS

Generic UpdateJobExecution

Associated Types

type Rep UpdateJobExecution :: * -> *

Methods

from :: UpdateJobExecution -> Rep UpdateJobExecution x

to :: Rep UpdateJobExecution x -> UpdateJobExecution

Hashable UpdateJobExecution

Methods

hashWithSalt :: Int -> UpdateJobExecution -> Int

hash :: UpdateJobExecution -> Int

ToJSON UpdateJobExecution

Methods

toJSON :: UpdateJobExecution -> Value

toEncoding :: UpdateJobExecution -> Encoding

toJSONList :: [UpdateJobExecution] -> Value

toEncodingList :: [UpdateJobExecution] -> Encoding

NFData UpdateJobExecution

Methods

rnf :: UpdateJobExecution -> ()

AWSRequest UpdateJobExecution

Associated Types

type Rs UpdateJobExecution :: *

Methods

request :: UpdateJobExecution -> Request UpdateJobExecution

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * UpdateJobExecution -> ClientResponse -> m (Response UpdateJobExecution)

ToHeaders UpdateJobExecution

Methods

toHeaders :: UpdateJobExecution -> [Header]

ToPath UpdateJobExecution

Methods

toPath :: UpdateJobExecution -> ByteString

ToQuery UpdateJobExecution

Methods

toQuery :: UpdateJobExecution -> QueryString

type Rep UpdateJobExecution

type Rep UpdateJobExecution = D1 * (MetaData "UpdateJobExecution" "Network.AWS.IoTJobsData.UpdateJobExecution" "amazonka-iot-jobs-dataplane-1.6.0-1BXy9I0VbTNJCQzMDHs5aK" False) (C1 * (MetaCons "UpdateJobExecution'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_ujeIncludeJobDocument") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_ujeStatusDetails") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text Text))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ujeExecutionNumber") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Integer))) (S1 * (MetaSel (Just Symbol "_ujeExpectedVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Integer))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_ujeIncludeJobExecutionState") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_ujeJobId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ujeThingName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_ujeStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * JobExecutionStatus))))))

type Rs UpdateJobExecution

type Rs UpdateJobExecution = UpdateJobExecutionResponse

Request Lenses

ujeIncludeJobDocument :: Lens' UpdateJobExecution (Maybe Bool)

Optional. When set to true, the response contains the job document. The default is false.

ujeStatusDetails :: Lens' UpdateJobExecution (HashMap Text Text)

Optional. A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.

ujeExecutionNumber :: Lens' UpdateJobExecution (Maybe Integer)

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

ujeExpectedVersion :: Lens' UpdateJobExecution (Maybe Integer)

Optional. The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.)

ujeIncludeJobExecutionState :: Lens' UpdateJobExecution (Maybe Bool)

Optional. When included and set to true, the response contains the JobExecutionState data. The default is false.

ujeJobId :: Lens' UpdateJobExecution Text

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

ujeThingName :: Lens' UpdateJobExecution Text

The name of the thing associated with the device.

ujeStatus :: Lens' UpdateJobExecution JobExecutionStatus

The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update.

Destructuring the Response

updateJobExecutionResponse

Arguments

:: Int

ujersResponseStatus

-> UpdateJobExecutionResponse

Creates a value of UpdateJobExecutionResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ujersJobDocument - The contents of the Job Documents.
• ujersExecutionState - A JobExecutionState object.
• ujersResponseStatus - -- | The response status code.

data UpdateJobExecutionResponse

See: updateJobExecutionResponse smart constructor.

Instances

Eq UpdateJobExecutionResponse

Methods

(==) :: UpdateJobExecutionResponse -> UpdateJobExecutionResponse -> Bool

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

Data UpdateJobExecutionResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateJobExecutionResponse -> c UpdateJobExecutionResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateJobExecutionResponse

toConstr :: UpdateJobExecutionResponse -> Constr

dataTypeOf :: UpdateJobExecutionResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c UpdateJobExecutionResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateJobExecutionResponse)

gmapT :: (forall b. Data b => b -> b) -> UpdateJobExecutionResponse -> UpdateJobExecutionResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateJobExecutionResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateJobExecutionResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> UpdateJobExecutionResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateJobExecutionResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateJobExecutionResponse -> m UpdateJobExecutionResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateJobExecutionResponse -> m UpdateJobExecutionResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateJobExecutionResponse -> m UpdateJobExecutionResponse

Read UpdateJobExecutionResponse

Methods

readsPrec :: Int -> ReadS UpdateJobExecutionResponse

readList :: ReadS [UpdateJobExecutionResponse]

readPrec :: ReadPrec UpdateJobExecutionResponse

readListPrec :: ReadPrec [UpdateJobExecutionResponse]

Show UpdateJobExecutionResponse

Methods

showsPrec :: Int -> UpdateJobExecutionResponse -> ShowS

show :: UpdateJobExecutionResponse -> String

showList :: [UpdateJobExecutionResponse] -> ShowS

Generic UpdateJobExecutionResponse

Associated Types

type Rep UpdateJobExecutionResponse :: * -> *

Methods

from :: UpdateJobExecutionResponse -> Rep UpdateJobExecutionResponse x

to :: Rep UpdateJobExecutionResponse x -> UpdateJobExecutionResponse

NFData UpdateJobExecutionResponse

Methods

rnf :: UpdateJobExecutionResponse -> ()

type Rep UpdateJobExecutionResponse

type Rep UpdateJobExecutionResponse = D1 * (MetaData "UpdateJobExecutionResponse" "Network.AWS.IoTJobsData.UpdateJobExecution" "amazonka-iot-jobs-dataplane-1.6.0-1BXy9I0VbTNJCQzMDHs5aK" False) (C1 * (MetaCons "UpdateJobExecutionResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_ujersJobDocument") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ujersExecutionState") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe JobExecutionState))) (S1 * (MetaSel (Just Symbol "_ujersResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

ujersJobDocument :: Lens' UpdateJobExecutionResponse (Maybe Text)

The contents of the Job Documents.

ujersExecutionState :: Lens' UpdateJobExecutionResponse (Maybe JobExecutionState)

A JobExecutionState object.

ujersResponseStatus :: Lens' UpdateJobExecutionResponse Int

• - | The response status code.