Struct aws_sdk_iot::model::Job
source · #[non_exhaustive]pub struct Job { /* private fields */ }Expand description
The Job object contains details about a job.
Implementations§
source§impl Job
impl Job
sourcepub fn job_arn(&self) -> Option<&str>
pub fn job_arn(&self) -> Option<&str>
An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".
sourcepub fn job_id(&self) -> Option<&str>
pub fn job_id(&self) -> Option<&str>
The unique identifier you assigned to this job when it was created.
sourcepub fn target_selection(&self) -> Option<&TargetSelection>
pub fn target_selection(&self) -> Option<&TargetSelection>
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.
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.
sourcepub fn status(&self) -> Option<&JobStatus>
pub fn status(&self) -> Option<&JobStatus>
The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or COMPLETED.
sourcepub fn force_canceled(&self) -> Option<bool>
pub fn force_canceled(&self) -> Option<bool>
Will be true if the job was canceled with the optional force parameter set to true.
sourcepub fn reason_code(&self) -> Option<&str>
pub fn reason_code(&self) -> Option<&str>
If the job was updated, provides the reason code for the update.
sourcepub fn comment(&self) -> Option<&str>
pub fn comment(&self) -> Option<&str>
If the job was updated, describes the reason for the update.
sourcepub fn targets(&self) -> Option<&[String]>
pub fn targets(&self) -> Option<&[String]>
A list of IoT things and thing groups to which the job should be sent.
sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
A short text description of the job.
sourcepub fn presigned_url_config(&self) -> Option<&PresignedUrlConfig>
pub fn presigned_url_config(&self) -> Option<&PresignedUrlConfig>
Configuration for pre-signed S3 URLs.
sourcepub fn job_executions_rollout_config(
&self
) -> Option<&JobExecutionsRolloutConfig>
pub fn job_executions_rollout_config(
&self
) -> Option<&JobExecutionsRolloutConfig>
Allows you to create a staged rollout of a job.
sourcepub fn abort_config(&self) -> Option<&AbortConfig>
pub fn abort_config(&self) -> Option<&AbortConfig>
Configuration for criteria to abort the job.
sourcepub fn created_at(&self) -> Option<&DateTime>
pub fn created_at(&self) -> Option<&DateTime>
The time, in seconds since the epoch, when the job was created.
sourcepub fn last_updated_at(&self) -> Option<&DateTime>
pub fn last_updated_at(&self) -> Option<&DateTime>
The time, in seconds since the epoch, when the job was last updated.
sourcepub fn completed_at(&self) -> Option<&DateTime>
pub fn completed_at(&self) -> Option<&DateTime>
The time, in seconds since the epoch, when the job was completed.
sourcepub fn job_process_details(&self) -> Option<&JobProcessDetails>
pub fn job_process_details(&self) -> Option<&JobProcessDetails>
Details about the job process.
sourcepub fn timeout_config(&self) -> Option<&TimeoutConfig>
pub fn timeout_config(&self) -> Option<&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.
sourcepub fn namespace_id(&self) -> Option<&str>
pub fn namespace_id(&self) -> Option<&str>
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.
sourcepub fn job_template_arn(&self) -> Option<&str>
pub fn job_template_arn(&self) -> Option<&str>
The ARN of the job template used to create the job.
sourcepub fn job_executions_retry_config(&self) -> Option<&JobExecutionsRetryConfig>
pub fn job_executions_retry_config(&self) -> Option<&JobExecutionsRetryConfig>
The configuration for the criteria to retry the job.
sourcepub fn document_parameters(&self) -> Option<&HashMap<String, String>>
pub fn document_parameters(&self) -> Option<&HashMap<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.
sourcepub fn is_concurrent(&self) -> Option<bool>
pub fn is_concurrent(&self) -> Option<bool>
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.
sourcepub fn scheduling_config(&self) -> Option<&SchedulingConfig>
pub fn scheduling_config(&self) -> Option<&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.