@aws-sdk/client-iot-data-plane 3.1054.0 → 3.1056.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.
Files changed (37) hide show
  1. package/README.md +21 -0
  2. package/dist-cjs/index.js +46 -0
  3. package/dist-cjs/models/errors.js +14 -1
  4. package/dist-cjs/schemas/schemas_0.js +83 -1
  5. package/dist-es/IoTDataPlane.js +8 -0
  6. package/dist-es/commands/GetConnectionCommand.js +16 -0
  7. package/dist-es/commands/ListSubscriptionsCommand.js +16 -0
  8. package/dist-es/commands/SendDirectMessageCommand.js +16 -0
  9. package/dist-es/commands/index.js +3 -0
  10. package/dist-es/models/errors.js +12 -0
  11. package/dist-es/pagination/ListSubscriptionsPaginator.js +4 -0
  12. package/dist-es/pagination/index.js +1 -0
  13. package/dist-es/schemas/schemas_0.js +83 -1
  14. package/dist-types/IoTDataPlane.d.ts +28 -0
  15. package/dist-types/IoTDataPlaneClient.d.ts +5 -2
  16. package/dist-types/commands/DeleteConnectionCommand.d.ts +1 -0
  17. package/dist-types/commands/GetConnectionCommand.d.ts +106 -0
  18. package/dist-types/commands/ListSubscriptionsCommand.d.ts +100 -0
  19. package/dist-types/commands/SendDirectMessageCommand.d.ts +122 -0
  20. package/dist-types/commands/index.d.ts +3 -0
  21. package/dist-types/models/errors.d.ts +12 -0
  22. package/dist-types/models/models_0.d.ts +259 -2
  23. package/dist-types/pagination/ListSubscriptionsPaginator.d.ts +7 -0
  24. package/dist-types/pagination/index.d.ts +1 -0
  25. package/dist-types/schemas/schemas_0.d.ts +11 -0
  26. package/dist-types/ts3.4/IoTDataPlane.d.ts +58 -0
  27. package/dist-types/ts3.4/IoTDataPlaneClient.d.ts +18 -0
  28. package/dist-types/ts3.4/commands/GetConnectionCommand.d.ts +52 -0
  29. package/dist-types/ts3.4/commands/ListSubscriptionsCommand.d.ts +53 -0
  30. package/dist-types/ts3.4/commands/SendDirectMessageCommand.d.ts +62 -0
  31. package/dist-types/ts3.4/commands/index.d.ts +3 -0
  32. package/dist-types/ts3.4/models/errors.d.ts +7 -0
  33. package/dist-types/ts3.4/models/models_0.d.ts +49 -0
  34. package/dist-types/ts3.4/pagination/ListSubscriptionsPaginator.d.ts +11 -0
  35. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  36. package/dist-types/ts3.4/schemas/schemas_0.d.ts +11 -0
  37. package/package.json +6 -6
@@ -5,9 +5,13 @@ const _DTS = "DeleteThingShadow";
5
5
  const _DTSR = "DeleteThingShadowRequest";
6
6
  const _DTSRe = "DeleteThingShadowResponse";
7
7
  const _FE = "ForbiddenException";
8
+ const _GC = "GetConnection";
9
+ const _GCR = "GetConnectionRequest";
10
+ const _GCRe = "GetConnectionResponse";
8
11
  const _GRM = "GetRetainedMessage";
9
12
  const _GRMR = "GetRetainedMessageRequest";
10
13
  const _GRMRe = "GetRetainedMessageResponse";
14
+ const _GTE = "GatewayTimeoutException";
11
15
  const _GTS = "GetThingShadow";
12
16
  const _GTSR = "GetThingShadowRequest";
13
17
  const _GTSRe = "GetThingShadowResponse";
@@ -19,6 +23,9 @@ const _LNSFTRi = "ListNamedShadowsForThingResponse";
19
23
  const _LRM = "ListRetainedMessages";
20
24
  const _LRMR = "ListRetainedMessagesRequest";
21
25
  const _LRMRi = "ListRetainedMessagesResponse";
26
+ const _LS = "ListSubscriptions";
27
+ const _LSR = "ListSubscriptionsRequest";
28
+ const _LSRi = "ListSubscriptionsResponse";
22
29
  const _MNAE = "MethodNotAllowedException";
23
30
  const _P = "Publish";
24
31
  const _PR = "PublishRequest";
@@ -26,7 +33,12 @@ const _RETLE = "RequestEntityTooLargeException";
26
33
  const _RML = "RetainedMessageList";
27
34
  const _RMS = "RetainedMessageSummary";
28
35
  const _RNFE = "ResourceNotFoundException";
36
+ const _SDM = "SendDirectMessage";
37
+ const _SDMR = "SendDirectMessageRequest";
38
+ const _SDMRe = "SendDirectMessageResponse";
29
39
  const _SJUP = "SynthesizedJsonUserProperties";
40
+ const _SL = "SubscriptionList";
41
+ const _SS = "SubscriptionSummary";
30
42
  const _SUE = "ServiceUnavailableException";
31
43
  const _TE = "ThrottlingException";
32
44
  const _UDEE = "UnsupportedDocumentEncodingException";
@@ -39,12 +51,19 @@ const _c = "client";
39
51
  const _cD = "correlationData";
