@aws-sdk/client-iot-data-plane 3.295.0 → 3.297.0

package/dist-types/IoTDataPlane.d.ts

@@ -8,6 +8,7 @@ import { PublishCommandInput, PublishCommandOutput } from "./commands/PublishCom
 import { UpdateThingShadowCommandInput, UpdateThingShadowCommandOutput } from "./commands/UpdateThingShadowCommand";
 import { IoTDataPlaneClient } from "./IoTDataPlaneClient";
 /**
+ * @public
  * <fullname>IoT data</fullname>
  *          <p>IoT data enables secure, bi-directional communication between Internet-connected things (such as sensors,
  *       actuators, embedded devices, or smart appliances) and the Amazon Web Services cloud. It implements a broker for applications and
@@ -22,6 +23,7 @@ import { IoTDataPlaneClient } from "./IoTDataPlaneClient";
  */
 export declare class IoTDataPlane extends IoTDataPlaneClient {
     /**
+     * @public
      * <p>Deletes the shadow for the specified thing.</p>
      *          <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DeleteThingShadow</a> action.</p>
      *          <p>For more information, see <a href="http://docs.aws.amazon.com/iot/latest/developerguide/API_DeleteThingShadow.html">DeleteThingShadow</a> in the IoT Developer Guide.</p>
@@ -30,6 +32,7 @@ export declare class IoTDataPlane extends IoTDataPlaneClient {
     deleteThingShadow(args: DeleteThingShadowCommandInput, cb: (err: any, data?: DeleteThingShadowCommandOutput) => void): void;
     deleteThingShadow(args: DeleteThingShadowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteThingShadowCommandOutput) => void): void;
     /**
+     * @public
      * <p>Gets the details of a single retained message for the specified topic.</p>
      *          <p>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
@@ -42,6 +45,7 @@ export declare class IoTDataPlane extends IoTDataPlaneClient {
     getRetainedMessage(args: GetRetainedMessageCommandInput, cb: (err: any, data?: GetRetainedMessageCommandOutput) => void): void;
     getRetainedMessage(args: GetRetainedMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRetainedMessageCommandOutput) => void): void;
     /**
+     * @public
      * <p>Gets the shadow for the specified thing.</p>
      *          <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">GetThingShadow</a> action.</p>
      *          <p>For more information, see <a href="http://docs.aws.amazon.com/iot/latest/developerguide/API_GetThingShadow.html">GetThingShadow</a> in the
@@ -51,6 +55,7 @@ export declare class IoTDataPlane extends IoTDataPlaneClient {
     getThingShadow(args: GetThingShadowCommandInput, cb: (err: any, data?: GetThingShadowCommandOutput) => void): void;
     getThingShadow(args: GetThingShadowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetThingShadowCommandOutput) => void): void;
     /**
+     * @public
      * <p>Lists the shadows for the specified thing.</p>
      *          <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListNamedShadowsForThing</a> action.</p>
      */
@@ -58,6 +63,7 @@ export declare class IoTDataPlane extends IoTDataPlaneClient {
     listNamedShadowsForThing(args: ListNamedShadowsForThingCommandInput, cb: (err: any, data?: ListNamedShadowsForThingCommandOutput) => void): void;
     listNamedShadowsForThing(args: ListNamedShadowsForThingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListNamedShadowsForThingCommandOutput) => void): void;
     /**
+     * @public
      * <p>Lists summary information about the retained messages stored for the account.</p>
      *          <p>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,
@@ -73,6 +79,7 @@ export declare class IoTDataPlane extends IoTDataPlaneClient {
     listRetainedMessages(args: ListRetainedMessagesCommandInput, cb: (err: any, data?: ListRetainedMessagesCommandOutput) => void): void;
     listRetainedMessages(args: ListRetainedMessagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRetainedMessagesCommandOutput) => void): void;
     /**
+     * @public
      * <p>Publishes an MQTT message.</p>
      *          <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">Publish</a> action.</p>
      *          <p>For more information about MQTT messages, see
@@ -85,6 +92,7 @@ export declare class IoTDataPlane extends IoTDataPlaneClient {
     publish(args: PublishCommandInput, cb: (err: any, data?: PublishCommandOutput) => void): void;
     publish(args: PublishCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PublishCommandOutput) => void): void;
     /**
+     * @public
      * <p>Updates the shadow for the specified thing.</p>
      *          <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">UpdateThingShadow</a> action.</p>
      *          <p>For more information, see <a href="http://docs.aws.amazon.com/iot/latest/developerguide/API_UpdateThingShadow.html">UpdateThingShadow</a> in the

package/dist-types/IoTDataPlaneClient.d.ts

@@ -15,15 +15,24 @@ import { ListRetainedMessagesCommandInput, ListRetainedMessagesCommandOutput } f
 import { PublishCommandInput, PublishCommandOutput } from "./commands/PublishCommand";
 import { UpdateThingShadowCommandInput, UpdateThingShadowCommandOutput } from "./commands/UpdateThingShadowCommand";
 import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
+/**
+ * @public
+ */
 export type ServiceInputTypes = DeleteThingShadowCommandInput | GetRetainedMessageCommandInput | GetThingShadowCommandInput | ListNamedShadowsForThingCommandInput | ListRetainedMessagesCommandInput | PublishCommandInput | UpdateThingShadowCommandInput;
+/**
+ * @public
+ */
 export type ServiceOutputTypes = DeleteThingShadowCommandOutput | GetRetainedMessageCommandOutput | GetThingShadowCommandOutput | ListNamedShadowsForThingCommandOutput | ListRetainedMessagesCommandOutput | PublishCommandOutput | UpdateThingShadowCommandOutput;
+/**
+ * @public
+ */
 export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
     /**
      * The HTTP handler to use. Fetch in browser and Https in Nodejs.
      */
     requestHandler?: __HttpHandler;
     /**
-     * A constructor for a class implementing the {@link __Checksum} interface
+     * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
      * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
      * @internal
      */
@@ -113,23 +122,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
      */
     logger?: __Logger;
     /**
-     * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
+     * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
      */
     defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
 }
