@aws-sdk/client-iot-data-plane 3.310.0 → 3.311.0

package/dist-cjs/protocols/Aws_restJson1.js

@@ -243,6 +243,9 @@ const de_GetRetainedMessageCommand = async (output, context) => {
     if (data.topic != null) {
         contents.topic = (0, smithy_client_1.expectString)(data.topic);
     }
+    if (data.userProperties != null) {
+        contents.userProperties = context.base64Decoder(data.userProperties);
+    }
     return contents;
 };
 exports.de_GetRetainedMessageCommand = de_GetRetainedMessageCommand;

package/dist-es/protocols/Aws_restJson1.js

@@ -232,6 +232,9 @@ export const de_GetRetainedMessageCommand = async (output, context) => {
     if (data.topic != null) {
         contents.topic = __expectString(data.topic);
     }
+    if (data.userProperties != null) {
+        contents.userProperties = context.base64Decoder(data.userProperties);
+    }
     return contents;
 };
 const de_GetRetainedMessageCommandError = async (output, context) => {

package/dist-types/IoTDataPlane.d.ts

@@ -36,7 +36,7 @@ export declare class IoTDataPlane extends IoTDataPlaneClient {
      * <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
-     *       <a href="/iot/latest/developerguide/API_iotdata_ListRetainedMessages.html">ListRetainedMessages</a>.</p>
+     *       <a href="https://docs.aws.amazon.com/iot/latest/apireference/API_iotdata_ListRetainedMessages.html">ListRetainedMessages</a>.</p>
      *          <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiotfleethubfordevicemanagement.html#awsiotfleethubfordevicemanagement-actions-as-permissions">GetRetainedMessage</a> action.</p>
      *          <p>For more information about messaging costs, see <a href="http://aws.amazon.com/iot-core/pricing/#Messaging">Amazon Web Services IoT Core
      *       pricing - Messaging</a>.</p>
@@ -69,7 +69,7 @@ export declare class IoTDataPlane extends IoTDataPlaneClient {
      *       return any message payloads. Although this action doesn't return a message payload,
      *       it can still incur messaging costs.</p>
      *          <p>To get the message payload of a retained message, call
-     *       <a href="https://docs.aws.amazon.com/iot/latest/developerguide/API_iotdata_GetRetainedMessage.html">GetRetainedMessage</a>
+     *       <a href="https://docs.aws.amazon.com/iot/latest/apireference/API_iotdata_GetRetainedMessage.html">GetRetainedMessage</a>
      *       with the topic name of the retained message.</p>
      *          <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiotfleethubfordevicemanagement.html#awsiotfleethubfordevicemanagement-actions-as-permissions">ListRetainedMessages</a> action.</p>
      *          <p>For more information about messaging costs, see <a href="http://aws.amazon.com/iot-core/pricing/#Messaging">Amazon Web Services IoT Core

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

@@ -22,7 +22,7 @@ export interface GetRetainedMessageCommandOutput extends GetRetainedMessageRespo
  * <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
- *       <a href="/iot/latest/developerguide/API_iotdata_ListRetainedMessages.html">ListRetainedMessages</a>.</p>
+ *       <a href="https://docs.aws.amazon.com/iot/latest/apireference/API_iotdata_ListRetainedMessages.html">ListRetainedMessages</a>.</p>
  *          <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiotfleethubfordevicemanagement.html#awsiotfleethubfordevicemanagement-actions-as-permissions">GetRetainedMessage</a> action.</p>
  *          <p>For more information about messaging costs, see <a href="http://aws.amazon.com/iot-core/pricing/#Messaging">Amazon Web Services IoT Core
  *       pricing - Messaging</a>.</p>

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

@@ -24,7 +24,7 @@ export interface ListRetainedMessagesCommandOutput extends ListRetainedMessagesR
  *       return any message payloads. Although this action doesn't return a message payload,
  *       it can still incur messaging costs.</p>
  *          <p>To get the message payload of a retained message, call
- *       <a href="https://docs.aws.amazon.com/iot/latest/developerguide/API_iotdata_GetRetainedMessage.html">GetRetainedMessage</a>
+ *       <a href="https://docs.aws.amazon.com/iot/latest/apireference/API_iotdata_GetRetainedMessage.html">GetRetainedMessage</a>
  *       with the topic name of the retained message.</p>
  *          <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiotfleethubfordevicemanagement.html#awsiotfleethubfordevicemanagement-actions-as-permissions">ListRetainedMessages</a> action.</p>
  *          <p>For more information about messaging costs, see <a href="http://aws.amazon.com/iot-core/pricing/#Messaging">Amazon Web Services IoT Core

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

@@ -163,6 +163,16 @@ export interface GetRetainedMessageResponse {
      * <p>The Epoch date and time, in milliseconds, when the retained message was stored by IoT.</p>
      */
     lastModifiedTime?: number;
+    /**
+     * <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
+     *       represents two user properties. Note that it will be base64-encoded:</p>
+     *          <p>
+     *             <code>[\{"deviceName": "alpha"\}, \{"deviceCnt": "45"\}]</code>
+     *          </p>
+     */
+    userProperties?: Uint8Array;
 }
 /**
  * @public

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

@@ -82,6 +82,7 @@ export interface GetRetainedMessageResponse {
   payload?: Uint8Array;
   qos?: number;
   lastModifiedTime?: number;
+  userProperties?: Uint8Array;
 }
 export interface GetThingShadowRequest {
   thingName: string | undefined;

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.310.0",
+  "version": "3.311.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",