@aws-sdk/client-iot-data-plane 3.35.0 → 3.38.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 (130) hide show
  1. package/CHANGELOG.md +47 -0
  2. package/dist-cjs/IoTDataPlane.js +0 -14
  3. package/dist-cjs/IoTDataPlaneClient.js +0 -19
  4. package/dist-cjs/commands/DeleteThingShadowCommand.js +0 -27
  5. package/dist-cjs/commands/GetRetainedMessageCommand.js +0 -31
  6. package/dist-cjs/commands/GetThingShadowCommand.js +0 -28
  7. package/dist-cjs/commands/ListNamedShadowsForThingCommand.js +0 -26
  8. package/dist-cjs/commands/ListRetainedMessagesCommand.js +0 -34
  9. package/dist-cjs/commands/PublishCommand.js +0 -31
  10. package/dist-cjs/commands/UpdateThingShadowCommand.js +0 -28
  11. package/dist-cjs/commands/index.js +10 -0
  12. package/dist-cjs/endpoints.js +1 -2
  13. package/dist-cjs/index.js +4 -12
  14. package/dist-cjs/models/index.js +0 -1
  15. package/dist-cjs/models/models_0.js +0 -73
  16. package/dist-cjs/pagination/Interfaces.js +0 -1
  17. package/dist-cjs/pagination/ListRetainedMessagesPaginator.js +0 -11
  18. package/dist-cjs/pagination/index.js +5 -0
  19. package/dist-cjs/protocols/Aws_restJson1.js +0 -6
  20. package/dist-cjs/runtimeConfig.browser.js +1 -6
  21. package/dist-cjs/runtimeConfig.js +2 -7
  22. package/dist-cjs/runtimeConfig.native.js +0 -4
  23. package/dist-cjs/runtimeConfig.shared.js +0 -4
  24. package/dist-es/IoTDataPlane.js +0 -1
  25. package/dist-es/IoTDataPlaneClient.js +0 -1
  26. package/dist-es/commands/DeleteThingShadowCommand.js +0 -1
  27. package/dist-es/commands/GetRetainedMessageCommand.js +0 -1
  28. package/dist-es/commands/GetThingShadowCommand.js +0 -1
  29. package/dist-es/commands/ListNamedShadowsForThingCommand.js +0 -1
  30. package/dist-es/commands/ListRetainedMessagesCommand.js +0 -1
  31. package/dist-es/commands/PublishCommand.js +0 -1
  32. package/dist-es/commands/UpdateThingShadowCommand.js +0 -1
  33. package/dist-es/commands/index.js +7 -0
  34. package/dist-es/endpoints.js +1 -2
  35. package/dist-es/index.js +4 -12
  36. package/dist-es/models/index.js +0 -1
  37. package/dist-es/models/models_0.js +0 -1
  38. package/dist-es/pagination/Interfaces.js +0 -1
  39. package/dist-es/pagination/ListRetainedMessagesPaginator.js +0 -1
  40. package/dist-es/pagination/index.js +2 -0
  41. package/dist-es/protocols/Aws_restJson1.js +0 -1
  42. package/dist-es/runtimeConfig.browser.js +1 -2
  43. package/dist-es/runtimeConfig.js +2 -3
  44. package/dist-es/runtimeConfig.native.js +0 -1
  45. package/dist-es/runtimeConfig.shared.js +0 -1
  46. package/dist-types/commands/index.d.ts +7 -0
  47. package/dist-types/index.d.ts +4 -11
  48. package/dist-types/pagination/index.d.ts +2 -0
  49. package/dist-types/ts3.4/IoTDataPlane.d.ts +8 -64
  50. package/dist-types/ts3.4/IoTDataPlaneClient.d.ts +24 -99
  51. package/dist-types/ts3.4/commands/DeleteThingShadowCommand.d.ts +2 -22
  52. package/dist-types/ts3.4/commands/GetRetainedMessageCommand.d.ts +2 -26
  53. package/dist-types/ts3.4/commands/GetThingShadowCommand.d.ts +2 -23
  54. package/dist-types/ts3.4/commands/ListNamedShadowsForThingCommand.d.ts +2 -21
  55. package/dist-types/ts3.4/commands/ListRetainedMessagesCommand.d.ts +2 -29
  56. package/dist-types/ts3.4/commands/PublishCommand.d.ts +2 -26
  57. package/dist-types/ts3.4/commands/UpdateThingShadowCommand.d.ts +2 -23
  58. package/dist-types/ts3.4/commands/index.d.ts +7 -0
  59. package/dist-types/ts3.4/index.d.ts +4 -11
  60. package/dist-types/ts3.4/models/models_0.d.ts +87 -271
  61. package/dist-types/ts3.4/pagination/index.d.ts +2 -0
  62. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -3
  63. package/dist-types/ts3.4/runtimeConfig.d.ts +1 -3
  64. package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -3
  65. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +1 -3
  66. package/package.json +33 -30
  67. package/dist-cjs/IoTDataPlane.js.map +0 -1
  68. package/dist-cjs/IoTDataPlaneClient.js.map +0 -1
  69. package/dist-cjs/commands/DeleteThingShadowCommand.js.map +0 -1
  70. package/dist-cjs/commands/GetRetainedMessageCommand.js.map +0 -1
  71. package/dist-cjs/commands/GetThingShadowCommand.js.map +0 -1
  72. package/dist-cjs/commands/ListNamedShadowsForThingCommand.js.map +0 -1
  73. package/dist-cjs/commands/ListRetainedMessagesCommand.js.map +0 -1
  74. package/dist-cjs/commands/PublishCommand.js.map +0 -1
  75. package/dist-cjs/commands/UpdateThingShadowCommand.js.map +0 -1
  76. package/dist-cjs/endpoints.js.map +0 -1
  77. package/dist-cjs/index.js.map +0 -1
  78. package/dist-cjs/models/index.js.map +0 -1
  79. package/dist-cjs/models/models_0.js.map +0 -1
  80. package/dist-cjs/pagination/Interfaces.js.map +0 -1
  81. package/dist-cjs/pagination/ListRetainedMessagesPaginator.js.map +0 -1
  82. package/dist-cjs/protocols/Aws_restJson1.js.map +0 -1
  83. package/dist-cjs/runtimeConfig.browser.js.map +0 -1
  84. package/dist-cjs/runtimeConfig.js.map +0 -1
  85. package/dist-cjs/runtimeConfig.native.js.map +0 -1
  86. package/dist-cjs/runtimeConfig.shared.js.map +0 -1
  87. package/dist-es/IoTDataPlane.js.map +0 -1
  88. package/dist-es/IoTDataPlaneClient.js.map +0 -1
  89. package/dist-es/commands/DeleteThingShadowCommand.js.map +0 -1
  90. package/dist-es/commands/GetRetainedMessageCommand.js.map +0 -1
  91. package/dist-es/commands/GetThingShadowCommand.js.map +0 -1
  92. package/dist-es/commands/ListNamedShadowsForThingCommand.js.map +0 -1
  93. package/dist-es/commands/ListRetainedMessagesCommand.js.map +0 -1
  94. package/dist-es/commands/PublishCommand.js.map +0 -1
  95. package/dist-es/commands/UpdateThingShadowCommand.js.map +0 -1
  96. package/dist-es/endpoints.js.map +0 -1
  97. package/dist-es/index.js.map +0 -1
  98. package/dist-es/models/index.js.map +0 -1
  99. package/dist-es/models/models_0.js.map +0 -1
  100. package/dist-es/pagination/Interfaces.js.map +0 -1
  101. package/dist-es/pagination/ListRetainedMessagesPaginator.js.map +0 -1
  102. package/dist-es/protocols/Aws_restJson1.js.map +0 -1
  103. package/dist-es/runtimeConfig.browser.js.map +0 -1
  104. package/dist-es/runtimeConfig.js.map +0 -1
  105. package/dist-es/runtimeConfig.native.js.map +0 -1
  106. package/dist-es/runtimeConfig.shared.js.map +0 -1
  107. package/jest.config.js +0 -4
  108. package/src/IoTDataPlane.ts +0 -297
  109. package/src/IoTDataPlaneClient.ts +0 -273
  110. package/src/commands/DeleteThingShadowCommand.ts +0 -97
  111. package/src/commands/GetRetainedMessageCommand.ts +0 -101
  112. package/src/commands/GetThingShadowCommand.ts +0 -98
  113. package/src/commands/ListNamedShadowsForThingCommand.ts +0 -96
  114. package/src/commands/ListRetainedMessagesCommand.ts +0 -104
  115. package/src/commands/PublishCommand.ts +0 -101
  116. package/src/commands/UpdateThingShadowCommand.ts +0 -98
  117. package/src/endpoints.ts +0 -91
  118. package/src/index.ts +0 -12
  119. package/src/models/index.ts +0 -1
  120. package/src/models/models_0.ts +0 -570
  121. package/src/pagination/Interfaces.ts +0 -8
  122. package/src/pagination/ListRetainedMessagesPaginator.ts +0 -59
  123. package/src/protocols/Aws_restJson1.ts +0 -1281
  124. package/src/runtimeConfig.browser.ts +0 -41
  125. package/src/runtimeConfig.native.ts +0 -17
  126. package/src/runtimeConfig.shared.ts +0 -17
  127. package/src/runtimeConfig.ts +0 -46
  128. package/tsconfig.es.json +0 -10
  129. package/tsconfig.json +0 -33
  130. package/tsconfig.types.json +0 -9