+/**
+ * @public
+ */
 type IoTDataPlaneClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
 /**
- * The configuration interface of IoTDataPlaneClient class constructor that set the region, credentials and other options.
+ * @public
+ *
+ *  The configuration interface of IoTDataPlaneClient class constructor that set the region, credentials and other options.
  */
 export interface IoTDataPlaneClientConfig extends IoTDataPlaneClientConfigType {
 }
+/**
+ * @public
+ */
 type IoTDataPlaneClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
 /**
- * The resolved configuration interface of IoTDataPlaneClient class. This is resolved and normalized from the {@link IoTDataPlaneClientConfig | constructor configuration interface}.
+ * @public
+ *
+ *  The resolved configuration interface of IoTDataPlaneClient class. This is resolved and normalized from the {@link IoTDataPlaneClientConfig | constructor configuration interface}.
  */
 export interface IoTDataPlaneClientResolvedConfig extends IoTDataPlaneClientResolvedConfigType {
 }
 /**
+ * @public
  * <fullname>IoT data</fullname>
  *          <p>IoT data enables secure, bi-directional communication between Internet-connected things (such as sensors,
  *       actuators, embedded devices, or smart appliances) and the Amazon Web Services cloud. It implements a broker for applications and

package/dist-types/commands/DeleteThingShadowCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { IoTDataPlaneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTDataPlaneClient";
 import { DeleteThingShadowRequest, DeleteThingShadowResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link DeleteThingShadowCommand}.
  */
 export interface DeleteThingShadowCommandInput extends DeleteThingShadowRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link DeleteThingShadowCommand}.
  */
 export interface DeleteThingShadowCommandOutput extends DeleteThingShadowResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Deletes the shadow for the specified thing.</p>
  *          <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DeleteThingShadow</a> action.</p>
  *          <p>For more information, see <a href="http://docs.aws.amazon.com/iot/latest/developerguide/API_DeleteThingShadow.html">DeleteThingShadow</a> in the IoT Developer Guide.</p>
