@aws-sdk/client-iot-data-plane 3.533.0 → 3.540.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,12 +1,14 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.defaultEndpointResolver = void 0;
4
- const util_endpoints_1 = require("@smithy/util-endpoints");
4
+ const util_endpoints_1 = require("@aws-sdk/util-endpoints");
5
+ const util_endpoints_2 = require("@smithy/util-endpoints");
5
6
  const ruleset_1 = require("./ruleset");
6
7
  const defaultEndpointResolver = (endpointParams, context = {}) => {
7
- return (0, util_endpoints_1.resolveEndpoint)(ruleset_1.ruleSet, {
8
+ return (0, util_endpoints_2.resolveEndpoint)(ruleset_1.ruleSet, {
8
9
  endpointParams: endpointParams,
9
10
  logger: context.logger,
10
11
  });
11
12
  };
12
13
  exports.defaultEndpointResolver = defaultEndpointResolver;
14
+ util_endpoints_2.customEndpointFunctions.aws = util_endpoints_1.awsEndpointFunctions;
package/dist-cjs/index.js CHANGED
@@ -924,9 +924,6 @@ var IoTDataPlane = _IoTDataPlane;
924
924
  // src/pagination/ListRetainedMessagesPaginator.ts
925
925
 
926
926
  var paginateListRetainedMessages = (0, import_core.createPaginator)(IoTDataPlaneClient, ListRetainedMessagesCommand, "nextToken", "nextToken", "maxResults");
927
-
928
- // src/index.ts
929
- var import_util_endpoints = require("@aws-sdk/util-endpoints");
930
927
  // Annotate the CommonJS export names for ESM import in node:
931
928
 
932
929
  0 && (module.exports = {
@@ -1,4 +1,5 @@
1
- import { resolveEndpoint } from "@smithy/util-endpoints";
1
+ import { awsEndpointFunctions } from "@aws-sdk/util-endpoints";
2
+ import { customEndpointFunctions, resolveEndpoint } from "@smithy/util-endpoints";
2
3
  import { ruleSet } from "./ruleset";
3
4
  export const defaultEndpointResolver = (endpointParams, context = {}) => {
4
5
  return resolveEndpoint(ruleSet, {
@@ -6,3 +7,4 @@ export const defaultEndpointResolver = (endpointParams, context = {}) => {
6
7
  logger: context.logger,
7
8
  });
8
9
  };
10
+ customEndpointFunctions.aws = awsEndpointFunctions;
package/dist-es/index.js CHANGED
@@ -3,5 +3,4 @@ export * from "./IoTDataPlane";
3
3
  export * from "./commands";
4
4
  export * from "./pagination";
5
5
  export * from "./models";
6
- import "@aws-sdk/util-endpoints";
7
6
  export { IoTDataPlaneServiceException } from "./models/IoTDataPlaneServiceException";
@@ -35,6 +35,7 @@ export interface IoTDataPlane {
35
35
  /**
36
36
  * @see {@link ListRetainedMessagesCommand}
37
37
  */
38
+ listRetainedMessages(): Promise<ListRetainedMessagesCommandOutput>;
38
39
  listRetainedMessages(args: ListRetainedMessagesCommandInput, options?: __HttpHandlerOptions): Promise<ListRetainedMessagesCommandOutput>;
39
40
  listRetainedMessages(args: ListRetainedMessagesCommandInput, cb: (err: any, data?: ListRetainedMessagesCommandOutput) => void): void;
40
41
  listRetainedMessages(args: ListRetainedMessagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRetainedMessagesCommandOutput) => void): void;
@@ -52,7 +53,6 @@ export interface IoTDataPlane {
52
53
  updateThingShadow(args: UpdateThingShadowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateThingShadowCommandOutput) => void): void;
53
54
  }
54
55
  /**
55
- * @public
56
56
  * <fullname>IoT data</fullname>
57
57
  * <p>IoT data enables secure, bi-directional communication between Internet-connected things (such as sensors,
58
58
  * actuators, embedded devices, or smart appliances) and the Amazon Web Services cloud. It implements a broker for applications and
@@ -64,6 +64,7 @@ export interface IoTDataPlane {
64
64
  * </p>
65
65
  * <p>The service name used by <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Amazon Web ServicesSignature Version 4</a>
66
66
  * to sign requests is: <i>iotdevicegateway</i>.</p>
67
+ * @public
67
68
  */
68
69
  export declare class IoTDataPlane extends IoTDataPlaneClient implements IoTDataPlane {
69
70
  }
@@ -158,7 +158,6 @@ export type IoTDataPlaneClientResolvedConfigType = __SmithyResolvedConfiguration
158
158
  export interface IoTDataPlaneClientResolvedConfig extends IoTDataPlaneClientResolvedConfigType {
159
159
  }
160
160
  /**
161
- * @public
162
161
  * <fullname>IoT data</fullname>
163
162
  * <p>IoT data enables secure, bi-directional communication between Internet-connected things (such as sensors,
164
163
  * actuators, embedded devices, or smart appliances) and the Amazon Web Services cloud. It implements a broker for applications and
@@ -170,6 +169,7 @@ export interface IoTDataPlaneClientResolvedConfig extends IoTDataPlaneClientReso
170
169
  * </p>
171
170
  * <p>The service name used by <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Amazon Web ServicesSignature Version 4</a>
172
171
  * to sign requests is: <i>iotdevicegateway</i>.</p>
172
+ * @public
173
173
  */
174
174
  export declare class IoTDataPlaneClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, IoTDataPlaneClientResolvedConfig> {
175
175
  /**
@@ -29,10 +29,10 @@ export interface DeleteThingShadowCommandOutput extends DeleteThingShadowCommand
29
29
  }
30
30
  declare const DeleteThingShadowCommand_base: {
31
31
  new (input: DeleteThingShadowCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteThingShadowCommandInput, DeleteThingShadowCommandOutput, IoTDataPlaneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
32
+ new (__0_0: DeleteThingShadowCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteThingShadowCommandInput, DeleteThingShadowCommandOutput, IoTDataPlaneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
32
33
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
33
34
  };
34
35
  /**
35
- * @public
36
36
  * <p>Deletes the shadow for the specified thing.</p>
37
37
  * <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>
38
38
  * <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>
@@ -87,6 +87,7 @@ declare const DeleteThingShadowCommand_base: {
87
87
  * @throws {@link IoTDataPlaneServiceException}
88
88
  * <p>Base exception class for all service exceptions from IoTDataPlane service.</p>
89
89
  *
90
+ * @public
90
91
  */
91
92
  export declare class DeleteThingShadowCommand extends DeleteThingShadowCommand_base {
92
93
  }
@@ -22,10 +22,10 @@ export interface GetRetainedMessageCommandOutput extends GetRetainedMessageRespo
22
22
  }
23
23
  declare const GetRetainedMessageCommand_base: {
24
24
  new (input: GetRetainedMessageCommandInput): import("@smithy/smithy-client").CommandImpl<GetRetainedMessageCommandInput, GetRetainedMessageCommandOutput, IoTDataPlaneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
+ new (__0_0: GetRetainedMessageCommandInput): import("@smithy/smithy-client").CommandImpl<GetRetainedMessageCommandInput, GetRetainedMessageCommandOutput, IoTDataPlaneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
26
27
  };
27
28
  /**
28
- * @public
29
29
  * <p>Gets the details of a single retained message for the specified topic.</p>
30
30
  * <p>This action returns the message payload of the retained message, which can
31
31
  * incur messaging costs. To list only the topic names of the retained messages, call
@@ -84,6 +84,7 @@ declare const GetRetainedMessageCommand_base: {
84
84
  * @throws {@link IoTDataPlaneServiceException}
85
85
  * <p>Base exception class for all service exceptions from IoTDataPlane service.</p>
86
86
  *
87
+ * @public
87
88
  */
88
89
  export declare class GetRetainedMessageCommand extends GetRetainedMessageCommand_base {
89
90
  }
@@ -29,10 +29,10 @@ export interface GetThingShadowCommandOutput extends GetThingShadowCommandOutput
29
29
  }
30
30
  declare const GetThingShadowCommand_base: {
31
31
  new (input: GetThingShadowCommandInput): import("@smithy/smithy-client").CommandImpl<GetThingShadowCommandInput, GetThingShadowCommandOutput, IoTDataPlaneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
32
+ new (__0_0: GetThingShadowCommandInput): import("@smithy/smithy-client").CommandImpl<GetThingShadowCommandInput, GetThingShadowCommandOutput, IoTDataPlaneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
32
33
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
33
34
  };
34
35
  /**
35
- * @public
36
36
  * <p>Gets the shadow for the specified thing.</p>
37
37
  * <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>
38
38
  * <p>For more information, see <a href="http://docs.aws.amazon.com/iot/latest/developerguide/API_GetThingShadow.html">GetThingShadow</a> in the
@@ -88,6 +88,7 @@ declare const GetThingShadowCommand_base: {
88
88
  * @throws {@link IoTDataPlaneServiceException}
89
89
  * <p>Base exception class for all service exceptions from IoTDataPlane service.</p>
90
90
  *
91
+ * @public
91
92
  */
92
93
  export declare class GetThingShadowCommand extends GetThingShadowCommand_base {
93
94
  }
@@ -22,10 +22,10 @@ export interface ListNamedShadowsForThingCommandOutput extends ListNamedShadowsF
22
22
  }
23
23
  declare const ListNamedShadowsForThingCommand_base: {
24
24
  new (input: ListNamedShadowsForThingCommandInput): import("@smithy/smithy-client").CommandImpl<ListNamedShadowsForThingCommandInput, ListNamedShadowsForThingCommandOutput, IoTDataPlaneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
+ new (__0_0: ListNamedShadowsForThingCommandInput): import("@smithy/smithy-client").CommandImpl<ListNamedShadowsForThingCommandInput, ListNamedShadowsForThingCommandOutput, IoTDataPlaneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
26
27
  };
27
28
  /**
28
- * @public
29
29
  * <p>Lists the shadows for the specified thing.</p>
30
30
  * <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>
31
31
  * @example
@@ -81,6 +81,7 @@ declare const ListNamedShadowsForThingCommand_base: {
81
81
  * @throws {@link IoTDataPlaneServiceException}
82
82
  * <p>Base exception class for all service exceptions from IoTDataPlane service.</p>
83
83
  *
84
+ * @public
84
85
  */
85
86
  export declare class ListNamedShadowsForThingCommand extends ListNamedShadowsForThingCommand_base {
86
87
  }
@@ -22,10 +22,10 @@ export interface ListRetainedMessagesCommandOutput extends ListRetainedMessagesR
22
22
  }
23
23
  declare const ListRetainedMessagesCommand_base: {
24
24
  new (input: ListRetainedMessagesCommandInput): import("@smithy/smithy-client").CommandImpl<ListRetainedMessagesCommandInput, ListRetainedMessagesCommandOutput, IoTDataPlaneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
+ new (...[input]: [] | [ListRetainedMessagesCommandInput]): import("@smithy/smithy-client").CommandImpl<ListRetainedMessagesCommandInput, ListRetainedMessagesCommandOutput, IoTDataPlaneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
26
27
  };
27
28
  /**
28
- * @public
29
29
  * <p>Lists summary information about the retained messages stored for the account.</p>
30
30
  * <p>This action returns only the topic names of the retained messages. It doesn't
31
31
  * return any message payloads. Although this action doesn't return a message payload,
@@ -89,6 +89,7 @@ declare const ListRetainedMessagesCommand_base: {
89
89
  * @throws {@link IoTDataPlaneServiceException}
90
90
  * <p>Base exception class for all service exceptions from IoTDataPlane service.</p>
91
91
  *
92
+ * @public
92
93
  */
93
94
  export declare class ListRetainedMessagesCommand extends ListRetainedMessagesCommand_base {
94
95
  }
@@ -28,10 +28,10 @@ export interface PublishCommandOutput extends __MetadataBearer {
28
28
  }
29
29
  declare const PublishCommand_base: {
30
30
  new (input: PublishCommandInput): import("@smithy/smithy-client").CommandImpl<PublishCommandInput, PublishCommandOutput, IoTDataPlaneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
31
+ new (__0_0: PublishCommandInput): import("@smithy/smithy-client").CommandImpl<PublishCommandInput, PublishCommandOutput, IoTDataPlaneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
31
32
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
32
33
  };
33
34
  /**
34
- * @public
35
35
  * <p>Publishes an MQTT message.</p>
36
36
  * <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>
37
37
  * <p>For more information about MQTT messages, see
@@ -87,6 +87,7 @@ declare const PublishCommand_base: {
87
87
  * @throws {@link IoTDataPlaneServiceException}
88
88
  * <p>Base exception class for all service exceptions from IoTDataPlane service.</p>
89
89
  *
90
+ * @public
90
91
  */
91
92
  export declare class PublishCommand extends PublishCommand_base {
92
93
  }
@@ -35,10 +35,10 @@ export interface UpdateThingShadowCommandOutput extends UpdateThingShadowCommand
35
35
  }
