feat(client-iot-data-plane): This release adds support for MQTT5 properties to AWS IoT HTTP Publish API.

Author: awstools

clients/client-iot-data-plane/src/models/models_0.ts

@@ -1,5 +1,8 @@
 // smithy-typescript generated code
-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";
 
@@ -345,6 +348,11 @@ export interface ListRetainedMessagesResponse {
   nextToken?: string;
 }
 
+export enum PayloadFormatIndicator {
+  UNSPECIFIED_BYTES = "UNSPECIFIED_BYTES",
+  UTF8_DATA = "UTF8_DATA",
+}
+
 /**
  * <p>The input for the Publish operation.</p>
  */
@@ -355,7 +363,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;
 
@@ -375,6 +383,51 @@ 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;
 }
 
 /**

clients/client-iot-data-plane/src/protocols/Aws_restJson1.ts

@@ -8,6 +8,7 @@ import {
   expectObject as __expectObject,
   expectString as __expectString,
   extendedEncodeURIComponent as __extendedEncodeURIComponent,
+  LazyJsonString as __LazyJsonString,
   map as __map,
   resolvedPath as __resolvedPath,
   throwDefaultError,
@@ -172,14 +173,23 @@ export const serializeAws_restJson1PublishCommand = async (
   context: __SerdeContext
 ): Promise<__HttpRequest> => {
   const { hostname, protocol = "https", port, path: basePath } = await context.endpoint();
-  const headers: any = {
+  const headers: any = 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: any = 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: any;
   if (input.payload !== undefined) {
@@ -572,6 +582,9 @@ const deserializeAws_restJson1PublishCommandError = async (
     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);