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

Class: Aws::IoT::Types::JobExecution

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

Overview

The job execution object represents the execution of a job on a particular device.

Instance Attribute Summary collapse

Instance Attribute Details

#execution_numberInteger

A string (consisting of the digits "0" through "9") which identifies this particular job execution on this particular device. It can be used in commands which return or update job execution information.

Returns:

  • (Integer)


3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3965

class JobExecution < Struct.new(
  :job_id,
  :status,
  :force_canceled,
  :status_details,
  :thing_arn,
  :queued_at,
  :started_at,
  :last_updated_at,
  :execution_number,
  :version_number)
  include Aws::Structure
end

#force_canceledBoolean

Will be true if the job execution was canceled with the optional force parameter set to true.

Returns:

  • (Boolean)


3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3965

class JobExecution < Struct.new(
  :job_id,
  :status,
  :force_canceled,
  :status_details,
  :thing_arn,
  :queued_at,
  :started_at,
  :last_updated_at,
  :execution_number,
  :version_number)
  include Aws::Structure
end

#job_idString

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

Returns:

  • (String)


3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3965

class JobExecution < Struct.new(
  :job_id,
  :status,
  :force_canceled,
  :status_details,
  :thing_arn,
  :queued_at,
  :started_at,
  :last_updated_at,
  :execution_number,
  :version_number)
  include Aws::Structure
end

#last_updated_atTime

The time, in milliseconds since the epoch, when the job execution was last updated.

Returns:

  • (Time)


3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3965

class JobExecution < Struct.new(
  :job_id,
  :status,
  :force_canceled,
  :status_details,
  :thing_arn,
  :queued_at,
  :started_at,
  :last_updated_at,
  :execution_number,
  :version_number)
  include Aws::Structure
end

#queued_atTime

The time, in milliseconds since the epoch, when the job execution was queued.

Returns:

  • (Time)


3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3965

class JobExecution < Struct.new(
  :job_id,
  :status,
  :force_canceled,
  :status_details,
  :thing_arn,
  :queued_at,
  :started_at,
  :last_updated_at,
  :execution_number,
  :version_number)
  include Aws::Structure
end

#started_atTime

The time, in milliseconds since the epoch, when the job execution started.

Returns:

  • (Time)


3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3965

class JobExecution < Struct.new(
  :job_id,
  :status,
  :force_canceled,
  :status_details,
  :thing_arn,
  :queued_at,
  :started_at,
  :last_updated_at,
  :execution_number,
  :version_number)
  include Aws::Structure
end

#statusString

The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCESS, CANCELED, or REJECTED).

Returns:

  • (String)


3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3965

class JobExecution < Struct.new(
  :job_id,
  :status,
  :force_canceled,
  :status_details,
  :thing_arn,
  :queued_at,
  :started_at,
  :last_updated_at,
  :execution_number,
  :version_number)
  include Aws::Structure
end

#status_detailsTypes::JobExecutionStatusDetails

A collection of name/value pairs that describe the status of the job execution.



3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3965

class JobExecution < Struct.new(
  :job_id,
  :status,
  :force_canceled,
  :status_details,
  :thing_arn,
  :queued_at,
  :started_at,
  :last_updated_at,
  :execution_number,
  :version_number)
  include Aws::Structure
end

#thing_arnString

The ARN of the thing on which the job execution is running.

Returns:

  • (String)


3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3965

class JobExecution < Struct.new(
  :job_id,
  :status,
  :force_canceled,
  :status_details,
  :thing_arn,
  :queued_at,
  :started_at,
  :last_updated_at,
  :execution_number,
  :version_number)
  include Aws::Structure
end

#version_numberInteger

The version of the job execution. Job execution versions are incremented each time they are updated by a device.

Returns:

  • (Integer)


3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3965

class JobExecution < Struct.new(
  :job_id,
  :status,
  :force_canceled,
  :status_details,
  :thing_arn,
  :queued_at,
  :started_at,
  :last_updated_at,
  :execution_number,
  :version_number)
  include Aws::Structure
end