@aws-sdk/client-ivschat 3.295.0 → 3.297.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 (25) hide show
  1. package/dist-types/Ivschat.d.ts +18 -0
  2. package/dist-types/IvschatClient.d.ts +24 -4
  3. package/dist-types/commands/CreateChatTokenCommand.d.ts +16 -0
  4. package/dist-types/commands/CreateLoggingConfigurationCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateRoomCommand.d.ts +16 -0
  6. package/dist-types/commands/DeleteLoggingConfigurationCommand.d.ts +16 -0
  7. package/dist-types/commands/DeleteMessageCommand.d.ts +16 -0
  8. package/dist-types/commands/DeleteRoomCommand.d.ts +16 -0
  9. package/dist-types/commands/DisconnectUserCommand.d.ts +16 -0
  10. package/dist-types/commands/GetLoggingConfigurationCommand.d.ts +16 -0
  11. package/dist-types/commands/GetRoomCommand.d.ts +16 -0
  12. package/dist-types/commands/ListLoggingConfigurationsCommand.d.ts +16 -0
  13. package/dist-types/commands/ListRoomsCommand.d.ts +16 -0
  14. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  15. package/dist-types/commands/SendEventCommand.d.ts +16 -0
  16. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  17. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  18. package/dist-types/commands/UpdateLoggingConfigurationCommand.d.ts +16 -0
  19. package/dist-types/commands/UpdateRoomCommand.d.ts +16 -0
  20. package/dist-types/models/IvschatServiceException.d.ts +2 -0
  21. package/dist-types/models/models_0.d.ts +136 -0
  22. package/dist-types/pagination/Interfaces.d.ts +3 -0
  23. package/dist-types/pagination/ListLoggingConfigurationsPaginator.d.ts +3 -0
  24. package/dist-types/pagination/ListRoomsPaginator.d.ts +3 -0
  25. package/package.json +29 -29
@@ -18,6 +18,7 @@ import { UpdateLoggingConfigurationCommandInput, UpdateLoggingConfigurationComma
18
18
  import { UpdateRoomCommandInput, UpdateRoomCommandOutput } from "./commands/UpdateRoomCommand";
19
19
  import { IvschatClient } from "./IvschatClient";
20
20
  /**
21
+ * @public
21
22
  * <p>
22
23
  * <b>Introduction</b>
23
24
  * </p>
@@ -240,6 +241,7 @@ import { IvschatClient } from "./IvschatClient";
240
241
  */
241
242
  export declare class Ivschat extends IvschatClient {
242
243
  /**
244
+ * @public
243
245
  * <p>Creates an encrypted token that is used by a chat participant to establish an individual
244
246
  * WebSocket chat connection to a room. When the token is used to connect to chat, the
245
247
  * connection is valid for the session duration specified in the request. The token becomes
@@ -257,6 +259,7 @@ export declare class Ivschat extends IvschatClient {
257
259
  createChatToken(args: CreateChatTokenCommandInput, cb: (err: any, data?: CreateChatTokenCommandOutput) => void): void;
258
260
  createChatToken(args: CreateChatTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateChatTokenCommandOutput) => void): void;
259
261
  /**
262
+ * @public
260
263
  * <p>Creates a logging configuration that allows clients to store and record sent
261
264
  * messages.</p>
262
265
  */
@@ -264,18 +267,21 @@ export declare class Ivschat extends IvschatClient {
264
267
  createLoggingConfiguration(args: CreateLoggingConfigurationCommandInput, cb: (err: any, data?: CreateLoggingConfigurationCommandOutput) => void): void;
265
268
  createLoggingConfiguration(args: CreateLoggingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLoggingConfigurationCommandOutput) => void): void;
266
269
  /**
270
+ * @public
267
271
  * <p>Creates a room that allows clients to connect and pass messages.</p>
268
272
  */
269
273
  createRoom(args: CreateRoomCommandInput, options?: __HttpHandlerOptions): Promise<CreateRoomCommandOutput>;
270
274
  createRoom(args: CreateRoomCommandInput, cb: (err: any, data?: CreateRoomCommandOutput) => void): void;
271
275
  createRoom(args: CreateRoomCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRoomCommandOutput) => void): void;
272
276
  /**
277
+ * @public
273
278
  * <p>Deletes the specified logging configuration.</p>
274
279
  */
275
280
  deleteLoggingConfiguration(args: DeleteLoggingConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<DeleteLoggingConfigurationCommandOutput>;
276
281
  deleteLoggingConfiguration(args: DeleteLoggingConfigurationCommandInput, cb: (err: any, data?: DeleteLoggingConfigurationCommandOutput) => void): void;
277
282
  deleteLoggingConfiguration(args: DeleteLoggingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLoggingConfigurationCommandOutput) => void): void;
278
283
  /**
284
+ * @public
279
285
  * <p>Sends an event to a specific room which directs clients to delete a specific message;
280
286
  * that is, unrender it from view and delete it from the client’s chat history. This event’s
281
287
  * <code>EventName</code> is <code>aws:DELETE_MESSAGE</code>. This replicates the <a href="https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-deletemessage-publish.html">
@@ -285,12 +291,14 @@ export declare class Ivschat extends IvschatClient {
285
291
  deleteMessage(args: DeleteMessageCommandInput, cb: (err: any, data?: DeleteMessageCommandOutput) => void): void;
286
292
  deleteMessage(args: DeleteMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMessageCommandOutput) => void): void;
287
293
  /**
294
+ * @public
288
295
  * <p>Deletes the specified room.</p>
289
296
  */
290
297
  deleteRoom(args: DeleteRoomCommandInput, options?: __HttpHandlerOptions): Promise<DeleteRoomCommandOutput>;
291
298
  deleteRoom(args: DeleteRoomCommandInput, cb: (err: any, data?: DeleteRoomCommandOutput) => void): void;
292
299
  deleteRoom(args: DeleteRoomCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRoomCommandOutput) => void): void;
