@aws-sdk/client-ivschat 3.614.0 → 3.620.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 (14) hide show
  1. package/README.md +9 -118
  2. package/dist-cjs/index.js +5 -5
  3. package/dist-es/IvschatClient.js +5 -5
  4. package/dist-types/Ivschat.d.ts +9 -118
  5. package/dist-types/IvschatClient.d.ts +11 -120
  6. package/dist-types/index.d.ts +9 -118
  7. package/dist-types/runtimeConfig.browser.d.ts +1 -1
  8. package/dist-types/runtimeConfig.d.ts +1 -1
  9. package/dist-types/runtimeConfig.native.d.ts +1 -1
  10. package/dist-types/ts3.4/IvschatClient.d.ts +2 -2
  11. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -1
  12. package/dist-types/ts3.4/runtimeConfig.d.ts +1 -1
  13. package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -1
  14. package/package.json +18 -18
package/README.md CHANGED
@@ -15,6 +15,9 @@ API</a>, to enable users to interact with chat rooms in real time.</p>
15
15
  <p>The API is an AWS regional service. For a list of supported regions and Amazon IVS Chat
16
16
  HTTPS service endpoints, see the Amazon IVS Chat information on the <a href="https://docs.aws.amazon.com/general/latest/gr/ivs.html">Amazon IVS page</a> in the
17
17
  <i>AWS General Reference</i>. </p>
18
+ <p>This document describes HTTP operations. There is a separate <i>messaging</i> API
19
+ for managing Chat resources; see the <a href="https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/chat-messaging-api.html"> Amazon IVS Chat Messaging API
20
+ Reference</a>.</p>
18
21
  <p>
19
22
  <b>Notes on terminology:</b>
20
23
  </p>
@@ -29,16 +32,19 @@ Amazon IVS Chat Messaging API. We refer to these as <i>clients</i>. </p>
29
32
  </li>
30
33
  </ul>
31
34
  <p>
32
- <b>Key Concepts</b>
35
+ <b>Resources</b>
33
36
  </p>
37
+ <p>The following resources are part of Amazon IVS Chat:</p>
34
38
  <ul>
35
39
  <li>
36
40
  <p>
37
- <b>LoggingConfiguration</b> — A configuration that allows customers to store and record sent messages in a chat room.</p>
41
+ <b>LoggingConfiguration</b> — A configuration that allows customers to store and record sent messages in a chat room. See the Logging Configuration endpoints for more information.</p>
38
42
  </li>
39
43
  <li>
40
44
  <p>
41
- <b>Room</b> — The central Amazon IVS Chat resource through which clients connect to and exchange chat messages.</p>
45
+ <b>Room</b> — The central Amazon IVS Chat resource through
46
+ which clients connect to and exchange chat messages. See the Room endpoints for more
47
+ information.</p>
42
48
  </li>
43
49
  </ul>
44
50
  <p>
@@ -107,121 +113,6 @@ the Security page of the <i>Amazon IVS User Guide</i>.</p>
107
113
  resource unambiguously across all of AWS, such as in IAM policies and API calls. For more
108
114
  information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names</a> in the <i>AWS General
109
115
  Reference</i>.</p>
110
- <p>
111
- <b>Messaging Endpoints</b>
112
- </p>
113
- <ul>
114
- <li>
115
- <p>
116
- <a>DeleteMessage</a> — Sends an event to a specific room which
117
- directs clients to delete a specific message; that is, unrender it from view and delete it
118
- from the client’s chat history. This event’s <code>EventName</code> is
119
- <code>aws:DELETE_MESSAGE</code>. This replicates the <a href="https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-deletemessage-publish.html">
120
- DeleteMessage</a> WebSocket operation in the Amazon IVS Chat Messaging API.</p>
121
- </li>
122
- <li>
123
- <p>
124
- <a>DisconnectUser</a> — Disconnects all connections using a specified
125
- user ID from a room. This replicates the <a href="https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-disconnectuser-publish.html">
126
- DisconnectUser</a> WebSocket operation in the Amazon IVS Chat Messaging API.</p>
127
- </li>
128
- <li>
129
- <p>
130
- <a>SendEvent</a> — Sends an event to a room. Use this within your
131
- application’s business logic to send events to clients of a room; e.g., to notify clients
132
- to change the way the chat UI is rendered.</p>
133
- </li>
134
- </ul>
135
- <p>
136
- <b>Chat Token Endpoint</b>
137
- </p>
138
- <ul>
139
- <li>
140
- <p>
141
- <a>CreateChatToken</a> — Creates an encrypted token that is used by a chat participant to establish an
142
- individual WebSocket chat connection to a room. When the token is used to connect to chat,
143
- the connection is valid for the session duration specified in the request. The token
144
- becomes invalid at the token-expiration timestamp included in the response.</p>
145
- </li>
146
- </ul>
147
- <p>
148
- <b>Room Endpoints</b>
149
- </p>
150
- <ul>
151
- <li>
152
- <p>
153
- <a>CreateRoom</a> — Creates a room that allows clients to connect and
154
- pass messages.</p>
155
- </li>
156
- <li>
157
- <p>
158
- <a>DeleteRoom</a> — Deletes the specified room.</p>
159
- </li>
160
- <li>
161
- <p>
162
- <a>GetRoom</a> — Gets the specified room.</p>
163
- </li>
164
- <li>
165
- <p>
166
- <a>ListRooms</a> — Gets summary information about all your rooms in
167
- the AWS region where the API request is processed. </p>
168
- </li>
169
- <li>
170
- <p>
171
- <a>UpdateRoom</a> — Updates a room’s configuration.</p>
172
- </li>
173
- </ul>
174
- <p>
175
- <b>Logging Configuration Endpoints</b>
176
- </p>
177
- <ul>
178
- <li>
179
- <p>
180
- <a>CreateLoggingConfiguration</a> — Creates a logging configuration that allows clients to store and record sent messages.</p>
181
- </li>
182
- <li>
183
- <p>
184
- <a>DeleteLoggingConfiguration</a> — Deletes the specified logging
185
- configuration.</p>
186
- </li>
187
- <li>
188
- <p>
189
- <a>GetLoggingConfiguration</a> — Gets the specified logging
190
- configuration.</p>
191
- </li>
192
- <li>
193
- <p>
194
- <a>ListLoggingConfigurations</a> — Gets summary information about all
195
- your logging configurations in the AWS region where the API request is processed.</p>
196
- </li>
197
- <li>
198
- <p>
199
- <a>UpdateLoggingConfiguration</a> — Updates a specified logging configuration.</p>
200
- </li>
201
- </ul>
202
- <p>
203
- <b>Tags Endpoints</b>
204
- </p>
205
- <ul>
206
- <li>
207
- <p>
208
- <a>ListTagsForResource</a> — Gets information about AWS tags for the
209
- specified ARN.</p>
210
- </li>
211
- <li>
212
- <p>
213
- <a>TagResource</a> — Adds or updates tags for the AWS resource with
214
- the specified ARN.</p>
215
- </li>
216
- <li>
217
- <p>
218
- <a>UntagResource</a> — Removes tags from the resource with the
219
- specified ARN.</p>
220
- </li>
221
- </ul>
222
- <p>All the above are HTTP operations. There is a separate <i>messaging</i> API
223
- for managing Chat resources; see the <a href="https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/chat-messaging-api.html"> Amazon IVS Chat Messaging API
224
- Reference</a>.</p>
225
116
 
