GetThingConnectivityData
Retrieves the live connectivity status per device.
Request Syntax
POST /things/thingName/connectivity-data HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- thingName
-
The name of your IoT thing.
Length Constraints: Minimum length of 1. Maximum length of 128.
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
{
"connected": boolean,
"disconnectReason": "string",
"thingName": "string",
"timestamp": number
}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.
- connected
-
A Boolean that indicates the connectivity status.
Type: Boolean
- disconnectReason
-
The reason why the client is disconnecting.
Type: String
Valid Values:
AUTH_ERROR | CLIENT_INITIATED_DISCONNECT | CLIENT_ERROR | CONNECTION_LOST | DUPLICATE_CLIENTID | FORBIDDEN_ACCESS | MQTT_KEEP_ALIVE_TIMEOUT | SERVER_ERROR | SERVER_INITIATED_DISCONNECT | THROTTLED | WEBSOCKET_TTL_EXPIRATION | CUSTOMAUTH_TTL_EXPIRATION | UNKNOWN | NONE - thingName
-
The name of your IoT thing.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9:_-]+ - timestamp
-
The timestamp of when the event occurred.
Type: Timestamp
Errors
- IndexNotReadyException
-
The index is not ready.
HTTP Status Code: 400
- InternalFailureException
-
An unexpected error has occurred.
HTTP Status Code: 500
- InvalidRequestException
-
The request is not valid.
HTTP Status Code: 400
- ResourceNotFoundException
-
The specified resource does not exist.
HTTP Status Code: 404
- ServiceUnavailableException
-
The service is temporarily unavailable.
HTTP Status Code: 503
- ThrottlingException
-
The rate exceeds the limit.
HTTP Status Code: 400
- UnauthorizedException
-
You are not authorized to perform this operation.
HTTP Status Code: 401
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