@@ -7,89 +7,33 @@ import { ListRetainedMessagesCommandInput, ListRetainedMessagesCommandOutput } f
7
7
  import { PublishCommandInput, PublishCommandOutput } from "./commands/PublishCommand";
8
8
  import { UpdateThingShadowCommandInput, UpdateThingShadowCommandOutput } from "./commands/UpdateThingShadowCommand";
9
9
  import { IoTDataPlaneClient } from "./IoTDataPlaneClient";
10
- /**
11
- * <fullname>IoT data</fullname>
12
- * <p>IoT data enables secure, bi-directional communication between Internet-connected things (such as sensors,
13
- * actuators, embedded devices, or smart appliances) and the Amazon Web Services cloud. It implements a broker for applications and
14
- * things to publish messages over HTTP (Publish) and retrieve, update, and delete shadows. A shadow is a
15
- * persistent representation of your things and their state in the Amazon Web Services cloud.</p>
16
- * <p>Find the endpoint address for actions in IoT data by running this CLI command:</p>
17
- * <p>
18
- * <code>aws iot describe-endpoint --endpoint-type iot:Data-ATS</code>
19
- * </p>
20
- * <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>
21
- * to sign requests is: <i>iotdevicegateway</i>.</p>
22
- */
10
+
23
11
  export declare class IoTDataPlane extends IoTDataPlaneClient {
24
- /**
25
- * <p>Deletes the shadow for the specified thing.</p>
26
- * <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>
27
- * <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>
28
- */
12
+
29
13
  deleteThingShadow(args: DeleteThingShadowCommandInput, options?: __HttpHandlerOptions): Promise<DeleteThingShadowCommandOutput>;
30
14
  deleteThingShadow(args: DeleteThingShadowCommandInput, cb: (err: any, data?: DeleteThingShadowCommandOutput) => void): void;
31
15
  deleteThingShadow(args: DeleteThingShadowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteThingShadowCommandOutput) => void): void;
