Copyright	(c) 2013-2018 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
Language	Haskell2010

Network.AWS.IoTJobsData.DescribeJobExecution

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets details of a job execution.

Creating a Request

describeJobExecution Source #

Arguments

:: Text	`djeJobId`
-> Text	`djeThingName`
-> DescribeJobExecution

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

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

djeIncludeJobDocument - Optional. When set to true, the response contains the job document. The default is false.
djeExecutionNumber - Optional. A number that identifies a particular job execution on a particular device. If not specified, the latest job execution is returned.
djeJobId - The unique identifier assigned to this job when it was created.
djeThingName - The thing name associated with the device the job execution is running on.

data DescribeJobExecution Source #

See: describeJobExecution smart constructor.

Instances

Eq DescribeJobExecution Source #
Instance details Defined in Network.AWS.IoTJobsData.DescribeJobExecution Methods (==) :: DescribeJobExecution -> DescribeJobExecution -> Bool # (/=) :: DescribeJobExecution -> DescribeJobExecution -> Bool #
Data DescribeJobExecution Source #
Instance details Defined in Network.AWS.IoTJobsData.DescribeJobExecution Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeJobExecution -> c DescribeJobExecution # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeJobExecution # toConstr :: DescribeJobExecution -> Constr # dataTypeOf :: DescribeJobExecution -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DescribeJobExecution) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeJobExecution) # gmapT :: (forall b. Data b => b -> b) -> DescribeJobExecution -> DescribeJobExecution # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeJobExecution -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeJobExecution -> r # gmapQ :: (forall d. Data d => d -> u) -> DescribeJobExecution -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeJobExecution -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeJobExecution -> m DescribeJobExecution # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeJobExecution -> m DescribeJobExecution # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeJobExecution -> m DescribeJobExecution #
Read DescribeJobExecution Source #
Instance details Defined in Network.AWS.IoTJobsData.DescribeJobExecution Methods readsPrec :: Int -> ReadS DescribeJobExecution # readList :: ReadS [DescribeJobExecution] # readPrec :: ReadPrec DescribeJobExecution # readListPrec :: ReadPrec [DescribeJobExecution] #
Show DescribeJobExecution Source #
Instance details Defined in Network.AWS.IoTJobsData.DescribeJobExecution Methods showsPrec :: Int -> DescribeJobExecution -> ShowS # show :: DescribeJobExecution -> String # showList :: [DescribeJobExecution] -> ShowS #
Generic DescribeJobExecution Source #
Instance details Defined in Network.AWS.IoTJobsData.DescribeJobExecution Associated Types type Rep DescribeJobExecution :: Type -> Type # Methods from :: DescribeJobExecution -> Rep DescribeJobExecution x # to :: Rep DescribeJobExecution x -> DescribeJobExecution #
Hashable DescribeJobExecution Source #
Instance details Defined in Network.AWS.IoTJobsData.DescribeJobExecution Methods hashWithSalt :: Int -> DescribeJobExecution -> Int # hash :: DescribeJobExecution -> Int #
AWSRequest DescribeJobExecution Source #
Instance details Defined in Network.AWS.IoTJobsData.DescribeJobExecution Associated Types type Rs DescribeJobExecution :: Type # Methods request :: DescribeJobExecution -> Request DescribeJobExecution # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy DescribeJobExecution -> ClientResponse -> m (Response DescribeJobExecution) #
ToHeaders DescribeJobExecution Source #
Instance details Defined in Network.AWS.IoTJobsData.DescribeJobExecution Methods toHeaders :: DescribeJobExecution -> [Header] #
ToPath DescribeJobExecution Source #
Instance details Defined in Network.AWS.IoTJobsData.DescribeJobExecution Methods toPath :: DescribeJobExecution -> ByteString #
ToQuery DescribeJobExecution Source #
Instance details Defined in Network.AWS.IoTJobsData.DescribeJobExecution Methods toQuery :: DescribeJobExecution -> QueryString #
NFData DescribeJobExecution Source #
Instance details Defined in Network.AWS.IoTJobsData.DescribeJobExecution Methods rnf :: DescribeJobExecution -> () #
type Rep DescribeJobExecution Source #
Instance details Defined in Network.AWS.IoTJobsData.DescribeJobExecution type Rep DescribeJobExecution = D1 (MetaData "DescribeJobExecution" "Network.AWS.IoTJobsData.DescribeJobExecution" "amazonka-iot-jobs-dataplane-1.6.1-HQBkg3pfdMoKuuM15384PM" False) (C1 (MetaCons "DescribeJobExecution'" PrefixI True) ((S1 (MetaSel (Just "_djeIncludeJobDocument") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :: S1 (MetaSel (Just "_djeExecutionNumber") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Integer))) :: (S1 (MetaSel (Just "_djeJobId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_djeThingName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))
type Rs DescribeJobExecution Source #
Instance details Defined in Network.AWS.IoTJobsData.DescribeJobExecution type Rs DescribeJobExecution = DescribeJobExecutionResponse

Request Lenses

djeIncludeJobDocument :: Lens' DescribeJobExecution (Maybe Bool) Source #

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

djeExecutionNumber :: Lens' DescribeJobExecution (Maybe Integer) Source #

Optional. A number that identifies a particular job execution on a particular device. If not specified, the latest job execution is returned.

djeJobId :: Lens' DescribeJobExecution Text Source #

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

djeThingName :: Lens' DescribeJobExecution Text Source #

The thing name associated with the device the job execution is running on.

Destructuring the Response

describeJobExecutionResponse Source #

Arguments

:: Int	`djersResponseStatus`
-> DescribeJobExecutionResponse

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

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

djersExecution - Contains data about a job execution.
djersResponseStatus - -- | The response status code.

data DescribeJobExecutionResponse Source #

See: describeJobExecutionResponse smart constructor.

Instances

Eq DescribeJobExecutionResponse Source #
Instance details Defined in Network.AWS.IoTJobsData.DescribeJobExecution Methods (==) :: DescribeJobExecutionResponse -> DescribeJobExecutionResponse -> Bool # (/=) :: DescribeJobExecutionResponse -> DescribeJobExecutionResponse -> Bool #
Data DescribeJobExecutionResponse Source #
Instance details Defined in Network.AWS.IoTJobsData.DescribeJobExecution Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeJobExecutionResponse -> c DescribeJobExecutionResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeJobExecutionResponse # toConstr :: DescribeJobExecutionResponse -> Constr # dataTypeOf :: DescribeJobExecutionResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DescribeJobExecutionResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeJobExecutionResponse) # gmapT :: (forall b. Data b => b -> b) -> DescribeJobExecutionResponse -> DescribeJobExecutionResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeJobExecutionResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeJobExecutionResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> DescribeJobExecutionResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeJobExecutionResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeJobExecutionResponse -> m DescribeJobExecutionResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeJobExecutionResponse -> m DescribeJobExecutionResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeJobExecutionResponse -> m DescribeJobExecutionResponse #
Read DescribeJobExecutionResponse Source #
Instance details Defined in Network.AWS.IoTJobsData.DescribeJobExecution Methods readsPrec :: Int -> ReadS DescribeJobExecutionResponse # readList :: ReadS [DescribeJobExecutionResponse] # readPrec :: ReadPrec DescribeJobExecutionResponse # readListPrec :: ReadPrec [DescribeJobExecutionResponse] #
Show DescribeJobExecutionResponse Source #
Instance details Defined in Network.AWS.IoTJobsData.DescribeJobExecution Methods showsPrec :: Int -> DescribeJobExecutionResponse -> ShowS # show :: DescribeJobExecutionResponse -> String # showList :: [DescribeJobExecutionResponse] -> ShowS #
Generic DescribeJobExecutionResponse Source #
Instance details Defined in Network.AWS.IoTJobsData.DescribeJobExecution Associated Types type Rep DescribeJobExecutionResponse :: Type -> Type # Methods from :: DescribeJobExecutionResponse -> Rep DescribeJobExecutionResponse x # to :: Rep DescribeJobExecutionResponse x -> DescribeJobExecutionResponse #
NFData DescribeJobExecutionResponse Source #
Instance details Defined in Network.AWS.IoTJobsData.DescribeJobExecution Methods rnf :: DescribeJobExecutionResponse -> () #
type Rep DescribeJobExecutionResponse Source #
Instance details Defined in Network.AWS.IoTJobsData.DescribeJobExecution type Rep DescribeJobExecutionResponse = D1 (MetaData "DescribeJobExecutionResponse" "Network.AWS.IoTJobsData.DescribeJobExecution" "amazonka-iot-jobs-dataplane-1.6.1-HQBkg3pfdMoKuuM15384PM" False) (C1 (MetaCons "DescribeJobExecutionResponse'" PrefixI True) (S1 (MetaSel (Just "_djersExecution") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe JobExecution)) :*: S1 (MetaSel (Just "_djersResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

djersExecution :: Lens' DescribeJobExecutionResponse (Maybe JobExecution) Source #

Contains data about a job execution.

djersResponseStatus :: Lens' DescribeJobExecutionResponse Int Source #

- | The response status code.