@aws-sdk/client-iot-data-plane 3.379.1 → 3.385.0

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

@@ -18,10 +18,12 @@ export declare class ConflictException extends __BaseException {
  */
 export interface DeleteThingShadowRequest {
     /**
+     * @public
      * <p>The name of the thing.</p>
      */
     thingName: string | undefined;
     /**
+     * @public
      * <p>The name of the shadow.</p>
      */
     shadowName?: string;
@@ -32,6 +34,7 @@ export interface DeleteThingShadowRequest {
  */
 export interface DeleteThingShadowResponse {
     /**
+     * @public
      * <p>The state information, in JSON format.</p>
      */
     payload: Uint8Array | undefined;
@@ -138,6 +141,7 @@ export declare class UnsupportedDocumentEncodingException extends __BaseExceptio
  */
 export interface GetRetainedMessageRequest {
     /**
+     * @public
      * <p>The topic name of the retained message to retrieve.</p>
      */
     topic: string | undefined;
@@ -148,22 +152,27 @@ export interface GetRetainedMessageRequest {
  */
 export interface GetRetainedMessageResponse {
     /**
+     * @public
      * <p>The topic name to which the retained message was published.</p>
      */
     topic?: string;
     /**
+     * @public
      * <p>The Base64-encoded message payload of the retained message body.</p>
      */
     payload?: Uint8Array;
     /**
+     * @public
      * <p>The quality of service (QoS) level used to publish the retained message.</p>
      */
     qos?: number;
     /**
+     * @public
      * <p>The Epoch date and time, in milliseconds, when the retained message was stored by IoT.</p>
      */
     lastModifiedTime?: number;
     /**
+     * @public
      * <p>A base64-encoded JSON string that includes an array of JSON objects, or null if the
      *       retained message doesn't include any user properties.</p>
      *          <p>The following example <code>userProperties</code> parameter is a JSON string that
@@ -180,10 +189,12 @@ export interface GetRetainedMessageResponse {
  */
 export interface GetThingShadowRequest {
     /**
+     * @public
      * <p>The name of the thing.</p>
      */
     thingName: string | undefined;
     /**
+     * @public
      * <p>The name of the shadow.</p>
      */
     shadowName?: string;
@@ -194,6 +205,7 @@ export interface GetThingShadowRequest {
  */
 export interface GetThingShadowResponse {
     /**
+     * @public
      * <p>The state information, in JSON format.</p>
      */
     payload?: Uint8Array;
@@ -203,14 +215,17 @@ export interface GetThingShadowResponse {
  */
 export interface ListNamedShadowsForThingRequest {
     /**
+     * @public
      * <p>The name of the thing.</p>
      */
     thingName: string | undefined;
     /**
+     * @public
      * <p>The token to retrieve the next set of results.</p>
      */
     nextToken?: string;
     /**
+     * @public
      * <p>The result page size.</p>
      */
     pageSize?: number;
@@ -220,14 +235,17 @@ export interface ListNamedShadowsForThingRequest {
  */
 export interface ListNamedShadowsForThingResponse {
     /**
+     * @public
      * <p>The list of shadows for the specified thing.</p>
      */
     results?: string[];
     /**
+     * @public
      * <p>The token to use to get the next set of results, or <b>null</b> if there are no additional results.</p>
      */
     nextToken?: string;
     /**
+     * @public
      * <p>The Epoch date and time the response was generated by IoT.</p>
      */
     timestamp?: number;
@@ -237,12 +255,14 @@ export interface ListNamedShadowsForThingResponse {
  */
 export interface ListRetainedMessagesRequest {
     /**
+     * @public
      * <p>To retrieve the next set of results, the <code>nextToken</code>
      *       value from a previous response; otherwise <b>null</b> to receive
      *       the first set of results.</p>
      */
     nextToken?: string;
     /**
+     * @public
      * <p>The maximum number of results to return at one time.</p>
      */
     maxResults?: number;
@@ -253,18 +273,22 @@ export interface ListRetainedMessagesRequest {
  */
 export interface RetainedMessageSummary {
     /**
+     * @public
      * <p>The topic name to which the retained message was published.</p>
      */
     topic?: string;
     /**
+     * @public
      * <p>The size of the retained message's payload in bytes.</p>
      */
     payloadSize?: number;
     /**
+     * @public
      * <p>The quality of service (QoS) level used to publish the retained message.</p>
      */
     qos?: number;
     /**
+     * @public
      * <p>The Epoch date and time, in milliseconds, when the retained message was stored by IoT.</p>
      */
     lastModifiedTime?: number;
@@ -274,11 +298,13 @@ export interface RetainedMessageSummary {
  */
 export interface ListRetainedMessagesResponse {
     /**
+     * @public
      * <p>A summary list the account's retained messages. The information returned doesn't include
      *       the message payloads of the retained messages.</p>
      */
     retainedTopics?: RetainedMessageSummary[];
     /**
+     * @public
      * <p>The token for the next set of results, or null if there are no additional results.</p>
      */
     nextToken?: string;
@@ -301,14 +327,17 @@ export type PayloadFormatIndicator = (typeof PayloadFormatIndicator)[keyof typeo
  */
 export interface PublishRequest {
     /**
+     * @public
      * <p>The name of the MQTT topic.</p>
      */
     topic: string | undefined;
     /**
+     * @public
      * <p>The Quality of Service (QoS) level. The default QoS level is 0.</p>
      */
     qos?: number;
     /**
+     * @public
      * <p>A Boolean value that determines whether to set the RETAIN flag when the message is published.</p>
      *          <p>Setting the RETAIN flag causes the message to be retained and sent to new subscribers to the topic.</p>
      *          <p>Valid values: <code>true</code> | <code>false</code>
@@ -318,12 +347,14 @@ export interface PublishRequest {
      */
     retain?: boolean;
     /**
+     * @public
      * <p>The message body. MQTT accepts text, binary, and empty (null) message payloads.</p>
      *          <p>Publishing an empty (null) payload with <b>retain</b> =
      *         <code>true</code> deletes the retained message identified by <b>topic</b> from Amazon Web Services IoT Core.</p>
      */
     payload?: Uint8Array;
     /**
+     * @public
      * <p>A JSON string that contains an array of JSON objects. If you don’t use Amazon Web Services SDK or CLI,
      *       you must encode the JSON string to base64 format before adding it to the HTTP header.
      *         <code>userProperties</code> is an HTTP header value in the API.</p>
@@ -335,27 +366,32 @@ export interface PublishRequest {
      */
     userProperties?: __LazyJsonString | string;
     /**
+     * @public
      * <p>An <code>Enum</code> string value that indicates whether the payload is formatted as
      *       UTF-8. <code>payloadFormatIndicator</code> is an HTTP header value in the API.</p>
      */
     payloadFormatIndicator?: PayloadFormatIndicator | string;
     /**
+     * @public
      * <p>A UTF-8 encoded string that describes the content of the publishing message.</p>
      */
     contentType?: string;
     /**
+     * @public
      * <p>A UTF-8 encoded string that's used as the topic name for a response message. The response
      *       topic is used to describe the topic which the receiver should publish to as part of the
      *       request-response flow. The topic must not contain wildcard characters.</p>
      */
     responseTopic?: string;
     /**
+     * @public
      * <p>The base64-encoded binary data used by the sender of the request message to identify which
      *       request the response message is for when it's received. <code>correlationData</code> is an
      *       HTTP header value in the API.</p>
      */
     correlationData?: string;
     /**
+     * @public
      * <p>A user-defined integer value that represents the message expiry interval in seconds. If
      *       absent, the message doesn't expire. For more information about the limits of
      *         <code>messageExpiry</code>, see <a href="https://docs.aws.amazon.com/general/latest/gr/iot-core.html#message-broker-limits">Amazon Web Services IoT Core message broker and
@@ -381,14 +417,17 @@ export declare class RequestEntityTooLargeException extends __BaseException {
  */
 export interface UpdateThingShadowRequest {
     /**
+     * @public
      * <p>The name of the thing.</p>
      */
     thingName: string | undefined;
     /**
+     * @public
      * <p>The name of the shadow.</p>
      */
     shadowName?: string;
     /**
+     * @public
      * <p>The state information, in JSON format.</p>
      */
     payload: Uint8Array | undefined;
@@ -399,6 +438,7 @@ export interface UpdateThingShadowRequest {
  */
 export interface UpdateThingShadowResponse {
     /**
+     * @public
      * <p>The state information, in JSON format.</p>
      */
     payload?: Uint8Array;

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.379.1",
+  "version": "3.385.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,15 +21,15 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.379.1",
-    "@aws-sdk/credential-provider-node": "3.379.1",
+    "@aws-sdk/client-sts": "3.385.0",
+    "@aws-sdk/credential-provider-node": "3.385.0",
     "@aws-sdk/middleware-host-header": "3.379.1",
     "@aws-sdk/middleware-logger": "3.378.0",
     "@aws-sdk/middleware-recursion-detection": "3.378.0",
     "@aws-sdk/middleware-signing": "3.379.1",
-    "@aws-sdk/middleware-user-agent": "3.379.1",
+    "@aws-sdk/middleware-user-agent": "3.382.0",
     "@aws-sdk/types": "3.378.0",
-    "@aws-sdk/util-endpoints": "3.378.0",
+    "@aws-sdk/util-endpoints": "3.382.0",
     "@aws-sdk/util-user-agent-browser": "3.378.0",
     "@aws-sdk/util-user-agent-node": "3.378.0",
     "@smithy/config-resolver": "^2.0.1",