293
300
  /**
301
+ * @public
294
302
  * <p>Disconnects all connections using a specified user ID from a room. This replicates the
295
303
  * <a href="https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-disconnectuser-publish.html">
296
304
  * DisconnectUser</a> WebSocket operation in the Amazon IVS Chat Messaging API.</p>
@@ -299,18 +307,21 @@ export declare class Ivschat extends IvschatClient {
299
307
  disconnectUser(args: DisconnectUserCommandInput, cb: (err: any, data?: DisconnectUserCommandOutput) => void): void;
300
308
  disconnectUser(args: DisconnectUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisconnectUserCommandOutput) => void): void;
301
309
  /**
310
+ * @public
302
311
  * <p>Gets the specified logging configuration.</p>
303
312
  */
304
313
  getLoggingConfiguration(args: GetLoggingConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<GetLoggingConfigurationCommandOutput>;
305
314
  getLoggingConfiguration(args: GetLoggingConfigurationCommandInput, cb: (err: any, data?: GetLoggingConfigurationCommandOutput) => void): void;
306
315
  getLoggingConfiguration(args: GetLoggingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLoggingConfigurationCommandOutput) => void): void;
307
316
  /**
317
+ * @public
308
318
  * <p>Gets the specified room.</p>
309
319
  */
310
320
  getRoom(args: GetRoomCommandInput, options?: __HttpHandlerOptions): Promise<GetRoomCommandOutput>;
311
321
  getRoom(args: GetRoomCommandInput, cb: (err: any, data?: GetRoomCommandOutput) => void): void;
312
322
  getRoom(args: GetRoomCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRoomCommandOutput) => void): void;
313
323
  /**
324
+ * @public
314
325
  * <p>Gets summary information about all your logging configurations in the AWS region where
315
326
  * the API request is processed.</p>
316
327
  */
@@ -318,6 +329,7 @@ export declare class Ivschat extends IvschatClient {
318
329
  listLoggingConfigurations(args: ListLoggingConfigurationsCommandInput, cb: (err: any, data?: ListLoggingConfigurationsCommandOutput) => void): void;
319
330
  listLoggingConfigurations(args: ListLoggingConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLoggingConfigurationsCommandOutput) => void): void;
320
331
  /**
332
+ * @public
321
333
  * <p>Gets summary information about all your rooms in the AWS region where the API request is
322
334
  * processed. Results are sorted in descending order of <code>updateTime</code>.</p>
323
335
  */
