Amazonka.IoT.DescribeJob

Describes a job.

Requires permission to access the DescribeJob action.

Creating a Request

data DescribeJob

See: newDescribeJob smart constructor.

Constructors

DescribeJob'

Fields

• jobId :: Text

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

Instances

ToHeaders DescribeJob

Defined in Amazonka.IoT.DescribeJob

Methods

toHeaders :: DescribeJob -> [Header]

ToPath DescribeJob

Defined in Amazonka.IoT.DescribeJob

Methods

toPath :: DescribeJob -> ByteString

ToQuery DescribeJob

Defined in Amazonka.IoT.DescribeJob

Methods

toQuery :: DescribeJob -> QueryString

AWSRequest DescribeJob

Defined in Amazonka.IoT.DescribeJob

Associated Types

type AWSResponse DescribeJob

Methods

request :: (Service -> Service) -> DescribeJob -> Request DescribeJob

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeJob)))

Generic DescribeJob

Defined in Amazonka.IoT.DescribeJob

Associated Types

type Rep DescribeJob :: Type -> Type

Methods

from :: DescribeJob -> Rep DescribeJob x

to :: Rep DescribeJob x -> DescribeJob

Read DescribeJob

Defined in Amazonka.IoT.DescribeJob

Methods

readsPrec :: Int -> ReadS DescribeJob

readList :: ReadS [DescribeJob]

readPrec :: ReadPrec DescribeJob

readListPrec :: ReadPrec [DescribeJob]

Show DescribeJob

Defined in Amazonka.IoT.DescribeJob

Methods

showsPrec :: Int -> DescribeJob -> ShowS

show :: DescribeJob -> String

showList :: [DescribeJob] -> ShowS

NFData DescribeJob

Defined in Amazonka.IoT.DescribeJob

Methods

rnf :: DescribeJob -> ()

Eq DescribeJob

Defined in Amazonka.IoT.DescribeJob

Methods

(==) :: DescribeJob -> DescribeJob -> Bool

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

Hashable DescribeJob

Defined in Amazonka.IoT.DescribeJob

Methods

hashWithSalt :: Int -> DescribeJob -> Int

hash :: DescribeJob -> Int

type AWSResponse DescribeJob

Defined in Amazonka.IoT.DescribeJob

type AWSResponse DescribeJob = DescribeJobResponse

type Rep DescribeJob

Defined in Amazonka.IoT.DescribeJob

type Rep DescribeJob = D1 ('MetaData "DescribeJob" "Amazonka.IoT.DescribeJob" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "DescribeJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeJob

Arguments

:: Text

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:

DescribeJob, describeJob_jobId - The unique identifier you assigned to this job when it was created.

Request Lenses

describeJob_jobId :: Lens' DescribeJob Text

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

Destructuring the Response

data DescribeJobResponse

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

Generic DescribeJobResponse

Defined in Amazonka.IoT.DescribeJob

Associated Types

type Rep DescribeJobResponse :: Type -> Type

Methods

from :: DescribeJobResponse -> Rep DescribeJobResponse x

to :: Rep DescribeJobResponse x -> DescribeJobResponse

Read DescribeJobResponse

Defined in Amazonka.IoT.DescribeJob

Methods

readsPrec :: Int -> ReadS DescribeJobResponse

readList :: ReadS [DescribeJobResponse]

readPrec :: ReadPrec DescribeJobResponse

readListPrec :: ReadPrec [DescribeJobResponse]

Show DescribeJobResponse

Defined in Amazonka.IoT.DescribeJob

Methods

showsPrec :: Int -> DescribeJobResponse -> ShowS

show :: DescribeJobResponse -> String

showList :: [DescribeJobResponse] -> ShowS

NFData DescribeJobResponse

Defined in Amazonka.IoT.DescribeJob

Methods

rnf :: DescribeJobResponse -> ()

Eq DescribeJobResponse

Defined in Amazonka.IoT.DescribeJob

Methods

(==) :: DescribeJobResponse -> DescribeJobResponse -> Bool

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

type Rep DescribeJobResponse

Defined in Amazonka.IoT.DescribeJob

type Rep DescribeJobResponse = D1 ('MetaData "DescribeJobResponse" "Amazonka.IoT.DescribeJob" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" '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

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)

An S3 link to the job document.

describeJobResponse_job :: Lens' DescribeJobResponse (Maybe Job)

Information about the job.

describeJobResponse_httpStatus :: Lens' DescribeJobResponse Int

The response's http status code.