Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DescribeJobExecutionRequest

Data needed to make a DescribeJobExecution request.

Hierarchy

  • DescribeJobExecutionRequest

Index

Properties

Optional clientToken

clientToken: undefined | string

An opaque string used to correlate requests and responses. Enter an arbitrary value here and it is reflected in the response.

Optional executionNumber

executionNumber: undefined | number

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

Optional includeJobDocument

includeJobDocument: undefined | false | true

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

jobId

jobId: string

The unique identifier assigned to this job when it was created. Or use $next to return the next pending job execution for a thing (status IN_PROGRESS or QUEUED). In this case, any job executions with status IN_PROGRESS are returned first. Job executions are returned in the order in which they were created.

thingName

thingName: string

The name of the thing associated with the device.

Generated using TypeDoc