@aws-sdk/client-ivschat 3.533.0 → 3.535.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.
- package/dist-types/Ivschat.d.ts +4 -1
- package/dist-types/IvschatClient.d.ts +1 -1
- package/dist-types/commands/CreateChatTokenCommand.d.ts +2 -1
- package/dist-types/commands/CreateLoggingConfigurationCommand.d.ts +2 -1
- package/dist-types/commands/CreateRoomCommand.d.ts +2 -1
- package/dist-types/commands/DeleteLoggingConfigurationCommand.d.ts +2 -1
- package/dist-types/commands/DeleteMessageCommand.d.ts +2 -1
- package/dist-types/commands/DeleteRoomCommand.d.ts +2 -1
- package/dist-types/commands/DisconnectUserCommand.d.ts +2 -1
- package/dist-types/commands/GetLoggingConfigurationCommand.d.ts +2 -1
- package/dist-types/commands/GetRoomCommand.d.ts +2 -1
- package/dist-types/commands/ListLoggingConfigurationsCommand.d.ts +2 -1
- package/dist-types/commands/ListRoomsCommand.d.ts +2 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
- package/dist-types/commands/SendEventCommand.d.ts +2 -1
- package/dist-types/commands/TagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UpdateLoggingConfigurationCommand.d.ts +2 -1
- package/dist-types/commands/UpdateRoomCommand.d.ts +2 -1
- package/dist-types/models/models_0.d.ts +166 -166
- package/dist-types/ts3.4/Ivschat.d.ts +3 -0
- package/dist-types/ts3.4/commands/CreateChatTokenCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateLoggingConfigurationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateRoomCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteLoggingConfigurationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteMessageCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteRoomCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DisconnectUserCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetLoggingConfigurationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetRoomCommand.d.ts +7 -0
- package/dist-types/ts3.4/commands/ListLoggingConfigurationsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListRoomsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SendEventCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateLoggingConfigurationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateRoomCommand.d.ts +9 -0
- package/package.json +40 -40
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { IvschatServiceException as __BaseException } from "./IvschatServiceException";
|
|
3
3
|
/**
|
|
4
|
-
* @public
|
|
5
4
|
* <p/>
|
|
5
|
+
* @public
|
|
6
6
|
*/
|
|
7
7
|
export declare class AccessDeniedException extends __BaseException {
|
|
8
8
|
readonly name: "AccessDeniedException";
|
|
@@ -30,34 +30,34 @@ export type ChatTokenCapability = (typeof ChatTokenCapability)[keyof typeof Chat
|
|
|
30
30
|
*/
|
|
31
31
|
export interface CreateChatTokenRequest {
|
|
32
32
|
/**
|
|
33
|
-
* @public
|
|
34
33
|
* <p>Identifier of the room that the client is trying to access. Currently this must be an
|
|
35
34
|
* ARN. </p>
|
|
35
|
+
* @public
|
|
36
36
|
*/
|
|
37
37
|
roomIdentifier: string | undefined;
|
|
38
38
|
/**
|
|
39
|
-
* @public
|
|
40
39
|
* <p>Application-provided ID that uniquely identifies the user associated with this token.
|
|
41
40
|
* This can be any UTF-8 encoded text.</p>
|
|
41
|
+
* @public
|
|
42
42
|
*/
|
|
43
43
|
userId: string | undefined;
|
|
44
44
|
/**
|
|
45
|
-
* @public
|
|
46
45
|
* <p>Set of capabilities that the user is allowed to perform in the room. Default: None (the
|
|
47
46
|
* capability to view messages is implicitly included in all requests).</p>
|
|
47
|
+
* @public
|
|
48
48
|
*/
|
|
49
49
|
capabilities?: ChatTokenCapability[];
|
|
50
50
|
/**
|
|
51
|
-
* @public
|
|
52
51
|
* <p>Session duration (in minutes), after which the session expires. Default: 60 (1
|
|
53
52
|
* hour).</p>
|
|
53
|
+
* @public
|
|
54
54
|
*/
|
|
55
55
|
sessionDurationInMinutes?: number;
|
|
56
56
|
/**
|
|
57
|
-
* @public
|
|
58
57
|
* <p>Application-provided attributes to encode into the token and attach to a chat session.
|
|
59
58
|
* Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1
|
|
60
59
|
* KB total.</p>
|
|
60
|
+
* @public
|
|
61
61
|
*/
|
|
62
62
|
attributes?: Record<string, string>;
|
|
63
63
|
}
|
|
@@ -66,27 +66,27 @@ export interface CreateChatTokenRequest {
|
|
|
66
66
|
*/
|
|
67
67
|
export interface CreateChatTokenResponse {
|
|
68
68
|
/**
|
|
69
|
-
* @public
|
|
70
69
|
* <p>The issued client token, encrypted.</p>
|
|
70
|
+
* @public
|
|
71
71
|
*/
|
|
72
72
|
token?: string;
|
|
73
73
|
/**
|
|
74
|
-
* @public
|
|
75
74
|
* <p>Time after which the token is no longer valid and cannot be used to connect to a room.
|
|
76
75
|
* This is an ISO 8601 timestamp; <i>note that this is returned as a
|
|
77
76
|
* string</i>.</p>
|
|
77
|
+
* @public
|
|
78
78
|
*/
|
|
79
79
|
tokenExpirationTime?: Date;
|
|
80
80
|
/**
|
|
81
|
-
* @public
|
|
82
81
|
* <p>Time after which an end user's session is no longer valid. This is an ISO 8601
|
|
83
82
|
* timestamp; <i>note that this is returned as a string</i>.</p>
|
|
83
|
+
* @public
|
|
84
84
|
*/
|
|
85
85
|
sessionExpirationTime?: Date;
|
|
86
86
|
}
|
|
87
87
|
/**
|
|
88
|
-
* @public
|
|
89
88
|
* <p/>
|
|
89
|
+
* @public
|
|
90
90
|
*/
|
|
91
91
|
export declare class PendingVerification extends __BaseException {
|
|
92
92
|
readonly name: "PendingVerification";
|
|
@@ -108,20 +108,20 @@ export declare const ResourceType: {
|
|
|
108
108
|
*/
|
|
109
109
|
export type ResourceType = (typeof ResourceType)[keyof typeof ResourceType];
|
|
110
110
|
/**
|
|
111
|
-
* @public
|
|
112
111
|
* <p/>
|
|
112
|
+
* @public
|
|
113
113
|
*/
|
|
114
114
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
115
115
|
readonly name: "ResourceNotFoundException";
|
|
116
116
|
readonly $fault: "client";
|
|
117
117
|
/**
|
|
118
|
-
* @public
|
|
119
118
|
* <p/>
|
|
119
|
+
* @public
|
|
120
120
|
*/
|
|
121
121
|
resourceId: string | undefined;
|
|
122
122
|
/**
|
|
123
|
-
* @public
|
|
124
123
|
* <p/>
|
|
124
|
+
* @public
|
|
125
125
|
*/
|
|
126
126
|
resourceType: ResourceType | undefined;
|
|
127
127
|
/**
|
|
@@ -130,18 +130,18 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
130
130
|
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
131
131
|
}
|
|
132
132
|
/**
|
|
133
|
-
* @public
|
|
134
133
|
* <p>This object is used in the ValidationException error.</p>
|
|
134
|
+
* @public
|
|
135
135
|
*/
|
|
136
136
|
export interface ValidationExceptionField {
|
|
137
137
|
/**
|
|
138
|
-
* @public
|
|
139
138
|
* <p>Name of the field which failed validation.</p>
|
|
139
|
+
* @public
|
|
140
140
|
*/
|
|
141
141
|
name: string | undefined;
|
|
142
142
|
/**
|
|
143
|
-
* @public
|
|
144
143
|
* <p>Explanation of the reason for the validation error.</p>
|
|
144
|
+
* @public
|
|
145
145
|
*/
|
|
146
146
|
message: string | undefined;
|
|
147
147
|
}
|
|
@@ -159,20 +159,20 @@ export declare const ValidationExceptionReason: {
|
|
|
159
159
|
*/
|
|
160
160
|
export type ValidationExceptionReason = (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason];
|
|
161
161
|
/**
|
|
162
|
-
* @public
|
|
163
162
|
* <p/>
|
|
163
|
+
* @public
|
|
164
164
|
*/
|
|
165
165
|
export declare class ValidationException extends __BaseException {
|
|
166
166
|
readonly name: "ValidationException";
|
|
167
167
|
readonly $fault: "client";
|
|
168
168
|
/**
|
|
169
|
-
* @public
|
|
170
169
|
* <p/>
|
|
170
|
+
* @public
|
|
171
171
|
*/
|
|
172
172
|
reason: ValidationExceptionReason | undefined;
|
|
173
173
|
/**
|
|
174
|
-
* @public
|
|
175
174
|
* <p/>
|
|
175
|
+
* @public
|
|
176
176
|
*/
|
|
177
177
|
fieldList?: ValidationExceptionField[];
|
|
178
178
|
/**
|
|
@@ -181,20 +181,20 @@ export declare class ValidationException extends __BaseException {
|
|
|
181
181
|
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
182
182
|
}
|
|
183
183
|
/**
|
|
184
|
-
* @public
|
|
185
184
|
* <p/>
|
|
185
|
+
* @public
|
|
186
186
|
*/
|
|
187
187
|
export declare class ConflictException extends __BaseException {
|
|
188
188
|
readonly name: "ConflictException";
|
|
189
189
|
readonly $fault: "client";
|
|
190
190
|
/**
|
|
191
|
-
* @public
|
|
192
191
|
* <p/>
|
|
192
|
+
* @public
|
|
193
193
|
*/
|
|
194
194
|
resourceId: string | undefined;
|
|
195
195
|
/**
|
|
196
|
-
* @public
|
|
197
196
|
* <p/>
|
|
197
|
+
* @public
|
|
198
198
|
*/
|
|
199
199
|
resourceType: ResourceType | undefined;
|
|
200
200
|
/**
|
|
@@ -203,44 +203,44 @@ export declare class ConflictException extends __BaseException {
|
|
|
203
203
|
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
204
204
|
}
|
|
205
205
|
/**
|
|
206
|
-
* @public
|
|
207
206
|
* <p>Specifies a CloudWatch Logs location where chat logs will be stored.</p>
|
|
207
|
+
* @public
|
|
208
208
|
*/
|
|
209
209
|
export interface CloudWatchLogsDestinationConfiguration {
|
|
210
210
|
/**
|
|
211
|
-
* @public
|
|
212
211
|
* <p>Name of the Amazon Cloudwatch Logs destination where chat activity will be logged.</p>
|
|
212
|
+
* @public
|
|
213
213
|
*/
|
|
214
214
|
logGroupName: string | undefined;
|
|
215
215
|
}
|
|
216
216
|
/**
|
|
217
|
-
* @public
|
|
218
217
|
* <p>Specifies a Kinesis Firehose location where chat logs will be stored.</p>
|
|
218
|
+
* @public
|
|
219
219
|
*/
|
|
220
220
|
export interface FirehoseDestinationConfiguration {
|
|
221
221
|
/**
|
|
222
|
-
* @public
|
|
223
222
|
* <p>Name of the Amazon Kinesis Firehose delivery stream where chat activity will be
|
|
224
223
|
* logged.</p>
|
|
224
|
+
* @public
|
|
225
225
|
*/
|
|
226
226
|
deliveryStreamName: string | undefined;
|
|
227
227
|
}
|
|
228
228
|
/**
|
|
229
|
-
* @public
|
|
230
229
|
* <p>Specifies an S3 location where chat logs will be stored.</p>
|
|
230
|
+
* @public
|
|
231
231
|
*/
|
|
232
232
|
export interface S3DestinationConfiguration {
|
|
233
233
|
/**
|
|
234
|
-
* @public
|
|
235
234
|
* <p>Name of the Amazon S3 bucket where chat activity will be logged.</p>
|
|
235
|
+
* @public
|
|
236
236
|
*/
|
|
237
237
|
bucketName: string | undefined;
|
|
238
238
|
}
|
|
239
239
|
/**
|
|
240
|
-
* @public
|
|
241
240
|
* <p>A complex type that describes a location where chat logs will be stored. Each member
|
|
242
241
|
* represents the configuration of one log destination. For logging, you define only one type of
|
|
243
242
|
* destination (for CloudWatch Logs, Kinesis Firehose, or S3).</p>
|
|
243
|
+
* @public
|
|
244
244
|
*/
|
|
245
245
|
export type DestinationConfiguration = DestinationConfiguration.CloudWatchLogsMember | DestinationConfiguration.FirehoseMember | DestinationConfiguration.S3Member | DestinationConfiguration.$UnknownMember;
|
|
246
246
|
/**
|
|
@@ -248,8 +248,8 @@ export type DestinationConfiguration = DestinationConfiguration.CloudWatchLogsMe
|
|
|
248
248
|
*/
|
|
249
249
|
export declare namespace DestinationConfiguration {
|
|
250
250
|
/**
|
|
251
|
-
* @public
|
|
252
251
|
* <p>An Amazon S3 destination configuration where chat activity will be logged.</p>
|
|
252
|
+
* @public
|
|
253
253
|
*/
|
|
254
254
|
interface S3Member {
|
|
255
255
|
s3: S3DestinationConfiguration;
|
|
@@ -258,9 +258,9 @@ export declare namespace DestinationConfiguration {
|
|
|
258
258
|
$unknown?: never;
|
|
259
259
|
}
|
|
260
260
|
/**
|
|
261
|
-
* @public
|
|
262
261
|
* <p>An Amazon CloudWatch Logs destination configuration where chat activity will be
|
|
263
262
|
* logged.</p>
|
|
263
|
+
* @public
|
|
264
264
|
*/
|
|
265
265
|
interface CloudWatchLogsMember {
|
|
266
266
|
s3?: never;
|
|
@@ -269,9 +269,9 @@ export declare namespace DestinationConfiguration {
|
|
|
269
269
|
$unknown?: never;
|
|
270
270
|
}
|
|
271
271
|
/**
|
|
272
|
-
* @public
|
|
273
272
|
* <p>An Amazon Kinesis Data Firehose destination configuration where chat activity will be
|
|
274
273
|
* logged.</p>
|
|
274
|
+
* @public
|
|
275
275
|
*/
|
|
276
276
|
interface FirehoseMember {
|
|
277
277
|
s3?: never;
|
|
@@ -301,25 +301,25 @@ export declare namespace DestinationConfiguration {
|
|
|
301
301
|
*/
|
|
302
302
|
export interface CreateLoggingConfigurationRequest {
|
|
303
303
|
/**
|
|
304
|
-
* @public
|
|
305
304
|
* <p>Logging-configuration name. The value does not need to be unique.</p>
|
|
305
|
+
* @public
|
|
306
306
|
*/
|
|
307
307
|
name?: string;
|
|
308
308
|
/**
|
|
309
|
-
* @public
|
|
310
309
|
* <p>A complex type that contains a destination configuration for where chat content will be
|
|
311
310
|
* logged. There can be only one type of destination (<code>cloudWatchLogs</code>,
|
|
312
311
|
* <code>firehose</code>, or <code>s3</code>) in a
|
|
313
312
|
* <code>destinationConfiguration</code>.</p>
|
|
313
|
+
* @public
|
|
314
314
|
*/
|
|
315
315
|
destinationConfiguration: DestinationConfiguration | undefined;
|
|
316
316
|
/**
|
|
317
|
-
* @public
|
|
318
317
|
* <p>Tags to attach to the resource. Array of maps, each of the form <code>string:string
|
|
319
318
|
* (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
|
|
320
319
|
* Resources</a> for details, including restrictions that apply to tags and "Tag naming
|
|
321
320
|
* limits and requirements"; Amazon IVS Chat has no constraints on tags beyond what is
|
|
322
321
|
* documented there.</p>
|
|
322
|
+
* @public
|
|
323
323
|
*/
|
|
324
324
|
tags?: Record<string, string>;
|
|
325
325
|
}
|
|
@@ -339,74 +339,74 @@ export type CreateLoggingConfigurationState = (typeof CreateLoggingConfiguration
|
|
|
339
339
|
*/
|
|
340
340
|
export interface CreateLoggingConfigurationResponse {
|
|
341
341
|
/**
|
|
342
|
-
* @public
|
|
343
342
|
* <p>Logging-configuration ARN, assigned by the system.</p>
|
|
343
|
+
* @public
|
|
344
344
|
*/
|
|
345
345
|
arn?: string;
|
|
346
346
|
/**
|
|
347
|
-
* @public
|
|
348
347
|
* <p>Logging-configuration ID, generated by the system. This is a relative identifier, the
|
|
349
348
|
* part of the ARN that uniquely identifies the logging configuration.</p>
|
|
349
|
+
* @public
|
|
350
350
|
*/
|
|
351
351
|
id?: string;
|
|
352
352
|
/**
|
|
353
|
-
* @public
|
|
354
353
|
* <p>Time when the logging configuration was created. This is an ISO 8601 timestamp;
|
|
355
354
|
* <i>note that this is returned as a string</i>.</p>
|
|
355
|
+
* @public
|
|
356
356
|
*/
|
|
357
357
|
createTime?: Date;
|
|
358
358
|
/**
|
|
359
|
-
* @public
|
|
360
359
|
* <p>Time of the logging configuration’s last update. This is an ISO 8601 timestamp;
|
|
361
360
|
* <i>note that this is returned as a string</i>.</p>
|
|
361
|
+
* @public
|
|
362
362
|
*/
|
|
363
363
|
updateTime?: Date;
|
|
364
364
|
/**
|
|
365
|
-
* @public
|
|
366
365
|
* <p>Logging-configuration name, from the request (if specified).</p>
|
|
366
|
+
* @public
|
|
367
367
|
*/
|
|
368
368
|
name?: string;
|
|
369
369
|
/**
|
|
370
|
-
* @public
|
|
371
370
|
* <p>A complex type that contains a destination configuration for where chat content will be
|
|
372
371
|
* logged, from the request. There is only one type of destination
|
|
373
372
|
* (<code>cloudWatchLogs</code>, <code>firehose</code>, or <code>s3</code>) in a
|
|
374
373
|
* <code>destinationConfiguration</code>.</p>
|
|
374
|
+
* @public
|
|
375
375
|
*/
|
|
376
376
|
destinationConfiguration?: DestinationConfiguration;
|
|
377
377
|
/**
|
|
378
|
-
* @public
|
|
379
378
|
* <p>The state of the logging configuration. When the state is <code>ACTIVE</code>, the
|
|
380
379
|
* configuration is ready to log chat content.</p>
|
|
380
|
+
* @public
|
|
381
381
|
*/
|
|
382
382
|
state?: CreateLoggingConfigurationState;
|
|
383
383
|
/**
|
|
384
|
-
* @public
|
|
385
384
|
* <p>Tags attached to the resource, from the request (if specified). Array of maps, each of
|
|
386
385
|
* the form <code>string:string (key:value)</code>.</p>
|
|
386
|
+
* @public
|
|
387
387
|
*/
|
|
388
388
|
tags?: Record<string, string>;
|
|
389
389
|
}
|
|
390
390
|
/**
|
|
391
|
-
* @public
|
|
392
391
|
* <p/>
|
|
392
|
+
* @public
|
|
393
393
|
*/
|
|
394
394
|
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
395
395
|
readonly name: "ServiceQuotaExceededException";
|
|
396
396
|
readonly $fault: "client";
|
|
397
397
|
/**
|
|
398
|
-
* @public
|
|
399
398
|
* <p/>
|
|
399
|
+
* @public
|
|
400
400
|
*/
|
|
401
401
|
resourceId: string | undefined;
|
|
402
402
|
/**
|
|
403
|
-
* @public
|
|
404
403
|
* <p/>
|
|
404
|
+
* @public
|
|
405
405
|
*/
|
|
406
406
|
resourceType: ResourceType | undefined;
|
|
407
407
|
/**
|
|
408
|
-
* @public
|
|
409
408
|
* <p/>
|
|
409
|
+
* @public
|
|
410
410
|
*/
|
|
411
411
|
limit: number | undefined;
|
|
412
412
|
/**
|
|
@@ -427,24 +427,24 @@ export declare const FallbackResult: {
|
|
|
427
427
|
*/
|
|
428
428
|
export type FallbackResult = (typeof FallbackResult)[keyof typeof FallbackResult];
|
|
429
429
|
/**
|
|
430
|
-
* @public
|
|
431
430
|
* <p>Configuration information for optional message review.</p>
|
|
431
|
+
* @public
|
|
432
432
|
*/
|
|
433
433
|
export interface MessageReviewHandler {
|
|
434
434
|
/**
|
|
435
|
-
* @public
|
|
436
435
|
* <p>Identifier of the message review handler. Currently this must be an ARN of a lambda
|
|
437
436
|
* function.</p>
|
|
437
|
+
* @public
|
|
438
438
|
*/
|
|
439
439
|
uri?: string;
|
|
440
440
|
/**
|
|
441
|
-
* @public
|
|
442
441
|
* <p>Specifies the fallback behavior (whether the message is allowed or denied) if the handler
|
|
443
442
|
* does not return a valid response, encounters an error, or times out. (For the timeout period,
|
|
444
443
|
* see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/service-quotas.html"> Service
|
|
445
444
|
* Quotas</a>.) If allowed, the message is delivered with returned content to all users
|
|
446
445
|
* connected to the room. If denied, the message is not delivered to any user. Default:
|
|
447
446
|
* <code>ALLOW</code>.</p>
|
|
447
|
+
* @public
|
|
448
448
|
*/
|
|
449
449
|
fallbackResult?: FallbackResult;
|
|
450
450
|
}
|
|
@@ -453,40 +453,40 @@ export interface MessageReviewHandler {
|
|
|
453
453
|
*/
|
|
454
454
|
export interface CreateRoomRequest {
|
|
455
455
|
/**
|
|
456
|
-
* @public
|
|
457
456
|
* <p>Room name. The value does not need to be unique.</p>
|
|
457
|
+
* @public
|
|
458
458
|
*/
|
|
459
459
|
name?: string;
|
|
460
460
|
/**
|
|
461
|
-
* @public
|
|
462
461
|
* <p>Maximum number of messages per second that can be sent to the room (by all clients).
|
|
463
462
|
* Default: 10. </p>
|
|
463
|
+
* @public
|
|
464
464
|
*/
|
|
465
465
|
maximumMessageRatePerSecond?: number;
|
|
466
466
|
/**
|
|
467
|
-
* @public
|
|
468
467
|
* <p>Maximum number of characters in a single message. Messages are expected to be UTF-8
|
|
469
468
|
* encoded and this limit applies specifically to rune/code-point count, not number of bytes.
|
|
470
469
|
* Default: 500.</p>
|
|
470
|
+
* @public
|
|
471
471
|
*/
|
|
472
472
|
maximumMessageLength?: number;
|
|
473
473
|
/**
|
|
474
|
-
* @public
|
|
475
474
|
* <p>Configuration information for optional review of messages.</p>
|
|
475
|
+
* @public
|
|
476
476
|
*/
|
|
477
477
|
messageReviewHandler?: MessageReviewHandler;
|
|
478
478
|
/**
|
|
479
|
-
* @public
|
|
480
479
|
* <p>Tags to attach to the resource. Array of maps, each of the form <code>string:string
|
|
481
480
|
* (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
|
|
482
481
|
* Resources</a> for details, including restrictions that apply to tags and "Tag naming
|
|
483
482
|
* limits and requirements"; Amazon IVS Chat has no constraints beyond what is documented
|
|
484
483
|
* there.</p>
|
|
484
|
+
* @public
|
|
485
485
|
*/
|
|
486
486
|
tags?: Record<string, string>;
|
|
487
487
|
/**
|
|
488
|
-
* @public
|
|
489
488
|
* <p>Array of logging-configuration identifiers attached to the room.</p>
|
|
489
|
+
* @public
|
|
490
490
|
*/
|
|
491
491
|
loggingConfigurationIdentifiers?: string[];
|
|
492
492
|
}
|
|
@@ -495,59 +495,59 @@ export interface CreateRoomRequest {
|
|
|
495
495
|
*/
|
|
496
496
|
export interface CreateRoomResponse {
|
|
497
497
|
/**
|
|
498
|
-
* @public
|
|
499
498
|
* <p>Room ARN, assigned by the system.</p>
|
|
499
|
+
* @public
|
|
500
500
|
*/
|
|
501
501
|
arn?: string;
|
|
502
502
|
/**
|
|
503
|
-
* @public
|
|
504
503
|
* <p>Room ID, generated by the system. This is a relative identifier, the part of the ARN
|
|
505
504
|
* that uniquely identifies the room.</p>
|
|
505
|
+
* @public
|
|
506
506
|
*/
|
|
507
507
|
id?: string;
|
|
508
508
|
/**
|
|
509
|
-
* @public
|
|
510
509
|
* <p>Room name, from the request (if specified).</p>
|
|
510
|
+
* @public
|
|
511
511
|
*/
|
|
512
512
|
name?: string;
|
|
513
513
|
/**
|
|
514
|
-
* @public
|
|
515
514
|
* <p>Time when the room was created. This is an ISO 8601 timestamp; <i>note that this
|
|
516
515
|
* is returned as a string</i>.</p>
|
|
516
|
+
* @public
|
|
517
517
|
*/
|
|
518
518
|
createTime?: Date;
|
|
519
519
|
/**
|
|
520
|
-
* @public
|
|
521
520
|
* <p>Time of the room’s last update. This is an ISO 8601 timestamp; <i>note that this
|
|
522
521
|
* is returned as a string</i>.</p>
|
|
522
|
+
* @public
|
|
523
523
|
*/
|
|
524
524
|
updateTime?: Date;
|
|
525
525
|
/**
|
|
526
|
-
* @public
|
|
527
526
|
* <p>Maximum number of messages per second that can be sent to the room (by all clients),
|
|
528
527
|
* from the request (if specified).</p>
|
|
528
|
+
* @public
|
|
529
529
|
*/
|
|
530
530
|
maximumMessageRatePerSecond?: number;
|
|
531
531
|
/**
|
|
532
|
-
* @public
|
|
533
532
|
* <p>Maximum number of characters in a single message, from the request (if
|
|
534
533
|
* specified).</p>
|
|
534
|
+
* @public
|
|
535
535
|
*/
|
|
536
536
|
maximumMessageLength?: number;
|
|
537
537
|
/**
|
|
538
|
-
* @public
|
|
539
538
|
* <p>Configuration information for optional review of messages.</p>
|
|
539
|
+
* @public
|
|
540
540
|
*/
|
|
541
541
|
messageReviewHandler?: MessageReviewHandler;
|
|
542
542
|
/**
|
|
543
|
-
* @public
|
|
544
543
|
* <p>Tags attached to the resource, from the request (if specified).</p>
|
|
544
|
+
* @public
|
|
545
545
|
*/
|
|
546
546
|
tags?: Record<string, string>;
|
|
547
547
|
/**
|
|
548
|
-
* @public
|
|
549
548
|
* <p>Array of logging configurations attached to the room, from the request (if
|
|
550
549
|
* specified).</p>
|
|
550
|
+
* @public
|
|
551
551
|
*/
|
|
552
552
|
loggingConfigurationIdentifiers?: string[];
|
|
553
553
|
}
|
|
@@ -556,8 +556,8 @@ export interface CreateRoomResponse {
|
|
|
556
556
|
*/
|
|
557
557
|
export interface DeleteLoggingConfigurationRequest {
|
|
558
558
|
/**
|
|
559
|
-
* @public
|
|
560
559
|
* <p>Identifier of the logging configuration to be deleted.</p>
|
|
560
|
+
* @public
|
|
561
561
|
*/
|
|
562
562
|
identifier: string | undefined;
|
|
563
563
|
}
|
|
@@ -566,21 +566,21 @@ export interface DeleteLoggingConfigurationRequest {
|
|
|
566
566
|
*/
|
|
567
567
|
export interface DeleteMessageRequest {
|
|
568
568
|
/**
|
|
569
|
-
* @public
|
|
570
569
|
* <p>Identifier of the room where the message should be deleted. Currently this must be an
|
|
571
570
|
* ARN. </p>
|
|
571
|
+
* @public
|
|
572
572
|
*/
|
|
573
573
|
roomIdentifier: string | undefined;
|
|
574
574
|
/**
|
|
575
|
-
* @public
|
|
576
575
|
* <p>ID of the message to be deleted. This is the <code>Id</code> field in the received
|
|
577
576
|
* message (see <a href="https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-message-subscribe.html"> Message
|
|
578
577
|
* (Subscribe)</a> in the Chat Messaging API).</p>
|
|
578
|
+
* @public
|
|
579
579
|
*/
|
|
580
580
|
id: string | undefined;
|
|
581
581
|
/**
|
|
582
|
-
* @public
|
|
583
582
|
* <p>Reason for deleting the message.</p>
|
|
583
|
+
* @public
|
|
584
584
|
*/
|
|
585
585
|
reason?: string;
|
|
586
586
|
}
|
|
@@ -589,31 +589,31 @@ export interface DeleteMessageRequest {
|
|
|
589
589
|
*/
|
|
590
590
|
export interface DeleteMessageResponse {
|
|
591
591
|
/**
|
|
592
|
-
* @public
|
|
593
592
|
* <p>Operation identifier, generated by Amazon IVS Chat.</p>
|
|
593
|
+
* @public
|
|
594
594
|
*/
|
|
595
595
|
id?: string;
|
|
596
596
|
}
|
|
597
597
|
/**
|
|
598
|
-
* @public
|
|
599
598
|
* <p/>
|
|
599
|
+
* @public
|
|
600
600
|
*/
|
|
601
601
|
export declare class ThrottlingException extends __BaseException {
|
|
602
602
|
readonly name: "ThrottlingException";
|
|
603
603
|
readonly $fault: "client";
|
|
604
604
|
/**
|
|
605
|
-
* @public
|
|
606
605
|
* <p/>
|
|
606
|
+
* @public
|
|
607
607
|
*/
|
|
608
608
|
resourceId: string | undefined;
|
|
609
609
|
/**
|
|
610
|
-
* @public
|
|
611
610
|
* <p/>
|
|
611
|
+
* @public
|
|
612
612
|
*/
|
|
613
613
|
resourceType: ResourceType | undefined;
|
|
614
614
|
/**
|
|
615
|
-
* @public
|
|
616
615
|
* <p/>
|
|
616
|
+
* @public
|
|
617
617
|
*/
|
|
618
618
|
limit: number | undefined;
|
|
619
619
|
/**
|
|
@@ -626,8 +626,8 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
626
626
|
*/
|
|
627
627
|
export interface DeleteRoomRequest {
|
|
628
628
|
/**
|
|
629
|
-
* @public
|
|
630
629
|
* <p>Identifier of the room to be deleted. Currently this must be an ARN.</p>
|
|
630
|
+
* @public
|
|
631
631
|
*/
|
|
632
632
|
identifier: string | undefined;
|
|
633
633
|
}
|
|
@@ -636,19 +636,19 @@ export interface DeleteRoomRequest {
|
|
|
636
636
|
*/
|
|
637
637
|
export interface DisconnectUserRequest {
|
|
638
638
|
/**
|
|
639
|
-
* @public
|
|
640
639
|
* <p>Identifier of the room from which the user's clients should be disconnected. Currently
|
|
641
640
|
* this must be an ARN.</p>
|
|
641
|
+
* @public
|
|
642
642
|
*/
|
|
643
643
|
roomIdentifier: string | undefined;
|
|
644
644
|
/**
|
|
645
|
-
* @public
|
|
646
645
|
* <p>ID of the user (connection) to disconnect from the room.</p>
|
|
646
|
+
* @public
|
|
647
647
|
*/
|
|
648
648
|
userId: string | undefined;
|
|
649
649
|
/**
|
|
650
|
-
* @public
|
|
651
650
|
* <p>Reason for disconnecting the user.</p>
|
|
651
|
+
* @public
|
|
652
652
|
*/
|
|
653
653
|
reason?: string;
|
|
654
654
|
}
|
|
@@ -662,8 +662,8 @@ export interface DisconnectUserResponse {
|
|
|
662
662
|
*/
|
|
663
663
|
export interface GetLoggingConfigurationRequest {
|
|
664
664
|
/**
|
|
665
|
-
* @public
|
|
666
665
|
* <p>Identifier of the logging configuration to be retrieved.</p>
|
|
666
|
+
* @public
|
|
667
667
|
*/
|
|
668
668
|
identifier: string | undefined;
|
|
669
669
|
}
|
|
@@ -689,52 +689,52 @@ export type LoggingConfigurationState = (typeof LoggingConfigurationState)[keyof
|
|
|
689
689
|
*/
|
|
690
690
|
export interface GetLoggingConfigurationResponse {
|
|
691
691
|
/**
|
|
692
|
-
* @public
|
|
693
692
|
* <p>Logging-configuration ARN, from the request (if <code>identifier</code> was an
|
|
694
693
|
* ARN).</p>
|
|
694
|
+
* @public
|
|
695
695
|
*/
|
|
696
696
|
arn?: string;
|
|
697
697
|
/**
|
|
698
|
-
* @public
|
|
699
698
|
* <p>Logging-configuration ID, generated by the system. This is a relative identifier, the
|
|
700
699
|
* part of the ARN that uniquely identifies the logging configuration.</p>
|
|
700
|
+
* @public
|
|
701
701
|
*/
|
|
702
702
|
id?: string;
|
|
703
703
|
/**
|
|
704
|
-
* @public
|
|
705
704
|
* <p>Time when the logging configuration was created. This is an ISO 8601 timestamp;
|
|
706
705
|
* <i>note that this is returned as a string</i>.</p>
|
|
706
|
+
* @public
|
|
707
707
|
*/
|
|
708
708
|
createTime?: Date;
|
|
709
709
|
/**
|
|
710
|
-
* @public
|
|
711
710
|
* <p>Time of the logging configuration’s last update. This is an ISO 8601 timestamp;
|
|
712
711
|
* <i>note that this is returned as a string</i>.</p>
|
|
712
|
+
* @public
|
|
713
713
|
*/
|
|
714
714
|
updateTime?: Date;
|
|
715
715
|
/**
|
|
716
|
-
* @public
|
|
717
716
|
* <p>Logging-configuration name. This value does not need to be unique.</p>
|
|
717
|
+
* @public
|
|
718
718
|
*/
|
|
719
719
|
name?: string;
|
|
720
720
|
/**
|
|
721
|
-
* @public
|
|
722
721
|
* <p>A complex type that contains a destination configuration for where chat content will be
|
|
723
722
|
* logged. There is only one type of destination (<code>cloudWatchLogs</code>,
|
|
724
723
|
* <code>firehose</code>, or <code>s3</code>) in a
|
|
725
724
|
* <code>destinationConfiguration</code>.</p>
|
|
725
|
+
* @public
|
|
726
726
|
*/
|
|
727
727
|
destinationConfiguration?: DestinationConfiguration;
|
|
728
728
|
/**
|
|
729
|
-
* @public
|
|
730
729
|
* <p>The state of the logging configuration. When the state is <code>ACTIVE</code>, the
|
|
731
730
|
* configuration is ready to log chat content.</p>
|
|
731
|
+
* @public
|
|
732
732
|
*/
|
|
733
733
|
state?: LoggingConfigurationState;
|
|
734
734
|
/**
|
|
735
|
-
* @public
|
|
736
735
|
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
737
736
|
* (key:value)</code>.</p>
|
|
737
|
+
* @public
|
|
738
738
|
*/
|
|
739
739
|
tags?: Record<string, string>;
|
|
740
740
|
}
|
|
@@ -743,9 +743,9 @@ export interface GetLoggingConfigurationResponse {
|
|
|
743
743
|
*/
|
|
744
744
|
export interface GetRoomRequest {
|
|
745
745
|
/**
|
|
746
|
-
* @public
|
|
747
746
|
* <p>Identifier of the room for which the configuration is to be retrieved. Currently this
|
|
748
747
|
* must be an ARN.</p>
|
|
748
|
+
* @public
|
|
749
749
|
*/
|
|
750
750
|
identifier: string | undefined;
|
|
751
751
|
}
|
|
@@ -754,60 +754,60 @@ export interface GetRoomRequest {
|
|
|
754
754
|
*/
|
|
755
755
|
export interface GetRoomResponse {
|
|
756
756
|
/**
|
|
757
|
-
* @public
|
|
758
757
|
* <p>Room ARN, from the request (if <code>identifier</code> was an ARN).</p>
|
|
758
|
+
* @public
|
|
759
759
|
*/
|
|
760
760
|
arn?: string;
|
|
761
761
|
/**
|
|
762
|
-
* @public
|
|
763
762
|
* <p>Room ID, generated by the system. This is a relative identifier, the part of the ARN
|
|
764
763
|
* that uniquely identifies the room.</p>
|
|
764
|
+
* @public
|
|
765
765
|
*/
|
|
766
766
|
id?: string;
|
|
767
767
|
/**
|
|
768
|
-
* @public
|
|
769
768
|
* <p>Room name. The value does not need to be unique.</p>
|
|
769
|
+
* @public
|
|
770
770
|
*/
|
|
771
771
|
name?: string;
|
|
772
772
|
/**
|
|
773
|
-
* @public
|
|
774
773
|
* <p>Time when the room was created. This is an ISO 8601 timestamp; <i>note that this
|
|
775
774
|
* is returned as a string</i>.</p>
|
|
775
|
+
* @public
|
|
776
776
|
*/
|
|
777
777
|
createTime?: Date;
|
|
778
778
|
/**
|
|
779
|
-
* @public
|
|
780
779
|
* <p>Time of the room’s last update. This is an ISO 8601 timestamp; <i>note that this
|
|
781
780
|
* is returned as a string</i>.</p>
|
|
781
|
+
* @public
|
|
782
782
|
*/
|
|
783
783
|
updateTime?: Date;
|
|
784
784
|
/**
|
|
785
|
-
* @public
|
|
786
785
|
* <p>Maximum number of messages per second that can be sent to the room (by all clients).
|
|
787
786
|
* Default: 10.</p>
|
|
787
|
+
* @public
|
|
788
788
|
*/
|
|
789
789
|
maximumMessageRatePerSecond?: number;
|
|
790
790
|
/**
|
|
791
|
-
* @public
|
|
792
791
|
* <p>Maximum number of characters in a single message. Messages are expected to be UTF-8
|
|
793
792
|
* encoded and this limit applies specifically to rune/code-point count, not number of bytes.
|
|
794
793
|
* Default: 500.</p>
|
|
794
|
+
* @public
|
|
795
795
|
*/
|
|
796
796
|
maximumMessageLength?: number;
|
|
797
797
|
/**
|
|
798
|
-
* @public
|
|
799
798
|
* <p>Configuration information for optional review of messages.</p>
|
|
799
|
+
* @public
|
|
800
800
|
*/
|
|
801
801
|
messageReviewHandler?: MessageReviewHandler;
|
|
802
802
|
/**
|
|
803
|
-
* @public
|
|
804
803
|
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
805
804
|
* (key:value)</code>.</p>
|
|
805
|
+
* @public
|
|
806
806
|
*/
|
|
807
807
|
tags?: Record<string, string>;
|
|
808
808
|
/**
|
|
809
|
-
* @public
|
|
810
809
|
* <p>Array of logging configurations attached to the room.</p>
|
|
810
|
+
* @public
|
|
811
811
|
*/
|
|
812
812
|
loggingConfigurationIdentifiers?: string[];
|
|
813
813
|
}
|
|
@@ -816,69 +816,69 @@ export interface GetRoomResponse {
|
|
|
816
816
|
*/
|
|
817
817
|
export interface ListLoggingConfigurationsRequest {
|
|
818
818
|
/**
|
|
819
|
-
* @public
|
|
820
819
|
* <p>The first logging configurations to retrieve. This is used for pagination; see the
|
|
821
820
|
* <code>nextToken</code> response field.</p>
|
|
821
|
+
* @public
|
|
822
822
|
*/
|
|
823
823
|
nextToken?: string;
|
|
824
824
|
/**
|
|
825
|
-
* @public
|
|
826
825
|
* <p>Maximum number of logging configurations to return. Default: 50.</p>
|
|
826
|
+
* @public
|
|
827
827
|
*/
|
|
828
828
|
maxResults?: number;
|
|
829
829
|
}
|
|
830
830
|
/**
|
|
831
|
-
* @public
|
|
832
831
|
* <p>Summary information about a logging configuration.</p>
|
|
832
|
+
* @public
|
|
833
833
|
*/
|
|
834
834
|
export interface LoggingConfigurationSummary {
|
|
835
835
|
/**
|
|
836
|
-
* @public
|
|
837
836
|
* <p>Logging-configuration ARN.</p>
|
|
837
|
+
* @public
|
|
838
838
|
*/
|
|
839
839
|
arn?: string;
|
|
840
840
|
/**
|
|
841
|
-
* @public
|
|
842
841
|
* <p>Logging-configuration ID, generated by the system. This is a relative identifier, the part
|
|
843
842
|
* of the ARN that uniquely identifies the room.</p>
|
|
843
|
+
* @public
|
|
844
844
|
*/
|
|
845
845
|
id?: string;
|
|
846
846
|
/**
|
|
847
|
-
* @public
|
|
848
847
|
* <p>Time when the logging configuration was created. This is an ISO 8601 timestamp;
|
|
849
848
|
* <i>note that this is returned as a string</i>.</p>
|
|
849
|
+
* @public
|
|
850
850
|
*/
|
|
851
851
|
createTime?: Date;
|
|
852
852
|
/**
|
|
853
|
-
* @public
|
|
854
853
|
* <p>Time of the logging configuration’s last update. This is an ISO 8601 timestamp;
|
|
855
854
|
* <i>note that this is returned as a string</i>.</p>
|
|
855
|
+
* @public
|
|
856
856
|
*/
|
|
857
857
|
updateTime?: Date;
|
|
858
858
|
/**
|
|
859
|
-
* @public
|
|
860
859
|
* <p>Logging-configuration name. The value does not need to be unique.</p>
|
|
860
|
+
* @public
|
|
861
861
|
*/
|
|
862
862
|
name?: string;
|
|
863
863
|
/**
|
|
864
|
-
* @public
|
|
865
864
|
* <p>A complex type that contains a destination configuration for where chat content will be
|
|
866
865
|
* logged.</p>
|
|
866
|
+
* @public
|
|
867
867
|
*/
|
|
868
868
|
destinationConfiguration?: DestinationConfiguration;
|
|
869
869
|
/**
|
|
870
|
-
* @public
|
|
871
870
|
* <p>The state of the logging configuration. When this is <code>ACTIVE</code>, the
|
|
872
871
|
* configuration is ready for logging chat content.</p>
|
|
872
|
+
* @public
|
|
873
873
|
*/
|
|
874
874
|
state?: LoggingConfigurationState;
|
|
875
875
|
/**
|
|
876
|
-
* @public
|
|
877
876
|
* <p>Tags to attach to the resource. Array of maps, each of the form <code>string:string
|
|
878
877
|
* (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
|
|
879
878
|
* Resources</a> for details, including restrictions that apply to tags and "Tag naming
|
|
880
879
|
* limits and requirements"; Amazon IVS Chat has no constraints on tags beyond what is documented
|
|
881
880
|
* there.</p>
|
|
881
|
+
* @public
|
|
882
882
|
*/
|
|
883
883
|
tags?: Record<string, string>;
|
|
884
884
|
}
|
|
@@ -887,16 +887,16 @@ export interface LoggingConfigurationSummary {
|
|
|
887
887
|
*/
|
|
888
888
|
export interface ListLoggingConfigurationsResponse {
|
|
889
889
|
/**
|
|
890
|
-
* @public
|
|
891
890
|
* <p>List of the matching logging configurations (summary information only). There is only
|
|
892
891
|
* one type of destination (<code>cloudWatchLogs</code>, <code>firehose</code>, or
|
|
893
892
|
* <code>s3</code>) in a <code>destinationConfiguration</code>.</p>
|
|
893
|
+
* @public
|
|
894
894
|
*/
|
|
895
895
|
loggingConfigurations: LoggingConfigurationSummary[] | undefined;
|
|
896
896
|
/**
|
|
897
|
-
* @public
|
|
898
897
|
* <p>If there are more logging configurations than <code>maxResults</code>, use
|
|
899
898
|
* <code>nextToken</code> in the request to get the next set.</p>
|
|
899
|
+
* @public
|
|
900
900
|
*/
|
|
901
901
|
nextToken?: string;
|
|
902
902
|
}
|
|
@@ -905,82 +905,82 @@ export interface ListLoggingConfigurationsResponse {
|
|
|
905
905
|
*/
|
|
906
906
|
export interface ListRoomsRequest {
|
|
907
907
|
/**
|
|
908
|
-
* @public
|
|
909
908
|
* <p>Filters the list to match the specified room name.</p>
|
|
909
|
+
* @public
|
|
910
910
|
*/
|
|
911
911
|
name?: string;
|
|
912
912
|
/**
|
|
913
|
-
* @public
|
|
914
913
|
* <p>The first room to retrieve. This is used for pagination; see the <code>nextToken</code>
|
|
915
914
|
* response field.</p>
|
|
915
|
+
* @public
|
|
916
916
|
*/
|
|
917
917
|
nextToken?: string;
|
|
918
918
|
/**
|
|
919
|
-
* @public
|
|
920
919
|
* <p>Maximum number of rooms to return. Default: 50.</p>
|
|
920
|
+
* @public
|
|
921
921
|
*/
|
|
922
922
|
maxResults?: number;
|
|
923
923
|
/**
|
|
924
|
-
* @public
|
|
925
924
|
* <p>Filters the list to match the specified message review handler URI.</p>
|
|
925
|
+
* @public
|
|
926
926
|
*/
|
|
927
927
|
messageReviewHandlerUri?: string;
|
|
928
928
|
/**
|
|
929
|
-
* @public
|
|
930
929
|
* <p>Logging-configuration identifier.</p>
|
|
930
|
+
* @public
|
|
931
931
|
*/
|
|
932
932
|
loggingConfigurationIdentifier?: string;
|
|
933
933
|
}
|
|
934
934
|
/**
|
|
935
|
-
* @public
|
|
936
935
|
* <p>Summary information about a room.</p>
|
|
936
|
+
* @public
|
|
937
937
|
*/
|
|
938
938
|
export interface RoomSummary {
|
|
939
939
|
/**
|
|
940
|
-
* @public
|
|
941
940
|
* <p>Room ARN.</p>
|
|
941
|
+
* @public
|
|
942
942
|
*/
|
|
943
943
|
arn?: string;
|
|
944
944
|
/**
|
|
945
|
-
* @public
|
|
946
945
|
* <p>Room ID, generated by the system. This is a relative identifier, the part of the ARN that
|
|
947
946
|
* uniquely identifies the room.</p>
|
|
947
|
+
* @public
|
|
948
948
|
*/
|
|
949
949
|
id?: string;
|
|
950
950
|
/**
|
|
951
|
-
* @public
|
|
952
951
|
* <p>Room name. The value does not need to be unique.</p>
|
|
952
|
+
* @public
|
|
953
953
|
*/
|
|
954
954
|
name?: string;
|
|
955
955
|
/**
|
|
956
|
-
* @public
|
|
957
956
|
* <p>Configuration information for optional review of messages.</p>
|
|
957
|
+
* @public
|
|
958
958
|
*/
|
|
959
959
|
messageReviewHandler?: MessageReviewHandler;
|
|
960
960
|
/**
|
|
961
|
-
* @public
|
|
962
961
|
* <p>Time when the room was created. This is an ISO 8601 timestamp; <i>note that this is
|
|
963
962
|
* returned as a string</i>. </p>
|
|
963
|
+
* @public
|
|
964
964
|
*/
|
|
965
965
|
createTime?: Date;
|
|
966
966
|
/**
|
|
967
|
-
* @public
|
|
968
967
|
* <p>Time of the room’s last update. This is an ISO 8601 timestamp; <i>note that this is
|
|
969
968
|
* returned as a string</i>. </p>
|
|
969
|
+
* @public
|
|
970
970
|
*/
|
|
971
971
|
updateTime?: Date;
|
|
972
972
|
/**
|
|
973
|
-
* @public
|
|
974
973
|
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
975
974
|
* (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
|
|
976
975
|
* Resources</a> for details, including restrictions that apply to tags and "Tag naming
|
|
977
976
|
* limits and requirements"; Amazon IVS Chat has no constraints beyond what is documented
|
|
978
977
|
* there.</p>
|
|
978
|
+
* @public
|
|
979
979
|
*/
|
|
980
980
|
tags?: Record<string, string>;
|
|
981
981
|
/**
|
|
982
|
-
* @public
|
|
983
982
|
* <p>List of logging-configuration identifiers attached to the room.</p>
|
|
983
|
+
* @public
|
|
984
984
|
*/
|
|
985
985
|
loggingConfigurationIdentifiers?: string[];
|
|
986
986
|
}
|
|
@@ -989,20 +989,20 @@ export interface RoomSummary {
|
|
|
989
989
|
*/
|
|
990
990
|
export interface ListRoomsResponse {
|
|
991
991
|
/**
|
|
992
|
-
* @public
|
|
993
992
|
* <p>List of the matching rooms (summary information only).</p>
|
|
993
|
+
* @public
|
|
994
994
|
*/
|
|
995
995
|
rooms: RoomSummary[] | undefined;
|
|
996
996
|
/**
|
|
997
|
-
* @public
|
|
998
997
|
* <p>If there are more rooms than <code>maxResults</code>, use <code>nextToken</code> in the
|
|
999
998
|
* request to get the next set.</p>
|
|
999
|
+
* @public
|
|
1000
1000
|
*/
|
|
1001
1001
|
nextToken?: string;
|
|
1002
1002
|
}
|
|
1003
1003
|
/**
|
|
1004
|
-
* @public
|
|
1005
1004
|
* <p/>
|
|
1005
|
+
* @public
|
|
1006
1006
|
*/
|
|
1007
1007
|
export declare class InternalServerException extends __BaseException {
|
|
1008
1008
|
readonly name: "InternalServerException";
|
|
@@ -1017,8 +1017,8 @@ export declare class InternalServerException extends __BaseException {
|
|
|
1017
1017
|
*/
|
|
1018
1018
|
export interface ListTagsForResourceRequest {
|
|
1019
1019
|
/**
|
|
1020
|
-
* @public
|
|
1021
1020
|
* <p>The ARN of the resource to be retrieved. The ARN must be URL-encoded.</p>
|
|
1021
|
+
* @public
|
|
1022
1022
|
*/
|
|
1023
1023
|
resourceArn: string | undefined;
|
|
1024
1024
|
}
|
|
@@ -1027,9 +1027,9 @@ export interface ListTagsForResourceRequest {
|
|
|
1027
1027
|
*/
|
|
1028
1028
|
export interface ListTagsForResourceResponse {
|
|
1029
1029
|
/**
|
|
1030
|
-
* @public
|
|
1031
1030
|
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
1032
1031
|
* (key:value)</code>.</p>
|
|
1032
|
+
* @public
|
|
1033
1033
|
*/
|
|
1034
1034
|
tags: Record<string, string> | undefined;
|
|
1035
1035
|
}
|
|
@@ -1038,20 +1038,20 @@ export interface ListTagsForResourceResponse {
|
|
|
1038
1038
|
*/
|
|
1039
1039
|
export interface SendEventRequest {
|
|
1040
1040
|
/**
|
|
1041
|
-
* @public
|
|
1042
1041
|
* <p>Identifier of the room to which the event will be sent. Currently this must be an
|
|
1043
1042
|
* ARN.</p>
|
|
1043
|
+
* @public
|
|
1044
1044
|
*/
|
|
1045
1045
|
roomIdentifier: string | undefined;
|
|
1046
1046
|
/**
|
|
1047
|
-
* @public
|
|
1048
1047
|
* <p>Application-defined name of the event to send to clients.</p>
|
|
1048
|
+
* @public
|
|
1049
1049
|
*/
|
|
1050
1050
|
eventName: string | undefined;
|
|
1051
1051
|
/**
|
|
1052
|
-
* @public
|
|
1053
1052
|
* <p>Application-defined metadata to attach to the event sent to clients. The maximum length
|
|
1054
1053
|
* of the metadata is 1 KB total.</p>
|
|
1054
|
+
* @public
|
|
1055
1055
|
*/
|
|
1056
1056
|
attributes?: Record<string, string>;
|
|
1057
1057
|
}
|
|
@@ -1060,9 +1060,9 @@ export interface SendEventRequest {
|
|
|
1060
1060
|
*/
|
|
1061
1061
|
export interface SendEventResponse {
|
|
1062
1062
|
/**
|
|
1063
|
-
* @public
|
|
1064
1063
|
* <p>An identifier generated by Amazon IVS Chat. This identifier must be used in subsequent
|
|
1065
1064
|
* operations for this message, such as DeleteMessage.</p>
|
|
1065
|
+
* @public
|
|
1066
1066
|
*/
|
|
1067
1067
|
id?: string;
|
|
1068
1068
|
}
|
|
@@ -1071,17 +1071,17 @@ export interface SendEventResponse {
|
|
|
1071
1071
|
*/
|
|
1072
1072
|
export interface TagResourceRequest {
|
|
1073
1073
|
/**
|
|
1074
|
-
* @public
|
|
1075
1074
|
* <p>The ARN of the resource to be tagged. The ARN must be URL-encoded.</p>
|
|
1075
|
+
* @public
|
|
1076
1076
|
*/
|
|
1077
1077
|
resourceArn: string | undefined;
|
|
1078
1078
|
/**
|
|
1079
|
-
* @public
|
|
1080
1079
|
* <p>Array of tags to be added or updated. Array of maps, each of the form
|
|
1081
1080
|
* <code>string:string (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
|
|
1082
1081
|
* Resources</a> for details, including restrictions that apply to tags and "Tag naming
|
|
1083
1082
|
* limits and requirements"; Amazon IVS Chat has no constraints beyond what is documented
|
|
1084
1083
|
* there.</p>
|
|
1084
|
+
* @public
|
|
1085
1085
|
*/
|
|
1086
1086
|
tags: Record<string, string> | undefined;
|
|
1087
1087
|
}
|
|
@@ -1095,17 +1095,17 @@ export interface TagResourceResponse {
|
|
|
1095
1095
|
*/
|
|
1096
1096
|
export interface UntagResourceRequest {
|
|
1097
1097
|
/**
|
|
1098
|
-
* @public
|
|
1099
1098
|
* <p>The ARN of the resource to be untagged. The ARN must be URL-encoded.</p>
|
|
1099
|
+
* @public
|
|
1100
1100
|
*/
|
|
1101
1101
|
resourceArn: string | undefined;
|
|
1102
1102
|
/**
|
|
1103
|
-
* @public
|
|
1104
1103
|
* <p>Array of tags to be removed. Array of maps, each of the form <code>string:string
|
|
1105
1104
|
* (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
|
|
1106
1105
|
* Resources</a> for details, including restrictions that apply to tags and "Tag naming
|
|
1107
1106
|
* limits and requirements"; Amazon IVS Chat has no constraints beyond what is documented
|
|
1108
1107
|
* there.</p>
|
|
1108
|
+
* @public
|
|
1109
1109
|
*/
|
|
1110
1110
|
tagKeys: string[] | undefined;
|
|
1111
1111
|
}
|
|
@@ -1119,21 +1119,21 @@ export interface UntagResourceResponse {
|
|
|
1119
1119
|
*/
|
|
1120
1120
|
export interface UpdateLoggingConfigurationRequest {
|
|
1121
1121
|
/**
|
|
1122
|
-
* @public
|
|
1123
1122
|
* <p>Identifier of the logging configuration to be updated.</p>
|
|
1123
|
+
* @public
|
|
1124
1124
|
*/
|
|
1125
1125
|
identifier: string | undefined;
|
|
1126
1126
|
/**
|
|
1127
|
-
* @public
|
|
1128
1127
|
* <p>Logging-configuration name. The value does not need to be unique.</p>
|
|
1128
|
+
* @public
|
|
1129
1129
|
*/
|
|
1130
1130
|
name?: string;
|
|
1131
1131
|
/**
|
|
1132
|
-
* @public
|
|
1133
1132
|
* <p>A complex type that contains a destination configuration for where chat content will be
|
|
1134
1133
|
* logged. There can be only one type of destination (<code>cloudWatchLogs</code>,
|
|
1135
1134
|
* <code>firehose</code>, or <code>s3</code>) in a
|
|
1136
1135
|
* <code>destinationConfiguration</code>.</p>
|
|
1136
|
+
* @public
|
|
1137
1137
|
*/
|
|
1138
1138
|
destinationConfiguration?: DestinationConfiguration;
|
|
1139
1139
|
}
|
|
@@ -1153,52 +1153,52 @@ export type UpdateLoggingConfigurationState = (typeof UpdateLoggingConfiguration
|
|
|
1153
1153
|
*/
|
|
1154
1154
|
export interface UpdateLoggingConfigurationResponse {
|
|
1155
1155
|
/**
|
|
1156
|
-
* @public
|
|
1157
1156
|
* <p>Logging-configuration ARN, from the request (if <code>identifier</code> was an
|
|
1158
1157
|
* ARN).</p>
|
|
1158
|
+
* @public
|
|
1159
1159
|
*/
|
|
1160
1160
|
arn?: string;
|
|
1161
1161
|
/**
|
|
1162
|
-
* @public
|
|
1163
1162
|
* <p>Logging-configuration ID, generated by the system. This is a relative identifier, the
|
|
1164
1163
|
* part of the ARN that uniquely identifies the room.</p>
|
|
1164
|
+
* @public
|
|
1165
1165
|
*/
|
|
1166
1166
|
id?: string;
|
|
1167
1167
|
/**
|
|
1168
|
-
* @public
|
|
1169
1168
|
* <p>Time when the logging configuration was created. This is an ISO 8601 timestamp;
|
|
1170
1169
|
* <i>note that this is returned as a string</i>.</p>
|
|
1170
|
+
* @public
|
|
1171
1171
|
*/
|
|
1172
1172
|
createTime?: Date;
|
|
1173
1173
|
/**
|
|
1174
|
-
* @public
|
|
1175
1174
|
* <p>Time of the logging configuration’s last update. This is an ISO 8601 timestamp;
|
|
1176
1175
|
* <i>note that this is returned as a string</i>.</p>
|
|
1176
|
+
* @public
|
|
1177
1177
|
*/
|
|
1178
1178
|
updateTime?: Date;
|
|
1179
1179
|
/**
|
|
1180
|
-
* @public
|
|
1181
1180
|
* <p>Logging-configuration name, from the request (if specified).</p>
|
|
1181
|
+
* @public
|
|
1182
1182
|
*/
|
|
1183
1183
|
name?: string;
|
|
1184
1184
|
/**
|
|
1185
|
-
* @public
|
|
1186
1185
|
* <p>A complex type that contains a destination configuration for where chat content will be
|
|
1187
1186
|
* logged, from the request. There is only one type of destination
|
|
1188
1187
|
* (<code>cloudWatchLogs</code>, <code>firehose</code>, or <code>s3</code>) in a
|
|
1189
1188
|
* <code>destinationConfiguration</code>.</p>
|
|
1189
|
+
* @public
|
|
1190
1190
|
*/
|
|
1191
1191
|
destinationConfiguration?: DestinationConfiguration;
|
|
1192
1192
|
/**
|
|
1193
|
-
* @public
|
|
1194
1193
|
* <p>The state of the logging configuration. When the state is <code>ACTIVE</code>, the
|
|
1195
1194
|
* configuration is ready to log chat content.</p>
|
|
1195
|
+
* @public
|
|
1196
1196
|
*/
|
|
1197
1197
|
state?: UpdateLoggingConfigurationState;
|
|
1198
1198
|
/**
|
|
1199
|
-
* @public
|
|
1200
1199
|
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
1201
1200
|
* (key:value)</code>. </p>
|
|
1201
|
+
* @public
|
|
1202
1202
|
*/
|
|
1203
1203
|
tags?: Record<string, string>;
|
|
1204
1204
|
}
|
|
@@ -1207,38 +1207,38 @@ export interface UpdateLoggingConfigurationResponse {
|
|
|
1207
1207
|
*/
|
|
1208
1208
|
export interface UpdateRoomRequest {
|
|
1209
1209
|
/**
|
|
1210
|
-
* @public
|
|
1211
1210
|
* <p>Identifier of the room to be updated. Currently this must be an ARN.</p>
|
|
1211
|
+
* @public
|
|
1212
1212
|
*/
|
|
1213
1213
|
identifier: string | undefined;
|
|
1214
1214
|
/**
|
|
1215
|
-
* @public
|
|
1216
1215
|
* <p>Room name. The value does not need to be unique.</p>
|
|
1216
|
+
* @public
|
|
1217
1217
|
*/
|
|
1218
1218
|
name?: string;
|
|
1219
1219
|
/**
|
|
1220
|
-
* @public
|
|
1221
1220
|
* <p>Maximum number of messages per second that can be sent to the room (by all clients).
|
|
1222
1221
|
* Default: 10.</p>
|
|
1222
|
+
* @public
|
|
1223
1223
|
*/
|
|
1224
1224
|
maximumMessageRatePerSecond?: number;
|
|
1225
1225
|
/**
|
|
1226
|
-
* @public
|
|
1227
1226
|
* <p>The maximum number of characters in a single message. Messages are expected to be UTF-8
|
|
1228
1227
|
* encoded and this limit applies specifically to rune/code-point count, not number of bytes.
|
|
1229
1228
|
* Default: 500.</p>
|
|
1229
|
+
* @public
|
|
1230
1230
|
*/
|
|
1231
1231
|
maximumMessageLength?: number;
|
|
1232
1232
|
/**
|
|
1233
|
-
* @public
|
|
1234
1233
|
* <p>Configuration information for optional review of messages. Specify an empty
|
|
1235
1234
|
* <code>uri</code> string to disassociate a message review handler from the specified
|
|
1236
1235
|
* room.</p>
|
|
1236
|
+
* @public
|
|
1237
1237
|
*/
|
|
1238
1238
|
messageReviewHandler?: MessageReviewHandler;
|
|
1239
1239
|
/**
|
|
1240
|
-
* @public
|
|
1241
1240
|
* <p>Array of logging-configuration identifiers attached to the room.</p>
|
|
1241
|
+
* @public
|
|
1242
1242
|
*/
|
|
1243
1243
|
loggingConfigurationIdentifiers?: string[];
|
|
1244
1244
|
}
|
|
@@ -1247,60 +1247,60 @@ export interface UpdateRoomRequest {
|
|
|
1247
1247
|
*/
|
|
1248
1248
|
export interface UpdateRoomResponse {
|
|
1249
1249
|
/**
|
|
1250
|
-
* @public
|
|
1251
1250
|
* <p>Room ARN, from the request (if <code>identifier</code> was an ARN).</p>
|
|
1251
|
+
* @public
|
|
1252
1252
|
*/
|
|
1253
1253
|
arn?: string;
|
|
1254
1254
|
/**
|
|
1255
|
-
* @public
|
|
1256
1255
|
* <p>Room ID, generated by the system. This is a relative identifier, the part of the ARN
|
|
1257
1256
|
* that uniquely identifies the room.</p>
|
|
1257
|
+
* @public
|
|
1258
1258
|
*/
|
|
1259
1259
|
id?: string;
|
|
1260
1260
|
/**
|
|
1261
|
-
* @public
|
|
1262
1261
|
* <p>Room name, from the request (if specified).</p>
|
|
1262
|
+
* @public
|
|
1263
1263
|
*/
|
|
1264
1264
|
name?: string;
|
|
1265
1265
|
/**
|
|
1266
|
-
* @public
|
|
1267
1266
|
* <p>Time when the room was created. This is an ISO 8601 timestamp; <i>note that this
|
|
1268
1267
|
* is returned as a string</i>.</p>
|
|
1268
|
+
* @public
|
|
1269
1269
|
*/
|
|
1270
1270
|
createTime?: Date;
|
|
1271
1271
|
/**
|
|
1272
|
-
* @public
|
|
1273
1272
|
* <p>Time of the room’s last update. This is an ISO 8601 timestamp; <i>note that this
|
|
1274
1273
|
* is returned as a string</i>.</p>
|
|
1274
|
+
* @public
|
|
1275
1275
|
*/
|
|
1276
1276
|
updateTime?: Date;
|
|
1277
1277
|
/**
|
|
1278
|
-
* @public
|
|
1279
1278
|
* <p>Maximum number of messages per second that can be sent to the room (by all clients),
|
|
1280
1279
|
* from the request (if specified).</p>
|
|
1280
|
+
* @public
|
|
1281
1281
|
*/
|
|
1282
1282
|
maximumMessageRatePerSecond?: number;
|
|
1283
1283
|
/**
|
|
1284
|
-
* @public
|
|
1285
1284
|
* <p>Maximum number of characters in a single message, from the request (if
|
|
1286
1285
|
* specified).</p>
|
|
1286
|
+
* @public
|
|
1287
1287
|
*/
|
|
1288
1288
|
maximumMessageLength?: number;
|
|
1289
1289
|
/**
|
|
1290
|
-
* @public
|
|
1291
1290
|
* <p>Configuration information for optional review of messages.</p>
|
|
1291
|
+
* @public
|
|
1292
1292
|
*/
|
|
1293
1293
|
messageReviewHandler?: MessageReviewHandler;
|
|
1294
1294
|
/**
|
|
1295
|
-
* @public
|
|
1296
1295
|
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
1297
1296
|
* (key:value)</code>.</p>
|
|
1297
|
+
* @public
|
|
1298
1298
|
*/
|
|
1299
1299
|
tags?: Record<string, string>;
|
|
1300
1300
|
/**
|
|
1301
|
-
* @public
|
|
1302
1301
|
* <p>Array of logging configurations attached to the room, from the request (if
|
|
1303
1302
|
* specified).</p>
|
|
1303
|
+
* @public
|
|
1304
1304
|
*/
|
|
1305
1305
|
loggingConfigurationIdentifiers?: string[];
|
|
1306
1306
|
}
|