/AWS1/CL_IOTDESCRTHINGRESPONSE¶
The output from the DescribeThing operation.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_defaultclientid TYPE /AWS1/IOTCLIENTID /AWS1/IOTCLIENTID¶
The default MQTT client ID. For a typical device, the thing name is also used as the default MQTT client ID.
Although we don’t require a mapping between a thing's registry name and its use of MQTT client IDs, certificates, or shadow state, we recommend that you choose a thing name and use it as the MQTT client ID for the registry and the Device Shadow service.This lets you better organize your IoT fleet without removing the flexibility of the underlying device certificate model or shadows.
iv_thingname TYPE /AWS1/IOTTHINGNAME /AWS1/IOTTHINGNAME¶
The name of the thing.
iv_thingid TYPE /AWS1/IOTTHINGID /AWS1/IOTTHINGID¶
The ID of the thing to describe.
iv_thingarn TYPE /AWS1/IOTTHINGARN /AWS1/IOTTHINGARN¶
The ARN of the thing to describe.
iv_thingtypename TYPE /AWS1/IOTTHINGTYPENAME /AWS1/IOTTHINGTYPENAME¶
The thing type name.
it_attributes TYPE /AWS1/CL_IOTATTRIBUTES_W=>TT_ATTRIBUTES TT_ATTRIBUTES¶
The thing attributes.
iv_version TYPE /AWS1/IOTVERSION /AWS1/IOTVERSION¶
The current version of the thing record in the registry.
To avoid unintentional changes to the information in the registry, you can pass the version information in the
expectedVersionparameter of theUpdateThingandDeleteThingcalls.
iv_billinggroupname TYPE /AWS1/IOTBILLINGGROUPNAME /AWS1/IOTBILLINGGROUPNAME¶
The name of the billing group the thing belongs to.
Queryable Attributes¶
defaultClientId¶
The default MQTT client ID. For a typical device, the thing name is also used as the default MQTT client ID.
Although we don’t require a mapping between a thing's registry name and its use of MQTT client IDs, certificates, or shadow state, we recommend that you choose a thing name and use it as the MQTT client ID for the registry and the Device Shadow service.This lets you better organize your IoT fleet without removing the flexibility of the underlying device certificate model or shadows.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DEFAULTCLIENTID() |
Getter for DEFAULTCLIENTID, with configurable default |
ASK_DEFAULTCLIENTID() |
Getter for DEFAULTCLIENTID w/ exceptions if field has no val |
HAS_DEFAULTCLIENTID() |
Determine if DEFAULTCLIENTID has a value |
thingName¶
The name of the thing.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_THINGNAME() |
Getter for THINGNAME, with configurable default |
ASK_THINGNAME() |
Getter for THINGNAME w/ exceptions if field has no value |
HAS_THINGNAME() |
Determine if THINGNAME has a value |
thingId¶
The ID of the thing to describe.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_THINGID() |
Getter for THINGID, with configurable default |
ASK_THINGID() |
Getter for THINGID w/ exceptions if field has no value |
HAS_THINGID() |
Determine if THINGID has a value |
thingArn¶
The ARN of the thing to describe.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_THINGARN() |
Getter for THINGARN, with configurable default |
ASK_THINGARN() |
Getter for THINGARN w/ exceptions if field has no value |
HAS_THINGARN() |
Determine if THINGARN has a value |
thingTypeName¶
The thing type name.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_THINGTYPENAME() |
Getter for THINGTYPENAME, with configurable default |
ASK_THINGTYPENAME() |
Getter for THINGTYPENAME w/ exceptions if field has no value |
HAS_THINGTYPENAME() |
Determine if THINGTYPENAME has a value |
attributes¶
The thing attributes.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ATTRIBUTES() |
Getter for ATTRIBUTES, with configurable default |
ASK_ATTRIBUTES() |
Getter for ATTRIBUTES w/ exceptions if field has no value |
HAS_ATTRIBUTES() |
Determine if ATTRIBUTES has a value |
version¶
The current version of the thing record in the registry.
To avoid unintentional changes to the information in the registry, you can pass the version information in the
expectedVersionparameter of theUpdateThingandDeleteThingcalls.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_VERSION() |
Getter for VERSION |
billingGroupName¶
The name of the billing group the thing belongs to.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_BILLINGGROUPNAME() |
Getter for BILLINGGROUPNAME, with configurable default |
ASK_BILLINGGROUPNAME() |
Getter for BILLINGGROUPNAME w/ exceptions if field has no va |
HAS_BILLINGGROUPNAME() |
Determine if BILLINGGROUPNAME has a value |