Optional connection: MqttClientConnectionDeletes a named shadow for an AWS IoT thing.
If the device is offline, the PUBLISH packet will be sent once the connection resumes.
AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#delete-pub-sub-topic
Message to be serialized and sent
Quality of Service for delivering this message
Promise which returns a mqtt.MqttRequest which will contain the packet id of
the PUBLISH packet.
Deletes the (classic) shadow for an AWS IoT thing.
If the device is offline, the PUBLISH packet will be sent once the connection resumes.
AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#delete-pub-sub-topic
Message to be serialized and sent
Quality of Service for delivering this message
Promise which returns a mqtt.MqttRequest which will contain the packet id of
the PUBLISH packet.
Gets a named shadow for an AWS IoT thing.
If the device is offline, the PUBLISH packet will be sent once the connection resumes.
AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#get-pub-sub-topic
Message to be serialized and sent
Quality of Service for delivering this message
Promise which returns a mqtt.MqttRequest which will contain the packet id of
the PUBLISH packet.
Gets the (classic) shadow for an AWS IoT thing.
If the device is offline, the PUBLISH packet will be sent once the connection resumes.
AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#get-pub-sub-topic
Message to be serialized and sent
Quality of Service for delivering this message
Promise which returns a mqtt.MqttRequest which will contain the packet id of
the PUBLISH packet.
Update a named shadow for a device.
If the device is offline, the PUBLISH packet will be sent once the connection resumes.
AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-pub-sub-topic
Message to be serialized and sent
Quality of Service for delivering this message
Promise which returns a mqtt.MqttRequest which will contain the packet id of
the PUBLISH packet.
Update a device's (classic) shadow.
If the device is offline, the PUBLISH packet will be sent once the connection resumes.
AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-pub-sub-topic
Message to be serialized and sent
Quality of Service for delivering this message
Promise which returns a mqtt.MqttRequest which will contain the packet id of
the PUBLISH packet.
Subscribes to the accepted topic for the DeleteNamedShadow operation.
subscribeToDeleteNamedShadowAccepted may be called while the device is offline, though the async operation cannot complete successfully until the connection resumes.
Once subscribed, messageHandler is invoked each time a message matching
the topic is received. It is possible for such messages to arrive before
the SUBACK is received.
AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#delete-accepted-pub-sub-topic
Subscription request configuration
Maximum requested QoS that server may use when sending messages to the client. The server may grant a lower QoS in the SUBACK
Callback invoked when message or error is received from the server.
Optional error: IotShadowErrorOptional response: DeleteShadowResponsePromise which returns a mqtt.MqttSubscribeRequest which will contain the
result of the SUBSCRIBE. The Promise resolves when a SUBACK is returned
from the server or is rejected when an exception occurs.
Subscribes to the rejected topic for the DeleteNamedShadow operation.
subscribeToDeleteNamedShadowRejected may be called while the device is offline, though the async operation cannot complete successfully until the connection resumes.
Once subscribed, messageHandler is invoked each time a message matching
the topic is received. It is possible for such messages to arrive before
the SUBACK is received.
AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#delete-rejected-pub-sub-topic
Subscription request configuration
Maximum requested QoS that server may use when sending messages to the client. The server may grant a lower QoS in the SUBACK
Callback invoked when message or error is received from the server.
Optional error: IotShadowErrorOptional response: model.ErrorResponsePromise which returns a mqtt.MqttSubscribeRequest which will contain the
result of the SUBSCRIBE. The Promise resolves when a SUBACK is returned
from the server or is rejected when an exception occurs.
Subscribes to the accepted topic for the DeleteShadow operation
subscribeToDeleteShadowAccepted may be called while the device is offline, though the async operation cannot complete successfully until the connection resumes.
Once subscribed, messageHandler is invoked each time a message matching
the topic is received. It is possible for such messages to arrive before
the SUBACK is received.
AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#delete-accepted-pub-sub-topic
Subscription request configuration
Maximum requested QoS that server may use when sending messages to the client. The server may grant a lower QoS in the SUBACK
Callback invoked when message or error is received from the server.
Optional error: IotShadowErrorOptional response: DeleteShadowResponsePromise which returns a mqtt.MqttSubscribeRequest which will contain the
result of the SUBSCRIBE. The Promise resolves when a SUBACK is returned
from the server or is rejected when an exception occurs.
Subscribes to the rejected topic for the DeleteShadow operation
subscribeToDeleteShadowRejected may be called while the device is offline, though the async operation cannot complete successfully until the connection resumes.
Once subscribed, messageHandler is invoked each time a message matching
the topic is received. It is possible for such messages to arrive before
the SUBACK is received.
AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#delete-rejected-pub-sub-topic
Subscription request configuration
Maximum requested QoS that server may use when sending messages to the client. The server may grant a lower QoS in the SUBACK
Callback invoked when message or error is received from the server.
Optional error: IotShadowErrorOptional response: model.ErrorResponsePromise which returns a mqtt.MqttSubscribeRequest which will contain the
result of the SUBSCRIBE. The Promise resolves when a SUBACK is returned
from the server or is rejected when an exception occurs.
Subscribes to the accepted topic for the GetNamedShadow operation.
subscribeToGetNamedShadowAccepted may be called while the device is offline, though the async operation cannot complete successfully until the connection resumes.
Once subscribed, messageHandler is invoked each time a message matching
the topic is received. It is possible for such messages to arrive before
the SUBACK is received.
AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#get-accepted-pub-sub-topic
Subscription request configuration
Maximum requested QoS that server may use when sending messages to the client. The server may grant a lower QoS in the SUBACK
Callback invoked when message or error is received from the server.
Optional error: IotShadowErrorOptional response: GetShadowResponsePromise which returns a mqtt.MqttSubscribeRequest which will contain the
result of the SUBSCRIBE. The Promise resolves when a SUBACK is returned
from the server or is rejected when an exception occurs.
Subscribes to the rejected topic for the GetNamedShadow operation.
subscribeToGetNamedShadowRejected may be called while the device is offline, though the async operation cannot complete successfully until the connection resumes.
Once subscribed, messageHandler is invoked each time a message matching
the topic is received. It is possible for such messages to arrive before
the SUBACK is received.
AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#get-rejected-pub-sub-topic
Subscription request configuration
Maximum requested QoS that server may use when sending messages to the client. The server may grant a lower QoS in the SUBACK
Callback invoked when message or error is received from the server.
Optional error: IotShadowErrorOptional response: model.ErrorResponsePromise which returns a mqtt.MqttSubscribeRequest which will contain the
result of the SUBSCRIBE. The Promise resolves when a SUBACK is returned
from the server or is rejected when an exception occurs.
Subscribes to the accepted topic for the GetShadow operation.
subscribeToGetShadowAccepted may be called while the device is offline, though the async operation cannot complete successfully until the connection resumes.
Once subscribed, messageHandler is invoked each time a message matching
the topic is received. It is possible for such messages to arrive before
the SUBACK is received.
AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#get-accepted-pub-sub-topic
Subscription request configuration
Maximum requested QoS that server may use when sending messages to the client. The server may grant a lower QoS in the SUBACK
Callback invoked when message or error is received from the server.
Optional error: IotShadowErrorOptional response: GetShadowResponsePromise which returns a mqtt.MqttSubscribeRequest which will contain the
result of the SUBSCRIBE. The Promise resolves when a SUBACK is returned
from the server or is rejected when an exception occurs.
Subscribes to the rejected topic for the GetShadow operation.
subscribeToGetShadowRejected may be called while the device is offline, though the async operation cannot complete successfully until the connection resumes.
Once subscribed, messageHandler is invoked each time a message matching
the topic is received. It is possible for such messages to arrive before
the SUBACK is received.
AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#get-rejected-pub-sub-topic
Subscription request configuration
Maximum requested QoS that server may use when sending messages to the client. The server may grant a lower QoS in the SUBACK
Callback invoked when message or error is received from the server.
Optional error: IotShadowErrorOptional response: model.ErrorResponsePromise which returns a mqtt.MqttSubscribeRequest which will contain the
result of the SUBSCRIBE. The Promise resolves when a SUBACK is returned
from the server or is rejected when an exception occurs.
Subscribe to NamedShadowDelta events for a named shadow of an AWS IoT thing.
subscribeToNamedShadowDeltaUpdatedEvents may be called while the device is offline, though the async operation cannot complete successfully until the connection resumes.
Once subscribed, messageHandler is invoked each time a message matching
the topic is received. It is possible for such messages to arrive before
the SUBACK is received.
AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-delta-pub-sub-topic
Subscription request configuration
Maximum requested QoS that server may use when sending messages to the client. The server may grant a lower QoS in the SUBACK
Callback invoked when message or error is received from the server.
Optional error: IotShadowErrorOptional response: ShadowDeltaUpdatedEventPromise which returns a mqtt.MqttSubscribeRequest which will contain the
result of the SUBSCRIBE. The Promise resolves when a SUBACK is returned
from the server or is rejected when an exception occurs.
Subscribe to ShadowUpdated events for a named shadow of an AWS IoT thing.
subscribeToNamedShadowUpdatedEvents may be called while the device is offline, though the async operation cannot complete successfully until the connection resumes.
Once subscribed, messageHandler is invoked each time a message matching
the topic is received. It is possible for such messages to arrive before
the SUBACK is received.
AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-documents-pub-sub-topic
Subscription request configuration
Maximum requested QoS that server may use when sending messages to the client. The server may grant a lower QoS in the SUBACK
Callback invoked when message or error is received from the server.
Optional error: IotShadowErrorOptional response: ShadowUpdatedEventPromise which returns a mqtt.MqttSubscribeRequest which will contain the
result of the SUBSCRIBE. The Promise resolves when a SUBACK is returned
from the server or is rejected when an exception occurs.
Subscribe to ShadowDelta events for the (classic) shadow of an AWS IoT thing.
subscribeToShadowDeltaUpdatedEvents may be called while the device is offline, though the async operation cannot complete successfully until the connection resumes.
Once subscribed, messageHandler is invoked each time a message matching
the topic is received. It is possible for such messages to arrive before
the SUBACK is received.
AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-delta-pub-sub-topic
Subscription request configuration
Maximum requested QoS that server may use when sending messages to the client. The server may grant a lower QoS in the SUBACK
Callback invoked when message or error is received from the server.
Optional error: IotShadowErrorOptional response: ShadowDeltaUpdatedEventPromise which returns a mqtt.MqttSubscribeRequest which will contain the
result of the SUBSCRIBE. The Promise resolves when a SUBACK is returned
from the server or is rejected when an exception occurs.
Subscribe to ShadowUpdated events for the (classic) shadow of an AWS IoT thing.
subscribeToShadowUpdatedEvents may be called while the device is offline, though the async operation cannot complete successfully until the connection resumes.
Once subscribed, messageHandler is invoked each time a message matching
the topic is received. It is possible for such messages to arrive before
the SUBACK is received.
AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-documents-pub-sub-topic
Subscription request configuration
Maximum requested QoS that server may use when sending messages to the client. The server may grant a lower QoS in the SUBACK
Callback invoked when message or error is received from the server.
Optional error: IotShadowErrorOptional response: ShadowUpdatedEventPromise which returns a mqtt.MqttSubscribeRequest which will contain the
result of the SUBSCRIBE. The Promise resolves when a SUBACK is returned
from the server or is rejected when an exception occurs.
Subscribes to the accepted topic for the UpdateNamedShadow operation
subscribeToUpdateNamedShadowAccepted may be called while the device is offline, though the async operation cannot complete successfully until the connection resumes.
Once subscribed, messageHandler is invoked each time a message matching
the topic is received. It is possible for such messages to arrive before
the SUBACK is received.
AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-accepted-pub-sub-topic
Subscription request configuration
Maximum requested QoS that server may use when sending messages to the client. The server may grant a lower QoS in the SUBACK
Callback invoked when message or error is received from the server.
Optional error: IotShadowErrorOptional response: UpdateShadowResponsePromise which returns a mqtt.MqttSubscribeRequest which will contain the
result of the SUBSCRIBE. The Promise resolves when a SUBACK is returned
from the server or is rejected when an exception occurs.
Subscribes to the rejected topic for the UpdateNamedShadow operation
subscribeToUpdateNamedShadowRejected may be called while the device is offline, though the async operation cannot complete successfully until the connection resumes.
Once subscribed, messageHandler is invoked each time a message matching
the topic is received. It is possible for such messages to arrive before
the SUBACK is received.
AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-rejected-pub-sub-topic
Subscription request configuration
Maximum requested QoS that server may use when sending messages to the client. The server may grant a lower QoS in the SUBACK
Callback invoked when message or error is received from the server.
Optional error: IotShadowErrorOptional response: model.ErrorResponsePromise which returns a mqtt.MqttSubscribeRequest which will contain the
result of the SUBSCRIBE. The Promise resolves when a SUBACK is returned
from the server or is rejected when an exception occurs.
Subscribes to the accepted topic for the UpdateShadow operation
subscribeToUpdateShadowAccepted may be called while the device is offline, though the async operation cannot complete successfully until the connection resumes.
Once subscribed, messageHandler is invoked each time a message matching
the topic is received. It is possible for such messages to arrive before
the SUBACK is received.
AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-accepted-pub-sub-topic
Subscription request configuration
Maximum requested QoS that server may use when sending messages to the client. The server may grant a lower QoS in the SUBACK
Callback invoked when message or error is received from the server.
Optional error: IotShadowErrorOptional response: UpdateShadowResponsePromise which returns a mqtt.MqttSubscribeRequest which will contain the
result of the SUBSCRIBE. The Promise resolves when a SUBACK is returned
from the server or is rejected when an exception occurs.
Subscribes to the rejected topic for the UpdateShadow operation
subscribeToUpdateShadowRejected may be called while the device is offline, though the async operation cannot complete successfully until the connection resumes.
Once subscribed, messageHandler is invoked each time a message matching
the topic is received. It is possible for such messages to arrive before
the SUBACK is received.
AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-rejected-pub-sub-topic
Subscription request configuration
Maximum requested QoS that server may use when sending messages to the client. The server may grant a lower QoS in the SUBACK
Callback invoked when message or error is received from the server.
Optional error: IotShadowErrorOptional response: model.ErrorResponsePromise which returns a mqtt.MqttSubscribeRequest which will contain the
result of the SUBSCRIBE. The Promise resolves when a SUBACK is returned
from the server or is rejected when an exception occurs.
Static newCreates a new IotShadowClient that uses the SDK Mqtt5 client internally.
The pre-existing constructor that is bound to the MQTT311 client makes this awkward since we must support
new IotShadowClient(mqtt311connection);
for backwards compatibility, but still want to be able to inject an MQTT5 client as well.
the MQTT5 client to use with this service client
a new IotShadowClient instance
Generated using TypeDoc
The AWS IoT Device Shadow service adds shadows to AWS IoT thing objects. Shadows are a simple data store for device properties and state. Shadows can make a device’s state available to apps and other services whether the device is connected to AWS IoT or not.
AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html