@aws-sdk/client-iot-data-plane 3.216.0 → 3.218.0

package/dist-cjs/models/models_0.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UpdateThingShadowResponseFilterSensitiveLog = exports.UpdateThingShadowRequestFilterSensitiveLog = exports.PublishRequestFilterSensitiveLog = exports.ListRetainedMessagesResponseFilterSensitiveLog = exports.RetainedMessageSummaryFilterSensitiveLog = exports.ListRetainedMessagesRequestFilterSensitiveLog = exports.ListNamedShadowsForThingResponseFilterSensitiveLog = exports.ListNamedShadowsForThingRequestFilterSensitiveLog = exports.GetThingShadowResponseFilterSensitiveLog = exports.GetThingShadowRequestFilterSensitiveLog = exports.GetRetainedMessageResponseFilterSensitiveLog = exports.GetRetainedMessageRequestFilterSensitiveLog = exports.DeleteThingShadowResponseFilterSensitiveLog = exports.DeleteThingShadowRequestFilterSensitiveLog = exports.RequestEntityTooLargeException = exports.UnsupportedDocumentEncodingException = exports.UnauthorizedException = exports.ThrottlingException = exports.ServiceUnavailableException = exports.ResourceNotFoundException = exports.MethodNotAllowedException = exports.InvalidRequestException = exports.InternalFailureException = exports.ConflictException = void 0;
+exports.UpdateThingShadowResponseFilterSensitiveLog = exports.UpdateThingShadowRequestFilterSensitiveLog = exports.PublishRequestFilterSensitiveLog = exports.ListRetainedMessagesResponseFilterSensitiveLog = exports.RetainedMessageSummaryFilterSensitiveLog = exports.ListRetainedMessagesRequestFilterSensitiveLog = exports.ListNamedShadowsForThingResponseFilterSensitiveLog = exports.ListNamedShadowsForThingRequestFilterSensitiveLog = exports.GetThingShadowResponseFilterSensitiveLog = exports.GetThingShadowRequestFilterSensitiveLog = exports.GetRetainedMessageResponseFilterSensitiveLog = exports.GetRetainedMessageRequestFilterSensitiveLog = exports.DeleteThingShadowResponseFilterSensitiveLog = exports.DeleteThingShadowRequestFilterSensitiveLog = exports.RequestEntityTooLargeException = exports.PayloadFormatIndicator = exports.UnsupportedDocumentEncodingException = exports.UnauthorizedException = exports.ThrottlingException = exports.ServiceUnavailableException = exports.ResourceNotFoundException = exports.MethodNotAllowedException = exports.InvalidRequestException = exports.InternalFailureException = exports.ConflictException = void 0;
 const IoTDataPlaneServiceException_1 = require("./IoTDataPlaneServiceException");
 class ConflictException extends IoTDataPlaneServiceException_1.IoTDataPlaneServiceException {
     constructor(opts) {
@@ -119,6 +119,11 @@ class UnsupportedDocumentEncodingException extends IoTDataPlaneServiceException_
     }
 }
 exports.UnsupportedDocumentEncodingException = UnsupportedDocumentEncodingException;
