Class IotShadowClientv2

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

Hierarchy

IotShadowClientv2

Index

Methods - IotShadow

createNamedShadowDeltaUpdatedStream createNamedShadowUpdatedStream createShadowDeltaUpdatedStream createShadowUpdatedStream deleteNamedShadow deleteShadow getNamedShadow getShadow updateNamedShadow updateShadow

Methods - Other

close newFromMqtt311 newFromMqtt5

Methods - IotShadow

createNamedShadowDeltaUpdatedStream

createNamedShadowDeltaUpdatedStream(config): StreamingOperation<ShadowDeltaUpdatedEvent>
Create a stream for NamedShadowDelta events for a named shadow of an AWS IoT thing.

AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-delta-pub-sub-topic
Parameters
- config: NamedShadowDeltaUpdatedSubscriptionRequest
  
  streaming operation configuration options
Returns StreamingOperation<ShadowDeltaUpdatedEvent>
a streaming operation which will emit an event every time a message is received on the associated MQTT topic

createNamedShadowUpdatedStream

createNamedShadowUpdatedStream(config): StreamingOperation<ShadowUpdatedEvent>
Create a stream for ShadowUpdated events for a named shadow of an AWS IoT thing.

AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-documents-pub-sub-topic
Parameters
- config: NamedShadowUpdatedSubscriptionRequest
  
  streaming operation configuration options
Returns StreamingOperation<ShadowUpdatedEvent>
a streaming operation which will emit an event every time a message is received on the associated MQTT topic

createShadowDeltaUpdatedStream

createShadowDeltaUpdatedStream(config): StreamingOperation<ShadowDeltaUpdatedEvent>
Create a stream for ShadowDelta events for the (classic) shadow of an AWS IoT thing.

AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-delta-pub-sub-topic
Parameters
- config: ShadowDeltaUpdatedSubscriptionRequest
  
  streaming operation configuration options
Returns StreamingOperation<ShadowDeltaUpdatedEvent>
a streaming operation which will emit an event every time a message is received on the associated MQTT topic

createShadowUpdatedStream

createShadowUpdatedStream(config): StreamingOperation<ShadowUpdatedEvent>
Create a stream for ShadowUpdated events for the (classic) shadow of an AWS IoT thing.

AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-documents-pub-sub-topic
Parameters
- config: ShadowUpdatedSubscriptionRequest
  
  streaming operation configuration options
Returns StreamingOperation<ShadowUpdatedEvent>
a streaming operation which will emit an event every time a message is received on the associated MQTT topic

deleteNamedShadow

deleteNamedShadow(request): Promise<DeleteShadowResponse>
Deletes a named shadow for an AWS IoT thing.

AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#delete-pub-sub-topic
Parameters
- request: DeleteNamedShadowRequest
  
  operation to perform
Returns Promise<DeleteShadowResponse>
Promise which resolves into the response to the request

deleteShadow

deleteShadow(request): Promise<DeleteShadowResponse>
Deletes the (classic) shadow for an AWS IoT thing.

AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#delete-pub-sub-topic
Parameters
- request: DeleteShadowRequest
  
  operation to perform
Returns Promise<DeleteShadowResponse>
Promise which resolves into the response to the request

getNamedShadow

getNamedShadow(request): Promise<GetShadowResponse>
Gets a named shadow for an AWS IoT thing.

AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#get-pub-sub-topic
Parameters
- request: GetNamedShadowRequest
  
  operation to perform
Returns Promise<GetShadowResponse>
Promise which resolves into the response to the request

getShadow

getShadow(request): Promise<GetShadowResponse>
Gets the (classic) shadow for an AWS IoT thing.

AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#get-pub-sub-topic
Parameters
- request: GetShadowRequest
  
  operation to perform
Returns Promise<GetShadowResponse>
Promise which resolves into the response to the request

updateNamedShadow

updateNamedShadow(request): Promise<UpdateShadowResponse>
Update a named shadow for a device.

AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-pub-sub-topic
Parameters
- request: UpdateNamedShadowRequest
  
  operation to perform
Returns Promise<UpdateShadowResponse>
Promise which resolves into the response to the request

updateShadow

updateShadow(request): Promise<UpdateShadowResponse>
Update a device's (classic) shadow.

AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-pub-sub-topic
Parameters
- request: UpdateShadowRequest
  
  operation to perform
Returns Promise<UpdateShadowResponse>
Promise which resolves into the response to the request

Methods - Other

close

close(): void
Triggers cleanup of all resources associated with the service client. Closing a client will fail all incomplete requests and close all unclosed streaming operations.

This must be called when finished with a client; otherwise, native resources will leak.

Returns void

`Static` newFromMqtt311

newFromMqtt311(protocolClient, options): IotShadowClientv2
Creates a new service client that will use an SDK MQTT 311 client as transport.
Parameters
- protocolClient: MqttClientConnection
  
  the MQTT 311 client to use for transport
- options: RequestResponseClientOptions
  
  additional service client configuration options
Returns IotShadowClientv2
a new service client

`Static` newFromMqtt5

newFromMqtt5(protocolClient, options): IotShadowClientv2
Creates a new service client that will use an SDK MQTT 5 client as transport.
Parameters
- protocolClient: Mqtt5Client
  
  the MQTT 5 client to use for transport
- options: RequestResponseClientOptions
  
  additional service client configuration options
Returns IotShadowClientv2
a new service client

Class IotShadowClientv2

Hierarchy

Index

Methods - IotShadow

Methods - Other

Methods - IotShadow

createNamedShadowDeltaUpdatedStream

Parameters

config: NamedShadowDeltaUpdatedSubscriptionRequest

Returns StreamingOperation<ShadowDeltaUpdatedEvent>

createNamedShadowUpdatedStream

Parameters

config: NamedShadowUpdatedSubscriptionRequest

Returns StreamingOperation<ShadowUpdatedEvent>

createShadowDeltaUpdatedStream

Parameters

config: ShadowDeltaUpdatedSubscriptionRequest

Returns StreamingOperation<ShadowDeltaUpdatedEvent>

createShadowUpdatedStream

Parameters

config: ShadowUpdatedSubscriptionRequest

Returns StreamingOperation<ShadowUpdatedEvent>

deleteNamedShadow

Parameters

request: DeleteNamedShadowRequest

Returns Promise<DeleteShadowResponse>

deleteShadow

Parameters

request: DeleteShadowRequest

Returns Promise<DeleteShadowResponse>

getNamedShadow

Parameters

request: GetNamedShadowRequest

Returns Promise<GetShadowResponse>

getShadow

Parameters

request: GetShadowRequest

Returns Promise<GetShadowResponse>

updateNamedShadow

Parameters

request: UpdateNamedShadowRequest

Returns Promise<UpdateShadowResponse>

updateShadow

Parameters

request: UpdateShadowRequest

Returns Promise<UpdateShadowResponse>

Methods - Other

close

Returns void

Static newFromMqtt311

Parameters

protocolClient: MqttClientConnection

options: RequestResponseClientOptions

Returns IotShadowClientv2

Static newFromMqtt5

Parameters

protocolClient: Mqtt5Client

options: RequestResponseClientOptions

Returns IotShadowClientv2

Settings

Member Visibility

Theme

On This Page

`Static` newFromMqtt311

`Static` newFromMqtt5