aws_sdk_iotmanagedintegrations/client/

create_ota_task.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateOtaTask`](crate::operation::create_ota_task::builders::CreateOtaTaskFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`description(impl Into<String>)`](crate::operation::create_ota_task::builders::CreateOtaTaskFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::create_ota_task::builders::CreateOtaTaskFluentBuilder::set_description):<br>required: **false**<br><p>The description of the over-the-air (OTA) task.</p><br>
    ///   - [`s3_url(impl Into<String>)`](crate::operation::create_ota_task::builders::CreateOtaTaskFluentBuilder::s3_url) / [`set_s3_url(Option<String>)`](crate::operation::create_ota_task::builders::CreateOtaTaskFluentBuilder::set_s3_url):<br>required: **true**<br><p>The URL to the Amazon S3 bucket where the over-the-air (OTA) task is stored.</p><br>
    ///   - [`protocol(OtaProtocol)`](crate::operation::create_ota_task::builders::CreateOtaTaskFluentBuilder::protocol) / [`set_protocol(Option<OtaProtocol>)`](crate::operation::create_ota_task::builders::CreateOtaTaskFluentBuilder::set_protocol):<br>required: **false**<br><p>The connection protocol the over-the-air (OTA) task uses to update the device.</p><br>
    ///   - [`target(impl Into<String>)`](crate::operation::create_ota_task::builders::CreateOtaTaskFluentBuilder::target) / [`set_target(Option<Vec::<String>>)`](crate::operation::create_ota_task::builders::CreateOtaTaskFluentBuilder::set_target):<br>required: **false**<br><p>The device targeted for the over-the-air (OTA) task.</p><br>
    ///   - [`task_configuration_id(impl Into<String>)`](crate::operation::create_ota_task::builders::CreateOtaTaskFluentBuilder::task_configuration_id) / [`set_task_configuration_id(Option<String>)`](crate::operation::create_ota_task::builders::CreateOtaTaskFluentBuilder::set_task_configuration_id):<br>required: **false**<br><p>The identifier for the over-the-air (OTA) task configuration.</p><br>
    ///   - [`ota_mechanism(OtaMechanism)`](crate::operation::create_ota_task::builders::CreateOtaTaskFluentBuilder::ota_mechanism) / [`set_ota_mechanism(Option<OtaMechanism>)`](crate::operation::create_ota_task::builders::CreateOtaTaskFluentBuilder::set_ota_mechanism):<br>required: **false**<br><p>The deployment mechanism for the over-the-air (OTA) task.</p><br>
    ///   - [`ota_type(OtaType)`](crate::operation::create_ota_task::builders::CreateOtaTaskFluentBuilder::ota_type) / [`set_ota_type(Option<OtaType>)`](crate::operation::create_ota_task::builders::CreateOtaTaskFluentBuilder::set_ota_type):<br>required: **true**<br><p>The frequency type for the over-the-air (OTA) task.</p><br>
    ///   - [`ota_target_query_string(impl Into<String>)`](crate::operation::create_ota_task::builders::CreateOtaTaskFluentBuilder::ota_target_query_string) / [`set_ota_target_query_string(Option<String>)`](crate::operation::create_ota_task::builders::CreateOtaTaskFluentBuilder::set_ota_target_query_string):<br>required: **false**<br><p>The query string to add things to the thing group.</p><br>
    ///   - [`client_token(impl Into<String>)`](crate::operation::create_ota_task::builders::CreateOtaTaskFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::create_ota_task::builders::CreateOtaTaskFluentBuilder::set_client_token):<br>required: **false**<br><p>An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.</p><br>
    ///   - [`ota_scheduling_config(OtaTaskSchedulingConfig)`](crate::operation::create_ota_task::builders::CreateOtaTaskFluentBuilder::ota_scheduling_config) / [`set_ota_scheduling_config(Option<OtaTaskSchedulingConfig>)`](crate::operation::create_ota_task::builders::CreateOtaTaskFluentBuilder::set_ota_scheduling_config):<br>required: **false**<br><p>Over-the-air (OTA) task scheduling config.</p><br>
    ///   - [`ota_task_execution_retry_config(OtaTaskExecutionRetryConfig)`](crate::operation::create_ota_task::builders::CreateOtaTaskFluentBuilder::ota_task_execution_retry_config) / [`set_ota_task_execution_retry_config(Option<OtaTaskExecutionRetryConfig>)`](crate::operation::create_ota_task::builders::CreateOtaTaskFluentBuilder::set_ota_task_execution_retry_config):<br>required: **false**<br><p>Over-the-air (OTA) task retry config.</p><br>
    ///   - [`tags(impl Into<String>, impl Into<String>)`](crate::operation::create_ota_task::builders::CreateOtaTaskFluentBuilder::tags) / [`set_tags(Option<HashMap::<String, String>>)`](crate::operation::create_ota_task::builders::CreateOtaTaskFluentBuilder::set_tags):<br>required: **false**<br><p>A set of key/value pairs that are used to manage the over-the-air (OTA) task.</p><br>
    /// - On success, responds with [`CreateOtaTaskOutput`](crate::operation::create_ota_task::CreateOtaTaskOutput) with field(s):
    ///   - [`task_id(Option<String>)`](crate::operation::create_ota_task::CreateOtaTaskOutput::task_id): <p>The identifier of the over-the-air (OTA) task.</p>
    ///   - [`task_arn(Option<String>)`](crate::operation::create_ota_task::CreateOtaTaskOutput::task_arn): <p>The Amazon Resource Name (ARN) of the over-the-air (OTA) task.</p>
    ///   - [`description(Option<String>)`](crate::operation::create_ota_task::CreateOtaTaskOutput::description): <p>A description of the over-the-air (OTA) task.</p>
    /// - On failure, responds with [`SdkError<CreateOtaTaskError>`](crate::operation::create_ota_task::CreateOtaTaskError)
    pub fn create_ota_task(&self) -> crate::operation::create_ota_task::builders::CreateOtaTaskFluentBuilder {
        crate::operation::create_ota_task::builders::CreateOtaTaskFluentBuilder::new(self.handle.clone())
    }
}