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 collapse
- SENSITIVE =
[]
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.
-
#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 optionalforce
parameter set totrue
. -
#is_concurrent ⇒ Boolean
Indicates whether a job is concurrent.
-
#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.
-
#scheduling_config ⇒ Types::SchedulingConfig
The configuration that allows you to schedule a job for a future date and time in addition to specifying the end behavior for each job execution.
-
#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.
7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 7819 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, :is_concurrent, :scheduling_config) SENSITIVE = [] include Aws::Structure end |
#comment ⇒ String
If the job was updated, describes the reason for the update.
7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 7819 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, :is_concurrent, :scheduling_config) SENSITIVE = [] include Aws::Structure end |
#completed_at ⇒ Time
The time, in seconds since the epoch, when the job was completed.
7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 7819 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, :is_concurrent, :scheduling_config) SENSITIVE = [] include Aws::Structure end |
#created_at ⇒ Time
The time, in seconds since the epoch, when the job was created.
7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 7819 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, :is_concurrent, :scheduling_config) SENSITIVE = [] include Aws::Structure end |
#description ⇒ String
A short text description of the job.
7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 7819 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, :is_concurrent, :scheduling_config) 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.
documentParameters
can only be used when creating jobs from Amazon
Web Services managed templates. This parameter can't be used with
custom job templates or to create jobs from them.
7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 7819 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, :is_concurrent, :scheduling_config) SENSITIVE = [] include Aws::Structure end |
#force_canceled ⇒ Boolean
Will be true
if the job was canceled with the optional force
parameter set to true
.
7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 7819 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, :is_concurrent, :scheduling_config) 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.
7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 7819 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, :is_concurrent, :scheduling_config) SENSITIVE = [] include Aws::Structure end |
#job_arn ⇒ String
An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".
7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 7819 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, :is_concurrent, :scheduling_config) SENSITIVE = [] include Aws::Structure end |
#job_executions_retry_config ⇒ Types::JobExecutionsRetryConfig
The configuration for the criteria to retry the job.
7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 7819 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, :is_concurrent, :scheduling_config) SENSITIVE = [] include Aws::Structure end |
#job_executions_rollout_config ⇒ Types::JobExecutionsRolloutConfig
Allows you to create a staged rollout of a job.
7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 7819 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, :is_concurrent, :scheduling_config) SENSITIVE = [] include Aws::Structure end |
#job_id ⇒ String
The unique identifier you assigned to this job when it was created.
7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 7819 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, :is_concurrent, :scheduling_config) SENSITIVE = [] include Aws::Structure end |
#job_process_details ⇒ Types::JobProcessDetails
Details about the job process.
7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 7819 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, :is_concurrent, :scheduling_config) SENSITIVE = [] include Aws::Structure end |
#job_template_arn ⇒ String
The ARN of the job template used to create the job.
7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 7819 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, :is_concurrent, :scheduling_config) SENSITIVE = [] include Aws::Structure end |
#last_updated_at ⇒ Time
The time, in seconds since the epoch, when the job was last updated.
7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 7819 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, :is_concurrent, :scheduling_config) 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/
namespaceId
feature is in public preview.
7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 7819 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, :is_concurrent, :scheduling_config) SENSITIVE = [] include Aws::Structure end |
#presigned_url_config ⇒ Types::PresignedUrlConfig
Configuration for pre-signed S3 URLs.
7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 7819 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, :is_concurrent, :scheduling_config) SENSITIVE = [] include Aws::Structure end |
#reason_code ⇒ String
If the job was updated, provides the reason code for the update.
7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 7819 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, :is_concurrent, :scheduling_config) SENSITIVE = [] include Aws::Structure end |
#scheduling_config ⇒ Types::SchedulingConfig
The configuration that allows you to schedule a job for a future date and time in addition to specifying the end behavior for each job execution.
7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 7819 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, :is_concurrent, :scheduling_config) SENSITIVE = [] include Aws::Structure end |
#status ⇒ String
The status of the job, one of IN_PROGRESS
, CANCELED
,
DELETION_IN_PROGRESS
or COMPLETED
.
7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 7819 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, :is_concurrent, :scheduling_config) 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.
7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 7819 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, :is_concurrent, :scheduling_config) SENSITIVE = [] include Aws::Structure end |
#targets ⇒ Array<String>
A list of IoT things and thing groups to which the job should be sent.
7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 7819 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, :is_concurrent, :scheduling_config) 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
.
7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 7819 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, :is_concurrent, :scheduling_config) SENSITIVE = [] include Aws::Structure end |