40
52
  const _cI = "clientId";
41
53
  const _cS = "cleanSession";
54
+ const _cSo = "connectedSince";
42
55
  const _cT = "contentType";
56
+ const _co = "connected";
57
+ const _con = "confirmation";
58
+ const _dR = "disconnectReason";
59
+ const _dS = "disconnectedSince";
43
60
  const _e = "error";
44
61
  const _h = "http";
45
62
  const _hE = "httpError";
46
63
  const _hH = "httpHeader";
47
64
  const _hQ = "httpQuery";
65
+ const _iSI = "includeSocketInformation";
66
+ const _kAD = "keepAliveDuration";
48
67
  const _lMT = "lastModifiedTime";
49
68
  const _m = "message";
50
69
  const _mE = "messageExpiry";
@@ -63,18 +82,28 @@ const _rT = "retainedTopics";
63
82
  const _rTe = "responseTopic";
64
83
  const _re = "retain";
65
84
  const _s = "smithy.ts.sdk.synthetic.com.amazonaws.iotdataplane";
85
+ const _sE = "sessionExpiry";
86
+ const _sI = "sourceIp";
66
87
  const _sN = "shadowName";
88
+ const _sP = "sourcePort";
67
89
  const _se = "server";
90
+ const _su = "subscriptions";
68
91
  const _t = "topic";
92
+ const _tF = "topicFilter";
93
+ const _tI = "targetIp";
94
+ const _tIr = "traceId";
69
95
  const _tN = "thingName";
96
+ const _tP = "targetPort";
70
97
  const _ti = "timestamp";
98
+ const _tim = "timeout";
71
99
  const _uP = "userProperties";
100
+ const _vEI = "vpcEndpointId";
72
101
  const _xamcd = "x-amz-mqtt5-correlation-data";
73
102
  const _xampfi = "x-amz-mqtt5-payload-format-indicator";
74
103
  const _xamup = "x-amz-mqtt5-user-properties";
75
104
  const n0 = "com.amazonaws.iotdataplane";
76
105
  import { TypeRegistry } from "@smithy/core/schema";
77
- import { ConflictException, ForbiddenException, InternalFailureException, InvalidRequestException, MethodNotAllowedException, RequestEntityTooLargeException, ResourceNotFoundException, ServiceUnavailableException, ThrottlingException, UnauthorizedException, UnsupportedDocumentEncodingException, } from "../models/errors";
106
+ import { ConflictException, ForbiddenException, GatewayTimeoutException, InternalFailureException, InvalidRequestException, MethodNotAllowedException, RequestEntityTooLargeException, ResourceNotFoundException, ServiceUnavailableException, ThrottlingException, UnauthorizedException, UnsupportedDocumentEncodingException, } from "../models/errors";
78
107
  import { IoTDataPlaneServiceException } from "../models/IoTDataPlaneServiceException";
79
108
  const _s_registry = TypeRegistry.for(_s);
80
109
  export var IoTDataPlaneServiceException$ = [-3, _s, "IoTDataPlaneServiceException", 0, [], []];
@@ -92,6 +121,12 @@ export var ForbiddenException$ = [-3, n0, _FE,
92
121
  [0]
93
122
  ];
94
123
  n0_registry.registerError(ForbiddenException$, ForbiddenException);