@@ -325,12 +337,14 @@ export declare class Ivschat extends IvschatClient {
325
337
  listRooms(args: ListRoomsCommandInput, cb: (err: any, data?: ListRoomsCommandOutput) => void): void;
326
338
  listRooms(args: ListRoomsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRoomsCommandOutput) => void): void;
327
339
  /**
340
+ * @public
328
341
  * <p>Gets information about AWS tags for the specified ARN.</p>
329
342
  */
330
343
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
331
344
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
332
345
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
333
346
  /**
347
+ * @public
334
348
  * <p>Sends an event to a room. Use this within your application’s business logic to send
335
349
  * events to clients of a room; e.g., to notify clients to change the way the chat UI is
336
350
  * rendered.</p>
@@ -339,24 +353,28 @@ export declare class Ivschat extends IvschatClient {
339
353
  sendEvent(args: SendEventCommandInput, cb: (err: any, data?: SendEventCommandOutput) => void): void;
340
354
  sendEvent(args: SendEventCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendEventCommandOutput) => void): void;
341
355
  /**
356
+ * @public
342
357
  * <p>Adds or updates tags for the AWS resource with the specified ARN.</p>
343
358
  */
344
359
  tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
345
360
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
346
361
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
347
362
  /**
363
+ * @public
348
364
  * <p>Removes tags from the resource with the specified ARN.</p>
349
365
  */
350
366
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
351
367
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
352
368
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
353
369
  /**
370
+ * @public
354
371
  * <p>Updates a specified logging configuration.</p>
355
372
  */
356
373
  updateLoggingConfiguration(args: UpdateLoggingConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<UpdateLoggingConfigurationCommandOutput>;
357
374
  updateLoggingConfiguration(args: UpdateLoggingConfigurationCommandInput, cb: (err: any, data?: UpdateLoggingConfigurationCommandOutput) => void): void;
358
375
  updateLoggingConfiguration(args: UpdateLoggingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateLoggingConfigurationCommandOutput) => void): void;
359
376
  /**
377
+ * @public
360
378
  * <p>Updates a room’s configuration.</p>
361
379
  */
362
380
  updateRoom(args: UpdateRoomCommandInput, options?: __HttpHandlerOptions): Promise<UpdateRoomCommandOutput>;
@@ -25,15 +25,24 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./command
25
25
  import { UpdateLoggingConfigurationCommandInput, UpdateLoggingConfigurationCommandOutput } from "./commands/UpdateLoggingConfigurationCommand";
26
26
  import { UpdateRoomCommandInput, UpdateRoomCommandOutput } from "./commands/UpdateRoomCommand";
27
27
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
28
+ /**
29
+ * @public
30
+ */
28
31
  export type ServiceInputTypes = CreateChatTokenCommandInput | CreateLoggingConfigurationCommandInput | CreateRoomCommandInput | DeleteLoggingConfigurationCommandInput | DeleteMessageCommandInput | DeleteRoomCommandInput | DisconnectUserCommandInput | GetLoggingConfigurationCommandInput | GetRoomCommandInput | ListLoggingConfigurationsCommandInput | ListRoomsCommandInput | ListTagsForResourceCommandInput | SendEventCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateLoggingConfigurationCommandInput | UpdateRoomCommandInput;
32
+ /**
33
+ * @public
34
+ */
29
35
  export type ServiceOutputTypes = CreateChatTokenCommandOutput | CreateLoggingConfigurationCommandOutput | CreateRoomCommandOutput | DeleteLoggingConfigurationCommandOutput | DeleteMessageCommandOutput | DeleteRoomCommandOutput | DisconnectUserCommandOutput | GetLoggingConfigurationCommandOutput | GetRoomCommandOutput | ListLoggingConfigurationsCommandOutput | ListRoomsCommandOutput | ListTagsForResourceCommandOutput | SendEventCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateLoggingConfigurationCommandOutput | UpdateRoomCommandOutput;
36
+ /**
37
+ * @public
38
+ */
30
39
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
31
40
  /**
32
41
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
33
42
  */
