/AWS1/CL_IOTGETTHINGCVYDATARSP¶
GetThingConnectivityDataResponse
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_thingname TYPE /AWS1/IOTCNNCTVYAPITHINGNAME /AWS1/IOTCNNCTVYAPITHINGNAME¶
The name of your IoT thing.
iv_connected TYPE /AWS1/IOTBOOLEAN /AWS1/IOTBOOLEAN¶
A Boolean that indicates the connectivity status.
iv_timestamp TYPE /AWS1/IOTTIMESTAMP /AWS1/IOTTIMESTAMP¶
The timestamp of when the device connected or disconnected.
iv_disconnectreason TYPE /AWS1/IOTDISCONNECTREASONVALUE /AWS1/IOTDISCONNECTREASONVALUE¶
The reason that the client is disconnected.
iv_sourceip TYPE /AWS1/IOTSOURCEIP /AWS1/IOTSOURCEIP¶
The IP address of the client that initiated the connection.
iv_sourceport TYPE /AWS1/IOTSOURCEPORT /AWS1/IOTSOURCEPORT¶
The client's source port.
iv_targetip TYPE /AWS1/IOTTARGETIP /AWS1/IOTTARGETIP¶
The IP address of the Amazon Web Services IoT Core endpoint that the client connected to.
iv_targetport TYPE /AWS1/IOTTARGETPORT /AWS1/IOTTARGETPORT¶
The port number of the Amazon Web Services IoT Core endpoint that the client connected to.
iv_vpcendpointid TYPE /AWS1/IOTVPCENDPOINTID /AWS1/IOTVPCENDPOINTID¶
The ID of the VPC endpoint. Present for clients connected to Amazon Web Services IoT Core via a VPC endpoint.
iv_keepaliveduration TYPE /AWS1/IOTKEEPALIVEDURATION /AWS1/IOTKEEPALIVEDURATION¶
The keep-alive interval in seconds that the client specified when establishing the connection.
iv_cleansession TYPE /AWS1/IOTBOOLEAN /AWS1/IOTBOOLEAN¶
Indicates whether the client is using a clean session. Returns
truefor clean sessions.
iv_sessionexpiry TYPE /AWS1/IOTSESSIONEXPIRY /AWS1/IOTSESSIONEXPIRY¶
The session expiry interval in seconds for the MQTT client connection. This value indicates how long the session will remain active after the client disconnects.
iv_clientid TYPE /AWS1/IOTCLIENTID /AWS1/IOTCLIENTID¶
The unique identifier of the MQTT client.
Queryable Attributes¶
thingName¶
The name of your IoT 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 |
connected¶
A Boolean that indicates the connectivity status.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CONNECTED() |
Getter for CONNECTED, with configurable default |
ASK_CONNECTED() |
Getter for CONNECTED w/ exceptions if field has no value |
HAS_CONNECTED() |
Determine if CONNECTED has a value |
timestamp¶
The timestamp of when the device connected or disconnected.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TIMESTAMP() |
Getter for TIMESTAMP, with configurable default |
ASK_TIMESTAMP() |
Getter for TIMESTAMP w/ exceptions if field has no value |
HAS_TIMESTAMP() |
Determine if TIMESTAMP has a value |
disconnectReason¶
The reason that the client is disconnected.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DISCONNECTREASON() |
Getter for DISCONNECTREASON, with configurable default |
ASK_DISCONNECTREASON() |
Getter for DISCONNECTREASON w/ exceptions if field has no va |
HAS_DISCONNECTREASON() |
Determine if DISCONNECTREASON has a value |
sourceIp¶
The IP address of the client that initiated the connection.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SOURCEIP() |
Getter for SOURCEIP, with configurable default |
ASK_SOURCEIP() |
Getter for SOURCEIP w/ exceptions if field has no value |
HAS_SOURCEIP() |
Determine if SOURCEIP has a value |
sourcePort¶
The client's source port.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SOURCEPORT() |
Getter for SOURCEPORT, with configurable default |
ASK_SOURCEPORT() |
Getter for SOURCEPORT w/ exceptions if field has no value |
HAS_SOURCEPORT() |
Determine if SOURCEPORT has a value |
targetIp¶
The IP address of the Amazon Web Services IoT Core endpoint that the client connected to.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TARGETIP() |
Getter for TARGETIP, with configurable default |
ASK_TARGETIP() |
Getter for TARGETIP w/ exceptions if field has no value |
HAS_TARGETIP() |
Determine if TARGETIP has a value |
targetPort¶
The port number of the Amazon Web Services IoT Core endpoint that the client connected to.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TARGETPORT() |
Getter for TARGETPORT, with configurable default |
ASK_TARGETPORT() |
Getter for TARGETPORT w/ exceptions if field has no value |
HAS_TARGETPORT() |
Determine if TARGETPORT has a value |
vpcEndpointId¶
The ID of the VPC endpoint. Present for clients connected to Amazon Web Services IoT Core via a VPC endpoint.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_VPCENDPOINTID() |
Getter for VPCENDPOINTID, with configurable default |
ASK_VPCENDPOINTID() |
Getter for VPCENDPOINTID w/ exceptions if field has no value |
HAS_VPCENDPOINTID() |
Determine if VPCENDPOINTID has a value |
keepAliveDuration¶
The keep-alive interval in seconds that the client specified when establishing the connection.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_KEEPALIVEDURATION() |
Getter for KEEPALIVEDURATION, with configurable default |
ASK_KEEPALIVEDURATION() |
Getter for KEEPALIVEDURATION w/ exceptions if field has no v |
HAS_KEEPALIVEDURATION() |
Determine if KEEPALIVEDURATION has a value |
cleanSession¶
Indicates whether the client is using a clean session. Returns
truefor clean sessions.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CLEANSESSION() |
Getter for CLEANSESSION, with configurable default |
ASK_CLEANSESSION() |
Getter for CLEANSESSION w/ exceptions if field has no value |
HAS_CLEANSESSION() |
Determine if CLEANSESSION has a value |
sessionExpiry¶
The session expiry interval in seconds for the MQTT client connection. This value indicates how long the session will remain active after the client disconnects.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SESSIONEXPIRY() |
Getter for SESSIONEXPIRY, with configurable default |
ASK_SESSIONEXPIRY() |
Getter for SESSIONEXPIRY w/ exceptions if field has no value |
HAS_SESSIONEXPIRY() |
Determine if SESSIONEXPIRY has a value |
clientId¶
The unique identifier of the MQTT client.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CLIENTID() |
Getter for CLIENTID, with configurable default |
ASK_CLIENTID() |
Getter for CLIENTID w/ exceptions if field has no value |
HAS_CLIENTID() |
Determine if CLIENTID has a value |