Struct GetCommandExecutionOutput

#[non_exhaustive]
pub struct GetCommandExecutionOutput {

    pub execution_id: Option<String>,
    pub command_arn: Option<String>,
    pub target_arn: Option<String>,
    pub status: Option<CommandExecutionStatus>,
    pub status_reason: Option<StatusReason>,
    pub result: Option<HashMap<String, CommandExecutionResult>>,
    pub parameters: Option<HashMap<String, CommandParameterValue>>,
    pub execution_timeout_seconds: Option<i64>,
    pub created_at: Option<DateTime>,
    pub last_updated_at: Option<DateTime>,
    pub started_at: Option<DateTime>,
    pub completed_at: Option<DateTime>,
    pub time_to_live: Option<DateTime>,
    /* private fields */
}

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.

execution_id: Option<String>

The unique identifier of the command execution.

command_arn: Option<String>

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

target_arn: Option<String>

The Amazon Resource Number (ARN) of the device on which the command execution is being performed.

status: Option<CommandExecutionStatus>

The status of the command execution. After your devices receive the command and start performing the operations specified in the command, it can use the UpdateCommandExecution MQTT API to update the status information.

status_reason: Option<StatusReason>

Your devices can use this parameter to provide additional context about the status of a command execution using a reason code and description.

result: Option<HashMap<String, CommandExecutionResult>>

The result value for the current state of the command execution. The status provides information about the progress of the command execution. The device can use the result field to share additional details about the execution such as a return value of a remote function call.

If you use the AWS-IoT-FleetWise namespace, then this field is not applicable in the API response.

parameters: Option<HashMap<String, CommandParameterValue>>

The list of parameters that the StartCommandExecution API used when performing the command on the device.

execution_timeout_seconds: Option<i64>

Specifies the amount of time in seconds that the device can take to finish a command execution. A timer starts when 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.

created_at: Option<DateTime>

The timestamp, when the command execution was created.

last_updated_at: Option<DateTime>

The timestamp, when the command execution was last updated.

started_at: Option<DateTime>

The timestamp, when the command execution was started.

completed_at: Option<DateTime>

The timestamp, when the command execution was completed.

time_to_live: Option<DateTime>

The time to live (TTL) parameter that indicates the duration for which executions will be retained in your account. The default value is six months.

Implementations

impl GetCommandExecutionOutput

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

The unique identifier of the command execution.

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

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

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

The Amazon Resource Number (ARN) of the device on which the command execution is being performed.

pub fn status(&self) -> Option<&CommandExecutionStatus>

The status of the command execution. After your devices receive the command and start performing the operations specified in the command, it can use the UpdateCommandExecution MQTT API to update the status information.

pub fn status_reason(&self) -> Option<&StatusReason>

Your devices can use this parameter to provide additional context about the status of a command execution using a reason code and description.

pub fn result(&self) -> Option<&HashMap<String, CommandExecutionResult>>

The result value for the current state of the command execution. The status provides information about the progress of the command execution. The device can use the result field to share additional details about the execution such as a return value of a remote function call.

If you use the AWS-IoT-FleetWise namespace, then this field is not applicable in the API response.

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

The list of parameters that the StartCommandExecution API used when performing the command on the device.

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

Specifies the amount of time in seconds that the device can take to finish a command execution. A timer starts when 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 created_at(&self) -> Option<&DateTime>

The timestamp, when the command execution was created.

pub fn last_updated_at(&self) -> Option<&DateTime>

The timestamp, when the command execution was last updated.

pub fn started_at(&self) -> Option<&DateTime>

The timestamp, when the command execution was started.

pub fn completed_at(&self) -> Option<&DateTime>

The timestamp, when the command execution was completed.

pub fn time_to_live(&self) -> Option<&DateTime>

The time to live (TTL) parameter that indicates the duration for which executions will be retained in your account. The default value is six months.

impl GetCommandExecutionOutput

pub fn builder() -> GetCommandExecutionOutputBuilder

Creates a new builder-style object to manufacture GetCommandExecutionOutput.

Trait Implementations

impl Clone for GetCommandExecutionOutput

fn clone(&self) -> GetCommandExecutionOutput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GetCommandExecutionOutput

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

Formats the value using the given formatter.

impl PartialEq for GetCommandExecutionOutput

fn eq(&self, other: &GetCommandExecutionOutput) -> 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 RequestId for GetCommandExecutionOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for GetCommandExecutionOutput