@@ -27,6 +32,8 @@ export interface DeleteThingShadowCommandOutput extends DeleteThingShadowRespons
  * const response = await client.send(command);
  * ```
  *
+ * @param DeleteThingShadowCommandInput - {@link DeleteThingShadowCommandInput}
+ * @returns {@link DeleteThingShadowCommandOutput}
  * @see {@link DeleteThingShadowCommandInput} for command's `input` shape.
  * @see {@link DeleteThingShadowCommandOutput} for command's `response` shape.
  * @see {@link IoTDataPlaneClientResolvedConfig | config} for IoTDataPlaneClient's `config` shape.
@@ -60,11 +67,20 @@ export interface DeleteThingShadowCommandOutput extends DeleteThingShadowRespons
 export declare class DeleteThingShadowCommand extends $Command<DeleteThingShadowCommandInput, DeleteThingShadowCommandOutput, IoTDataPlaneClientResolvedConfig> {
     readonly input: DeleteThingShadowCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: DeleteThingShadowCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTDataPlaneClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteThingShadowCommandInput, DeleteThingShadowCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/GetRetainedMessageCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { IoTDataPlaneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTDataPlaneClient";
 import { GetRetainedMessageRequest, GetRetainedMessageResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link GetRetainedMessageCommand}.
  */
 export interface GetRetainedMessageCommandInput extends GetRetainedMessageRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link GetRetainedMessageCommand}.
  */
 export interface GetRetainedMessageCommandOutput extends GetRetainedMessageResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Gets the details of a single retained message for the specified topic.</p>
  *          <p>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
@@ -31,6 +36,8 @@ export interface GetRetainedMessageCommandOutput extends GetRetainedMessageRespo
  * const response = await client.send(command);
  * ```
  *
+ * @param GetRetainedMessageCommandInput - {@link GetRetainedMessageCommandInput}
+ * @returns {@link GetRetainedMessageCommandOutput}
  * @see {@link GetRetainedMessageCommandInput} for command's `input` shape.
  * @see {@link GetRetainedMessageCommandOutput} for command's `response` shape.
  * @see {@link IoTDataPlaneClientResolvedConfig | config} for IoTDataPlaneClient's `config` shape.
