CommandParameter - AWS IoT

CommandParameter

A map of key-value pairs that describe the command.

Contents

name

The name of a specific parameter used in a command and command execution.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 192.

Pattern: ^[.$a-zA-Z0-9_-]+$

Required: Yes

defaultValue

The default value used to describe the command. This is the value assumed by the parameter if no other value is assigned to it.

Type: CommandParameterValue object

Required: No

description

The description of the command parameter.

Type: String

Length Constraints: Maximum length of 2028.

Pattern: [^\p{C}]*

Required: No

value

The value used to describe the command. When you assign a value to a parameter, it will override any default value that you had already specified.

Type: CommandParameterValue object

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: