aws_sdk_iot/client/
get_command.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`GetCommand`](crate::operation::get_command::builders::GetCommandFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`command_id(impl Into<String>)`](crate::operation::get_command::builders::GetCommandFluentBuilder::command_id) / [`set_command_id(Option<String>)`](crate::operation::get_command::builders::GetCommandFluentBuilder::set_command_id):<br>required: **true**<br><p>The unique identifier of the command for which you want to retrieve information.</p><br>
7    /// - On success, responds with [`GetCommandOutput`](crate::operation::get_command::GetCommandOutput) with field(s):
8    ///   - [`command_id(Option<String>)`](crate::operation::get_command::GetCommandOutput::command_id): <p>The unique identifier of the command.</p>
9    ///   - [`command_arn(Option<String>)`](crate::operation::get_command::GetCommandOutput::command_arn): <p>The Amazon Resource Number (ARN) of the command. For example, <code>arn:aws:iot:<region>    :    <accountid>     :command/     <commandid></commandid>    </accountid>   </region></code></p>
10    ///   - [`namespace(Option<CommandNamespace>)`](crate::operation::get_command::GetCommandOutput::namespace): <p>The namespace of the command.</p>
11    ///   - [`display_name(Option<String>)`](crate::operation::get_command::GetCommandOutput::display_name): <p>The user-friendly name in the console for the command.</p>
12    ///   - [`description(Option<String>)`](crate::operation::get_command::GetCommandOutput::description): <p>A short text description of the command.</p>
13    ///   - [`mandatory_parameters(Option<Vec::<CommandParameter>>)`](crate::operation::get_command::GetCommandOutput::mandatory_parameters): <p>A list of parameters for the command created.</p>
14    ///   - [`payload(Option<CommandPayload>)`](crate::operation::get_command::GetCommandOutput::payload): <p>The payload object that you provided for the command.</p>
15    ///   - [`role_arn(Option<String>)`](crate::operation::get_command::GetCommandOutput::role_arn): <p>The IAM role that you provided when creating the command with <code>AWS-IoT-FleetWise</code> as the namespace.</p>
16    ///   - [`created_at(Option<DateTime>)`](crate::operation::get_command::GetCommandOutput::created_at): <p>The timestamp, when the command was created.</p>
17    ///   - [`last_updated_at(Option<DateTime>)`](crate::operation::get_command::GetCommandOutput::last_updated_at): <p>The timestamp, when the command was last updated.</p>
18    ///   - [`deprecated(Option<bool>)`](crate::operation::get_command::GetCommandOutput::deprecated): <p>Indicates whether the command has been deprecated.</p>
19    ///   - [`pending_deletion(Option<bool>)`](crate::operation::get_command::GetCommandOutput::pending_deletion): <p>Indicates whether the command is being deleted.</p>
20    /// - On failure, responds with [`SdkError<GetCommandError>`](crate::operation::get_command::GetCommandError)
21    pub fn get_command(&self) -> crate::operation::get_command::builders::GetCommandFluentBuilder {
22        crate::operation::get_command::builders::GetCommandFluentBuilder::new(self.handle.clone())
23    }
24}
aws_sdk_iot/client/get_command.rs

aws_sdk_iot/client/
get_command.rs
