Struct aws_sdk_iot::types::Job

#[non_exhaustive]
pub struct Job {

    pub job_arn: Option<String>,
    pub job_id: Option<String>,
    pub target_selection: Option<TargetSelection>,
    pub status: Option<JobStatus>,
    pub force_canceled: Option<bool>,
    pub reason_code: Option<String>,
    pub comment: Option<String>,
    pub targets: Option<Vec<String>>,
    pub description: Option<String>,
    pub presigned_url_config: Option<PresignedUrlConfig>,
    pub job_executions_rollout_config: Option<JobExecutionsRolloutConfig>,
    pub abort_config: Option<AbortConfig>,
    pub created_at: Option<DateTime>,
    pub last_updated_at: Option<DateTime>,
    pub completed_at: Option<DateTime>,
    pub job_process_details: Option<JobProcessDetails>,
    pub timeout_config: Option<TimeoutConfig>,
    pub namespace_id: Option<String>,
    pub job_template_arn: Option<String>,
    pub job_executions_retry_config: Option<JobExecutionsRetryConfig>,
    pub document_parameters: Option<HashMap<String, String>>,
    pub is_concurrent: Option<bool>,
    pub scheduling_config: Option<SchedulingConfig>,
    pub scheduled_job_rollouts: Option<Vec<ScheduledJobRollout>>,
    pub destination_package_versions: Option<Vec<String>>,
}

The Job object contains details about a job.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

job_arn: Option<String>

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

job_id: Option<String>

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

target_selection: 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.

status: Option<JobStatus>

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

force_canceled: Option<bool>

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

reason_code: Option<String>

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

comment: Option<String>

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

targets: Option<Vec<String>>

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

description: Option<String>

A short text description of the job.

presigned_url_config: Option<PresignedUrlConfig>

Configuration for pre-signed S3 URLs.

job_executions_rollout_config: Option<JobExecutionsRolloutConfig>

Allows you to create a staged rollout of a job.

abort_config: Option<AbortConfig>

Configuration for criteria to abort the job.

created_at: Option<DateTime>

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

last_updated_at: Option<DateTime>

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

completed_at: Option<DateTime>

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

job_process_details: Option<JobProcessDetails>

Details about the job process.

timeout_config: 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.

namespace_id: Option<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 only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.

job_template_arn: Option<String>

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

job_executions_retry_config: Option<JobExecutionsRetryConfig>

The configuration for the criteria to retry the job.

document_parameters: 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.

is_concurrent: 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.

scheduling_config: 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.

scheduled_job_rollouts: Option<Vec<ScheduledJobRollout>>

Displays the next seven maintenance window occurrences and their start times.

destination_package_versions: Option<Vec<String>>

The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.

Note:The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.

Implementations

impl Job

pub fn job_arn(&self) -> Option<&str>

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

pub fn job_id(&self) -> Option<&str>

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

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.

pub fn status(&self) -> Option<&JobStatus>

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

pub fn force_canceled(&self) -> Option<bool>

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

pub fn reason_code(&self) -> Option<&str>

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

pub fn comment(&self) -> Option<&str>

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

pub fn targets(&self) -> &[String]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .targets.is_none().

pub fn description(&self) -> Option<&str>

A short text description of the job.

pub fn presigned_url_config(&self) -> Option<&PresignedUrlConfig>

Configuration for pre-signed S3 URLs.

pub fn job_executions_rollout_config( &self ) -> Option<&JobExecutionsRolloutConfig>

Allows you to create a staged rollout of a job.

pub fn abort_config(&self) -> Option<&AbortConfig>

Configuration for criteria to abort the job.

pub fn created_at(&self) -> Option<&DateTime>

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

pub fn last_updated_at(&self) -> Option<&DateTime>

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

pub fn completed_at(&self) -> Option<&DateTime>

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

pub fn job_process_details(&self) -> Option<&JobProcessDetails>

Details about the job process.

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.

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 only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.

pub fn job_template_arn(&self) -> Option<&str>

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

pub fn job_executions_retry_config(&self) -> Option<&JobExecutionsRetryConfig>

The configuration for the criteria to retry the job.

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.

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.

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.

pub fn scheduled_job_rollouts(&self) -> &[ScheduledJobRollout]

Displays the next seven maintenance window occurrences and their start times.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .scheduled_job_rollouts.is_none().

pub fn destination_package_versions(&self) -> &[String]

The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.

Note:The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .destination_package_versions.is_none().

impl Job

pub fn builder() -> JobBuilder

Creates a new builder-style object to manufacture Job.

Trait Implementations

impl Clone for Job

fn clone(&self) -> Job

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Job

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Job

fn eq(&self, other: &Job) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Job