AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . iot ]

get-command

Description

Gets information about the specified command.

See also: AWS API Documentation

Synopsis

  get-command
--command-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--v2-debug]

Options

--command-id (string)

The unique identifier of the command for which you want to retrieve information.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

commandId -> (string)

The unique identifier of the command.

commandArn -> (string)

The Amazon Resource Number (ARN) of the command. For example, arn:aws:iot:<region>:<accountid>:command/<commandId>

namespace -> (string)

The namespace of the command.

displayName -> (string)

The user-friendly name in the console for the command.

description -> (string)

A short text description of the command.

mandatoryParameters -> (list)

A list of parameters for the command created.

(structure)

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

name -> (string)

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

type -> (string)

The type of the command parameter.

value -> (structure)

Parameter value that overrides the default value, if set.

S -> (string)

An attribute of type String. For example:

"S": "Hello"

B -> (boolean)

An attribute of type Boolean. For example:

"BOOL": true

I -> (integer)

An attribute of type Integer (Thirty-Two Bits).

L -> (long)

An attribute of type Long.

D -> (double)

An attribute of type Double (Sixty-Four Bits).

BIN -> (blob)

An attribute of type Binary. For example:

"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

UL -> (string)

An attribute of type unsigned long.

defaultValue -> (structure)

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

S -> (string)

An attribute of type String. For example:

"S": "Hello"

B -> (boolean)

An attribute of type Boolean. For example:

"BOOL": true

I -> (integer)

An attribute of type Integer (Thirty-Two Bits).

L -> (long)

An attribute of type Long.

D -> (double)

An attribute of type Double (Sixty-Four Bits).

BIN -> (blob)

An attribute of type Binary. For example:

"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

UL -> (string)

An attribute of type unsigned long.

valueConditions -> (list)

The list of conditions that a command parameter value must satisfy to create a command execution.

(structure)

A condition for the command parameter that must be evaluated to true for successful creation of a command execution.

comparisonOperator -> (string)

The comparison operator for the command parameter.

Note

IN_RANGE, and NOT_IN_RANGE operators include boundary values.

operand -> (structure)

The comparison operand for the command parameter.

number -> (string)

An operand of number value type, defined as a string.

numbers -> (list)

A List of operands of numerical value type, defined as strings.

(string)

string -> (string)

An operand of string value type.

strings -> (list)

A List of operands of string value type.

(string)

numberRange -> (structure)

An operand of numerical range value type.

min -> (string)

The minimum value of a numerical range of a command parameter value.

max -> (string)

The maximum value of a numerical range of a command parameter value.

description -> (string)

The description of the command parameter.

payload -> (structure)

The payload object that you provided for the command.

content -> (blob)

The static payload file for the command.

contentType -> (string)

The content type that specifies the format type of the payload file. This field must use a type/subtype format, such as application/json . For information about various content types, see Common MIME types .

payloadTemplate -> (string)

The payload template for the dynamic command.

preprocessor -> (structure)

Configuration that determines how payloadTemplate is processed to generate command execution payload.

awsJsonSubstitution -> (structure)

Configuration for the JSON substitution preprocessor.

outputFormat -> (string)

Converts the command preprocessor result to the format defined by this parameter, before sending it to the device.

roleArn -> (string)

The IAM role that you provided when creating the command with AWS-IoT-FleetWise as the namespace.

createdAt -> (timestamp)

The timestamp, when the command was created.

lastUpdatedAt -> (timestamp)

The timestamp, when the command was last updated.

deprecated -> (boolean)

Indicates whether the command has been deprecated.

pendingDeletion -> (boolean)

Indicates whether the command is being deleted.