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.DescribeJobExecution

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets details of a job execution.

Synopsis

data DescribeJobExecution = DescribeJobExecution' {
- includeJobDocument :: Maybe Bool
- executionNumber :: Maybe Integer
- jobId :: Text
- thingName :: Text
}
newDescribeJobExecution :: Text -> Text -> DescribeJobExecution
describeJobExecution_includeJobDocument :: Lens' DescribeJobExecution (Maybe Bool)
describeJobExecution_executionNumber :: Lens' DescribeJobExecution (Maybe Integer)
describeJobExecution_jobId :: Lens' DescribeJobExecution Text
describeJobExecution_thingName :: Lens' DescribeJobExecution Text
data DescribeJobExecutionResponse = DescribeJobExecutionResponse' {
- execution :: Maybe JobExecution
- httpStatus :: Int
}
newDescribeJobExecutionResponse :: Int -> DescribeJobExecutionResponse
describeJobExecutionResponse_execution :: Lens' DescribeJobExecutionResponse (Maybe JobExecution)
describeJobExecutionResponse_httpStatus :: Lens' DescribeJobExecutionResponse Int

Creating a Request

data DescribeJobExecution Source #

See: newDescribeJobExecution smart constructor.

Constructors

DescribeJobExecution'

Fields

includeJobDocument :: Maybe Bool
Optional. When set to true, the response contains the job document. The default is false.
executionNumber :: Maybe Integer
Optional. A number that identifies a particular job execution on a particular device. If not specified, the latest job execution is returned.
jobId :: Text
The unique identifier assigned to this job when it was created.
thingName :: Text
The thing name associated with the device the job execution is running on.

Instances

Instances details