34
43
  requestHandler?: __HttpHandler;
35
44
  /**
36
- * A constructor for a class implementing the {@link __Checksum} interface
45
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
37
46
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
38
47
  * @internal
39
48
  */
@@ -123,23 +132,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
123
132
  */
124
133
  logger?: __Logger;
125
134
  /**
126
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
135
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
127
136
  */
128
137
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
129
138
  }
139
+ /**
140
+ * @public
141
+ */
130
142
  type IvschatClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
131
143
  /**
132
- * The configuration interface of IvschatClient class constructor that set the region, credentials and other options.
144
+ * @public
145
+ *
146
+ * The configuration interface of IvschatClient class constructor that set the region, credentials and other options.
133
147
  */
134
148
  export interface IvschatClientConfig extends IvschatClientConfigType {
135
149
  }
150
+ /**
151
+ * @public
152
+ */
136
153
  type IvschatClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
137
154
  /**
138
- * The resolved configuration interface of IvschatClient class. This is resolved and normalized from the {@link IvschatClientConfig | constructor configuration interface}.
155
+ * @public
156
+ *
157
+ * The resolved configuration interface of IvschatClient class. This is resolved and normalized from the {@link IvschatClientConfig | constructor configuration interface}.
139
158
  */
140
159
  export interface IvschatClientResolvedConfig extends IvschatClientResolvedConfigType {
141
160
  }
142
161
  /**
162
+ * @public
143
163
  * <p>
144
164
  * <b>Introduction</b>
145
165
  * </p>
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IvschatClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IvschatClient";
5
5
  import { CreateChatTokenRequest, CreateChatTokenResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateChatTokenCommand}.
8
10
  */
9
11
  export interface CreateChatTokenCommandInput extends CreateChatTokenRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateChatTokenCommand}.
13
17
  */
14
18
  export interface CreateChatTokenCommandOutput extends CreateChatTokenResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates an encrypted token that is used by a chat participant to establish an individual
18
23
  * WebSocket chat connection to a room. When the token is used to connect to chat, the
19
24
  * connection is valid for the session duration specified in the request. The token becomes
@@ -36,6 +41,8 @@ export interface CreateChatTokenCommandOutput extends CreateChatTokenResponse, _
36
41
  * const response = await client.send(command);
