Struct CreateCommandInput

#[non_exhaustive]
pub struct CreateCommandInput {
    pub command_id: Option<String>,
    pub namespace: Option<CommandNamespace>,
    pub display_name: Option<String>,
    pub description: Option<String>,
    pub payload: Option<CommandPayload>,
    pub mandatory_parameters: Option<Vec<CommandParameter>>,
    pub role_arn: Option<String>,
    pub tags: Option<Vec<Tag>>,
}

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.

command_id: Option<String>

A unique identifier for the command. We recommend using UUID. Alpha-numeric characters, hyphens, and underscores are valid for use here.

namespace: Option<CommandNamespace>

The namespace of the command. The MQTT reserved topics and validations will be used for command executions according to the namespace setting.

display_name: Option<String>

The user-friendly name in the console for the command. This name doesn't have to be unique. You can update the user-friendly name after you define it.

description: Option<String>

A short text decription of the command.

payload: Option<CommandPayload>

The payload object for the command. You must specify this information when using the AWS-IoT namespace.

You can upload a static payload file from your local storage that contains the instructions for the device to process. The payload file can use any format. To make sure that the device correctly interprets the payload, we recommend you to specify the payload content type.

mandatory_parameters: Option<Vec<CommandParameter>>

A list of parameters that are required by the StartCommandExecution API. These parameters need to be specified only when using the AWS-IoT-FleetWise namespace. You can either specify them here or when running the command using the StartCommandExecution API.

role_arn: Option<String>

The IAM role that you must provide when using the AWS-IoT-FleetWise namespace. The role grants IoT Device Management the permission to access IoT FleetWise resources for generating the payload for the command. This field is not required when you use the AWS-IoT namespace.

tags: Option<Vec<Tag>>

Name-value pairs that are used as metadata to manage a command.

Implementations

impl CreateCommandInput

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

A unique identifier for the command. We recommend using UUID. Alpha-numeric characters, hyphens, and underscores are valid for use here.

pub fn namespace(&self) -> Option<&CommandNamespace>

The namespace of the command. The MQTT reserved topics and validations will be used for command executions according to the namespace setting.

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

The user-friendly name in the console for the command. This name doesn't have to be unique. You can update the user-friendly name after you define it.

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

A short text decription of the command.

pub fn payload(&self) -> Option<&CommandPayload>

The payload object for the command. You must specify this information when using the AWS-IoT namespace.

You can upload a static payload file from your local storage that contains the instructions for the device to process. The payload file can use any format. To make sure that the device correctly interprets the payload, we recommend you to specify the payload content type.

pub fn mandatory_parameters(&self) -> &[CommandParameter]

A list of parameters that are required by the StartCommandExecution API. These parameters need to be specified only when using the AWS-IoT-FleetWise namespace. You can either specify them here or when running the command using the StartCommandExecution API.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .mandatory_parameters.is_none().

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

The IAM role that you must provide when using the AWS-IoT-FleetWise namespace. The role grants IoT Device Management the permission to access IoT FleetWise resources for generating the payload for the command. This field is not required when you use the AWS-IoT namespace.

pub fn tags(&self) -> &[Tag]

Name-value pairs that are used as metadata to manage a command.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().

impl CreateCommandInput

pub fn builder() -> CreateCommandInputBuilder

Creates a new builder-style object to manufacture CreateCommandInput.

Trait Implementations

impl Clone for CreateCommandInput

fn clone(&self) -> CreateCommandInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateCommandInput

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

Formats the value using the given formatter.

impl PartialEq for CreateCommandInput

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