Eq DescribeJobExecution Source #
Instance details Defined in Amazonka.IoTJobsData.DescribeJobExecution Methods (==) :: DescribeJobExecution -> DescribeJobExecution -> Bool # (/=) :: DescribeJobExecution -> DescribeJobExecution -> Bool #
Read DescribeJobExecution Source #
Instance details Defined in Amazonka.IoTJobsData.DescribeJobExecution Methods readsPrec :: Int -> ReadS DescribeJobExecution # readList :: ReadS [DescribeJobExecution] # readPrec :: ReadPrec DescribeJobExecution # readListPrec :: ReadPrec [DescribeJobExecution] #
Show DescribeJobExecution Source #
Instance details Defined in Amazonka.IoTJobsData.DescribeJobExecution Methods showsPrec :: Int -> DescribeJobExecution -> ShowS # show :: DescribeJobExecution -> String # showList :: [DescribeJobExecution] -> ShowS #
Generic DescribeJobExecution Source #
Instance details Defined in Amazonka.IoTJobsData.DescribeJobExecution Associated Types type Rep DescribeJobExecution :: Type -> Type # Methods from :: DescribeJobExecution -> Rep DescribeJobExecution x # to :: Rep DescribeJobExecution x -> DescribeJobExecution #
NFData DescribeJobExecution Source #
Instance details Defined in Amazonka.IoTJobsData.DescribeJobExecution Methods rnf :: DescribeJobExecution -> () #
Hashable DescribeJobExecution Source #
Instance details Defined in Amazonka.IoTJobsData.DescribeJobExecution Methods hashWithSalt :: Int -> DescribeJobExecution -> Int # hash :: DescribeJobExecution -> Int #
AWSRequest DescribeJobExecution Source #
Instance details Defined in Amazonka.IoTJobsData.DescribeJobExecution Associated Types type AWSResponse DescribeJobExecution # Methods request :: DescribeJobExecution -> Request DescribeJobExecution # response :: MonadResource m => Logger -> Service -> Proxy DescribeJobExecution -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeJobExecution))) #
ToHeaders DescribeJobExecution Source #
Instance details Defined in Amazonka.IoTJobsData.DescribeJobExecution Methods toHeaders :: DescribeJobExecution -> [Header] #
ToPath DescribeJobExecution Source #
Instance details Defined in Amazonka.IoTJobsData.DescribeJobExecution Methods toPath :: DescribeJobExecution -> ByteString #
ToQuery DescribeJobExecution Source #
Instance details Defined in Amazonka.IoTJobsData.DescribeJobExecution Methods toQuery :: DescribeJobExecution -> QueryString #
type Rep DescribeJobExecution Source #
Instance details Defined in Amazonka.IoTJobsData.DescribeJobExecution type Rep DescribeJobExecution = D1 ('MetaData "DescribeJobExecution" "Amazonka.IoTJobsData.DescribeJobExecution" "libZSservicesZSamazonka-iot-jobs-dataplaneZSamazonka-iot-jobs-dataplane" 'False) (C1 ('MetaCons "DescribeJobExecution'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "includeJobDocument") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "executionNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))) :: (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "thingName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse DescribeJobExecution Source #
Instance details Defined in Amazonka.IoTJobsData.DescribeJobExecution type AWSResponse DescribeJobExecution = DescribeJobExecutionResponse

newDescribeJobExecution Source #

Arguments

:: Text	`$sel:jobId:DescribeJobExecution'`
-> Text	`$sel:thingName:DescribeJobExecution'`
-> DescribeJobExecution

Create a value of DescribeJobExecution 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:includeJobDocument:DescribeJobExecution', describeJobExecution_includeJobDocument - Optional. When set to true, the response contains the job document. The default is false.

$sel:executionNumber:DescribeJobExecution', describeJobExecution_executionNumber - Optional. A number that identifies a particular job execution on a particular device. If not specified, the latest job execution is returned.

$sel:jobId:DescribeJobExecution', describeJobExecution_jobId - The unique identifier assigned to this job when it was created.

$sel:thingName:DescribeJobExecution', describeJobExecution_thingName - The thing name associated with the device the job execution is running on.

Request Lenses

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

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

describeJobExecution_executionNumber :: 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.

describeJobExecution_jobId :: Lens' DescribeJobExecution Text Source #

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

describeJobExecution_thingName :: Lens' DescribeJobExecution Text Source #

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

Destructuring the Response

data DescribeJobExecutionResponse Source #

See: newDescribeJobExecutionResponse smart constructor.

Constructors

DescribeJobExecutionResponse'
Fields execution :: Maybe JobExecution Contains data about a job execution. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq DescribeJobExecutionResponse Source #
Instance details Defined in Amazonka.IoTJobsData.DescribeJobExecution Methods (==) :: DescribeJobExecutionResponse -> DescribeJobExecutionResponse -> Bool # (/=) :: DescribeJobExecutionResponse -> DescribeJobExecutionResponse -> Bool #
Read DescribeJobExecutionResponse Source #
Instance details Defined in Amazonka.IoTJobsData.DescribeJobExecution Methods readsPrec :: Int -> ReadS DescribeJobExecutionResponse # readList :: ReadS [DescribeJobExecutionResponse] # readPrec :: ReadPrec DescribeJobExecutionResponse # readListPrec :: ReadPrec [DescribeJobExecutionResponse] #
Show DescribeJobExecutionResponse Source #
Instance details Defined in Amazonka.IoTJobsData.DescribeJobExecution Methods showsPrec :: Int -> DescribeJobExecutionResponse -> ShowS # show :: DescribeJobExecutionResponse -> String # showList :: [DescribeJobExecutionResponse] -> ShowS #
Generic DescribeJobExecutionResponse Source #
Instance details Defined in Amazonka.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 Amazonka.IoTJobsData.DescribeJobExecution Methods rnf :: DescribeJobExecutionResponse -> () #
type Rep DescribeJobExecutionResponse Source #
Instance details Defined in Amazonka.IoTJobsData.DescribeJobExecution type Rep DescribeJobExecutionResponse = D1 ('MetaData "DescribeJobExecutionResponse" "Amazonka.IoTJobsData.DescribeJobExecution" "libZSservicesZSamazonka-iot-jobs-dataplaneZSamazonka-iot-jobs-dataplane" 'False) (C1 ('MetaCons "DescribeJobExecutionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "execution") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobExecution)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeJobExecutionResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeJobExecutionResponse'`
-> DescribeJobExecutionResponse

Create a value of DescribeJobExecutionResponse 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:execution:DescribeJobExecutionResponse', describeJobExecutionResponse_execution - Contains data about a job execution.

$sel:httpStatus:DescribeJobExecutionResponse', describeJobExecutionResponse_httpStatus - The response's http status code.

Response Lenses

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

Contains data about a job execution.

describeJobExecutionResponse_httpStatus :: Lens' DescribeJobExecutionResponse Int Source #

The response's http status code.