37
42
  * ```
38
43
  *
44
+ * @param CreateChatTokenCommandInput - {@link CreateChatTokenCommandInput}
45
+ * @returns {@link CreateChatTokenCommandOutput}
39
46
  * @see {@link CreateChatTokenCommandInput} for command's `input` shape.
40
47
  * @see {@link CreateChatTokenCommandOutput} for command's `response` shape.
41
48
  * @see {@link IvschatClientResolvedConfig | config} for IvschatClient's `config` shape.
@@ -57,11 +64,20 @@ export interface CreateChatTokenCommandOutput extends CreateChatTokenResponse, _
57
64
  export declare class CreateChatTokenCommand extends $Command<CreateChatTokenCommandInput, CreateChatTokenCommandOutput, IvschatClientResolvedConfig> {
58
65
  readonly input: CreateChatTokenCommandInput;
59
66
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
67
+ /**
68
+ * @public
69
+ */
60
70
  constructor(input: CreateChatTokenCommandInput);
61
71
  /**
62
72
  * @internal
63
73
  */
64
74
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IvschatClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateChatTokenCommandInput, CreateChatTokenCommandOutput>;
75
+ /**
76
+ * @internal
77
+ */
65
78
  private serialize;
79
+ /**
80
+ * @internal
81
+ */
66
82
  private deserialize;
67
83
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IvschatClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IvschatClient";
5
5
  import { CreateLoggingConfigurationRequest, CreateLoggingConfigurationResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateLoggingConfigurationCommand}.
8
10
  */
9
11
  export interface CreateLoggingConfigurationCommandInput extends CreateLoggingConfigurationRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateLoggingConfigurationCommand}.
13
17
  */
14
18
  export interface CreateLoggingConfigurationCommandOutput extends CreateLoggingConfigurationResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a logging configuration that allows clients to store and record sent
18
23
  * messages.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface CreateLoggingConfigurationCommandOutput extends CreateLoggingCo
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param CreateLoggingConfigurationCommandInput - {@link CreateLoggingConfigurationCommandInput}
35
+ * @returns {@link CreateLoggingConfigurationCommandOutput}
29
36
  * @see {@link CreateLoggingConfigurationCommandInput} for command's `input` shape.
30
37
  * @see {@link CreateLoggingConfigurationCommandOutput} for command's `response` shape.
31
38
  * @see {@link IvschatClientResolvedConfig | config} for IvschatClient's `config` shape.
@@ -53,11 +60,20 @@ export interface CreateLoggingConfigurationCommandOutput extends CreateLoggingCo
53
60
  export declare class CreateLoggingConfigurationCommand extends $Command<CreateLoggingConfigurationCommandInput, CreateLoggingConfigurationCommandOutput, IvschatClientResolvedConfig> {
54
61
  readonly input: CreateLoggingConfigurationCommandInput;
55
62
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
63
+ /**
64
+ * @public
65
+ */
56
66
  constructor(input: CreateLoggingConfigurationCommandInput);
57
67
  /**
58
68
  * @internal
59
69
  */
60
70
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IvschatClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateLoggingConfigurationCommandInput, CreateLoggingConfigurationCommandOutput>;
71
+ /**
72
+ * @internal
73
+ */
61
74
  private serialize;
75
+ /**
76
+ * @internal
77
+ */
62
78
  private deserialize;
63
79
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IvschatClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IvschatClient";
5
5
  import { CreateRoomRequest, CreateRoomResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateRoomCommand}.
8
10
  */
9
11
  export interface CreateRoomCommandInput extends CreateRoomRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateRoomCommand}.
13
17
  */
14
18
  export interface CreateRoomCommandOutput extends CreateRoomResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a room that allows clients to connect and pass messages.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateRoomCommandOutput extends CreateRoomResponse, __MetadataB
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateRoomCommandInput - {@link CreateRoomCommandInput}
34
+ * @returns {@link CreateRoomCommandOutput}
28
35
  * @see {@link CreateRoomCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateRoomCommandOutput} for command's `response` shape.
30
37
  * @see {@link IvschatClientResolvedConfig | config} for IvschatClient's `config` shape.
@@ -52,11 +59,20 @@ export interface CreateRoomCommandOutput extends CreateRoomResponse, __MetadataB
52
59
  export declare class CreateRoomCommand extends $Command<CreateRoomCommandInput, CreateRoomCommandOutput, IvschatClientResolvedConfig> {
53
60
  readonly input: CreateRoomCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: CreateRoomCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IvschatClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateRoomCommandInput, CreateRoomCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IvschatClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IvschatClient";
5
5
  import { DeleteLoggingConfigurationRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteLoggingConfigurationCommand}.
8
10
  */
9
11
  export interface DeleteLoggingConfigurationCommandInput extends DeleteLoggingConfigurationRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteLoggingConfigurationCommand}.
13
17
  */
14
18
  export interface DeleteLoggingConfigurationCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes the specified logging configuration.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DeleteLoggingConfigurationCommandOutput extends __MetadataBeare
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteLoggingConfigurationCommandInput - {@link DeleteLoggingConfigurationCommandInput}
34
+ * @returns {@link DeleteLoggingConfigurationCommandOutput}
28
35
  * @see {@link DeleteLoggingConfigurationCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteLoggingConfigurationCommandOutput} for command's `response` shape.
30
37
  * @see {@link IvschatClientResolvedConfig | config} for IvschatClient's `config` shape.
@@ -49,11 +56,20 @@ export interface DeleteLoggingConfigurationCommandOutput extends __MetadataBeare
49
56
  export declare class DeleteLoggingConfigurationCommand extends $Command<DeleteLoggingConfigurationCommandInput, DeleteLoggingConfigurationCommandOutput, IvschatClientResolvedConfig> {
50
57
  readonly input: DeleteLoggingConfigurationCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: DeleteLoggingConfigurationCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IvschatClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteLoggingConfigurationCommandInput, DeleteLoggingConfigurationCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IvschatClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IvschatClient";
5
5
  import { DeleteMessageRequest, DeleteMessageResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteMessageCommand}.
8
10
  */
9
11
  export interface DeleteMessageCommandInput extends DeleteMessageRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteMessageCommand}.
13
17
  */
14
18
  export interface DeleteMessageCommandOutput extends DeleteMessageResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Sends an event to a specific room which directs clients to delete a specific message;
18
23
  * that is, unrender it from view and delete it from the client’s chat history. This event’s
19
24
  * <code>EventName</code> is <code>aws:DELETE_MESSAGE</code>. This replicates the <a href="https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-deletemessage-publish.html">
@@ -28,6 +33,8 @@ export interface DeleteMessageCommandOutput extends DeleteMessageResponse, __Met
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param DeleteMessageCommandInput - {@link DeleteMessageCommandInput}
37
+ * @returns {@link DeleteMessageCommandOutput}
31
38
  * @see {@link DeleteMessageCommandInput} for command's `input` shape.
32
39
  * @see {@link DeleteMessageCommandOutput} for command's `response` shape.
33
40
  * @see {@link IvschatClientResolvedConfig | config} for IvschatClient's `config` shape.
@@ -52,11 +59,20 @@ export interface DeleteMessageCommandOutput extends DeleteMessageResponse, __Met
52
59
  export declare class DeleteMessageCommand extends $Command<DeleteMessageCommandInput, DeleteMessageCommandOutput, IvschatClientResolvedConfig> {
53
60
  readonly input: DeleteMessageCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: DeleteMessageCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IvschatClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteMessageCommandInput, DeleteMessageCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IvschatClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IvschatClient";
5
5
  import { DeleteRoomRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteRoomCommand}.
8
10
  */
9
11
  export interface DeleteRoomCommandInput extends DeleteRoomRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteRoomCommand}.
13
17
  */
14
18
  export interface DeleteRoomCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes the specified room.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DeleteRoomCommandOutput extends __MetadataBearer {
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteRoomCommandInput - {@link DeleteRoomCommandInput}
34
+ * @returns {@link DeleteRoomCommandOutput}
28
35
  * @see {@link DeleteRoomCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteRoomCommandOutput} for command's `response` shape.
30
37
  * @see {@link IvschatClientResolvedConfig | config} for IvschatClient's `config` shape.
@@ -46,11 +53,20 @@ export interface DeleteRoomCommandOutput extends __MetadataBearer {
46
53
  export declare class DeleteRoomCommand extends $Command<DeleteRoomCommandInput, DeleteRoomCommandOutput, IvschatClientResolvedConfig> {
47
54
  readonly input: DeleteRoomCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: DeleteRoomCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IvschatClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteRoomCommandInput, DeleteRoomCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IvschatClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IvschatClient";
5
5
  import { DisconnectUserRequest, DisconnectUserResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DisconnectUserCommand}.
8
10
  */
9
11
  export interface DisconnectUserCommandInput extends DisconnectUserRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DisconnectUserCommand}.
13
17
  */
14
18
  export interface DisconnectUserCommandOutput extends DisconnectUserResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Disconnects all connections using a specified user ID from a room. This replicates the
18
23
  * <a href="https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-disconnectuser-publish.html">
19
24
  * DisconnectUser</a> WebSocket operation in the Amazon IVS Chat Messaging API.</p>
@@ -27,6 +32,8 @@ export interface DisconnectUserCommandOutput extends DisconnectUserResponse, __M
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param DisconnectUserCommandInput - {@link DisconnectUserCommandInput}
36
+ * @returns {@link DisconnectUserCommandOutput}
30
37
  * @see {@link DisconnectUserCommandInput} for command's `input` shape.
31
38
  * @see {@link DisconnectUserCommandOutput} for command's `response` shape.
32
39
  * @see {@link IvschatClientResolvedConfig | config} for IvschatClient's `config` shape.
@@ -51,11 +58,20 @@ export interface DisconnectUserCommandOutput extends DisconnectUserResponse, __M
51
58
  export declare class DisconnectUserCommand extends $Command<DisconnectUserCommandInput, DisconnectUserCommandOutput, IvschatClientResolvedConfig> {
52
59
  readonly input: DisconnectUserCommandInput;
53
60
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
61
+ /**
62
+ * @public
63
+ */
54
64
  constructor(input: DisconnectUserCommandInput);
55
65
  /**
56
66
  * @internal
57
67
  */
58
68
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IvschatClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DisconnectUserCommandInput, DisconnectUserCommandOutput>;
69
+ /**
70
+ * @internal
71
+ */
59
72
  private serialize;
73
+ /**
74
+ * @internal
75
+ */
60
76
  private deserialize;
61
77
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IvschatClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IvschatClient";
5
5
  import { GetLoggingConfigurationRequest, GetLoggingConfigurationResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetLoggingConfigurationCommand}.
8
10
  */
9
11
  export interface GetLoggingConfigurationCommandInput extends GetLoggingConfigurationRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetLoggingConfigurationCommand}.
13
17
  */
14
18
  export interface GetLoggingConfigurationCommandOutput extends GetLoggingConfigurationResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets the specified logging configuration.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface GetLoggingConfigurationCommandOutput extends GetLoggingConfigur
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetLoggingConfigurationCommandInput - {@link GetLoggingConfigurationCommandInput}
34
+ * @returns {@link GetLoggingConfigurationCommandOutput}
28
35
  * @see {@link GetLoggingConfigurationCommandInput} for command's `input` shape.
29
36
  * @see {@link GetLoggingConfigurationCommandOutput} for command's `response` shape.
30
37
  * @see {@link IvschatClientResolvedConfig | config} for IvschatClient's `config` shape.
@@ -43,11 +50,20 @@ export interface GetLoggingConfigurationCommandOutput extends GetLoggingConfigur
43
50
  export declare class GetLoggingConfigurationCommand extends $Command<GetLoggingConfigurationCommandInput, GetLoggingConfigurationCommandOutput, IvschatClientResolvedConfig> {
44
51
  readonly input: GetLoggingConfigurationCommandInput;
45
52
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
53
+ /**
54
+ * @public
55
+ */
46
56
  constructor(input: GetLoggingConfigurationCommandInput);
47
57
  /**
48
58
  * @internal
49
59
  */
50
60
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IvschatClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetLoggingConfigurationCommandInput, GetLoggingConfigurationCommandOutput>;
61
+ /**
62
+ * @internal
63
+ */
51
64
  private serialize;
65
+ /**
66
+ * @internal
67
+ */
52
68
  private deserialize;
53
69
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IvschatClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IvschatClient";
5
5
  import { GetRoomRequest, GetRoomResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetRoomCommand}.
8
10
  */
9
11
  export interface GetRoomCommandInput extends GetRoomRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetRoomCommand}.
13
17
  */
14
18
  export interface GetRoomCommandOutput extends GetRoomResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets the specified room.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface GetRoomCommandOutput extends GetRoomResponse, __MetadataBearer
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetRoomCommandInput - {@link GetRoomCommandInput}
34
+ * @returns {@link GetRoomCommandOutput}
28
35
  * @see {@link GetRoomCommandInput} for command's `input` shape.
29
36
  * @see {@link GetRoomCommandOutput} for command's `response` shape.
30
37
  * @see {@link IvschatClientResolvedConfig | config} for IvschatClient's `config` shape.
@@ -43,11 +50,20 @@ export interface GetRoomCommandOutput extends GetRoomResponse, __MetadataBearer
43
50
  export declare class GetRoomCommand extends $Command<GetRoomCommandInput, GetRoomCommandOutput, IvschatClientResolvedConfig> {
44
51
  readonly input: GetRoomCommandInput;
45
52
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
53
+ /**
54
+ * @public
55
+ */
46
56
  constructor(input: GetRoomCommandInput);
47
57
  /**
48
58
  * @internal
49
59
  */
50
60
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IvschatClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetRoomCommandInput, GetRoomCommandOutput>;
61
+ /**
62
+ * @internal
63
+ */
51
64
  private serialize;
65
+ /**
66
+ * @internal
67
+ */
52
68
  private deserialize;
53
69
  }