226
117
  ## Installing
227
118
 
package/dist-cjs/index.js CHANGED
@@ -168,19 +168,19 @@ var _IvschatClient = class _IvschatClient extends import_smithy_client.Client {
168
168
  const _config_1 = resolveClientEndpointParameters(_config_0);
169
169
  const _config_2 = (0, import_config_resolver.resolveRegionConfig)(_config_1);
170
170
  const _config_3 = (0, import_middleware_endpoint.resolveEndpointConfig)(_config_2);
171
- const _config_4 = (0, import_middleware_retry.resolveRetryConfig)(_config_3);
172
- const _config_5 = (0, import_middleware_host_header.resolveHostHeaderConfig)(_config_4);
173
- const _config_6 = (0, import_middleware_user_agent.resolveUserAgentConfig)(_config_5);
171
+ const _config_4 = (0, import_middleware_host_header.resolveHostHeaderConfig)(_config_3);
172
+ const _config_5 = (0, import_middleware_user_agent.resolveUserAgentConfig)(_config_4);
173
+ const _config_6 = (0, import_middleware_retry.resolveRetryConfig)(_config_5);
174
174
  const _config_7 = (0, import_httpAuthSchemeProvider.resolveHttpAuthSchemeConfig)(_config_6);
175
175
  const _config_8 = resolveRuntimeExtensions(_config_7, (configuration == null ? void 0 : configuration.extensions) || []);
176
176
  super(_config_8);
177
177
  this.config = _config_8;
178
- this.middlewareStack.use((0, import_middleware_retry.getRetryPlugin)(this.config));
179
- this.middlewareStack.use((0, import_middleware_content_length.getContentLengthPlugin)(this.config));
180
178
  this.middlewareStack.use((0, import_middleware_host_header.getHostHeaderPlugin)(this.config));
181
179
  this.middlewareStack.use((0, import_middleware_logger.getLoggerPlugin)(this.config));
182
180
  this.middlewareStack.use((0, import_middleware_recursion_detection.getRecursionDetectionPlugin)(this.config));
183
181
  this.middlewareStack.use((0, import_middleware_user_agent.getUserAgentPlugin)(this.config));
182
+ this.middlewareStack.use((0, import_middleware_retry.getRetryPlugin)(this.config));
183
+ this.middlewareStack.use((0, import_middleware_content_length.getContentLengthPlugin)(this.config));
184
184
  this.middlewareStack.use(
185
185
  (0, import_core.getHttpAuthSchemeEndpointRuleSetPlugin)(this.config, {
186
186
  httpAuthSchemeParametersProvider: this.getDefaultHttpAuthSchemeParametersProvider(),
package/dist-es/IvschatClient.js CHANGED
@@ -19,19 +19,19 @@ export class IvschatClient extends __Client {
19
19
  const _config_1 = resolveClientEndpointParameters(_config_0);
20
20
  const _config_2 = resolveRegionConfig(_config_1);
21
21
  const _config_3 = resolveEndpointConfig(_config_2);
22
- const _config_4 = resolveRetryConfig(_config_3);
23
- const _config_5 = resolveHostHeaderConfig(_config_4);
24
- const _config_6 = resolveUserAgentConfig(_config_5);
22
+ const _config_4 = resolveHostHeaderConfig(_config_3);
23
+ const _config_5 = resolveUserAgentConfig(_config_4);
24
+ const _config_6 = resolveRetryConfig(_config_5);
25
25
  const _config_7 = resolveHttpAuthSchemeConfig(_config_6);
26
26
  const _config_8 = resolveRuntimeExtensions(_config_7, configuration?.extensions || []);
27
27
  super(_config_8);
28
28
  this.config = _config_8;
29
- this.middlewareStack.use(getRetryPlugin(this.config));
30
- this.middlewareStack.use(getContentLengthPlugin(this.config));
31
29
  this.middlewareStack.use(getHostHeaderPlugin(this.config));
32
30
  this.middlewareStack.use(getLoggerPlugin(this.config));
33
31
  this.middlewareStack.use(getRecursionDetectionPlugin(this.config));
34
32
  this.middlewareStack.use(getUserAgentPlugin(this.config));
33
+ this.middlewareStack.use(getRetryPlugin(this.config));
34
+ this.middlewareStack.use(getContentLengthPlugin(this.config));
35
35
  this.middlewareStack.use(getHttpAuthSchemeEndpointRuleSetPlugin(this.config, {
36
36
  httpAuthSchemeParametersProvider: this.getDefaultHttpAuthSchemeParametersProvider(),
37
37
  identityProviderConfigProvider: this.getIdentityProviderConfigProvider(),
package/dist-types/Ivschat.d.ts CHANGED
@@ -134,6 +134,9 @@ export interface Ivschat {
134
134
  * <p>The API is an AWS regional service. For a list of supported regions and Amazon IVS Chat
135
135
  * HTTPS service endpoints, see the Amazon IVS Chat information on the <a href="https://docs.aws.amazon.com/general/latest/gr/ivs.html">Amazon IVS page</a> in the
136
136
  * <i>AWS General Reference</i>. </p>
137
+ * <p>This document describes HTTP operations. There is a separate <i>messaging</i> API
138
+ * for managing Chat resources; see the <a href="https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/chat-messaging-api.html"> Amazon IVS Chat Messaging API
139
+ * Reference</a>.</p>
137
140
  * <p>
138
141
  * <b>Notes on terminology:</b>
139
142
  * </p>
@@ -148,16 +151,19 @@ export interface Ivschat {
148
151
  * </li>
149
152
  * </ul>
150
153
  * <p>
151
- * <b>Key Concepts</b>
154
+ * <b>Resources</b>
152
155
  * </p>
156
+ * <p>The following resources are part of Amazon IVS Chat:</p>
153
157
  * <ul>
154
158
  * <li>
155
159
  * <p>
156
- * <b>LoggingConfiguration</b> — A configuration that allows customers to store and record sent messages in a chat room.</p>
160
+ * <b>LoggingConfiguration</b> — A configuration that allows customers to store and record sent messages in a chat room. See the Logging Configuration endpoints for more information.</p>
157
161
  * </li>
158
162
  * <li>
159
163
  * <p>
160
- * <b>Room</b> — The central Amazon IVS Chat resource through which clients connect to and exchange chat messages.</p>
164
+ * <b>Room</b> — The central Amazon IVS Chat resource through
165
+ * which clients connect to and exchange chat messages. See the Room endpoints for more
166
+ * information.</p>
161
167
  * </li>
162
168
  * </ul>
163
169
  * <p>
@@ -226,121 +232,6 @@ export interface Ivschat {
226
232
  * resource unambiguously across all of AWS, such as in IAM policies and API calls. For more
227
233
  * information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names</a> in the <i>AWS General
228
234
  * Reference</i>.</p>
229
- * <p>
230
- * <b>Messaging Endpoints</b>
231
- * </p>
232
- * <ul>
233
- * <li>
234
- * <p>
235
- * <a>DeleteMessage</a> — Sends an event to a specific room which
236
- * directs clients to delete a specific message; that is, unrender it from view and delete it
237
- * from the client’s chat history. This event’s <code>EventName</code> is
238
- * <code>aws:DELETE_MESSAGE</code>. This replicates the <a href="https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-deletemessage-publish.html">
239
- * DeleteMessage</a> WebSocket operation in the Amazon IVS Chat Messaging API.</p>
240
- * </li>
241
- * <li>
242
- * <p>
243
- * <a>DisconnectUser</a> — Disconnects all connections using a specified
244
- * user ID from a room. This replicates the <a href="https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-disconnectuser-publish.html">
245
- * DisconnectUser</a> WebSocket operation in the Amazon IVS Chat Messaging API.</p>
246
- * </li>
247
- * <li>
248
- * <p>
249
- * <a>SendEvent</a> — Sends an event to a room. Use this within your
250
- * application’s business logic to send events to clients of a room; e.g., to notify clients
251
- * to change the way the chat UI is rendered.</p>
252
- * </li>
253
- * </ul>
254
- * <p>
255
- * <b>Chat Token Endpoint</b>
256
- * </p>
257
- * <ul>
258
- * <li>
259
- * <p>
260
- * <a>CreateChatToken</a> — Creates an encrypted token that is used by a chat participant to establish an
261
- * individual WebSocket chat connection to a room. When the token is used to connect to chat,
262
- * the connection is valid for the session duration specified in the request. The token
263
- * becomes invalid at the token-expiration timestamp included in the response.</p>
264
- * </li>
265
- * </ul>
266
- * <p>
267
- * <b>Room Endpoints</b>
268
- * </p>
269
- * <ul>
270
- * <li>
271
- * <p>
272
- * <a>CreateRoom</a> — Creates a room that allows clients to connect and
273
- * pass messages.</p>
274
- * </li>
275
- * <li>
276
- * <p>
277
- * <a>DeleteRoom</a> — Deletes the specified room.</p>
278
- * </li>
279
- * <li>
280
- * <p>
281
- * <a>GetRoom</a> — Gets the specified room.</p>
282
- * </li>
283
- * <li>
284
- * <p>
285
- * <a>ListRooms</a> — Gets summary information about all your rooms in
286
- * the AWS region where the API request is processed. </p>
287
- * </li>
288
- * <li>
289
- * <p>
290
- * <a>UpdateRoom</a> — Updates a room’s configuration.</p>
291
- * </li>
292
- * </ul>
293
- * <p>
294
- * <b>Logging Configuration Endpoints</b>
295
- * </p>
296
- * <ul>
297
- * <li>
298
- * <p>
299
- * <a>CreateLoggingConfiguration</a> — Creates a logging configuration that allows clients to store and record sent messages.</p>
300
- * </li>
301
- * <li>
302
- * <p>
303
- * <a>DeleteLoggingConfiguration</a> — Deletes the specified logging
304
- * configuration.</p>
305
- * </li>
306
- * <li>
307
- * <p>
308
- * <a>GetLoggingConfiguration</a> — Gets the specified logging
309
- * configuration.</p>
310
- * </li>
311
- * <li>
312
- * <p>
313
- * <a>ListLoggingConfigurations</a> — Gets summary information about all
314
- * your logging configurations in the AWS region where the API request is processed.</p>
315
- * </li>
316
- * <li>
317
- * <p>
318
- * <a>UpdateLoggingConfiguration</a> — Updates a specified logging configuration.</p>
319
- * </li>
320
- * </ul>
321
- * <p>
322
- * <b>Tags Endpoints</b>
323
- * </p>
324
- * <ul>
325
- * <li>
326
- * <p>
327
- * <a>ListTagsForResource</a> — Gets information about AWS tags for the
328
- * specified ARN.</p>
329
- * </li>
330
- * <li>
331
- * <p>
332
- * <a>TagResource</a> — Adds or updates tags for the AWS resource with
333
- * the specified ARN.</p>
334
- * </li>
335
- * <li>
336
- * <p>
337
- * <a>UntagResource</a> — Removes tags from the resource with the
338
- * specified ARN.</p>
339
- * </li>
340
- * </ul>
341
- * <p>All the above are HTTP operations. There is a separate <i>messaging</i> API
342
- * for managing Chat resources; see the <a href="https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/chat-messaging-api.html"> Amazon IVS Chat Messaging API
343
- * Reference</a>.</p>
344
235
  * @public
345
236
  */
346
237
  export declare class Ivschat extends IvschatClient implements Ivschat {
package/dist-types/IvschatClient.d.ts CHANGED
@@ -148,7 +148,7 @@ export interface ClientDefaults extends Partial<__SmithyConfiguration<__HttpHand
148
148
  /**
149
149
  * @public
150
150
  */
151
- export type IvschatClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & UserAgentInputConfig & HttpAuthSchemeInputConfig & ClientInputEndpointParameters;
151
+ export type IvschatClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & HostHeaderInputConfig & UserAgentInputConfig & RetryInputConfig & HttpAuthSchemeInputConfig & ClientInputEndpointParameters;
152
152
  /**
153
153
  * @public
154
154
  *
@@ -159,7 +159,7 @@ export interface IvschatClientConfig extends IvschatClientConfigType {
159
159
  /**
160
160
  * @public
161
161
  */
162
- export type IvschatClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RuntimeExtensionsConfig & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & UserAgentResolvedConfig & HttpAuthSchemeResolvedConfig & ClientResolvedEndpointParameters;
162
+ export type IvschatClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RuntimeExtensionsConfig & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & HostHeaderResolvedConfig & UserAgentResolvedConfig & RetryResolvedConfig & HttpAuthSchemeResolvedConfig & ClientResolvedEndpointParameters;
163
163
  /**
164
164
  * @public
165
165
  *
@@ -177,6 +177,9 @@ export interface IvschatClientResolvedConfig extends IvschatClientResolvedConfig
177
177
  * <p>The API is an AWS regional service. For a list of supported regions and Amazon IVS Chat
178
178
  * HTTPS service endpoints, see the Amazon IVS Chat information on the <a href="https://docs.aws.amazon.com/general/latest/gr/ivs.html">Amazon IVS page</a> in the
179
179
  * <i>AWS General Reference</i>. </p>
180
+ * <p>This document describes HTTP operations. There is a separate <i>messaging</i> API
181
+ * for managing Chat resources; see the <a href="https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/chat-messaging-api.html"> Amazon IVS Chat Messaging API
182
+ * Reference</a>.</p>
180
183
  * <p>
181
184
  * <b>Notes on terminology:</b>
182
185
  * </p>
@@ -191,16 +194,19 @@ export interface IvschatClientResolvedConfig extends IvschatClientResolvedConfig
191
194
  * </li>
192
195
  * </ul>
193
196
  * <p>
194
- * <b>Key Concepts</b>
197
+ * <b>Resources</b>
195
198
  * </p>
199
+ * <p>The following resources are part of Amazon IVS Chat:</p>
196
200
  * <ul>
197
201
  * <li>
198
202
  * <p>
199
- * <b>LoggingConfiguration</b> — A configuration that allows customers to store and record sent messages in a chat room.</p>
203
+ * <b>LoggingConfiguration</b> — A configuration that allows customers to store and record sent messages in a chat room. See the Logging Configuration endpoints for more information.</p>
200
204
  * </li>
201
205
  * <li>
202
206
  * <p>
203
- * <b>Room</b> — The central Amazon IVS Chat resource through which clients connect to and exchange chat messages.</p>
207
+ * <b>Room</b> — The central Amazon IVS Chat resource through
208
+ * which clients connect to and exchange chat messages. See the Room endpoints for more
209
+ * information.</p>
204
210
  * </li>
205
211
  * </ul>
206
212
  * <p>
@@ -269,121 +275,6 @@ export interface IvschatClientResolvedConfig extends IvschatClientResolvedConfig
269
275
  * resource unambiguously across all of AWS, such as in IAM policies and API calls. For more
270
276
  * information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names</a> in the <i>AWS General
271
277
  * Reference</i>.</p>
272
- * <p>
273
- * <b>Messaging Endpoints</b>
274
- * </p>
275
- * <ul>
276
- * <li>
277
- * <p>
278
- * <a>DeleteMessage</a> — Sends an event to a specific room which
279
- * directs clients to delete a specific message; that is, unrender it from view and delete it
280
- * from the client’s chat history. This event’s <code>EventName</code> is
281
- * <code>aws:DELETE_MESSAGE</code>. This replicates the <a href="https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-deletemessage-publish.html">
282
- * DeleteMessage</a> WebSocket operation in the Amazon IVS Chat Messaging API.</p>
283
- * </li>
284
- * <li>
285
- * <p>
286
- * <a>DisconnectUser</a> — Disconnects all connections using a specified
287
- * user ID from a room. This replicates the <a href="https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-disconnectuser-publish.html">
288
- * DisconnectUser</a> WebSocket operation in the Amazon IVS Chat Messaging API.</p>
289
- * </li>
290
- * <li>
291
- * <p>
292
- * <a>SendEvent</a> — Sends an event to a room. Use this within your
293
- * application’s business logic to send events to clients of a room; e.g., to notify clients
294
- * to change the way the chat UI is rendered.</p>
295
- * </li>
296
- * </ul>
297
- * <p>
298
- * <b>Chat Token Endpoint</b>
299
- * </p>
300
- * <ul>
301
- * <li>
302
- * <p>
303
- * <a>CreateChatToken</a> — Creates an encrypted token that is used by a chat participant to establish an
304
- * individual WebSocket chat connection to a room. When the token is used to connect to chat,
305
- * the connection is valid for the session duration specified in the request. The token
306
- * becomes invalid at the token-expiration timestamp included in the response.</p>
307
- * </li>
308
- * </ul>
309
- * <p>
310
- * <b>Room Endpoints</b>
311
- * </p>
312
- * <ul>
313
- * <li>
314
- * <p>
315
- * <a>CreateRoom</a> — Creates a room that allows clients to connect and
316
- * pass messages.</p>
317
- * </li>
318
- * <li>
319
- * <p>
320
- * <a>DeleteRoom</a> — Deletes the specified room.</p>
321
- * </li>
322
- * <li>
323
- * <p>
324
- * <a>GetRoom</a> — Gets the specified room.</p>
325
- * </li>
326
- * <li>
327
- * <p>
328
- * <a>ListRooms</a> — Gets summary information about all your rooms in
329
- * the AWS region where the API request is processed. </p>
330
- * </li>
331
- * <li>
332
- * <p>
333
- * <a>UpdateRoom</a> — Updates a room’s configuration.</p>
334
- * </li>
335
- * </ul>
336
- * <p>
337
- * <b>Logging Configuration Endpoints</b>
338
- * </p>
339
- * <ul>
340
- * <li>
341
- * <p>
342
- * <a>CreateLoggingConfiguration</a> — Creates a logging configuration that allows clients to store and record sent messages.</p>
343
- * </li>
344
- * <li>
345
- * <p>
346
- * <a>DeleteLoggingConfiguration</a> — Deletes the specified logging
347
- * configuration.</p>
348
- * </li>
349
- * <li>
350
- * <p>
351
- * <a>GetLoggingConfiguration</a> — Gets the specified logging
352
- * configuration.</p>
353
- * </li>
354
- * <li>
355
- * <p>
356
- * <a>ListLoggingConfigurations</a> — Gets summary information about all
357
- * your logging configurations in the AWS region where the API request is processed.</p>
358
- * </li>
359
- * <li>
360
- * <p>
361
- * <a>UpdateLoggingConfiguration</a> — Updates a specified logging configuration.</p>
362
- * </li>
363
- * </ul>
364
- * <p>
365
- * <b>Tags Endpoints</b>
366
- * </p>
367
- * <ul>
368
- * <li>
369
- * <p>
370
- * <a>ListTagsForResource</a> — Gets information about AWS tags for the
371
- * specified ARN.</p>
372
- * </li>
373
- * <li>
374
- * <p>
375
- * <a>TagResource</a> — Adds or updates tags for the AWS resource with
376
- * the specified ARN.</p>
377
- * </li>
378
- * <li>
379
- * <p>
380
- * <a>UntagResource</a> — Removes tags from the resource with the
381
- * specified ARN.</p>
382
- * </li>
383
- * </ul>
384
- * <p>All the above are HTTP operations. There is a separate <i>messaging</i> API
385
- * for managing Chat resources; see the <a href="https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/chat-messaging-api.html"> Amazon IVS Chat Messaging API
386
- * Reference</a>.</p>
387
278
  * @public
388
279
  */
389
280
  export declare class IvschatClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, IvschatClientResolvedConfig> {
package/dist-types/index.d.ts CHANGED
@@ -8,6 +8,9 @@
8
8
  * <p>The API is an AWS regional service. For a list of supported regions and Amazon IVS Chat
9
9
  * HTTPS service endpoints, see the Amazon IVS Chat information on the <a href="https://docs.aws.amazon.com/general/latest/gr/ivs.html">Amazon IVS page</a> in the
10
10
  * <i>AWS General Reference</i>. </p>
11
+ * <p>This document describes HTTP operations. There is a separate <i>messaging</i> API
12
+ * for managing Chat resources; see the <a href="https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/chat-messaging-api.html"> Amazon IVS Chat Messaging API
13
+ * Reference</a>.</p>
11
14
  * <p>
12
15
  * <b>Notes on terminology:</b>
13
16
  * </p>
@@ -22,16 +25,19 @@
22
25
  * </li>
23
26
  * </ul>
24
27
  * <p>
25
- * <b>Key Concepts</b>
28
+ * <b>Resources</b>
26
29
  * </p>
30
+ * <p>The following resources are part of Amazon IVS Chat:</p>
27
31
  * <ul>
28
32
  * <li>
29
33
  * <p>
30
- * <b>LoggingConfiguration</b> — A configuration that allows customers to store and record sent messages in a chat room.</p>
34
+ * <b>LoggingConfiguration</b> — A configuration that allows customers to store and record sent messages in a chat room. See the Logging Configuration endpoints for more information.</p>
31
35
  * </li>
32
36
  * <li>
33
37
  * <p>
34
- * <b>Room</b> — The central Amazon IVS Chat resource through which clients connect to and exchange chat messages.</p>
38
+ * <b>Room</b> — The central Amazon IVS Chat resource through
39
+ * which clients connect to and exchange chat messages. See the Room endpoints for more
40
+ * information.</p>
35
41
  * </li>
36
42
  * </ul>
37
43
  * <p>
@@ -100,121 +106,6 @@
100
106
  * resource unambiguously across all of AWS, such as in IAM policies and API calls. For more
101
107
  * information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names</a> in the <i>AWS General
102
108
  * Reference</i>.</p>
103
- * <p>
104
- * <b>Messaging Endpoints</b>
105
- * </p>
106
- * <ul>
107
- * <li>
108
- * <p>
109
- * <a>DeleteMessage</a> — Sends an event to a specific room which
110
- * directs clients to delete a specific message; that is, unrender it from view and delete it
111
- * from the client’s chat history. This event’s <code>EventName</code> is
112
- * <code>aws:DELETE_MESSAGE</code>. This replicates the <a href="https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-deletemessage-publish.html">
113
- * DeleteMessage</a> WebSocket operation in the Amazon IVS Chat Messaging API.</p>
114
- * </li>
115
- * <li>
116
- * <p>
117
- * <a>DisconnectUser</a> — Disconnects all connections using a specified
118
- * user ID from a room. This replicates the <a href="https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-disconnectuser-publish.html">
119
- * DisconnectUser</a> WebSocket operation in the Amazon IVS Chat Messaging API.</p>
120
- * </li>
121
- * <li>
122
- * <p>
123
- * <a>SendEvent</a> — Sends an event to a room. Use this within your
124
- * application’s business logic to send events to clients of a room; e.g., to notify clients
125
- * to change the way the chat UI is rendered.</p>
126
- * </li>
127
- * </ul>
128
- * <p>
129
- * <b>Chat Token Endpoint</b>
130
- * </p>
131
- * <ul>
132
- * <li>
133
- * <p>
134
- * <a>CreateChatToken</a> — Creates an encrypted token that is used by a chat participant to establish an
135
- * individual WebSocket chat connection to a room. When the token is used to connect to chat,
136
- * the connection is valid for the session duration specified in the request. The token
137
- * becomes invalid at the token-expiration timestamp included in the response.</p>
138
- * </li>
139
- * </ul>
140
- * <p>
141
- * <b>Room Endpoints</b>
142
- * </p>
143
- * <ul>
144
- * <li>
145
- * <p>
146
- * <a>CreateRoom</a> — Creates a room that allows clients to connect and
147
- * pass messages.</p>
148
- * </li>
149
- * <li>
150
- * <p>
151
- * <a>DeleteRoom</a> — Deletes the specified room.</p>
152
- * </li>
153
- * <li>
154
- * <p>
155
- * <a>GetRoom</a> — Gets the specified room.</p>
156
- * </li>
157
- * <li>
158
- * <p>
159
- * <a>ListRooms</a> — Gets summary information about all your rooms in
160
- * the AWS region where the API request is processed. </p>
161
- * </li>
162
- * <li>
163
- * <p>
164
- * <a>UpdateRoom</a> — Updates a room’s configuration.</p>
165
- * </li>
166
- * </ul>
167
- * <p>
168
- * <b>Logging Configuration Endpoints</b>
169
- * </p>
170
- * <ul>
171
- * <li>
172
- * <p>
173
- * <a>CreateLoggingConfiguration</a> — Creates a logging configuration that allows clients to store and record sent messages.</p>
174
- * </li>
175
- * <li>
176
- * <p>
177
- * <a>DeleteLoggingConfiguration</a> — Deletes the specified logging
178
- * configuration.</p>
179
- * </li>
180
- * <li>
181
- * <p>
182
- * <a>GetLoggingConfiguration</a> — Gets the specified logging
183
- * configuration.</p>
184
- * </li>
185
- * <li>
186
- * <p>
187
- * <a>ListLoggingConfigurations</a> — Gets summary information about all
188
- * your logging configurations in the AWS region where the API request is processed.</p>
189
- * </li>
190
- * <li>
191
- * <p>
192
- * <a>UpdateLoggingConfiguration</a> — Updates a specified logging configuration.</p>
193
- * </li>
194
- * </ul>
195
- * <p>
196
- * <b>Tags Endpoints</b>
197
- * </p>
198
- * <ul>
199
- * <li>
200
- * <p>
201
- * <a>ListTagsForResource</a> — Gets information about AWS tags for the
202
- * specified ARN.</p>
203
- * </li>
204
- * <li>
205
- * <p>
206
- * <a>TagResource</a> — Adds or updates tags for the AWS resource with
207
- * the specified ARN.</p>
208
- * </li>
209
- * <li>
210
- * <p>
211
- * <a>UntagResource</a> — Removes tags from the resource with the
212
- * specified ARN.</p>
213
- * </li>
214
- * </ul>
215
- * <p>All the above are HTTP operations. There is a separate <i>messaging</i> API
216
- * for managing Chat resources; see the <a href="https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/chat-messaging-api.html"> Amazon IVS Chat Messaging API
217
- * Reference</a>.</p>
218
109
  *
219
110
  * @packageDocumentation
220
111
  */
package/dist-types/runtimeConfig.browser.d.ts CHANGED
@@ -32,8 +32,8 @@ export declare const getRuntimeConfig: (config: IvschatClientConfig) => {
32
32
  logger?: import("@smithy/types").Logger | undefined;
33
33
  }) => import("@smithy/types").EndpointV2;
34
34
  tls?: boolean | undefined;
35
- retryStrategy?: import("@smithy/types").RetryStrategy | import("@smithy/types").RetryStrategyV2 | undefined;
36
35
  customUserAgent?: string | import("@smithy/types").UserAgent | undefined;
36
+ retryStrategy?: import("@smithy/types").RetryStrategy | import("@smithy/types").RetryStrategyV2 | undefined;
37
37
  httpAuthSchemes: import("@smithy/types").HttpAuthScheme[];
38
38
  httpAuthSchemeProvider: import("./auth/httpAuthSchemeProvider").IvschatHttpAuthSchemeProvider;
39
39
  credentials?: import("@smithy/types").AwsCredentialIdentity | import("@smithy/types").AwsCredentialIdentityProvider | undefined;
package/dist-types/runtimeConfig.d.ts CHANGED
@@ -32,8 +32,8 @@ export declare const getRuntimeConfig: (config: IvschatClientConfig) => {
32
32
  logger?: import("@smithy/types").Logger | undefined;
33
33
  }) => import("@smithy/types").EndpointV2;
34
34
  tls?: boolean | undefined;
35
- retryStrategy?: import("@smithy/types").RetryStrategy | import("@smithy/types").RetryStrategyV2 | undefined;
36
35
  customUserAgent?: string | import("@smithy/types").UserAgent | undefined;
36
+ retryStrategy?: import("@smithy/types").RetryStrategy | import("@smithy/types").RetryStrategyV2 | undefined;
37
37
  httpAuthSchemes: import("@smithy/types").HttpAuthScheme[];
38
38
  httpAuthSchemeProvider: import("./auth/httpAuthSchemeProvider").IvschatHttpAuthSchemeProvider;
39
39
  credentials?: import("@smithy/types").AwsCredentialIdentity | import("@smithy/types").AwsCredentialIdentityProvider | undefined;
package/dist-types/runtimeConfig.native.d.ts CHANGED
@@ -31,8 +31,8 @@ export declare const getRuntimeConfig: (config: IvschatClientConfig) => {
31
31
  logger?: import("@smithy/types").Logger | undefined;
32
32
  }) => import("@smithy/types").EndpointV2;
33
33
  tls?: boolean | undefined;
34
- retryStrategy?: import("@smithy/types").RetryStrategy | import("@smithy/types").RetryStrategyV2 | undefined;
35
34
  customUserAgent?: string | import("@smithy/types").UserAgent | undefined;
35
+ retryStrategy?: import("@smithy/types").RetryStrategy | import("@smithy/types").RetryStrategyV2 | undefined;
36
36
  httpAuthSchemes: import("@smithy/types").HttpAuthScheme[];
37
37
  httpAuthSchemeProvider: import("./auth/httpAuthSchemeProvider").IvschatHttpAuthSchemeProvider;
38
38
  credentials?: import("@smithy/types").AwsCredentialIdentity | import("@smithy/types").AwsCredentialIdentityProvider | undefined;
package/dist-types/ts3.4/IvschatClient.d.ts CHANGED
@@ -187,9 +187,9 @@ export type IvschatClientConfigType = Partial<
187
187
  ClientDefaults &
188
188
  RegionInputConfig &
189
189
  EndpointInputConfig<EndpointParameters> &
190
- RetryInputConfig &
191
190
  HostHeaderInputConfig &
192
191
  UserAgentInputConfig &
192
+ RetryInputConfig &
193
193
  HttpAuthSchemeInputConfig &
194
194
  ClientInputEndpointParameters;
195
195
  export interface IvschatClientConfig extends IvschatClientConfigType {}
@@ -199,9 +199,9 @@ export type IvschatClientResolvedConfigType =
199
199
  RuntimeExtensionsConfig &
200
200
  RegionResolvedConfig &
201
201
  EndpointResolvedConfig<EndpointParameters> &
202
- RetryResolvedConfig &
203
202
  HostHeaderResolvedConfig &
204
203
  UserAgentResolvedConfig &
204
+ RetryResolvedConfig &
205
205
  HttpAuthSchemeResolvedConfig &
206
206
  ClientResolvedEndpointParameters;
207
207
  export interface IvschatClientResolvedConfig
package/dist-types/ts3.4/runtimeConfig.browser.d.ts CHANGED
@@ -56,11 +56,11 @@ export declare const getRuntimeConfig: (config: IvschatClientConfig) => {
56
56
  }
57
57
  ) => import("@smithy/types").EndpointV2;
58
58
  tls?: boolean | undefined;
59
+ customUserAgent?: string | import("@smithy/types").UserAgent | undefined;
59
60
  retryStrategy?:
60
61
  | import("@smithy/types").RetryStrategy
61
62
  | import("@smithy/types").RetryStrategyV2
62
63
  | undefined;
63
- customUserAgent?: string | import("@smithy/types").UserAgent | undefined;
64
64
  httpAuthSchemes: import("@smithy/types").HttpAuthScheme[];
65
65
  httpAuthSchemeProvider: import("./auth/httpAuthSchemeProvider").IvschatHttpAuthSchemeProvider;
66
66
  credentials?:
package/dist-types/ts3.4/runtimeConfig.d.ts CHANGED
@@ -60,11 +60,11 @@ export declare const getRuntimeConfig: (config: IvschatClientConfig) => {
60
60
  }
61
61
  ) => import("@smithy/types").EndpointV2;
62
62
  tls?: boolean | undefined;
63
+ customUserAgent?: string | import("@smithy/types").UserAgent | undefined;
63
64
  retryStrategy?:
64
65
  | import("@smithy/types").RetryStrategy
65
66
  | import("@smithy/types").RetryStrategyV2
66
67
  | undefined;
67
- customUserAgent?: string | import("@smithy/types").UserAgent | undefined;
68
68
  httpAuthSchemes: import("@smithy/types").HttpAuthScheme[];
69
69
  httpAuthSchemeProvider: import("./auth/httpAuthSchemeProvider").IvschatHttpAuthSchemeProvider;
70
70
  credentials?:
package/dist-types/ts3.4/runtimeConfig.native.d.ts CHANGED
@@ -50,11 +50,11 @@ export declare const getRuntimeConfig: (config: IvschatClientConfig) => {
50
50
  }
51
51
  ) => import("@smithy/types").EndpointV2;
52
52
  tls?: boolean | undefined;
53
+ customUserAgent?: string | import("@smithy/types").UserAgent | undefined;
53
54
  retryStrategy?:
54
55
  | import("@smithy/types").RetryStrategy
55
56
  | import("@smithy/types").RetryStrategyV2
56
57
  | undefined;
57
- customUserAgent?: string | import("@smithy/types").UserAgent | undefined;
58
58
  httpAuthSchemes: import("@smithy/types").HttpAuthScheme[];
59
59
  httpAuthSchemeProvider: import("./auth/httpAuthSchemeProvider").IvschatHttpAuthSchemeProvider;
60
60
  credentials?:
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-ivschat",
3
3
  "description": "AWS SDK for JavaScript Ivschat Client for Node.js, Browser and React Native",
4
- "version": "3.614.0",
4
+ "version": "3.620.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-ivschat",
@@ -20,40 +20,40 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "5.2.0",
22
22
  "@aws-crypto/sha256-js": "5.2.0",
23
- "@aws-sdk/client-sso-oidc": "3.614.0",
24
- "@aws-sdk/client-sts": "3.614.0",
25
- "@aws-sdk/core": "3.614.0",
26
- "@aws-sdk/credential-provider-node": "3.614.0",
27
- "@aws-sdk/middleware-host-header": "3.609.0",
23
+ "@aws-sdk/client-sso-oidc": "3.620.0",
24
+ "@aws-sdk/client-sts": "3.620.0",
25
+ "@aws-sdk/core": "3.620.0",
26
+ "@aws-sdk/credential-provider-node": "3.620.0",
27
+ "@aws-sdk/middleware-host-header": "3.620.0",
28
28
  "@aws-sdk/middleware-logger": "3.609.0",
29
- "@aws-sdk/middleware-recursion-detection": "3.609.0",
30
- "@aws-sdk/middleware-user-agent": "3.614.0",
29
+ "@aws-sdk/middleware-recursion-detection": "3.620.0",
30
+ "@aws-sdk/middleware-user-agent": "3.620.0",
31
31
  "@aws-sdk/region-config-resolver": "3.614.0",
32
32
  "@aws-sdk/types": "3.609.0",
33
33
  "@aws-sdk/util-endpoints": "3.614.0",
34
34
  "@aws-sdk/util-user-agent-browser": "3.609.0",
35
35
  "@aws-sdk/util-user-agent-node": "3.614.0",
36
36
  "@smithy/config-resolver": "^3.0.5",
37
- "@smithy/core": "^2.2.6",
38
- "@smithy/fetch-http-handler": "^3.2.1",
37
+ "@smithy/core": "^2.3.0",
38
+ "@smithy/fetch-http-handler": "^3.2.3",
39
39
  "@smithy/hash-node": "^3.0.3",
40
40
  "@smithy/invalid-dependency": "^3.0.3",
41
- "@smithy/middleware-content-length": "^3.0.3",
42
- "@smithy/middleware-endpoint": "^3.0.5",
43
- "@smithy/middleware-retry": "^3.0.9",
41
+ "@smithy/middleware-content-length": "^3.0.5",
42
+ "@smithy/middleware-endpoint": "^3.1.0",
43
+ "@smithy/middleware-retry": "^3.0.12",
44
44
  "@smithy/middleware-serde": "^3.0.3",
45
45
  "@smithy/middleware-stack": "^3.0.3",
46
46
  "@smithy/node-config-provider": "^3.1.4",
47
- "@smithy/node-http-handler": "^3.1.2",
48
- "@smithy/protocol-http": "^4.0.3",
49
- "@smithy/smithy-client": "^3.1.7",
47
+ "@smithy/node-http-handler": "^3.1.4",
48
+ "@smithy/protocol-http": "^4.1.0",
49
+ "@smithy/smithy-client": "^3.1.10",
50
50
  "@smithy/types": "^3.3.0",
51
51
  "@smithy/url-parser": "^3.0.3",
52
52
  "@smithy/util-base64": "^3.0.0",
53
53
  "@smithy/util-body-length-browser": "^3.0.0",
54
54
  "@smithy/util-body-length-node": "^3.0.0",
55
- "@smithy/util-defaults-mode-browser": "^3.0.9",
56
- "@smithy/util-defaults-mode-node": "^3.0.9",
55
+ "@smithy/util-defaults-mode-browser": "^3.0.12",
56
+ "@smithy/util-defaults-mode-node": "^3.0.12",
57
57
  "@smithy/util-endpoints": "^2.0.5",
58
58
  "@smithy/util-middleware": "^3.0.3",
59
59
  "@smithy/util-retry": "^3.0.3",