Struct aws_sdk_iot::client::fluent_builders::CreateJobTemplate

pub struct CreateJobTemplate { /* private fields */ }

Fluent builder constructing a request to CreateJobTemplate.

Creates a job template.

Requires permission to access the CreateJobTemplate action.

Implementations

impl CreateJobTemplate

pub async fn send(
    self
) -> Result<CreateJobTemplateOutput, SdkError<CreateJobTemplateError>>

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

A unique identifier for the job template. We recommend using a UUID. Alpha-numeric characters, "-", and "_" are valid for use here.

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

A unique identifier for the job template. We recommend using a UUID. Alpha-numeric characters, "-", and "_" are valid for use here.

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

The ARN of the job to use as the basis for the job template.

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

The ARN of the job to use as the basis for the job template.

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

An S3 link to the job document to use in the template. 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 to use in the template. 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 description of the job document.

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

A description of the job document.

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

Configuration for pre-signed S3 URLs.

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

Configuration for pre-signed S3 URLs.

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

Allows you to create a staged rollout of a job.

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

Allows you to create a staged rollout of a job.

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

The criteria that determine when and how a job abort takes place.

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

The criteria that determine when and how a job abort takes place.

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

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

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

Appends an item to tags.

To override the contents of this collection use set_tags.

Metadata that can be used to manage the job template.

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

Metadata that can be used to manage the job template.

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.

Trait Implementations

impl Clone for CreateJobTemplate

fn clone(&self) -> CreateJobTemplate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateJobTemplate

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

Formats the value using the given formatter.