Struct aws_sdk_iot::operation::create_job::builders::CreateJobFluentBuilder

pub struct CreateJobFluentBuilder { /* private fields */ }

Fluent builder constructing a request to CreateJob.

Creates a job.

Requires permission to access the CreateJob action.

Implementations

impl CreateJobFluentBuilder

pub fn as_input(&self) -> &CreateJobInputBuilder

Access the CreateJob as a reference.

pub async fn send( self ) -> Result<CreateJobOutput, SdkError<CreateJobError, 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<CreateJobOutput, CreateJobError, Self>

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

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

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

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, 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 short text description of the job.

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

A short text description of the job.

pub fn get_description(&self) -> &Option<String>

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

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.

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

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

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

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

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 only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.

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 only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.

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

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

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 get_job_executions_retry_config( &self ) -> &Option<JobExecutionsRetryConfig>

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

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

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

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 get_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, 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 CreateJobFluentBuilder

fn clone(&self) -> CreateJobFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateJobFluentBuilder

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

Formats the value using the given formatter.