Struct aws_sdk_iot::input::CreateOtaUpdateInput

source ·

#[non_exhaustive]
pub struct CreateOtaUpdateInput { /* private fields */ }

Implementations§

source §

impl CreateOtaUpdateInput

source

pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<CreateOTAUpdate, AwsResponseRetryClassifier>, BuildError>

Consumes the builder and constructs an Operation<CreateOTAUpdate>

Examples found in repository ?

src/client.rs (line 6879)

        pub async fn customize(
            self,
        ) -> std::result::Result<
            crate::operation::customize::CustomizableOperation<
                crate::operation::CreateOTAUpdate,
                aws_http::retry::AwsResponseRetryClassifier,
            >,
            aws_smithy_http::result::SdkError<crate::error::CreateOTAUpdateError>,
        > {
            let handle = self.handle.clone();
            let operation = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            Ok(crate::operation::customize::CustomizableOperation { handle, operation })
        }

        /// 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](aws_smithy_types::retry::RetryConfig), which can be
        /// set when configuring the client.
        pub async fn send(
            self,
        ) -> std::result::Result<
            crate::output::CreateOtaUpdateOutput,
            aws_smithy_http::result::SdkError<crate::error::CreateOTAUpdateError>,
        > {
            let op = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&self.handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            self.handle.client.call(op).await
        }

source

pub fn builder() -> Builder

Creates a new builder-style object to manufacture CreateOtaUpdateInput.

source §

impl CreateOtaUpdateInput

source

pub fn ota_update_id(&self) -> Option<&str>

The ID of the OTA update to be created.

source

pub fn description(&self) -> Option<&str>

The description of the OTA update.

source

pub fn targets(&self) -> Option<&[String]>

The devices targeted to receive OTA updates.

source

pub fn protocols(&self) -> Option<&[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.

source

pub fn 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.

source

pub fn aws_job_executions_rollout_config(
&self
) -> Option<&AwsJobExecutionsRolloutConfig>

Configuration for the rollout of OTA updates.

source

pub fn aws_job_presigned_url_config(&self) -> Option<&AwsJobPresignedUrlConfig>

Configuration information for pre-signed URLs.

source

pub fn aws_job_abort_config(&self) -> Option<&AwsJobAbortConfig>

The criteria that determine when and how a job abort takes place.

source

pub fn 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.

source

pub fn files(&self) -> Option<&[OtaUpdateFile]>

The files to be streamed by the OTA update.

source

pub fn role_arn(&self) -> Option<&str>

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.

source