@aws-sdk/client-chime-sdk-messaging 3.379.1 → 3.385.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/models/models_0.d.ts +398 -0
- package/package.json +5 -5
|
@@ -31,14 +31,17 @@ export type ChannelMembershipType = (typeof ChannelMembershipType)[keyof typeof
|
|
|
31
31
|
*/
|
|
32
32
|
export interface AppInstanceUserMembershipSummary {
|
|
33
33
|
/**
|
|
34
|
+
* @public
|
|
34
35
|
* <p>The type of <code>ChannelMembership</code>.</p>
|
|
35
36
|
*/
|
|
36
37
|
Type?: ChannelMembershipType | string;
|
|
37
38
|
/**
|
|
39
|
+
* @public
|
|
38
40
|
* <p>The time at which an <code>AppInstanceUser</code> last marked a channel as read.</p>
|
|
39
41
|
*/
|
|
40
42
|
ReadMarkerTimestamp?: Date;
|
|
41
43
|
/**
|
|
44
|
+
* @public
|
|
42
45
|
* <p>The ID of the SubChannel that the <code>AppInstanceUser</code> is a member of.</p>
|
|
43
46
|
*/
|
|
44
47
|
SubChannelId?: string;
|
|
@@ -48,14 +51,17 @@ export interface AppInstanceUserMembershipSummary {
|
|
|
48
51
|
*/
|
|
49
52
|
export interface AssociateChannelFlowRequest {
|
|
50
53
|
/**
|
|
54
|
+
* @public
|
|
51
55
|
* <p>The ARN of the channel.</p>
|
|
52
56
|
*/
|
|
53
57
|
ChannelArn: string | undefined;
|
|
54
58
|
/**
|
|
59
|
+
* @public
|
|
55
60
|
* <p>The ARN of the channel flow.</p>
|
|
56
61
|
*/
|
|
57
62
|
ChannelFlowArn: string | undefined;
|
|
58
63
|
/**
|
|
64
|
+
* @public
|
|
59
65
|
* <p>The <code>AppInstanceUserArn</code> of the user making the API call.</p>
|
|
60
66
|
*/
|
|
61
67
|
ChimeBearer: string | undefined;
|
|
@@ -204,10 +210,12 @@ export declare class UnauthorizedClientException extends __BaseException {
|
|
|
204
210
|
*/
|
|
205
211
|
export interface Identity {
|
|
206
212
|
/**
|
|
213
|
+
* @public
|
|
207
214
|
* <p>The ARN in an Identity.</p>
|
|
208
215
|
*/
|
|
209
216
|
Arn?: string;
|
|
210
217
|
/**
|
|
218
|
+
* @public
|
|
211
219
|
* <p>The name in an Identity.</p>
|
|
212
220
|
*/
|
|
213
221
|
Name?: string;
|
|
@@ -219,22 +227,27 @@ export interface Identity {
|
|
|
219
227
|
*/
|
|
220
228
|
export interface BatchChannelMemberships {
|
|
221
229
|
/**
|
|
230
|
+
* @public
|
|
222
231
|
* <p>The identifier of the member who invited another member.</p>
|
|
223
232
|
*/
|
|
224
233
|
InvitedBy?: Identity;
|
|
225
234
|
/**
|
|
235
|
+
* @public
|
|
226
236
|
* <p>The membership types set for the channel members.</p>
|
|
227
237
|
*/
|
|
228
238
|
Type?: ChannelMembershipType | string;
|
|
229
239
|
/**
|
|
240
|
+
* @public
|
|
230
241
|
* <p>The users successfully added to the request.</p>
|
|
231
242
|
*/
|
|
232
243
|
Members?: Identity[];
|
|
233
244
|
/**
|
|
245
|
+
* @public
|
|
234
246
|
* <p>The ARN of the channel to which you're adding members.</p>
|
|
235
247
|
*/
|
|
236
248
|
ChannelArn?: string;
|
|
237
249
|
/**
|
|
250
|
+
* @public
|
|
238
251
|
* <p>The ID of the SubChannel.</p>
|
|
239
252
|
*/
|
|
240
253
|
SubChannelId?: string;
|
|
@@ -244,10 +257,12 @@ export interface BatchChannelMemberships {
|
|
|
244
257
|
*/
|
|
245
258
|
export interface BatchCreateChannelMembershipRequest {
|
|
246
259
|
/**
|
|
260
|
+
* @public
|
|
247
261
|
* <p>The ARN of the channel to which you're adding users or bots.</p>
|
|
248
262
|
*/
|
|
249
263
|
ChannelArn: string | undefined;
|
|
250
264
|
/**
|
|
265
|
+
* @public
|
|
251
266
|
* <p>The membership type of a user, <code>DEFAULT</code> or <code>HIDDEN</code>. Default
|
|
252
267
|
* members are always returned as part of <code>ListChannelMemberships</code>. Hidden members
|
|
253
268
|
* are only returned if the type filter in <code>ListChannelMemberships</code> equals
|
|
@@ -256,16 +271,19 @@ export interface BatchCreateChannelMembershipRequest {
|
|
|
256
271
|
*/
|
|
257
272
|
Type?: ChannelMembershipType | string;
|
|
258
273
|
/**
|
|
274
|
+
* @public
|
|
259
275
|
* <p>The ARNs of the members you want to add to the channel. Only <code>AppInstanceUsers</code> and
|
|
260
276
|
* <code>AppInstanceBots</code> can be added as a channel member.</p>
|
|
261
277
|
*/
|
|
262
278
|
MemberArns: string[] | undefined;
|
|
263
279
|
/**
|
|
280
|
+
* @public
|
|
264
281
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code>
|
|
265
282
|
* that makes the API call.</p>
|
|
266
283
|
*/
|
|
267
284
|
ChimeBearer: string | undefined;
|
|
268
285
|
/**
|
|
286
|
+
* @public
|
|
269
287
|
* <p>The ID of the SubChannel in the request. </p>
|
|
270
288
|
* <note>
|
|
271
289
|
* <p>Only required when creating membership in a SubChannel for a moderator in an elastic channel.</p>
|
|
@@ -279,14 +297,17 @@ export interface BatchCreateChannelMembershipRequest {
|
|
|
279
297
|
*/
|
|
280
298
|
export interface BatchCreateChannelMembershipError {
|
|
281
299
|
/**
|
|
300
|
+
* @public
|
|
282
301
|
* <p>The <code>AppInstanceUserArn</code> of the member that the service couldn't add.</p>
|
|
283
302
|
*/
|
|
284
303
|
MemberArn?: string;
|
|
285
304
|
/**
|
|
305
|
+
* @public
|
|
286
306
|
* <p>The error code.</p>
|
|
287
307
|
*/
|
|
288
308
|
ErrorCode?: ErrorCode | string;
|
|
289
309
|
/**
|
|
310
|
+
* @public
|
|
290
311
|
* <p>The error message.</p>
|
|
291
312
|
*/
|
|
292
313
|
ErrorMessage?: string;
|
|
@@ -296,10 +317,12 @@ export interface BatchCreateChannelMembershipError {
|
|
|
296
317
|
*/
|
|
297
318
|
export interface BatchCreateChannelMembershipResponse {
|
|
298
319
|
/**
|
|
320
|
+
* @public
|
|
299
321
|
* <p>The list of channel memberships in the response.</p>
|
|
300
322
|
*/
|
|
301
323
|
BatchChannelMemberships?: BatchChannelMemberships;
|
|
302
324
|
/**
|
|
325
|
+
* @public
|
|
303
326
|
* <p>If the action fails for one or more of the memberships in the request, a list of the
|
|
304
327
|
* memberships is returned, along with error codes and error messages.</p>
|
|
305
328
|
*/
|
|
@@ -325,14 +348,17 @@ export declare class ResourceLimitExceededException extends __BaseException {
|
|
|
325
348
|
*/
|
|
326
349
|
export interface ElasticChannelConfiguration {
|
|
327
350
|
/**
|
|
351
|
+
* @public
|
|
328
352
|
* <p>The maximum number of SubChannels that you want to allow in the elastic channel.</p>
|
|
329
353
|
*/
|
|
330
354
|
MaximumSubChannels: number | undefined;
|
|
331
355
|
/**
|
|
356
|
+
* @public
|
|
332
357
|
* <p>The maximum number of members allowed in a SubChannel.</p>
|
|
333
358
|
*/
|
|
334
359
|
TargetMembershipsPerSubChannel: number | undefined;
|
|
335
360
|
/**
|
|
361
|
+
* @public
|
|
336
362
|
* <p>The minimum allowed percentage of TargetMembershipsPerSubChannel users. Ceil of the calculated value is used in balancing members among SubChannels of the elastic channel.</p>
|
|
337
363
|
*/
|
|
338
364
|
MinimumMembershipPercentage: number | undefined;
|
|
@@ -355,10 +381,12 @@ export type ExpirationCriterion = (typeof ExpirationCriterion)[keyof typeof Expi
|
|
|
355
381
|
*/
|
|
356
382
|
export interface ExpirationSettings {
|
|
357
383
|
/**
|
|
384
|
+
* @public
|
|
358
385
|
* <p>The period in days after which the system automatically deletes a channel.</p>
|
|
359
386
|
*/
|
|
360
387
|
ExpirationDays: number | undefined;
|
|
361
388
|
/**
|
|
389
|
+
* @public
|
|
362
390
|
* <p>The conditions that must be met for a channel to expire.</p>
|
|
363
391
|
*/
|
|
364
392
|
ExpirationCriterion: ExpirationCriterion | string | undefined;
|
|
@@ -393,50 +421,62 @@ export type ChannelPrivacy = (typeof ChannelPrivacy)[keyof typeof ChannelPrivacy
|
|
|
393
421
|
*/
|
|
394
422
|
export interface Channel {
|
|
395
423
|
/**
|
|
424
|
+
* @public
|
|
396
425
|
* <p>The name of a channel.</p>
|
|
397
426
|
*/
|
|
398
427
|
Name?: string;
|
|
399
428
|
/**
|
|
429
|
+
* @public
|
|
400
430
|
* <p>The ARN of a channel.</p>
|
|
401
431
|
*/
|
|
402
432
|
ChannelArn?: string;
|
|
403
433
|
/**
|
|
434
|
+
* @public
|
|
404
435
|
* <p>The mode of the channel.</p>
|
|
405
436
|
*/
|
|
406
437
|
Mode?: ChannelMode | string;
|
|
407
438
|
/**
|
|
439
|
+
* @public
|
|
408
440
|
* <p>The channel's privacy setting.</p>
|
|
409
441
|
*/
|
|
410
442
|
Privacy?: ChannelPrivacy | string;
|
|
411
443
|
/**
|
|
444
|
+
* @public
|
|
412
445
|
* <p>The channel's metadata.</p>
|
|
413
446
|
*/
|
|
414
447
|
Metadata?: string;
|
|
415
448
|
/**
|
|
449
|
+
* @public
|
|
416
450
|
* <p>The <code>AppInstanceUser</code> who created the channel.</p>
|
|
417
451
|
*/
|
|
418
452
|
CreatedBy?: Identity;
|
|
419
453
|
/**
|
|
454
|
+
* @public
|
|
420
455
|
* <p>The time at which the <code>AppInstanceUser</code> created the channel.</p>
|
|
421
456
|
*/
|
|
422
457
|
CreatedTimestamp?: Date;
|
|
423
458
|
/**
|
|
459
|
+
* @public
|
|
424
460
|
* <p>The time at which a member sent the last message in the channel.</p>
|
|
425
461
|
*/
|
|
426
462
|
LastMessageTimestamp?: Date;
|
|
427
463
|
/**
|
|
464
|
+
* @public
|
|
428
465
|
* <p>The time at which a channel was last updated.</p>
|
|
429
466
|
*/
|
|
430
467
|
LastUpdatedTimestamp?: Date;
|
|
431
468
|
/**
|
|
469
|
+
* @public
|
|
432
470
|
* <p>The ARN of the channel flow.</p>
|
|
433
471
|
*/
|
|
434
472
|
ChannelFlowArn?: string;
|
|
435
473
|
/**
|
|
474
|
+
* @public
|
|
436
475
|
* <p>The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million members.</p>
|
|
437
476
|
*/
|
|
438
477
|
ElasticChannelConfiguration?: ElasticChannelConfiguration;
|
|
439
478
|
/**
|
|
479
|
+
* @public
|
|
440
480
|
* <p>Settings that control when a channel expires.</p>
|
|
441
481
|
*/
|
|
442
482
|
ExpirationSettings?: ExpirationSettings;
|
|
@@ -447,22 +487,27 @@ export interface Channel {
|
|
|
447
487
|
*/
|
|
448
488
|
export interface ChannelAssociatedWithFlowSummary {
|
|
449
489
|
/**
|
|
490
|
+
* @public
|
|
450
491
|
* <p>The name of the channel flow.</p>
|
|
451
492
|
*/
|
|
452
493
|
Name?: string;
|
|
453
494
|
/**
|
|
495
|
+
* @public
|
|
454
496
|
* <p>The ARN of the channel.</p>
|
|
455
497
|
*/
|
|
456
498
|
ChannelArn?: string;
|
|
457
499
|
/**
|
|
500
|
+
* @public
|
|
458
501
|
* <p>The mode of the channel.</p>
|
|
459
502
|
*/
|
|
460
503
|
Mode?: ChannelMode | string;
|
|
461
504
|
/**
|
|
505
|
+
* @public
|
|
462
506
|
* <p>The channel's privacy setting.</p>
|
|
463
507
|
*/
|
|
464
508
|
Privacy?: ChannelPrivacy | string;
|
|
465
509
|
/**
|
|
510
|
+
* @public
|
|
466
511
|
* <p>The channel's metadata.</p>
|
|
467
512
|
*/
|
|
468
513
|
Metadata?: string;
|
|
@@ -473,18 +518,22 @@ export interface ChannelAssociatedWithFlowSummary {
|
|
|
473
518
|
*/
|
|
474
519
|
export interface ChannelBan {
|
|
475
520
|
/**
|
|
521
|
+
* @public
|
|
476
522
|
* <p>The member being banned from the channel.</p>
|
|
477
523
|
*/
|
|
478
524
|
Member?: Identity;
|
|
479
525
|
/**
|
|
526
|
+
* @public
|
|
480
527
|
* <p>The ARN of the channel from which a member is being banned.</p>
|
|
481
528
|
*/
|
|
482
529
|
ChannelArn?: string;
|
|
483
530
|
/**
|
|
531
|
+
* @public
|
|
484
532
|
* <p>The time at which the ban was created.</p>
|
|
485
533
|
*/
|
|
486
534
|
CreatedTimestamp?: Date;
|
|
487
535
|
/**
|
|
536
|
+
* @public
|
|
488
537
|
* <p>The <code>AppInstanceUser</code> who created the ban.</p>
|
|
489
538
|
*/
|
|
490
539
|
CreatedBy?: Identity;
|
|
@@ -495,6 +544,7 @@ export interface ChannelBan {
|
|
|
495
544
|
*/
|
|
496
545
|
export interface ChannelBanSummary {
|
|
497
546
|
/**
|
|
547
|
+
* @public
|
|
498
548
|
* <p>The member being banned from a channel.</p>
|
|
499
549
|
*/
|
|
500
550
|
Member?: Identity;
|
|
@@ -516,10 +566,12 @@ export type InvocationType = (typeof InvocationType)[keyof typeof InvocationType
|
|
|
516
566
|
*/
|
|
517
567
|
export interface LambdaConfiguration {
|
|
518
568
|
/**
|
|
569
|
+
* @public
|
|
519
570
|
* <p>The ARN of the Lambda message processing function.</p>
|
|
520
571
|
*/
|
|
521
572
|
ResourceArn: string | undefined;
|
|
522
573
|
/**
|
|
574
|
+
* @public
|
|
523
575
|
* <p>Controls how the Lambda function is invoked.</p>
|
|
524
576
|
*/
|
|
525
577
|
InvocationType: InvocationType | string | undefined;
|
|
@@ -530,6 +582,7 @@ export interface LambdaConfiguration {
|
|
|
530
582
|
*/
|
|
531
583
|
export interface ProcessorConfiguration {
|
|
532
584
|
/**
|
|
585
|
+
* @public
|
|
533
586
|
* <p>Indicates that the processor is of type Lambda.</p>
|
|
534
587
|
*/
|
|
535
588
|
Lambda: LambdaConfiguration | undefined;
|
|
@@ -552,19 +605,23 @@ export type FallbackAction = (typeof FallbackAction)[keyof typeof FallbackAction
|
|
|
552
605
|
*/
|
|
553
606
|
export interface Processor {
|
|
554
607
|
/**
|
|
608
|
+
* @public
|
|
555
609
|
* <p>The name of the channel flow.</p>
|
|
556
610
|
*/
|
|
557
611
|
Name: string | undefined;
|
|
558
612
|
/**
|
|
613
|
+
* @public
|
|
559
614
|
* <p>The information about the type of processor and its identifier.</p>
|
|
560
615
|
*/
|
|
561
616
|
Configuration: ProcessorConfiguration | undefined;
|
|
562
617
|
/**
|
|
618
|
+
* @public
|
|
563
619
|
* <p>The sequence in which processors run. If you have multiple processors in a channel flow, message processing goes through each processor in the sequence. The value determines the sequence.
|
|
564
620
|
* At this point, we support only 1 processor within a flow.</p>
|
|
565
621
|
*/
|
|
566
622
|
ExecutionOrder: number | undefined;
|
|
567
623
|
/**
|
|
624
|
+
* @public
|
|
568
625
|
* <p>Determines whether to continue with message processing or stop it in cases where communication with a processor fails. If a processor has a fallback action of <code>ABORT</code> and
|
|
569
626
|
* communication with it fails, the processor sets the message status to <code>FAILED</code> and does not send the message to any recipients. Note that if the last processor in the channel flow sequence
|
|
570
627
|
* has a fallback action of <code>CONTINUE</code> and communication with the processor fails, then the message is considered processed and sent to recipients of the channel.</p>
|
|
@@ -577,22 +634,27 @@ export interface Processor {
|
|
|
577
634
|
*/
|
|
578
635
|
export interface ChannelFlow {
|
|
579
636
|
/**
|
|
637
|
+
* @public
|
|
580
638
|
* <p>The ARN of the channel flow.</p>
|
|
581
639
|
*/
|
|
582
640
|
ChannelFlowArn?: string;
|
|
583
641
|
/**
|
|
642
|
+
* @public
|
|
584
643
|
* <p>Information about the processor Lambda functions.</p>
|
|
585
644
|
*/
|
|
586
645
|
Processors?: Processor[];
|
|
587
646
|
/**
|
|
647
|
+
* @public
|
|
588
648
|
* <p>The name of the channel flow.</p>
|
|
589
649
|
*/
|
|
590
650
|
Name?: string;
|
|
591
651
|
/**
|
|
652
|
+
* @public
|
|
592
653
|
* <p>The time at which the channel flow was created.</p>
|
|
593
654
|
*/
|
|
594
655
|
CreatedTimestamp?: Date;
|
|
595
656
|
/**
|
|
657
|
+
* @public
|
|
596
658
|
* <p>The time at which a channel flow was updated.</p>
|
|
597
659
|
*/
|
|
598
660
|
LastUpdatedTimestamp?: Date;
|
|
@@ -603,6 +665,7 @@ export interface ChannelFlow {
|
|
|
603
665
|
*/
|
|
604
666
|
export interface MessageAttributeValue {
|
|
605
667
|
/**
|
|
668
|
+
* @public
|
|
606
669
|
* <p>The strings in a message attribute value.</p>
|
|
607
670
|
*/
|
|
608
671
|
StringValues?: string[];
|
|
@@ -625,14 +688,17 @@ export type PushNotificationType = (typeof PushNotificationType)[keyof typeof Pu
|
|
|
625
688
|
*/
|
|
626
689
|
export interface PushNotificationConfiguration {
|
|
627
690
|
/**
|
|
691
|
+
* @public
|
|
628
692
|
* <p>The title of the push notification.</p>
|
|
629
693
|
*/
|
|
630
694
|
Title?: string;
|
|
631
695
|
/**
|
|
696
|
+
* @public
|
|
632
697
|
* <p>The body of the push notification.</p>
|
|
633
698
|
*/
|
|
634
699
|
Body?: string;
|
|
635
700
|
/**
|
|
701
|
+
* @public
|
|
636
702
|
* <p>Enum value that indicates the type of the push notification for a message.
|
|
637
703
|
* <code>DEFAULT</code>: Normal mobile push notification.
|
|
638
704
|
* <code>VOIP</code>: VOIP mobile push notification.</p>
|
|
@@ -645,34 +711,41 @@ export interface PushNotificationConfiguration {
|
|
|
645
711
|
*/
|
|
646
712
|
export interface ChannelMessageCallback {
|
|
647
713
|
/**
|
|
714
|
+
* @public
|
|
648
715
|
* <p>The message ID.</p>
|
|
649
716
|
*/
|
|
650
717
|
MessageId: string | undefined;
|
|
651
718
|
/**
|
|
719
|
+
* @public
|
|
652
720
|
* <p>The message content. For Amazon Lex V2 bot responses, this field holds a list of messages originating from the bot. For more information, refer to
|
|
653
721
|
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html">Processing responses from an AppInstanceBot</a> in the
|
|
654
722
|
* <i>Amazon Chime SDK Messaging Developer Guide</i>.</p>
|
|
655
723
|
*/
|
|
656
724
|
Content?: string;
|
|
657
725
|
/**
|
|
726
|
+
* @public
|
|
658
727
|
* <p>The message metadata.</p>
|
|
659
728
|
*/
|
|
660
729
|
Metadata?: string;
|
|
661
730
|
/**
|
|
731
|
+
* @public
|
|
662
732
|
* <p>The push notification configuration of the message.</p>
|
|
663
733
|
*/
|
|
664
734
|
PushNotification?: PushNotificationConfiguration;
|
|
665
735
|
/**
|
|
736
|
+
* @public
|
|
666
737
|
* <p>The attributes for the channel message. For Amazon Lex V2 bot responses, the attributes are mapped to specific fields from the bot. For more information, refer to
|
|
667
738
|
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html">Processing responses from an AppInstanceBot</a> in the
|
|
668
739
|
* <i>Amazon Chime SDK Messaging Developer Guide</i>.</p>
|
|
669
740
|
*/
|
|
670
741
|
MessageAttributes?: Record<string, MessageAttributeValue>;
|
|
671
742
|
/**
|
|
743
|
+
* @public
|
|
672
744
|
* <p>The ID of the SubChannel.</p>
|
|
673
745
|
*/
|
|
674
746
|
SubChannelId?: string;
|
|
675
747
|
/**
|
|
748
|
+
* @public
|
|
676
749
|
* <p>The content type of the call-back message. For Amazon Lex V2 bot responses, the content type is <code>application/amz-chime-lex-msgs</code> for success responses and
|
|
677
750
|
* <code>application/amz-chime-lex-error</code> for failure responses. For more information, refer to
|
|
678
751
|
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html">Processing responses from an AppInstanceBot</a> in the
|
|
@@ -685,18 +758,22 @@ export interface ChannelMessageCallback {
|
|
|
685
758
|
*/
|
|
686
759
|
export interface ChannelFlowCallbackRequest {
|
|
687
760
|
/**
|
|
761
|
+
* @public
|
|
688
762
|
* <p>The identifier passed to the processor by the service when invoked. Use the identifier to call back the service.</p>
|
|
689
763
|
*/
|
|
690
764
|
CallbackId?: string;
|
|
691
765
|
/**
|
|
766
|
+
* @public
|
|
692
767
|
* <p>The ARN of the channel.</p>
|
|
693
768
|
*/
|
|
694
769
|
ChannelArn: string | undefined;
|
|
695
770
|
/**
|
|
771
|
+
* @public
|
|
696
772
|
* <p>When a processor determines that a message needs to be <code>DENIED</code>, pass this parameter with a value of true.</p>
|
|
697
773
|
*/
|
|
698
774
|
DeleteResource?: boolean;
|
|
699
775
|
/**
|
|
776
|
+
* @public
|
|
700
777
|
* <p>Stores information about the processed message.</p>
|
|
701
778
|
*/
|
|
702
779
|
ChannelMessage: ChannelMessageCallback | undefined;
|
|
@@ -706,10 +783,12 @@ export interface ChannelFlowCallbackRequest {
|
|
|
706
783
|
*/
|
|
707
784
|
export interface ChannelFlowCallbackResponse {
|
|
708
785
|
/**
|
|
786
|
+
* @public
|
|
709
787
|
* <p>The ARN of the channel.</p>
|
|
710
788
|
*/
|
|
711
789
|
ChannelArn?: string;
|
|
712
790
|
/**
|
|
791
|
+
* @public
|
|
713
792
|
* <p>The call back ID passed in the request.</p>
|
|
714
793
|
*/
|
|
715
794
|
CallbackId?: string;
|
|
@@ -720,14 +799,17 @@ export interface ChannelFlowCallbackResponse {
|
|
|
720
799
|
*/
|
|
721
800
|
export interface ChannelFlowSummary {
|
|
722
801
|
/**
|
|
802
|
+
* @public
|
|
723
803
|
* <p>The ARN of the channel flow.</p>
|
|
724
804
|
*/
|
|
725
805
|
ChannelFlowArn?: string;
|
|
726
806
|
/**
|
|
807
|
+
* @public
|
|
727
808
|
* <p>The name of the channel flow.</p>
|
|
728
809
|
*/
|
|
729
810
|
Name?: string;
|
|
730
811
|
/**
|
|
812
|
+
* @public
|
|
731
813
|
* <p>Information about the processor Lambda functions.</p>
|
|
732
814
|
*/
|
|
733
815
|
Processors?: Processor[];
|
|
@@ -738,30 +820,37 @@ export interface ChannelFlowSummary {
|
|
|
738
820
|
*/
|
|
739
821
|
export interface ChannelMembership {
|
|
740
822
|
/**
|
|
823
|
+
* @public
|
|
741
824
|
* <p>The identifier of the member who invited another member.</p>
|
|
742
825
|
*/
|
|
743
826
|
InvitedBy?: Identity;
|
|
744
827
|
/**
|
|
828
|
+
* @public
|
|
745
829
|
* <p>The membership type set for the channel member.</p>
|
|
746
830
|
*/
|
|
747
831
|
Type?: ChannelMembershipType | string;
|
|
748
832
|
/**
|
|
833
|
+
* @public
|
|
749
834
|
* <p>The data of the channel member.</p>
|
|
750
835
|
*/
|
|
751
836
|
Member?: Identity;
|
|
752
837
|
/**
|
|
838
|
+
* @public
|
|
753
839
|
* <p>The ARN of the member's channel.</p>
|
|
754
840
|
*/
|
|
755
841
|
ChannelArn?: string;
|
|
756
842
|
/**
|
|
843
|
+
* @public
|
|
757
844
|
* <p>The time at which the channel membership was created.</p>
|
|
758
845
|
*/
|
|
759
846
|
CreatedTimestamp?: Date;
|
|
760
847
|
/**
|
|
848
|
+
* @public
|
|
761
849
|
* <p>The time at which a channel membership was last updated.</p>
|
|
762
850
|
*/
|
|
763
851
|
LastUpdatedTimestamp?: Date;
|
|
764
852
|
/**
|
|
853
|
+
* @public
|
|
765
854
|
* <p>The ID of the SubChannel that a user belongs to.</p>
|
|
766
855
|
*/
|
|
767
856
|
SubChannelId?: string;
|
|
@@ -772,26 +861,32 @@ export interface ChannelMembership {
|
|
|
772
861
|
*/
|
|
773
862
|
export interface ChannelSummary {
|
|
774
863
|
/**
|
|
864
|
+
* @public
|
|
775
865
|
* <p>The name of the channel.</p>
|
|
776
866
|
*/
|
|
777
867
|
Name?: string;
|
|
778
868
|
/**
|
|
869
|
+
* @public
|
|
779
870
|
* <p>The ARN of the channel.</p>
|
|
780
871
|
*/
|
|
781
872
|
ChannelArn?: string;
|
|
782
873
|
/**
|
|
874
|
+
* @public
|
|
783
875
|
* <p>The mode of the channel.</p>
|
|
784
876
|
*/
|
|
785
877
|
Mode?: ChannelMode | string;
|
|
786
878
|
/**
|
|
879
|
+
* @public
|
|
787
880
|
* <p>The privacy setting of the channel.</p>
|
|
788
881
|
*/
|
|
789
882
|
Privacy?: ChannelPrivacy | string;
|
|
790
883
|
/**
|
|
884
|
+
* @public
|
|
791
885
|
* <p>The metadata of the channel.</p>
|
|
792
886
|
*/
|
|
793
887
|
Metadata?: string;
|
|
794
888
|
/**
|
|
889
|
+
* @public
|
|
795
890
|
* <p>The time at which the last persistent message visible to the caller in a channel was sent.</p>
|
|
796
891
|
*/
|
|
797
892
|
LastMessageTimestamp?: Date;
|
|
@@ -802,10 +897,12 @@ export interface ChannelSummary {
|
|
|
802
897
|
*/
|
|
803
898
|
export interface ChannelMembershipForAppInstanceUserSummary {
|
|
804
899
|
/**
|
|
900
|
+
* @public
|
|
805
901
|
* <p>Returns the channel data for an <code>AppInstance</code>.</p>
|
|
806
902
|
*/
|
|
807
903
|
ChannelSummary?: ChannelSummary;
|
|
808
904
|
/**
|
|
905
|
+
* @public
|
|
809
906
|
* <p>Returns the channel membership data for an <code>AppInstance</code>.</p>
|
|
810
907
|
*/
|
|
811
908
|
AppInstanceUserMembershipSummary?: AppInstanceUserMembershipSummary;
|
|
@@ -816,12 +913,14 @@ export interface ChannelMembershipForAppInstanceUserSummary {
|
|
|
816
913
|
*/
|
|
817
914
|
export interface PushNotificationPreferences {
|
|
818
915
|
/**
|
|
916
|
+
* @public
|
|
819
917
|
* <p>Enum value that indicates which push notifications to send to the requested member of a channel.
|
|
820
918
|
* <code>ALL</code> sends all push notifications, <code>NONE</code> sends no push notifications, <code>FILTERED</code> sends only filtered push notifications.
|
|
821
919
|
* </p>
|
|
822
920
|
*/
|
|
823
921
|
AllowNotifications: AllowNotifications | string | undefined;
|
|
824
922
|
/**
|
|
923
|
+
* @public
|
|
825
924
|
* <p>The simple JSON object used to send a subset of a push notification to the requested member.</p>
|
|
826
925
|
*/
|
|
827
926
|
FilterRule?: string;
|
|
@@ -832,6 +931,7 @@ export interface PushNotificationPreferences {
|
|
|
832
931
|
*/
|
|
833
932
|
export interface ChannelMembershipPreferences {
|
|
834
933
|
/**
|
|
934
|
+
* @public
|
|
835
935
|
* <p>The push notification configuration of a message.</p>
|
|
836
936
|
*/
|
|
837
937
|
PushNotifications?: PushNotificationPreferences;
|
|
@@ -842,6 +942,7 @@ export interface ChannelMembershipPreferences {
|
|
|
842
942
|
*/
|
|
843
943
|
export interface ChannelMembershipSummary {
|
|
844
944
|
/**
|
|
945
|
+
* @public
|
|
845
946
|
* <p>A member's summary data.</p>
|
|
846
947
|
*/
|
|
847
948
|
Member?: Identity;
|
|
@@ -878,10 +979,12 @@ export type ChannelMessageStatus = (typeof ChannelMessageStatus)[keyof typeof Ch
|
|
|
878
979
|
*/
|
|
879
980
|
export interface ChannelMessageStatusStructure {
|
|
880
981
|
/**
|
|
982
|
+
* @public
|
|
881
983
|
* <p>The message status value.</p>
|
|
882
984
|
*/
|
|
883
985
|
Value?: ChannelMessageStatus | string;
|
|
884
986
|
/**
|
|
987
|
+
* @public
|
|
885
988
|
* <p>Contains more details about the message status.</p>
|
|
886
989
|
*/
|
|
887
990
|
Detail?: string;
|
|
@@ -893,6 +996,7 @@ export interface ChannelMessageStatusStructure {
|
|
|
893
996
|
*/
|
|
894
997
|
export interface Target {
|
|
895
998
|
/**
|
|
999
|
+
* @public
|
|
896
1000
|
* <p>The ARN of the target channel member.</p>
|
|
897
1001
|
*/
|
|
898
1002
|
MemberArn?: string;
|
|
@@ -915,66 +1019,81 @@ export type ChannelMessageType = (typeof ChannelMessageType)[keyof typeof Channe
|
|
|
915
1019
|
*/
|
|
916
1020
|
export interface ChannelMessage {
|
|
917
1021
|
/**
|
|
1022
|
+
* @public
|
|
918
1023
|
* <p>The ARN of the channel.</p>
|
|
919
1024
|
*/
|
|
920
1025
|
ChannelArn?: string;
|
|
921
1026
|
/**
|
|
1027
|
+
* @public
|
|
922
1028
|
* <p>The ID of a message.</p>
|
|
923
1029
|
*/
|
|
924
1030
|
MessageId?: string;
|
|
925
1031
|
/**
|
|
1032
|
+
* @public
|
|
926
1033
|
* <p>The content of the channel message. For Amazon Lex V2 bot responses, this field holds a list of messages originating from the bot. For more information, refer to
|
|
927
1034
|
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html">Processing responses from an AppInstanceBot</a> in the
|
|
928
1035
|
* <i>Amazon Chime SDK Messaging Developer Guide</i>.</p>
|
|
929
1036
|
*/
|
|
930
1037
|
Content?: string;
|
|
931
1038
|
/**
|
|
1039
|
+
* @public
|
|
932
1040
|
* <p>The message metadata.</p>
|
|
933
1041
|
*/
|
|
934
1042
|
Metadata?: string;
|
|
935
1043
|
/**
|
|
1044
|
+
* @public
|
|
936
1045
|
* <p>The message type.</p>
|
|
937
1046
|
*/
|
|
938
1047
|
Type?: ChannelMessageType | string;
|
|
939
1048
|
/**
|
|
1049
|
+
* @public
|
|
940
1050
|
* <p>The time at which the message was created.</p>
|
|
941
1051
|
*/
|
|
942
1052
|
CreatedTimestamp?: Date;
|
|
943
1053
|
/**
|
|
1054
|
+
* @public
|
|
944
1055
|
* <p>The time at which a message was edited.</p>
|
|
945
1056
|
*/
|
|
946
1057
|
LastEditedTimestamp?: Date;
|
|
947
1058
|
/**
|
|
1059
|
+
* @public
|
|
948
1060
|
* <p>The time at which a message was updated.</p>
|
|
949
1061
|
*/
|
|
950
1062
|
LastUpdatedTimestamp?: Date;
|
|
951
1063
|
/**
|
|
1064
|
+
* @public
|
|
952
1065
|
* <p>The message sender.</p>
|
|
953
1066
|
*/
|
|
954
1067
|
Sender?: Identity;
|
|
955
1068
|
/**
|
|
1069
|
+
* @public
|
|
956
1070
|
* <p>Hides the content of a message.</p>
|
|
957
1071
|
*/
|
|
958
1072
|
Redacted?: boolean;
|
|
959
1073
|
/**
|
|
1074
|
+
* @public
|
|
960
1075
|
* <p>The persistence setting for a channel message.</p>
|
|
961
1076
|
*/
|
|
962
1077
|
Persistence?: ChannelMessagePersistenceType | string;
|
|
963
1078
|
/**
|
|
1079
|
+
* @public
|
|
964
1080
|
* <p>The status of the channel message.</p>
|
|
965
1081
|
*/
|
|
966
1082
|
Status?: ChannelMessageStatusStructure;
|
|
967
1083
|
/**
|
|
1084
|
+
* @public
|
|
968
1085
|
* <p>The attributes for the channel message. For Amazon Lex V2 bot responses, the attributes are mapped to specific fields from the bot. For more information, refer to
|
|
969
1086
|
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html">Processing responses from an AppInstanceBot</a> in the
|
|
970
1087
|
* <i>Amazon Chime SDK Messaging Developer Guide</i>.</p>
|
|
971
1088
|
*/
|
|
972
1089
|
MessageAttributes?: Record<string, MessageAttributeValue>;
|
|
973
1090
|
/**
|
|
1091
|
+
* @public
|
|
974
1092
|
* <p>The ID of the SubChannel.</p>
|
|
975
1093
|
*/
|
|
976
1094
|
SubChannelId?: string;
|
|
977
1095
|
/**
|
|
1096
|
+
* @public
|
|
978
1097
|
* <p>The content type of the channel message. For Amazon Lex V2 bot responses, the content type is <code>application/amz-chime-lex-msgs</code> for success responses and
|
|
979
1098
|
* <code>application/amz-chime-lex-error</code> for failure responses. For more information, refer to
|
|
980
1099
|
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html">Processing responses from an AppInstanceBot</a> in the
|
|
@@ -982,6 +1101,7 @@ export interface ChannelMessage {
|
|
|
982
1101
|
*/
|
|
983
1102
|
ContentType?: string;
|
|
984
1103
|
/**
|
|
1104
|
+
* @public
|
|
985
1105
|
* <p>The target of a message, a sender, a user, or a bot. Only the target and the sender can view targeted messages.
|
|
986
1106
|
* Only users who can see targeted messages can take actions on them. However, administrators can delete targeted messages that they can’t see.</p>
|
|
987
1107
|
*/
|
|
@@ -993,55 +1113,67 @@ export interface ChannelMessage {
|
|
|
993
1113
|
*/
|
|
994
1114
|
export interface ChannelMessageSummary {
|
|
995
1115
|
/**
|
|
1116
|
+
* @public
|
|
996
1117
|
* <p>The ID of the message.</p>
|
|
997
1118
|
*/
|
|
998
1119
|
MessageId?: string;
|
|
999
1120
|
/**
|
|
1121
|
+
* @public
|
|
1000
1122
|
* <p>The content of the channel message. For Amazon Lex V2 bot responses, this field holds a list of messages originating from the bot. For more information, refer to
|
|
1001
1123
|
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html">Processing responses from an AppInstanceBot</a> in the
|
|
1002
1124
|
* <i>Amazon Chime SDK Messaging Developer Guide</i>.</p>
|
|
1003
1125
|
*/
|
|
1004
1126
|
Content?: string;
|
|
1005
1127
|
/**
|
|
1128
|
+
* @public
|
|
1006
1129
|
* <p>The metadata of the message.</p>
|
|
1007
1130
|
*/
|
|
1008
1131
|
Metadata?: string;
|
|
1009
1132
|
/**
|
|
1133
|
+
* @public
|
|
1010
1134
|
* <p>The type of message.</p>
|
|
1011
1135
|
*/
|
|
1012
1136
|
Type?: ChannelMessageType | string;
|
|
1013
1137
|
/**
|
|
1138
|
+
* @public
|
|
1014
1139
|
* <p>The time at which the message summary was created.</p>
|
|
1015
1140
|
*/
|
|
1016
1141
|
CreatedTimestamp?: Date;
|
|
1017
1142
|
/**
|
|
1143
|
+
* @public
|
|
1018
1144
|
* <p>The time at which a message was last updated.</p>
|
|
1019
1145
|
*/
|
|
1020
1146
|
LastUpdatedTimestamp?: Date;
|
|
1021
1147
|
/**
|
|
1148
|
+
* @public
|
|
1022
1149
|
* <p>The time at which a message was last edited.</p>
|
|
1023
1150
|
*/
|
|
1024
1151
|
LastEditedTimestamp?: Date;
|
|
1025
1152
|
/**
|
|
1153
|
+
* @public
|
|
1026
1154
|
* <p>The message sender.</p>
|
|
1027
1155
|
*/
|
|
1028
1156
|
Sender?: Identity;
|
|
1029
1157
|
/**
|
|
1158
|
+
* @public
|
|
1030
1159
|
* <p>Indicates whether a message was redacted.</p>
|
|
1031
1160
|
*/
|
|
1032
1161
|
Redacted?: boolean;
|
|
1033
1162
|
/**
|
|
1163
|
+
* @public
|
|
1034
1164
|
* <p>The message status. The status value is <code>SENT</code> for messages sent to a channel without a channel flow. For channels associated with channel flow, the value determines the
|
|
1035
1165
|
* processing stage.</p>
|
|
1036
1166
|
*/
|
|
1037
1167
|
Status?: ChannelMessageStatusStructure;
|
|
1038
1168
|
/**
|
|
1169
|
+
* @public
|
|
1039
1170
|
* <p>The attributes for the channel message. For Amazon Lex V2 bot responses, the attributes are mapped to specific fields from the bot. For more information, refer to
|
|
1040
1171
|
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html">Processing responses from an AppInstanceBot</a> in the
|
|
1041
1172
|
* <i>Amazon Chime SDK Messaging Developer Guide</i>.</p>
|
|
1042
1173
|
*/
|
|
1043
1174
|
MessageAttributes?: Record<string, MessageAttributeValue>;
|
|
1044
1175
|
/**
|
|
1176
|
+
* @public
|
|
1045
1177
|
* <p>The content type of the channel message listed in the summary. For Amazon Lex V2 bot responses, the content type is <code>application/amz-chime-lex-msgs</code> for success responses and
|
|
1046
1178
|
* <code>application/amz-chime-lex-error</code> for failure responses. For more information, refer to
|
|
1047
1179
|
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html">Processing responses from an AppInstanceBot</a> in the
|
|
@@ -1049,6 +1181,7 @@ export interface ChannelMessageSummary {
|
|
|
1049
1181
|
*/
|
|
1050
1182
|
ContentType?: string;
|
|
1051
1183
|
/**
|
|
1184
|
+
* @public
|
|
1052
1185
|
* <p>The target of a message, a sender, a user, or a bot. Only the target and the sender can view targeted messages.
|
|
1053
1186
|
* Only users who can see targeted messages can take actions on them. However, administrators can delete targeted messages that they can’t see.</p>
|
|
1054
1187
|
*/
|
|
@@ -1060,6 +1193,7 @@ export interface ChannelMessageSummary {
|
|
|
1060
1193
|
*/
|
|
1061
1194
|
export interface ChannelModeratedByAppInstanceUserSummary {
|
|
1062
1195
|
/**
|
|
1196
|
+
* @public
|
|
1063
1197
|
* <p>Summary of the details of a <code>Channel</code>.</p>
|
|
1064
1198
|
*/
|
|
1065
1199
|
ChannelSummary?: ChannelSummary;
|
|
@@ -1070,18 +1204,22 @@ export interface ChannelModeratedByAppInstanceUserSummary {
|
|
|
1070
1204
|
*/
|
|
1071
1205
|
export interface ChannelModerator {
|
|
1072
1206
|
/**
|
|
1207
|
+
* @public
|
|
1073
1208
|
* <p>The moderator's data.</p>
|
|
1074
1209
|
*/
|
|
1075
1210
|
Moderator?: Identity;
|
|
1076
1211
|
/**
|
|
1212
|
+
* @public
|
|
1077
1213
|
* <p>The ARN of the moderator's channel.</p>
|
|
1078
1214
|
*/
|
|
1079
1215
|
ChannelArn?: string;
|
|
1080
1216
|
/**
|
|
1217
|
+
* @public
|
|
1081
1218
|
* <p>The time at which the moderator was created.</p>
|
|
1082
1219
|
*/
|
|
1083
1220
|
CreatedTimestamp?: Date;
|
|
1084
1221
|
/**
|
|
1222
|
+
* @public
|
|
1085
1223
|
* <p>The <code>AppInstanceUser</code> who created the moderator.</p>
|
|
1086
1224
|
*/
|
|
1087
1225
|
CreatedBy?: Identity;
|
|
@@ -1092,6 +1230,7 @@ export interface ChannelModerator {
|
|
|
1092
1230
|
*/
|
|
1093
1231
|
export interface ChannelModeratorSummary {
|
|
1094
1232
|
/**
|
|
1233
|
+
* @public
|
|
1095
1234
|
* <p>The data for a moderator.</p>
|
|
1096
1235
|
*/
|
|
1097
1236
|
Moderator?: Identity;
|
|
@@ -1102,10 +1241,12 @@ export interface ChannelModeratorSummary {
|
|
|
1102
1241
|
*/
|
|
1103
1242
|
export interface Tag {
|
|
1104
1243
|
/**
|
|
1244
|
+
* @public
|
|
1105
1245
|
* <p>The key in a tag.</p>
|
|
1106
1246
|
*/
|
|
1107
1247
|
Key: string | undefined;
|
|
1108
1248
|
/**
|
|
1249
|
+
* @public
|
|
1109
1250
|
* <p>The value in a tag.</p>
|
|
1110
1251
|
*/
|
|
1111
1252
|
Value: string | undefined;
|
|
@@ -1115,58 +1256,71 @@ export interface Tag {
|
|
|
1115
1256
|
*/
|
|
1116
1257
|
export interface CreateChannelRequest {
|
|
1117
1258
|
/**
|
|
1259
|
+
* @public
|
|
1118
1260
|
* <p>The ARN of the channel request.</p>
|
|
1119
1261
|
*/
|
|
1120
1262
|
AppInstanceArn: string | undefined;
|
|
1121
1263
|
/**
|
|
1264
|
+
* @public
|
|
1122
1265
|
* <p>The name of the channel.</p>
|
|
1123
1266
|
*/
|
|
1124
1267
|
Name: string | undefined;
|
|
1125
1268
|
/**
|
|
1269
|
+
* @public
|
|
1126
1270
|
* <p>The channel mode: <code>UNRESTRICTED</code> or <code>RESTRICTED</code>. Administrators,
|
|
1127
1271
|
* moderators, and channel members can add themselves and other members to unrestricted
|
|
1128
1272
|
* channels. Only administrators and moderators can add members to restricted channels.</p>
|
|
1129
1273
|
*/
|
|
1130
1274
|
Mode?: ChannelMode | string;
|
|
1131
1275
|
/**
|
|
1276
|
+
* @public
|
|
1132
1277
|
* <p>The channel's privacy level: <code>PUBLIC</code> or <code>PRIVATE</code>. Private
|
|
1133
1278
|
* channels aren't discoverable by users outside the channel. Public channels are discoverable
|
|
1134
1279
|
* by anyone in the <code>AppInstance</code>.</p>
|
|
1135
1280
|
*/
|
|
1136
1281
|
Privacy?: ChannelPrivacy | string;
|
|
1137
1282
|
/**
|
|
1283
|
+
* @public
|
|
1138
1284
|
* <p>The metadata of the creation request. Limited to 1KB and UTF-8.</p>
|
|
1139
1285
|
*/
|
|
1140
1286
|
Metadata?: string;
|
|
1141
1287
|
/**
|
|
1288
|
+
* @public
|
|
1142
1289
|
* <p>The client token for the request. An <code>Idempotency</code> token.</p>
|
|
1143
1290
|
*/
|
|
1144
1291
|
ClientRequestToken?: string;
|
|
1145
1292
|
/**
|
|
1293
|
+
* @public
|
|
1146
1294
|
* <p>The tags for the creation request.</p>
|
|
1147
1295
|
*/
|
|
1148
1296
|
Tags?: Tag[];
|
|
1149
1297
|
/**
|
|
1298
|
+
* @public
|
|
1150
1299
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call.</p>
|
|
1151
1300
|
*/
|
|
1152
1301
|
ChimeBearer: string | undefined;
|
|
1153
1302
|
/**
|
|
1303
|
+
* @public
|
|
1154
1304
|
* <p>The ID of the channel in the request.</p>
|
|
1155
1305
|
*/
|
|
1156
1306
|
ChannelId?: string;
|
|
1157
1307
|
/**
|
|
1308
|
+
* @public
|
|
1158
1309
|
* <p>The ARNs of the channel members in the request.</p>
|
|
1159
1310
|
*/
|
|
1160
1311
|
MemberArns?: string[];
|
|
1161
1312
|
/**
|
|
1313
|
+
* @public
|
|
1162
1314
|
* <p>The ARNs of the channel moderators in the request.</p>
|
|
1163
1315
|
*/
|
|
1164
1316
|
ModeratorArns?: string[];
|
|
1165
1317
|
/**
|
|
1318
|
+
* @public
|
|
1166
1319
|
* <p>The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million users, excluding moderators.</p>
|
|
1167
1320
|
*/
|
|
1168
1321
|
ElasticChannelConfiguration?: ElasticChannelConfiguration;
|
|
1169
1322
|
/**
|
|
1323
|
+
* @public
|
|
1170
1324
|
* <p>Settings that control the interval after which the channel is automatically deleted.</p>
|
|
1171
1325
|
*/
|
|
1172
1326
|
ExpirationSettings?: ExpirationSettings;
|
|
@@ -1176,6 +1330,7 @@ export interface CreateChannelRequest {
|
|
|
1176
1330
|
*/
|
|
1177
1331
|
export interface CreateChannelResponse {
|
|
1178
1332
|
/**
|
|
1333
|
+
* @public
|
|
1179
1334
|
* <p>The ARN of the channel.</p>
|
|
1180
1335
|
*/
|
|
1181
1336
|
ChannelArn?: string;
|
|
@@ -1185,14 +1340,17 @@ export interface CreateChannelResponse {
|
|
|
1185
1340
|
*/
|
|
1186
1341
|
export interface CreateChannelBanRequest {
|
|
1187
1342
|
/**
|
|
1343
|
+
* @public
|
|
1188
1344
|
* <p>The ARN of the ban request.</p>
|
|
1189
1345
|
*/
|
|
1190
1346
|
ChannelArn: string | undefined;
|
|
1191
1347
|
/**
|
|
1348
|
+
* @public
|
|
1192
1349
|
* <p>The <code>AppInstanceUserArn</code> of the member being banned.</p>
|
|
1193
1350
|
*/
|
|
1194
1351
|
MemberArn: string | undefined;
|
|
1195
1352
|
/**
|
|
1353
|
+
* @public
|
|
1196
1354
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call.</p>
|
|
1197
1355
|
*/
|
|
1198
1356
|
ChimeBearer: string | undefined;
|
|
@@ -1202,10 +1360,12 @@ export interface CreateChannelBanRequest {
|
|
|
1202
1360
|
*/
|
|
1203
1361
|
export interface CreateChannelBanResponse {
|
|
1204
1362
|
/**
|
|
1363
|
+
* @public
|
|
1205
1364
|
* <p>The ARN of the response to the ban request.</p>
|
|
1206
1365
|
*/
|
|
1207
1366
|
ChannelArn?: string;
|
|
1208
1367
|
/**
|
|
1368
|
+
* @public
|
|
1209
1369
|
* <p>The <code>ChannelArn</code> and <code>BannedIdentity</code> of the member in the ban
|
|
1210
1370
|
* response.</p>
|
|
1211
1371
|
*/
|
|
@@ -1216,22 +1376,27 @@ export interface CreateChannelBanResponse {
|
|
|
1216
1376
|
*/
|
|
1217
1377
|
export interface CreateChannelFlowRequest {
|
|
1218
1378
|
/**
|
|
1379
|
+
* @public
|
|
1219
1380
|
* <p>The ARN of the channel flow request.</p>
|
|
1220
1381
|
*/
|
|
1221
1382
|
AppInstanceArn: string | undefined;
|
|
1222
1383
|
/**
|
|
1384
|
+
* @public
|
|
1223
1385
|
* <p>Information about the processor Lambda functions.</p>
|
|
1224
1386
|
*/
|
|
1225
1387
|
Processors: Processor[] | undefined;
|
|
1226
1388
|
/**
|
|
1389
|
+
* @public
|
|
1227
1390
|
* <p>The name of the channel flow.</p>
|
|
1228
1391
|
*/
|
|
1229
1392
|
Name: string | undefined;
|
|
1230
1393
|
/**
|
|
1394
|
+
* @public
|
|
1231
1395
|
* <p>The tags for the creation request.</p>
|
|
1232
1396
|
*/
|
|
1233
1397
|
Tags?: Tag[];
|
|
1234
1398
|
/**
|
|
1399
|
+
* @public
|
|
1235
1400
|
* <p>The client token for the request. An Idempotency token.</p>
|
|
1236
1401
|
*/
|
|
1237
1402
|
ClientRequestToken?: string;
|
|
@@ -1241,6 +1406,7 @@ export interface CreateChannelFlowRequest {
|
|
|
1241
1406
|
*/
|
|
1242
1407
|
export interface CreateChannelFlowResponse {
|
|
1243
1408
|
/**
|
|
1409
|
+
* @public
|
|
1244
1410
|
* <p>The ARN of the channel flow.</p>
|
|
1245
1411
|
*/
|
|
1246
1412
|
ChannelFlowArn?: string;
|
|
@@ -1250,14 +1416,17 @@ export interface CreateChannelFlowResponse {
|
|
|
1250
1416
|
*/
|
|
1251
1417
|
export interface CreateChannelMembershipRequest {
|
|
1252
1418
|
/**
|
|
1419
|
+
* @public
|
|
1253
1420
|
* <p>The ARN of the channel to which you're adding users.</p>
|
|
1254
1421
|
*/
|
|
1255
1422
|
ChannelArn: string | undefined;
|
|
1256
1423
|
/**
|
|
1424
|
+
* @public
|
|
1257
1425
|
* <p>The <code>AppInstanceUserArn</code> of the member you want to add to the channel.</p>
|
|
1258
1426
|
*/
|
|
1259
1427
|
MemberArn: string | undefined;
|
|
1260
1428
|
/**
|
|
1429
|
+
* @public
|
|
1261
1430
|
* <p>The membership type of a user, <code>DEFAULT</code> or <code>HIDDEN</code>. Default
|
|
1262
1431
|
* members are always returned as part of <code>ListChannelMemberships</code>. Hidden members
|
|
1263
1432
|
* are only returned if the type filter in <code>ListChannelMemberships</code> equals
|
|
@@ -1266,11 +1435,13 @@ export interface CreateChannelMembershipRequest {
|
|
|
1266
1435
|
*/
|
|
1267
1436
|
Type: ChannelMembershipType | string | undefined;
|
|
1268
1437
|
/**
|
|
1438
|
+
* @public
|
|
1269
1439
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code>
|
|
1270
1440
|
* that makes the API call.</p>
|
|
1271
1441
|
*/
|
|
1272
1442
|
ChimeBearer: string | undefined;
|
|
1273
1443
|
/**
|
|
1444
|
+
* @public
|
|
1274
1445
|
* <p>The ID of the SubChannel in the request.</p>
|
|
1275
1446
|
* <note>
|
|
1276
1447
|
* <p>Only required when creating membership in a SubChannel for a moderator in an elastic channel.</p>
|
|
@@ -1283,14 +1454,17 @@ export interface CreateChannelMembershipRequest {
|
|
|
1283
1454
|
*/
|
|
1284
1455
|
export interface CreateChannelMembershipResponse {
|
|
1285
1456
|
/**
|
|
1457
|
+
* @public
|
|
1286
1458
|
* <p>The ARN of the channel.</p>
|
|
1287
1459
|
*/
|
|
1288
1460
|
ChannelArn?: string;
|
|
1289
1461
|
/**
|
|
1462
|
+
* @public
|
|
1290
1463
|
* <p>The ARN and metadata of the member being added.</p>
|
|
1291
1464
|
*/
|
|
1292
1465
|
Member?: Identity;
|
|
1293
1466
|
/**
|
|
1467
|
+
* @public
|
|
1294
1468
|
* <p>The ID of the SubChannel in the response.</p>
|
|
1295
1469
|
*/
|
|
1296
1470
|
SubChannelId?: string;
|
|
@@ -1300,14 +1474,17 @@ export interface CreateChannelMembershipResponse {
|
|
|
1300
1474
|
*/
|
|
1301
1475
|
export interface CreateChannelModeratorRequest {
|
|
1302
1476
|
/**
|
|
1477
|
+
* @public
|
|
1303
1478
|
* <p>The ARN of the channel.</p>
|
|
1304
1479
|
*/
|
|
1305
1480
|
ChannelArn: string | undefined;
|
|
1306
1481
|
/**
|
|
1482
|
+
* @public
|
|
1307
1483
|
* <p>The <code>AppInstanceUserArn</code> of the moderator.</p>
|
|
1308
1484
|
*/
|
|
1309
1485
|
ChannelModeratorArn: string | undefined;
|
|
1310
1486
|
/**
|
|
1487
|
+
* @public
|
|
1311
1488
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code>
|
|
1312
1489
|
* that makes the API call.</p>
|
|
1313
1490
|
*/
|
|
@@ -1318,10 +1495,12 @@ export interface CreateChannelModeratorRequest {
|
|
|
1318
1495
|
*/
|
|
1319
1496
|
export interface CreateChannelModeratorResponse {
|
|
1320
1497
|
/**
|
|
1498
|
+
* @public
|
|
1321
1499
|
* <p>The ARN of the channel.</p>
|
|
1322
1500
|
*/
|
|
1323
1501
|
ChannelArn?: string;
|
|
1324
1502
|
/**
|
|
1503
|
+
* @public
|
|
1325
1504
|
* <p>The ARNs of the channel and the moderator.</p>
|
|
1326
1505
|
*/
|
|
1327
1506
|
ChannelModerator?: Identity;
|
|
@@ -1331,10 +1510,12 @@ export interface CreateChannelModeratorResponse {
|
|
|
1331
1510
|
*/
|
|
1332
1511
|
export interface DeleteChannelRequest {
|
|
1333
1512
|
/**
|
|
1513
|
+
* @public
|
|
1334
1514
|
* <p>The ARN of the channel being deleted.</p>
|
|
1335
1515
|
*/
|
|
1336
1516
|
ChannelArn: string | undefined;
|
|
1337
1517
|
/**
|
|
1518
|
+
* @public
|
|
1338
1519
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code>
|
|
1339
1520
|
* that makes the API call.</p>
|
|
1340
1521
|
*/
|
|
@@ -1345,14 +1526,17 @@ export interface DeleteChannelRequest {
|
|
|
1345
1526
|
*/
|
|
1346
1527
|
export interface DeleteChannelBanRequest {
|
|
1347
1528
|
/**
|
|
1529
|
+
* @public
|
|
1348
1530
|
* <p>The ARN of the channel from which the <code>AppInstanceUser</code> was banned.</p>
|
|
1349
1531
|
*/
|
|
1350
1532
|
ChannelArn: string | undefined;
|
|
1351
1533
|
/**
|
|
1534
|
+
* @public
|
|
1352
1535
|
* <p>The ARN of the <code>AppInstanceUser</code> that you want to reinstate.</p>
|
|
1353
1536
|
*/
|
|
1354
1537
|
MemberArn: string | undefined;
|
|
1355
1538
|
/**
|
|
1539
|
+
* @public
|
|
1356
1540
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the
|
|
1357
1541
|
* API call.</p>
|
|
1358
1542
|
*/
|
|
@@ -1363,6 +1547,7 @@ export interface DeleteChannelBanRequest {
|
|
|
1363
1547
|
*/
|
|
1364
1548
|
export interface DeleteChannelFlowRequest {
|
|
1365
1549
|
/**
|
|
1550
|
+
* @public
|
|
1366
1551
|
* <p>The ARN of the channel flow.</p>
|
|
1367
1552
|
*/
|
|
1368
1553
|
ChannelFlowArn: string | undefined;
|
|
@@ -1372,19 +1557,23 @@ export interface DeleteChannelFlowRequest {
|
|
|
1372
1557
|
*/
|
|
1373
1558
|
export interface DeleteChannelMembershipRequest {
|
|
1374
1559
|
/**
|
|
1560
|
+
* @public
|
|
1375
1561
|
* <p>The ARN of the channel from which you want to remove the user.</p>
|
|
1376
1562
|
*/
|
|
1377
1563
|
ChannelArn: string | undefined;
|
|
1378
1564
|
/**
|
|
1565
|
+
* @public
|
|
1379
1566
|
* <p>The <code>AppInstanceUserArn</code> of the member that you're removing from the channel.</p>
|
|
1380
1567
|
*/
|
|
1381
1568
|
MemberArn: string | undefined;
|
|
1382
1569
|
/**
|
|
1570
|
+
* @public
|
|
1383
1571
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the
|
|
1384
1572
|
* API call.</p>
|
|
1385
1573
|
*/
|
|
1386
1574
|
ChimeBearer: string | undefined;
|
|
1387
1575
|
/**
|
|
1576
|
+
* @public
|
|
1388
1577
|
* <p>The ID of the SubChannel in the request.</p>
|
|
1389
1578
|
* <note>
|
|
1390
1579
|
* <p>Only for use by moderators.</p>
|
|
@@ -1397,19 +1586,23 @@ export interface DeleteChannelMembershipRequest {
|
|
|
1397
1586
|
*/
|
|
1398
1587
|
export interface DeleteChannelMessageRequest {
|
|
1399
1588
|
/**
|
|
1589
|
+
* @public
|
|
1400
1590
|
* <p>The ARN of the channel.</p>
|
|
1401
1591
|
*/
|
|
1402
1592
|
ChannelArn: string | undefined;
|
|
1403
1593
|
/**
|
|
1594
|
+
* @public
|
|
1404
1595
|
* <p>The ID of the message being deleted.</p>
|
|
1405
1596
|
*/
|
|
1406
1597
|
MessageId: string | undefined;
|
|
1407
1598
|
/**
|
|
1599
|
+
* @public
|
|
1408
1600
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the
|
|
1409
1601
|
* API call.</p>
|
|
1410
1602
|
*/
|
|
1411
1603
|
ChimeBearer: string | undefined;
|
|
1412
1604
|
/**
|
|
1605
|
+
* @public
|
|
1413
1606
|
* <p>The ID of the SubChannel in the request.</p>
|
|
1414
1607
|
* <note>
|
|
1415
1608
|
* <p>Only required when deleting messages in a SubChannel that the user belongs to.</p>
|
|
@@ -1422,14 +1615,17 @@ export interface DeleteChannelMessageRequest {
|
|
|
1422
1615
|
*/
|
|
1423
1616
|
export interface DeleteChannelModeratorRequest {
|
|
1424
1617
|
/**
|
|
1618
|
+
* @public
|
|
1425
1619
|
* <p>The ARN of the channel.</p>
|
|
1426
1620
|
*/
|
|
1427
1621
|
ChannelArn: string | undefined;
|
|
1428
1622
|
/**
|
|
1623
|
+
* @public
|
|
1429
1624
|
* <p>The <code>AppInstanceUserArn</code> of the moderator being deleted.</p>
|
|
1430
1625
|
*/
|
|
1431
1626
|
ChannelModeratorArn: string | undefined;
|
|
1432
1627
|
/**
|
|
1628
|
+
* @public
|
|
1433
1629
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the
|
|
1434
1630
|
* API call.</p>
|
|
1435
1631
|
*/
|
|
@@ -1440,6 +1636,7 @@ export interface DeleteChannelModeratorRequest {
|
|
|
1440
1636
|
*/
|
|
1441
1637
|
export interface DeleteMessagingStreamingConfigurationsRequest {
|
|
1442
1638
|
/**
|
|
1639
|
+
* @public
|
|
1443
1640
|
* <p>The ARN of the streaming configurations being deleted.</p>
|
|
1444
1641
|
*/
|
|
1445
1642
|
AppInstanceArn: string | undefined;
|
|
@@ -1449,10 +1646,12 @@ export interface DeleteMessagingStreamingConfigurationsRequest {
|
|
|
1449
1646
|
*/
|
|
1450
1647
|
export interface DescribeChannelRequest {
|
|
1451
1648
|
/**
|
|
1649
|
+
* @public
|
|
1452
1650
|
* <p>The ARN of the channel.</p>
|
|
1453
1651
|
*/
|
|
1454
1652
|
ChannelArn: string | undefined;
|
|
1455
1653
|
/**
|
|
1654
|
+
* @public
|
|
1456
1655
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the
|
|
1457
1656
|
* API call.</p>
|
|
1458
1657
|
*/
|
|
@@ -1463,6 +1662,7 @@ export interface DescribeChannelRequest {
|
|
|
1463
1662
|
*/
|
|
1464
1663
|
export interface DescribeChannelResponse {
|
|
1465
1664
|
/**
|
|
1665
|
+
* @public
|
|
1466
1666
|
* <p>The channel details.</p>
|
|
1467
1667
|
*/
|
|
1468
1668
|
Channel?: Channel;
|
|
@@ -1472,14 +1672,17 @@ export interface DescribeChannelResponse {
|
|
|
1472
1672
|
*/
|
|
1473
1673
|
export interface DescribeChannelBanRequest {
|
|
1474
1674
|
/**
|
|
1675
|
+
* @public
|
|
1475
1676
|
* <p>The ARN of the channel from which the user is banned.</p>
|
|
1476
1677
|
*/
|
|
1477
1678
|
ChannelArn: string | undefined;
|
|
1478
1679
|
/**
|
|
1680
|
+
* @public
|
|
1479
1681
|
* <p>The <code>AppInstanceUserArn</code> of the member being banned.</p>
|
|
1480
1682
|
*/
|
|
1481
1683
|
MemberArn: string | undefined;
|
|
1482
1684
|
/**
|
|
1685
|
+
* @public
|
|
1483
1686
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the
|
|
1484
1687
|
* API call.</p>
|
|
1485
1688
|
*/
|
|
@@ -1490,6 +1693,7 @@ export interface DescribeChannelBanRequest {
|
|
|
1490
1693
|
*/
|
|
1491
1694
|
export interface DescribeChannelBanResponse {
|
|
1492
1695
|
/**
|
|
1696
|
+
* @public
|
|
1493
1697
|
* <p>The details of the ban.</p>
|
|
1494
1698
|
*/
|
|
1495
1699
|
ChannelBan?: ChannelBan;
|
|
@@ -1499,6 +1703,7 @@ export interface DescribeChannelBanResponse {
|
|
|
1499
1703
|
*/
|
|
1500
1704
|
export interface DescribeChannelFlowRequest {
|
|
1501
1705
|
/**
|
|
1706
|
+
* @public
|
|
1502
1707
|
* <p>The ARN of the channel flow.</p>
|
|
1503
1708
|
*/
|
|
1504
1709
|
ChannelFlowArn: string | undefined;
|
|
@@ -1508,6 +1713,7 @@ export interface DescribeChannelFlowRequest {
|
|
|
1508
1713
|
*/
|
|
1509
1714
|
export interface DescribeChannelFlowResponse {
|
|
1510
1715
|
/**
|
|
1716
|
+
* @public
|
|
1511
1717
|
* <p>The channel flow details.</p>
|
|
1512
1718
|
*/
|
|
1513
1719
|
ChannelFlow?: ChannelFlow;
|
|
@@ -1517,19 +1723,23 @@ export interface DescribeChannelFlowResponse {
|
|
|
1517
1723
|
*/
|
|
1518
1724
|
export interface DescribeChannelMembershipRequest {
|
|
1519
1725
|
/**
|
|
1726
|
+
* @public
|
|
1520
1727
|
* <p>The ARN of the channel.</p>
|
|
1521
1728
|
*/
|
|
1522
1729
|
ChannelArn: string | undefined;
|
|
1523
1730
|
/**
|
|
1731
|
+
* @public
|
|
1524
1732
|
* <p>The <code>AppInstanceUserArn</code> of the member.</p>
|
|
1525
1733
|
*/
|
|
1526
1734
|
MemberArn: string | undefined;
|
|
1527
1735
|
/**
|
|
1736
|
+
* @public
|
|
1528
1737
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the
|
|
1529
1738
|
* API call.</p>
|
|
1530
1739
|
*/
|
|
1531
1740
|
ChimeBearer: string | undefined;
|
|
1532
1741
|
/**
|
|
1742
|
+
* @public
|
|
1533
1743
|
* <p>The ID of the SubChannel in the request. The response contains an <code>ElasticChannelConfiguration</code> object.</p>
|
|
1534
1744
|
* <note>
|
|
1535
1745
|
* <p>Only required to get a user’s SubChannel membership details.</p>
|
|
@@ -1542,6 +1752,7 @@ export interface DescribeChannelMembershipRequest {
|
|
|
1542
1752
|
*/
|
|
1543
1753
|
export interface DescribeChannelMembershipResponse {
|
|
1544
1754
|
/**
|
|
1755
|
+
* @public
|
|
1545
1756
|
* <p>The details of the membership.</p>
|
|
1546
1757
|
*/
|
|
1547
1758
|
ChannelMembership?: ChannelMembership;
|
|
@@ -1551,14 +1762,17 @@ export interface DescribeChannelMembershipResponse {
|
|
|
1551
1762
|
*/
|
|
1552
1763
|
export interface DescribeChannelMembershipForAppInstanceUserRequest {
|
|
1553
1764
|
/**
|
|
1765
|
+
* @public
|
|
1554
1766
|
* <p>The ARN of the channel to which the user belongs.</p>
|
|
1555
1767
|
*/
|
|
1556
1768
|
ChannelArn: string | undefined;
|
|
1557
1769
|
/**
|
|
1770
|
+
* @public
|
|
1558
1771
|
* <p>The ARN of the user or bot in a channel.</p>
|
|
1559
1772
|
*/
|
|
1560
1773
|
AppInstanceUserArn: string | undefined;
|
|
1561
1774
|
/**
|
|
1775
|
+
* @public
|
|
1562
1776
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code>
|
|
1563
1777
|
* that makes the API call.</p>
|
|
1564
1778
|
*/
|
|
@@ -1569,6 +1783,7 @@ export interface DescribeChannelMembershipForAppInstanceUserRequest {
|
|
|
1569
1783
|
*/
|
|
1570
1784
|
export interface DescribeChannelMembershipForAppInstanceUserResponse {
|
|
1571
1785
|
/**
|
|
1786
|
+
* @public
|
|
1572
1787
|
* <p>The channel to which a user belongs.</p>
|
|
1573
1788
|
*/
|
|
1574
1789
|
ChannelMembership?: ChannelMembershipForAppInstanceUserSummary;
|
|
@@ -1578,14 +1793,17 @@ export interface DescribeChannelMembershipForAppInstanceUserResponse {
|
|
|
1578
1793
|
*/
|
|
1579
1794
|
export interface DescribeChannelModeratedByAppInstanceUserRequest {
|
|
1580
1795
|
/**
|
|
1796
|
+
* @public
|
|
1581
1797
|
* <p>The ARN of the moderated channel.</p>
|
|
1582
1798
|
*/
|
|
1583
1799
|
ChannelArn: string | undefined;
|
|
1584
1800
|
/**
|
|
1801
|
+
* @public
|
|
1585
1802
|
* <p>The ARN of the user or bot in the moderated channel.</p>
|
|
1586
1803
|
*/
|
|
1587
1804
|
AppInstanceUserArn: string | undefined;
|
|
1588
1805
|
/**
|
|
1806
|
+
* @public
|
|
1589
1807
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code>
|
|
1590
1808
|
* that makes the API call.</p>
|
|
1591
1809
|
*/
|
|
@@ -1596,6 +1814,7 @@ export interface DescribeChannelModeratedByAppInstanceUserRequest {
|
|
|
1596
1814
|
*/
|
|
1597
1815
|
export interface DescribeChannelModeratedByAppInstanceUserResponse {
|
|
1598
1816
|
/**
|
|
1817
|
+
* @public
|
|
1599
1818
|
* <p>The moderated channel.</p>
|
|
1600
1819
|
*/
|
|
1601
1820
|
Channel?: ChannelModeratedByAppInstanceUserSummary;
|
|
@@ -1605,14 +1824,17 @@ export interface DescribeChannelModeratedByAppInstanceUserResponse {
|
|
|
1605
1824
|
*/
|
|
1606
1825
|
export interface DescribeChannelModeratorRequest {
|
|
1607
1826
|
/**
|
|
1827
|
+
* @public
|
|
1608
1828
|
* <p>The ARN of the channel.</p>
|
|
1609
1829
|
*/
|
|
1610
1830
|
ChannelArn: string | undefined;
|
|
1611
1831
|
/**
|
|
1832
|
+
* @public
|
|
1612
1833
|
* <p>The <code>AppInstanceUserArn</code> of the channel moderator.</p>
|
|
1613
1834
|
*/
|
|
1614
1835
|
ChannelModeratorArn: string | undefined;
|
|
1615
1836
|
/**
|
|
1837
|
+
* @public
|
|
1616
1838
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code>
|
|
1617
1839
|
* that makes the API call.</p>
|
|
1618
1840
|
*/
|
|
@@ -1623,6 +1845,7 @@ export interface DescribeChannelModeratorRequest {
|
|
|
1623
1845
|
*/
|
|
1624
1846
|
export interface DescribeChannelModeratorResponse {
|
|
1625
1847
|
/**
|
|
1848
|
+
* @public
|
|
1626
1849
|
* <p>The details of the channel moderator.</p>
|
|
1627
1850
|
*/
|
|
1628
1851
|
ChannelModerator?: ChannelModerator;
|
|
@@ -1632,14 +1855,17 @@ export interface DescribeChannelModeratorResponse {
|
|
|
1632
1855
|
*/
|
|
1633
1856
|
export interface DisassociateChannelFlowRequest {
|
|
1634
1857
|
/**
|
|
1858
|
+
* @public
|
|
1635
1859
|
* <p>The ARN of the channel.</p>
|
|
1636
1860
|
*/
|
|
1637
1861
|
ChannelArn: string | undefined;
|
|
1638
1862
|
/**
|
|
1863
|
+
* @public
|
|
1639
1864
|
* <p>The ARN of the channel flow.</p>
|
|
1640
1865
|
*/
|
|
1641
1866
|
ChannelFlowArn: string | undefined;
|
|
1642
1867
|
/**
|
|
1868
|
+
* @public
|
|
1643
1869
|
* <p>The <code>AppInstanceUserArn</code> of the user making the API call.</p>
|
|
1644
1870
|
*/
|
|
1645
1871
|
ChimeBearer: string | undefined;
|
|
@@ -1649,14 +1875,17 @@ export interface DisassociateChannelFlowRequest {
|
|
|
1649
1875
|
*/
|
|
1650
1876
|
export interface GetChannelMembershipPreferencesRequest {
|
|
1651
1877
|
/**
|
|
1878
|
+
* @public
|
|
1652
1879
|
* <p>The ARN of the channel.</p>
|
|
1653
1880
|
*/
|
|
1654
1881
|
ChannelArn: string | undefined;
|
|
1655
1882
|
/**
|
|
1883
|
+
* @public
|
|
1656
1884
|
* <p>The <code>AppInstanceUserArn</code> of the member retrieving the preferences.</p>
|
|
1657
1885
|
*/
|
|
1658
1886
|
MemberArn: string | undefined;
|
|
1659
1887
|
/**
|
|
1888
|
+
* @public
|
|
1660
1889
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call.</p>
|
|
1661
1890
|
*/
|
|
1662
1891
|
ChimeBearer: string | undefined;
|
|
@@ -1666,14 +1895,17 @@ export interface GetChannelMembershipPreferencesRequest {
|
|
|
1666
1895
|
*/
|
|
1667
1896
|
export interface GetChannelMembershipPreferencesResponse {
|
|
1668
1897
|
/**
|
|
1898
|
+
* @public
|
|
1669
1899
|
* <p>The ARN of the channel.</p>
|
|
1670
1900
|
*/
|
|
1671
1901
|
ChannelArn?: string;
|
|
1672
1902
|
/**
|
|
1903
|
+
* @public
|
|
1673
1904
|
* <p>The details of a user.</p>
|
|
1674
1905
|
*/
|
|
1675
1906
|
Member?: Identity;
|
|
1676
1907
|
/**
|
|
1908
|
+
* @public
|
|
1677
1909
|
* <p>The channel membership preferences for an <code>AppInstanceUser</code> .</p>
|
|
1678
1910
|
*/
|
|
1679
1911
|
Preferences?: ChannelMembershipPreferences;
|
|
@@ -1683,19 +1915,23 @@ export interface GetChannelMembershipPreferencesResponse {
|
|
|
1683
1915
|
*/
|
|
1684
1916
|
export interface GetChannelMessageRequest {
|
|
1685
1917
|
/**
|
|
1918
|
+
* @public
|
|
1686
1919
|
* <p>The ARN of the channel.</p>
|
|
1687
1920
|
*/
|
|
1688
1921
|
ChannelArn: string | undefined;
|
|
1689
1922
|
/**
|
|
1923
|
+
* @public
|
|
1690
1924
|
* <p>The ID of the message.</p>
|
|
1691
1925
|
*/
|
|
1692
1926
|
MessageId: string | undefined;
|
|
1693
1927
|
/**
|
|
1928
|
+
* @public
|
|
1694
1929
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code>
|
|
1695
1930
|
* that makes the API call.</p>
|
|
1696
1931
|
*/
|
|
1697
1932
|
ChimeBearer: string | undefined;
|
|
1698
1933
|
/**
|
|
1934
|
+
* @public
|
|
1699
1935
|
* <p>The ID of the SubChannel in the request.</p>
|
|
1700
1936
|
* <note>
|
|
1701
1937
|
* <p>Only required when getting messages in a SubChannel that the user belongs to.</p>
|
|
@@ -1708,6 +1944,7 @@ export interface GetChannelMessageRequest {
|
|
|
1708
1944
|
*/
|
|
1709
1945
|
export interface GetChannelMessageResponse {
|
|
1710
1946
|
/**
|
|
1947
|
+
* @public
|
|
1711
1948
|
* <p>The details of and content in the message.</p>
|
|
1712
1949
|
*/
|
|
1713
1950
|
ChannelMessage?: ChannelMessage;
|
|
@@ -1717,18 +1954,22 @@ export interface GetChannelMessageResponse {
|
|
|
1717
1954
|
*/
|
|
1718
1955
|
export interface GetChannelMessageStatusRequest {
|
|
1719
1956
|
/**
|
|
1957
|
+
* @public
|
|
1720
1958
|
* <p>The ARN of the channel</p>
|
|
1721
1959
|
*/
|
|
1722
1960
|
ChannelArn: string | undefined;
|
|
1723
1961
|
/**
|
|
1962
|
+
* @public
|
|
1724
1963
|
* <p>The ID of the message.</p>
|
|
1725
1964
|
*/
|
|
1726
1965
|
MessageId: string | undefined;
|
|
1727
1966
|
/**
|
|
1967
|
+
* @public
|
|
1728
1968
|
* <p>The <code>AppInstanceUserArn</code> of the user making the API call.</p>
|
|
1729
1969
|
*/
|
|
1730
1970
|
ChimeBearer: string | undefined;
|
|
1731
1971
|
/**
|
|
1972
|
+
* @public
|
|
1732
1973
|
* <p>The ID of the SubChannel in the request.</p>
|
|
1733
1974
|
* <note>
|
|
1734
1975
|
* <p>Only required when getting message status in a SubChannel that the user belongs to.</p>
|
|
@@ -1741,6 +1982,7 @@ export interface GetChannelMessageStatusRequest {
|
|
|
1741
1982
|
*/
|
|
1742
1983
|
export interface GetChannelMessageStatusResponse {
|
|
1743
1984
|
/**
|
|
1985
|
+
* @public
|
|
1744
1986
|
* <p>The message status and details.</p>
|
|
1745
1987
|
*/
|
|
1746
1988
|
Status?: ChannelMessageStatusStructure;
|
|
@@ -1756,6 +1998,7 @@ export interface GetMessagingSessionEndpointRequest {
|
|
|
1756
1998
|
*/
|
|
1757
1999
|
export interface MessagingSessionEndpoint {
|
|
1758
2000
|
/**
|
|
2001
|
+
* @public
|
|
1759
2002
|
* <p>The endpoint to which you establish a websocket connection.</p>
|
|
1760
2003
|
*/
|
|
1761
2004
|
Url?: string;
|
|
@@ -1765,6 +2008,7 @@ export interface MessagingSessionEndpoint {
|
|
|
1765
2008
|
*/
|
|
1766
2009
|
export interface GetMessagingSessionEndpointResponse {
|
|
1767
2010
|
/**
|
|
2011
|
+
* @public
|
|
1768
2012
|
* <p>The endpoint returned in the response.</p>
|
|
1769
2013
|
*/
|
|
1770
2014
|
Endpoint?: MessagingSessionEndpoint;
|
|
@@ -1774,6 +2018,7 @@ export interface GetMessagingSessionEndpointResponse {
|
|
|
1774
2018
|
*/
|
|
1775
2019
|
export interface GetMessagingStreamingConfigurationsRequest {
|
|
1776
2020
|
/**
|
|
2021
|
+
* @public
|
|
1777
2022
|
* <p>The ARN of the streaming configurations.</p>
|
|
1778
2023
|
*/
|
|
1779
2024
|
AppInstanceArn: string | undefined;
|
|
@@ -1796,10 +2041,12 @@ export type MessagingDataType = (typeof MessagingDataType)[keyof typeof Messagin
|
|
|
1796
2041
|
*/
|
|
1797
2042
|
export interface StreamingConfiguration {
|
|
1798
2043
|
/**
|
|
2044
|
+
* @public
|
|
1799
2045
|
* <p>The data type of the configuration.</p>
|
|
1800
2046
|
*/
|
|
1801
2047
|
DataType: MessagingDataType | string | undefined;
|
|
1802
2048
|
/**
|
|
2049
|
+
* @public
|
|
1803
2050
|
* <p>The ARN of the resource in the configuration. </p>
|
|
1804
2051
|
*/
|
|
1805
2052
|
ResourceArn: string | undefined;
|
|
@@ -1809,6 +2056,7 @@ export interface StreamingConfiguration {
|
|
|
1809
2056
|
*/
|
|
1810
2057
|
export interface GetMessagingStreamingConfigurationsResponse {
|
|
1811
2058
|
/**
|
|
2059
|
+
* @public
|
|
1812
2060
|
* <p>The streaming settings.</p>
|
|
1813
2061
|
*/
|
|
1814
2062
|
StreamingConfigurations?: StreamingConfiguration[];
|
|
@@ -1818,18 +2066,22 @@ export interface GetMessagingStreamingConfigurationsResponse {
|
|
|
1818
2066
|
*/
|
|
1819
2067
|
export interface ListChannelBansRequest {
|
|
1820
2068
|
/**
|
|
2069
|
+
* @public
|
|
1821
2070
|
* <p>The ARN of the channel.</p>
|
|
1822
2071
|
*/
|
|
1823
2072
|
ChannelArn: string | undefined;
|
|
1824
2073
|
/**
|
|
2074
|
+
* @public
|
|
1825
2075
|
* <p>The maximum number of bans that you want returned.</p>
|
|
1826
2076
|
*/
|
|
1827
2077
|
MaxResults?: number;
|
|
1828
2078
|
/**
|
|
2079
|
+
* @public
|
|
1829
2080
|
* <p>The token passed by previous API calls until all requested bans are returned.</p>
|
|
1830
2081
|
*/
|
|
1831
2082
|
NextToken?: string;
|
|
1832
2083
|
/**
|
|
2084
|
+
* @public
|
|
1833
2085
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code>
|
|
1834
2086
|
* that makes the API call.</p>
|
|
1835
2087
|
*/
|
|
@@ -1840,14 +2092,17 @@ export interface ListChannelBansRequest {
|
|
|
1840
2092
|
*/
|
|
1841
2093
|
export interface ListChannelBansResponse {
|
|
1842
2094
|
/**
|
|
2095
|
+
* @public
|
|
1843
2096
|
* <p>The ARN of the channel.</p>
|
|
1844
2097
|
*/
|
|
1845
2098
|
ChannelArn?: string;
|
|
1846
2099
|
/**
|
|
2100
|
+
* @public
|
|
1847
2101
|
* <p>The token passed by previous API calls until all requested bans are returned.</p>
|
|
1848
2102
|
*/
|
|
1849
2103
|
NextToken?: string;
|
|
1850
2104
|
/**
|
|
2105
|
+
* @public
|
|
1851
2106
|
* <p>The information for each requested ban.</p>
|
|
1852
2107
|
*/
|
|
1853
2108
|
ChannelBans?: ChannelBanSummary[];
|
|
@@ -1857,14 +2112,17 @@ export interface ListChannelBansResponse {
|
|
|
1857
2112
|
*/
|
|
1858
2113
|
export interface ListChannelFlowsRequest {
|
|
1859
2114
|
/**
|
|
2115
|
+
* @public
|
|
1860
2116
|
* <p>The ARN of the app instance.</p>
|
|
1861
2117
|
*/
|
|
1862
2118
|
AppInstanceArn: string | undefined;
|
|
1863
2119
|
/**
|
|
2120
|
+
* @public
|
|
1864
2121
|
* <p>The maximum number of channel flows that you want to return.</p>
|
|
1865
2122
|
*/
|
|
1866
2123
|
MaxResults?: number;
|
|
1867
2124
|
/**
|
|
2125
|
+
* @public
|
|
1868
2126
|
* <p>The token passed by previous API calls until all requested channel flows are returned.</p>
|
|
1869
2127
|
*/
|
|
1870
2128
|
NextToken?: string;
|
|
@@ -1874,10 +2132,12 @@ export interface ListChannelFlowsRequest {
|
|
|
1874
2132
|
*/
|
|
1875
2133
|
export interface ListChannelFlowsResponse {
|
|
1876
2134
|
/**
|
|
2135
|
+
* @public
|
|
1877
2136
|
* <p>The information about each channel flow.</p>
|
|
1878
2137
|
*/
|
|
1879
2138
|
ChannelFlows?: ChannelFlowSummary[];
|
|
1880
2139
|
/**
|
|
2140
|
+
* @public
|
|
1881
2141
|
* <p>The token passed by previous API calls until all requested channels are returned.</p>
|
|
1882
2142
|
*/
|
|
1883
2143
|
NextToken?: string;
|
|
@@ -1887,10 +2147,12 @@ export interface ListChannelFlowsResponse {
|
|
|
1887
2147
|
*/
|
|
1888
2148
|
export interface ListChannelMembershipsRequest {
|
|
1889
2149
|
/**
|
|
2150
|
+
* @public
|
|
1890
2151
|
* <p>The maximum number of channel memberships that you want returned.</p>
|
|
1891
2152
|
*/
|
|
1892
2153
|
ChannelArn: string | undefined;
|
|
1893
2154
|
/**
|
|
2155
|
+
* @public
|
|
1894
2156
|
* <p>The membership type of a user, <code>DEFAULT</code> or <code>HIDDEN</code>. Default
|
|
1895
2157
|
* members are returned as part of <code>ListChannelMemberships</code> if no type is specified. Hidden members
|
|
1896
2158
|
* are only returned if the type filter in <code>ListChannelMemberships</code> equals
|
|
@@ -1898,20 +2160,24 @@ export interface ListChannelMembershipsRequest {
|
|
|
1898
2160
|
*/
|
|
1899
2161
|
Type?: ChannelMembershipType | string;
|
|
1900
2162
|
/**
|
|
2163
|
+
* @public
|
|
1901
2164
|
* <p>The maximum number of channel memberships that you want returned.</p>
|
|
1902
2165
|
*/
|
|
1903
2166
|
MaxResults?: number;
|
|
1904
2167
|
/**
|
|
2168
|
+
* @public
|
|
1905
2169
|
* <p>The token passed by previous API calls until all requested channel memberships are
|
|
1906
2170
|
* returned.</p>
|
|
1907
2171
|
*/
|
|
1908
2172
|
NextToken?: string;
|
|
1909
2173
|
/**
|
|
2174
|
+
* @public
|
|
1910
2175
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code>
|
|
1911
2176
|
* that makes the API call.</p>
|
|
1912
2177
|
*/
|
|
1913
2178
|
ChimeBearer: string | undefined;
|
|
1914
2179
|
/**
|
|
2180
|
+
* @public
|
|
1915
2181
|
* <p>The ID of the SubChannel in the request.</p>
|
|
1916
2182
|
* <note>
|
|
1917
2183
|
* <p>Only required when listing a user's memberships in a particular sub-channel of an elastic channel.</p>
|
|
@@ -1924,14 +2190,17 @@ export interface ListChannelMembershipsRequest {
|
|
|
1924
2190
|
*/
|
|
1925
2191
|
export interface ListChannelMembershipsResponse {
|
|
1926
2192
|
/**
|
|
2193
|
+
* @public
|
|
1927
2194
|
* <p>The ARN of the channel.</p>
|
|
1928
2195
|
*/
|
|
1929
2196
|
ChannelArn?: string;
|
|
1930
2197
|
/**
|
|
2198
|
+
* @public
|
|
1931
2199
|
* <p>The information for the requested channel memberships.</p>
|
|
1932
2200
|
*/
|
|
1933
2201
|
ChannelMemberships?: ChannelMembershipSummary[];
|
|
1934
2202
|
/**
|
|
2203
|
+
* @public
|
|
1935
2204
|
* <p>The token passed by previous API calls until all requested channel memberships are
|
|
1936
2205
|
* returned.</p>
|
|
1937
2206
|
*/
|
|
@@ -1942,19 +2211,23 @@ export interface ListChannelMembershipsResponse {
|
|
|
1942
2211
|
*/
|
|
1943
2212
|
export interface ListChannelMembershipsForAppInstanceUserRequest {
|
|
1944
2213
|
/**
|
|
2214
|
+
* @public
|
|
1945
2215
|
* <p>The ARN of the user or bot.</p>
|
|
1946
2216
|
*/
|
|
1947
2217
|
AppInstanceUserArn?: string;
|
|
1948
2218
|
/**
|
|
2219
|
+
* @public
|
|
1949
2220
|
* <p>The maximum number of users that you want returned.</p>
|
|
1950
2221
|
*/
|
|
1951
2222
|
MaxResults?: number;
|
|
1952
2223
|
/**
|
|
2224
|
+
* @public
|
|
1953
2225
|
* <p>The token returned from previous API requests until the number of channel memberships is
|
|
1954
2226
|
* reached.</p>
|
|
1955
2227
|
*/
|
|
1956
2228
|
NextToken?: string;
|
|
1957
2229
|
/**
|
|
2230
|
+
* @public
|
|
1958
2231
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code>
|
|
1959
2232
|
* that makes the API call.</p>
|
|
1960
2233
|
*/
|
|
@@ -1965,10 +2238,12 @@ export interface ListChannelMembershipsForAppInstanceUserRequest {
|
|
|
1965
2238
|
*/
|
|
1966
2239
|
export interface ListChannelMembershipsForAppInstanceUserResponse {
|
|
1967
2240
|
/**
|
|
2241
|
+
* @public
|
|
1968
2242
|
* <p>The information for the requested channel memberships.</p>
|
|
1969
2243
|
*/
|
|
1970
2244
|
ChannelMemberships?: ChannelMembershipForAppInstanceUserSummary[];
|
|
1971
2245
|
/**
|
|
2246
|
+
* @public
|
|
1972
2247
|
* <p>The token passed by previous API calls until all requested users are returned.</p>
|
|
1973
2248
|
*/
|
|
1974
2249
|
NextToken?: string;
|
|
@@ -1990,36 +2265,44 @@ export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder];
|
|
|
1990
2265
|
*/
|
|
1991
2266
|
export interface ListChannelMessagesRequest {
|
|
1992
2267
|
/**
|
|
2268
|
+
* @public
|
|
1993
2269
|
* <p>The ARN of the channel.</p>
|
|
1994
2270
|
*/
|
|
1995
2271
|
ChannelArn: string | undefined;
|
|
1996
2272
|
/**
|
|
2273
|
+
* @public
|
|
1997
2274
|
* <p>The order in which you want messages sorted. Default is Descending, based on time
|
|
1998
2275
|
* created.</p>
|
|
1999
2276
|
*/
|
|
2000
2277
|
SortOrder?: SortOrder | string;
|
|
2001
2278
|
/**
|
|
2279
|
+
* @public
|
|
2002
2280
|
* <p>The initial or starting time stamp for your requested messages.</p>
|
|
2003
2281
|
*/
|
|
2004
2282
|
NotBefore?: Date;
|
|
2005
2283
|
/**
|
|
2284
|
+
* @public
|
|
2006
2285
|
* <p>The final or ending time stamp for your requested messages.</p>
|
|
2007
2286
|
*/
|
|
2008
2287
|
NotAfter?: Date;
|
|
2009
2288
|
/**
|
|
2289
|
+
* @public
|
|
2010
2290
|
* <p>The maximum number of messages that you want returned.</p>
|
|
2011
2291
|
*/
|
|
2012
2292
|
MaxResults?: number;
|
|
2013
2293
|
/**
|
|
2294
|
+
* @public
|
|
2014
2295
|
* <p>The token passed by previous API calls until all requested messages are returned.</p>
|
|
2015
2296
|
*/
|
|
2016
2297
|
NextToken?: string;
|
|
2017
2298
|
/**
|
|
2299
|
+
* @public
|
|
2018
2300
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code>
|
|
2019
2301
|
* that makes the API call.</p>
|
|
2020
2302
|
*/
|
|
2021
2303
|
ChimeBearer: string | undefined;
|
|
2022
2304
|
/**
|
|
2305
|
+
* @public
|
|
2023
2306
|
* <p>The ID of the SubChannel in the request.</p>
|
|
2024
2307
|
* <note>
|
|
2025
2308
|
* <p>Only required when listing the messages in a SubChannel that the user belongs to.</p>
|
|
@@ -2032,18 +2315,22 @@ export interface ListChannelMessagesRequest {
|
|
|
2032
2315
|
*/
|
|
2033
2316
|
export interface ListChannelMessagesResponse {
|
|
2034
2317
|
/**
|
|
2318
|
+
* @public
|
|
2035
2319
|
* <p>The ARN of the channel containing the requested messages.</p>
|
|
2036
2320
|
*/
|
|
2037
2321
|
ChannelArn?: string;
|
|
2038
2322
|
/**
|
|
2323
|
+
* @public
|
|
2039
2324
|
* <p>The token passed by previous API calls until all requested messages are returned.</p>
|
|
2040
2325
|
*/
|
|
2041
2326
|
NextToken?: string;
|
|
2042
2327
|
/**
|
|
2328
|
+
* @public
|
|
2043
2329
|
* <p>The information about, and content of, each requested message.</p>
|
|
2044
2330
|
*/
|
|
2045
2331
|
ChannelMessages?: ChannelMessageSummary[];
|
|
2046
2332
|
/**
|
|
2333
|
+
* @public
|
|
2047
2334
|
* <p>The ID of the SubChannel in the response.</p>
|
|
2048
2335
|
*/
|
|
2049
2336
|
SubChannelId?: string;
|
|
@@ -2053,19 +2340,23 @@ export interface ListChannelMessagesResponse {
|
|
|
2053
2340
|
*/
|
|
2054
2341
|
export interface ListChannelModeratorsRequest {
|
|
2055
2342
|
/**
|
|
2343
|
+
* @public
|
|
2056
2344
|
* <p>The ARN of the channel.</p>
|
|
2057
2345
|
*/
|
|
2058
2346
|
ChannelArn: string | undefined;
|
|
2059
2347
|
/**
|
|
2348
|
+
* @public
|
|
2060
2349
|
* <p>The maximum number of moderators that you want returned.</p>
|
|
2061
2350
|
*/
|
|
2062
2351
|
MaxResults?: number;
|
|
2063
2352
|
/**
|
|
2353
|
+
* @public
|
|
2064
2354
|
* <p>The token passed by previous API calls until all requested moderators are
|
|
2065
2355
|
* returned.</p>
|
|
2066
2356
|
*/
|
|
2067
2357
|
NextToken?: string;
|
|
2068
2358
|
/**
|
|
2359
|
+
* @public
|
|
2069
2360
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code>
|
|
2070
2361
|
* that makes the API call.</p>
|
|
2071
2362
|
*/
|
|
@@ -2076,15 +2367,18 @@ export interface ListChannelModeratorsRequest {
|
|
|
2076
2367
|
*/
|
|
2077
2368
|
export interface ListChannelModeratorsResponse {
|
|
2078
2369
|
/**
|
|
2370
|
+
* @public
|
|
2079
2371
|
* <p>The ARN of the channel.</p>
|
|
2080
2372
|
*/
|
|
2081
2373
|
ChannelArn?: string;
|
|
2082
2374
|
/**
|
|
2375
|
+
* @public
|
|
2083
2376
|
* <p>The token passed by previous API calls until all requested moderators are
|
|
2084
2377
|
* returned.</p>
|
|
2085
2378
|
*/
|
|
2086
2379
|
NextToken?: string;
|
|
2087
2380
|
/**
|
|
2381
|
+
* @public
|
|
2088
2382
|
* <p>The information about and names of each moderator.</p>
|
|
2089
2383
|
*/
|
|
2090
2384
|
ChannelModerators?: ChannelModeratorSummary[];
|
|
@@ -2094,24 +2388,29 @@ export interface ListChannelModeratorsResponse {
|
|
|
2094
2388
|
*/
|
|
2095
2389
|
export interface ListChannelsRequest {
|
|
2096
2390
|
/**
|
|
2391
|
+
* @public
|
|
2097
2392
|
* <p>The ARN of the <code>AppInstance</code>.</p>
|
|
2098
2393
|
*/
|
|
2099
2394
|
AppInstanceArn: string | undefined;
|
|
2100
2395
|
/**
|
|
2396
|
+
* @public
|
|
2101
2397
|
* <p>The privacy setting. <code>PUBLIC</code> retrieves all the public channels.
|
|
2102
2398
|
* <code>PRIVATE</code> retrieves private channels. Only an <code>AppInstanceAdmin</code>
|
|
2103
2399
|
* can retrieve private channels. </p>
|
|
2104
2400
|
*/
|
|
2105
2401
|
Privacy?: ChannelPrivacy | string;
|
|
2106
2402
|
/**
|
|
2403
|
+
* @public
|
|
2107
2404
|
* <p>The maximum number of channels that you want to return.</p>
|
|
2108
2405
|
*/
|
|
2109
2406
|
MaxResults?: number;
|
|
2110
2407
|
/**
|
|
2408
|
+
* @public
|
|
2111
2409
|
* <p>The token passed by previous API calls until all requested channels are returned.</p>
|
|
2112
2410
|
*/
|
|
2113
2411
|
NextToken?: string;
|
|
2114
2412
|
/**
|
|
2413
|
+
* @public
|
|
2115
2414
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code>
|
|
2116
2415
|
* that makes the API call.</p>
|
|
2117
2416
|
*/
|
|
@@ -2122,10 +2421,12 @@ export interface ListChannelsRequest {
|
|
|
2122
2421
|
*/
|
|
2123
2422
|
export interface ListChannelsResponse {
|
|
2124
2423
|
/**
|
|
2424
|
+
* @public
|
|
2125
2425
|
* <p>The information about each channel.</p>
|
|
2126
2426
|
*/
|
|
2127
2427
|
Channels?: ChannelSummary[];
|
|
2128
2428
|
/**
|
|
2429
|
+
* @public
|
|
2129
2430
|
* <p>The token returned from previous API requests until the number of channels is
|
|
2130
2431
|
* reached.</p>
|
|
2131
2432
|
*/
|
|
@@ -2136,14 +2437,17 @@ export interface ListChannelsResponse {
|
|
|
2136
2437
|
*/
|
|
2137
2438
|
export interface ListChannelsAssociatedWithChannelFlowRequest {
|
|
2138
2439
|
/**
|
|
2440
|
+
* @public
|
|
2139
2441
|
* <p>The ARN of the channel flow.</p>
|
|
2140
2442
|
*/
|
|
2141
2443
|
ChannelFlowArn: string | undefined;
|
|
2142
2444
|
/**
|
|
2445
|
+
* @public
|
|
2143
2446
|
* <p>The maximum number of channels that you want to return.</p>
|
|
2144
2447
|
*/
|
|
2145
2448
|
MaxResults?: number;
|
|
2146
2449
|
/**
|
|
2450
|
+
* @public
|
|
2147
2451
|
* <p>The token passed by previous API calls until all requested channels are returned.</p>
|
|
2148
2452
|
*/
|
|
2149
2453
|
NextToken?: string;
|
|
@@ -2153,10 +2457,12 @@ export interface ListChannelsAssociatedWithChannelFlowRequest {
|
|
|
2153
2457
|
*/
|
|
2154
2458
|
export interface ListChannelsAssociatedWithChannelFlowResponse {
|
|
2155
2459
|
/**
|
|
2460
|
+
* @public
|
|
2156
2461
|
* <p>The information about each channel.</p>
|
|
2157
2462
|
*/
|
|
2158
2463
|
Channels?: ChannelAssociatedWithFlowSummary[];
|
|
2159
2464
|
/**
|
|
2465
|
+
* @public
|
|
2160
2466
|
* <p>The token passed by previous API calls until all requested channels are returned.</p>
|
|
2161
2467
|
*/
|
|
2162
2468
|
NextToken?: string;
|
|
@@ -2166,19 +2472,23 @@ export interface ListChannelsAssociatedWithChannelFlowResponse {
|
|
|
2166
2472
|
*/
|
|
2167
2473
|
export interface ListChannelsModeratedByAppInstanceUserRequest {
|
|
2168
2474
|
/**
|
|
2475
|
+
* @public
|
|
2169
2476
|
* <p>The ARN of the user or bot in the moderated channel.</p>
|
|
2170
2477
|
*/
|
|
2171
2478
|
AppInstanceUserArn?: string;
|
|
2172
2479
|
/**
|
|
2480
|
+
* @public
|
|
2173
2481
|
* <p>The maximum number of channels in the request.</p>
|
|
2174
2482
|
*/
|
|
2175
2483
|
MaxResults?: number;
|
|
2176
2484
|
/**
|
|
2485
|
+
* @public
|
|
2177
2486
|
* <p>The token returned from previous API requests until the number of channels moderated by
|
|
2178
2487
|
* the user is reached.</p>
|
|
2179
2488
|
*/
|
|
2180
2489
|
NextToken?: string;
|
|
2181
2490
|
/**
|
|
2491
|
+
* @public
|
|
2182
2492
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code>
|
|
2183
2493
|
* that makes the API call.</p>
|
|
2184
2494
|
*/
|
|
@@ -2189,10 +2499,12 @@ export interface ListChannelsModeratedByAppInstanceUserRequest {
|
|
|
2189
2499
|
*/
|
|
2190
2500
|
export interface ListChannelsModeratedByAppInstanceUserResponse {
|
|
2191
2501
|
/**
|
|
2502
|
+
* @public
|
|
2192
2503
|
* <p>The moderated channels in the request.</p>
|
|
2193
2504
|
*/
|
|
2194
2505
|
Channels?: ChannelModeratedByAppInstanceUserSummary[];
|
|
2195
2506
|
/**
|
|
2507
|
+
* @public
|
|
2196
2508
|
* <p>The token returned from previous API requests until the number of channels moderated by
|
|
2197
2509
|
* the user is reached.</p>
|
|
2198
2510
|
*/
|
|
@@ -2203,18 +2515,22 @@ export interface ListChannelsModeratedByAppInstanceUserResponse {
|
|
|
2203
2515
|
*/
|
|
2204
2516
|
export interface ListSubChannelsRequest {
|
|
2205
2517
|
/**
|
|
2518
|
+
* @public
|
|
2206
2519
|
* <p>The ARN of elastic channel.</p>
|
|
2207
2520
|
*/
|
|
2208
2521
|
ChannelArn: string | undefined;
|
|
2209
2522
|
/**
|
|
2523
|
+
* @public
|
|
2210
2524
|
* <p>The <code>AppInstanceUserArn</code> of the user making the API call.</p>
|
|
2211
2525
|
*/
|
|
2212
2526
|
ChimeBearer: string | undefined;
|
|
2213
2527
|
/**
|
|
2528
|
+
* @public
|
|
2214
2529
|
* <p>The maximum number of sub-channels that you want to return.</p>
|
|
2215
2530
|
*/
|
|
2216
2531
|
MaxResults?: number;
|
|
2217
2532
|
/**
|
|
2533
|
+
* @public
|
|
2218
2534
|
* <p>The token passed by previous API calls until all requested sub-channels are returned.</p>
|
|
2219
2535
|
*/
|
|
2220
2536
|
NextToken?: string;
|
|
@@ -2225,10 +2541,12 @@ export interface ListSubChannelsRequest {
|
|
|
2225
2541
|
*/
|
|
2226
2542
|
export interface SubChannelSummary {
|
|
2227
2543
|
/**
|
|
2544
|
+
* @public
|
|
2228
2545
|
* <p>The unique ID of a SubChannel.</p>
|
|
2229
2546
|
*/
|
|
2230
2547
|
SubChannelId?: string;
|
|
2231
2548
|
/**
|
|
2549
|
+
* @public
|
|
2232
2550
|
* <p>The number of members in a SubChannel.</p>
|
|
2233
2551
|
*/
|
|
2234
2552
|
MembershipCount?: number;
|
|
@@ -2238,14 +2556,17 @@ export interface SubChannelSummary {
|
|
|
2238
2556
|
*/
|
|
2239
2557
|
export interface ListSubChannelsResponse {
|
|
2240
2558
|
/**
|
|
2559
|
+
* @public
|
|
2241
2560
|
* <p>The ARN of elastic channel.</p>
|
|
2242
2561
|
*/
|
|
2243
2562
|
ChannelArn?: string;
|
|
2244
2563
|
/**
|
|
2564
|
+
* @public
|
|
2245
2565
|
* <p>The information about each sub-channel.</p>
|
|
2246
2566
|
*/
|
|
2247
2567
|
SubChannels?: SubChannelSummary[];
|
|
2248
2568
|
/**
|
|
2569
|
+
* @public
|
|
2249
2570
|
* <p>The token passed by previous API calls until all requested sub-channels are returned.</p>
|
|
2250
2571
|
*/
|
|
2251
2572
|
NextToken?: string;
|
|
@@ -2255,6 +2576,7 @@ export interface ListSubChannelsResponse {
|
|
|
2255
2576
|
*/
|
|
2256
2577
|
export interface ListTagsForResourceRequest {
|
|
2257
2578
|
/**
|
|
2579
|
+
* @public
|
|
2258
2580
|
* <p>The ARN of the resource.</p>
|
|
2259
2581
|
*/
|
|
2260
2582
|
ResourceARN: string | undefined;
|
|
@@ -2264,6 +2586,7 @@ export interface ListTagsForResourceRequest {
|
|
|
2264
2586
|
*/
|
|
2265
2587
|
export interface ListTagsForResourceResponse {
|
|
2266
2588
|
/**
|
|
2589
|
+
* @public
|
|
2267
2590
|
* <p>The tag key-value pairs.</p>
|
|
2268
2591
|
*/
|
|
2269
2592
|
Tags?: Tag[];
|
|
@@ -2273,14 +2596,17 @@ export interface ListTagsForResourceResponse {
|
|
|
2273
2596
|
*/
|
|
2274
2597
|
export interface PutChannelExpirationSettingsRequest {
|
|
2275
2598
|
/**
|
|
2599
|
+
* @public
|
|
2276
2600
|
* <p>The ARN of the channel.</p>
|
|
2277
2601
|
*/
|
|
2278
2602
|
ChannelArn: string | undefined;
|
|
2279
2603
|
/**
|
|
2604
|
+
* @public
|
|
2280
2605
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call.</p>
|
|
2281
2606
|
*/
|
|
2282
2607
|
ChimeBearer?: string;
|
|
2283
2608
|
/**
|
|
2609
|
+
* @public
|
|
2284
2610
|
* <p>Settings that control the interval after which a channel is deleted.</p>
|
|
2285
2611
|
*/
|
|
2286
2612
|
ExpirationSettings?: ExpirationSettings;
|
|
@@ -2290,10 +2616,12 @@ export interface PutChannelExpirationSettingsRequest {
|
|
|
2290
2616
|
*/
|
|
2291
2617
|
export interface PutChannelExpirationSettingsResponse {
|
|
2292
2618
|
/**
|
|
2619
|
+
* @public
|
|
2293
2620
|
* <p>The channel ARN.</p>
|
|
2294
2621
|
*/
|
|
2295
2622
|
ChannelArn?: string;
|
|
2296
2623
|
/**
|
|
2624
|
+
* @public
|
|
2297
2625
|
* <p>Settings that control the interval after which a channel is deleted.</p>
|
|
2298
2626
|
*/
|
|
2299
2627
|
ExpirationSettings?: ExpirationSettings;
|
|
@@ -2303,18 +2631,22 @@ export interface PutChannelExpirationSettingsResponse {
|
|
|
2303
2631
|
*/
|
|
2304
2632
|
export interface PutChannelMembershipPreferencesRequest {
|
|
2305
2633
|
/**
|
|
2634
|
+
* @public
|
|
2306
2635
|
* <p>The ARN of the channel.</p>
|
|
2307
2636
|
*/
|
|
2308
2637
|
ChannelArn: string | undefined;
|
|
2309
2638
|
/**
|
|
2639
|
+
* @public
|
|
2310
2640
|
* <p>The ARN of the member setting the preferences.</p>
|
|
2311
2641
|
*/
|
|
2312
2642
|
MemberArn: string | undefined;
|
|
2313
2643
|
/**
|
|
2644
|
+
* @public
|
|
2314
2645
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call.</p>
|
|
2315
2646
|
*/
|
|
2316
2647
|
ChimeBearer: string | undefined;
|
|
2317
2648
|
/**
|
|
2649
|
+
* @public
|
|
2318
2650
|
* <p>The channel membership preferences of an <code>AppInstanceUser</code> .</p>
|
|
2319
2651
|
*/
|
|
2320
2652
|
Preferences: ChannelMembershipPreferences | undefined;
|
|
@@ -2324,14 +2656,17 @@ export interface PutChannelMembershipPreferencesRequest {
|
|
|
2324
2656
|
*/
|
|
2325
2657
|
export interface PutChannelMembershipPreferencesResponse {
|
|
2326
2658
|
/**
|
|
2659
|
+
* @public
|
|
2327
2660
|
* <p>The ARN of the channel.</p>
|
|
2328
2661
|
*/
|
|
2329
2662
|
ChannelArn?: string;
|
|
2330
2663
|
/**
|
|
2664
|
+
* @public
|
|
2331
2665
|
* <p>The details of a user.</p>
|
|
2332
2666
|
*/
|
|
2333
2667
|
Member?: Identity;
|
|
2334
2668
|
/**
|
|
2669
|
+
* @public
|
|
2335
2670
|
* <p>The ARN and metadata of the member being added.</p>
|
|
2336
2671
|
*/
|
|
2337
2672
|
Preferences?: ChannelMembershipPreferences;
|
|
@@ -2341,10 +2676,12 @@ export interface PutChannelMembershipPreferencesResponse {
|
|
|
2341
2676
|
*/
|
|
2342
2677
|
export interface PutMessagingStreamingConfigurationsRequest {
|
|
2343
2678
|
/**
|
|
2679
|
+
* @public
|
|
2344
2680
|
* <p>The ARN of the streaming configuration.</p>
|
|
2345
2681
|
*/
|
|
2346
2682
|
AppInstanceArn: string | undefined;
|
|
2347
2683
|
/**
|
|
2684
|
+
* @public
|
|
2348
2685
|
* <p>The streaming configurations.</p>
|
|
2349
2686
|
*/
|
|
2350
2687
|
StreamingConfigurations: StreamingConfiguration[] | undefined;
|
|
@@ -2354,6 +2691,7 @@ export interface PutMessagingStreamingConfigurationsRequest {
|
|
|
2354
2691
|
*/
|
|
2355
2692
|
export interface PutMessagingStreamingConfigurationsResponse {
|
|
2356
2693
|
/**
|
|
2694
|
+
* @public
|
|
2357
2695
|
* <p>The requested streaming configurations.</p>
|
|
2358
2696
|
*/
|
|
2359
2697
|
StreamingConfigurations?: StreamingConfiguration[];
|
|
@@ -2363,19 +2701,23 @@ export interface PutMessagingStreamingConfigurationsResponse {
|
|
|
2363
2701
|
*/
|
|
2364
2702
|
export interface RedactChannelMessageRequest {
|
|
2365
2703
|
/**
|
|
2704
|
+
* @public
|
|
2366
2705
|
* <p>The ARN of the channel containing the messages that you want to redact.</p>
|
|
2367
2706
|
*/
|
|
2368
2707
|
ChannelArn: string | undefined;
|
|
2369
2708
|
/**
|
|
2709
|
+
* @public
|
|
2370
2710
|
* <p>The ID of the message being redacted.</p>
|
|
2371
2711
|
*/
|
|
2372
2712
|
MessageId: string | undefined;
|
|
2373
2713
|
/**
|
|
2714
|
+
* @public
|
|
2374
2715
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code>
|
|
2375
2716
|
* that makes the API call.</p>
|
|
2376
2717
|
*/
|
|
2377
2718
|
ChimeBearer: string | undefined;
|
|
2378
2719
|
/**
|
|
2720
|
+
* @public
|
|
2379
2721
|
* <p>The ID of the SubChannel in the request.</p>
|
|
2380
2722
|
*/
|
|
2381
2723
|
SubChannelId?: string;
|
|
@@ -2385,14 +2727,17 @@ export interface RedactChannelMessageRequest {
|
|
|
2385
2727
|
*/
|
|
2386
2728
|
export interface RedactChannelMessageResponse {
|
|
2387
2729
|
/**
|
|
2730
|
+
* @public
|
|
2388
2731
|
* <p>The ARN of the channel containing the messages that you want to redact.</p>
|
|
2389
2732
|
*/
|
|
2390
2733
|
ChannelArn?: string;
|
|
2391
2734
|
/**
|
|
2735
|
+
* @public
|
|
2392
2736
|
* <p>The ID of the message being redacted.</p>
|
|
2393
2737
|
*/
|
|
2394
2738
|
MessageId?: string;
|
|
2395
2739
|
/**
|
|
2740
|
+
* @public
|
|
2396
2741
|
* <p>The ID of the SubChannel in the response.</p>
|
|
2397
2742
|
* <note>
|
|
2398
2743
|
* <p>Only required when redacting messages in a SubChannel that the user belongs to.</p>
|
|
@@ -2429,11 +2774,13 @@ export type SearchFieldOperator = (typeof SearchFieldOperator)[keyof typeof Sear
|
|
|
2429
2774
|
*/
|
|
2430
2775
|
export interface SearchField {
|
|
2431
2776
|
/**
|
|
2777
|
+
* @public
|
|
2432
2778
|
* <p>An <code>enum</code> value that indicates the key to search the channel on. <code>MEMBERS</code> allows you to search channels based on memberships. You can use it with the <code>EQUALS</code>
|
|
2433
2779
|
* operator to get channels whose memberships are equal to the specified values, and with the <code>INCLUDES</code> operator to get channels whose memberships include the specified values.</p>
|
|
2434
2780
|
*/
|
|
2435
2781
|
Key: SearchFieldKey | string | undefined;
|
|
2436
2782
|
/**
|
|
2783
|
+
* @public
|
|
2437
2784
|
* <p>The values that you want to search for, a list of strings. The values must be <code>AppInstanceUserArns</code> specified as a list of strings.</p>
|
|
2438
2785
|
* <note>
|
|
2439
2786
|
* <p>This operation isn't supported for <code>AppInstanceUsers</code> with large number of memberships.</p>
|
|
@@ -2441,6 +2788,7 @@ export interface SearchField {
|
|
|
2441
2788
|
*/
|
|
2442
2789
|
Values: string[] | undefined;
|
|
2443
2790
|
/**
|
|
2791
|
+
* @public
|
|
2444
2792
|
* <p>The operator used to compare field values, currently <code>EQUALS</code> or <code>INCLUDES</code>. Use the <code>EQUALS</code> operator to find channels whose memberships equal the specified values.
|
|
2445
2793
|
* Use the <code>INCLUDES</code> operator to find channels whose memberships include the specified values.</p>
|
|
2446
2794
|
*/
|
|
@@ -2451,18 +2799,22 @@ export interface SearchField {
|
|
|
2451
2799
|
*/
|
|
2452
2800
|
export interface SearchChannelsRequest {
|
|
2453
2801
|
/**
|
|
2802
|
+
* @public
|
|
2454
2803
|
* <p>The <code>AppInstanceUserArn</code> of the user making the API call.</p>
|
|
2455
2804
|
*/
|
|
2456
2805
|
ChimeBearer?: string;
|
|
2457
2806
|
/**
|
|
2807
|
+
* @public
|
|
2458
2808
|
* <p>A list of the <code>Field</code> objects in the channel being searched.</p>
|
|
2459
2809
|
*/
|
|
2460
2810
|
Fields: SearchField[] | undefined;
|
|
2461
2811
|
/**
|
|
2812
|
+
* @public
|
|
2462
2813
|
* <p>The maximum number of channels that you want returned.</p>
|
|
2463
2814
|
*/
|
|
2464
2815
|
MaxResults?: number;
|
|
2465
2816
|
/**
|
|
2817
|
+
* @public
|
|
2466
2818
|
* <p>The token returned from previous API requests until the number of channels is reached.</p>
|
|
2467
2819
|
*/
|
|
2468
2820
|
NextToken?: string;
|
|
@@ -2472,10 +2824,12 @@ export interface SearchChannelsRequest {
|
|
|
2472
2824
|
*/
|
|
2473
2825
|
export interface SearchChannelsResponse {
|
|
2474
2826
|
/**
|
|
2827
|
+
* @public
|
|
2475
2828
|
* <p>A list of the channels in the request.</p>
|
|
2476
2829
|
*/
|
|
2477
2830
|
Channels?: ChannelSummary[];
|
|
2478
2831
|
/**
|
|
2832
|
+
* @public
|
|
2479
2833
|
* <p>The token returned from previous API responses until the number of channels is reached.</p>
|
|
2480
2834
|
*/
|
|
2481
2835
|
NextToken?: string;
|
|
@@ -2485,14 +2839,17 @@ export interface SearchChannelsResponse {
|
|
|
2485
2839
|
*/
|
|
2486
2840
|
export interface SendChannelMessageRequest {
|
|
2487
2841
|
/**
|
|
2842
|
+
* @public
|
|
2488
2843
|
* <p>The ARN of the channel.</p>
|
|
2489
2844
|
*/
|
|
2490
2845
|
ChannelArn: string | undefined;
|
|
2491
2846
|
/**
|
|
2847
|
+
* @public
|
|
2492
2848
|
* <p>The content of the channel message.</p>
|
|
2493
2849
|
*/
|
|
2494
2850
|
Content: string | undefined;
|
|
2495
2851
|
/**
|
|
2852
|
+
* @public
|
|
2496
2853
|
* <p>The type of message, <code>STANDARD</code> or <code>CONTROL</code>.</p>
|
|
2497
2854
|
* <p>
|
|
2498
2855
|
* <code>STANDARD</code> messages can be up to 4KB in size and contain metadata. Metadata is arbitrary,
|
|
@@ -2502,39 +2859,48 @@ export interface SendChannelMessageRequest {
|
|
|
2502
2859
|
*/
|
|
2503
2860
|
Type: ChannelMessageType | string | undefined;
|
|
2504
2861
|
/**
|
|
2862
|
+
* @public
|
|
2505
2863
|
* <p>Boolean that controls whether the message is persisted on the back end. Required.</p>
|
|
2506
2864
|
*/
|
|
2507
2865
|
Persistence: ChannelMessagePersistenceType | string | undefined;
|
|
2508
2866
|
/**
|
|
2867
|
+
* @public
|
|
2509
2868
|
* <p>The optional metadata for each message.</p>
|
|
2510
2869
|
*/
|
|
2511
2870
|
Metadata?: string;
|
|
2512
2871
|
/**
|
|
2872
|
+
* @public
|
|
2513
2873
|
* <p>The <code>Idempotency</code> token for each client request.</p>
|
|
2514
2874
|
*/
|
|
2515
2875
|
ClientRequestToken?: string;
|
|
2516
2876
|
/**
|
|
2877
|
+
* @public
|
|
2517
2878
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code>
|
|
2518
2879
|
* that makes the API call.</p>
|
|
2519
2880
|
*/
|
|
2520
2881
|
ChimeBearer: string | undefined;
|
|
2521
2882
|
/**
|
|
2883
|
+
* @public
|
|
2522
2884
|
* <p>The push notification configuration of the message.</p>
|
|
2523
2885
|
*/
|
|
2524
2886
|
PushNotification?: PushNotificationConfiguration;
|
|
2525
2887
|
/**
|
|
2888
|
+
* @public
|
|
2526
2889
|
* <p>The attributes for the message, used for message filtering along with a <code>FilterRule</code> defined in the <code>PushNotificationPreferences</code>.</p>
|
|
2527
2890
|
*/
|
|
2528
2891
|
MessageAttributes?: Record<string, MessageAttributeValue>;
|
|
2529
2892
|
/**
|
|
2893
|
+
* @public
|
|
2530
2894
|
* <p>The ID of the SubChannel in the request.</p>
|
|
2531
2895
|
*/
|
|
2532
2896
|
SubChannelId?: string;
|
|
2533
2897
|
/**
|
|
2898
|
+
* @public
|
|
2534
2899
|
* <p>The content type of the channel message.</p>
|
|
2535
2900
|
*/
|
|
2536
2901
|
ContentType?: string;
|
|
2537
2902
|
/**
|
|
2903
|
+
* @public
|
|
2538
2904
|
* <p>The target of a message. Must be a member of the channel, such as another user, a bot, or the sender. Only the target and the sender can view targeted messages.
|
|
2539
2905
|
* Only users who can see targeted messages can take actions on them. However, administrators can delete targeted messages that they can’t see.
|
|
2540
2906
|
* </p>
|
|
@@ -2546,18 +2912,22 @@ export interface SendChannelMessageRequest {
|
|
|
2546
2912
|
*/
|
|
2547
2913
|
export interface SendChannelMessageResponse {
|
|
2548
2914
|
/**
|
|
2915
|
+
* @public
|
|
2549
2916
|
* <p>The ARN of the channel.</p>
|
|
2550
2917
|
*/
|
|
2551
2918
|
ChannelArn?: string;
|
|
2552
2919
|
/**
|
|
2920
|
+
* @public
|
|
2553
2921
|
* <p>The ID string assigned to each message.</p>
|
|
2554
2922
|
*/
|
|
2555
2923
|
MessageId?: string;
|
|
2556
2924
|
/**
|
|
2925
|
+
* @public
|
|
2557
2926
|
* <p>The status of the channel message.</p>
|
|
2558
2927
|
*/
|
|
2559
2928
|
Status?: ChannelMessageStatusStructure;
|
|
2560
2929
|
/**
|
|
2930
|
+
* @public
|
|
2561
2931
|
* <p>The ID of the SubChannel in the response.</p>
|
|
2562
2932
|
*/
|
|
2563
2933
|
SubChannelId?: string;
|
|
@@ -2567,10 +2937,12 @@ export interface SendChannelMessageResponse {
|
|
|
2567
2937
|
*/
|
|
2568
2938
|
export interface TagResourceRequest {
|
|
2569
2939
|
/**
|
|
2940
|
+
* @public
|
|
2570
2941
|
* <p>The resource ARN.</p>
|
|
2571
2942
|
*/
|
|
2572
2943
|
ResourceARN: string | undefined;
|
|
2573
2944
|
/**
|
|
2945
|
+
* @public
|
|
2574
2946
|
* <p>The tag key-value pairs.</p>
|
|
2575
2947
|
*/
|
|
2576
2948
|
Tags: Tag[] | undefined;
|
|
@@ -2580,10 +2952,12 @@ export interface TagResourceRequest {
|
|
|
2580
2952
|
*/
|
|
2581
2953
|
export interface UntagResourceRequest {
|
|
2582
2954
|
/**
|
|
2955
|
+
* @public
|
|
2583
2956
|
* <p>The resource ARN.</p>
|
|
2584
2957
|
*/
|
|
2585
2958
|
ResourceARN: string | undefined;
|
|
2586
2959
|
/**
|
|
2960
|
+
* @public
|
|
2587
2961
|
* <p>The tag keys.</p>
|
|
2588
2962
|
*/
|
|
2589
2963
|
TagKeys: string[] | undefined;
|
|
@@ -2593,22 +2967,27 @@ export interface UntagResourceRequest {
|
|
|
2593
2967
|
*/
|
|
2594
2968
|
export interface UpdateChannelRequest {
|
|
2595
2969
|
/**
|
|
2970
|
+
* @public
|
|
2596
2971
|
* <p>The ARN of the channel.</p>
|
|
2597
2972
|
*/
|
|
2598
2973
|
ChannelArn: string | undefined;
|
|
2599
2974
|
/**
|
|
2975
|
+
* @public
|
|
2600
2976
|
* <p>The name of the channel.</p>
|
|
2601
2977
|
*/
|
|
2602
2978
|
Name?: string;
|
|
2603
2979
|
/**
|
|
2980
|
+
* @public
|
|
2604
2981
|
* <p>The mode of the update request.</p>
|
|
2605
2982
|
*/
|
|
2606
2983
|
Mode?: ChannelMode | string;
|
|
2607
2984
|
/**
|
|
2985
|
+
* @public
|
|
2608
2986
|
* <p>The metadata for the update request.</p>
|
|
2609
2987
|
*/
|
|
2610
2988
|
Metadata?: string;
|
|
2611
2989
|
/**
|
|
2990
|
+
* @public
|
|
2612
2991
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code>
|
|
2613
2992
|
* that makes the API call.</p>
|
|
2614
2993
|
*/
|
|
@@ -2619,6 +2998,7 @@ export interface UpdateChannelRequest {
|
|
|
2619
2998
|
*/
|
|
2620
2999
|
export interface UpdateChannelResponse {
|
|
2621
3000
|
/**
|
|
3001
|
+
* @public
|
|
2622
3002
|
* <p>The ARN of the channel.</p>
|
|
2623
3003
|
*/
|
|
2624
3004
|
ChannelArn?: string;
|
|
@@ -2628,14 +3008,17 @@ export interface UpdateChannelResponse {
|
|
|
2628
3008
|
*/
|
|
2629
3009
|
export interface UpdateChannelFlowRequest {
|
|
2630
3010
|
/**
|
|
3011
|
+
* @public
|
|
2631
3012
|
* <p>The ARN of the channel flow.</p>
|
|
2632
3013
|
*/
|
|
2633
3014
|
ChannelFlowArn: string | undefined;
|
|
2634
3015
|
/**
|
|
3016
|
+
* @public
|
|
2635
3017
|
* <p>Information about the processor Lambda functions </p>
|
|
2636
3018
|
*/
|
|
2637
3019
|
Processors: Processor[] | undefined;
|
|
2638
3020
|
/**
|
|
3021
|
+
* @public
|
|
2639
3022
|
* <p>The name of the channel flow.</p>
|
|
2640
3023
|
*/
|
|
2641
3024
|
Name: string | undefined;
|
|
@@ -2645,6 +3028,7 @@ export interface UpdateChannelFlowRequest {
|
|
|
2645
3028
|
*/
|
|
2646
3029
|
export interface UpdateChannelFlowResponse {
|
|
2647
3030
|
/**
|
|
3031
|
+
* @public
|
|
2648
3032
|
* <p>The ARN of the channel flow.</p>
|
|
2649
3033
|
*/
|
|
2650
3034
|
ChannelFlowArn?: string;
|
|
@@ -2654,27 +3038,33 @@ export interface UpdateChannelFlowResponse {
|
|
|
2654
3038
|
*/
|
|
2655
3039
|
export interface UpdateChannelMessageRequest {
|
|
2656
3040
|
/**
|
|
3041
|
+
* @public
|
|
2657
3042
|
* <p>The ARN of the channel.</p>
|
|
2658
3043
|
*/
|
|
2659
3044
|
ChannelArn: string | undefined;
|
|
2660
3045
|
/**
|
|
3046
|
+
* @public
|
|
2661
3047
|
* <p>The ID string of the message being updated.</p>
|
|
2662
3048
|
*/
|
|
2663
3049
|
MessageId: string | undefined;
|
|
2664
3050
|
/**
|
|
3051
|
+
* @public
|
|
2665
3052
|
* <p>The content of the channel message. </p>
|
|
2666
3053
|
*/
|
|
2667
3054
|
Content: string | undefined;
|
|
2668
3055
|
/**
|
|
3056
|
+
* @public
|
|
2669
3057
|
* <p>The metadata of the message being updated.</p>
|
|
2670
3058
|
*/
|
|
2671
3059
|
Metadata?: string;
|
|
2672
3060
|
/**
|
|
3061
|
+
* @public
|
|
2673
3062
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code>
|
|
2674
3063
|
* that makes the API call.</p>
|
|
2675
3064
|
*/
|
|
2676
3065
|
ChimeBearer: string | undefined;
|
|
2677
3066
|
/**
|
|
3067
|
+
* @public
|
|
2678
3068
|
* <p>The ID of the SubChannel in the request.</p>
|
|
2679
3069
|
* <note>
|
|
2680
3070
|
* <p>Only required when updating messages in a SubChannel that the user belongs to.</p>
|
|
@@ -2682,6 +3072,7 @@ export interface UpdateChannelMessageRequest {
|
|
|
2682
3072
|
*/
|
|
2683
3073
|
SubChannelId?: string;
|
|
2684
3074
|
/**
|
|
3075
|
+
* @public
|
|
2685
3076
|
* <p>The content type of the channel message.</p>
|
|
2686
3077
|
*/
|
|
2687
3078
|
ContentType?: string;
|
|
@@ -2691,18 +3082,22 @@ export interface UpdateChannelMessageRequest {
|
|
|
2691
3082
|
*/
|
|
2692
3083
|
export interface UpdateChannelMessageResponse {
|
|
2693
3084
|
/**
|
|
3085
|
+
* @public
|
|
2694
3086
|
* <p>The ARN of the channel.</p>
|
|
2695
3087
|
*/
|
|
2696
3088
|
ChannelArn?: string;
|
|
2697
3089
|
/**
|
|
3090
|
+
* @public
|
|
2698
3091
|
* <p>The ID string of the message being updated.</p>
|
|
2699
3092
|
*/
|
|
2700
3093
|
MessageId?: string;
|
|
2701
3094
|
/**
|
|
3095
|
+
* @public
|
|
2702
3096
|
* <p>The status of the message update.</p>
|
|
2703
3097
|
*/
|
|
2704
3098
|
Status?: ChannelMessageStatusStructure;
|
|
2705
3099
|
/**
|
|
3100
|
+
* @public
|
|
2706
3101
|
* <p>The ID of the SubChannel in the response.</p>
|
|
2707
3102
|
*/
|
|
2708
3103
|
SubChannelId?: string;
|
|
@@ -2712,10 +3107,12 @@ export interface UpdateChannelMessageResponse {
|
|
|
2712
3107
|
*/
|
|
2713
3108
|
export interface UpdateChannelReadMarkerRequest {
|
|
2714
3109
|
/**
|
|
3110
|
+
* @public
|
|
2715
3111
|
* <p>The ARN of the channel.</p>
|
|
2716
3112
|
*/
|
|
2717
3113
|
ChannelArn: string | undefined;
|
|
2718
3114
|
/**
|
|
3115
|
+
* @public
|
|
2719
3116
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code>
|
|
2720
3117
|
* that makes the API call.</p>
|
|
2721
3118
|
*/
|
|
@@ -2726,6 +3123,7 @@ export interface UpdateChannelReadMarkerRequest {
|
|
|
2726
3123
|
*/
|
|
2727
3124
|
export interface UpdateChannelReadMarkerResponse {
|
|
2728
3125
|
/**
|
|
3126
|
+
* @public
|
|
2729
3127
|
* <p>The ARN of the channel.</p>
|
|
2730
3128
|
*/
|
|
2731
3129
|
ChannelArn?: string;
|