124
+ export var GatewayTimeoutException$ = [-3, n0, _GTE,
125
+ { [_e]: _se, [_hE]: 504 },
126
+ [_m],
127
+ [0]
128
+ ];
129
+ n0_registry.registerError(GatewayTimeoutException$, GatewayTimeoutException);
95
130
  export var InternalFailureException$ = [-3, n0, _IFE,
96
131
  { [_e]: _se, [_hE]: 500 },
97
132
  [_m],
@@ -166,6 +201,16 @@ export var DeleteThingShadowResponse$ = [3, n0, _DTSRe,
166
201
  [_p],
167
202
  [[21, 16]], 1
168
203
  ];
204
+ export var GetConnectionRequest$ = [3, n0, _GCR,
205
+ 0,
206
+ [_cI, _iSI],
207
+ [[0, 1], [2, { [_hQ]: _iSI }]], 1
208
+ ];
209
+ export var GetConnectionResponse$ = [3, n0, _GCRe,
210
+ 0,
211
+ [_co, _tN, _cS, _sI, _sP, _tI, _tP, _kAD, _cSo, _dS, _dR, _sE, _cI, _vEI],
212
+ [2, 0, 2, 0, 1, 0, 1, 1, 1, 1, 0, 1, 0, 0]
213
+ ];
169
214
  export var GetRetainedMessageRequest$ = [3, n0, _GRMR,
170
215
  0,
171
216
  [_t],
@@ -206,6 +251,16 @@ export var ListRetainedMessagesResponse$ = [3, n0, _LRMRi,
206
251
  [_rT, _nT],
207
252
  [() => RetainedMessageList, 0]
208
253
  ];
254
+ export var ListSubscriptionsRequest$ = [3, n0, _LSR,
255
+ 0,
256
+ [_cI, _nT, _mR],
257
+ [[0, 1], [0, { [_hQ]: _nT }], [1, { [_hQ]: _mR }]], 1
258
+ ];
259
+ export var ListSubscriptionsResponse$ = [3, n0, _LSRi,
260
+ 0,
261
+ [_su, _nT],
262
+ [() => SubscriptionList, 0]
263
+ ];
209
264
  export var PublishRequest$ = [3, n0, _PR,
210
265
  0,
211
266
  [_t, _q, _re, _p, _uP, _pFI, _cT, _rTe, _cD, _mE],
@@ -216,6 +271,21 @@ export var RetainedMessageSummary$ = [3, n0, _RMS,
216
271
  [_t, _pSa, _q, _lMT],
217
272
  [0, 1, 1, 1]
218
273
  ];
274
+ export var SendDirectMessageRequest$ = [3, n0, _SDMR,
275
+ 0,
276
+ [_cI, _t, _cT, _rTe, _con, _tim, _p, _uP, _pFI, _cD],
277
+ [[0, 1], [0, { [_hQ]: _t }], [0, { [_hQ]: _cT }], [0, { [_hQ]: _rTe }], [2, { [_hQ]: _con }], [1, { [_hQ]: _tim }], [21, 16], [() => SynthesizedJsonUserProperties, { [_hH]: _xamup }], [0, { [_hH]: _xampfi }], [0, { [_hH]: _xamcd }]], 2
278
+ ];
279
+ export var SendDirectMessageResponse$ = [3, n0, _SDMRe,
280
+ 0,
281
+ [_m, _tIr],
282
+ [0, 0]
283
+ ];
284
+ export var SubscriptionSummary$ = [3, n0, _SS,
285
+ 0,
286
+ [_tF, _q],
287
+ [0, 1], 2
288
+ ];
219
289
  export var UpdateThingShadowRequest$ = [3, n0, _UTSR,
220
290
  0,
221
291
  [_tN, _p, _sN],
@@ -231,12 +301,18 @@ var NamedShadowList = 64 | 0;
231
301
  var RetainedMessageList = [1, n0, _RML,
232
302
  0, () => RetainedMessageSummary$
233
303
  ];
304
+ var SubscriptionList = [1, n0, _SL,
305
+ 0, () => SubscriptionSummary$
306
+ ];
234
307
  export var DeleteConnection$ = [9, n0, _DC,
235
308
  { [_h]: ["DELETE", "/connections/{clientId}", 200] }, () => DeleteConnectionRequest$, () => __Unit
236
309
  ];
237
310
  export var DeleteThingShadow$ = [9, n0, _DTS,
238
311
  { [_h]: ["DELETE", "/things/{thingName}/shadow", 200] }, () => DeleteThingShadowRequest$, () => DeleteThingShadowResponse$
239
312
  ];
313
+ export var GetConnection$ = [9, n0, _GC,
314
+ { [_h]: ["GET", "/connections/{clientId}", 200] }, () => GetConnectionRequest$, () => GetConnectionResponse$
315
+ ];
240
316
  export var GetRetainedMessage$ = [9, n0, _GRM,
241
317
  { [_h]: ["GET", "/retainedMessage/{topic}", 200] }, () => GetRetainedMessageRequest$, () => GetRetainedMessageResponse$
242
318
  ];
@@ -249,9 +325,15 @@ export var ListNamedShadowsForThing$ = [9, n0, _LNSFT,
249
325
  export var ListRetainedMessages$ = [9, n0, _LRM,
250
326
  { [_h]: ["GET", "/retainedMessage", 200] }, () => ListRetainedMessagesRequest$, () => ListRetainedMessagesResponse$
251
327
  ];
328
+ export var ListSubscriptions$ = [9, n0, _LS,
329
+ { [_h]: ["GET", "/connections/{clientId}/subscriptions", 200] }, () => ListSubscriptionsRequest$, () => ListSubscriptionsResponse$
330
+ ];
252
331
  export var Publish$ = [9, n0, _P,
253
332
  { [_h]: ["POST", "/topics/{topic}", 200] }, () => PublishRequest$, () => __Unit
254
333
  ];
334
+ export var SendDirectMessage$ = [9, n0, _SDM,
335
+ { [_h]: ["POST", "/connections/{clientId}/messages", 200] }, () => SendDirectMessageRequest$, () => SendDirectMessageResponse$
336
+ ];
255
337
  export var UpdateThingShadow$ = [9, n0, _UTS,
256
338
  { [_h]: ["POST", "/things/{thingName}/shadow", 200] }, () => UpdateThingShadowRequest$, () => UpdateThingShadowResponse$
257
339
  ];
@@ -1,11 +1,14 @@
1
1
  import type { HttpHandlerOptions as __HttpHandlerOptions, PaginationConfiguration, Paginator } from "@smithy/types";
2
2
  import { type DeleteConnectionCommandInput, type DeleteConnectionCommandOutput } from "./commands/DeleteConnectionCommand";
3
3
  import { type DeleteThingShadowCommandInput, type DeleteThingShadowCommandOutput } from "./commands/DeleteThingShadowCommand";
4
+ import { type GetConnectionCommandInput, type GetConnectionCommandOutput } from "./commands/GetConnectionCommand";
4
5
  import { type GetRetainedMessageCommandInput, type GetRetainedMessageCommandOutput } from "./commands/GetRetainedMessageCommand";
5
6
  import { type GetThingShadowCommandInput, type GetThingShadowCommandOutput } from "./commands/GetThingShadowCommand";
6
7
  import { type ListNamedShadowsForThingCommandInput, type ListNamedShadowsForThingCommandOutput } from "./commands/ListNamedShadowsForThingCommand";
7
8
  import { type ListRetainedMessagesCommandInput, type ListRetainedMessagesCommandOutput } from "./commands/ListRetainedMessagesCommand";
9
+ import { type ListSubscriptionsCommandInput, type ListSubscriptionsCommandOutput } from "./commands/ListSubscriptionsCommand";
8
10
  import { type PublishCommandInput, type PublishCommandOutput } from "./commands/PublishCommand";
11
+ import { type SendDirectMessageCommandInput, type SendDirectMessageCommandOutput } from "./commands/SendDirectMessageCommand";
9
12
  import { type UpdateThingShadowCommandInput, type UpdateThingShadowCommandOutput } from "./commands/UpdateThingShadowCommand";
10
13
  import { IoTDataPlaneClient } from "./IoTDataPlaneClient";
11
14
  export interface IoTDataPlane {
@@ -21,6 +24,12 @@ export interface IoTDataPlane {
21
24
  deleteThingShadow(args: DeleteThingShadowCommandInput, options?: __HttpHandlerOptions): Promise<DeleteThingShadowCommandOutput>;
22
25
  deleteThingShadow(args: DeleteThingShadowCommandInput, cb: (err: any, data?: DeleteThingShadowCommandOutput) => void): void;
23
26
  deleteThingShadow(args: DeleteThingShadowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteThingShadowCommandOutput) => void): void;
27
+ /**
28
+ * @see {@link GetConnectionCommand}
29
+ */
30
+ getConnection(args: GetConnectionCommandInput, options?: __HttpHandlerOptions): Promise<GetConnectionCommandOutput>;
31
+ getConnection(args: GetConnectionCommandInput, cb: (err: any, data?: GetConnectionCommandOutput) => void): void;
32
+ getConnection(args: GetConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetConnectionCommandOutput) => void): void;
24
33
  /**
25
34
  * @see {@link GetRetainedMessageCommand}
26
35
  */
@@ -46,12 +55,24 @@ export interface IoTDataPlane {
46
55
  listRetainedMessages(args: ListRetainedMessagesCommandInput, options?: __HttpHandlerOptions): Promise<ListRetainedMessagesCommandOutput>;
47
56
  listRetainedMessages(args: ListRetainedMessagesCommandInput, cb: (err: any, data?: ListRetainedMessagesCommandOutput) => void): void;
48
57
  listRetainedMessages(args: ListRetainedMessagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRetainedMessagesCommandOutput) => void): void;
58
+ /**
59
+ * @see {@link ListSubscriptionsCommand}
60
+ */
61
+ listSubscriptions(args: ListSubscriptionsCommandInput, options?: __HttpHandlerOptions): Promise<ListSubscriptionsCommandOutput>;
62
+ listSubscriptions(args: ListSubscriptionsCommandInput, cb: (err: any, data?: ListSubscriptionsCommandOutput) => void): void;
63
+ listSubscriptions(args: ListSubscriptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSubscriptionsCommandOutput) => void): void;
49
64
  /**
50
65
  * @see {@link PublishCommand}
51
66
  */
52
67
  publish(args: PublishCommandInput, options?: __HttpHandlerOptions): Promise<PublishCommandOutput>;
53
68
  publish(args: PublishCommandInput, cb: (err: any, data?: PublishCommandOutput) => void): void;
54
69
  publish(args: PublishCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PublishCommandOutput) => void): void;
70
+ /**
71
+ * @see {@link SendDirectMessageCommand}
72
+ */
73
+ sendDirectMessage(args: SendDirectMessageCommandInput, options?: __HttpHandlerOptions): Promise<SendDirectMessageCommandOutput>;
74
+ sendDirectMessage(args: SendDirectMessageCommandInput, cb: (err: any, data?: SendDirectMessageCommandOutput) => void): void;
75
+ sendDirectMessage(args: SendDirectMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendDirectMessageCommandOutput) => void): void;
55
76
  /**
56
77
  * @see {@link UpdateThingShadowCommand}
57
78
  */
@@ -65,6 +86,13 @@ export interface IoTDataPlane {
65
86
  * @returns AsyncIterable of {@link ListRetainedMessagesCommandOutput}.
66
87
  */
67
88
  paginateListRetainedMessages(args?: ListRetainedMessagesCommandInput, paginationConfig?: Omit<PaginationConfiguration, "client">): Paginator<ListRetainedMessagesCommandOutput>;
89
+ /**
90
+ * @see {@link ListSubscriptionsCommand}
91
+ * @param args - command input.
92
+ * @param paginationConfig - optional pagination config.
93
+ * @returns AsyncIterable of {@link ListSubscriptionsCommandOutput}.
94
+ */
95
+ paginateListSubscriptions(args: ListSubscriptionsCommandInput, paginationConfig?: Omit<PaginationConfiguration, "client">): Paginator<ListSubscriptionsCommandOutput>;
68
96
  }
69
97
  /**
70
98
  * <fullname>IoT data</fullname>
@@ -8,11 +8,14 @@ import type { AwsCredentialIdentityProvider, BodyLengthCalculator as __BodyLengt
8
8
  import { type HttpAuthSchemeInputConfig, type HttpAuthSchemeResolvedConfig } from "./auth/httpAuthSchemeProvider";
9
9
  import type { DeleteConnectionCommandInput, DeleteConnectionCommandOutput } from "./commands/DeleteConnectionCommand";
10
10
  import type { DeleteThingShadowCommandInput, DeleteThingShadowCommandOutput } from "./commands/DeleteThingShadowCommand";
11
+ import type { GetConnectionCommandInput, GetConnectionCommandOutput } from "./commands/GetConnectionCommand";
11
12
  import type { GetRetainedMessageCommandInput, GetRetainedMessageCommandOutput } from "./commands/GetRetainedMessageCommand";
12
13
  import type { GetThingShadowCommandInput, GetThingShadowCommandOutput } from "./commands/GetThingShadowCommand";
13
14
  import type { ListNamedShadowsForThingCommandInput, ListNamedShadowsForThingCommandOutput } from "./commands/ListNamedShadowsForThingCommand";
14
15
  import type { ListRetainedMessagesCommandInput, ListRetainedMessagesCommandOutput } from "./commands/ListRetainedMessagesCommand";
16
+ import type { ListSubscriptionsCommandInput, ListSubscriptionsCommandOutput } from "./commands/ListSubscriptionsCommand";
15
17
  import type { PublishCommandInput, PublishCommandOutput } from "./commands/PublishCommand";
18
+ import type { SendDirectMessageCommandInput, SendDirectMessageCommandOutput } from "./commands/SendDirectMessageCommand";
16
19
  import type { UpdateThingShadowCommandInput, UpdateThingShadowCommandOutput } from "./commands/UpdateThingShadowCommand";
17
20
  import { type ClientInputEndpointParameters, type ClientResolvedEndpointParameters, type EndpointParameters } from "./endpoint/EndpointParameters";
18
21
  import { type RuntimeExtension, type RuntimeExtensionsConfig } from "./runtimeExtensions";
@@ -20,11 +23,11 @@ export { __Client };
20
23
  /**
21
24
  * @public
22
25
  */
23
- export type ServiceInputTypes = DeleteConnectionCommandInput | DeleteThingShadowCommandInput | GetRetainedMessageCommandInput | GetThingShadowCommandInput | ListNamedShadowsForThingCommandInput | ListRetainedMessagesCommandInput | PublishCommandInput | UpdateThingShadowCommandInput;
26
+ export type ServiceInputTypes = DeleteConnectionCommandInput | DeleteThingShadowCommandInput | GetConnectionCommandInput | GetRetainedMessageCommandInput | GetThingShadowCommandInput | ListNamedShadowsForThingCommandInput | ListRetainedMessagesCommandInput | ListSubscriptionsCommandInput | PublishCommandInput | SendDirectMessageCommandInput | UpdateThingShadowCommandInput;
24
27
  /**
25
28
  * @public
26
29
  */
27
- export type ServiceOutputTypes = DeleteConnectionCommandOutput | DeleteThingShadowCommandOutput | GetRetainedMessageCommandOutput | GetThingShadowCommandOutput | ListNamedShadowsForThingCommandOutput | ListRetainedMessagesCommandOutput | PublishCommandOutput | UpdateThingShadowCommandOutput;
30
+ export type ServiceOutputTypes = DeleteConnectionCommandOutput | DeleteThingShadowCommandOutput | GetConnectionCommandOutput | GetRetainedMessageCommandOutput | GetThingShadowCommandOutput | ListNamedShadowsForThingCommandOutput | ListRetainedMessagesCommandOutput | ListSubscriptionsCommandOutput | PublishCommandOutput | SendDirectMessageCommandOutput | UpdateThingShadowCommandOutput;
28
31
  /**
29
32
  * @public
30
33
  */
@@ -30,6 +30,7 @@ declare const DeleteConnectionCommand_base: {
30
30
  };
31
31
  /**
32
32
  * <p>Disconnects a connected MQTT client from Amazon Web Services IoT Core. When you disconnect a client, Amazon Web Services IoT Core closes the client's network connection and optionally cleans the session state.</p>
33
+ * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DeleteConnection</a> action.</p>
33
34
  * @example
34
35
  * Use a bare-bones client and the command you need to make an API call.
35
36
  * ```javascript
@@ -0,0 +1,106 @@
1
+ import { Command as $Command } from "@smithy/core/client";
2
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import type { IoTDataPlaneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTDataPlaneClient";
4
+ import type { GetConnectionRequest, GetConnectionResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link GetConnectionCommand}.
14
+ */
15
+ export interface GetConnectionCommandInput extends GetConnectionRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetConnectionCommand}.
21
+ */
22
+ export interface GetConnectionCommandOutput extends GetConnectionResponse, __MetadataBearer {
23
+ }
24
+ declare const GetConnectionCommand_base: {
25
+ new (input: GetConnectionCommandInput): import("@smithy/core/client").CommandImpl<GetConnectionCommandInput, GetConnectionCommandOutput, IoTDataPlaneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: GetConnectionCommandInput): import("@smithy/core/client").CommandImpl<GetConnectionCommandInput, GetConnectionCommandOutput, IoTDataPlaneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): {
28
+ [x: string]: unknown;
29
+ };
30
+ };
31
+ /**
32
+ * <p>Retrieves connection information for the specified MQTT client.</p>
33
+ * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">GetConnection</a> action.</p>
34
+ * @example
35
+ * Use a bare-bones client and the command you need to make an API call.
36
+ * ```javascript
37
+ * import { IoTDataPlaneClient, GetConnectionCommand } from "@aws-sdk/client-iot-data-plane"; // ES Modules import
38
+ * // const { IoTDataPlaneClient, GetConnectionCommand } = require("@aws-sdk/client-iot-data-plane"); // CommonJS import
39
+ * // import type { IoTDataPlaneClientConfig } from "@aws-sdk/client-iot-data-plane";
40
+ * const config = {}; // type is IoTDataPlaneClientConfig
41
+ * const client = new IoTDataPlaneClient(config);
42
+ * const input = { // GetConnectionRequest
43
+ * clientId: "STRING_VALUE", // required
44
+ * includeSocketInformation: true || false,
45
+ * };
46
+ * const command = new GetConnectionCommand(input);
47
+ * const response = await client.send(command);
48
+ * // { // GetConnectionResponse
49
+ * // connected: true || false,
50
+ * // thingName: "STRING_VALUE",
51
+ * // cleanSession: true || false,
52
+ * // sourceIp: "STRING_VALUE",
53
+ * // sourcePort: Number("int"),
54
+ * // targetIp: "STRING_VALUE",
55
+ * // targetPort: Number("int"),
56
+ * // keepAliveDuration: Number("int"),
57
+ * // connectedSince: Number("long"),
58
+ * // disconnectedSince: Number("long"),
59
+ * // disconnectReason: "STRING_VALUE",
60
+ * // sessionExpiry: Number("long"),
61
+ * // clientId: "STRING_VALUE",
62
+ * // vpcEndpointId: "STRING_VALUE",
63
+ * // };
64
+ *
65
+ * ```
66
+ *
67
+ * @param GetConnectionCommandInput - {@link GetConnectionCommandInput}
68
+ * @returns {@link GetConnectionCommandOutput}
69
+ * @see {@link GetConnectionCommandInput} for command's `input` shape.
70
+ * @see {@link GetConnectionCommandOutput} for command's `response` shape.
71
+ * @see {@link IoTDataPlaneClientResolvedConfig | config} for IoTDataPlaneClient's `config` shape.
72
+ *
73
+ * @throws {@link ForbiddenException} (client fault)
74
+ * <p>The caller isn't authorized to make the request.</p>
75
+ *
76
+ * @throws {@link InternalFailureException} (server fault)
77
+ * <p>An unexpected error has occurred.</p>
78
+ *
79
+ * @throws {@link InvalidRequestException} (client fault)
80
+ * <p>The request is not valid.</p>
81
+ *
82
+ * @throws {@link ResourceNotFoundException} (client fault)
83
+ * <p>The specified resource does not exist.</p>
84
+ *
85
+ * @throws {@link ThrottlingException} (client fault)
86
+ * <p>The rate exceeds the limit.</p>
87
+ *
88
+ * @throws {@link IoTDataPlaneServiceException}
89
+ * <p>Base exception class for all service exceptions from IoTDataPlane service.</p>
90
+ *
91
+ *
92
+ * @public
93
+ */
94
+ export declare class GetConnectionCommand extends GetConnectionCommand_base {
95
+ /** @internal type navigation helper, not in runtime. */
96
+ protected static __types: {
97
+ api: {
98
+ input: GetConnectionRequest;
99
+ output: GetConnectionResponse;
100
+ };
101
+ sdk: {
102
+ input: GetConnectionCommandInput;
103
+ output: GetConnectionCommandOutput;
104
+ };
105
+ };
106
+ }
@@ -0,0 +1,100 @@
1
+ import { Command as $Command } from "@smithy/core/client";
2
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import type { IoTDataPlaneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTDataPlaneClient";
4
+ import type { ListSubscriptionsRequest, ListSubscriptionsResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link ListSubscriptionsCommand}.
14
+ */
15
+ export interface ListSubscriptionsCommandInput extends ListSubscriptionsRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link ListSubscriptionsCommand}.
21
+ */
22
+ export interface ListSubscriptionsCommandOutput extends ListSubscriptionsResponse, __MetadataBearer {
23
+ }
24
+ declare const ListSubscriptionsCommand_base: {
25
+ new (input: ListSubscriptionsCommandInput): import("@smithy/core/client").CommandImpl<ListSubscriptionsCommandInput, ListSubscriptionsCommandOutput, IoTDataPlaneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: ListSubscriptionsCommandInput): import("@smithy/core/client").CommandImpl<ListSubscriptionsCommandInput, ListSubscriptionsCommandOutput, IoTDataPlaneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): {
28
+ [x: string]: unknown;
29
+ };
30
+ };
31
+ /**
32
+ * <p>Returns a list of all subscriptions for MQTT clients with active sessions, including offline clients with persistent sessions.</p>
33
+ * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListSubscriptions</a> action.</p>
34
+ * @example
35
+ * Use a bare-bones client and the command you need to make an API call.
36
+ * ```javascript
37
+ * import { IoTDataPlaneClient, ListSubscriptionsCommand } from "@aws-sdk/client-iot-data-plane"; // ES Modules import
38
+ * // const { IoTDataPlaneClient, ListSubscriptionsCommand } = require("@aws-sdk/client-iot-data-plane"); // CommonJS import
39
+ * // import type { IoTDataPlaneClientConfig } from "@aws-sdk/client-iot-data-plane";
40
+ * const config = {}; // type is IoTDataPlaneClientConfig
41
+ * const client = new IoTDataPlaneClient(config);
42
+ * const input = { // ListSubscriptionsRequest
43
+ * clientId: "STRING_VALUE", // required
44
+ * nextToken: "STRING_VALUE",
45
+ * maxResults: Number("int"),
46
+ * };
47
+ * const command = new ListSubscriptionsCommand(input);
48
+ * const response = await client.send(command);
49
+ * // { // ListSubscriptionsResponse
50
+ * // subscriptions: [ // SubscriptionList
51
+ * // { // SubscriptionSummary
52
+ * // topicFilter: "STRING_VALUE", // required
53
+ * // qos: Number("int"), // required
54
+ * // },
55
+ * // ],
56
+ * // nextToken: "STRING_VALUE",
57
+ * // };
58
+ *
59
+ * ```
60
+ *
61
+ * @param ListSubscriptionsCommandInput - {@link ListSubscriptionsCommandInput}
62
+ * @returns {@link ListSubscriptionsCommandOutput}
63
+ * @see {@link ListSubscriptionsCommandInput} for command's `input` shape.
64
+ * @see {@link ListSubscriptionsCommandOutput} for command's `response` shape.
65
+ * @see {@link IoTDataPlaneClientResolvedConfig | config} for IoTDataPlaneClient's `config` shape.
66
+ *
67
+ * @throws {@link ForbiddenException} (client fault)
68
+ * <p>The caller isn't authorized to make the request.</p>
69
+ *
70
+ * @throws {@link InternalFailureException} (server fault)
71
+ * <p>An unexpected error has occurred.</p>
72
+ *
73
+ * @throws {@link InvalidRequestException} (client fault)
74
+ * <p>The request is not valid.</p>
75
+ *
76
+ * @throws {@link ResourceNotFoundException} (client fault)
77
+ * <p>The specified resource does not exist.</p>
78
+ *
79
+ * @throws {@link ThrottlingException} (client fault)
80
+ * <p>The rate exceeds the limit.</p>
81
+ *
82
+ * @throws {@link IoTDataPlaneServiceException}
83
+ * <p>Base exception class for all service exceptions from IoTDataPlane service.</p>
84
+ *
85
+ *
86
+ * @public
87
+ */
88
+ export declare class ListSubscriptionsCommand extends ListSubscriptionsCommand_base {
89
+ /** @internal type navigation helper, not in runtime. */
90
+ protected static __types: {
91
+ api: {
92
+ input: ListSubscriptionsRequest;
93
+ output: ListSubscriptionsResponse;
94
+ };
95
+ sdk: {
96
+ input: ListSubscriptionsCommandInput;
97
+ output: ListSubscriptionsCommandOutput;
98
+ };
99
+ };
100
+ }
@@ -0,0 +1,122 @@
1
+ import { Command as $Command } from "@smithy/core/client";
2
+ import type { BlobPayloadInputTypes, MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import type { IoTDataPlaneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTDataPlaneClient";
4
+ import type { SendDirectMessageRequest, SendDirectMessageResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ */
13
+ export type SendDirectMessageCommandInputType = Omit<SendDirectMessageRequest, "payload"> & {
14
+ payload?: BlobPayloadInputTypes;
15
+ };
16
+ /**
17
+ * @public
18
+ *
19
+ * The input for {@link SendDirectMessageCommand}.
20
+ */
21
+ export interface SendDirectMessageCommandInput extends SendDirectMessageCommandInputType {
22
+ }
23
+ /**
24
+ * @public
25
+ *
26
+ * The output of {@link SendDirectMessageCommand}.
27
+ */
28
+ export interface SendDirectMessageCommandOutput extends SendDirectMessageResponse, __MetadataBearer {
29
+ }
30
+ declare const SendDirectMessageCommand_base: {
31
+ new (input: SendDirectMessageCommandInput): import("@smithy/core/client").CommandImpl<SendDirectMessageCommandInput, SendDirectMessageCommandOutput, IoTDataPlaneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
32
+ new (input: SendDirectMessageCommandInput): import("@smithy/core/client").CommandImpl<SendDirectMessageCommandInput, SendDirectMessageCommandOutput, IoTDataPlaneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
33
+ getEndpointParameterInstructions(): {
34
+ [x: string]: unknown;
35
+ };
36
+ };
37
+ /**
38
+ * <p>Sends an MQTT message directly to a specific client identified by its client ID.</p>
39
+ * <p>
40
+ * <code>SendDirectMessage</code> targets a single client ID. The receiving client does not
41
+ * need to subscribe to the topic, but the receiver's policy must allow <code>iot:Receive</code> on the specified topic.</p>
42
+ * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">SendDirectMessage</a> action.</p>
43
+ * <p>For more information about messaging costs, see <a href="http://aws.amazon.com/iot-core/pricing/">Amazon Web Services IoT Core
44
+ * pricing</a>.</p>
45
+ * @example
46
+ * Use a bare-bones client and the command you need to make an API call.
47
+ * ```javascript
48
+ * import { IoTDataPlaneClient, SendDirectMessageCommand } from "@aws-sdk/client-iot-data-plane"; // ES Modules import
49
+ * // const { IoTDataPlaneClient, SendDirectMessageCommand } = require("@aws-sdk/client-iot-data-plane"); // CommonJS import
50
+ * // import type { IoTDataPlaneClientConfig } from "@aws-sdk/client-iot-data-plane";
51
+ * const config = {}; // type is IoTDataPlaneClientConfig
52
+ * const client = new IoTDataPlaneClient(config);
53
+ * const input = { // SendDirectMessageRequest
54
+ * clientId: "STRING_VALUE", // required
55
+ * topic: "STRING_VALUE", // required
56
+ * contentType: "STRING_VALUE",
57
+ * responseTopic: "STRING_VALUE",
58
+ * confirmation: true || false,
59
+ * timeout: Number("int"),
60
+ * payload: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
61
+ * userProperties: "STRING_VALUE",
62
+ * payloadFormatIndicator: "UNSPECIFIED_BYTES" || "UTF8_DATA",
63
+ * correlationData: "STRING_VALUE",
64
+ * };
65
+ * const command = new SendDirectMessageCommand(input);
66
+ * const response = await client.send(command);
67
+ * // { // SendDirectMessageResponse
68
+ * // message: "STRING_VALUE",
69
+ * // traceId: "STRING_VALUE",
70
+ * // };
71
+ *
72
+ * ```
73
+ *
74
+ * @param SendDirectMessageCommandInput - {@link SendDirectMessageCommandInput}
75
+ * @returns {@link SendDirectMessageCommandOutput}
76
+ * @see {@link SendDirectMessageCommandInput} for command's `input` shape.
77
+ * @see {@link SendDirectMessageCommandOutput} for command's `response` shape.
78
+ * @see {@link IoTDataPlaneClientResolvedConfig | config} for IoTDataPlaneClient's `config` shape.
79
+ *
80
+ * @throws {@link ForbiddenException} (client fault)
81
+ * <p>The caller isn't authorized to make the request.</p>
82
+ *
83
+ * @throws {@link GatewayTimeoutException} (server fault)
84
+ * <p>The delivery confirmation was not received from the client within the specified timeout period.</p>
85
+ *
86
+ * @throws {@link InternalFailureException} (server fault)
87
+ * <p>An unexpected error has occurred.</p>
88
+ *
89
+ * @throws {@link InvalidRequestException} (client fault)
90
+ * <p>The request is not valid.</p>
91
+ *
92
+ * @throws {@link RequestEntityTooLargeException} (client fault)
93
+ * <p>The payload exceeds the maximum size allowed.</p>
94
+ *
95
+ * @throws {@link ResourceNotFoundException} (client fault)
96
+ * <p>The specified resource does not exist.</p>
97
+ *
98
+ * @throws {@link ThrottlingException} (client fault)
99
+ * <p>The rate exceeds the limit.</p>
100
+ *
101
+ * @throws {@link UnauthorizedException} (client fault)
102
+ * <p>You are not authorized to perform this operation.</p>
103
+ *
104
+ * @throws {@link IoTDataPlaneServiceException}
105
+ * <p>Base exception class for all service exceptions from IoTDataPlane service.</p>
106
+ *
107
+ *
108
+ * @public
109
+ */
110
+ export declare class SendDirectMessageCommand extends SendDirectMessageCommand_base {
111
+ /** @internal type navigation helper, not in runtime. */
112
+ protected static __types: {
113
+ api: {
114
+ input: SendDirectMessageRequest;
115
+ output: SendDirectMessageResponse;
116
+ };
117
+ sdk: {
118
+ input: SendDirectMessageCommandInput;
119
+ output: SendDirectMessageCommandOutput;
120
+ };
121
+ };
122
+ }
@@ -1,8 +1,11 @@
1
1
  export * from "./DeleteConnectionCommand";
2
2
  export * from "./DeleteThingShadowCommand";
3
+ export * from "./GetConnectionCommand";
3
4
  export * from "./GetRetainedMessageCommand";
4
5
  export * from "./GetThingShadowCommand";
5
6
  export * from "./ListNamedShadowsForThingCommand";
6
7
  export * from "./ListRetainedMessagesCommand";
8
+ export * from "./ListSubscriptionsCommand";
7
9
  export * from "./PublishCommand";
10
+ export * from "./SendDirectMessageCommand";
8
11
  export * from "./UpdateThingShadowCommand";
@@ -120,6 +120,18 @@ export declare class UnsupportedDocumentEncodingException extends __BaseExceptio
120
120
  */
121
121
  constructor(opts: __ExceptionOptionType<UnsupportedDocumentEncodingException, __BaseException>);
122
122
  }
123
+ /**
124
+ * <p>The delivery confirmation was not received from the client within the specified timeout period.</p>
125
+ * @public
126
+ */
127
+ export declare class GatewayTimeoutException extends __BaseException {
128
+ readonly name: "GatewayTimeoutException";
129
+ readonly $fault: "server";
130
+ /**
131
+ * @internal
132
+ */
133
+ constructor(opts: __ExceptionOptionType<GatewayTimeoutException, __BaseException>);
134
+ }
123
135
  /**
124
136
  * <p>The payload exceeds the maximum size allowed.</p>
125
137
  * @public