Struct StartCommandExecutionInput 

#[non_exhaustive]
pub struct StartCommandExecutionInput {
    pub target_arn: Option<String>,
    pub command_arn: Option<String>,
    pub parameters: Option<HashMap<String, CommandParameterValue>>,
    pub execution_timeout_seconds: Option<i64>,
    pub client_token: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

target_arn: Option<String>

The Amazon Resource Number (ARN) of the device where the command execution is occurring.

command_arn: Option<String>

The Amazon Resource Number (ARN) of the command. For example, arn:aws:iot: : :command/

parameters: Option<HashMap<String, CommandParameterValue>>

A list of parameters that are required by the StartCommandExecution API when performing the command on a device.

execution_timeout_seconds: Option<i64>

Specifies the amount of time in second the device has to finish the command execution. A timer is started as soon as the command execution is created. If the command execution status is not set to another terminal state before the timer expires, it will automatically update to TIMED_OUT.

client_token: Option<String>

The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you retry the request using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.

Implementations

impl StartCommandExecutionInput

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

The Amazon Resource Number (ARN) of the device where the command execution is occurring.

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

The Amazon Resource Number (ARN) of the command. For example, arn:aws:iot: : :command/

pub fn parameters(&self) -> Option<&HashMap<String, CommandParameterValue>>

A list of parameters that are required by the StartCommandExecution API when performing the command on a device.

pub fn execution_timeout_seconds(&self) -> Option<i64>

Specifies the amount of time in second the device has to finish the command execution. A timer is started as soon as the command execution is created. If the command execution status is not set to another terminal state before the timer expires, it will automatically update to TIMED_OUT.

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

The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you retry the request using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.

impl StartCommandExecutionInput

pub fn builder() -> StartCommandExecutionInputBuilder

Creates a new builder-style object to manufacture StartCommandExecutionInput.

Trait Implementations

impl Clone for StartCommandExecutionInput

fn clone(&self) -> StartCommandExecutionInput

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StartCommandExecutionInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for StartCommandExecutionInput

fn eq(&self, other: &StartCommandExecutionInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for StartCommandExecutionInput