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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iotjobsdataplane/lib/aws-sdk-iotjobsdataplane/types.rb

Constant Summary collapse

SENSITIVE =
[]

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)


45
46
47
48
49
50
51
52
# File 'gems/aws-sdk-iotjobsdataplane/lib/aws-sdk-iotjobsdataplane/types.rb', line 45

class DescribeJobExecutionRequest < Struct.new(
  :job_id,
  :thing_name,
  :include_job_document,
  :execution_number)
  SENSITIVE = []
  include Aws::Structure
end

#include_job_documentBoolean

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

Returns:

  • (Boolean)


45
46
47
48
49
50
51
52
# File 'gems/aws-sdk-iotjobsdataplane/lib/aws-sdk-iotjobsdataplane/types.rb', line 45

class DescribeJobExecutionRequest < Struct.new(
  :job_id,
  :thing_name,
  :include_job_document,
  :execution_number)
  SENSITIVE = []
  include Aws::Structure
end

#job_idString

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

Returns:

  • (String)


45
46
47
48
49
50
51
52
# File 'gems/aws-sdk-iotjobsdataplane/lib/aws-sdk-iotjobsdataplane/types.rb', line 45

class DescribeJobExecutionRequest < Struct.new(
  :job_id,
  :thing_name,
  :include_job_document,
  :execution_number)
  SENSITIVE = []
  include Aws::Structure
end

#thing_nameString

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

Returns:

  • (String)


45
46
47
48
49
50
51
52
# File 'gems/aws-sdk-iotjobsdataplane/lib/aws-sdk-iotjobsdataplane/types.rb', line 45

class DescribeJobExecutionRequest < Struct.new(
  :job_id,
  :thing_name,
  :include_job_document,
  :execution_number)
  SENSITIVE = []
  include Aws::Structure
end