Class: Aws::IoT::Types::Job

Inherits:

Struct

• Object
• Struct
• Aws::IoT::Types::Job

Defined in:

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

Overview

The Job object contains details about a job.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #abort_config ⇒ Types::AbortConfig

  Configuration for criteria to abort the job.

• #comment ⇒ String

  If the job was updated, describes the reason for the update.

• #completed_at ⇒ Time

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

• #created_at ⇒ Time

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

• #description ⇒ String

  A short text description of the job.

• #document_parameters ⇒ Hash<String,String>

  A key-value map that pairs the patterns that need to be replaced in a managed template job document schema.

• #force_canceled ⇒ Boolean

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

• #job_arn ⇒ String

  An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".

• #job_executions_retry_config ⇒ Types::JobExecutionsRetryConfig

  The configuration for the criteria to retry the job.

• #job_executions_rollout_config ⇒ Types::JobExecutionsRolloutConfig

  Allows you to create a staged rollout of a job.

• #job_id ⇒ String

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

• #job_process_details ⇒ Types::JobProcessDetails

  Details about the job process.

• #job_template_arn ⇒ String

  The ARN of the job template used to create the job.

• #last_updated_at ⇒ Time

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

• #namespace_id ⇒ String

  The namespace used to indicate that a job is a customer-managed job.

• #presigned_url_config ⇒ Types::PresignedUrlConfig

  Configuration for pre-signed S3 URLs.

• #reason_code ⇒ String

  If the job was updated, provides the reason code for the update.

• #status ⇒ String

  The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or COMPLETED.

• #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).

• #targets ⇒ Array<String>

  A list of IoT things and thing groups to which the job should be sent.

• #timeout_config ⇒ Types::TimeoutConfig

  Specifies the amount of time each device has to finish its execution of the job.

Instance Attribute Details

#abort_config ⇒ Types::AbortConfig

Configuration for criteria to abort the job.

Returns:

• (Types::AbortConfig)

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

