Struct aws_sdk_iot::input::CreateOtaUpdateInput
source · [−]#[non_exhaustive]pub struct CreateOtaUpdateInput {Show 13 fields
pub ota_update_id: Option<String>,
pub description: Option<String>,
pub targets: Option<Vec<String>>,
pub protocols: Option<Vec<Protocol>>,
pub target_selection: Option<TargetSelection>,
pub aws_job_executions_rollout_config: Option<AwsJobExecutionsRolloutConfig>,
pub aws_job_presigned_url_config: Option<AwsJobPresignedUrlConfig>,
pub aws_job_abort_config: Option<AwsJobAbortConfig>,
pub aws_job_timeout_config: Option<AwsJobTimeoutConfig>,
pub files: Option<Vec<OtaUpdateFile>>,
pub role_arn: Option<String>,
pub additional_parameters: Option<HashMap<String, String>>,
pub tags: Option<Vec<Tag>>,
}
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.ota_update_id: Option<String>
The ID of the OTA update to be created.
description: Option<String>
The description of the OTA update.
targets: Option<Vec<String>>
The devices targeted to receive OTA updates.
protocols: Option<Vec<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.
target_selection: 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.
aws_job_executions_rollout_config: Option<AwsJobExecutionsRolloutConfig>
Configuration for the rollout of OTA updates.
aws_job_presigned_url_config: Option<AwsJobPresignedUrlConfig>
Configuration information for pre-signed URLs.
aws_job_abort_config: Option<AwsJobAbortConfig>
The criteria that determine when and how a job abort takes place.
aws_job_timeout_config: 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
.
files: Option<Vec<OtaUpdateFile>>
The files to be streamed by the OTA update.
role_arn: Option<String>
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.
additional_parameters: Option<HashMap<String, String>>
A list of additional OTA update parameters which are name-value pairs.
Metadata which can be used to manage updates.
Implementations
sourceimpl CreateOtaUpdateInput
impl CreateOtaUpdateInput
sourcepub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<CreateOTAUpdate, AwsErrorRetryPolicy>, BuildError>
pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<CreateOTAUpdate, AwsErrorRetryPolicy>, BuildError>
Consumes the builder and constructs an Operation<CreateOTAUpdate
>
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture CreateOtaUpdateInput
sourceimpl CreateOtaUpdateInput
impl CreateOtaUpdateInput
sourcepub fn ota_update_id(&self) -> Option<&str>
pub fn ota_update_id(&self) -> Option<&str>
The ID of the OTA update to be created.
sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
The description of the OTA update.
sourcepub fn protocols(&self) -> Option<&[Protocol]>
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.
sourcepub fn target_selection(&self) -> Option<&TargetSelection>
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.
sourcepub fn aws_job_executions_rollout_config(
&self
) -> Option<&AwsJobExecutionsRolloutConfig>
pub fn aws_job_executions_rollout_config(
&self
) -> Option<&AwsJobExecutionsRolloutConfig>
Configuration for the rollout of OTA updates.
sourcepub fn aws_job_presigned_url_config(&self) -> Option<&AwsJobPresignedUrlConfig>
pub fn aws_job_presigned_url_config(&self) -> Option<&AwsJobPresignedUrlConfig>
Configuration information for pre-signed URLs.
sourcepub fn aws_job_abort_config(&self) -> Option<&AwsJobAbortConfig>
pub fn aws_job_abort_config(&self) -> Option<&AwsJobAbortConfig>
The criteria that determine when and how a job abort takes place.
sourcepub fn aws_job_timeout_config(&self) -> Option<&AwsJobTimeoutConfig>
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
.
sourcepub fn role_arn(&self) -> Option<&str>
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.
sourcepub fn additional_parameters(&self) -> Option<&HashMap<String, String>>
pub fn additional_parameters(&self) -> Option<&HashMap<String, String>>
A list of additional OTA update parameters which are name-value pairs.
Metadata which can be used to manage updates.
Trait Implementations
sourceimpl Clone for CreateOtaUpdateInput
impl Clone for CreateOtaUpdateInput
sourcefn clone(&self) -> CreateOtaUpdateInput
fn clone(&self) -> CreateOtaUpdateInput
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for CreateOtaUpdateInput
impl Debug for CreateOtaUpdateInput
sourceimpl PartialEq<CreateOtaUpdateInput> for CreateOtaUpdateInput
impl PartialEq<CreateOtaUpdateInput> for CreateOtaUpdateInput
sourcefn eq(&self, other: &CreateOtaUpdateInput) -> bool
fn eq(&self, other: &CreateOtaUpdateInput) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &CreateOtaUpdateInput) -> bool
fn ne(&self, other: &CreateOtaUpdateInput) -> bool
This method tests for !=
.
impl StructuralPartialEq for CreateOtaUpdateInput
Auto Trait Implementations
impl RefUnwindSafe for CreateOtaUpdateInput
impl Send for CreateOtaUpdateInput
impl Sync for CreateOtaUpdateInput
impl Unpin for CreateOtaUpdateInput
impl UnwindSafe for CreateOtaUpdateInput
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more