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

Inherits:

Struct

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

show all

Includes:: Structure

Defined in:: lib/aws-sdk-iot/types.rb

Overview

The ‘Job` object contains details about a job.

Instance Attribute Summary collapse

#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 milliseconds since the epoch, when the job was completed.
#created_at ⇒ Time

The time, in milliseconds since the epoch, when the job was created.
#description ⇒ String

A short text description of the job.
#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_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.
#last_updated_at ⇒ Time

The time, in milliseconds since the epoch, when the job was last updated.
#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 'lib/aws-sdk-iot/types.rb', line 5493

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)
  include Aws::Structure
end

#comment ⇒ `String`

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

Returns:

(String)

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

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)
  include Aws::Structure
end

#completed_at ⇒ `Time`

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

Returns:

(Time)

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

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)
  include Aws::Structure
end

#created_at ⇒ `Time`

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

Returns:

(Time)

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

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)
  include Aws::Structure
end

#description ⇒ `String`

A short text description of the job.

Returns:

(String)

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

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)
  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 'lib/aws-sdk-iot/types.rb', line 5493

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)
  include Aws::Structure
end

#job_arn ⇒ `String`

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

Returns:

(String)

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

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)
  include Aws::Structure
end

#job_executions_rollout_config ⇒ `Types::JobExecutionsRolloutConfig`

Allows you to create a staged rollout of a job.

Returns:

(Types::JobExecutionsRolloutConfig)

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

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)
  include Aws::Structure
end

#job_id ⇒ `String`

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

Returns:

(String)

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

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)
  include Aws::Structure
end

#job_process_details ⇒ `Types::JobProcessDetails`

Details about the job process.

Returns:

(Types::JobProcessDetails)

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

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)
  include Aws::Structure
end

#last_updated_at ⇒ `Time`

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

Returns:

(Time)

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

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)
  include Aws::Structure
end

#presigned_url_config ⇒ `Types::PresignedUrlConfig`

Configuration for pre-signed S3 URLs.

Returns:

(Types::PresignedUrlConfig)

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

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)
  include Aws::Structure
end

#reason_code ⇒ `String`

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

Returns:

(String)

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

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)
  include Aws::Structure
end

#status ⇒ `String`

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

Returns:

(String)

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

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)
  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 'lib/aws-sdk-iot/types.rb', line 5493

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)
  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 'lib/aws-sdk-iot/types.rb', line 5493

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)
  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 'lib/aws-sdk-iot/types.rb', line 5493

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)
  include Aws::Structure
end

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

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#abort_config ⇒ Types::AbortConfig

#comment ⇒ String

#completed_at ⇒ Time

#created_at ⇒ Time

#description ⇒ String

#force_canceled ⇒ Boolean

#job_arn ⇒ String

#job_executions_rollout_config ⇒ Types::JobExecutionsRolloutConfig

#job_id ⇒ String

#job_process_details ⇒ Types::JobProcessDetails

#last_updated_at ⇒ Time

#presigned_url_config ⇒ Types::PresignedUrlConfig

#reason_code ⇒ String

#status ⇒ String

#target_selection ⇒ String

#targets ⇒ Array<String>

#timeout_config ⇒ Types::TimeoutConfig

#abort_config ⇒ `Types::AbortConfig`

#comment ⇒ `String`

#completed_at ⇒ `Time`

#created_at ⇒ `Time`

#description ⇒ `String`

#force_canceled ⇒ `Boolean`

#job_arn ⇒ `String`

#job_executions_rollout_config ⇒ `Types::JobExecutionsRolloutConfig`

#job_id ⇒ `String`

#job_process_details ⇒ `Types::JobProcessDetails`

#last_updated_at ⇒ `Time`

#presigned_url_config ⇒ `Types::PresignedUrlConfig`

#reason_code ⇒ `String`

#status ⇒ `String`

#target_selection ⇒ `String`

#targets ⇒ `Array<String>`

#timeout_config ⇒ `Types::TimeoutConfig`