GetCommand - AWS IoT
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

GetCommand

Gets information about the specified command.

Request Syntax

GET /commands/commandId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

commandId

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

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

Pattern: [a-zA-Z0-9_-]+

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "commandArn": "string",
   "commandId": "string",
   "createdAt": number,
   "deprecated": boolean,
   "description": "string",
   "displayName": "string",
   "lastUpdatedAt": number,
   "mandatoryParameters": [ 
      { 
         "defaultValue": { 
            "B": boolean,
            "BIN": blob,
            "D": number,
            "I": number,
            "L": number,
            "S": "string",
            "UL": "string"
         },
         "description": "string",
         "name": "string",
         "value": { 
            "B": boolean,
            "BIN": blob,
            "D": number,
            "I": number,
            "L": number,
            "S": "string",
            "UL": "string"
         }
      }
   ],
   "namespace": "string",
   "payload": { 
      "content": blob,
      "contentType": "string"
   },
   "pendingDeletion": boolean,
   "roleArn": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

commandArn

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

Type: String

commandId

The unique identifier of the command.

Type: String

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

Pattern: [a-zA-Z0-9_-]+

createdAt

The timestamp, when the command was created.

Type: Timestamp

deprecated

Indicates whether the command has been deprecated.

Type: Boolean

description

A short text description of the command.

Type: String

Length Constraints: Maximum length of 2028.

Pattern: [^\p{C}]*

displayName

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

Type: String

Length Constraints: Maximum length of 64.

Pattern: [^\p{C}]*

lastUpdatedAt

The timestamp, when the command was last updated.

Type: Timestamp

mandatoryParameters

A list of parameters for the command created.

Type: Array of CommandParameter objects

Array Members: Minimum number of 1 item.

namespace

The namespace of the command.

Type: String

Valid Values: AWS-IoT | AWS-IoT-FleetWise

payload

The payload object that you provided for the command.

Type: CommandPayload object

pendingDeletion

Indicates whether the command is being deleted.

Type: Boolean

roleArn

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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Errors

InternalServerException

Internal error from the service that indicates an unexpected error or that the service is unavailable.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 404

ThrottlingException

The rate exceeds the limit.

HTTP Status Code: 400

ValidationException

The request is not valid.

HTTP Status Code: 400

See Also

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