32
- /**
33
- * <p>Gets the details of a single retained message for the specified topic.</p>
34
- * <p>This action returns the message payload of the retained message, which can
35
- * incur messaging costs. To list only the topic names of the retained messages, call
36
- * <a href="/iot/latest/developerguide/API_iotdata_ListRetainedMessages.html">ListRetainedMessages</a>.</p>
37
- * <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>
38
- * <p>For more information about messaging costs, see <a href="http://aws.amazon.com/iot-core/pricing/#Messaging">IoT Core
39
- * pricing - Messaging</a>.</p>
40
- */
16
+
41
17
  getRetainedMessage(args: GetRetainedMessageCommandInput, options?: __HttpHandlerOptions): Promise<GetRetainedMessageCommandOutput>;
42
18
  getRetainedMessage(args: GetRetainedMessageCommandInput, cb: (err: any, data?: GetRetainedMessageCommandOutput) => void): void;
43
19
  getRetainedMessage(args: GetRetainedMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRetainedMessageCommandOutput) => void): void;
44
- /**
45
- * <p>Gets the shadow for the specified thing.</p>
46
- * <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>
47
- * <p>For more information, see <a href="http://docs.aws.amazon.com/iot/latest/developerguide/API_GetThingShadow.html">GetThingShadow</a> in the
48
- * IoT Developer Guide.</p>
49
- */
20
+
50
21
  getThingShadow(args: GetThingShadowCommandInput, options?: __HttpHandlerOptions): Promise<GetThingShadowCommandOutput>;
51
22
  getThingShadow(args: GetThingShadowCommandInput, cb: (err: any, data?: GetThingShadowCommandOutput) => void): void;
52
23
  getThingShadow(args: GetThingShadowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetThingShadowCommandOutput) => void): void;
53
- /**
54
- * <p>Lists the shadows for the specified thing.</p>
55
- * <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>
56
- */
24
+
57
25
  listNamedShadowsForThing(args: ListNamedShadowsForThingCommandInput, options?: __HttpHandlerOptions): Promise<ListNamedShadowsForThingCommandOutput>;
58
26
  listNamedShadowsForThing(args: ListNamedShadowsForThingCommandInput, cb: (err: any, data?: ListNamedShadowsForThingCommandOutput) => void): void;
59
27
  listNamedShadowsForThing(args: ListNamedShadowsForThingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListNamedShadowsForThingCommandOutput) => void): void;
60
- /**
61
- * <p>Lists summary information about the retained messages stored for the account.</p>
62
- * <p>This action returns only the topic names of the retained messages. It doesn't
63
- * return any message payloads. Although this action doesn't return a message payload,
64
- * it can still incur messaging costs.</p>
65
- * <p>To get the message payload of a retained message, call
66
- * <a href="https://docs.aws.amazon.com/iot/latest/developerguide/API_iotdata_GetRetainedMessage.html">GetRetainedMessage</a>
67
- * with the topic name of the retained message.</p>
68
- * <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>
69
- * <p>For more information about messaging costs, see <a href="http://aws.amazon.com/iot-core/pricing/#Messaging">IoT Core
70
- * pricing - Messaging</a>.</p>
71
- */
28
+
72
29
  listRetainedMessages(args: ListRetainedMessagesCommandInput, options?: __HttpHandlerOptions): Promise<ListRetainedMessagesCommandOutput>;
