Struct aws_sdk_iot::operation::create_job::CreateJobInput

#[non_exhaustive]
pub struct CreateJobInput {

    pub job_id: Option<String>,
    pub targets: Option<Vec<String>>,
    pub document_source: Option<String>,
    pub document: Option<String>,
    pub description: Option<String>,
    pub presigned_url_config: Option<PresignedUrlConfig>,
    pub target_selection: Option<TargetSelection>,
    pub job_executions_rollout_config: Option<JobExecutionsRolloutConfig>,
    pub abort_config: Option<AbortConfig>,
    pub timeout_config: Option<TimeoutConfig>,
    pub tags: Option<Vec<Tag>>,
    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 scheduling_config: Option<SchedulingConfig>,
    pub destination_package_versions: Option<Vec<String>>,
}

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_id: Option<String>

A job identifier which must be unique for your Amazon Web Services account. We recommend using a UUID. Alpha-numeric characters, "-" and "_" are valid for use here.

targets: Option<Vec<String>>

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

document_source: Option<String>

An S3 link, or S3 object URL, to the job document. The link is an Amazon S3 object URL and is required if you don't specify a value for document.

For example, --document-source https://s3.region-code.amazonaws.com/example-firmware/device-firmware.1.0

For more information, see Methods for accessing a bucket.

document: Option<String>

The job document. Required if you don't specify a value for documentSource.

description: Option<String>

A short text description of the job.

presigned_url_config: Option<PresignedUrlConfig>

Configuration information for pre-signed S3 URLs.

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 thing when the thing 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.

job_executions_rollout_config: Option<JobExecutionsRolloutConfig>

Allows you to create a staged rollout of the job.

abort_config: Option<AbortConfig>

Allows you to create the criteria to abort a job.

timeout_config: Option<TimeoutConfig>

Specifies the amount of time each device has to finish its execution of the job. The 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 time expires, it will be automatically set to TIMED_OUT.

tags: Option<Vec<Tag>>

Metadata which can be used to manage the job.

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>

Allows you to create the criteria to retry a job.

document_parameters: Option<HashMap<String, String>>

Parameters of an Amazon Web Services managed template that you can specify to create the job document.

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.

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.

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.

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

Implementations

impl CreateJobInput

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

A job identifier which must be unique for your Amazon Web Services account. We recommend using a UUID. Alpha-numeric characters, "-" and "_" are valid for use here.

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

A list of 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 document_source(&self) -> Option<&str>

An S3 link, or S3 object URL, to the job document. The link is an Amazon S3 object URL and is required if you don't specify a value for document.

For example, --document-source https://s3.region-code.amazonaws.com/example-firmware/device-firmware.1.0

For more information, see Methods for accessing a bucket.

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

The job document. Required if you don't specify a value for documentSource.

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

A short text description of the job.

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

Configuration information for pre-signed S3 URLs.

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 thing when the thing 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 job_executions_rollout_config( &self ) -> Option<&JobExecutionsRolloutConfig>

Allows you to create a staged rollout of the job.

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

Allows you to create the criteria to abort a job.

pub fn timeout_config(&self) -> Option<&TimeoutConfig>

Specifies the amount of time each device has to finish its execution of the job. The 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 time expires, it will be automatically set to TIMED_OUT.

pub fn tags(&self) -> &[Tag]

Metadata which can be used to manage the job.

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

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>

Allows you to create the criteria to retry a job.

pub fn document_parameters(&self) -> Option<&HashMap<String, String>>

Parameters of an Amazon Web Services managed template that you can specify to create the job document.

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

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 CreateJobInput

pub fn builder() -> CreateJobInputBuilder

Creates a new builder-style object to manufacture CreateJobInput.

Trait Implementations

impl Clone for CreateJobInput

fn clone(&self) -> CreateJobInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateJobInput

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

Formats the value using the given formatter.

impl PartialEq for CreateJobInput

fn eq(&self, other: &CreateJobInput) -> 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 CreateJobInput