36
36
  declare const UpdateThingShadowCommand_base: {
37
37
  new (input: UpdateThingShadowCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateThingShadowCommandInput, UpdateThingShadowCommandOutput, IoTDataPlaneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
38
+ new (__0_0: UpdateThingShadowCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateThingShadowCommandInput, UpdateThingShadowCommandOutput, IoTDataPlaneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
38
39
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
39
40
  };
40
41
  /**
41
- * @public
42
42
  * <p>Updates the shadow for the specified thing.</p>
43
43
  * <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>
44
44
  * <p>For more information, see <a href="http://docs.aws.amazon.com/iot/latest/developerguide/API_UpdateThingShadow.html">UpdateThingShadow</a> in the
@@ -98,6 +98,7 @@ declare const UpdateThingShadowCommand_base: {
98
98
  * @throws {@link IoTDataPlaneServiceException}
99
99
  * <p>Base exception class for all service exceptions from IoTDataPlane service.</p>
100
100
  *
101
+ * @public
101
102
  */
102
103
  export declare class UpdateThingShadowCommand extends UpdateThingShadowCommand_base {
103
104
  }
@@ -21,5 +21,4 @@ export { IoTDataPlaneExtensionConfiguration } from "./extensionConfiguration";
21
21
  export * from "./commands";
22
22
  export * from "./pagination";
23
23
  export * from "./models";
24
- import "@aws-sdk/util-endpoints";
25
24
  export { IoTDataPlaneServiceException } from "./models/IoTDataPlaneServiceException";
@@ -1,8 +1,8 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType, LazyJsonString as __LazyJsonString } from "@smithy/smithy-client";
2
2
  import { IoTDataPlaneServiceException as __BaseException } from "./IoTDataPlaneServiceException";
3
3
  /**
4
- * @public
5
4
  * <p>The specified version does not match the version of the document.</p>
5
+ * @public
6
6
  */
7
7
  export declare class ConflictException extends __BaseException {
8
8
  readonly name: "ConflictException";
@@ -13,35 +13,35 @@ export declare class ConflictException extends __BaseException {
13
13
  constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
14
14
  }
15
15
  /**
16
- * @public
17
16
  * <p>The input for the DeleteThingShadow operation.</p>
17
+ * @public
18
18
  */
19
19
  export interface DeleteThingShadowRequest {
20
20
  /**
21
- * @public
22
21
  * <p>The name of the thing.</p>
22
+ * @public
23
23
  */
24
24
  thingName: string | undefined;
25
25
  /**
26
- * @public
27
26
  * <p>The name of the shadow.</p>
27
+ * @public
28
28
  */
29
29
  shadowName?: string;
30
30
  }
31
31
  /**
32
- * @public
33
32
  * <p>The output from the DeleteThingShadow operation.</p>
33
+ * @public
34
34
  */
35
35
  export interface DeleteThingShadowResponse {
36
36
  /**
37
- * @public
38
37
  * <p>The state information, in JSON format.</p>
38
+ * @public
39
39
  */
40
40
  payload: Uint8Array | undefined;
41
41
  }
42
42
  /**
43
- * @public
44
43
  * <p>An unexpected error has occurred.</p>
44
+ * @public
45
45
  */
46
46
  export declare class InternalFailureException extends __BaseException {
47
47
  readonly name: "InternalFailureException";
@@ -52,8 +52,8 @@ export declare class InternalFailureException extends __BaseException {
52
52
  constructor(opts: __ExceptionOptionType<InternalFailureException, __BaseException>);
53
53
  }
54
54
  /**
55
- * @public
56
55
  * <p>The request is not valid.</p>
56
+ * @public
57
57
  */
58
58
  export declare class InvalidRequestException extends __BaseException {
59
59
  readonly name: "InvalidRequestException";
@@ -64,8 +64,8 @@ export declare class InvalidRequestException extends __BaseException {
64
64
  constructor(opts: __ExceptionOptionType<InvalidRequestException, __BaseException>);
65
65
  }
66
66
  /**
67
- * @public
68
67
  * <p>The specified combination of HTTP verb and URI is not supported.</p>
68
+ * @public
69
69
  */
70
70
  export declare class MethodNotAllowedException extends __BaseException {
71
71
  readonly name: "MethodNotAllowedException";
@@ -76,8 +76,8 @@ export declare class MethodNotAllowedException extends __BaseException {
76
76
  constructor(opts: __ExceptionOptionType<MethodNotAllowedException, __BaseException>);
77
77
  }
78
78
  /**
79
- * @public
80
79
  * <p>The specified resource does not exist.</p>
80
+ * @public
81
81
  */
82
82
  export declare class ResourceNotFoundException extends __BaseException {
83
83
  readonly name: "ResourceNotFoundException";
@@ -88,8 +88,8 @@ export declare class ResourceNotFoundException extends __BaseException {
88
88
  constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
89
89
  }
90
90
  /**
91
- * @public
92
91
  * <p>The service is temporarily unavailable.</p>
92
+ * @public
93
93
  */
94
94
  export declare class ServiceUnavailableException extends __BaseException {
95
95
  readonly name: "ServiceUnavailableException";
@@ -100,8 +100,8 @@ export declare class ServiceUnavailableException extends __BaseException {
100
100
  constructor(opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>);
101
101
  }
102
102
  /**
103
- * @public
104
103
  * <p>The rate exceeds the limit.</p>
104
+ * @public
105
105
  */
106
106
  export declare class ThrottlingException extends __BaseException {
107
107
  readonly name: "ThrottlingException";
@@ -112,8 +112,8 @@ export declare class ThrottlingException extends __BaseException {
112
112
  constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
113
113
  }
114
114
  /**
115
- * @public
116
115
  * <p>You are not authorized to perform this operation.</p>
116
+ * @public
117
117
  */
118
118
  export declare class UnauthorizedException extends __BaseException {
119
119
  readonly name: "UnauthorizedException";
@@ -124,8 +124,8 @@ export declare class UnauthorizedException extends __BaseException {
124
124
  constructor(opts: __ExceptionOptionType<UnauthorizedException, __BaseException>);
125
125
  }
126
126
  /**
127
- * @public
128
127
  * <p>The document encoding is not supported.</p>
128
+ * @public
129
129
  */
130
130
  export declare class UnsupportedDocumentEncodingException extends __BaseException {
131
131
  readonly name: "UnsupportedDocumentEncodingException";
@@ -136,43 +136,42 @@ export declare class UnsupportedDocumentEncodingException extends __BaseExceptio
136
136
  constructor(opts: __ExceptionOptionType<UnsupportedDocumentEncodingException, __BaseException>);
137
137
  }
138
138
  /**
139
- * @public
140
139
  * <p>The input for the GetRetainedMessage operation.</p>
140
+ * @public
141
141
  */
142
142
  export interface GetRetainedMessageRequest {
143
143
  /**
144
- * @public
145
144
  * <p>The topic name of the retained message to retrieve.</p>
145
+ * @public
146
146
  */
147
147
  topic: string | undefined;
148
148
  }
149
149
  /**
150
- * @public
151
150
  * <p>The output from the GetRetainedMessage operation.</p>
151
+ * @public
152
152
  */
153
153
  export interface GetRetainedMessageResponse {
154
154
  /**
155
- * @public
156
155
  * <p>The topic name to which the retained message was published.</p>
156
+ * @public
157
157
  */
158
158
  topic?: string;
159
159
  /**
160
- * @public
161
160
  * <p>The Base64-encoded message payload of the retained message body.</p>
161
+ * @public
162
162
  */
163
163
  payload?: Uint8Array;
164
164
  /**
165
- * @public
166
165
  * <p>The quality of service (QoS) level used to publish the retained message.</p>
166
+ * @public
167
167
  */
168
168
  qos?: number;
169
169
  /**
170
- * @public
171
170
  * <p>The Epoch date and time, in milliseconds, when the retained message was stored by IoT.</p>
171
+ * @public
172
172
  */
173
173
  lastModifiedTime?: number;
174
174
  /**
175
- * @public
176
175
  * <p>A base64-encoded JSON string that includes an array of JSON objects, or null if the
177
176
  * retained message doesn't include any user properties.</p>
178
177
  * <p>The following example <code>userProperties</code> parameter is a JSON string that
@@ -180,33 +179,34 @@ export interface GetRetainedMessageResponse {
180
179
  * <p>
181
180
  * <code>[\{"deviceName": "alpha"\}, \{"deviceCnt": "45"\}]</code>
182
181
  * </p>
182
+ * @public
183
183
  */
184
184
  userProperties?: Uint8Array;
185
185
  }
186
186
  /**
187
- * @public
188
187
  * <p>The input for the GetThingShadow operation.</p>
188
+ * @public
189
189
  */
190
190
  export interface GetThingShadowRequest {
191
191
  /**
192
- * @public
193
192
  * <p>The name of the thing.</p>
193
+ * @public
194
194
  */
195
195
  thingName: string | undefined;
196
196
  /**
197
- * @public
198
197
  * <p>The name of the shadow.</p>
198
+ * @public
199
199
  */
200
200
  shadowName?: string;
201
201
  }
202
202
  /**
203
- * @public
204
203
  * <p>The output from the GetThingShadow operation.</p>
204
+ * @public
205
205
  */
206
206
  export interface GetThingShadowResponse {
207
207
  /**
208
- * @public
209
208
  * <p>The state information, in JSON format.</p>
209
+ * @public
210
210
  */
211
211
  payload?: Uint8Array;
212
212
  }
@@ -215,18 +215,18 @@ export interface GetThingShadowResponse {
215
215
  */
216
216
  export interface ListNamedShadowsForThingRequest {
217
217
  /**
218
- * @public
219
218
  * <p>The name of the thing.</p>
219
+ * @public
220
220
  */
221
221
  thingName: string | undefined;
222
222
  /**
223
- * @public
224
223
  * <p>The token to retrieve the next set of results.</p>
224
+ * @public
225
225
  */
226
226
  nextToken?: string;
227
227
  /**
228
- * @public
229
228
  * <p>The result page size.</p>
229
+ * @public
230
230
  */
231
231
  pageSize?: number;
232
232
  }
@@ -235,18 +235,18 @@ export interface ListNamedShadowsForThingRequest {
235
235
  */
236
236
  export interface ListNamedShadowsForThingResponse {
237
237
  /**
238
- * @public
239
238
  * <p>The list of shadows for the specified thing.</p>
239
+ * @public
240
240
  */
241
241
  results?: string[];
242
242
  /**
243
- * @public
244
243
  * <p>The token to use to get the next set of results, or <b>null</b> if there are no additional results.</p>
244
+ * @public
245
245
  */
246
246
  nextToken?: string;
247
247
  /**
248
- * @public
249
248
  * <p>The Epoch date and time the response was generated by IoT.</p>
249
+ * @public
250
250
  */
251
251
  timestamp?: number;
252
252
  }
@@ -255,41 +255,41 @@ export interface ListNamedShadowsForThingResponse {
255
255
  */
256
256
  export interface ListRetainedMessagesRequest {
257
257
  /**
258
- * @public
259
258
  * <p>To retrieve the next set of results, the <code>nextToken</code>
260
259
  * value from a previous response; otherwise <b>null</b> to receive
261
260
  * the first set of results.</p>
261
+ * @public
262
262
  */
263
263
  nextToken?: string;
264
264
  /**
265
- * @public
266
265
  * <p>The maximum number of results to return at one time.</p>
266
+ * @public
267
267
  */
268
268
  maxResults?: number;
269
269
  }
270
270
  /**
271
- * @public
272
271
  * <p>Information about a single retained message.</p>
272
+ * @public
273
273
  */
274
274
  export interface RetainedMessageSummary {
275
275
  /**
276
- * @public
277
276
  * <p>The topic name to which the retained message was published.</p>
277
+ * @public
278
278
  */
279
279
  topic?: string;
280
280
  /**
281
- * @public
282
281
  * <p>The size of the retained message's payload in bytes.</p>
282
+ * @public
283
283
  */
284
284
  payloadSize?: number;
285
285
  /**
286
- * @public
287
286
  * <p>The quality of service (QoS) level used to publish the retained message.</p>
287
+ * @public
288
288
  */
289
289
  qos?: number;
290
290
  /**
291
- * @public
292
291
  * <p>The Epoch date and time, in milliseconds, when the retained message was stored by IoT.</p>
292
+ * @public
293
293
  */
294
294
  lastModifiedTime?: number;
295
295
  }
@@ -298,14 +298,14 @@ export interface RetainedMessageSummary {
298
298
  */
299
299
  export interface ListRetainedMessagesResponse {
300
300
  /**
301
- * @public
302
301
  * <p>A summary list the account's retained messages. The information returned doesn't include
303
302
  * the message payloads of the retained messages.</p>
303
+ * @public
304
304
  */
305
305
  retainedTopics?: RetainedMessageSummary[];
306
306
  /**
307
- * @public
308
307
  * <p>The token for the next set of results, or null if there are no additional results.</p>
308
+ * @public
309
309
  */
310
310
  nextToken?: string;
311
311
  }
@@ -322,39 +322,38 @@ export declare const PayloadFormatIndicator: {
322
322
  */
323
323
  export type PayloadFormatIndicator = (typeof PayloadFormatIndicator)[keyof typeof PayloadFormatIndicator];
324
324
  /**
325
- * @public
326
325
  * <p>The input for the Publish operation.</p>
326
+ * @public
327
327
  */
328
328
  export interface PublishRequest {
329
329
  /**
330
- * @public
331
330
  * <p>The name of the MQTT topic.</p>
331
+ * @public
332
332
  */
333
333
  topic: string | undefined;
334
334
  /**
335
- * @public
336
335
  * <p>The Quality of Service (QoS) level. The default QoS level is 0.</p>
336
+ * @public
337
337
  */
338
338
  qos?: number;
339
339
  /**
340
- * @public
341
340
  * <p>A Boolean value that determines whether to set the RETAIN flag when the message is published.</p>
342
341
  * <p>Setting the RETAIN flag causes the message to be retained and sent to new subscribers to the topic.</p>
343
342
  * <p>Valid values: <code>true</code> | <code>false</code>
344
343
  * </p>
345
344
  * <p>Default value: <code>false</code>
346
345
  * </p>
346
+ * @public
347
347
  */
348
348
  retain?: boolean;
349
349
  /**
350
- * @public
351
350
  * <p>The message body. MQTT accepts text, binary, and empty (null) message payloads.</p>
352
351
  * <p>Publishing an empty (null) payload with <b>retain</b> =
353
352
  * <code>true</code> deletes the retained message identified by <b>topic</b> from Amazon Web Services IoT Core.</p>
353
+ * @public
354
354
  */
355
355
  payload?: Uint8Array;
356
356
  /**
357
- * @public
358
357
  * <p>A JSON string that contains an array of JSON objects. If you don’t use Amazon Web Services SDK or CLI,
359
358
  * you must encode the JSON string to base64 format before adding it to the HTTP header.
360
359
  * <code>userProperties</code> is an HTTP header value in the API.</p>
@@ -363,45 +362,46 @@ export interface PublishRequest {
363
362
  * <p>
364
363
  * <code>[\{"deviceName": "alpha"\}, \{"deviceCnt": "45"\}]</code>
365
364
  * </p>
365
+ * @public
366
366
  */
367
367
  userProperties?: __LazyJsonString | string;
368
368
  /**
369
- * @public
370
369
  * <p>An <code>Enum</code> string value that indicates whether the payload is formatted as
371
370
  * UTF-8. <code>payloadFormatIndicator</code> is an HTTP header value in the API.</p>
371
+ * @public
372
372
  */
373
373
  payloadFormatIndicator?: PayloadFormatIndicator;
374
374
  /**
375
- * @public
376
375
  * <p>A UTF-8 encoded string that describes the content of the publishing message.</p>
376
+ * @public
377
377
  */
378
378
  contentType?: string;
379
379
  /**
380
- * @public
381
380
  * <p>A UTF-8 encoded string that's used as the topic name for a response message. The response
382
381
  * topic is used to describe the topic which the receiver should publish to as part of the
383
382
  * request-response flow. The topic must not contain wildcard characters.</p>
383
+ * @public
384
384
  */
385
385
  responseTopic?: string;
386
386
  /**
387
- * @public
388
387
  * <p>The base64-encoded binary data used by the sender of the request message to identify which
389
388
  * request the response message is for when it's received. <code>correlationData</code> is an
390
389
  * HTTP header value in the API.</p>
390
+ * @public
391
391
  */
392
392
  correlationData?: string;
393
393
  /**
394
- * @public
395
394
  * <p>A user-defined integer value that represents the message expiry interval in seconds. If
396
395
  * absent, the message doesn't expire. For more information about the limits of
397
396
  * <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
398
397
  * protocol limits and quotas </a> from the Amazon Web Services Reference Guide.</p>
398
+ * @public
399
399
  */
400
400
  messageExpiry?: number;
401
401
  }
402
402
  /**
403
- * @public
404
403
  * <p>The payload exceeds the maximum size allowed.</p>
404
+ * @public
405
405
  */
406
406
  export declare class RequestEntityTooLargeException extends __BaseException {
407
407
  readonly name: "RequestEntityTooLargeException";
@@ -412,34 +412,34 @@ export declare class RequestEntityTooLargeException extends __BaseException {
412
412
  constructor(opts: __ExceptionOptionType<RequestEntityTooLargeException, __BaseException>);
413
413
  }
414
414
  /**
415
- * @public
416
415
  * <p>The input for the UpdateThingShadow operation.</p>
416
+ * @public
417
417
  */
418
418
  export interface UpdateThingShadowRequest {
419
419
  /**
420
- * @public
421
420
  * <p>The name of the thing.</p>
421
+ * @public
422
422
  */
423
423
  thingName: string | undefined;
424
424
  /**
425
- * @public
426
425
  * <p>The name of the shadow.</p>
426
+ * @public
427
427
  */
428
428
  shadowName?: string;
429
429
  /**
430
- * @public
431
430
  * <p>The state information, in JSON format.</p>
431
+ * @public
432
432
  */
433
433
  payload: Uint8Array | undefined;
434
434
  }
435
435
  /**
436
- * @public
437
436
  * <p>The output from the UpdateThingShadow operation.</p>
437
+ * @public
438
438
  */
439
439
  export interface UpdateThingShadowResponse {
440
440
  /**
441
- * @public
442
441
  * <p>The state information, in JSON format.</p>
442
+ * @public
443
443
  */
444
444
  payload?: Uint8Array;
445
445
  }
@@ -81,6 +81,7 @@ export interface IoTDataPlane {
81
81
  options: __HttpHandlerOptions,
82
82
  cb: (err: any, data?: ListNamedShadowsForThingCommandOutput) => void
83
83
  ): void;
84
+ listRetainedMessages(): Promise<ListRetainedMessagesCommandOutput>;
84
85
  listRetainedMessages(
85
86
  args: ListRetainedMessagesCommandInput,
86
87
  options?: __HttpHandlerOptions
@@ -32,6 +32,15 @@ declare const DeleteThingShadowCommand_base: {
32
32
  ServiceInputTypes,
33
33
  ServiceOutputTypes
34
34
  >;
35
+ new (
36
+ __0_0: DeleteThingShadowCommandInput
37
+ ): import("@smithy/smithy-client").CommandImpl<
38
+ DeleteThingShadowCommandInput,
39
+ DeleteThingShadowCommandOutput,
40
+ IoTDataPlaneClientResolvedConfig,
41
+ ServiceInputTypes,
42
+ ServiceOutputTypes
43
+ >;
35
44
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
36
45
  };
37
46
  export declare class DeleteThingShadowCommand extends DeleteThingShadowCommand_base {}
@@ -25,6 +25,15 @@ declare const GetRetainedMessageCommand_base: {
25
25
  ServiceInputTypes,
26
26
  ServiceOutputTypes
27
27
  >;
28
+ new (
29
+ __0_0: GetRetainedMessageCommandInput
30
+ ): import("@smithy/smithy-client").CommandImpl<
31
+ GetRetainedMessageCommandInput,
32
+ GetRetainedMessageCommandOutput,
33
+ IoTDataPlaneClientResolvedConfig,
34
+ ServiceInputTypes,
35
+ ServiceOutputTypes
36
+ >;
28
37
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
29
38
  };
30
39
  export declare class GetRetainedMessageCommand extends GetRetainedMessageCommand_base {}
@@ -31,6 +31,15 @@ declare const GetThingShadowCommand_base: {
31
31
  ServiceInputTypes,
32
32
  ServiceOutputTypes
33
33
  >;
34
+ new (
35
+ __0_0: GetThingShadowCommandInput
36
+ ): import("@smithy/smithy-client").CommandImpl<
37
+ GetThingShadowCommandInput,
38
+ GetThingShadowCommandOutput,
39
+ IoTDataPlaneClientResolvedConfig,
40
+ ServiceInputTypes,
41
+ ServiceOutputTypes
42
+ >;
34
43
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
35
44
  };
36
45
  export declare class GetThingShadowCommand extends GetThingShadowCommand_base {}
@@ -25,6 +25,15 @@ declare const ListNamedShadowsForThingCommand_base: {
25
25
  ServiceInputTypes,
26
26
  ServiceOutputTypes
27
27
  >;
28
+ new (
29
+ __0_0: ListNamedShadowsForThingCommandInput
30
+ ): import("@smithy/smithy-client").CommandImpl<
31
+ ListNamedShadowsForThingCommandInput,
32
+ ListNamedShadowsForThingCommandOutput,
33
+ IoTDataPlaneClientResolvedConfig,
34
+ ServiceInputTypes,
35
+ ServiceOutputTypes
36
+ >;
28
37
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
29
38
  };
30
39
  export declare class ListNamedShadowsForThingCommand extends ListNamedShadowsForThingCommand_base {}
@@ -25,6 +25,15 @@ declare const ListRetainedMessagesCommand_base: {
25
25
  ServiceInputTypes,
26
26
  ServiceOutputTypes
27
27
  >;
28
+ new (
29
+ ...[input]: [] | [ListRetainedMessagesCommandInput]
30
+ ): import("@smithy/smithy-client").CommandImpl<
31
+ ListRetainedMessagesCommandInput,
32
+ ListRetainedMessagesCommandOutput,
33
+ IoTDataPlaneClientResolvedConfig,
34
+ ServiceInputTypes,
35
+ ServiceOutputTypes
36
+ >;
28
37
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
29
38
  };
30
39
  export declare class ListRetainedMessagesCommand extends ListRetainedMessagesCommand_base {}
@@ -26,6 +26,13 @@ declare const PublishCommand_base: {
26
26
  ServiceInputTypes,
27
27
  ServiceOutputTypes
28
28
  >;
29
+ new (__0_0: PublishCommandInput): import("@smithy/smithy-client").CommandImpl<
30
+ PublishCommandInput,
31
+ PublishCommandOutput,
32
+ IoTDataPlaneClientResolvedConfig,
33
+ ServiceInputTypes,
34
+ ServiceOutputTypes
35
+ >;
29
36
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
30
37
  };
31
38
  export declare class PublishCommand extends PublishCommand_base {}
@@ -41,6 +41,15 @@ declare const UpdateThingShadowCommand_base: {
41
41
  ServiceInputTypes,
42
42
  ServiceOutputTypes
43
43
  >;
44
+ new (
45
+ __0_0: UpdateThingShadowCommandInput
46
+ ): import("@smithy/smithy-client").CommandImpl<
47
+ UpdateThingShadowCommandInput,
48
+ UpdateThingShadowCommandOutput,
49
+ IoTDataPlaneClientResolvedConfig,
50
+ ServiceInputTypes,
51
+ ServiceOutputTypes
52
+ >;
44
53
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
45
54
  };
46
55
  export declare class UpdateThingShadowCommand extends UpdateThingShadowCommand_base {}
@@ -6,5 +6,4 @@ export { IoTDataPlaneExtensionConfiguration } from "./extensionConfiguration";
6
6
  export * from "./commands";
7
7
  export * from "./pagination";
8
8
  export * from "./models";
9
- import "@aws-sdk/util-endpoints";
10
9
  export { IoTDataPlaneServiceException } from "./models/IoTDataPlaneServiceException";
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-iot-data-plane",
3
3
  "description": "AWS SDK for JavaScript Iot Data Plane Client for Node.js, Browser and React Native",
4
- "version": "3.533.0",
4
+ "version": "3.540.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-iot-data-plane",
@@ -20,48 +20,48 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "3.0.0",
22
22
  "@aws-crypto/sha256-js": "3.0.0",
23
- "@aws-sdk/client-sts": "3.533.0",
24
- "@aws-sdk/core": "3.533.0",
25
- "@aws-sdk/credential-provider-node": "3.533.0",
26
- "@aws-sdk/middleware-host-header": "3.533.0",
27
- "@aws-sdk/middleware-logger": "3.533.0",
28
- "@aws-sdk/middleware-recursion-detection": "3.533.0",
29
- "@aws-sdk/middleware-user-agent": "3.533.0",
30
- "@aws-sdk/region-config-resolver": "3.533.0",
31
- "@aws-sdk/types": "3.533.0",
32
- "@aws-sdk/util-endpoints": "3.533.0",
33
- "@aws-sdk/util-user-agent-browser": "3.533.0",
34
- "@aws-sdk/util-user-agent-node": "3.533.0",
35
- "@smithy/config-resolver": "^2.1.5",
36
- "@smithy/core": "^1.3.8",
37
- "@smithy/fetch-http-handler": "^2.4.5",
38
- "@smithy/hash-node": "^2.1.4",
39
- "@smithy/invalid-dependency": "^2.1.4",
40
- "@smithy/middleware-content-length": "^2.1.4",
41
- "@smithy/middleware-endpoint": "^2.4.6",
42
- "@smithy/middleware-retry": "^2.1.7",
43
- "@smithy/middleware-serde": "^2.2.1",
44
- "@smithy/middleware-stack": "^2.1.4",
45
- "@smithy/node-config-provider": "^2.2.5",
46
- "@smithy/node-http-handler": "^2.4.3",
47
- "@smithy/protocol-http": "^3.2.2",
48
- "@smithy/smithy-client": "^2.4.5",
49
- "@smithy/types": "^2.11.0",
50
- "@smithy/url-parser": "^2.1.4",
51
- "@smithy/util-base64": "^2.2.1",
52
- "@smithy/util-body-length-browser": "^2.1.1",
53
- "@smithy/util-body-length-node": "^2.2.2",
54
- "@smithy/util-defaults-mode-browser": "^2.1.7",
55
- "@smithy/util-defaults-mode-node": "^2.2.7",
56
- "@smithy/util-endpoints": "^1.1.5",
57
- "@smithy/util-middleware": "^2.1.4",
58
- "@smithy/util-retry": "^2.1.4",
59
- "@smithy/util-stream": "^2.1.5",
60
- "@smithy/util-utf8": "^2.2.0",
61
- "tslib": "^2.5.0"
23
+ "@aws-sdk/client-sts": "3.540.0",
24
+ "@aws-sdk/core": "3.535.0",
25
+ "@aws-sdk/credential-provider-node": "3.540.0",
26
+ "@aws-sdk/middleware-host-header": "3.535.0",
27
+ "@aws-sdk/middleware-logger": "3.535.0",
28
+ "@aws-sdk/middleware-recursion-detection": "3.535.0",
29
+ "@aws-sdk/middleware-user-agent": "3.540.0",
30
+ "@aws-sdk/region-config-resolver": "3.535.0",
31
+ "@aws-sdk/types": "3.535.0",
32
+ "@aws-sdk/util-endpoints": "3.540.0",
33
+ "@aws-sdk/util-user-agent-browser": "3.535.0",
34
+ "@aws-sdk/util-user-agent-node": "3.535.0",
35
+ "@smithy/config-resolver": "^2.2.0",
36
+ "@smithy/core": "^1.4.0",
37
+ "@smithy/fetch-http-handler": "^2.5.0",
38
+ "@smithy/hash-node": "^2.2.0",
39
+ "@smithy/invalid-dependency": "^2.2.0",
40
+ "@smithy/middleware-content-length": "^2.2.0",
41
+ "@smithy/middleware-endpoint": "^2.5.0",
42
+ "@smithy/middleware-retry": "^2.2.0",
43
+ "@smithy/middleware-serde": "^2.3.0",
44
+ "@smithy/middleware-stack": "^2.2.0",
45
+ "@smithy/node-config-provider": "^2.3.0",
46
+ "@smithy/node-http-handler": "^2.5.0",
47
+ "@smithy/protocol-http": "^3.3.0",
48
+ "@smithy/smithy-client": "^2.5.0",
49
+ "@smithy/types": "^2.12.0",
50
+ "@smithy/url-parser": "^2.2.0",
51
+ "@smithy/util-base64": "^2.3.0",
52
+ "@smithy/util-body-length-browser": "^2.2.0",
53
+ "@smithy/util-body-length-node": "^2.3.0",
54
+ "@smithy/util-defaults-mode-browser": "^2.2.0",
55
+ "@smithy/util-defaults-mode-node": "^2.3.0",
56
+ "@smithy/util-endpoints": "^1.2.0",
57
+ "@smithy/util-middleware": "^2.2.0",
58
+ "@smithy/util-retry": "^2.2.0",
59
+ "@smithy/util-stream": "^2.2.0",
60
+ "@smithy/util-utf8": "^2.3.0",
61
+ "tslib": "^2.6.2"
62
62
  },
63
63
  "devDependencies": {
64
- "@smithy/service-client-documentation-generator": "^2.1.1",
64
+ "@smithy/service-client-documentation-generator": "^2.2.0",
65
65
  "@tsconfig/node14": "1.0.3",
66
66
  "@types/node": "^14.14.31",
67
67
  "concurrently": "7.0.0",