73
30
  listRetainedMessages(args: ListRetainedMessagesCommandInput, cb: (err: any, data?: ListRetainedMessagesCommandOutput) => void): void;
74
31
  listRetainedMessages(args: ListRetainedMessagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRetainedMessagesCommandOutput) => void): void;
75
- /**
76
- * <p>Publishes an MQTT message.</p>
77
- * <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>
78
- * <p>For more information about MQTT messages, see
79
- * <a href="http://docs.aws.amazon.com/iot/latest/developerguide/mqtt.html">MQTT Protocol</a> in the
80
- * IoT Developer Guide.</p>
81
- * <p>For more information about messaging costs, see <a href="http://aws.amazon.com/iot-core/pricing/#Messaging">IoT Core
82
- * pricing - Messaging</a>.</p>
83
- */
32
+
84
33
  publish(args: PublishCommandInput, options?: __HttpHandlerOptions): Promise<PublishCommandOutput>;
85
34
  publish(args: PublishCommandInput, cb: (err: any, data?: PublishCommandOutput) => void): void;
86
35
  publish(args: PublishCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PublishCommandOutput) => void): void;
87
- /**
88
- * <p>Updates the shadow for the specified thing.</p>
89
- * <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>
90
- * <p>For more information, see <a href="http://docs.aws.amazon.com/iot/latest/developerguide/API_UpdateThingShadow.html">UpdateThingShadow</a> in the
91
- * IoT Developer Guide.</p>
92
- */
36
+
93
37
  updateThingShadow(args: UpdateThingShadowCommandInput, options?: __HttpHandlerOptions): Promise<UpdateThingShadowCommandOutput>;
94
38
  updateThingShadow(args: UpdateThingShadowCommandInput, cb: (err: any, data?: UpdateThingShadowCommandOutput) => void): void;
95
39
  updateThingShadow(args: UpdateThingShadowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateThingShadowCommandOutput) => void): void;
@@ -16,134 +16,59 @@ import { UpdateThingShadowCommandInput, UpdateThingShadowCommandOutput } from ".
16
16
  export declare type ServiceInputTypes = DeleteThingShadowCommandInput | GetRetainedMessageCommandInput | GetThingShadowCommandInput | ListNamedShadowsForThingCommandInput | ListRetainedMessagesCommandInput | PublishCommandInput | UpdateThingShadowCommandInput;
17
17
  export declare type ServiceOutputTypes = DeleteThingShadowCommandOutput | GetRetainedMessageCommandOutput | GetThingShadowCommandOutput | ListNamedShadowsForThingCommandOutput | ListRetainedMessagesCommandOutput | PublishCommandOutput | UpdateThingShadowCommandOutput;
18
18
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
19
- /**
20
- * The HTTP handler to use. Fetch in browser and Https in Nodejs.
21
- */
19
+
22
20
  requestHandler?: __HttpHandler;
23
- /**
24
- * A constructor for a class implementing the {@link __Hash} interface
25
- * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
26
- * @internal
27
- */
21
+
28
22
  sha256?: __HashConstructor;
29
- /**
30
- * The function that will be used to convert strings into HTTP endpoints.
31
- * @internal
32
- */
23
+
33
24
  urlParser?: __UrlParser;
34
- /**
35
- * A function that can calculate the length of a request body.
36
- * @internal
37
- */
25
+
38
26
  bodyLengthChecker?: (body: any) => number | undefined;
39
- /**
40
- * A function that converts a stream into an array of bytes.
41
- * @internal
42
- */
27
+
43
28
  streamCollector?: __StreamCollector;
44
- /**
45
- * The function that will be used to convert a base64-encoded string to a byte array.
46
- * @internal
47
- */
29
+
48
30
  base64Decoder?: __Decoder;
49
- /**
50
- * The function that will be used to convert binary data to a base64-encoded string.
51
- * @internal
52
- */
31
+
53
32
  base64Encoder?: __Encoder;
54
- /**
55
- * The function that will be used to convert a UTF8-encoded string to a byte array.
56
- * @internal
57
- */
33
+
58
34
  utf8Decoder?: __Decoder;
59
- /**
60
- * The function that will be used to convert binary data to a UTF-8 encoded string.
61
- * @internal
62
- */
35
+
63
36
  utf8Encoder?: __Encoder;
64
- /**
65
- * The runtime environment.
66
- * @internal
67
- */
37
+
68
38
  runtime?: string;
