@aws-sdk/client-ivschat 3.211.0 → 3.213.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/README.md +37 -5
- package/dist-cjs/Ivschat.js +75 -0
- package/dist-cjs/commands/CreateLoggingConfigurationCommand.js +46 -0
- package/dist-cjs/commands/DeleteLoggingConfigurationCommand.js +46 -0
- package/dist-cjs/commands/GetLoggingConfigurationCommand.js +46 -0
- package/dist-cjs/commands/ListLoggingConfigurationsCommand.js +46 -0
- package/dist-cjs/commands/UpdateLoggingConfigurationCommand.js +46 -0
- package/dist-cjs/commands/index.js +5 -0
- package/dist-cjs/models/models_0.js +121 -6
- package/dist-cjs/pagination/ListLoggingConfigurationsPaginator.js +36 -0
- package/dist-cjs/pagination/index.js +1 -0
- package/dist-cjs/protocols/Aws_restJson1.js +522 -16
- package/dist-es/Ivschat.js +75 -0
- package/dist-es/commands/CreateLoggingConfigurationCommand.js +42 -0
- package/dist-es/commands/DeleteLoggingConfigurationCommand.js +42 -0
- package/dist-es/commands/GetLoggingConfigurationCommand.js +42 -0
- package/dist-es/commands/ListLoggingConfigurationsCommand.js +42 -0
- package/dist-es/commands/UpdateLoggingConfigurationCommand.js +42 -0
- package/dist-es/commands/index.js +5 -0
- package/dist-es/models/models_0.js +105 -5
- package/dist-es/pagination/ListLoggingConfigurationsPaginator.js +32 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_restJson1.js +513 -17
- package/dist-types/Ivschat.d.ts +84 -8
- package/dist-types/IvschatClient.d.ts +44 -7
- package/dist-types/commands/CreateChatTokenCommand.d.ts +10 -3
- package/dist-types/commands/CreateLoggingConfigurationCommand.d.ts +38 -0
- package/dist-types/commands/DeleteLoggingConfigurationCommand.d.ts +37 -0
- package/dist-types/commands/GetLoggingConfigurationCommand.d.ts +37 -0
- package/dist-types/commands/ListLoggingConfigurationsCommand.d.ts +38 -0
- package/dist-types/commands/UpdateLoggingConfigurationCommand.d.ts +37 -0
- package/dist-types/commands/index.d.ts +5 -0
- package/dist-types/models/models_0.d.ts +473 -37
- package/dist-types/pagination/ListLoggingConfigurationsPaginator.d.ts +4 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +15 -0
- package/dist-types/ts3.4/Ivschat.d.ts +85 -0
- package/dist-types/ts3.4/IvschatClient.d.ts +30 -0
- package/dist-types/ts3.4/commands/CreateLoggingConfigurationCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/DeleteLoggingConfigurationCommand.d.ts +37 -0
- package/dist-types/ts3.4/commands/GetLoggingConfigurationCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/ListLoggingConfigurationsCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/UpdateLoggingConfigurationCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/index.d.ts +5 -0
- package/dist-types/ts3.4/models/models_0.d.ts +184 -9
- package/dist-types/ts3.4/pagination/ListLoggingConfigurationsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +60 -0
- package/package.json +28 -28
|
@@ -150,6 +150,172 @@ export declare class ConflictException extends __BaseException {
|
|
|
150
150
|
*/
|
|
151
151
|
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
152
152
|
}
|
|
153
|
+
/**
|
|
154
|
+
* <p>Specifies a CloudWatch Logs location where chat logs will be stored.</p>
|
|
155
|
+
*/
|
|
156
|
+
export interface CloudWatchLogsDestinationConfiguration {
|
|
157
|
+
/**
|
|
158
|
+
* <p>Name of the Amazon Cloudwatch Logs destination where chat activity will be logged.</p>
|
|
159
|
+
*/
|
|
160
|
+
logGroupName: string | undefined;
|
|
161
|
+
}
|
|
162
|
+
/**
|
|
163
|
+
* <p>Specifies a Kinesis Firehose location where chat logs will be stored.</p>
|
|
164
|
+
*/
|
|
165
|
+
export interface FirehoseDestinationConfiguration {
|
|
166
|
+
/**
|
|
167
|
+
* <p>Name of the Amazon Kinesis Firehose delivery stream where chat activity will be
|
|
168
|
+
* logged.</p>
|
|
169
|
+
*/
|
|
170
|
+
deliveryStreamName: string | undefined;
|
|
171
|
+
}
|
|
172
|
+
/**
|
|
173
|
+
* <p>Specifies an S3 location where chat logs will be stored.</p>
|
|
174
|
+
*/
|
|
175
|
+
export interface S3DestinationConfiguration {
|
|
176
|
+
/**
|
|
177
|
+
* <p>Name of the Amazon S3 bucket where chat activity will be logged.</p>
|
|
178
|
+
*/
|
|
179
|
+
bucketName: string | undefined;
|
|
180
|
+
}
|
|
181
|
+
/**
|
|
182
|
+
* <p>A complex type that describes a location where chat logs will be stored. Each member
|
|
183
|
+
* represents the configuration of one log destination. For logging, you define only one type of
|
|
184
|
+
* destination (for CloudWatch Logs, Kinesis Firehose, or S3).</p>
|
|
185
|
+
*/
|
|
186
|
+
export declare type DestinationConfiguration = DestinationConfiguration.CloudWatchLogsMember | DestinationConfiguration.FirehoseMember | DestinationConfiguration.S3Member | DestinationConfiguration.$UnknownMember;
|
|
187
|
+
export declare namespace DestinationConfiguration {
|
|
188
|
+
/**
|
|
189
|
+
* <p>Name of the Amazon S3 bucket where chat activity will be logged.</p>
|
|
190
|
+
*/
|
|
191
|
+
interface S3Member {
|
|
192
|
+
s3: S3DestinationConfiguration;
|
|
193
|
+
cloudWatchLogs?: never;
|
|
194
|
+
firehose?: never;
|
|
195
|
+
$unknown?: never;
|
|
196
|
+
}
|
|
197
|
+
/**
|
|
198
|
+
* <p>Name of the Amazon CloudWatch Logs destination where chat activity will be logged.</p>
|
|
199
|
+
*/
|
|
200
|
+
interface CloudWatchLogsMember {
|
|
201
|
+
s3?: never;
|
|
202
|
+
cloudWatchLogs: CloudWatchLogsDestinationConfiguration;
|
|
203
|
+
firehose?: never;
|
|
204
|
+
$unknown?: never;
|
|
205
|
+
}
|
|
206
|
+
/**
|
|
207
|
+
* <p>Name of the Amazon Kinesis Data Firehose destination where chat activity will be
|
|
208
|
+
* logged</p>
|
|
209
|
+
*/
|
|
210
|
+
interface FirehoseMember {
|
|
211
|
+
s3?: never;
|
|
212
|
+
cloudWatchLogs?: never;
|
|
213
|
+
firehose: FirehoseDestinationConfiguration;
|
|
214
|
+
$unknown?: never;
|
|
215
|
+
}
|
|
216
|
+
interface $UnknownMember {
|
|
217
|
+
s3?: never;
|
|
218
|
+
cloudWatchLogs?: never;
|
|
219
|
+
firehose?: never;
|
|
220
|
+
$unknown: [string, any];
|
|
221
|
+
}
|
|
222
|
+
interface Visitor<T> {
|
|
223
|
+
s3: (value: S3DestinationConfiguration) => T;
|
|
224
|
+
cloudWatchLogs: (value: CloudWatchLogsDestinationConfiguration) => T;
|
|
225
|
+
firehose: (value: FirehoseDestinationConfiguration) => T;
|
|
226
|
+
_: (name: string, value: any) => T;
|
|
227
|
+
}
|
|
228
|
+
const visit: <T>(value: DestinationConfiguration, visitor: Visitor<T>) => T;
|
|
229
|
+
}
|
|
230
|
+
export interface CreateLoggingConfigurationRequest {
|
|
231
|
+
/**
|
|
232
|
+
* <p>Logging-configuration name. The value does not need to be unique.</p>
|
|
233
|
+
*/
|
|
234
|
+
name?: string;
|
|
235
|
+
/**
|
|
236
|
+
* <p>A complex type that contains a destination configuration for where chat content will be
|
|
237
|
+
* logged. There can be only one type of destination (<code>cloudWatchLogs</code>,
|
|
238
|
+
* <code>firehose</code>, or <code>s3</code>) in a
|
|
239
|
+
* <code>destinationConfiguration</code>.</p>
|
|
240
|
+
*/
|
|
241
|
+
destinationConfiguration: DestinationConfiguration | undefined;
|
|
242
|
+
/**
|
|
243
|
+
* <p>Tags to attach to the resource. Array of maps, each of the form <code>string:string
|
|
244
|
+
* (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
|
|
245
|
+
* Resources</a> for details, including restrictions that apply to tags and "Tag naming
|
|
246
|
+
* limits and requirements"; Amazon IVS Chat has no constraints on tags beyond what is
|
|
247
|
+
* documented there.</p>
|
|
248
|
+
*/
|
|
249
|
+
tags?: Record<string, string>;
|
|
250
|
+
}
|
|
251
|
+
export declare enum CreateLoggingConfigurationState {
|
|
252
|
+
ACTIVE = "ACTIVE"
|
|
253
|
+
}
|
|
254
|
+
export interface CreateLoggingConfigurationResponse {
|
|
255
|
+
/**
|
|
256
|
+
* <p>Logging-configuration ARN, assigned by the system.</p>
|
|
257
|
+
*/
|
|
258
|
+
arn?: string;
|
|
259
|
+
/**
|
|
260
|
+
* <p>Logging-configuration ID, generated by the system. This is a relative identifier, the
|
|
261
|
+
* part of the ARN that uniquely identifies the logging configuration.</p>
|
|
262
|
+
*/
|
|
263
|
+
id?: string;
|
|
264
|
+
/**
|
|
265
|
+
* <p>Time when the logging configuration was created. This is an ISO 8601 timestamp;
|
|
266
|
+
* <i>note that this is returned as a string</i>.</p>
|
|
267
|
+
*/
|
|
268
|
+
createTime?: Date;
|
|
269
|
+
/**
|
|
270
|
+
* <p>Time of the logging configuration’s last update. This is an ISO 8601 timestamp;
|
|
271
|
+
* <i>note that this is returned as a string</i>.</p>
|
|
272
|
+
*/
|
|
273
|
+
updateTime?: Date;
|
|
274
|
+
/**
|
|
275
|
+
* <p>Logging-configuration name, from the request (if specified).</p>
|
|
276
|
+
*/
|
|
277
|
+
name?: string;
|
|
278
|
+
/**
|
|
279
|
+
* <p>A complex type that contains a destination configuration for where chat content will be
|
|
280
|
+
* logged, from the request. There is only one type of destination
|
|
281
|
+
* (<code>cloudWatchLogs</code>, <code>firehose</code>, or <code>s3</code>) in a
|
|
282
|
+
* <code>destinationConfiguration</code>.</p>
|
|
283
|
+
*/
|
|
284
|
+
destinationConfiguration?: DestinationConfiguration;
|
|
285
|
+
/**
|
|
286
|
+
* <p>The state of the logging configuration. When the state is <code>ACTIVE</code>, the
|
|
287
|
+
* configuration is ready to log chat content.</p>
|
|
288
|
+
*/
|
|
289
|
+
state?: CreateLoggingConfigurationState | string;
|
|
290
|
+
/**
|
|
291
|
+
* <p>Tags attached to the resource, from the request (if specified). Array of maps, each of
|
|
292
|
+
* the form <code>string:string (key:value)</code>.</p>
|
|
293
|
+
*/
|
|
294
|
+
tags?: Record<string, string>;
|
|
295
|
+
}
|
|
296
|
+
/**
|
|
297
|
+
* <p/>
|
|
298
|
+
*/
|
|
299
|
+
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
300
|
+
readonly name: "ServiceQuotaExceededException";
|
|
301
|
+
readonly $fault: "client";
|
|
302
|
+
/**
|
|
303
|
+
* <p/>
|
|
304
|
+
*/
|
|
305
|
+
resourceId: string | undefined;
|
|
306
|
+
/**
|
|
307
|
+
* <p/>
|
|
308
|
+
*/
|
|
309
|
+
resourceType: ResourceType | string | undefined;
|
|
310
|
+
/**
|
|
311
|
+
* <p/>
|
|
312
|
+
*/
|
|
313
|
+
limit: number | undefined;
|
|
314
|
+
/**
|
|
315
|
+
* @internal
|
|
316
|
+
*/
|
|
317
|
+
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
318
|
+
}
|
|
153
319
|
export declare enum FallbackResult {
|
|
154
320
|
ALLOW = "ALLOW",
|
|
155
321
|
DENY = "DENY"
|
|
@@ -159,14 +325,17 @@ export declare enum FallbackResult {
|
|
|
159
325
|
*/
|
|
160
326
|
export interface MessageReviewHandler {
|
|
161
327
|
/**
|
|
162
|
-
* <p>Identifier of the message review handler. Currently this must be an ARN of a lambda
|
|
328
|
+
* <p>Identifier of the message review handler. Currently this must be an ARN of a lambda
|
|
329
|
+
* function.</p>
|
|
163
330
|
*/
|
|
164
331
|
uri?: string;
|
|
165
332
|
/**
|
|
166
333
|
* <p>Specifies the fallback behavior (whether the message is allowed or denied) if the handler
|
|
167
|
-
* does not return a valid response, encounters an error, or times out. (For the timeout period,
|
|
168
|
-
*
|
|
169
|
-
*
|
|
334
|
+
* does not return a valid response, encounters an error, or times out. (For the timeout period,
|
|
335
|
+
* see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/service-quotas.html"> Service
|
|
336
|
+
* Quotas</a>.) If allowed, the message is delivered with returned content to all users
|
|
337
|
+
* connected to the room. If denied, the message is not delivered to any user. Default:
|
|
338
|
+
* <code>ALLOW</code>.</p>
|
|
170
339
|
*/
|
|
171
340
|
fallbackResult?: FallbackResult | string;
|
|
172
341
|
}
|
|
@@ -198,6 +367,10 @@ export interface CreateRoomRequest {
|
|
|
198
367
|
* there.</p>
|
|
199
368
|
*/
|
|
200
369
|
tags?: Record<string, string>;
|
|
370
|
+
/**
|
|
371
|
+
* <p>Array of logging-configuration identifiers attached to the room.</p>
|
|
372
|
+
*/
|
|
373
|
+
loggingConfigurationIdentifiers?: string[];
|
|
201
374
|
}
|
|
202
375
|
export interface CreateRoomResponse {
|
|
203
376
|
/**
|
|
@@ -225,11 +398,12 @@ export interface CreateRoomResponse {
|
|
|
225
398
|
updateTime?: Date;
|
|
226
399
|
/**
|
|
227
400
|
* <p>Maximum number of messages per second that can be sent to the room (by all clients),
|
|
228
|
-
* from the request.</p>
|
|
401
|
+
* from the request (if specified).</p>
|
|
229
402
|
*/
|
|
230
403
|
maximumMessageRatePerSecond?: number;
|
|
231
404
|
/**
|
|
232
|
-
* <p>Maximum number of characters in a single message, from the request
|
|
405
|
+
* <p>Maximum number of characters in a single message, from the request (if
|
|
406
|
+
* specified).</p>
|
|
233
407
|
*/
|
|
234
408
|
maximumMessageLength?: number;
|
|
235
409
|
/**
|
|
@@ -237,32 +411,20 @@ export interface CreateRoomResponse {
|
|
|
237
411
|
*/
|
|
238
412
|
messageReviewHandler?: MessageReviewHandler;
|
|
239
413
|
/**
|
|
240
|
-
* <p>Tags attached to the resource, from the request.</p>
|
|
414
|
+
* <p>Tags attached to the resource, from the request (if specified).</p>
|
|
241
415
|
*/
|
|
242
416
|
tags?: Record<string, string>;
|
|
243
|
-
}
|
|
244
|
-
/**
|
|
245
|
-
* <p/>
|
|
246
|
-
*/
|
|
247
|
-
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
248
|
-
readonly name: "ServiceQuotaExceededException";
|
|
249
|
-
readonly $fault: "client";
|
|
250
|
-
/**
|
|
251
|
-
* <p/>
|
|
252
|
-
*/
|
|
253
|
-
resourceId: string | undefined;
|
|
254
|
-
/**
|
|
255
|
-
* <p/>
|
|
256
|
-
*/
|
|
257
|
-
resourceType: ResourceType | string | undefined;
|
|
258
417
|
/**
|
|
259
|
-
* <p
|
|
418
|
+
* <p>Array of logging configurations attached to the room, from the request (if
|
|
419
|
+
* specified).</p>
|
|
260
420
|
*/
|
|
261
|
-
|
|
421
|
+
loggingConfigurationIdentifiers?: string[];
|
|
422
|
+
}
|
|
423
|
+
export interface DeleteLoggingConfigurationRequest {
|
|
262
424
|
/**
|
|
263
|
-
*
|
|
425
|
+
* <p>Identifier of the logging configuration to be deleted.</p>
|
|
264
426
|
*/
|
|
265
|
-
|
|
427
|
+
identifier: string | undefined;
|
|
266
428
|
}
|
|
267
429
|
export interface DeleteMessageRequest {
|
|
268
430
|
/**
|
|
@@ -333,6 +495,64 @@ export interface DisconnectUserRequest {
|
|
|
333
495
|
}
|
|
334
496
|
export interface DisconnectUserResponse {
|
|
335
497
|
}
|
|
498
|
+
export interface GetLoggingConfigurationRequest {
|
|
499
|
+
/**
|
|
500
|
+
* <p>Identifier of the logging configuration to be retrieved.</p>
|
|
501
|
+
*/
|
|
502
|
+
identifier: string | undefined;
|
|
503
|
+
}
|
|
504
|
+
export declare enum LoggingConfigurationState {
|
|
505
|
+
ACTIVE = "ACTIVE",
|
|
506
|
+
CREATE_FAILED = "CREATE_FAILED",
|
|
507
|
+
CREATING = "CREATING",
|
|
508
|
+
DELETE_FAILED = "DELETE_FAILED",
|
|
509
|
+
DELETING = "DELETING",
|
|
510
|
+
UPDATE_FAILED = "UPDATE_FAILED",
|
|
511
|
+
UPDATING = "UPDATING"
|
|
512
|
+
}
|
|
513
|
+
export interface GetLoggingConfigurationResponse {
|
|
514
|
+
/**
|
|
515
|
+
* <p>Logging-configuration ARN, from the request (if <code>identifier</code> was an
|
|
516
|
+
* ARN).</p>
|
|
517
|
+
*/
|
|
518
|
+
arn?: string;
|
|
519
|
+
/**
|
|
520
|
+
* <p>Logging-configuration ID, generated by the system. This is a relative identifier, the
|
|
521
|
+
* part of the ARN that uniquely identifies the logging configuration.</p>
|
|
522
|
+
*/
|
|
523
|
+
id?: string;
|
|
524
|
+
/**
|
|
525
|
+
* <p>Time when the logging configuration was created. This is an ISO 8601 timestamp;
|
|
526
|
+
* <i>note that this is returned as a string</i>.</p>
|
|
527
|
+
*/
|
|
528
|
+
createTime?: Date;
|
|
529
|
+
/**
|
|
530
|
+
* <p>Time of the logging configuration’s last update. This is an ISO 8601 timestamp;
|
|
531
|
+
* <i>note that this is returned as a string</i>.</p>
|
|
532
|
+
*/
|
|
533
|
+
updateTime?: Date;
|
|
534
|
+
/**
|
|
535
|
+
* <p>Logging-configuration name. This value does not need to be unique.</p>
|
|
536
|
+
*/
|
|
537
|
+
name?: string;
|
|
538
|
+
/**
|
|
539
|
+
* <p>A complex type that contains a destination configuration for where chat content will be
|
|
540
|
+
* logged. There is only one type of destination (<code>cloudWatchLogs</code>,
|
|
541
|
+
* <code>firehose</code>, or <code>s3</code>) in a
|
|
542
|
+
* <code>destinationConfiguration</code>.</p>
|
|
543
|
+
*/
|
|
544
|
+
destinationConfiguration?: DestinationConfiguration;
|
|
545
|
+
/**
|
|
546
|
+
* <p>The state of the logging configuration. When the state is <code>ACTIVE</code>, the
|
|
547
|
+
* configuration is ready to log chat content.</p>
|
|
548
|
+
*/
|
|
549
|
+
state?: LoggingConfigurationState | string;
|
|
550
|
+
/**
|
|
551
|
+
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
552
|
+
* (key:value)</code>.</p>
|
|
553
|
+
*/
|
|
554
|
+
tags?: Record<string, string>;
|
|
555
|
+
}
|
|
336
556
|
export interface GetRoomRequest {
|
|
337
557
|
/**
|
|
338
558
|
* <p>Identifier of the room for which the configuration is to be retrieved. Currently this
|
|
@@ -384,6 +604,80 @@ export interface GetRoomResponse {
|
|
|
384
604
|
* (key:value)</code>.</p>
|
|
385
605
|
*/
|
|
386
606
|
tags?: Record<string, string>;
|
|
607
|
+
/**
|
|
608
|
+
* <p>Array of logging configurations attached to the room.</p>
|
|
609
|
+
*/
|
|
610
|
+
loggingConfigurationIdentifiers?: string[];
|
|
611
|
+
}
|
|
612
|
+
export interface ListLoggingConfigurationsRequest {
|
|
613
|
+
/**
|
|
614
|
+
* <p>The first logging configurations to retrieve. This is used for pagination; see the
|
|
615
|
+
* <code>nextToken</code> response field.</p>
|
|
616
|
+
*/
|
|
617
|
+
nextToken?: string;
|
|
618
|
+
/**
|
|
619
|
+
* <p>Maximum number of logging configurations to return. Default: 50.</p>
|
|
620
|
+
*/
|
|
621
|
+
maxResults?: number;
|
|
622
|
+
}
|
|
623
|
+
/**
|
|
624
|
+
* <p>Summary information about a logging configuration.</p>
|
|
625
|
+
*/
|
|
626
|
+
export interface LoggingConfigurationSummary {
|
|
627
|
+
/**
|
|
628
|
+
* <p>Logging-configuration ARN.</p>
|
|
629
|
+
*/
|
|
630
|
+
arn?: string;
|
|
631
|
+
/**
|
|
632
|
+
* <p>Logging-configuration ID, generated by the system. This is a relative identifier, the part
|
|
633
|
+
* of the ARN that uniquely identifies the room.</p>
|
|
634
|
+
*/
|
|
635
|
+
id?: string;
|
|
636
|
+
/**
|
|
637
|
+
* <p>Time when the logging configuration was created. This is an ISO 8601 timestamp;
|
|
638
|
+
* <i>note that this is returned as a string</i>.</p>
|
|
639
|
+
*/
|
|
640
|
+
createTime?: Date;
|
|
641
|
+
/**
|
|
642
|
+
* <p>Time of the logging configuration’s last update. This is an ISO 8601 timestamp;
|
|
643
|
+
* <i>note that this is returned as a string</i>.</p>
|
|
644
|
+
*/
|
|
645
|
+
updateTime?: Date;
|
|
646
|
+
/**
|
|
647
|
+
* <p>Logging-configuration name. The value does not need to be unique.</p>
|
|
648
|
+
*/
|
|
649
|
+
name?: string;
|
|
650
|
+
/**
|
|
651
|
+
* <p>A complex type that contains a destination configuration for where chat content will be
|
|
652
|
+
* logged.</p>
|
|
653
|
+
*/
|
|
654
|
+
destinationConfiguration?: DestinationConfiguration;
|
|
655
|
+
/**
|
|
656
|
+
* <p>The state of the logging configuration. When this is <code>ACTIVE</code>, the
|
|
657
|
+
* configuration is ready for logging chat content.</p>
|
|
658
|
+
*/
|
|
659
|
+
state?: LoggingConfigurationState | string;
|
|
660
|
+
/**
|
|
661
|
+
* <p>Tags to attach to the resource. Array of maps, each of the form <code>string:string
|
|
662
|
+
* (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
|
|
663
|
+
* Resources</a> for details, including restrictions that apply to tags and "Tag naming
|
|
664
|
+
* limits and requirements"; Amazon IVS Chat has no constraints on tags beyond what is documented
|
|
665
|
+
* there.</p>
|
|
666
|
+
*/
|
|
667
|
+
tags?: Record<string, string>;
|
|
668
|
+
}
|
|
669
|
+
export interface ListLoggingConfigurationsResponse {
|
|
670
|
+
/**
|
|
671
|
+
* <p>List of the matching logging configurations (summary information only). There is only
|
|
672
|
+
* one type of destination (<code>cloudWatchLogs</code>, <code>firehose</code>, or
|
|
673
|
+
* <code>s3</code>) in a <code>destinationConfiguration</code>.</p>
|
|
674
|
+
*/
|
|
675
|
+
loggingConfigurations: LoggingConfigurationSummary[] | undefined;
|
|
676
|
+
/**
|
|
677
|
+
* <p>If there are more logging configurations than <code>maxResults</code>, use
|
|
678
|
+
* <code>nextToken</code> in the request to get the next set.</p>
|
|
679
|
+
*/
|
|
680
|
+
nextToken?: string;
|
|
387
681
|
}
|
|
388
682
|
export interface ListRoomsRequest {
|
|
389
683
|
/**
|
|
@@ -403,6 +697,10 @@ export interface ListRoomsRequest {
|
|
|
403
697
|
* <p>Filters the list to match the specified message review handler URI.</p>
|
|
404
698
|
*/
|
|
405
699
|
messageReviewHandlerUri?: string;
|
|
700
|
+
/**
|
|
701
|
+
* <p>Logging-configuration identifier.</p>
|
|
702
|
+
*/
|
|
703
|
+
loggingConfigurationIdentifier?: string;
|
|
406
704
|
}
|
|
407
705
|
/**
|
|
408
706
|
* <p>Summary information about a room.</p>
|
|
@@ -436,12 +734,17 @@ export interface RoomSummary {
|
|
|
436
734
|
*/
|
|
437
735
|
updateTime?: Date;
|
|
438
736
|
/**
|
|
439
|
-
* <p>Tags attached to the resource.
|
|
440
|
-
*
|
|
737
|
+
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
738
|
+
* (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
|
|
739
|
+
* Resources</a> for details, including restrictions that apply to tags and "Tag naming
|
|
441
740
|
* limits and requirements"; Amazon IVS Chat has no constraints beyond what is documented
|
|
442
741
|
* there.</p>
|
|
443
742
|
*/
|
|
444
743
|
tags?: Record<string, string>;
|
|
744
|
+
/**
|
|
745
|
+
* <p>List of logging-configuration identifiers attached to the room.</p>
|
|
746
|
+
*/
|
|
747
|
+
loggingConfigurationIdentifiers?: string[];
|
|
445
748
|
}
|
|
446
749
|
export interface ListRoomsResponse {
|
|
447
750
|
/**
|
|
@@ -473,7 +776,8 @@ export interface ListTagsForResourceRequest {
|
|
|
473
776
|
}
|
|
474
777
|
export interface ListTagsForResourceResponse {
|
|
475
778
|
/**
|
|
476
|
-
* <p>Tags attached to the resource,
|
|
779
|
+
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
780
|
+
* (key:value)</code>.</p>
|
|
477
781
|
*/
|
|
478
782
|
tags: Record<string, string> | undefined;
|
|
479
783
|
}
|
|
@@ -506,8 +810,9 @@ export interface TagResourceRequest {
|
|
|
506
810
|
*/
|
|
507
811
|
resourceArn: string | undefined;
|
|
508
812
|
/**
|
|
509
|
-
* <p>Array of tags to be added or updated.
|
|
510
|
-
*
|
|
813
|
+
* <p>Array of tags to be added or updated. Array of maps, each of the form
|
|
814
|
+
* <code>string:string (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
|
|
815
|
+
* Resources</a> for details, including restrictions that apply to tags and "Tag naming
|
|
511
816
|
* limits and requirements"; Amazon IVS Chat has no constraints beyond what is documented
|
|
512
817
|
* there.</p>
|
|
513
818
|
*/
|
|
@@ -521,8 +826,9 @@ export interface UntagResourceRequest {
|
|
|
521
826
|
*/
|
|
522
827
|
resourceArn: string | undefined;
|
|
523
828
|
/**
|
|
524
|
-
* <p>Array of tags to be removed.
|
|
525
|
-
*
|
|
829
|
+
* <p>Array of tags to be removed. Array of maps, each of the form <code>string:string
|
|
830
|
+
* (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
|
|
831
|
+
* Resources</a> for details, including restrictions that apply to tags and "Tag naming
|
|
526
832
|
* limits and requirements"; Amazon IVS Chat has no constraints beyond what is documented
|
|
527
833
|
* there.</p>
|
|
528
834
|
*/
|
|
@@ -530,6 +836,69 @@ export interface UntagResourceRequest {
|
|
|
530
836
|
}
|
|
531
837
|
export interface UntagResourceResponse {
|
|
532
838
|
}
|
|
839
|
+
export interface UpdateLoggingConfigurationRequest {
|
|
840
|
+
/**
|
|
841
|
+
* <p>Identifier of the logging configuration to be updated.</p>
|
|
842
|
+
*/
|
|
843
|
+
identifier: string | undefined;
|
|
844
|
+
/**
|
|
845
|
+
* <p>Logging-configuration name. The value does not need to be unique.</p>
|
|
846
|
+
*/
|
|
847
|
+
name?: string;
|
|
848
|
+
/**
|
|
849
|
+
* <p>A complex type that contains a destination configuration for where chat content will be
|
|
850
|
+
* logged. There can be only one type of destination (<code>cloudWatchLogs</code>,
|
|
851
|
+
* <code>firehose</code>, or <code>s3</code>) in a
|
|
852
|
+
* <code>destinationConfiguration</code>.</p>
|
|
853
|
+
*/
|
|
854
|
+
destinationConfiguration?: DestinationConfiguration;
|
|
855
|
+
}
|
|
856
|
+
export declare enum UpdateLoggingConfigurationState {
|
|
857
|
+
ACTIVE = "ACTIVE"
|
|
858
|
+
}
|
|
859
|
+
export interface UpdateLoggingConfigurationResponse {
|
|
860
|
+
/**
|
|
861
|
+
* <p>Logging-configuration ARN, from the request (if <code>identifier</code> was an
|
|
862
|
+
* ARN).</p>
|
|
863
|
+
*/
|
|
864
|
+
arn?: string;
|
|
865
|
+
/**
|
|
866
|
+
* <p>Logging-configuration ID, generated by the system. This is a relative identifier, the
|
|
867
|
+
* part of the ARN that uniquely identifies the room.</p>
|
|
868
|
+
*/
|
|
869
|
+
id?: string;
|
|
870
|
+
/**
|
|
871
|
+
* <p>Time when the logging configuration was created. This is an ISO 8601 timestamp;
|
|
872
|
+
* <i>note that this is returned as a string</i>.</p>
|
|
873
|
+
*/
|
|
874
|
+
createTime?: Date;
|
|
875
|
+
/**
|
|
876
|
+
* <p>Time of the logging configuration’s last update. This is an ISO 8601 timestamp;
|
|
877
|
+
* <i>note that this is returned as a string</i>.</p>
|
|
878
|
+
*/
|
|
879
|
+
updateTime?: Date;
|
|
880
|
+
/**
|
|
881
|
+
* <p>Logging-configuration name, from the request (if specified).</p>
|
|
882
|
+
*/
|
|
883
|
+
name?: string;
|
|
884
|
+
/**
|
|
885
|
+
* <p>A complex type that contains a destination configuration for where chat content will be
|
|
886
|
+
* logged, from the request. There is only one type of destination
|
|
887
|
+
* (<code>cloudWatchLogs</code>, <code>firehose</code>, or <code>s3</code>) in a
|
|
888
|
+
* <code>destinationConfiguration</code>.</p>
|
|
889
|
+
*/
|
|
890
|
+
destinationConfiguration?: DestinationConfiguration;
|
|
891
|
+
/**
|
|
892
|
+
* <p>The state of the logging configuration. When the state is <code>ACTIVE</code>, the
|
|
893
|
+
* configuration is ready to log chat content.</p>
|
|
894
|
+
*/
|
|
895
|
+
state?: UpdateLoggingConfigurationState | string;
|
|
896
|
+
/**
|
|
897
|
+
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
898
|
+
* (key:value)</code>. </p>
|
|
899
|
+
*/
|
|
900
|
+
tags?: Record<string, string>;
|
|
901
|
+
}
|
|
533
902
|
export interface UpdateRoomRequest {
|
|
534
903
|
/**
|
|
535
904
|
* <p>Identifier of the room to be updated. Currently this must be an ARN.</p>
|
|
@@ -556,6 +925,10 @@ export interface UpdateRoomRequest {
|
|
|
556
925
|
* room.</p>
|
|
557
926
|
*/
|
|
558
927
|
messageReviewHandler?: MessageReviewHandler;
|
|
928
|
+
/**
|
|
929
|
+
* <p>Array of logging-configuration identifiers attached to the room.</p>
|
|
930
|
+
*/
|
|
931
|
+
loggingConfigurationIdentifiers?: string[];
|
|
559
932
|
}
|
|
560
933
|
export interface UpdateRoomResponse {
|
|
561
934
|
/**
|
|
@@ -568,7 +941,7 @@ export interface UpdateRoomResponse {
|
|
|
568
941
|
*/
|
|
569
942
|
id?: string;
|
|
570
943
|
/**
|
|
571
|
-
* <p>Room name, from the request.</p>
|
|
944
|
+
* <p>Room name, from the request (if specified).</p>
|
|
572
945
|
*/
|
|
573
946
|
name?: string;
|
|
574
947
|
/**
|
|
@@ -583,11 +956,12 @@ export interface UpdateRoomResponse {
|
|
|
583
956
|
updateTime?: Date;
|
|
584
957
|
/**
|
|
585
958
|
* <p>Maximum number of messages per second that can be sent to the room (by all clients),
|
|
586
|
-
* from the request.</p>
|
|
959
|
+
* from the request (if specified).</p>
|
|
587
960
|
*/
|
|
588
961
|
maximumMessageRatePerSecond?: number;
|
|
589
962
|
/**
|
|
590
|
-
* <p>Maximum number of characters in a single message, from the request
|
|
963
|
+
* <p>Maximum number of characters in a single message, from the request (if
|
|
964
|
+
* specified).</p>
|
|
591
965
|
*/
|
|
592
966
|
maximumMessageLength?: number;
|
|
593
967
|
/**
|
|
@@ -595,9 +969,15 @@ export interface UpdateRoomResponse {
|
|
|
595
969
|
*/
|
|
596
970
|
messageReviewHandler?: MessageReviewHandler;
|
|
597
971
|
/**
|
|
598
|
-
* <p>Tags attached to the resource
|
|
972
|
+
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
973
|
+
* (key:value)</code>.</p>
|
|
599
974
|
*/
|
|
600
975
|
tags?: Record<string, string>;
|
|
976
|
+
/**
|
|
977
|
+
* <p>Array of logging configurations attached to the room, from the request (if
|
|
978
|
+
* specified).</p>
|
|
979
|
+
*/
|
|
980
|
+
loggingConfigurationIdentifiers?: string[];
|
|
601
981
|
}
|
|
602
982
|
/**
|
|
603
983
|
* @internal
|
|
@@ -611,6 +991,30 @@ export declare const CreateChatTokenResponseFilterSensitiveLog: (obj: CreateChat
|
|
|
611
991
|
* @internal
|
|
612
992
|
*/
|
|
613
993
|
export declare const ValidationExceptionFieldFilterSensitiveLog: (obj: ValidationExceptionField) => any;
|
|
994
|
+
/**
|
|
995
|
+
* @internal
|
|
996
|
+
*/
|
|
997
|
+
export declare const CloudWatchLogsDestinationConfigurationFilterSensitiveLog: (obj: CloudWatchLogsDestinationConfiguration) => any;
|
|
998
|
+
/**
|
|
999
|
+
* @internal
|
|
1000
|
+
*/
|
|
1001
|
+
export declare const FirehoseDestinationConfigurationFilterSensitiveLog: (obj: FirehoseDestinationConfiguration) => any;
|
|
1002
|
+
/**
|
|
1003
|
+
* @internal
|
|
1004
|
+
*/
|
|
1005
|
+
export declare const S3DestinationConfigurationFilterSensitiveLog: (obj: S3DestinationConfiguration) => any;
|
|
1006
|
+
/**
|
|
1007
|
+
* @internal
|
|
1008
|
+
*/
|
|
1009
|
+
export declare const DestinationConfigurationFilterSensitiveLog: (obj: DestinationConfiguration) => any;
|
|
1010
|
+
/**
|
|
1011
|
+
* @internal
|
|
1012
|
+
*/
|
|
1013
|
+
export declare const CreateLoggingConfigurationRequestFilterSensitiveLog: (obj: CreateLoggingConfigurationRequest) => any;
|
|
1014
|
+
/**
|
|
1015
|
+
* @internal
|
|
1016
|
+
*/
|
|
1017
|
+
export declare const CreateLoggingConfigurationResponseFilterSensitiveLog: (obj: CreateLoggingConfigurationResponse) => any;
|
|
614
1018
|
/**
|
|
615
1019
|
* @internal
|
|
616
1020
|
*/
|
|
@@ -623,6 +1027,10 @@ export declare const CreateRoomRequestFilterSensitiveLog: (obj: CreateRoomReques
|
|
|
623
1027
|
* @internal
|
|
624
1028
|
*/
|
|
625
1029
|
export declare const CreateRoomResponseFilterSensitiveLog: (obj: CreateRoomResponse) => any;
|
|
1030
|
+
/**
|
|
1031
|
+
* @internal
|
|
1032
|
+
*/
|
|
1033
|
+
export declare const DeleteLoggingConfigurationRequestFilterSensitiveLog: (obj: DeleteLoggingConfigurationRequest) => any;
|
|
626
1034
|
/**
|
|
627
1035
|
* @internal
|
|
628
1036
|
*/
|
|
@@ -643,6 +1051,14 @@ export declare const DisconnectUserRequestFilterSensitiveLog: (obj: DisconnectUs
|
|
|
643
1051
|
* @internal
|
|
644
1052
|
*/
|
|
645
1053
|
export declare const DisconnectUserResponseFilterSensitiveLog: (obj: DisconnectUserResponse) => any;
|
|
1054
|
+
/**
|
|
1055
|
+
* @internal
|
|
1056
|
+
*/
|
|
1057
|
+
export declare const GetLoggingConfigurationRequestFilterSensitiveLog: (obj: GetLoggingConfigurationRequest) => any;
|
|
1058
|
+
/**
|
|
1059
|
+
* @internal
|
|
1060
|
+
*/
|
|
1061
|
+
export declare const GetLoggingConfigurationResponseFilterSensitiveLog: (obj: GetLoggingConfigurationResponse) => any;
|
|
646
1062
|
/**
|
|
647
1063
|
* @internal
|
|
648
1064
|
*/
|
|
@@ -651,6 +1067,18 @@ export declare const GetRoomRequestFilterSensitiveLog: (obj: GetRoomRequest) =>
|
|
|
651
1067
|
* @internal
|
|
652
1068
|
*/
|
|
653
1069
|
export declare const GetRoomResponseFilterSensitiveLog: (obj: GetRoomResponse) => any;
|
|
1070
|
+
/**
|
|
1071
|
+
* @internal
|
|
1072
|
+
*/
|
|
1073
|
+
export declare const ListLoggingConfigurationsRequestFilterSensitiveLog: (obj: ListLoggingConfigurationsRequest) => any;
|
|
1074
|
+
/**
|
|
1075
|
+
* @internal
|
|
1076
|
+
*/
|
|
1077
|
+
export declare const LoggingConfigurationSummaryFilterSensitiveLog: (obj: LoggingConfigurationSummary) => any;
|
|
1078
|
+
/**
|
|
1079
|
+
* @internal
|
|
1080
|
+
*/
|
|
1081
|
+
export declare const ListLoggingConfigurationsResponseFilterSensitiveLog: (obj: ListLoggingConfigurationsResponse) => any;
|
|
654
1082
|
/**
|
|
655
1083
|
* @internal
|
|
656
1084
|
*/
|
|
@@ -695,6 +1123,14 @@ export declare const UntagResourceRequestFilterSensitiveLog: (obj: UntagResource
|
|
|
695
1123
|
* @internal
|
|
696
1124
|
*/
|
|
697
1125
|
export declare const UntagResourceResponseFilterSensitiveLog: (obj: UntagResourceResponse) => any;
|
|
1126
|
+
/**
|
|
1127
|
+
* @internal
|
|
1128
|
+
*/
|
|
1129
|
+
export declare const UpdateLoggingConfigurationRequestFilterSensitiveLog: (obj: UpdateLoggingConfigurationRequest) => any;
|
|
1130
|
+
/**
|
|
1131
|
+
* @internal
|
|
1132
|
+
*/
|
|
1133
|
+
export declare const UpdateLoggingConfigurationResponseFilterSensitiveLog: (obj: UpdateLoggingConfigurationResponse) => any;
|
|
698
1134
|
/**
|
|
699
1135
|
* @internal
|
|
700
1136
|
*/
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import { Paginator } from "@aws-sdk/types";
|
|
2
|
+
import { ListLoggingConfigurationsCommandInput, ListLoggingConfigurationsCommandOutput } from "../commands/ListLoggingConfigurationsCommand";
|
|
3
|
+
import { IvschatPaginationConfiguration } from "./Interfaces";
|
|
4
|
+
export declare function paginateListLoggingConfigurations(config: IvschatPaginationConfiguration, input: ListLoggingConfigurationsCommandInput, ...additionalArguments: any): Paginator<ListLoggingConfigurationsCommandOutput>;
|