Class: Aws::IoTJobsDataPlane::Types::JobExecution

Inherits:

Struct

• Object
• Struct
• Aws::IoTJobsDataPlane::Types::JobExecution

Defined in:

gems/aws-sdk-iotjobsdataplane/lib/aws-sdk-iotjobsdataplane/types.rb

Overview

Contains data about a job execution.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #approximate_seconds_before_timed_out ⇒ Integer

  The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT.

• #execution_number ⇒ Integer

  A number that identifies a particular job execution on a particular device.

• #job_document ⇒ String

  The content of the job document.

• #job_id ⇒ String

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

• #last_updated_at ⇒ Integer

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

• #queued_at ⇒ Integer

  The time, in seconds since the epoch, when the job execution was enqueued.

• #started_at ⇒ Integer

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

• #status ⇒ String

  The status of the job execution.

• #status_details ⇒ Hash<String,String>

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

• #thing_name ⇒ String

  The name of the thing that is executing the job.

• #version_number ⇒ Integer

  The version of the job execution.

Instance Attribute Details

#approximate_seconds_before_timed_out ⇒ Integer

The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT. The actual job execution timeout can occur up to 60 seconds later than the estimated duration.

Returns:

• (Integer)

# File 'gems/aws-sdk-iotjobsdataplane/lib/aws-sdk-iotjobsdataplane/types.rb', line 251

class JobExecution < Struct.new(
  :job_id,
  :thing_name,
  :status,
  :status_details,
  :queued_at,
  :started_at,
  :last_updated_at,
  :approximate_seconds_before_timed_out,
  :version_number,
  :execution_number,
  :job_document)
  SENSITIVE = []
  include Aws::Structure
end

#execution_number ⇒ Integer

A number that identifies a particular job execution on a particular device. It can be used later in commands that return or update job execution information.

Returns:

• (Integer)

# File 'gems/aws-sdk-iotjobsdataplane/lib/aws-sdk-iotjobsdataplane/types.rb', line 251

class JobExecution < Struct.new(
  :job_id,
  :thing_name,
  :status,
  :status_details,
  :queued_at,
  :started_at,
  :last_updated_at,
  :approximate_seconds_before_timed_out,
  :version_number,
  :execution_number,
  :job_document)
  SENSITIVE = []
  include Aws::Structure
end

#job_document ⇒ String

The content of the job document.

Returns:

• (String)

# File 'gems/aws-sdk-iotjobsdataplane/lib/aws-sdk-iotjobsdataplane/types.rb', line 251

class JobExecution < Struct.new(
  :job_id,
  :thing_name,
  :status,
  :status_details,
  :queued_at,
  :started_at,
  :last_updated_at,
  :approximate_seconds_before_timed_out,
  :version_number,
  :execution_number,
  :job_document)
  SENSITIVE = []
  include Aws::Structure
end

#job_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-iotjobsdataplane/lib/aws-sdk-iotjobsdataplane/types.rb', line 251

class JobExecution < Struct.new(
  :job_id,
  :thing_name,
  :status,
  :status_details,
  :queued_at,
  :started_at,
  :last_updated_at,
  :approximate_seconds_before_timed_out,
  :version_number,
  :execution_number,
  :job_document)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_at ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-iotjobsdataplane/lib/aws-sdk-iotjobsdataplane/types.rb', line 251

class JobExecution < Struct.new(
  :job_id,
  :thing_name,
  :status,
  :status_details,
  :queued_at,
  :started_at,
  :last_updated_at,
  :approximate_seconds_before_timed_out,
  :version_number,
  :execution_number,
  :job_document)
  SENSITIVE = []
  include Aws::Structure
end

#queued_at ⇒ Integer

The time, in seconds since the epoch, when the job execution was enqueued.

Returns:

• (Integer)

# File 'gems/aws-sdk-iotjobsdataplane/lib/aws-sdk-iotjobsdataplane/types.rb', line 251

class JobExecution < Struct.new(
  :job_id,
  :thing_name,
  :status,
  :status_details,
  :queued_at,
  :started_at,
  :last_updated_at,
  :approximate_seconds_before_timed_out,
  :version_number,
  :execution_number,
  :job_document)
  SENSITIVE = []
  include Aws::Structure
end

#started_at ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-iotjobsdataplane/lib/aws-sdk-iotjobsdataplane/types.rb', line 251

class JobExecution < Struct.new(
  :job_id,
  :thing_name,
  :status,
  :status_details,
  :queued_at,
  :started_at,
  :last_updated_at,
  :approximate_seconds_before_timed_out,
  :version_number,
  :execution_number,
  :job_document)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS", "FAILED", "SUCCESS", "CANCELED", "TIMED_OUT", "REJECTED", or "REMOVED".

Returns:

• (String)

# File 'gems/aws-sdk-iotjobsdataplane/lib/aws-sdk-iotjobsdataplane/types.rb', line 251

class JobExecution < Struct.new(
  :job_id,
  :thing_name,
  :status,
  :status_details,
  :queued_at,
  :started_at,
  :last_updated_at,
  :approximate_seconds_before_timed_out,
  :version_number,
  :execution_number,
  :job_document)
  SENSITIVE = []
  include Aws::Structure
end

#status_details ⇒ Hash<String,String>

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

The maximum length of the value in the name/value pair is 1,024 characters.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-iotjobsdataplane/lib/aws-sdk-iotjobsdataplane/types.rb', line 251

class JobExecution < Struct.new(
  :job_id,
  :thing_name,
  :status,
  :status_details,
  :queued_at,
  :started_at,
  :last_updated_at,
  :approximate_seconds_before_timed_out,
  :version_number,
  :execution_number,
  :job_document)
  SENSITIVE = []
  include Aws::Structure
end

#thing_name ⇒ String

The name of the thing that is executing the job.

Returns:

• (String)

# File 'gems/aws-sdk-iotjobsdataplane/lib/aws-sdk-iotjobsdataplane/types.rb', line 251

class JobExecution < Struct.new(
  :job_id,
  :thing_name,
  :status,
  :status_details,
  :queued_at,
  :started_at,
  :last_updated_at,
  :approximate_seconds_before_timed_out,
  :version_number,
  :execution_number,
  :job_document)
  SENSITIVE = []
  include Aws::Structure
end

#version_number ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-iotjobsdataplane/lib/aws-sdk-iotjobsdataplane/types.rb', line 251

class JobExecution < Struct.new(
  :job_id,
  :thing_name,
  :status,
  :status_details,
  :queued_at,
  :started_at,
  :last_updated_at,
  :approximate_seconds_before_timed_out,
  :version_number,
  :execution_number,
  :job_document)
  SENSITIVE = []
  include Aws::Structure
end