69
- /**
70
- * Disable dyanamically changing the endpoint of the client based on the hostPrefix
71
- * trait of an operation.
72
- */
39
+
73
40
  disableHostPrefix?: boolean;
74
- /**
75
- * Value for how many times a request will be made at most in case of retry.
76
- */
41
+
77
42
  maxAttempts?: number | __Provider<number>;
78
- /**
79
- * Specifies which retry algorithm to use.
80
- */
43
+
81
44
  retryMode?: string | __Provider<string>;
82
- /**
83
- * Optional logger for logging debug/info/warn/error.
84
- */
45
+
85
46
  logger?: __Logger;
86
- /**
87
- * Unique service identifier.
88
- * @internal
89
- */
47
+
90
48
  serviceId?: string;
91
- /**
92
- * The AWS region to which this client will send requests
93
- */
49
+
94
50
  region?: string | __Provider<string>;
95
- /**
96
- * Default credentials provider; Not available in browser runtime.
97
- * @internal
98
- */
51
+
99
52
  credentialDefaultProvider?: (input: any) => __Provider<__Credentials>;
100
- /**
101
- * Fetch related hostname, signing name or signing region with given region.
102
- * @internal
103
- */
53
+
104
54
  regionInfoProvider?: RegionInfoProvider;
105
- /**
106
- * The provider populating default tracking information to be sent with `user-agent`, `x-amz-user-agent` header
107
- * @internal
108
- */
55
+
109
56
  defaultUserAgentProvider?: Provider<__UserAgent>;
110
57
  }
111
58
  declare type IoTDataPlaneClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointsInputConfig & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig;
112
- /**
113
- * The configuration interface of IoTDataPlaneClient class constructor that set the region, credentials and other options.
114
- */
59
+
115
60
  export interface IoTDataPlaneClientConfig extends IoTDataPlaneClientConfigType {
116
61
  }
117
62
  declare type IoTDataPlaneClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointsResolvedConfig & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig;
118
- /**
119
- * The resolved configuration interface of IoTDataPlaneClient class. This is resolved and normalized from the {@link IoTDataPlaneClientConfig | constructor configuration interface}.
120
- */
63
+
121
64
  export interface IoTDataPlaneClientResolvedConfig extends IoTDataPlaneClientResolvedConfigType {
122
65
  }
123
- /**
124
- * <fullname>IoT data</fullname>
125
- * <p>IoT data enables secure, bi-directional communication between Internet-connected things (such as sensors,
126
- * actuators, embedded devices, or smart appliances) and the Amazon Web Services cloud. It implements a broker for applications and
127
- * things to publish messages over HTTP (Publish) and retrieve, update, and delete shadows. A shadow is a
128
- * persistent representation of your things and their state in the Amazon Web Services cloud.</p>
129
- * <p>Find the endpoint address for actions in IoT data by running this CLI command:</p>
130
- * <p>
131
- * <code>aws iot describe-endpoint --endpoint-type iot:Data-ATS</code>
132
- * </p>
133
- * <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>
134
- * to sign requests is: <i>iotdevicegateway</i>.</p>
135
- */
66
+
136
67
  export declare class IoTDataPlaneClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, IoTDataPlaneClientResolvedConfig> {
137
- /**
138
- * The resolved configuration of IoTDataPlaneClient class. This is resolved and normalized from the {@link IoTDataPlaneClientConfig | constructor configuration interface}.
139
- */
68
+
140
69
  readonly config: IoTDataPlaneClientResolvedConfig;
141
70
  constructor(configuration: IoTDataPlaneClientConfig);
142
- /**
143
- * Destroy underlying resources, like sockets. It's usually not necessary to do this.
144
- * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
145
- * Otherwise, sockets might stay open for quite a long time before the server terminates them.
146
- */
71
+
147
72
  destroy(): void;
148
73
  }
149
74
  export {};
@@ -6,31 +6,11 @@ export interface DeleteThingShadowCommandInput extends DeleteThingShadowRequest
6
6
  }
7
7
  export interface DeleteThingShadowCommandOutput extends DeleteThingShadowResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Deletes the shadow for the specified thing.</p>
