AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::IoTJobsDataPlane::Types::DescribeJobExecutionRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DescribeJobExecutionRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  job_id: "DescribeJobExecutionJobId", # required
  thing_name: "ThingName", # required
  include_job_document: false,
  execution_number: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#execution_numberInteger

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

Returns:

  • (Integer)

    Optional.

#include_job_documentBoolean

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

Returns:

  • (Boolean)

    Optional.

#job_idString

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

Returns:

  • (String)

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

#thing_nameString

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

Returns:

  • (String)

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