Struct aws_sdk_iot::input::CreateJobInput

source ·

#[non_exhaustive]
pub struct CreateJobInput { /* private fields */ }

Implementations§

source §

impl CreateJobInput

source

pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<CreateJob, AwsResponseRetryClassifier>, BuildError>

Consumes the builder and constructs an Operation<CreateJob>

source

pub fn builder() -> Builder

Creates a new builder-style object to manufacture CreateJobInput.

source §

impl CreateJobInput

source

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.

source

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

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

source

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

An S3 link to the job document. Required if you don't specify a value for document.

If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.

The placeholder link is of the following form:

${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key}

where bucket is your bucket name and key is the object in the bucket to which you are linking.

source

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

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

source

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

A short text description of the job.

source

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

Configuration information for pre-signed S3 URLs.

source

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.

source

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

Allows you to create a staged rollout of the job.

source

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

Allows you to create the criteria to abort a job.

source

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.

source

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

Metadata which can be used to manage the job.

source

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.

source

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

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

source

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

Allows you to create the criteria to retry a job.

source

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.

source