11
- * <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>
12
- * <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>
13
- * @example
14
- * Use a bare-bones client and the command you need to make an API call.
15
- * ```javascript
16
- * import { IoTDataPlaneClient, DeleteThingShadowCommand } from "@aws-sdk/client-iot-data-plane"; // ES Modules import
17
- * // const { IoTDataPlaneClient, DeleteThingShadowCommand } = require("@aws-sdk/client-iot-data-plane"); // CommonJS import
18
- * const client = new IoTDataPlaneClient(config);
19
- * const command = new DeleteThingShadowCommand(input);
20
- * const response = await client.send(command);
21
- * ```
22
- *
23
- * @see {@link DeleteThingShadowCommandInput} for command's `input` shape.
24
- * @see {@link DeleteThingShadowCommandOutput} for command's `response` shape.
25
- * @see {@link IoTDataPlaneClientResolvedConfig | config} for command's `input` shape.
26
- *
27
- */
9
+
28
10
  export declare class DeleteThingShadowCommand extends $Command<DeleteThingShadowCommandInput, DeleteThingShadowCommandOutput, IoTDataPlaneClientResolvedConfig> {
29
11
  readonly input: DeleteThingShadowCommandInput;
30
12
  constructor(input: DeleteThingShadowCommandInput);
31
- /**
32
- * @internal
33
- */
13
+
34
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTDataPlaneClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteThingShadowCommandInput, DeleteThingShadowCommandOutput>;
35
15
  private serialize;
36
16
  private deserialize;
@@ -6,35 +6,11 @@ export interface GetRetainedMessageCommandInput extends GetRetainedMessageReques
6
6
  }
7
7
  export interface GetRetainedMessageCommandOutput extends GetRetainedMessageResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Gets the details of a single retained message for the specified topic.</p>
