aws_sdk_iotwireless/client/
update_fuota_task.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`UpdateFuotaTask`](crate::operation::update_fuota_task::builders::UpdateFuotaTaskFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`id(impl Into<String>)`](crate::operation::update_fuota_task::builders::UpdateFuotaTaskFluentBuilder::id) / [`set_id(Option<String>)`](crate::operation::update_fuota_task::builders::UpdateFuotaTaskFluentBuilder::set_id):<br>required: **true**<br><p>The ID of a FUOTA task.</p><br>
7    ///   - [`name(impl Into<String>)`](crate::operation::update_fuota_task::builders::UpdateFuotaTaskFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::update_fuota_task::builders::UpdateFuotaTaskFluentBuilder::set_name):<br>required: **false**<br><p>The name of a FUOTA task.</p><br>
8    ///   - [`description(impl Into<String>)`](crate::operation::update_fuota_task::builders::UpdateFuotaTaskFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::update_fuota_task::builders::UpdateFuotaTaskFluentBuilder::set_description):<br>required: **false**<br><p>The description of the new resource.</p><br>
9    ///   - [`lo_ra_wan(LoRaWanFuotaTask)`](crate::operation::update_fuota_task::builders::UpdateFuotaTaskFluentBuilder::lo_ra_wan) / [`set_lo_ra_wan(Option<LoRaWanFuotaTask>)`](crate::operation::update_fuota_task::builders::UpdateFuotaTaskFluentBuilder::set_lo_ra_wan):<br>required: **false**<br><p>The LoRaWAN information used with a FUOTA task.</p><br>
10    ///   - [`firmware_update_image(impl Into<String>)`](crate::operation::update_fuota_task::builders::UpdateFuotaTaskFluentBuilder::firmware_update_image) / [`set_firmware_update_image(Option<String>)`](crate::operation::update_fuota_task::builders::UpdateFuotaTaskFluentBuilder::set_firmware_update_image):<br>required: **false**<br><p>The S3 URI points to a firmware update image that is to be used with a FUOTA task.</p><br>
11    ///   - [`firmware_update_role(impl Into<String>)`](crate::operation::update_fuota_task::builders::UpdateFuotaTaskFluentBuilder::firmware_update_role) / [`set_firmware_update_role(Option<String>)`](crate::operation::update_fuota_task::builders::UpdateFuotaTaskFluentBuilder::set_firmware_update_role):<br>required: **false**<br><p>The firmware update role that is to be used with a FUOTA task.</p><br>
12    ///   - [`redundancy_percent(i32)`](crate::operation::update_fuota_task::builders::UpdateFuotaTaskFluentBuilder::redundancy_percent) / [`set_redundancy_percent(Option<i32>)`](crate::operation::update_fuota_task::builders::UpdateFuotaTaskFluentBuilder::set_redundancy_percent):<br>required: **false**<br><p>The percentage of the added fragments that are redundant. For example, if the size of the firmware image file is 100 bytes and the fragment size is 10 bytes, with <code>RedundancyPercent</code> set to 50(%), the final number of encoded fragments is (100 / 10) + (100 / 10 * 50%) = 15.</p><br>
13    ///   - [`fragment_size_bytes(i32)`](crate::operation::update_fuota_task::builders::UpdateFuotaTaskFluentBuilder::fragment_size_bytes) / [`set_fragment_size_bytes(Option<i32>)`](crate::operation::update_fuota_task::builders::UpdateFuotaTaskFluentBuilder::set_fragment_size_bytes):<br>required: **false**<br><p>The size of each fragment in bytes. This parameter is supported only for FUOTA tasks with multicast groups.</p><br>
14    ///   - [`fragment_interval_ms(i32)`](crate::operation::update_fuota_task::builders::UpdateFuotaTaskFluentBuilder::fragment_interval_ms) / [`set_fragment_interval_ms(Option<i32>)`](crate::operation::update_fuota_task::builders::UpdateFuotaTaskFluentBuilder::set_fragment_interval_ms):<br>required: **false**<br><p>The interval for sending fragments in milliseconds, rounded to the nearest second.</p><note>  <p>This interval only determines the timing for when the Cloud sends down the fragments to yor device. There can be a delay for when your device will receive these fragments. This delay depends on the device's class and the communication delay with the cloud.</p> </note><br>
15    ///   - [`descriptor(impl Into<String>)`](crate::operation::update_fuota_task::builders::UpdateFuotaTaskFluentBuilder::descriptor) / [`set_descriptor(Option<String>)`](crate::operation::update_fuota_task::builders::UpdateFuotaTaskFluentBuilder::set_descriptor):<br>required: **false**<br><p>The descriptor is the metadata about the file that is transferred to the device using FUOTA, such as the software version. It is a binary field encoded in base64.</p><br>
16    /// - On success, responds with [`UpdateFuotaTaskOutput`](crate::operation::update_fuota_task::UpdateFuotaTaskOutput)
17    /// - On failure, responds with [`SdkError<UpdateFuotaTaskError>`](crate::operation::update_fuota_task::UpdateFuotaTaskError)
18    pub fn update_fuota_task(&self) -> crate::operation::update_fuota_task::builders::UpdateFuotaTaskFluentBuilder {
19        crate::operation::update_fuota_task::builders::UpdateFuotaTaskFluentBuilder::new(self.handle.clone())
20    }
21}
aws_sdk_iotwireless/client/update_fuota_task.rs

aws_sdk_iotwireless/client/
update_fuota_task.rs
