Struct aws_sdk_iot::operation::create_job_template::builders::CreateJobTemplateFluentBuilder

pub struct CreateJobTemplateFluentBuilder { /* private fields */ }

Fluent builder constructing a request to CreateJobTemplate.

Creates a job template.

Requires permission to access the CreateJobTemplate action.

Implementations

impl CreateJobTemplateFluentBuilder

pub fn as_input(&self) -> &CreateJobTemplateInputBuilder

Access the CreateJobTemplate as a reference.

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

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 customize( self ) -> CustomizableOperation<CreateJobTemplateOutput, CreateJobTemplateError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

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 get_job_template_id(&self) -> &Option<String>

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 get_job_arn(&self) -> &Option<String>

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

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 get_document_source(&self) -> &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.

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 get_document(&self) -> &Option<String>

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 get_description(&self) -> &Option<String>

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 get_presigned_url_config(&self) -> &Option<PresignedUrlConfig>

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 get_job_executions_rollout_config( &self ) -> &Option<JobExecutionsRolloutConfig>

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 get_abort_config(&self) -> &Option<AbortConfig>

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 get_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 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 get_tags(&self) -> &Option<Vec<Tag>>

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.

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

Allows you to create the criteria to retry a job.

pub fn maintenance_windows(self, input: MaintenanceWindow) -> Self

Appends an item to maintenanceWindows.

To override the contents of this collection use set_maintenance_windows.

Allows you to configure an optional maintenance window for the rollout of a job document to all devices in the target group for a job.

pub fn set_maintenance_windows( self, input: Option<Vec<MaintenanceWindow>> ) -> Self

Allows you to configure an optional maintenance window for the rollout of a job document to all devices in the target group for a job.

pub fn get_maintenance_windows(&self) -> &Option<Vec<MaintenanceWindow>>

Allows you to configure an optional maintenance window for the rollout of a job document to all devices in the target group for a job.

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

Appends an item to destinationPackageVersions.

To override the contents of this collection use set_destination_package_versions.

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.

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

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.

pub fn get_destination_package_versions(&self) -> &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.

Trait Implementations

impl Clone for CreateJobTemplateFluentBuilder

fn clone(&self) -> CreateJobTemplateFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateJobTemplateFluentBuilder

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

Formats the value using the given formatter.