/AWS1/CL_IOTGETCOMMANDRESPONSE¶
GetCommandResponse
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_commandid TYPE /AWS1/IOTCOMMANDID /AWS1/IOTCOMMANDID¶
The unique identifier of the command.
iv_commandarn TYPE /AWS1/IOTCOMMANDARN /AWS1/IOTCOMMANDARN¶
The Amazon Resource Number (ARN) of the command. For example,
arn:aws:iot:: :command/
iv_namespace TYPE /AWS1/IOTCOMMANDNAMESPACE /AWS1/IOTCOMMANDNAMESPACE¶
The namespace of the command.
iv_displayname TYPE /AWS1/IOTDISPLAYNAME /AWS1/IOTDISPLAYNAME¶
The user-friendly name in the console for the command.
iv_description TYPE /AWS1/IOTCOMMANDDESCRIPTION /AWS1/IOTCOMMANDDESCRIPTION¶
A short text description of the command.
it_mandatoryparameters TYPE /AWS1/CL_IOTCOMMANDPARAMETER=>TT_COMMANDPARAMETERLIST TT_COMMANDPARAMETERLIST¶
A list of parameters for the command created.
io_payload TYPE REF TO /AWS1/CL_IOTCOMMANDPAYLOAD /AWS1/CL_IOTCOMMANDPAYLOAD¶
The payload object that you provided for the command.
iv_payloadtemplate TYPE /AWS1/IOTCMDPAYLOADTMPLSTRING /AWS1/IOTCMDPAYLOADTMPLSTRING¶
The payload template for the dynamic command.
io_preprocessor TYPE REF TO /AWS1/CL_IOTCOMMANDPREPROCOR /AWS1/CL_IOTCOMMANDPREPROCOR¶
Configuration that determines how
payloadTemplateis processed to generate command execution payload.
iv_rolearn TYPE /AWS1/IOTROLEARN /AWS1/IOTROLEARN¶
The IAM role that you provided when creating the command with
AWS-IoT-FleetWiseas the namespace.
iv_createdat TYPE /AWS1/IOTDATETYPE /AWS1/IOTDATETYPE¶
The timestamp, when the command was created.
iv_lastupdatedat TYPE /AWS1/IOTDATETYPE /AWS1/IOTDATETYPE¶
The timestamp, when the command was last updated.
iv_deprecated TYPE /AWS1/IOTDEPRECATIONFLAG /AWS1/IOTDEPRECATIONFLAG¶
Indicates whether the command has been deprecated.
iv_pendingdeletion TYPE /AWS1/IOTBOOLEANWRAPPEROBJECT /AWS1/IOTBOOLEANWRAPPEROBJECT¶
Indicates whether the command is being deleted.
Queryable Attributes¶
commandId¶
The unique identifier of the command.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_COMMANDID() |
Getter for COMMANDID, with configurable default |
ASK_COMMANDID() |
Getter for COMMANDID w/ exceptions if field has no value |
HAS_COMMANDID() |
Determine if COMMANDID has a value |
commandArn¶
The Amazon Resource Number (ARN) of the command. For example,
arn:aws:iot:: :command/
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_COMMANDARN() |
Getter for COMMANDARN, with configurable default |
ASK_COMMANDARN() |
Getter for COMMANDARN w/ exceptions if field has no value |
HAS_COMMANDARN() |
Determine if COMMANDARN has a value |
namespace¶
The namespace of the command.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NAMESPACE() |
Getter for NAMESPACE, with configurable default |
ASK_NAMESPACE() |
Getter for NAMESPACE w/ exceptions if field has no value |
HAS_NAMESPACE() |
Determine if NAMESPACE has a value |
displayName¶
The user-friendly name in the console for the command.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DISPLAYNAME() |
Getter for DISPLAYNAME, with configurable default |
ASK_DISPLAYNAME() |
Getter for DISPLAYNAME w/ exceptions if field has no value |
HAS_DISPLAYNAME() |
Determine if DISPLAYNAME has a value |
description¶
A short text description of the command.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DESCRIPTION() |
Getter for DESCRIPTION, with configurable default |
ASK_DESCRIPTION() |
Getter for DESCRIPTION w/ exceptions if field has no value |
HAS_DESCRIPTION() |
Determine if DESCRIPTION has a value |
mandatoryParameters¶
A list of parameters for the command created.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MANDATORYPARAMETERS() |
Getter for MANDATORYPARAMETERS, with configurable default |
ASK_MANDATORYPARAMETERS() |
Getter for MANDATORYPARAMETERS w/ exceptions if field has no |
HAS_MANDATORYPARAMETERS() |
Determine if MANDATORYPARAMETERS has a value |
payload¶
The payload object that you provided for the command.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PAYLOAD() |
Getter for PAYLOAD |
payloadTemplate¶
The payload template for the dynamic command.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PAYLOADTEMPLATE() |
Getter for PAYLOADTEMPLATE, with configurable default |
ASK_PAYLOADTEMPLATE() |
Getter for PAYLOADTEMPLATE w/ exceptions if field has no val |
HAS_PAYLOADTEMPLATE() |
Determine if PAYLOADTEMPLATE has a value |
preprocessor¶
Configuration that determines how
payloadTemplateis processed to generate command execution payload.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PREPROCESSOR() |
Getter for PREPROCESSOR |
roleArn¶
The IAM role that you provided when creating the command with
AWS-IoT-FleetWiseas the namespace.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ROLEARN() |
Getter for ROLEARN, with configurable default |
ASK_ROLEARN() |
Getter for ROLEARN w/ exceptions if field has no value |
HAS_ROLEARN() |
Determine if ROLEARN has a value |
createdAt¶
The timestamp, when the command was created.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATEDAT() |
Getter for CREATEDAT, with configurable default |
ASK_CREATEDAT() |
Getter for CREATEDAT w/ exceptions if field has no value |
HAS_CREATEDAT() |
Determine if CREATEDAT has a value |
lastUpdatedAt¶
The timestamp, when the command was last updated.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LASTUPDATEDAT() |
Getter for LASTUPDATEDAT, with configurable default |
ASK_LASTUPDATEDAT() |
Getter for LASTUPDATEDAT w/ exceptions if field has no value |
HAS_LASTUPDATEDAT() |
Determine if LASTUPDATEDAT has a value |
deprecated¶
Indicates whether the command has been deprecated.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DEPRECATED() |
Getter for DEPRECATED, with configurable default |
ASK_DEPRECATED() |
Getter for DEPRECATED w/ exceptions if field has no value |
HAS_DEPRECATED() |
Determine if DEPRECATED has a value |
pendingDeletion¶
Indicates whether the command is being deleted.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PENDINGDELETION() |
Getter for PENDINGDELETION, with configurable default |
ASK_PENDINGDELETION() |
Getter for PENDINGDELETION w/ exceptions if field has no val |
HAS_PENDINGDELETION() |
Determine if PENDINGDELETION has a value |