aws_sdk_iotmanagedintegrations/client/
get_ota_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 [`GetOtaTask`](crate::operation::get_ota_task::builders::GetOtaTaskFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`identifier(impl Into<String>)`](crate::operation::get_ota_task::builders::GetOtaTaskFluentBuilder::identifier) / [`set_identifier(Option<String>)`](crate::operation::get_ota_task::builders::GetOtaTaskFluentBuilder::set_identifier):<br>required: **true**<br><p>The over-the-air (OTA) task id.</p><br>
7    /// - On success, responds with [`GetOtaTaskOutput`](crate::operation::get_ota_task::GetOtaTaskOutput) with field(s):
8    ///   - [`task_id(Option<String>)`](crate::operation::get_ota_task::GetOtaTaskOutput::task_id): <p>The id of the over-the-air (OTA) task.</p>
9    ///   - [`task_arn(Option<String>)`](crate::operation::get_ota_task::GetOtaTaskOutput::task_arn): <p>The Amazon Resource Name (ARN) of the over-the-air (OTA) task</p>
10    ///   - [`description(Option<String>)`](crate::operation::get_ota_task::GetOtaTaskOutput::description): <p>The description of the over-the-air (OTA) task.</p>
11    ///   - [`s3_url(Option<String>)`](crate::operation::get_ota_task::GetOtaTaskOutput::s3_url): <p>The URL to the Amazon S3 bucket where the over-the-air (OTA) task is stored.</p>
12    ///   - [`protocol(Option<OtaProtocol>)`](crate::operation::get_ota_task::GetOtaTaskOutput::protocol): <p>The connection protocol the over-the-air (OTA) task uses to update the device.</p>
13    ///   - [`ota_type(Option<OtaType>)`](crate::operation::get_ota_task::GetOtaTaskOutput::ota_type): <p>The frequency type for the over-the-air (OTA) task.</p>
14    ///   - [`ota_target_query_string(Option<String>)`](crate::operation::get_ota_task::GetOtaTaskOutput::ota_target_query_string): <p>The query string to add things to the thing group.</p>
15    ///   - [`ota_mechanism(Option<OtaMechanism>)`](crate::operation::get_ota_task::GetOtaTaskOutput::ota_mechanism): <p>The deployment mechanism for the over-the-air (OTA) task.</p>
16    ///   - [`target(Option<Vec::<String>>)`](crate::operation::get_ota_task::GetOtaTaskOutput::target): <p>The device targeted for the over-the-air (OTA) task.</p>
17    ///   - [`created_at(Option<DateTime>)`](crate::operation::get_ota_task::GetOtaTaskOutput::created_at): <p>The timestamp value of when the over-the-air (OTA) task was created.</p>
18    ///   - [`last_updated_at(Option<DateTime>)`](crate::operation::get_ota_task::GetOtaTaskOutput::last_updated_at): <p>The timestamp value of when the over-the-air (OTA) task was last updated at.</p>
19    ///   - [`task_configuration_id(Option<String>)`](crate::operation::get_ota_task::GetOtaTaskOutput::task_configuration_id): <p>The identifier for the over-the-air (OTA) task configuration.</p>
20    ///   - [`task_processing_details(Option<TaskProcessingDetails>)`](crate::operation::get_ota_task::GetOtaTaskOutput::task_processing_details): <p>The processing details of all over-the-air (OTA) tasks.</p>
21    ///   - [`ota_scheduling_config(Option<OtaTaskSchedulingConfig>)`](crate::operation::get_ota_task::GetOtaTaskOutput::ota_scheduling_config): <p>Over-the-air (OTA) task scheduling config.</p>
22    ///   - [`ota_task_execution_retry_config(Option<OtaTaskExecutionRetryConfig>)`](crate::operation::get_ota_task::GetOtaTaskOutput::ota_task_execution_retry_config): <p>Over-the-air (OTA) task retry config.</p>
23    ///   - [`status(Option<OtaStatus>)`](crate::operation::get_ota_task::GetOtaTaskOutput::status): <p>The status of the over-the-air (OTA) task.</p>
24    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::get_ota_task::GetOtaTaskOutput::tags): <p>A set of key/value pairs that are used to manage the over-the-air (OTA) task.</p>
25    /// - On failure, responds with [`SdkError<GetOtaTaskError>`](crate::operation::get_ota_task::GetOtaTaskError)
26    pub fn get_ota_task(&self) -> crate::operation::get_ota_task::builders::GetOtaTaskFluentBuilder {
27        crate::operation::get_ota_task::builders::GetOtaTaskFluentBuilder::new(self.handle.clone())
28    }
29}