pub struct CreateOTAUpdateFluentBuilder { /* private fields */ }
Expand description
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§
source§impl CreateOTAUpdateFluentBuilder
impl CreateOTAUpdateFluentBuilder
sourcepub fn as_input(&self) -> &CreateOtaUpdateInputBuilder
pub fn as_input(&self) -> &CreateOtaUpdateInputBuilder
Access the CreateOTAUpdate as a reference.
sourcepub async fn send(
self
) -> Result<CreateOtaUpdateOutput, SdkError<CreateOTAUpdateError, HttpResponse>>
pub async fn send( self ) -> Result<CreateOtaUpdateOutput, SdkError<CreateOTAUpdateError, 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.
sourcepub fn customize(
self
) -> CustomizableOperation<CreateOtaUpdateOutput, CreateOTAUpdateError, Self>
pub fn customize( self ) -> CustomizableOperation<CreateOtaUpdateOutput, CreateOTAUpdateError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn ota_update_id(self, input: impl Into<String>) -> Self
pub fn ota_update_id(self, input: impl Into<String>) -> Self
The ID of the OTA update to be created.
sourcepub fn set_ota_update_id(self, input: Option<String>) -> Self
pub fn set_ota_update_id(self, input: Option<String>) -> Self
The ID of the OTA update to be created.
sourcepub fn get_ota_update_id(&self) -> &Option<String>
pub fn get_ota_update_id(&self) -> &Option<String>
The ID of the OTA update to be created.
sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
The description of the OTA update.
sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
The description of the OTA update.
sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
The description of the OTA update.
sourcepub fn targets(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_targets(self, input: Option<Vec<String>>) -> Self
pub fn set_targets(self, input: Option<Vec<String>>) -> Self
The devices targeted to receive OTA updates.
sourcepub fn get_targets(&self) -> &Option<Vec<String>>
pub fn get_targets(&self) -> &Option<Vec<String>>
The devices targeted to receive OTA updates.
sourcepub fn protocols(self, input: Protocol) -> Self
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.
sourcepub fn set_protocols(self, input: Option<Vec<Protocol>>) -> Self
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.
sourcepub fn get_protocols(&self) -> &Option<Vec<Protocol>>
pub fn get_protocols(&self) -> &Option<Vec<Protocol>>
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.
sourcepub fn target_selection(self, input: TargetSelection) -> Self
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.
sourcepub fn set_target_selection(self, input: Option<TargetSelection>) -> Self
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.
sourcepub fn get_target_selection(&self) -> &Option<TargetSelection>
pub fn get_target_selection(&self) -> &Option<TargetSelection>
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.
sourcepub fn aws_job_executions_rollout_config(
self,
input: AwsJobExecutionsRolloutConfig
) -> Self
pub fn aws_job_executions_rollout_config( self, input: AwsJobExecutionsRolloutConfig ) -> Self
Configuration for the rollout of OTA updates.
sourcepub fn set_aws_job_executions_rollout_config(
self,
input: Option<AwsJobExecutionsRolloutConfig>
) -> Self
pub fn set_aws_job_executions_rollout_config( self, input: Option<AwsJobExecutionsRolloutConfig> ) -> Self
Configuration for the rollout of OTA updates.
sourcepub fn get_aws_job_executions_rollout_config(
&self
) -> &Option<AwsJobExecutionsRolloutConfig>
pub fn get_aws_job_executions_rollout_config( &self ) -> &Option<AwsJobExecutionsRolloutConfig>
Configuration for the rollout of OTA updates.
sourcepub fn aws_job_presigned_url_config(
self,
input: AwsJobPresignedUrlConfig
) -> Self
pub fn aws_job_presigned_url_config( self, input: AwsJobPresignedUrlConfig ) -> Self
Configuration information for pre-signed URLs.
sourcepub fn set_aws_job_presigned_url_config(
self,
input: Option<AwsJobPresignedUrlConfig>
) -> Self
pub fn set_aws_job_presigned_url_config( self, input: Option<AwsJobPresignedUrlConfig> ) -> Self
Configuration information for pre-signed URLs.
sourcepub fn get_aws_job_presigned_url_config(
&self
) -> &Option<AwsJobPresignedUrlConfig>
pub fn get_aws_job_presigned_url_config( &self ) -> &Option<AwsJobPresignedUrlConfig>
Configuration information for pre-signed URLs.
sourcepub fn aws_job_abort_config(self, input: AwsJobAbortConfig) -> Self
pub fn aws_job_abort_config(self, input: AwsJobAbortConfig) -> Self
The criteria that determine when and how a job abort takes place.
sourcepub fn set_aws_job_abort_config(self, input: Option<AwsJobAbortConfig>) -> Self
pub fn set_aws_job_abort_config(self, input: Option<AwsJobAbortConfig>) -> Self
The criteria that determine when and how a job abort takes place.
sourcepub fn get_aws_job_abort_config(&self) -> &Option<AwsJobAbortConfig>
pub fn get_aws_job_abort_config(&self) -> &Option<AwsJobAbortConfig>
The criteria that determine when and how a job abort takes place.
sourcepub fn aws_job_timeout_config(self, input: AwsJobTimeoutConfig) -> Self
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
.
sourcepub fn set_aws_job_timeout_config(
self,
input: Option<AwsJobTimeoutConfig>
) -> Self
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
.
sourcepub fn get_aws_job_timeout_config(&self) -> &Option<AwsJobTimeoutConfig>
pub fn get_aws_job_timeout_config(&self) -> &Option<AwsJobTimeoutConfig>
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
.
sourcepub fn files(self, input: OtaUpdateFile) -> Self
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.
sourcepub fn set_files(self, input: Option<Vec<OtaUpdateFile>>) -> Self
pub fn set_files(self, input: Option<Vec<OtaUpdateFile>>) -> Self
The files to be streamed by the OTA update.
sourcepub fn get_files(&self) -> &Option<Vec<OtaUpdateFile>>
pub fn get_files(&self) -> &Option<Vec<OtaUpdateFile>>
The files to be streamed by the OTA update.
sourcepub fn role_arn(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_role_arn(self, input: Option<String>) -> Self
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.
sourcepub fn get_role_arn(&self) -> &Option<String>
pub fn get_role_arn(&self) -> &Option<String>
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.
sourcepub fn additional_parameters(
self,
k: impl Into<String>,
v: impl Into<String>
) -> Self
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. They won't be sent to devices as a part of the Job document.
sourcepub fn set_additional_parameters(
self,
input: Option<HashMap<String, String>>
) -> Self
pub fn set_additional_parameters( self, input: Option<HashMap<String, String>> ) -> Self
A list of additional OTA update parameters, which are name-value pairs. They won't be sent to devices as a part of the Job document.
sourcepub fn get_additional_parameters(&self) -> &Option<HashMap<String, String>>
pub fn get_additional_parameters(&self) -> &Option<HashMap<String, String>>
A list of additional OTA update parameters, which are name-value pairs. They won't be sent to devices as a part of the Job document.
Appends an item to tags
.
To override the contents of this collection use set_tags
.
Metadata which can be used to manage updates.
Metadata which can be used to manage updates.
Metadata which can be used to manage updates.
Trait Implementations§
source§impl Clone for CreateOTAUpdateFluentBuilder
impl Clone for CreateOTAUpdateFluentBuilder
source§fn clone(&self) -> CreateOTAUpdateFluentBuilder
fn clone(&self) -> CreateOTAUpdateFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more