class Job < Struct.new(
  :job_arn,
  :job_id,
  :target_selection,
  :status,
  :force_canceled,
  :reason_code,
  :comment,
  :targets,
  :description,
  :presigned_url_config,
  :job_executions_rollout_config,
  :abort_config,
  :created_at,
  :last_updated_at,
  :completed_at,
  :job_process_details,
  :timeout_config,
  :namespace_id,
  :job_template_arn,
  :job_executions_retry_config,
  :document_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#comment ⇒ String

If the job was updated, describes the reason for the update.

Returns:

• (String)

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

class Job < Struct.new(
  :job_arn,
  :job_id,
  :target_selection,
  :status,
  :force_canceled,
  :reason_code,
  :comment,
  :targets,
  :description,
  :presigned_url_config,
  :job_executions_rollout_config,
  :abort_config,
  :created_at,
  :last_updated_at,
  :completed_at,
  :job_process_details,
  :timeout_config,
  :namespace_id,
  :job_template_arn,
  :job_executions_retry_config,
  :document_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#completed_at ⇒ Time

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

Returns:

• (Time)

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

class Job < Struct.new(
  :job_arn,
  :job_id,
  :target_selection,
  :status,
  :force_canceled,
  :reason_code,
  :comment,
  :targets,
  :description,
  :presigned_url_config,
  :job_executions_rollout_config,
  :abort_config,
  :created_at,
  :last_updated_at,
  :completed_at,
  :job_process_details,
  :timeout_config,
  :namespace_id,
  :job_template_arn,
  :job_executions_retry_config,
  :document_parameters)
  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 10183

class Job < Struct.new(
  :job_arn,
  :job_id,
  :target_selection,
  :status,
  :force_canceled,
  :reason_code,
  :comment,
  :targets,
  :description,
  :presigned_url_config,
  :job_executions_rollout_config,
  :abort_config,
  :created_at,
  :last_updated_at,
  :completed_at,
  :job_process_details,
  :timeout_config,
  :namespace_id,
  :job_template_arn,
  :job_executions_retry_config,
  :document_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A short text description of the job.

Returns:

• (String)

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

class Job < Struct.new(
  :job_arn,
  :job_id,
  :target_selection,
  :status,
  :force_canceled,
  :reason_code,
  :comment,
  :targets,
  :description,
  :presigned_url_config,
  :job_executions_rollout_config,
  :abort_config,
  :created_at,
  :last_updated_at,
  :completed_at,
  :job_process_details,
  :timeout_config,
  :namespace_id,
  :job_template_arn,
  :job_executions_retry_config,
  :document_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#document_parameters ⇒ Hash<String,String>

A key-value map that pairs the patterns that need to be replaced in a managed template job document schema. You can use the description of each key as a guidance to specify the inputs during runtime when creating a job.

Returns:

• (Hash<String,String>)

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

class Job < Struct.new(
  :job_arn,
  :job_id,
  :target_selection,
  :status,
  :force_canceled,
  :reason_code,
  :comment,
  :targets,
  :description,
  :presigned_url_config,
  :job_executions_rollout_config,
  :abort_config,
  :created_at,
  :last_updated_at,
  :completed_at,
  :job_process_details,
  :timeout_config,
  :namespace_id,
  :job_template_arn,
  :job_executions_retry_config,
  :document_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#force_canceled ⇒ Boolean

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

Returns:

• (Boolean)

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

class Job < Struct.new(
  :job_arn,
  :job_id,
  :target_selection,
  :status,
  :force_canceled,
  :reason_code,
  :comment,
  :targets,
  :description,
  :presigned_url_config,
  :job_executions_rollout_config,
  :abort_config,
  :created_at,
  :last_updated_at,
  :completed_at,
  :job_process_details,
  :timeout_config,
  :namespace_id,
  :job_template_arn,
  :job_executions_retry_config,
  :document_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#job_arn ⇒ String

An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".

Returns:

• (String)

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

class Job < Struct.new(
  :job_arn,
  :job_id,
  :target_selection,
  :status,
  :force_canceled,
  :reason_code,
  :comment,
  :targets,
  :description,
  :presigned_url_config,
  :job_executions_rollout_config,
  :abort_config,
  :created_at,
  :last_updated_at,
  :completed_at,
  :job_process_details,
  :timeout_config,
  :namespace_id,
  :job_template_arn,
  :job_executions_retry_config,
  :document_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#job_executions_retry_config ⇒ Types::JobExecutionsRetryConfig

The configuration for the criteria to retry the job.

Returns:

• (Types::JobExecutionsRetryConfig)

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

class Job < Struct.new(
  :job_arn,
  :job_id,
  :target_selection,
  :status,
  :force_canceled,
  :reason_code,
  :comment,
  :targets,
  :description,
  :presigned_url_config,
  :job_executions_rollout_config,
  :abort_config,
  :created_at,
  :last_updated_at,
  :completed_at,
  :job_process_details,
  :timeout_config,
  :namespace_id,
  :job_template_arn,
  :job_executions_retry_config,
  :document_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#job_executions_rollout_config ⇒ Types::JobExecutionsRolloutConfig

Allows you to create a staged rollout of a job.

Returns:

• (Types::JobExecutionsRolloutConfig)

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

class Job < Struct.new(
  :job_arn,
  :job_id,
  :target_selection,
  :status,
  :force_canceled,
  :reason_code,
  :comment,
  :targets,
  :description,
  :presigned_url_config,
  :job_executions_rollout_config,
  :abort_config,
  :created_at,
  :last_updated_at,
  :completed_at,
  :job_process_details,
  :timeout_config,
  :namespace_id,
  :job_template_arn,
  :job_executions_retry_config,
  :document_parameters)
  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 10183

class Job < Struct.new(
  :job_arn,
  :job_id,
  :target_selection,
  :status,
  :force_canceled,
  :reason_code,
  :comment,
  :targets,
  :description,
  :presigned_url_config,
  :job_executions_rollout_config,
  :abort_config,
  :created_at,
  :last_updated_at,
  :completed_at,
  :job_process_details,
  :timeout_config,
  :namespace_id,
  :job_template_arn,
  :job_executions_retry_config,
  :document_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#job_process_details ⇒ Types::JobProcessDetails

Details about the job process.

Returns:

• (Types::JobProcessDetails)

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

class Job < Struct.new(
  :job_arn,
  :job_id,
  :target_selection,
  :status,
  :force_canceled,
  :reason_code,
  :comment,
  :targets,
  :description,
  :presigned_url_config,
  :job_executions_rollout_config,
  :abort_config,
  :created_at,
  :last_updated_at,
  :completed_at,
  :job_process_details,
  :timeout_config,
  :namespace_id,
  :job_template_arn,
  :job_executions_retry_config,
  :document_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#job_template_arn ⇒ String

The ARN of the job template used to create the job.

Returns:

• (String)

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

class Job < Struct.new(
  :job_arn,
  :job_id,
  :target_selection,
  :status,
  :force_canceled,
  :reason_code,
  :comment,
  :targets,
  :description,
  :presigned_url_config,
  :job_executions_rollout_config,
  :abort_config,
  :created_at,
  :last_updated_at,
  :completed_at,
  :job_process_details,
  :timeout_config,
  :namespace_id,
  :job_template_arn,
  :job_executions_retry_config,
  :document_parameters)
  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 10183

class Job < Struct.new(
  :job_arn,
  :job_id,
  :target_selection,
  :status,
  :force_canceled,
  :reason_code,
  :comment,
  :targets,
  :description,
  :presigned_url_config,
  :job_executions_rollout_config,
  :abort_config,
  :created_at,
  :last_updated_at,
  :completed_at,
  :job_process_details,
  :timeout_config,
  :namespace_id,
  :job_template_arn,
  :job_executions_retry_config,
  :document_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#namespace_id ⇒ String

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is in public preview.

Returns:

• (String)

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

class Job < Struct.new(
  :job_arn,
  :job_id,
  :target_selection,
  :status,
  :force_canceled,
  :reason_code,
  :comment,
  :targets,
  :description,
  :presigned_url_config,
  :job_executions_rollout_config,
  :abort_config,
  :created_at,
  :last_updated_at,
  :completed_at,
  :job_process_details,
  :timeout_config,
  :namespace_id,
  :job_template_arn,
  :job_executions_retry_config,
  :document_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#presigned_url_config ⇒ Types::PresignedUrlConfig

Configuration for pre-signed S3 URLs.

Returns:

• (Types::PresignedUrlConfig)

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

class Job < Struct.new(
  :job_arn,
  :job_id,
  :target_selection,
  :status,
  :force_canceled,
  :reason_code,
  :comment,
  :targets,
  :description,
  :presigned_url_config,
  :job_executions_rollout_config,
  :abort_config,
  :created_at,
  :last_updated_at,
  :completed_at,
  :job_process_details,
  :timeout_config,
  :namespace_id,
  :job_template_arn,
  :job_executions_retry_config,
  :document_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#reason_code ⇒ String

If the job was updated, provides the reason code for the update.

Returns:

• (String)

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

class Job < Struct.new(
  :job_arn,
  :job_id,
  :target_selection,
  :status,
  :force_canceled,
  :reason_code,
  :comment,
  :targets,
  :description,
  :presigned_url_config,
  :job_executions_rollout_config,
  :abort_config,
  :created_at,
  :last_updated_at,
  :completed_at,
  :job_process_details,
  :timeout_config,
  :namespace_id,
  :job_template_arn,
  :job_executions_retry_config,
  :document_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or COMPLETED.

Returns:

• (String)

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

class Job < Struct.new(
  :job_arn,
  :job_id,
  :target_selection,
  :status,
  :force_canceled,
  :reason_code,
  :comment,
  :targets,
  :description,
  :presigned_url_config,
  :job_executions_rollout_config,
  :abort_config,
  :created_at,
  :last_updated_at,
  :completed_at,
  :job_process_details,
  :timeout_config,
  :namespace_id,
  :job_template_arn,
  :job_executions_retry_config,
  :document_parameters)
  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 device when the thing representing the device is added to a target group, even after the job was completed by all things originally in the group.

Returns:

• (String)

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

class Job < Struct.new(
  :job_arn,
  :job_id,
  :target_selection,
  :status,
  :force_canceled,
  :reason_code,
  :comment,
  :targets,
  :description,
  :presigned_url_config,
  :job_executions_rollout_config,
  :abort_config,
  :created_at,
  :last_updated_at,
  :completed_at,
  :job_process_details,
  :timeout_config,
  :namespace_id,
  :job_template_arn,
  :job_executions_retry_config,
  :document_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#targets ⇒ Array<String>

A list of IoT things and thing groups to which the job should be sent.

Returns:

• (Array<String>)

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

class Job < Struct.new(
  :job_arn,
  :job_id,
  :target_selection,
  :status,
  :force_canceled,
  :reason_code,
  :comment,
  :targets,
  :description,
  :presigned_url_config,
  :job_executions_rollout_config,
  :abort_config,
  :created_at,
  :last_updated_at,
  :completed_at,
  :job_process_details,
  :timeout_config,
  :namespace_id,
  :job_template_arn,
  :job_executions_retry_config,
  :document_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#timeout_config ⇒ Types::TimeoutConfig

Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.

Returns:

• (Types::TimeoutConfig)

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

class Job < Struct.new(
  :job_arn,
  :job_id,
  :target_selection,
  :status,
  :force_canceled,
  :reason_code,
  :comment,
  :targets,
  :description,
  :presigned_url_config,
  :job_executions_rollout_config,
  :abort_config,
  :created_at,
  :last_updated_at,
  :completed_at,
  :job_process_details,
  :timeout_config,
  :namespace_id,
  :job_template_arn,
  :job_executions_retry_config,
  :document_parameters)
  SENSITIVE = []
  include Aws::Structure
end