Amazonka.IoTJobsData.DescribeJobExecution

Gets details of a job execution.

Creating a Request

data DescribeJobExecution

See: newDescribeJobExecution smart constructor.

Constructors

DescribeJobExecution'

Fields

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

• includeJobDocument :: Maybe Bool

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

• 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

ToHeaders DescribeJobExecution

Defined in Amazonka.IoTJobsData.DescribeJobExecution

Methods

toHeaders :: DescribeJobExecution -> [Header]

ToPath DescribeJobExecution

Defined in Amazonka.IoTJobsData.DescribeJobExecution

Methods

toPath :: DescribeJobExecution -> ByteString

ToQuery DescribeJobExecution

Defined in Amazonka.IoTJobsData.DescribeJobExecution

Methods

toQuery :: DescribeJobExecution -> QueryString

AWSRequest DescribeJobExecution

Defined in Amazonka.IoTJobsData.DescribeJobExecution

Associated Types

type AWSResponse DescribeJobExecution

Methods

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

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

Generic DescribeJobExecution

Defined in Amazonka.IoTJobsData.DescribeJobExecution

Associated Types

type Rep DescribeJobExecution :: Type -> Type

Methods

from :: DescribeJobExecution -> Rep DescribeJobExecution x

to :: Rep DescribeJobExecution x -> DescribeJobExecution

Read DescribeJobExecution

Defined in Amazonka.IoTJobsData.DescribeJobExecution

Methods

readsPrec :: Int -> ReadS DescribeJobExecution

readList :: ReadS [DescribeJobExecution]

readPrec :: ReadPrec DescribeJobExecution

readListPrec :: ReadPrec [DescribeJobExecution]

Show DescribeJobExecution

Defined in Amazonka.IoTJobsData.DescribeJobExecution

Methods

showsPrec :: Int -> DescribeJobExecution -> ShowS

show :: DescribeJobExecution -> String

showList :: [DescribeJobExecution] -> ShowS

NFData DescribeJobExecution

Defined in Amazonka.IoTJobsData.DescribeJobExecution

Methods

rnf :: DescribeJobExecution -> ()

Eq DescribeJobExecution

Defined in Amazonka.IoTJobsData.DescribeJobExecution

Methods

(==) :: DescribeJobExecution -> DescribeJobExecution -> Bool

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

Hashable DescribeJobExecution

Defined in Amazonka.IoTJobsData.DescribeJobExecution

Methods

hashWithSalt :: Int -> DescribeJobExecution -> Int

hash :: DescribeJobExecution -> Int

type AWSResponse DescribeJobExecution

Defined in Amazonka.IoTJobsData.DescribeJobExecution

type AWSResponse DescribeJobExecution = DescribeJobExecutionResponse

type Rep DescribeJobExecution

Defined in Amazonka.IoTJobsData.DescribeJobExecution

type Rep DescribeJobExecution = D1 ('MetaData "DescribeJobExecution" "Amazonka.IoTJobsData.DescribeJobExecution" "amazonka-iot-jobs-dataplane-2.0-8C3LLBSYBtOF7RBF3JFCku" 'False) (C1 ('MetaCons "DescribeJobExecution'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "executionNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "includeJobDocument") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "thingName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDescribeJobExecution

Arguments

:: Text

DescribeJobExecution

-> Text

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:

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

DescribeJobExecution, describeJobExecution_jobId - The unique identifier assigned to this job when it was created.

DescribeJobExecution, describeJobExecution_thingName - The thing name associated with the device the job execution is running on.

Request Lenses

describeJobExecution_executionNumber :: Lens' DescribeJobExecution (Maybe Integer)

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

describeJobExecution_includeJobDocument :: Lens' DescribeJobExecution (Maybe Bool)

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

describeJobExecution_jobId :: Lens' DescribeJobExecution Text

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

describeJobExecution_thingName :: Lens' DescribeJobExecution Text

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

Destructuring the Response

data DescribeJobExecutionResponse

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

Generic DescribeJobExecutionResponse

Defined in Amazonka.IoTJobsData.DescribeJobExecution

Associated Types

type Rep DescribeJobExecutionResponse :: Type -> Type

Methods

from :: DescribeJobExecutionResponse -> Rep DescribeJobExecutionResponse x

to :: Rep DescribeJobExecutionResponse x -> DescribeJobExecutionResponse

Read DescribeJobExecutionResponse

Defined in Amazonka.IoTJobsData.DescribeJobExecution

Methods

readsPrec :: Int -> ReadS DescribeJobExecutionResponse

readList :: ReadS [DescribeJobExecutionResponse]

readPrec :: ReadPrec DescribeJobExecutionResponse

readListPrec :: ReadPrec [DescribeJobExecutionResponse]

Show DescribeJobExecutionResponse

Defined in Amazonka.IoTJobsData.DescribeJobExecution

Methods

showsPrec :: Int -> DescribeJobExecutionResponse -> ShowS

show :: DescribeJobExecutionResponse -> String

showList :: [DescribeJobExecutionResponse] -> ShowS

NFData DescribeJobExecutionResponse

Defined in Amazonka.IoTJobsData.DescribeJobExecution

Methods

rnf :: DescribeJobExecutionResponse -> ()

Eq DescribeJobExecutionResponse

Defined in Amazonka.IoTJobsData.DescribeJobExecution

Methods

(==) :: DescribeJobExecutionResponse -> DescribeJobExecutionResponse -> Bool

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

type Rep DescribeJobExecutionResponse

Defined in Amazonka.IoTJobsData.DescribeJobExecution

type Rep DescribeJobExecutionResponse = D1 ('MetaData "DescribeJobExecutionResponse" "Amazonka.IoTJobsData.DescribeJobExecution" "amazonka-iot-jobs-dataplane-2.0-8C3LLBSYBtOF7RBF3JFCku" '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

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)

Contains data about a job execution.

describeJobExecutionResponse_httpStatus :: Lens' DescribeJobExecutionResponse Int

The response's http status code.