11
- * <p>This action returns the message payload of the retained message, which can
12
- * incur messaging costs. To list only the topic names of the retained messages, call
13
- * <a href="/iot/latest/developerguide/API_iotdata_ListRetainedMessages.html">ListRetainedMessages</a>.</p>
14
- * <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>
15
- * <p>For more information about messaging costs, see <a href="http://aws.amazon.com/iot-core/pricing/#Messaging">IoT Core
16
- * pricing - Messaging</a>.</p>
17
- * @example
18
- * Use a bare-bones client and the command you need to make an API call.
19
- * ```javascript
20
- * import { IoTDataPlaneClient, GetRetainedMessageCommand } from "@aws-sdk/client-iot-data-plane"; // ES Modules import
21
- * // const { IoTDataPlaneClient, GetRetainedMessageCommand } = require("@aws-sdk/client-iot-data-plane"); // CommonJS import
22
- * const client = new IoTDataPlaneClient(config);
23
- * const command = new GetRetainedMessageCommand(input);
24
- * const response = await client.send(command);
25
- * ```
26
- *
27
- * @see {@link GetRetainedMessageCommandInput} for command's `input` shape.
28
- * @see {@link GetRetainedMessageCommandOutput} for command's `response` shape.
29
- * @see {@link IoTDataPlaneClientResolvedConfig | config} for command's `input` shape.
30
- *
31
- */
9
+
32
10
  export declare class GetRetainedMessageCommand extends $Command<GetRetainedMessageCommandInput, GetRetainedMessageCommandOutput, IoTDataPlaneClientResolvedConfig> {
33
11
  readonly input: GetRetainedMessageCommandInput;
34
12
  constructor(input: GetRetainedMessageCommandInput);
35
- /**
36
- * @internal
37
- */
13
+
38
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTDataPlaneClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetRetainedMessageCommandInput, GetRetainedMessageCommandOutput>;
39
15
  private serialize;
40
16
  private deserialize;
@@ -6,32 +6,11 @@ export interface GetThingShadowCommandInput extends GetThingShadowRequest {
6
6
  }
7
7
  export interface GetThingShadowCommandOutput extends GetThingShadowResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Gets the shadow for the specified thing.</p>
11
- * <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>
12
- * <p>For more information, see <a href="http://docs.aws.amazon.com/iot/latest/developerguide/API_GetThingShadow.html">GetThingShadow</a> in the
13
- * IoT Developer Guide.</p>
14
- * @example
15
- * Use a bare-bones client and the command you need to make an API call.
16
- * ```javascript
17
- * import { IoTDataPlaneClient, GetThingShadowCommand } from "@aws-sdk/client-iot-data-plane"; // ES Modules import
18
- * // const { IoTDataPlaneClient, GetThingShadowCommand } = require("@aws-sdk/client-iot-data-plane"); // CommonJS import
19
- * const client = new IoTDataPlaneClient(config);
20
- * const command = new GetThingShadowCommand(input);
21
- * const response = await client.send(command);
22
- * ```
23
- *
24
- * @see {@link GetThingShadowCommandInput} for command's `input` shape.
25
- * @see {@link GetThingShadowCommandOutput} for command's `response` shape.
26
- * @see {@link IoTDataPlaneClientResolvedConfig | config} for command's `input` shape.
27
- *
28
- */
9
+
29
10
  export declare class GetThingShadowCommand extends $Command<GetThingShadowCommandInput, GetThingShadowCommandOutput, IoTDataPlaneClientResolvedConfig> {
30
11
  readonly input: GetThingShadowCommandInput;
31
12
  constructor(input: GetThingShadowCommandInput);
32
- /**
33
- * @internal
34
- */
13
+
35
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTDataPlaneClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetThingShadowCommandInput, GetThingShadowCommandOutput>;
36
15
  private serialize;
37
16
  private deserialize;
@@ -6,30 +6,11 @@ export interface ListNamedShadowsForThingCommandInput extends ListNamedShadowsFo
6
6
  }
7
7
  export interface ListNamedShadowsForThingCommandOutput extends ListNamedShadowsForThingResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Lists the shadows for the specified thing.</p>
11
- * <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>
12
- * @example
13
- * Use a bare-bones client and the command you need to make an API call.
14
- * ```javascript
15
- * import { IoTDataPlaneClient, ListNamedShadowsForThingCommand } from "@aws-sdk/client-iot-data-plane"; // ES Modules import
16
- * // const { IoTDataPlaneClient, ListNamedShadowsForThingCommand } = require("@aws-sdk/client-iot-data-plane"); // CommonJS import
17
- * const client = new IoTDataPlaneClient(config);
18
- * const command = new ListNamedShadowsForThingCommand(input);
19
- * const response = await client.send(command);
20
- * ```
21
- *
22
- * @see {@link ListNamedShadowsForThingCommandInput} for command's `input` shape.
23
- * @see {@link ListNamedShadowsForThingCommandOutput} for command's `response` shape.
24
- * @see {@link IoTDataPlaneClientResolvedConfig | config} for command's `input` shape.
25
- *
26
- */
9
+
27
10
  export declare class ListNamedShadowsForThingCommand extends $Command<ListNamedShadowsForThingCommandInput, ListNamedShadowsForThingCommandOutput, IoTDataPlaneClientResolvedConfig> {
28
11
  readonly input: ListNamedShadowsForThingCommandInput;
29
12
  constructor(input: ListNamedShadowsForThingCommandInput);
30
- /**
31
- * @internal
32
- */
13
+
33
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTDataPlaneClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListNamedShadowsForThingCommandInput, ListNamedShadowsForThingCommandOutput>;
34
15
  private serialize;
35
16
  private deserialize;
@@ -6,38 +6,11 @@ export interface ListRetainedMessagesCommandInput extends ListRetainedMessagesRe
6
6
  }
7
7
  export interface ListRetainedMessagesCommandOutput extends ListRetainedMessagesResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Lists summary information about the retained messages stored for the account.</p>
11
- * <p>This action returns only the topic names of the retained messages. It doesn't
12
- * return any message payloads. Although this action doesn't return a message payload,
13
- * it can still incur messaging costs.</p>
14
- * <p>To get the message payload of a retained message, call
15
- * <a href="https://docs.aws.amazon.com/iot/latest/developerguide/API_iotdata_GetRetainedMessage.html">GetRetainedMessage</a>
16
- * with the topic name of the retained message.</p>
17
- * <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>
18
- * <p>For more information about messaging costs, see <a href="http://aws.amazon.com/iot-core/pricing/#Messaging">IoT Core
19
- * pricing - Messaging</a>.</p>
20
- * @example
21
- * Use a bare-bones client and the command you need to make an API call.
22
- * ```javascript
23
- * import { IoTDataPlaneClient, ListRetainedMessagesCommand } from "@aws-sdk/client-iot-data-plane"; // ES Modules import
24
- * // const { IoTDataPlaneClient, ListRetainedMessagesCommand } = require("@aws-sdk/client-iot-data-plane"); // CommonJS import
25
- * const client = new IoTDataPlaneClient(config);
26
- * const command = new ListRetainedMessagesCommand(input);
27
- * const response = await client.send(command);
28
- * ```
29
- *
30
- * @see {@link ListRetainedMessagesCommandInput} for command's `input` shape.
31
- * @see {@link ListRetainedMessagesCommandOutput} for command's `response` shape.
32
- * @see {@link IoTDataPlaneClientResolvedConfig | config} for command's `input` shape.
33
- *
34
- */
9
+
35
10
  export declare class ListRetainedMessagesCommand extends $Command<ListRetainedMessagesCommandInput, ListRetainedMessagesCommandOutput, IoTDataPlaneClientResolvedConfig> {
36
11
  readonly input: ListRetainedMessagesCommandInput;
37
12
  constructor(input: ListRetainedMessagesCommandInput);
38
- /**
39
- * @internal
40
- */
13
+
41
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTDataPlaneClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListRetainedMessagesCommandInput, ListRetainedMessagesCommandOutput>;
42
15
  private serialize;
43
16
  private deserialize;
@@ -6,35 +6,11 @@ export interface PublishCommandInput extends PublishRequest {
6
6
  }
7
7
  export interface PublishCommandOutput extends __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Publishes an MQTT message.</p>
11
- * <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>
12
- * <p>For more information about MQTT messages, see
13
- * <a href="http://docs.aws.amazon.com/iot/latest/developerguide/mqtt.html">MQTT Protocol</a> in the
14
- * IoT Developer Guide.</p>
15
- * <p>For more information about messaging costs, see <a href="http://aws.amazon.com/iot-core/pricing/#Messaging">IoT Core
16
- * pricing - Messaging</a>.</p>
17
- * @example
18
- * Use a bare-bones client and the command you need to make an API call.
19
- * ```javascript
20
- * import { IoTDataPlaneClient, PublishCommand } from "@aws-sdk/client-iot-data-plane"; // ES Modules import
21
- * // const { IoTDataPlaneClient, PublishCommand } = require("@aws-sdk/client-iot-data-plane"); // CommonJS import
22
- * const client = new IoTDataPlaneClient(config);
23
- * const command = new PublishCommand(input);
24
- * const response = await client.send(command);
25
- * ```
26
- *
27
- * @see {@link PublishCommandInput} for command's `input` shape.
28
- * @see {@link PublishCommandOutput} for command's `response` shape.
29
- * @see {@link IoTDataPlaneClientResolvedConfig | config} for command's `input` shape.
30
- *
31
- */
9
+
32
10
  export declare class PublishCommand extends $Command<PublishCommandInput, PublishCommandOutput, IoTDataPlaneClientResolvedConfig> {
33
11
  readonly input: PublishCommandInput;
34
12
  constructor(input: PublishCommandInput);
35
- /**
36
- * @internal
37
- */
13
+
38
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTDataPlaneClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PublishCommandInput, PublishCommandOutput>;
39
15
  private serialize;
40
16
  private deserialize;
@@ -6,32 +6,11 @@ export interface UpdateThingShadowCommandInput extends UpdateThingShadowRequest
6
6
  }
7
7
  export interface UpdateThingShadowCommandOutput extends UpdateThingShadowResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Updates the shadow for the specified thing.</p>
11
- * <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>
12
- * <p>For more information, see <a href="http://docs.aws.amazon.com/iot/latest/developerguide/API_UpdateThingShadow.html">UpdateThingShadow</a> in the
13
- * IoT Developer Guide.</p>
14
- * @example
15
- * Use a bare-bones client and the command you need to make an API call.
16
- * ```javascript
17
- * import { IoTDataPlaneClient, UpdateThingShadowCommand } from "@aws-sdk/client-iot-data-plane"; // ES Modules import
18
- * // const { IoTDataPlaneClient, UpdateThingShadowCommand } = require("@aws-sdk/client-iot-data-plane"); // CommonJS import
19
- * const client = new IoTDataPlaneClient(config);
20
- * const command = new UpdateThingShadowCommand(input);
21
- * const response = await client.send(command);
22
- * ```
23
- *
24
- * @see {@link UpdateThingShadowCommandInput} for command's `input` shape.
25
- * @see {@link UpdateThingShadowCommandOutput} for command's `response` shape.
26
- * @see {@link IoTDataPlaneClientResolvedConfig | config} for command's `input` shape.
27
- *
28
- */
9
+
29
10
  export declare class UpdateThingShadowCommand extends $Command<UpdateThingShadowCommandInput, UpdateThingShadowCommandOutput, IoTDataPlaneClientResolvedConfig> {
30
11
  readonly input: UpdateThingShadowCommandInput;
31
12
  constructor(input: UpdateThingShadowCommandInput);
32
- /**
33
- * @internal
34
- */
13
+
35
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTDataPlaneClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateThingShadowCommandInput, UpdateThingShadowCommandOutput>;
36
15
  private serialize;
37
16
  private deserialize;
@@ -0,0 +1,7 @@
1
+ export * from "./DeleteThingShadowCommand";
2
+ export * from "./GetRetainedMessageCommand";
3
+ export * from "./GetThingShadowCommand";
4
+ export * from "./ListNamedShadowsForThingCommand";
5
+ export * from "./ListRetainedMessagesCommand";
6
+ export * from "./PublishCommand";
7
+ export * from "./UpdateThingShadowCommand";
@@ -1,12 +1,5 @@
1
- export * from "./IoTDataPlaneClient";
2
1
  export * from "./IoTDataPlane";
3
- export * from "./commands/DeleteThingShadowCommand";
4
- export * from "./commands/GetRetainedMessageCommand";
5
- export * from "./commands/GetThingShadowCommand";
6
- export * from "./commands/ListNamedShadowsForThingCommand";
7
- export * from "./commands/ListRetainedMessagesCommand";
8
- export * from "./pagination/ListRetainedMessagesPaginator";
9
- export * from "./commands/PublishCommand";
10
- export * from "./commands/UpdateThingShadowCommand";
11
- export * from "./pagination/Interfaces";
12
- export * from "./models/index";
2
+ export * from "./IoTDataPlaneClient";
3
+ export * from "./commands";
4
+ export * from "./models";
5
+ export * from "./pagination";