Struct aws_sdk_iot::client::fluent_builders::CreateJob

pub struct CreateJob { /* private fields */ }

Fluent builder constructing a request to CreateJob.

Creates a job.

Requires permission to access the CreateJob action.

Implementations

impl CreateJob

pub async fn send(self) -> Result<CreateJobOutput, SdkError<CreateJobError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn job_id(self, input: impl Into<String>) -> Self

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 set_job_id(self, input: Option<String>) -> Self

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, input: impl Into<String>) -> Self

Appends an item to targets.

To override the contents of this collection use set_targets.

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

pub fn set_targets(self, input: Option<Vec<String>>) -> Self

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

pub fn document_source(self, input: impl Into<String>) -> Self

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.

pub fn set_document_source(self, input: Option<String>) -> Self

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.

pub fn document(self, input: impl Into<String>) -> Self

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

pub fn set_document(self, input: Option<String>) -> Self

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

pub fn description(self, input: impl Into<String>) -> Self

A short text description of the job.

pub fn set_description(self, input: Option<String>) -> Self

A short text description of the job.

pub fn presigned_url_config(self, input: PresignedUrlConfig) -> Self

Configuration information for pre-signed S3 URLs.

pub fn set_presigned_url_config(self, input: Option<PresignedUrlConfig>) -> Self

Configuration information for pre-signed S3 URLs.

pub fn target_selection(self, input: TargetSelection) -> Self

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.

pub fn set_target_selection(self, input: Option<TargetSelection>) -> Self

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.

pub fn job_executions_rollout_config(
    self,
    input: JobExecutionsRolloutConfig
) -> Self

Allows you to create a staged rollout of the job.

pub fn set_job_executions_rollout_config(
    self,
    input: Option<JobExecutionsRolloutConfig>
) -> Self

Allows you to create a staged rollout of the job.

pub fn abort_config(self, input: AbortConfig) -> Self

Allows you to create the criteria to abort a job.

pub fn set_abort_config(self, input: Option<AbortConfig>) -> Self

Allows you to create the criteria to abort a job.

pub fn timeout_config(self, input: TimeoutConfig) -> Self

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 set_timeout_config(self, input: Option<TimeoutConfig>) -> Self

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, input: Tag) -> Self

Appends an item to tags.

To override the contents of this collection use set_tags.

Metadata which can be used to manage the job.

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

Metadata which can be used to manage the job.

pub fn namespace_id(self, input: impl Into<String>) -> Self

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.

pub fn set_namespace_id(self, input: Option<String>) -> Self

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.

pub fn job_template_arn(self, input: impl Into<String>) -> Self

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

pub fn set_job_template_arn(self, input: Option<String>) -> Self

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

pub fn job_executions_retry_config(
    self,
    input: JobExecutionsRetryConfig
) -> Self

Allows you to create the criteria to retry a job.

pub fn set_job_executions_retry_config(
    self,
    input: Option<JobExecutionsRetryConfig>
) -> Self

Allows you to create the criteria to retry a job.

pub fn document_parameters(
    self,
    k: impl Into<String>,
    v: impl Into<String>
) -> Self

Adds a key-value pair to documentParameters.

To override the contents of this collection use set_document_parameters.

Parameters of a managed template that you can specify to create the job document.

pub fn set_document_parameters(
    self,
    input: Option<HashMap<String, String>>
) -> Self

Parameters of a managed template that you can specify to create the job document.

Trait Implementations

impl Clone for CreateJob

fn clone(&self) -> CreateJob

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateJob

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

Formats the value using the given formatter.