-
Notifications
You must be signed in to change notification settings - Fork 2.1k
/
docs-2.json
1441 lines (1441 loc) · 81.5 KB
/
docs-2.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"version": "2.0",
"service": "<p>The Amazon Chime SDK Messaging APIs in this section allow software developers to send and receive messages in custom messaging applications. These APIs depend on the frameworks provided by the Amazon Chime SDK Identity APIs. For more information about the messaging APIs, see <a href=\"https://docs.aws.amazon.com/chime/latest/APIReference/API_Operations_Amazon_Chime_SDK_Messaging.html\">Amazon Chime SDK messaging</a>.</p>",
"operations": {
"AssociateChannelFlow": "<p>Associates a channel flow with a channel. Once associated, all messages to that channel go through channel flow processors. To stop processing, use the <code>DisassociateChannelFlow</code> API.</p> <note> <p>Only administrators or channel moderators can associate a channel flow. The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>",
"BatchCreateChannelMembership": "<p>Adds a specified number of users to a channel. </p>",
"ChannelFlowCallback": "<p>Calls back Chime SDK Messaging with a processing response message. This should be invoked from the processor Lambda. This is a developer API.</p> <p>You can return one of the following processing responses:</p> <ul> <li> <p>Update message content or metadata</p> </li> <li> <p>Deny a message</p> </li> <li> <p>Make no changes to the message</p> </li> </ul>",
"CreateChannel": "<p>Creates a channel to which you can add users and send messages.</p> <p> <b>Restriction</b>: You can't change a channel's privacy.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>",
"CreateChannelBan": "<p>Permanently bans a member from a channel. Moderators can't add banned members to a channel. To undo a ban, you first have to <code>DeleteChannelBan</code>, and then <code>CreateChannelMembership</code>. Bans are cleaned up when you delete users or channels.</p> <p>If you ban a user who is already part of a channel, that user is automatically kicked from the channel.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>",
"CreateChannelFlow": "<p>Creates a channel flow, a container for processors. Processors are AWS Lambda functions that perform actions on chat messages, such as stripping out profanity. You can associate channel flows with channels, and the processors in the channel flow then take action on all messages sent to that channel. This is a developer API.</p> <p>Channel flows process the following items:</p> <ol> <li> <p>New and updated messages</p> </li> <li> <p>Persistent and non-persistent messages</p> </li> <li> <p>The Standard message type</p> </li> </ol> <note> <p>Channel flows don't process Control or System messages. For more information about the message types provided by Chime SDK Messaging, refer to <a href=\"https://docs.aws.amazon.com/chime/latest/dg/using-the-messaging-sdk.html#msg-types\">Message types</a> in the <i>Amazon Chime developer guide</i>.</p> </note>",
"CreateChannelMembership": "<p>Adds a user to a channel. The <code>InvitedBy</code> field in <code>ChannelMembership</code> is derived from the request header. A channel member can:</p> <ul> <li> <p>List messages</p> </li> <li> <p>Send messages</p> </li> <li> <p>Receive messages</p> </li> <li> <p>Edit their own messages</p> </li> <li> <p>Leave the channel</p> </li> </ul> <p>Privacy settings impact this action as follows:</p> <ul> <li> <p>Public Channels: You do not need to be a member to list messages, but you must be a member to send messages.</p> </li> <li> <p>Private Channels: You must be a member to list or send messages.</p> </li> </ul> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>",
"CreateChannelModerator": "<p>Creates a new <code>ChannelModerator</code>. A channel moderator can:</p> <ul> <li> <p>Add and remove other members of the channel.</p> </li> <li> <p>Add and remove other moderators of the channel.</p> </li> <li> <p>Add and remove user bans for the channel.</p> </li> <li> <p>Redact messages in the channel.</p> </li> <li> <p>List messages in the channel.</p> </li> </ul> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>",
"DeleteChannel": "<p>Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>",
"DeleteChannelBan": "<p>Removes a user from a channel's ban list.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>",
"DeleteChannelFlow": "<p>Deletes a channel flow, an irreversible process. This is a developer API.</p> <note> <p> This API works only when the channel flow is not associated with any channel. To get a list of all channels that a channel flow is associated with, use the <code>ListChannelsAssociatedWithChannelFlow</code> API. Use the <code>DisassociateChannelFlow</code> API to disassociate a channel flow from all channels. </p> </note>",
"DeleteChannelMembership": "<p>Removes a member from a channel.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>",
"DeleteChannelMessage": "<p>Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately. A background process deletes any revisions created by <code>UpdateChannelMessage</code>.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>",
"DeleteChannelModerator": "<p>Deletes a channel moderator.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>",
"DescribeChannel": "<p>Returns the full details of a channel in an Amazon Chime <code>AppInstance</code>.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>",
"DescribeChannelBan": "<p>Returns the full details of a channel ban.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>",
"DescribeChannelFlow": "<p>Returns the full details of a channel flow in an Amazon Chime <code>AppInstance</code>. This is a developer API.</p>",
"DescribeChannelMembership": "<p>Returns the full details of a user's channel membership.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>",
"DescribeChannelMembershipForAppInstanceUser": "<p> Returns the details of a channel based on the membership of the specified <code>AppInstanceUser</code>.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>",
"DescribeChannelModeratedByAppInstanceUser": "<p>Returns the full details of a channel moderated by the specified <code>AppInstanceUser</code>.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>",
"DescribeChannelModerator": "<p>Returns the full details of a single ChannelModerator.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>",
"DisassociateChannelFlow": "<p>Disassociates a channel flow from all its channels. Once disassociated, all messages to that channel stop going through the channel flow processor.</p> <note> <p>Only administrators or channel moderators can disassociate a channel flow. The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>",
"GetChannelMembershipPreferences": "<p>Gets the membership preferences of an <code>AppInstanceUser</code> for the specified channel. The <code>AppInstanceUser</code> must be a member of the channel. Only the <code>AppInstanceUser</code> who owns the membership can retrieve preferences. Users in the <code>AppInstanceAdmin</code> and channel moderator roles can't retrieve preferences for other users. Banned users can't retrieve membership preferences for the channel from which they are banned.</p>",
"GetChannelMessage": "<p>Gets the full details of a channel message.</p> <note> <p>The x-amz-chime-bearer request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>",
"GetChannelMessageStatus": "<p>Gets message status for a specified <code>messageId</code>. Use this API to determine the intermediate status of messages going through channel flow processing. The API provides an alternative to retrieving message status if the event was not received because a client wasn't connected to a websocket. </p> <p>Messages can have any one of these statuses.</p> <dl> <dt>SENT</dt> <dd> <p>Message processed successfully</p> </dd> <dt>PENDING</dt> <dd> <p>Ongoing processing</p> </dd> <dt>FAILED</dt> <dd> <p>Processing failed</p> </dd> <dt>DENIED</dt> <dd> <p>Messasge denied by the processor</p> </dd> </dl> <note> <ul> <li> <p>This API does not return statuses for denied messages, because we don't store them once the processor denies them. </p> </li> <li> <p>Only the message sender can invoke this API.</p> </li> <li> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header</p> </li> </ul> </note>",
"GetMessagingSessionEndpoint": "<p>The details of the endpoint for the messaging session.</p>",
"ListChannelBans": "<p>Lists all the users banned from a particular channel.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>",
"ListChannelFlows": "<p>Returns a paginated lists of all the channel flows created under a single Chime. This is a developer API.</p>",
"ListChannelMemberships": "<p>Lists all channel memberships in a channel.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note> <p>If you want to list the channels to which a specific app instance user belongs, see the <a href=\"https://docs.aws.amazon.com/chime/latest/APIReference/API_messaging-chime_ListChannelMembershipsForAppInstanceUser.html\">ListChannelMembershipsForAppInstanceUser</a> API.</p>",
"ListChannelMembershipsForAppInstanceUser": "<p> Lists all channels that a particular <code>AppInstanceUser</code> is a part of. Only an <code>AppInstanceAdmin</code> can call the API with a user ARN that is not their own. </p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>",
"ListChannelMessages": "<p>List all the messages in a channel. Returns a paginated list of <code>ChannelMessages</code>. By default, sorted by creation timestamp in descending order.</p> <note> <p>Redacted messages appear in the results as empty, since they are only redacted, not deleted. Deleted messages do not appear in the results. This action always returns the latest version of an edited message.</p> <p>Also, the x-amz-chime-bearer request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>",
"ListChannelModerators": "<p>Lists all the moderators for a channel.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>",
"ListChannels": "<p>Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results.</p> <p class=\"title\"> <b>Functionality & restrictions</b> </p> <ul> <li> <p>Use privacy = <code>PUBLIC</code> to retrieve all public channels in the account.</p> </li> <li> <p>Only an <code>AppInstanceAdmin</code> can set privacy = <code>PRIVATE</code> to list the private channels in an account.</p> </li> </ul> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>",
"ListChannelsAssociatedWithChannelFlow": "<p>Lists all channels associated with a specified channel flow. You can associate a channel flow with multiple channels, but you can only associate a channel with one channel flow. This is a developer API.</p>",
"ListChannelsModeratedByAppInstanceUser": "<p>A list of the channels moderated by an <code>AppInstanceUser</code>.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>",
"ListSubChannels": "<p>Lists all the SubChannels in an elastic channel when given a channel ID. Available only to the app instance admins and channel moderators of elastic channels.</p>",
"ListTagsForResource": "<p>Lists the tags applied to an Amazon Chime SDK messaging resource.</p>",
"PutChannelMembershipPreferences": "<p>Sets the membership preferences of an <code>AppInstanceUser</code> for the specified channel. The <code>AppInstanceUser</code> must be a member of the channel. Only the <code>AppInstanceUser</code> who owns the membership can set preferences. Users in the <code>AppInstanceAdmin</code> and channel moderator roles can't set preferences for other users. Banned users can't set membership preferences for the channel from which they are banned.</p>",
"RedactChannelMessage": "<p>Redacts message content, but not metadata. The message exists in the back end, but the action returns null content, and the state shows as redacted.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>",
"SearchChannels": "<p>Allows <code>ChimeBearer</code> to search channels by channel members. AppInstanceUsers can search across the channels that they belong to. AppInstanceAdmins can search across all channels.</p>",
"SendChannelMessage": "<p>Sends a message to a particular channel that the member is a part of.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> <p>Also, <code>STANDARD</code> messages can contain 4KB of data and the 1KB of metadata. <code>CONTROL</code> messages can contain 30 bytes of data and no metadata.</p> </note>",
"TagResource": "<p>Applies the specified tags to the specified Amazon Chime SDK messaging resource.</p>",
"UntagResource": "<p>Removes the specified tags from the specified Amazon Chime SDK messaging resource.</p>",
"UpdateChannel": "<p>Update a channel's attributes.</p> <p> <b>Restriction</b>: You can't change a channel's privacy. </p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>",
"UpdateChannelFlow": "<p>Updates channel flow attributes. This is a developer API.</p>",
"UpdateChannelMessage": "<p>Updates the content of a message.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>",
"UpdateChannelReadMarker": "<p>The details of the time when a user last read messages in a channel.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>"
},
"shapes": {
"AllowNotifications": {
"base": null,
"refs": {
"PushNotificationPreferences$AllowNotifications": "<p>Enum value that indicates which push notifications to send to the requested member of a channel. <code>ALL</code> sends all push notifications, <code>NONE</code> sends no push notifications, <code>FILTERED</code> sends only filtered push notifications. </p>"
}
},
"AppInstanceUserMembershipSummary": {
"base": "<p>Summary of the membership details of an <code>AppInstanceUser</code>.</p>",
"refs": {
"ChannelMembershipForAppInstanceUserSummary$AppInstanceUserMembershipSummary": "<p>Returns the channel membership data for an <code>AppInstance</code>.</p>"
}
},
"AssociateChannelFlowRequest": {
"base": null,
"refs": {
}
},
"BadRequestException": {
"base": "<p>The input parameters don't match the service's restrictions.</p>",
"refs": {
}
},
"BatchChannelMemberships": {
"base": "<p>The membership information, including member ARNs, the channel ARN, and membership types.</p>",
"refs": {
"BatchCreateChannelMembershipResponse$BatchChannelMemberships": "<p>The list of channel memberships in the response.</p>"
}
},
"BatchCreateChannelMembershipError": {
"base": "<p>A list of failed member ARNs, error codes, and error messages.</p>",
"refs": {
"BatchCreateChannelMembershipErrors$member": null
}
},
"BatchCreateChannelMembershipErrors": {
"base": null,
"refs": {
"BatchCreateChannelMembershipResponse$Errors": "<p>If the action fails for one or more of the memberships in the request, a list of the memberships is returned, along with error codes and error messages.</p>"
}
},
"BatchCreateChannelMembershipRequest": {
"base": null,
"refs": {
}
},
"BatchCreateChannelMembershipResponse": {
"base": null,
"refs": {
}
},
"CallbackIdType": {
"base": null,
"refs": {
"ChannelFlowCallbackRequest$CallbackId": "<p>The identifier passed to the processor by the service when invoked. Use the identifier to call back the service.</p>",
"ChannelFlowCallbackResponse$CallbackId": "<p>The call back ID passed in the request.</p>"
}
},
"Channel": {
"base": "<p>The details of a channel.</p>",
"refs": {
"DescribeChannelResponse$Channel": "<p>The channel details.</p>"
}
},
"ChannelAssociatedWithFlowSummary": {
"base": "<p>Summary of details of a channel associated with channel flow.</p>",
"refs": {
"ChannelAssociatedWithFlowSummaryList$member": null
}
},
"ChannelAssociatedWithFlowSummaryList": {
"base": null,
"refs": {
"ListChannelsAssociatedWithChannelFlowResponse$Channels": "<p>The information about each channel.</p>"
}
},
"ChannelBan": {
"base": "<p>The details of a channel ban.</p>",
"refs": {
"DescribeChannelBanResponse$ChannelBan": "<p>The details of the ban.</p>"
}
},
"ChannelBanSummary": {
"base": "<p>Summary of the details of a <code>ChannelBan</code>.</p>",
"refs": {
"ChannelBanSummaryList$member": null
}
},
"ChannelBanSummaryList": {
"base": null,
"refs": {
"ListChannelBansResponse$ChannelBans": "<p>The information for each requested ban.</p>"
}
},
"ChannelFlow": {
"base": "<p>The details of a channel flow.</p>",
"refs": {
"DescribeChannelFlowResponse$ChannelFlow": "<p>The channel flow details.</p>"
}
},
"ChannelFlowCallbackRequest": {
"base": null,
"refs": {
}
},
"ChannelFlowCallbackResponse": {
"base": null,
"refs": {
}
},
"ChannelFlowExecutionOrder": {
"base": null,
"refs": {
"Processor$ExecutionOrder": "<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. At this point, we support only 1 processor within a flow.</p>"
}
},
"ChannelFlowSummary": {
"base": "<p>Summary of details of a channel flow.</p>",
"refs": {
"ChannelFlowSummaryList$member": null
}
},
"ChannelFlowSummaryList": {
"base": null,
"refs": {
"ListChannelFlowsResponse$ChannelFlows": "<p>The information about each channel flow.</p>"
}
},
"ChannelId": {
"base": null,
"refs": {
"CreateChannelRequest$ChannelId": "<p>The ID of the channel in the request.</p>"
}
},
"ChannelMemberArns": {
"base": null,
"refs": {
"CreateChannelRequest$MemberArns": "<p>The ARNs of the channel members in the request.</p>"
}
},
"ChannelMembership": {
"base": "<p>The details of a channel member.</p>",
"refs": {
"DescribeChannelMembershipResponse$ChannelMembership": "<p>The details of the membership.</p>"
}
},
"ChannelMembershipForAppInstanceUserSummary": {
"base": "<p>Summary of the channel membership details of an <code>AppInstanceUser</code>.</p>",
"refs": {
"ChannelMembershipForAppInstanceUserSummaryList$member": null,
"DescribeChannelMembershipForAppInstanceUserResponse$ChannelMembership": "<p>The channel to which a user belongs.</p>"
}
},
"ChannelMembershipForAppInstanceUserSummaryList": {
"base": null,
"refs": {
"ListChannelMembershipsForAppInstanceUserResponse$ChannelMemberships": "<p>The information for the requested channel memberships.</p>"
}
},
"ChannelMembershipPreferences": {
"base": "<p>The channel membership preferences for an <code>AppInstanceUser</code>.</p>",
"refs": {
"GetChannelMembershipPreferencesResponse$Preferences": "<p>The channel membership preferences for an <code>AppInstanceUser</code> .</p>",
"PutChannelMembershipPreferencesRequest$Preferences": "<p>The channel membership preferences of an <code>AppInstanceUser</code> .</p>",
"PutChannelMembershipPreferencesResponse$Preferences": "<p>The ARN and metadata of the member being added.</p>"
}
},
"ChannelMembershipSummary": {
"base": "<p>Summary of the details of a <code>ChannelMembership</code>.</p>",
"refs": {
"ChannelMembershipSummaryList$member": null
}
},
"ChannelMembershipSummaryList": {
"base": null,
"refs": {
"ListChannelMembershipsResponse$ChannelMemberships": "<p>The information for the requested channel memberships.</p>"
}
},
"ChannelMembershipType": {
"base": null,
"refs": {
"AppInstanceUserMembershipSummary$Type": "<p>The type of <code>ChannelMembership</code>.</p>",
"BatchChannelMemberships$Type": "<p>The membership types set for the channel users.</p>",
"BatchCreateChannelMembershipRequest$Type": "<p>The membership type of a user, <code>DEFAULT</code> or <code>HIDDEN</code>. Default members are always returned as part of <code>ListChannelMemberships</code>. Hidden members are only returned if the type filter in <code>ListChannelMemberships</code> equals <code>HIDDEN</code>. Otherwise hidden members are not returned. This is only supported by moderators.</p>",
"ChannelMembership$Type": "<p>The membership type set for the channel member.</p>",
"CreateChannelMembershipRequest$Type": "<p>The membership type of a user, <code>DEFAULT</code> or <code>HIDDEN</code>. Default members are always returned as part of <code>ListChannelMemberships</code>. Hidden members are only returned if the type filter in <code>ListChannelMemberships</code> equals <code>HIDDEN</code>. Otherwise hidden members are not returned. This is only supported by moderators.</p>",
"ListChannelMembershipsRequest$Type": "<p>The membership type of a user, <code>DEFAULT</code> or <code>HIDDEN</code>. Default members are returned as part of <code>ListChannelMemberships</code> if no type is specified. Hidden members are only returned if the type filter in <code>ListChannelMemberships</code> equals <code>HIDDEN</code>.</p>"
}
},
"ChannelMessage": {
"base": "<p>The details of a message in a channel.</p>",
"refs": {
"GetChannelMessageResponse$ChannelMessage": "<p>The details of and content in the message.</p>"
}
},
"ChannelMessageCallback": {
"base": "<p>Stores information about a callback.</p>",
"refs": {
"ChannelFlowCallbackRequest$ChannelMessage": "<p>Stores information about the processed message.</p>"
}
},
"ChannelMessagePersistenceType": {
"base": null,
"refs": {
"ChannelMessage$Persistence": "<p>The persistence setting for a channel message.</p>",
"SendChannelMessageRequest$Persistence": "<p>Boolean that controls whether the message is persisted on the back end. Required.</p>"
}
},
"ChannelMessageStatus": {
"base": null,
"refs": {
"ChannelMessageStatusStructure$Value": "<p>The message status value.</p>"
}
},
"ChannelMessageStatusStructure": {
"base": "<p>Stores information about a message status.</p>",
"refs": {
"ChannelMessage$Status": "<p>The status of the channel message.</p>",
"ChannelMessageSummary$Status": "<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 processing stage.</p>",
"GetChannelMessageStatusResponse$Status": "<p>The message status and details.</p>",
"SendChannelMessageResponse$Status": "<p>The status of the channel message.</p>",
"UpdateChannelMessageResponse$Status": "<p>The status of the message update.</p>"
}
},
"ChannelMessageSummary": {
"base": "<p>Summary of the messages in a <code>Channel</code>.</p>",
"refs": {
"ChannelMessageSummaryList$member": null
}
},
"ChannelMessageSummaryList": {
"base": null,
"refs": {
"ListChannelMessagesResponse$ChannelMessages": "<p>The information about, and content of, each requested message.</p>"
}
},
"ChannelMessageType": {
"base": null,
"refs": {
"ChannelMessage$Type": "<p>The message type.</p>",
"ChannelMessageSummary$Type": "<p>The type of message.</p>",
"SendChannelMessageRequest$Type": "<p>The type of message, <code>STANDARD</code> or <code>CONTROL</code>.</p>"
}
},
"ChannelMode": {
"base": null,
"refs": {
"Channel$Mode": "<p>The mode of the channel.</p>",
"ChannelAssociatedWithFlowSummary$Mode": "<p>The mode of the channel.</p>",
"ChannelSummary$Mode": "<p>The mode of the channel.</p>",
"CreateChannelRequest$Mode": "<p>The channel mode: <code>UNRESTRICTED</code> or <code>RESTRICTED</code>. Administrators, moderators, and channel members can add themselves and other members to unrestricted channels. Only administrators and moderators can add members to restricted channels.</p>",
"UpdateChannelRequest$Mode": "<p>The mode of the update request.</p>"
}
},
"ChannelModeratedByAppInstanceUserSummary": {
"base": "<p>Summary of the details of a moderated channel.</p>",
"refs": {
"ChannelModeratedByAppInstanceUserSummaryList$member": null,
"DescribeChannelModeratedByAppInstanceUserResponse$Channel": "<p>The moderated channel.</p>"
}
},
"ChannelModeratedByAppInstanceUserSummaryList": {
"base": null,
"refs": {
"ListChannelsModeratedByAppInstanceUserResponse$Channels": "<p>The moderated channels in the request.</p>"
}
},
"ChannelModerator": {
"base": "<p>The details of a channel moderator.</p>",
"refs": {
"DescribeChannelModeratorResponse$ChannelModerator": "<p>The details of the channel moderator.</p>"
}
},
"ChannelModeratorArns": {
"base": null,
"refs": {
"CreateChannelRequest$ModeratorArns": "<p>The ARNs of the channel moderators in the request.</p>"
}
},
"ChannelModeratorSummary": {
"base": "<p>Summary of the details of a <code>ChannelModerator</code>.</p>",
"refs": {
"ChannelModeratorSummaryList$member": null
}
},
"ChannelModeratorSummaryList": {
"base": null,
"refs": {
"ListChannelModeratorsResponse$ChannelModerators": "<p>The information about and names of each moderator.</p>"
}
},
"ChannelPrivacy": {
"base": null,
"refs": {
"Channel$Privacy": "<p>The channel's privacy setting.</p>",
"ChannelAssociatedWithFlowSummary$Privacy": "<p>The channel's privacy setting.</p>",
"ChannelSummary$Privacy": "<p>The privacy setting of the channel.</p>",
"CreateChannelRequest$Privacy": "<p>The channel's privacy level: <code>PUBLIC</code> or <code>PRIVATE</code>. Private channels aren't discoverable by users outside the channel. Public channels are discoverable by anyone in the <code>AppInstance</code>.</p>",
"ListChannelsRequest$Privacy": "<p>The privacy setting. <code>PUBLIC</code> retrieves all the public channels. <code>PRIVATE</code> retrieves private channels. Only an <code>AppInstanceAdmin</code> can retrieve private channels. </p>"
}
},
"ChannelSummary": {
"base": "<p>Summary of the details of a <code>Channel</code>.</p>",
"refs": {
"ChannelMembershipForAppInstanceUserSummary$ChannelSummary": "<p>Returns the channel data for an <code>AppInstance</code>.</p>",
"ChannelModeratedByAppInstanceUserSummary$ChannelSummary": "<p>Summary of the details of a <code>Channel</code>.</p>",
"ChannelSummaryList$member": null
}
},
"ChannelSummaryList": {
"base": null,
"refs": {
"ListChannelsResponse$Channels": "<p>The information about each channel.</p>",
"SearchChannelsResponse$Channels": "<p>A list of the channels in the request.</p>"
}
},
"ChimeArn": {
"base": null,
"refs": {
"AssociateChannelFlowRequest$ChannelArn": "<p>The ARN of the channel.</p>",
"AssociateChannelFlowRequest$ChannelFlowArn": "<p>The ARN of the channel flow.</p>",
"AssociateChannelFlowRequest$ChimeBearer": "<p>The <code>AppInstanceUserArn</code> of the user making the API call.</p>",
"BatchChannelMemberships$ChannelArn": "<p>The ARN of the channel to which you're adding users.</p>",
"BatchCreateChannelMembershipError$MemberArn": "<p>The <code>AppInstanceUserArn</code> of the member that the service couldn't add.</p>",
"BatchCreateChannelMembershipRequest$ChannelArn": "<p>The ARN of the channel to which you're adding users.</p>",
"BatchCreateChannelMembershipRequest$ChimeBearer": "<p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>",
"Channel$ChannelArn": "<p>The ARN of a channel.</p>",
"Channel$ChannelFlowArn": "<p>The ARN of the channel flow.</p>",
"ChannelAssociatedWithFlowSummary$ChannelArn": "<p>The ARN of the channel.</p>",
"ChannelBan$ChannelArn": "<p>The ARN of the channel from which a member is being banned.</p>",
"ChannelFlow$ChannelFlowArn": "<p>The ARN of the channel flow.</p>",
"ChannelFlowCallbackRequest$ChannelArn": "<p>The ARN of the channel.</p>",
"ChannelFlowCallbackResponse$ChannelArn": "<p>The ARN of the channel.</p>",
"ChannelFlowSummary$ChannelFlowArn": "<p>The ARN of the channel flow.</p>",
"ChannelMemberArns$member": null,
"ChannelMembership$ChannelArn": "<p>The ARN of the member's channel.</p>",
"ChannelMessage$ChannelArn": "<p>The ARN of the channel.</p>",
"ChannelModerator$ChannelArn": "<p>The ARN of the moderator's channel.</p>",
"ChannelModeratorArns$member": null,
"ChannelSummary$ChannelArn": "<p>The ARN of the channel.</p>",
"CreateChannelBanRequest$ChannelArn": "<p>The ARN of the ban request.</p>",
"CreateChannelBanRequest$MemberArn": "<p>The <code>AppInstanceUserArn</code> of the member being banned.</p>",
"CreateChannelBanRequest$ChimeBearer": "<p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>",
"CreateChannelBanResponse$ChannelArn": "<p>The ARN of the response to the ban request.</p>",
"CreateChannelFlowRequest$AppInstanceArn": "<p>The ARN of the channel flow request.</p>",
"CreateChannelFlowResponse$ChannelFlowArn": "<p>The ARN of the channel flow.</p>",
"CreateChannelMembershipRequest$ChannelArn": "<p>The ARN of the channel to which you're adding users.</p>",
"CreateChannelMembershipRequest$MemberArn": "<p>The <code>AppInstanceUserArn</code> of the member you want to add to the channel.</p>",
"CreateChannelMembershipRequest$ChimeBearer": "<p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>",
"CreateChannelMembershipResponse$ChannelArn": "<p>The ARN of the channel.</p>",
"CreateChannelModeratorRequest$ChannelArn": "<p>The ARN of the channel.</p>",
"CreateChannelModeratorRequest$ChannelModeratorArn": "<p>The <code>AppInstanceUserArn</code> of the moderator.</p>",
"CreateChannelModeratorRequest$ChimeBearer": "<p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>",
"CreateChannelModeratorResponse$ChannelArn": "<p>The ARN of the channel.</p>",
"CreateChannelRequest$AppInstanceArn": "<p>The ARN of the channel request.</p>",
"CreateChannelRequest$ChimeBearer": "<p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>",
"CreateChannelResponse$ChannelArn": "<p>The ARN of the channel.</p>",
"DeleteChannelBanRequest$ChannelArn": "<p>The ARN of the channel from which the <code>AppInstanceUser</code> was banned.</p>",
"DeleteChannelBanRequest$MemberArn": "<p>The ARN of the <code>AppInstanceUser</code> that you want to reinstate.</p>",
"DeleteChannelBanRequest$ChimeBearer": "<p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>",
"DeleteChannelFlowRequest$ChannelFlowArn": "<p>The ARN of the channel flow.</p>",
"DeleteChannelMembershipRequest$ChannelArn": "<p>The ARN of the channel from which you want to remove the user.</p>",
"DeleteChannelMembershipRequest$MemberArn": "<p>The <code>AppInstanceUserArn</code> of the member that you're removing from the channel.</p>",
"DeleteChannelMembershipRequest$ChimeBearer": "<p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>",
"DeleteChannelMessageRequest$ChannelArn": "<p>The ARN of the channel.</p>",
"DeleteChannelMessageRequest$ChimeBearer": "<p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>",
"DeleteChannelModeratorRequest$ChannelArn": "<p>The ARN of the channel.</p>",
"DeleteChannelModeratorRequest$ChannelModeratorArn": "<p>The <code>AppInstanceUserArn</code> of the moderator being deleted.</p>",
"DeleteChannelModeratorRequest$ChimeBearer": "<p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>",
"DeleteChannelRequest$ChannelArn": "<p>The ARN of the channel being deleted.</p>",
"DeleteChannelRequest$ChimeBearer": "<p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>",
"DescribeChannelBanRequest$ChannelArn": "<p>The ARN of the channel from which the user is banned.</p>",
"DescribeChannelBanRequest$MemberArn": "<p>The <code>AppInstanceUserArn</code> of the member being banned.</p>",
"DescribeChannelBanRequest$ChimeBearer": "<p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>",
"DescribeChannelFlowRequest$ChannelFlowArn": "<p>The ARN of the channel flow.</p>",
"DescribeChannelMembershipForAppInstanceUserRequest$ChannelArn": "<p>The ARN of the channel to which the user belongs.</p>",
"DescribeChannelMembershipForAppInstanceUserRequest$AppInstanceUserArn": "<p>The ARN of the user in a channel.</p>",
"DescribeChannelMembershipForAppInstanceUserRequest$ChimeBearer": "<p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>",
"DescribeChannelMembershipRequest$ChannelArn": "<p>The ARN of the channel.</p>",
"DescribeChannelMembershipRequest$MemberArn": "<p>The <code>AppInstanceUserArn</code> of the member.</p>",
"DescribeChannelMembershipRequest$ChimeBearer": "<p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>",
"DescribeChannelModeratedByAppInstanceUserRequest$ChannelArn": "<p>The ARN of the moderated channel.</p>",
"DescribeChannelModeratedByAppInstanceUserRequest$AppInstanceUserArn": "<p>The ARN of the <code>AppInstanceUser</code> in the moderated channel.</p>",
"DescribeChannelModeratedByAppInstanceUserRequest$ChimeBearer": "<p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>",
"DescribeChannelModeratorRequest$ChannelArn": "<p>The ARN of the channel.</p>",
"DescribeChannelModeratorRequest$ChannelModeratorArn": "<p>The <code>AppInstanceUserArn</code> of the channel moderator.</p>",
"DescribeChannelModeratorRequest$ChimeBearer": "<p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>",
"DescribeChannelRequest$ChannelArn": "<p>The ARN of the channel.</p>",
"DescribeChannelRequest$ChimeBearer": "<p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>",
"DisassociateChannelFlowRequest$ChannelArn": "<p>The ARN of the channel.</p>",
"DisassociateChannelFlowRequest$ChannelFlowArn": "<p>The ARN of the channel flow.</p>",
"DisassociateChannelFlowRequest$ChimeBearer": "<p>The <code>AppInstanceUserArn</code> of the user making the API call.</p>",
"GetChannelMembershipPreferencesRequest$ChannelArn": "<p>The ARN of the channel.</p>",
"GetChannelMembershipPreferencesRequest$MemberArn": "<p>The <code>AppInstanceUserArn</code> of the member retrieving the preferences.</p>",
"GetChannelMembershipPreferencesRequest$ChimeBearer": "<p>The <code>AppInstanceUserARN</code> of the user making the API call.</p>",
"GetChannelMembershipPreferencesResponse$ChannelArn": "<p>The ARN of the channel.</p>",
"GetChannelMessageRequest$ChannelArn": "<p>The ARN of the channel.</p>",
"GetChannelMessageRequest$ChimeBearer": "<p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>",
"GetChannelMessageStatusRequest$ChannelArn": "<p>The ARN of the channel</p>",
"GetChannelMessageStatusRequest$ChimeBearer": "<p>The <code>AppInstanceUserArn</code> of the user making the API call.</p>",
"Identity$Arn": "<p>The ARN in an Identity.</p>",
"ListChannelBansRequest$ChannelArn": "<p>The ARN of the channel.</p>",
"ListChannelBansRequest$ChimeBearer": "<p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>",
"ListChannelBansResponse$ChannelArn": "<p>The ARN of the channel.</p>",
"ListChannelFlowsRequest$AppInstanceArn": "<p>The ARN of the app instance.</p>",
"ListChannelMembershipsForAppInstanceUserRequest$AppInstanceUserArn": "<p>The ARN of the <code>AppInstanceUser</code>s</p>",
"ListChannelMembershipsForAppInstanceUserRequest$ChimeBearer": "<p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>",
"ListChannelMembershipsRequest$ChannelArn": "<p>The maximum number of channel memberships that you want returned.</p>",
"ListChannelMembershipsRequest$ChimeBearer": "<p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>",
"ListChannelMembershipsResponse$ChannelArn": "<p>The ARN of the channel.</p>",
"ListChannelMessagesRequest$ChannelArn": "<p>The ARN of the channel.</p>",
"ListChannelMessagesRequest$ChimeBearer": "<p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>",
"ListChannelMessagesResponse$ChannelArn": "<p>The ARN of the channel containing the requested messages.</p>",
"ListChannelModeratorsRequest$ChannelArn": "<p>The ARN of the channel.</p>",
"ListChannelModeratorsRequest$ChimeBearer": "<p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>",
"ListChannelModeratorsResponse$ChannelArn": "<p>The ARN of the channel.</p>",
"ListChannelsAssociatedWithChannelFlowRequest$ChannelFlowArn": "<p>The ARN of the channel flow.</p>",
"ListChannelsModeratedByAppInstanceUserRequest$AppInstanceUserArn": "<p>The ARN of the user in the moderated channel.</p>",
"ListChannelsModeratedByAppInstanceUserRequest$ChimeBearer": "<p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>",
"ListChannelsRequest$AppInstanceArn": "<p>The ARN of the <code>AppInstance</code>.</p>",
"ListChannelsRequest$ChimeBearer": "<p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>",
"ListSubChannelsRequest$ChannelArn": "<p>The ARN of elastic channel.</p>",
"ListSubChannelsRequest$ChimeBearer": "<p>The <code>AppInstanceUserArn</code> of the user making the API call.</p>",
"ListSubChannelsResponse$ChannelArn": "<p>The ARN of elastic channel.</p>",
"ListTagsForResourceRequest$ResourceARN": "<p>The ARN of the resource.</p>",
"MemberArns$member": null,
"PutChannelMembershipPreferencesRequest$ChannelArn": "<p>The ARN of the channel.</p>",
"PutChannelMembershipPreferencesRequest$MemberArn": "<p>The <code>AppInstanceUserArn</code> of the member setting the preferences.</p>",
"PutChannelMembershipPreferencesRequest$ChimeBearer": "<p>The <code>AppInstanceUserARN</code> of the user making the API call.</p>",
"PutChannelMembershipPreferencesResponse$ChannelArn": "<p>The ARN of the channel.</p>",
"RedactChannelMessageRequest$ChannelArn": "<p>The ARN of the channel containing the messages that you want to redact.</p>",
"RedactChannelMessageRequest$ChimeBearer": "<p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>",
"RedactChannelMessageResponse$ChannelArn": "<p>The ARN of the channel containing the messages that you want to redact.</p>",
"SearchChannelsRequest$ChimeBearer": "<p>The <code>AppInstanceUserArn</code> of the user making the API call.</p>",
"SendChannelMessageRequest$ChannelArn": "<p>The ARN of the channel.</p>",
"SendChannelMessageRequest$ChimeBearer": "<p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>",
"SendChannelMessageResponse$ChannelArn": "<p>The ARN of the channel.</p>",
"TagResourceRequest$ResourceARN": "<p>The resource ARN.</p>",
"UntagResourceRequest$ResourceARN": "<p>The resource ARN.</p>",
"UpdateChannelFlowRequest$ChannelFlowArn": "<p>The ARN of the channel flow.</p>",
"UpdateChannelFlowResponse$ChannelFlowArn": "<p>The ARN of the channel flow.</p>",
"UpdateChannelMessageRequest$ChannelArn": "<p>The ARN of the channel.</p>",
"UpdateChannelMessageRequest$ChimeBearer": "<p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>",
"UpdateChannelMessageResponse$ChannelArn": "<p>The ARN of the channel.</p>",
"UpdateChannelReadMarkerRequest$ChannelArn": "<p>The ARN of the channel.</p>",
"UpdateChannelReadMarkerRequest$ChimeBearer": "<p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>",
"UpdateChannelReadMarkerResponse$ChannelArn": "<p>The ARN of the channel.</p>",
"UpdateChannelRequest$ChannelArn": "<p>The ARN of the channel.</p>",
"UpdateChannelRequest$ChimeBearer": "<p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>",
"UpdateChannelResponse$ChannelArn": "<p>The ARN of the channel.</p>"
}
},
"ClientRequestToken": {
"base": null,
"refs": {
"CreateChannelFlowRequest$ClientRequestToken": "<p>The client token for the request. An Idempotency token.</p>",
"CreateChannelRequest$ClientRequestToken": "<p>The client token for the request. An <code>Idempotency</code> token.</p>",
"SendChannelMessageRequest$ClientRequestToken": "<p>The <code>Idempotency</code> token for each client request.</p>"
}
},
"ConflictException": {
"base": "<p>The request could not be processed because of conflict in the current state of the resource.</p>",
"refs": {
}
},
"Content": {
"base": null,
"refs": {
"ChannelMessage$Content": "<p>The message content.</p>",
"ChannelMessageSummary$Content": "<p>The content of the message.</p>",
"UpdateChannelMessageRequest$Content": "<p>The content of the message being updated.</p>"
}
},
"CreateChannelBanRequest": {
"base": null,
"refs": {
}
},
"CreateChannelBanResponse": {
"base": null,
"refs": {
}
},
"CreateChannelFlowRequest": {
"base": null,
"refs": {
}
},
"CreateChannelFlowResponse": {
"base": null,
"refs": {
}
},
"CreateChannelMembershipRequest": {
"base": null,
"refs": {
}
},
"CreateChannelMembershipResponse": {
"base": null,
"refs": {
}
},
"CreateChannelModeratorRequest": {
"base": null,
"refs": {
}
},
"CreateChannelModeratorResponse": {
"base": null,
"refs": {
}
},
"CreateChannelRequest": {
"base": null,
"refs": {
}
},
"CreateChannelResponse": {
"base": null,
"refs": {
}
},
"DeleteChannelBanRequest": {
"base": null,
"refs": {
}
},
"DeleteChannelFlowRequest": {
"base": null,
"refs": {
}
},
"DeleteChannelMembershipRequest": {
"base": null,
"refs": {
}
},
"DeleteChannelMessageRequest": {
"base": null,
"refs": {
}
},
"DeleteChannelModeratorRequest": {
"base": null,
"refs": {
}
},
"DeleteChannelRequest": {
"base": null,
"refs": {
}
},
"DescribeChannelBanRequest": {
"base": null,
"refs": {
}
},
"DescribeChannelBanResponse": {
"base": null,
"refs": {
}
},
"DescribeChannelFlowRequest": {
"base": null,
"refs": {
}
},
"DescribeChannelFlowResponse": {
"base": null,
"refs": {
}
},
"DescribeChannelMembershipForAppInstanceUserRequest": {
"base": null,
"refs": {
}
},
"DescribeChannelMembershipForAppInstanceUserResponse": {
"base": null,
"refs": {
}
},
"DescribeChannelMembershipRequest": {
"base": null,
"refs": {
}
},
"DescribeChannelMembershipResponse": {
"base": null,
"refs": {
}
},
"DescribeChannelModeratedByAppInstanceUserRequest": {
"base": null,
"refs": {
}
},
"DescribeChannelModeratedByAppInstanceUserResponse": {
"base": null,
"refs": {
}
},
"DescribeChannelModeratorRequest": {
"base": null,
"refs": {
}
},
"DescribeChannelModeratorResponse": {
"base": null,
"refs": {
}
},
"DescribeChannelRequest": {
"base": null,
"refs": {
}
},
"DescribeChannelResponse": {
"base": null,
"refs": {
}
},
"DisassociateChannelFlowRequest": {
"base": null,
"refs": {
}
},
"ElasticChannelConfiguration": {
"base": "<p>The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million members.</p>",
"refs": {
"Channel$ElasticChannelConfiguration": "<p>The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million members.</p>",
"CreateChannelRequest$ElasticChannelConfiguration": "<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>"
}
},
"ErrorCode": {
"base": null,
"refs": {
"BadRequestException$Code": null,
"BatchCreateChannelMembershipError$ErrorCode": "<p>The error code.</p>",
"ConflictException$Code": null,
"ForbiddenException$Code": null,
"NotFoundException$Code": null,
"ResourceLimitExceededException$Code": null,
"ServiceFailureException$Code": null,
"ServiceUnavailableException$Code": null,
"ThrottledClientException$Code": null,
"UnauthorizedClientException$Code": null
}
},
"FallbackAction": {
"base": null,
"refs": {
"Processor$FallbackAction": "<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 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 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>"
}
},
"FilterRule": {
"base": null,
"refs": {
"PushNotificationPreferences$FilterRule": "<p>The simple JSON object used to send a subset of a push notification to the requested member.</p>"
}
},
"ForbiddenException": {
"base": "<p>The client is permanently forbidden from making the request.</p>",
"refs": {
}
},
"GetChannelMembershipPreferencesRequest": {
"base": null,
"refs": {
}
},
"GetChannelMembershipPreferencesResponse": {
"base": null,
"refs": {
}
},
"GetChannelMessageRequest": {
"base": null,
"refs": {
}
},
"GetChannelMessageResponse": {
"base": null,
"refs": {
}
},
"GetChannelMessageStatusRequest": {
"base": null,
"refs": {
}
},
"GetChannelMessageStatusResponse": {
"base": null,
"refs": {
}
},
"GetMessagingSessionEndpointRequest": {
"base": null,
"refs": {
}
},
"GetMessagingSessionEndpointResponse": {
"base": null,
"refs": {
}
},
"Identity": {
"base": "<p>The details of a user.</p>",
"refs": {
"BatchChannelMemberships$InvitedBy": "<p>The identifier of the member who invited another member.</p>",
"Channel$CreatedBy": "<p>The <code>AppInstanceUser</code> who created the channel.</p>",
"ChannelBan$Member": "<p>The member being banned from the channel.</p>",
"ChannelBan$CreatedBy": "<p>The <code>AppInstanceUser</code> who created the ban.</p>",
"ChannelBanSummary$Member": "<p>The member being banned from a channel.</p>",
"ChannelMembership$InvitedBy": "<p>The identifier of the member who invited another member.</p>",
"ChannelMembership$Member": "<p>The data of the channel member.</p>",
"ChannelMembershipSummary$Member": "<p>A member's summary data.</p>",
"ChannelMessage$Sender": "<p>The message sender.</p>",
"ChannelMessageSummary$Sender": "<p>The message sender.</p>",
"ChannelModerator$Moderator": "<p>The moderator's data.</p>",
"ChannelModerator$CreatedBy": "<p>The <code>AppInstanceUser</code> who created the moderator.</p>",
"ChannelModeratorSummary$Moderator": "<p>The data for a moderator.</p>",
"CreateChannelBanResponse$Member": "<p>The <code>ChannelArn</code> and <code>BannedIdentity</code> of the member in the ban response.</p>",
"CreateChannelMembershipResponse$Member": "<p>The ARN and metadata of the member being added.</p>",
"CreateChannelModeratorResponse$ChannelModerator": "<p>The ARNs of the channel and the moderator.</p>",
"GetChannelMembershipPreferencesResponse$Member": "<p>The details of a user.</p>",
"Members$member": null,
"PutChannelMembershipPreferencesResponse$Member": "<p>The details of a user.</p>"
}
},
"InvocationType": {
"base": null,
"refs": {
"LambdaConfiguration$InvocationType": "<p>Controls how the Lambda function is invoked.</p>"
}
},
"LambdaConfiguration": {
"base": "<p>Stores metadata about a Lambda processor.</p>",
"refs": {
"ProcessorConfiguration$Lambda": "<p>Indicates that the processor is of type Lambda.</p>"
}
},
"LambdaFunctionArn": {
"base": null,
"refs": {
"LambdaConfiguration$ResourceArn": "<p>The ARN of the Lambda message processing function.</p>"
}
},
"ListChannelBansRequest": {
"base": null,
"refs": {
}
},
"ListChannelBansResponse": {
"base": null,
"refs": {
}
},
"ListChannelFlowsRequest": {
"base": null,
"refs": {
}
},
"ListChannelFlowsResponse": {
"base": null,
"refs": {
}
},
"ListChannelMembershipsForAppInstanceUserRequest": {
"base": null,
"refs": {
}
},
"ListChannelMembershipsForAppInstanceUserResponse": {
"base": null,
"refs": {
}
},
"ListChannelMembershipsRequest": {
"base": null,
"refs": {
}
},
"ListChannelMembershipsResponse": {
"base": null,
"refs": {
}
},
"ListChannelMessagesRequest": {
"base": null,
"refs": {
}
},
"ListChannelMessagesResponse": {
"base": null,
"refs": {
}
},
"ListChannelModeratorsRequest": {
"base": null,
"refs": {
}
},
"ListChannelModeratorsResponse": {
"base": null,
"refs": {
}
},
"ListChannelsAssociatedWithChannelFlowRequest": {
"base": null,
"refs": {
}
},
"ListChannelsAssociatedWithChannelFlowResponse": {
"base": null,
"refs": {
}
},
"ListChannelsModeratedByAppInstanceUserRequest": {
"base": null,
"refs": {
}
},
"ListChannelsModeratedByAppInstanceUserResponse": {
"base": null,
"refs": {
}
},
"ListChannelsRequest": {
"base": null,
"refs": {
}
},
"ListChannelsResponse": {
"base": null,
"refs": {
}
},
"ListSubChannelsRequest": {
"base": null,
"refs": {
}
},
"ListSubChannelsResponse": {
"base": null,
"refs": {
}
},
"ListTagsForResourceRequest": {
"base": null,
"refs": {
}
},
"ListTagsForResourceResponse": {
"base": null,
"refs": {
}
},
"MaxResults": {
"base": null,
"refs": {
"ListChannelBansRequest$MaxResults": "<p>The maximum number of bans that you want returned.</p>",
"ListChannelFlowsRequest$MaxResults": "<p>The maximum number of channel flows that you want to return.</p>",
"ListChannelMembershipsForAppInstanceUserRequest$MaxResults": "<p>The maximum number of users that you want returned.</p>",
"ListChannelMembershipsRequest$MaxResults": "<p>The maximum number of channel memberships that you want returned.</p>",
"ListChannelMessagesRequest$MaxResults": "<p>The maximum number of messages that you want returned.</p>",
"ListChannelModeratorsRequest$MaxResults": "<p>The maximum number of moderators that you want returned.</p>",
"ListChannelsAssociatedWithChannelFlowRequest$MaxResults": "<p>The maximum number of channels that you want to return.</p>",
"ListChannelsModeratedByAppInstanceUserRequest$MaxResults": "<p>The maximum number of channels in the request.</p>",
"ListChannelsRequest$MaxResults": "<p>The maximum number of channels that you want to return.</p>",
"ListSubChannelsRequest$MaxResults": "<p>The maximum number of sub-channels that you want to return.</p>",
"SearchChannelsRequest$MaxResults": "<p>The maximum number of channels that you want returned.</p>"
}
},
"MaximumSubChannels": {
"base": null,
"refs": {
"ElasticChannelConfiguration$MaximumSubChannels": "<p>The maximum number of SubChannels that you want to allow in the elastic channel.</p>"
}
},
"MemberArns": {
"base": null,
"refs": {
"BatchCreateChannelMembershipRequest$MemberArns": "<p>The <code>AppInstanceUserArn</code>s of the members you want to add to the channel.</p>"
}
},
"Members": {
"base": null,
"refs": {
"BatchChannelMemberships$Members": "<p>The users successfully added to the request.</p>"
}
},
"MembershipCount": {
"base": null,
"refs": {
"SubChannelSummary$MembershipCount": "<p>The number of members in a SubChannel.</p>"
}
},
"MessageAttributeMap": {
"base": null,
"refs": {
"ChannelMessage$MessageAttributes": "<p>The attributes for the message, used for message filtering along with a <code>FilterRule</code> defined in the <code>PushNotificationPreferences</code>.</p>",
"ChannelMessageCallback$MessageAttributes": "<p>The attributes for the message, used for message filtering along with a <code>FilterRule</code> defined in the <code>PushNotificationPreferences</code>. </p>",
"ChannelMessageSummary$MessageAttributes": "<p>The message attribues listed in a the summary of a channel message.</p>",
"SendChannelMessageRequest$MessageAttributes": "<p>The attributes for the message, used for message filtering along with a <code>FilterRule</code> defined in the <code>PushNotificationPreferences</code>.</p>"
}
},
"MessageAttributeName": {
"base": null,
"refs": {
"MessageAttributeMap$key": null
}
},
"MessageAttributeStringValue": {
"base": null,
"refs": {
"MessageAttributeStringValues$member": null
}
},
"MessageAttributeStringValues": {
"base": null,
"refs": {
"MessageAttributeValue$StringValues": "<p>The strings in a message attribute value.</p>"
}
},
"MessageAttributeValue": {
"base": "<p>A list of message attribute values.</p>",
"refs": {
"MessageAttributeMap$value": null
}
},
"MessageId": {
"base": null,
"refs": {
"ChannelMessage$MessageId": "<p>The ID of a message.</p>",
"ChannelMessageCallback$MessageId": "<p>The message ID.</p>",
"ChannelMessageSummary$MessageId": "<p>The ID of the message.</p>",
"DeleteChannelMessageRequest$MessageId": "<p>The ID of the message being deleted.</p>",
"GetChannelMessageRequest$MessageId": "<p>The ID of the message.</p>",
"GetChannelMessageStatusRequest$MessageId": "<p>The ID of the message.</p>",
"RedactChannelMessageRequest$MessageId": "<p>The ID of the message being redacted.</p>",
"RedactChannelMessageResponse$MessageId": "<p>The ID of the message being redacted.</p>",
"SendChannelMessageResponse$MessageId": "<p>The ID string assigned to each message.</p>",
"UpdateChannelMessageRequest$MessageId": "<p>The ID string of the message being updated.</p>",
"UpdateChannelMessageResponse$MessageId": "<p>The ID string of the message being updated.</p>"
}