IotData

import { IotData } from "https://aws-api.deno.dev/v0.3/services/iotdata.ts?docs=full";

class IotData {

constructor(apiFactory: client.ApiFactory);

async deleteThingShadow(params: DeleteThingShadowRequest, opts?: client.RequestOptions): Promise<DeleteThingShadowResponse>;

async getRetainedMessage(params: GetRetainedMessageRequest, opts?: client.RequestOptions): Promise<GetRetainedMessageResponse>;

async getThingShadow(params: GetThingShadowRequest, opts?: client.RequestOptions): Promise<GetThingShadowResponse>;

async listNamedShadowsForThing(params: ListNamedShadowsForThingRequest, opts?: client.RequestOptions): Promise<ListNamedShadowsForThingResponse>;

async listRetainedMessages(params?: ListRetainedMessagesRequest, opts?: client.RequestOptions): Promise<ListRetainedMessagesResponse>;

async publish(params: PublishRequest, opts?: client.RequestOptions): Promise<void>;

async updateThingShadow(params: UpdateThingShadowRequest, opts?: client.RequestOptions): Promise<UpdateThingShadowResponse>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new IotData(apiFactory: client.ApiFactory)

[src]

§Methods

deleteThingShadow(params: DeleteThingShadowRequest, opts?: client.RequestOptions): Promise<DeleteThingShadowResponse>

[src]

Deletes the shadow for the specified thing.

Requires permission to access the DeleteThingShadow action.

For more information, see DeleteThingShadow in the IoT Developer Guide.

getRetainedMessage(params: GetRetainedMessageRequest, opts?: client.RequestOptions): Promise<GetRetainedMessageResponse>

[src]

Gets the details of a single retained message for the specified topic.

This action returns the message payload of the retained message, which can incur messaging costs. To list only the topic names of the retained messages, call ListRetainedMessages.

Requires permission to access the GetRetainedMessage action.

For more information about messaging costs, see IoT Core pricing - Messaging.

getThingShadow(params: GetThingShadowRequest, opts?: client.RequestOptions): Promise<GetThingShadowResponse>

[src]

Gets the shadow for the specified thing.

Requires permission to access the GetThingShadow action.

For more information, see GetThingShadow in the IoT Developer Guide.

listNamedShadowsForThing(params: ListNamedShadowsForThingRequest, opts?: client.RequestOptions): Promise<ListNamedShadowsForThingResponse>

[src]

Lists the shadows for the specified thing.

Requires permission to access the ListNamedShadowsForThing action.

listRetainedMessages(params?: ListRetainedMessagesRequest, opts?: client.RequestOptions): Promise<ListRetainedMessagesResponse>

[src]

Lists summary information about the retained messages stored for the account.

This action returns only the topic names of the retained messages. It doesn't return any message payloads. Although this action doesn't return a message payload, it can still incur messaging costs.

To get the message payload of a retained message, call GetRetainedMessage with the topic name of the retained message.

Requires permission to access the ListRetainedMessages action.

For more information about messaging costs, see IoT Core pricing - Messaging.

publish(params: PublishRequest, opts?: client.RequestOptions): Promise<void>

[src]

Publishes an MQTT message.

Requires permission to access the Publish action.

For more information about MQTT messages, see MQTT Protocol in the IoT Developer Guide.

For more information about messaging costs, see IoT Core pricing - Messaging.

updateThingShadow(params: UpdateThingShadowRequest, opts?: client.RequestOptions): Promise<UpdateThingShadowResponse>

[src]

Updates the shadow for the specified thing.

Requires permission to access the UpdateThingShadow action.

For more information, see UpdateThingShadow in the IoT Developer Guide.

§Static Properties

ApiMetadata: client.ApiMetadata

[src]