aws_sdk_iotjobsdataplane/client/

start_command_execution.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`StartCommandExecution`](crate::operation::start_command_execution::builders::StartCommandExecutionFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`target_arn(impl Into<String>)`](crate::operation::start_command_execution::builders::StartCommandExecutionFluentBuilder::target_arn) / [`set_target_arn(Option<String>)`](crate::operation::start_command_execution::builders::StartCommandExecutionFluentBuilder::set_target_arn):<br>required: **true**<br><p>The Amazon Resource Number (ARN) of the device where the command execution is occurring.</p><br>
    ///   - [`command_arn(impl Into<String>)`](crate::operation::start_command_execution::builders::StartCommandExecutionFluentBuilder::command_arn) / [`set_command_arn(Option<String>)`](crate::operation::start_command_execution::builders::StartCommandExecutionFluentBuilder::set_command_arn):<br>required: **true**<br><p>The Amazon Resource Number (ARN) of the command. For example, <code>arn:aws:iot:<region>    :    <accountid>     :command/     <commandname></commandname>    </accountid>   </region></code></p><br>
    ///   - [`parameters(impl Into<String>, CommandParameterValue)`](crate::operation::start_command_execution::builders::StartCommandExecutionFluentBuilder::parameters) / [`set_parameters(Option<HashMap::<String, CommandParameterValue>>)`](crate::operation::start_command_execution::builders::StartCommandExecutionFluentBuilder::set_parameters):<br>required: **false**<br><p>A list of parameters that are required by the <code>StartCommandExecution</code> API when performing the command on a device.</p><br>
    ///   - [`execution_timeout_seconds(i64)`](crate::operation::start_command_execution::builders::StartCommandExecutionFluentBuilder::execution_timeout_seconds) / [`set_execution_timeout_seconds(Option<i64>)`](crate::operation::start_command_execution::builders::StartCommandExecutionFluentBuilder::set_execution_timeout_seconds):<br>required: **false**<br><p>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 <code>TIMED_OUT</code>.</p><br>
    ///   - [`client_token(impl Into<String>)`](crate::operation::start_command_execution::builders::StartCommandExecutionFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::start_command_execution::builders::StartCommandExecutionFluentBuilder::set_client_token):<br>required: **false**<br><p>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.</p><br>
    /// - On success, responds with [`StartCommandExecutionOutput`](crate::operation::start_command_execution::StartCommandExecutionOutput) with field(s):
    ///   - [`execution_id(Option<String>)`](crate::operation::start_command_execution::StartCommandExecutionOutput::execution_id): <p>A unique identifier for the command execution.</p>
    /// - On failure, responds with [`SdkError<StartCommandExecutionError>`](crate::operation::start_command_execution::StartCommandExecutionError)
    pub fn start_command_execution(&self) -> crate::operation::start_command_execution::builders::StartCommandExecutionFluentBuilder {
        crate::operation::start_command_execution::builders::StartCommandExecutionFluentBuilder::new(self.handle.clone())
    }
}