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.IoT.DescribeJob

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes a job.

Requires permission to access the DescribeJob action.

Synopsis

Creating a Request

data DescribeJob Source #

See: newDescribeJob smart constructor.

Constructors

DescribeJob'
Fields jobId :: Text The unique identifier you assigned to this job when it was created.

Instances

Instances details

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

newDescribeJob Source #

Arguments

:: Text	`$sel:jobId:DescribeJob'`
-> DescribeJob

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

Request Lenses

describeJob_jobId :: Lens' DescribeJob Text Source #

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

Destructuring the Response

data DescribeJobResponse Source #

See: newDescribeJobResponse smart constructor.

Constructors

DescribeJobResponse'
Fields documentSource :: Maybe Text An S3 link to the job document. job :: Maybe Job Information about the job. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq DescribeJobResponse Source #
Instance details Defined in Amazonka.IoT.DescribeJob Methods (==) :: DescribeJobResponse -> DescribeJobResponse -> Bool # (/=) :: DescribeJobResponse -> DescribeJobResponse -> Bool #
Read DescribeJobResponse Source #
Instance details Defined in Amazonka.IoT.DescribeJob Methods readsPrec :: Int -> ReadS DescribeJobResponse # readList :: ReadS [DescribeJobResponse] # readPrec :: ReadPrec DescribeJobResponse # readListPrec :: ReadPrec [DescribeJobResponse] #
Show DescribeJobResponse Source #
Instance details Defined in Amazonka.IoT.DescribeJob Methods showsPrec :: Int -> DescribeJobResponse -> ShowS # show :: DescribeJobResponse -> String # showList :: [DescribeJobResponse] -> ShowS #
Generic DescribeJobResponse Source #
Instance details Defined in Amazonka.IoT.DescribeJob Associated Types type Rep DescribeJobResponse :: Type -> Type # Methods from :: DescribeJobResponse -> Rep DescribeJobResponse x # to :: Rep DescribeJobResponse x -> DescribeJobResponse #
NFData DescribeJobResponse Source #
Instance details Defined in Amazonka.IoT.DescribeJob Methods rnf :: DescribeJobResponse -> () #
type Rep DescribeJobResponse Source #
Instance details Defined in Amazonka.IoT.DescribeJob type Rep DescribeJobResponse = D1 ('MetaData "DescribeJobResponse" "Amazonka.IoT.DescribeJob" "libZSservicesZSamazonka-iotZSamazonka-iot" 'False) (C1 ('MetaCons "DescribeJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "documentSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "job") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Job)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeJobResponse Source #

Arguments

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

Create a value of DescribeJobResponse 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:documentSource:DescribeJobResponse', describeJobResponse_documentSource - An S3 link to the job document.

$sel:job:DescribeJobResponse', describeJobResponse_job - Information about the job.

$sel:httpStatus:DescribeJobResponse', describeJobResponse_httpStatus - The response's http status code.

Response Lenses

describeJobResponse_documentSource :: Lens' DescribeJobResponse (Maybe Text) Source #

An S3 link to the job document.

describeJobResponse_job :: Lens' DescribeJobResponse (Maybe Job) Source #

Information about the job.

describeJobResponse_httpStatus :: Lens' DescribeJobResponse Int Source #

The response's http status code.