Class: Aws::IoT::Types::JobSummary

Inherits:

Struct

• Object
• Struct
• Aws::IoT::Types::JobSummary

Defined in:

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

Overview

The job summary.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #completed_at ⇒ Time

  The time, in seconds since the epoch, when the job completed.

• #created_at ⇒ Time

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

• #is_concurrent ⇒ Boolean

  Indicates whether a job is concurrent.

• #job_arn ⇒ String

  The job ARN.

• #job_id ⇒ String

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

• #last_updated_at ⇒ Time

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

• #status ⇒ String

  The job summary status.

• #target_selection ⇒ String

  Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT).

• #thing_group_id ⇒ String

  The ID of the thing group.

Instance Attribute Details

#completed_at ⇒ Time

The time, in seconds since the epoch, when the job completed.

Returns:

• (Time)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 8822

class JobSummary < Struct.new(
  :job_arn,
  :job_id,
  :thing_group_id,
  :target_selection,
  :status,
  :created_at,
  :last_updated_at,
  :completed_at,
  :is_concurrent)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Time

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

Returns:

• (Time)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 8822

class JobSummary < Struct.new(
  :job_arn,
  :job_id,
  :thing_group_id,
  :target_selection,
  :status,
  :created_at,
  :last_updated_at,
  :completed_at,
  :is_concurrent)
  SENSITIVE = []
  include Aws::Structure
end

#is_concurrent ⇒ Boolean

Indicates whether a job is concurrent. Will be true when a job is rolling out new job executions or canceling previously created executions, otherwise false.

Returns:

• (Boolean)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 8822

class JobSummary < Struct.new(
  :job_arn,
  :job_id,
  :thing_group_id,
  :target_selection,
  :status,
  :created_at,
  :last_updated_at,
  :completed_at,
  :is_concurrent)
  SENSITIVE = []
  include Aws::Structure
end

#job_arn ⇒ String

The job ARN.

Returns:

• (String)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 8822

class JobSummary < Struct.new(
  :job_arn,
  :job_id,
  :thing_group_id,
  :target_selection,
  :status,
  :created_at,
  :last_updated_at,
  :completed_at,
  :is_concurrent)
  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-iot/lib/aws-sdk-iot/types.rb', line 8822

class JobSummary < Struct.new(
  :job_arn,
  :job_id,
  :thing_group_id,
  :target_selection,
  :status,
  :created_at,
  :last_updated_at,
  :completed_at,
  :is_concurrent)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_at ⇒ Time

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

Returns:

• (Time)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 8822

class JobSummary < Struct.new(
  :job_arn,
  :job_id,
  :thing_group_id,
  :target_selection,
  :status,
  :created_at,
  :last_updated_at,
  :completed_at,
  :is_concurrent)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The job summary status.

Returns:

• (String)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 8822

class JobSummary < Struct.new(
  :job_arn,
  :job_id,
  :thing_group_id,
  :target_selection,
  :status,
  :created_at,
  :last_updated_at,
  :completed_at,
  :is_concurrent)
  SENSITIVE = []
  include Aws::Structure
end

#target_selection ⇒ String

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.

We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created.

Returns:

• (String)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 8822

class JobSummary < Struct.new(
  :job_arn,
  :job_id,
  :thing_group_id,
  :target_selection,
  :status,
  :created_at,
  :last_updated_at,
  :completed_at,
  :is_concurrent)
  SENSITIVE = []
  include Aws::Structure
end

#thing_group_id ⇒ String

The ID of the thing group.

Returns:

• (String)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 8822

class JobSummary < Struct.new(
  :job_arn,
  :job_id,
  :thing_group_id,
  :target_selection,
  :status,
  :created_at,
  :last_updated_at,
  :completed_at,
  :is_concurrent)
  SENSITIVE = []
  include Aws::Structure
end