You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::IoT::Types::Job
- Inherits:
-
Struct
- Object
- Struct
- Aws::IoT::Types::Job
- Defined in:
- (unknown)
Overview
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 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.
-
#force_canceled ⇒ Boolean
Will be
true
if the job was canceled with the optionalforce
parameter set totrue
. -
#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 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
orCOMPLETED
. -
#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.
#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.
#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 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.
When you specify a value for this parameter, AWS 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/
namespaceId
feature is in public preview.
#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
.
Possible values:
- IN_PROGRESS
- CANCELED
- COMPLETED
- DELETION_IN_PROGRESS
#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.
Possible values:
- CONTINUOUS
- 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. 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
.