@@ -61,11 +68,20 @@ export interface GetRetainedMessageCommandOutput extends GetRetainedMessageRespo
 export declare class GetRetainedMessageCommand extends $Command<GetRetainedMessageCommandInput, GetRetainedMessageCommandOutput, IoTDataPlaneClientResolvedConfig> {
     readonly input: GetRetainedMessageCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: GetRetainedMessageCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTDataPlaneClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetRetainedMessageCommandInput, GetRetainedMessageCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/GetThingShadowCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { IoTDataPlaneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTDataPlaneClient";
 import { GetThingShadowRequest, GetThingShadowResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link GetThingShadowCommand}.
  */
 export interface GetThingShadowCommandInput extends GetThingShadowRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link GetThingShadowCommand}.
  */
 export interface GetThingShadowCommandOutput extends GetThingShadowResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Gets the shadow for the specified thing.</p>
  *          <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">GetThingShadow</a> action.</p>
  *          <p>For more information, see <a href="http://docs.aws.amazon.com/iot/latest/developerguide/API_GetThingShadow.html">GetThingShadow</a> in the
@@ -28,6 +33,8 @@ export interface GetThingShadowCommandOutput extends GetThingShadowResponse, __M
  * const response = await client.send(command);
  * ```
  *
+ * @param GetThingShadowCommandInput - {@link GetThingShadowCommandInput}
+ * @returns {@link GetThingShadowCommandOutput}
  * @see {@link GetThingShadowCommandInput} for command's `input` shape.
  * @see {@link GetThingShadowCommandOutput} for command's `response` shape.
  * @see {@link IoTDataPlaneClientResolvedConfig | config} for IoTDataPlaneClient's `config` shape.
@@ -61,11 +68,20 @@ export interface GetThingShadowCommandOutput extends GetThingShadowResponse, __M
 export declare class GetThingShadowCommand extends $Command<GetThingShadowCommandInput, GetThingShadowCommandOutput, IoTDataPlaneClientResolvedConfig> {
     readonly input: GetThingShadowCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: GetThingShadowCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTDataPlaneClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetThingShadowCommandInput, GetThingShadowCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/ListNamedShadowsForThingCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { IoTDataPlaneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTDataPlaneClient";
 import { ListNamedShadowsForThingRequest, ListNamedShadowsForThingResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link ListNamedShadowsForThingCommand}.
  */
 export interface ListNamedShadowsForThingCommandInput extends ListNamedShadowsForThingRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link ListNamedShadowsForThingCommand}.
  */
 export interface ListNamedShadowsForThingCommandOutput extends ListNamedShadowsForThingResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Lists the shadows for the specified thing.</p>
  *          <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListNamedShadowsForThing</a> action.</p>
  * @example
@@ -26,6 +31,8 @@ export interface ListNamedShadowsForThingCommandOutput extends ListNamedShadowsF
  * const response = await client.send(command);
  * ```
  *
+ * @param ListNamedShadowsForThingCommandInput - {@link ListNamedShadowsForThingCommandInput}
+ * @returns {@link ListNamedShadowsForThingCommandOutput}
  * @see {@link ListNamedShadowsForThingCommandInput} for command's `input` shape.
  * @see {@link ListNamedShadowsForThingCommandOutput} for command's `response` shape.
  * @see {@link IoTDataPlaneClientResolvedConfig | config} for IoTDataPlaneClient's `config` shape.
@@ -56,11 +63,20 @@ export interface ListNamedShadowsForThingCommandOutput extends ListNamedShadowsF
 export declare class ListNamedShadowsForThingCommand extends $Command<ListNamedShadowsForThingCommandInput, ListNamedShadowsForThingCommandOutput, IoTDataPlaneClientResolvedConfig> {
     readonly input: ListNamedShadowsForThingCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ListNamedShadowsForThingCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTDataPlaneClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListNamedShadowsForThingCommandInput, ListNamedShadowsForThingCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/ListRetainedMessagesCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { IoTDataPlaneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTDataPlaneClient";
 import { ListRetainedMessagesRequest, ListRetainedMessagesResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link ListRetainedMessagesCommand}.
  */
 export interface ListRetainedMessagesCommandInput extends ListRetainedMessagesRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link ListRetainedMessagesCommand}.
  */
 export interface ListRetainedMessagesCommandOutput extends ListRetainedMessagesResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Lists summary information about the retained messages stored for the account.</p>
  *          <p>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,
@@ -34,6 +39,8 @@ export interface ListRetainedMessagesCommandOutput extends ListRetainedMessagesR
  * const response = await client.send(command);
  * ```
  *
+ * @param ListRetainedMessagesCommandInput - {@link ListRetainedMessagesCommandInput}
+ * @returns {@link ListRetainedMessagesCommandOutput}
  * @see {@link ListRetainedMessagesCommandInput} for command's `input` shape.
  * @see {@link ListRetainedMessagesCommandOutput} for command's `response` shape.
  * @see {@link IoTDataPlaneClientResolvedConfig | config} for IoTDataPlaneClient's `config` shape.
@@ -61,11 +68,20 @@ export interface ListRetainedMessagesCommandOutput extends ListRetainedMessagesR
 export declare class ListRetainedMessagesCommand extends $Command<ListRetainedMessagesCommandInput, ListRetainedMessagesCommandOutput, IoTDataPlaneClientResolvedConfig> {
     readonly input: ListRetainedMessagesCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ListRetainedMessagesCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTDataPlaneClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListRetainedMessagesCommandInput, ListRetainedMessagesCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/PublishCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { IoTDataPlaneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTDataPlaneClient";
 import { PublishRequest } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link PublishCommand}.
  */
 export interface PublishCommandInput extends PublishRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link PublishCommand}.
  */
 export interface PublishCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Publishes an MQTT message.</p>
  *          <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">Publish</a> action.</p>
  *          <p>For more information about MQTT messages, see
@@ -31,6 +36,8 @@ export interface PublishCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param PublishCommandInput - {@link PublishCommandInput}
+ * @returns {@link PublishCommandOutput}
  * @see {@link PublishCommandInput} for command's `input` shape.
  * @see {@link PublishCommandOutput} for command's `response` shape.
  * @see {@link IoTDataPlaneClientResolvedConfig | config} for IoTDataPlaneClient's `config` shape.
@@ -55,11 +62,20 @@ export interface PublishCommandOutput extends __MetadataBearer {
 export declare class PublishCommand extends $Command<PublishCommandInput, PublishCommandOutput, IoTDataPlaneClientResolvedConfig> {
     readonly input: PublishCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: PublishCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTDataPlaneClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PublishCommandInput, PublishCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/UpdateThingShadowCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { IoTDataPlaneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTDataPlaneClient";
 import { UpdateThingShadowRequest, UpdateThingShadowResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UpdateThingShadowCommand}.
  */
 export interface UpdateThingShadowCommandInput extends UpdateThingShadowRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateThingShadowCommand}.
  */
 export interface UpdateThingShadowCommandOutput extends UpdateThingShadowResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates the shadow for the specified thing.</p>
  *          <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">UpdateThingShadow</a> action.</p>
  *          <p>For more information, see <a href="http://docs.aws.amazon.com/iot/latest/developerguide/API_UpdateThingShadow.html">UpdateThingShadow</a> in the
@@ -28,6 +33,8 @@ export interface UpdateThingShadowCommandOutput extends UpdateThingShadowRespons
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateThingShadowCommandInput - {@link UpdateThingShadowCommandInput}
+ * @returns {@link UpdateThingShadowCommandOutput}
  * @see {@link UpdateThingShadowCommandInput} for command's `input` shape.
  * @see {@link UpdateThingShadowCommandOutput} for command's `response` shape.
  * @see {@link IoTDataPlaneClientResolvedConfig | config} for IoTDataPlaneClient's `config` shape.
@@ -64,11 +71,20 @@ export interface UpdateThingShadowCommandOutput extends UpdateThingShadowRespons
 export declare class UpdateThingShadowCommand extends $Command<UpdateThingShadowCommandInput, UpdateThingShadowCommandOutput, IoTDataPlaneClientResolvedConfig> {
     readonly input: UpdateThingShadowCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateThingShadowCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTDataPlaneClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateThingShadowCommandInput, UpdateThingShadowCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/models/IoTDataPlaneServiceException.d.ts

@@ -1,5 +1,7 @@
 import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
 /**
+ * @public
+ *
  * Base exception class for all service exceptions from IoTDataPlane service.
  */
 export declare class IoTDataPlaneServiceException extends __ServiceException {

package/dist-types/models/models_0.d.ts

@@ -1,6 +1,7 @@
 import { ExceptionOptionType as __ExceptionOptionType, LazyJsonString as __LazyJsonString } from "@aws-sdk/smithy-client";
 import { IoTDataPlaneServiceException as __BaseException } from "./IoTDataPlaneServiceException";
 /**
+ * @public
  * <p>The specified version does not match the version of the document.</p>
  */
 export declare class ConflictException extends __BaseException {
@@ -12,6 +13,7 @@ export declare class ConflictException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
 }
 /**
+ * @public
  * <p>The input for the DeleteThingShadow operation.</p>
  */
 export interface DeleteThingShadowRequest {
@@ -25,6 +27,7 @@ export interface DeleteThingShadowRequest {
     shadowName?: string;
 }
 /**
+ * @public
  * <p>The output from the DeleteThingShadow operation.</p>
  */
 export interface DeleteThingShadowResponse {
@@ -34,6 +37,7 @@ export interface DeleteThingShadowResponse {
     payload: Uint8Array | undefined;
 }
 /**
+ * @public
  * <p>An unexpected error has occurred.</p>
  */
 export declare class InternalFailureException extends __BaseException {
@@ -45,6 +49,7 @@ export declare class InternalFailureException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InternalFailureException, __BaseException>);
 }
 /**
+ * @public
  * <p>The request is not valid.</p>
  */
 export declare class InvalidRequestException extends __BaseException {
@@ -56,6 +61,7 @@ export declare class InvalidRequestException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InvalidRequestException, __BaseException>);
 }
 /**
+ * @public
  * <p>The specified combination of HTTP verb and URI is not supported.</p>
  */
 export declare class MethodNotAllowedException extends __BaseException {
@@ -67,6 +73,7 @@ export declare class MethodNotAllowedException extends __BaseException {
     constructor(opts: __ExceptionOptionType<MethodNotAllowedException, __BaseException>);
 }
 /**
+ * @public
  * <p>The specified resource does not exist.</p>
  */
 export declare class ResourceNotFoundException extends __BaseException {
@@ -78,6 +85,7 @@ export declare class ResourceNotFoundException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
 }
 /**
+ * @public
  * <p>The service is temporarily unavailable.</p>
  */
 export declare class ServiceUnavailableException extends __BaseException {
@@ -89,6 +97,7 @@ export declare class ServiceUnavailableException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>);
 }
 /**
+ * @public
  * <p>The rate exceeds the limit.</p>
  */
 export declare class ThrottlingException extends __BaseException {
@@ -100,6 +109,7 @@ export declare class ThrottlingException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
 }
 /**
+ * @public
  * <p>You are not authorized to perform this operation.</p>
  */
 export declare class UnauthorizedException extends __BaseException {
@@ -111,6 +121,7 @@ export declare class UnauthorizedException extends __BaseException {
     constructor(opts: __ExceptionOptionType<UnauthorizedException, __BaseException>);
 }
 /**
+ * @public
  * <p>The document encoding is not supported.</p>
  */
 export declare class UnsupportedDocumentEncodingException extends __BaseException {
@@ -122,6 +133,7 @@ export declare class UnsupportedDocumentEncodingException extends __BaseExceptio
     constructor(opts: __ExceptionOptionType<UnsupportedDocumentEncodingException, __BaseException>);
 }
 /**
+ * @public
  * <p>The input for the GetRetainedMessage operation.</p>
  */
 export interface GetRetainedMessageRequest {
@@ -131,6 +143,7 @@ export interface GetRetainedMessageRequest {
     topic: string | undefined;
 }
 /**
+ * @public
  * <p>The output from the GetRetainedMessage operation.</p>
  */
 export interface GetRetainedMessageResponse {
@@ -152,6 +165,7 @@ export interface GetRetainedMessageResponse {
     lastModifiedTime?: number;
 }
 /**
+ * @public
  * <p>The input for the GetThingShadow operation.</p>
  */
 export interface GetThingShadowRequest {
@@ -165,6 +179,7 @@ export interface GetThingShadowRequest {
     shadowName?: string;
 }
 /**
+ * @public
  * <p>The output from the GetThingShadow operation.</p>
  */
 export interface GetThingShadowResponse {
@@ -173,6 +188,9 @@ export interface GetThingShadowResponse {
      */
     payload?: Uint8Array;
 }
+/**
+ * @public
+ */
 export interface ListNamedShadowsForThingRequest {
     /**
      * <p>The name of the thing.</p>
@@ -187,6 +205,9 @@ export interface ListNamedShadowsForThingRequest {
      */
     pageSize?: number;
 }
+/**
+ * @public
+ */
 export interface ListNamedShadowsForThingResponse {
     /**
      * <p>The list of shadows for the specified thing.</p>
@@ -201,6 +222,9 @@ export interface ListNamedShadowsForThingResponse {
      */
     timestamp?: number;
 }
+/**
+ * @public
+ */
 export interface ListRetainedMessagesRequest {
     /**
      * <p>To retrieve the next set of results, the <code>nextToken</code>
@@ -214,6 +238,7 @@ export interface ListRetainedMessagesRequest {
     maxResults?: number;
 }
 /**
+ * @public
  * <p>Information about a single retained message.</p>
  */
 export interface RetainedMessageSummary {
@@ -234,6 +259,9 @@ export interface RetainedMessageSummary {
      */
     lastModifiedTime?: number;
 }
+/**
+ * @public
+ */
 export interface ListRetainedMessagesResponse {
     /**
      * <p>A summary list the account's retained messages. The information returned doesn't include
@@ -245,11 +273,15 @@ export interface ListRetainedMessagesResponse {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
 export declare enum PayloadFormatIndicator {
     UNSPECIFIED_BYTES = "UNSPECIFIED_BYTES",
     UTF8_DATA = "UTF8_DATA"
 }
 /**
+ * @public
  * <p>The input for the Publish operation.</p>
  */
 export interface PublishRequest {
@@ -283,7 +315,7 @@ export interface PublishRequest {
      *          <p>The following example <code>userProperties</code> parameter is a JSON string which
      *       represents two User Properties. Note that it needs to be base64-encoded:</p>
      *         <p>
-     *             <code>[{"deviceName": "alpha"}, {"deviceCnt": "45"}]</code>
+     *             <code>[\{"deviceName": "alpha"\}, \{"deviceCnt": "45"\}]</code>
      *          </p>
      */
     userProperties?: __LazyJsonString | string;
@@ -317,6 +349,7 @@ export interface PublishRequest {
     messageExpiry?: number;
 }
 /**
+ * @public
  * <p>The payload exceeds the maximum size allowed.</p>
  */
 export declare class RequestEntityTooLargeException extends __BaseException {
@@ -328,6 +361,7 @@ export declare class RequestEntityTooLargeException extends __BaseException {
     constructor(opts: __ExceptionOptionType<RequestEntityTooLargeException, __BaseException>);
 }
 /**
+ * @public
  * <p>The input for the UpdateThingShadow operation.</p>
  */
 export interface UpdateThingShadowRequest {
@@ -345,6 +379,7 @@ export interface UpdateThingShadowRequest {
     payload: Uint8Array | undefined;
 }
 /**
+ * @public
  * <p>The output from the UpdateThingShadow operation.</p>
  */
 export interface UpdateThingShadowResponse {

package/dist-types/pagination/Interfaces.d.ts

@@ -1,5 +1,8 @@
 import { PaginationConfiguration } from "@aws-sdk/types";
 import { IoTDataPlaneClient } from "../IoTDataPlaneClient";
+/**
+ * @public
+ */
 export interface IoTDataPlanePaginationConfiguration extends PaginationConfiguration {
     client: IoTDataPlaneClient;
 }

package/dist-types/pagination/ListRetainedMessagesPaginator.d.ts

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListRetainedMessagesCommandInput, ListRetainedMessagesCommandOutput } from "../commands/ListRetainedMessagesCommand";
 import { IoTDataPlanePaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListRetainedMessages(config: IoTDataPlanePaginationConfiguration, input: ListRetainedMessagesCommandInput, ...additionalArguments: any): Paginator<ListRetainedMessagesCommandOutput>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-iot-data-plane",
   "description": "AWS SDK for JavaScript Iot Data Plane Client for Node.js, Browser and React Native",
-  "version": "3.295.0",
+  "version": "3.297.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,37 +20,37 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.295.0",
-    "@aws-sdk/config-resolver": "3.295.0",
-    "@aws-sdk/credential-provider-node": "3.295.0",
-    "@aws-sdk/fetch-http-handler": "3.295.0",
-    "@aws-sdk/hash-node": "3.295.0",
-    "@aws-sdk/invalid-dependency": "3.295.0",
-    "@aws-sdk/middleware-content-length": "3.295.0",
-    "@aws-sdk/middleware-endpoint": "3.295.0",
-    "@aws-sdk/middleware-host-header": "3.295.0",
-    "@aws-sdk/middleware-logger": "3.295.0",
-    "@aws-sdk/middleware-recursion-detection": "3.295.0",
-    "@aws-sdk/middleware-retry": "3.295.0",
-    "@aws-sdk/middleware-serde": "3.295.0",
-    "@aws-sdk/middleware-signing": "3.295.0",
-    "@aws-sdk/middleware-stack": "3.295.0",
-    "@aws-sdk/middleware-user-agent": "3.295.0",
-    "@aws-sdk/node-config-provider": "3.295.0",
-    "@aws-sdk/node-http-handler": "3.295.0",
-    "@aws-sdk/protocol-http": "3.295.0",
-    "@aws-sdk/smithy-client": "3.295.0",
-    "@aws-sdk/types": "3.295.0",
-    "@aws-sdk/url-parser": "3.295.0",
+    "@aws-sdk/client-sts": "3.297.0",
+    "@aws-sdk/config-resolver": "3.296.0",
+    "@aws-sdk/credential-provider-node": "3.297.0",
+    "@aws-sdk/fetch-http-handler": "3.296.0",
+    "@aws-sdk/hash-node": "3.296.0",
+    "@aws-sdk/invalid-dependency": "3.296.0",
+    "@aws-sdk/middleware-content-length": "3.296.0",
+    "@aws-sdk/middleware-endpoint": "3.296.0",
+    "@aws-sdk/middleware-host-header": "3.296.0",
+    "@aws-sdk/middleware-logger": "3.296.0",
+    "@aws-sdk/middleware-recursion-detection": "3.296.0",
+    "@aws-sdk/middleware-retry": "3.296.0",
+    "@aws-sdk/middleware-serde": "3.296.0",
+    "@aws-sdk/middleware-signing": "3.296.0",
+    "@aws-sdk/middleware-stack": "3.296.0",
+    "@aws-sdk/middleware-user-agent": "3.296.0",
+    "@aws-sdk/node-config-provider": "3.296.0",
+    "@aws-sdk/node-http-handler": "3.296.0",
+    "@aws-sdk/protocol-http": "3.296.0",
+    "@aws-sdk/smithy-client": "3.296.0",
+    "@aws-sdk/types": "3.296.0",
+    "@aws-sdk/url-parser": "3.296.0",
     "@aws-sdk/util-base64": "3.295.0",
     "@aws-sdk/util-body-length-browser": "3.295.0",
     "@aws-sdk/util-body-length-node": "3.295.0",
-    "@aws-sdk/util-defaults-mode-browser": "3.295.0",
-    "@aws-sdk/util-defaults-mode-node": "3.295.0",
-    "@aws-sdk/util-endpoints": "3.295.0",
-    "@aws-sdk/util-retry": "3.295.0",
-    "@aws-sdk/util-user-agent-browser": "3.295.0",
-    "@aws-sdk/util-user-agent-node": "3.295.0",
+    "@aws-sdk/util-defaults-mode-browser": "3.296.0",
+    "@aws-sdk/util-defaults-mode-node": "3.296.0",
+    "@aws-sdk/util-endpoints": "3.296.0",
+    "@aws-sdk/util-retry": "3.296.0",
+    "@aws-sdk/util-user-agent-browser": "3.296.0",
+    "@aws-sdk/util-user-agent-node": "3.296.0",
     "@aws-sdk/util-utf8": "3.295.0",
     "tslib": "^2.5.0"
   },