Struct aws_sdk_iot::client::fluent_builders::CreateOTAUpdate

pub struct CreateOTAUpdate { /* private fields */ }

Fluent builder constructing a request to CreateOTAUpdate.

Creates an IoT OTA update on a target group of things or groups.

Requires permission to access the CreateOTAUpdate action.

Implementations

impl CreateOTAUpdate

pub async fn send(
    self
) -> Result<CreateOtaUpdateOutput, SdkError<CreateOTAUpdateError>>

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

The ID of the OTA update to be created.

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

The ID of the OTA update to be created.

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

The description of the OTA update.

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

The description of the OTA update.

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

Appends an item to targets.

To override the contents of this collection use set_targets.

The devices targeted to receive OTA updates.

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

The devices targeted to receive OTA updates.

pub fn protocols(self, input: Protocol) -> Self

Appends an item to protocols.

To override the contents of this collection use set_protocols.

The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device can choose the protocol.

pub fn set_protocols(self, input: Option<Vec<Protocol>>) -> Self

The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device can choose the protocol.

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

Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things specified as targets have completed the update (SNAPSHOT). If continuous, the update may also be run on a thing when a change is detected in a target. For example, an update will run on a thing when the thing is added to a target group, even after the update was completed by all things originally in the group. Valid values: CONTINUOUS | SNAPSHOT.

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

Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things specified as targets have completed the update (SNAPSHOT). If continuous, the update may also be run on a thing when a change is detected in a target. For example, an update will run on a thing when the thing is added to a target group, even after the update was completed by all things originally in the group. Valid values: CONTINUOUS | SNAPSHOT.

pub fn aws_job_executions_rollout_config(
    self,
    input: AwsJobExecutionsRolloutConfig
) -> Self

Configuration for the rollout of OTA updates.

pub fn set_aws_job_executions_rollout_config(
    self,
    input: Option<AwsJobExecutionsRolloutConfig>
) -> Self

Configuration for the rollout of OTA updates.

pub fn aws_job_presigned_url_config(
    self,
    input: AwsJobPresignedUrlConfig
) -> Self

Configuration information for pre-signed URLs.

pub fn set_aws_job_presigned_url_config(
    self,
    input: Option<AwsJobPresignedUrlConfig>
) -> Self

Configuration information for pre-signed URLs.

pub fn aws_job_abort_config(self, input: AwsJobAbortConfig) -> Self

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

pub fn set_aws_job_abort_config(self, input: Option<AwsJobAbortConfig>) -> Self

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

pub fn aws_job_timeout_config(self, input: AwsJobTimeoutConfig) -> 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_aws_job_timeout_config(
    self,
    input: Option<AwsJobTimeoutConfig>
) -> 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 files(self, input: OtaUpdateFile) -> Self

Appends an item to files.

To override the contents of this collection use set_files.

The files to be streamed by the OTA update.

pub fn set_files(self, input: Option<Vec<OtaUpdateFile>>) -> Self

The files to be streamed by the OTA update.

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

The IAM role that grants Amazon Web Services IoT Core access to the Amazon S3, IoT jobs and Amazon Web Services Code Signing resources to create an OTA update job.

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

The IAM role that grants Amazon Web Services IoT Core access to the Amazon S3, IoT jobs and Amazon Web Services Code Signing resources to create an OTA update job.

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

Adds a key-value pair to additionalParameters.

To override the contents of this collection use set_additional_parameters.

A list of additional OTA update parameters which are name-value pairs.

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

A list of additional OTA update parameters which are name-value pairs.

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

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

Metadata which can be used to manage updates.

Trait Implementations

impl Clone for CreateOTAUpdate

fn clone(&self) -> CreateOTAUpdate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateOTAUpdate

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

Formats the value using the given formatter.