aws_sdk_iotwireless/client/
get_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 [`GetFuotaTask`](crate::operation::get_fuota_task::builders::GetFuotaTaskFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`id(impl Into<String>)`](crate::operation::get_fuota_task::builders::GetFuotaTaskFluentBuilder::id) / [`set_id(Option<String>)`](crate::operation::get_fuota_task::builders::GetFuotaTaskFluentBuilder::set_id):<br>required: **true**<br><p>The ID of a FUOTA task.</p><br>
7    /// - On success, responds with [`GetFuotaTaskOutput`](crate::operation::get_fuota_task::GetFuotaTaskOutput) with field(s):
8    ///   - [`arn(Option<String>)`](crate::operation::get_fuota_task::GetFuotaTaskOutput::arn): <p>The arn of a FUOTA task.</p>
9    ///   - [`id(Option<String>)`](crate::operation::get_fuota_task::GetFuotaTaskOutput::id): <p>The ID of a FUOTA task.</p>
10    ///   - [`status(Option<FuotaTaskStatus>)`](crate::operation::get_fuota_task::GetFuotaTaskOutput::status): <p>The status of a FUOTA task.</p>
11    ///   - [`name(Option<String>)`](crate::operation::get_fuota_task::GetFuotaTaskOutput::name): <p>The name of a FUOTA task.</p>
12    ///   - [`description(Option<String>)`](crate::operation::get_fuota_task::GetFuotaTaskOutput::description): <p>The description of the new resource.</p>
13    ///   - [`lo_ra_wan(Option<LoRaWanFuotaTaskGetInfo>)`](crate::operation::get_fuota_task::GetFuotaTaskOutput::lo_ra_wan): <p>The LoRaWAN information returned from getting a FUOTA task.</p>
14    ///   - [`firmware_update_image(Option<String>)`](crate::operation::get_fuota_task::GetFuotaTaskOutput::firmware_update_image): <p>The S3 URI points to a firmware update image that is to be used with a FUOTA task.</p>
15    ///   - [`firmware_update_role(Option<String>)`](crate::operation::get_fuota_task::GetFuotaTaskOutput::firmware_update_role): <p>The firmware update role that is to be used with a FUOTA task.</p>
16    ///   - [`created_at(Option<DateTime>)`](crate::operation::get_fuota_task::GetFuotaTaskOutput::created_at): <p>Created at timestamp for the resource.</p>
17    ///   - [`redundancy_percent(Option<i32>)`](crate::operation::get_fuota_task::GetFuotaTaskOutput::redundancy_percent): <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>
18    ///   - [`fragment_size_bytes(Option<i32>)`](crate::operation::get_fuota_task::GetFuotaTaskOutput::fragment_size_bytes): <p>The size of each fragment in bytes. This parameter is supported only for FUOTA tasks with multicast groups.</p>
19    ///   - [`fragment_interval_ms(Option<i32>)`](crate::operation::get_fuota_task::GetFuotaTaskOutput::fragment_interval_ms): <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>
20    ///   - [`descriptor(Option<String>)`](crate::operation::get_fuota_task::GetFuotaTaskOutput::descriptor): <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>
21    /// - On failure, responds with [`SdkError<GetFuotaTaskError>`](crate::operation::get_fuota_task::GetFuotaTaskError)
22    pub fn get_fuota_task(&self) -> crate::operation::get_fuota_task::builders::GetFuotaTaskFluentBuilder {
23        crate::operation::get_fuota_task::builders::GetFuotaTaskFluentBuilder::new(self.handle.clone())
24    }
25}
aws_sdk_iotwireless/client/get_fuota_task.rs

aws_sdk_iotwireless/client/
get_fuota_task.rs