+var PayloadFormatIndicator;
+(function (PayloadFormatIndicator) {
+    PayloadFormatIndicator["UNSPECIFIED_BYTES"] = "UNSPECIFIED_BYTES";
+    PayloadFormatIndicator["UTF8_DATA"] = "UTF8_DATA";
+})(PayloadFormatIndicator = exports.PayloadFormatIndicator || (exports.PayloadFormatIndicator = {}));
 class RequestEntityTooLargeException extends IoTDataPlaneServiceException_1.IoTDataPlaneServiceException {
     constructor(opts) {
         super({

package/dist-cjs/protocols/Aws_restJson1.js

@@ -110,14 +110,23 @@ const serializeAws_restJson1ListRetainedMessagesCommand = async (input, context)
 exports.serializeAws_restJson1ListRetainedMessagesCommand = serializeAws_restJson1ListRetainedMessagesCommand;
 const serializeAws_restJson1PublishCommand = async (input, context) => {
     const { hostname, protocol = "https", port, path: basePath } = await context.endpoint();
-    const headers = {
+    const headers = map({}, isSerializableHeaderValue, {
         "content-type": "application/octet-stream",
-    };
+        "x-amz-mqtt5-user-properties": [
+            () => isSerializableHeaderValue(input.userProperties),
+            () => context.base64Encoder(Buffer.from(smithy_client_1.LazyJsonString.fromObject(input.userProperties))),
+        ],
+        "x-amz-mqtt5-payload-format-indicator": input.payloadFormatIndicator,
+        "x-amz-mqtt5-correlation-data": input.correlationData,
+    });
     let resolvedPath = `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + "/topics/{topic}";
     resolvedPath = (0, smithy_client_1.resolvedPath)(resolvedPath, input, "topic", () => input.topic, "{topic}", false);
     const query = map({
         qos: [() => input.qos !== void 0, () => input.qos.toString()],
         retain: [() => input.retain !== void 0, () => input.retain.toString()],
+        contentType: [, input.contentType],
+        responseTopic: [, input.responseTopic],
+        messageExpiry: [() => input.messageExpiry !== void 0, () => input.messageExpiry.toString()],
     });
     let body;
     if (input.payload !== undefined) {
@@ -465,6 +474,9 @@ const deserializeAws_restJson1PublishCommandError = async (output, context) => {
         case "MethodNotAllowedException":
         case "com.amazonaws.iotdataplane#MethodNotAllowedException":
             throw await deserializeAws_restJson1MethodNotAllowedExceptionResponse(parsedOutput, context);
+        case "ThrottlingException":
+        case "com.amazonaws.iotdataplane#ThrottlingException":
+            throw await deserializeAws_restJson1ThrottlingExceptionResponse(parsedOutput, context);
         case "UnauthorizedException":
         case "com.amazonaws.iotdataplane#UnauthorizedException":
             throw await deserializeAws_restJson1UnauthorizedExceptionResponse(parsedOutput, context);

package/dist-es/models/models_0.js

@@ -107,6 +107,11 @@ export class UnsupportedDocumentEncodingException extends __BaseException {
         Object.setPrototypeOf(this, UnsupportedDocumentEncodingException.prototype);
     }
 }
+export var PayloadFormatIndicator;
+(function (PayloadFormatIndicator) {
+    PayloadFormatIndicator["UNSPECIFIED_BYTES"] = "UNSPECIFIED_BYTES";
+    PayloadFormatIndicator["UTF8_DATA"] = "UTF8_DATA";
+})(PayloadFormatIndicator || (PayloadFormatIndicator = {}));
 export class RequestEntityTooLargeException extends __BaseException {
     constructor(opts) {
         super({

package/dist-es/protocols/Aws_restJson1.js

@@ -1,5 +1,5 @@
 import { HttpRequest as __HttpRequest } from "@aws-sdk/protocol-http";
-import { decorateServiceException as __decorateServiceException, expectInt32 as __expectInt32, expectLong as __expectLong, expectNonNull as __expectNonNull, expectObject as __expectObject, expectString as __expectString, map as __map, resolvedPath as __resolvedPath, throwDefaultError, } from "@aws-sdk/smithy-client";
+import { decorateServiceException as __decorateServiceException, expectInt32 as __expectInt32, expectLong as __expectLong, expectNonNull as __expectNonNull, expectObject as __expectObject, expectString as __expectString, LazyJsonString as __LazyJsonString, map as __map, resolvedPath as __resolvedPath, throwDefaultError, } from "@aws-sdk/smithy-client";
 import { IoTDataPlaneServiceException as __BaseException } from "../models/IoTDataPlaneServiceException";
 import { ConflictException, InternalFailureException, InvalidRequestException, MethodNotAllowedException, RequestEntityTooLargeException, ResourceNotFoundException, ServiceUnavailableException, ThrottlingException, UnauthorizedException, UnsupportedDocumentEncodingException, } from "../models/models_0";
 export const serializeAws_restJson1DeleteThingShadowCommand = async (input, context) => {
@@ -102,14 +102,23 @@ export const serializeAws_restJson1ListRetainedMessagesCommand = async (input, c
 };
 export const serializeAws_restJson1PublishCommand = async (input, context) => {
     const { hostname, protocol = "https", port, path: basePath } = await context.endpoint();
-    const headers = {
+    const headers = map({}, isSerializableHeaderValue, {
         "content-type": "application/octet-stream",
-    };
+        "x-amz-mqtt5-user-properties": [
+            () => isSerializableHeaderValue(input.userProperties),
+            () => context.base64Encoder(Buffer.from(__LazyJsonString.fromObject(input.userProperties))),
+        ],
+        "x-amz-mqtt5-payload-format-indicator": input.payloadFormatIndicator,
+        "x-amz-mqtt5-correlation-data": input.correlationData,
+    });
     let resolvedPath = `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + "/topics/{topic}";
     resolvedPath = __resolvedPath(resolvedPath, input, "topic", () => input.topic, "{topic}", false);
     const query = map({
         qos: [() => input.qos !== void 0, () => input.qos.toString()],
         retain: [() => input.retain !== void 0, () => input.retain.toString()],
+        contentType: [, input.contentType],
+        responseTopic: [, input.responseTopic],
+        messageExpiry: [() => input.messageExpiry !== void 0, () => input.messageExpiry.toString()],
     });
     let body;
     if (input.payload !== undefined) {
@@ -449,6 +458,9 @@ const deserializeAws_restJson1PublishCommandError = async (output, context) => {
         case "MethodNotAllowedException":
         case "com.amazonaws.iotdataplane#MethodNotAllowedException":
             throw await deserializeAws_restJson1MethodNotAllowedExceptionResponse(parsedOutput, context);
+        case "ThrottlingException":
+        case "com.amazonaws.iotdataplane#ThrottlingException":
+            throw await deserializeAws_restJson1ThrottlingExceptionResponse(parsedOutput, context);
         case "UnauthorizedException":
         case "com.amazonaws.iotdataplane#UnauthorizedException":
             throw await deserializeAws_restJson1UnauthorizedExceptionResponse(parsedOutput, context);

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

@@ -1,4 +1,4 @@
-import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
+import { ExceptionOptionType as __ExceptionOptionType, LazyJsonString as __LazyJsonString } from "@aws-sdk/smithy-client";
 import { IoTDataPlaneServiceException as __BaseException } from "./IoTDataPlaneServiceException";
 /**
  * <p>The specified version does not match the version of the document.</p>
@@ -245,6 +245,10 @@ export interface ListRetainedMessagesResponse {
      */
     nextToken?: string;
 }
+export declare enum PayloadFormatIndicator {
+    UNSPECIFIED_BYTES = "UNSPECIFIED_BYTES",
+    UTF8_DATA = "UTF8_DATA"
+}
 /**
  * <p>The input for the Publish operation.</p>
  */
@@ -254,7 +258,7 @@ export interface PublishRequest {
      */
     topic: string | undefined;
     /**
-     * <p>The Quality of Service (QoS) level.</p>
+     * <p>The Quality of Service (QoS) level. The default QoS level is 0.</p>
      */
     qos?: number;
     /**
@@ -272,6 +276,45 @@ export interface PublishRequest {
      *         <code>true</code> deletes the retained message identified by <b>topic</b> from Amazon Web Services IoT Core.</p>
      */
     payload?: Uint8Array;
+    /**
+     * <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>
+     *          <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>
+     *          </p>
+     */
+    userProperties?: __LazyJsonString | string;
+    /**
+     * <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;
+    /**
+     * <p>A UTF-8 encoded string that describes the content of the publishing message.</p>
+     */
+    contentType?: string;
+    /**
+     * <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;
+    /**
+     * <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;
+    /**
+     * <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
+     *         protocol limits and quotas </a> from the Amazon Web Services Reference Guide.</p>
+     */
+    messageExpiry?: number;
 }
 /**
  * <p>The payload exceeds the maximum size allowed.</p>

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

@@ -1,4 +1,7 @@
-import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
+import {
+  ExceptionOptionType as __ExceptionOptionType,
+  LazyJsonString as __LazyJsonString,
+} from "@aws-sdk/smithy-client";
 import { IoTDataPlaneServiceException as __BaseException } from "./IoTDataPlaneServiceException";
 export declare class ConflictException extends __BaseException {
   readonly name: "ConflictException";
@@ -111,11 +114,21 @@ export interface ListRetainedMessagesResponse {
   retainedTopics?: RetainedMessageSummary[];
   nextToken?: string;
 }
+export declare enum PayloadFormatIndicator {
+  UNSPECIFIED_BYTES = "UNSPECIFIED_BYTES",
+  UTF8_DATA = "UTF8_DATA",
+}
 export interface PublishRequest {
   topic: string | undefined;
   qos?: number;
   retain?: boolean;
   payload?: Uint8Array;
+  userProperties?: __LazyJsonString | string;
+  payloadFormatIndicator?: PayloadFormatIndicator | string;
+  contentType?: string;
+  responseTopic?: string;
+  correlationData?: string;
+  messageExpiry?: number;
 }
 export declare class RequestEntityTooLargeException extends __BaseException {
   readonly name: "RequestEntityTooLargeException";

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.216.0",
+  "version": "3.218.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -19,9 +19,9 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "2.0.0",
     "@aws-crypto/sha256-js": "2.0.0",
-    "@aws-sdk/client-sts": "3.216.0",
+    "@aws-sdk/client-sts": "3.218.0",
     "@aws-sdk/config-resolver": "3.215.0",
-    "@aws-sdk/credential-provider-node": "3.216.0",
+    "@aws-sdk/credential-provider-node": "3.218.0",
     "@aws-sdk/fetch-http-handler": "3.215.0",
     "@aws-sdk/hash-node": "3.215.0",
     "@aws-sdk/invalid-dependency": "3.215.0",