/
docs-2.json
4461 lines (4461 loc) · 224 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 API (application programming interface) is designed for developers to perform key tasks, such as creating and managing Amazon Chime accounts, users, and Voice Connectors. This guide provides detailed information about the Amazon Chime API, including operations, types, inputs and outputs, and error codes. It also includes some server-side API actions to use with the Amazon Chime SDK. For more information about the Amazon Chime SDK, see <a href=\"https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html\"> Using the Amazon Chime SDK </a> in the <i>Amazon Chime Developer Guide</i>.</p> <p>You can use an AWS SDK, the AWS Command Line Interface (AWS CLI), or the REST API to make API calls. We recommend using an AWS SDK or the AWS CLI. Each API operation includes links to information about using it with a language-specific AWS SDK or the AWS CLI.</p> <dl> <dt>Using an AWS SDK</dt> <dd> <p> You don't need to write code to calculate a signature for request authentication. The SDK clients authenticate your requests by using access keys that you provide. For more information about AWS SDKs, see the <a href=\"http://aws.amazon.com/developer/\">AWS Developer Center</a>. </p> </dd> <dt>Using the AWS CLI</dt> <dd> <p>Use your access keys with the AWS CLI to make API calls. For information about setting up the AWS CLI, see <a href=\"https://docs.aws.amazon.com/cli/latest/userguide/installing.html\">Installing the AWS Command Line Interface</a> in the <i>AWS Command Line Interface User Guide</i>. For a list of available Amazon Chime commands, see the <a href=\"https://docs.aws.amazon.com/cli/latest/reference/chime/index.html\">Amazon Chime commands</a> in the <i>AWS CLI Command Reference</i>. </p> </dd> <dt>Using REST APIs</dt> <dd> <p>If you use REST to make API calls, you must authenticate your request by providing a signature. Amazon Chime supports signature version 4. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version 4 Signing Process</a> in the <i>Amazon Web Services General Reference</i>.</p> <p>When making REST API calls, use the service name <code>chime</code> and REST endpoint <code>https://service.chime.aws.amazon.com</code>.</p> </dd> </dl> <p>Administrative permissions are controlled using AWS Identity and Access Management (IAM). For more information, see <a href=\"https://docs.aws.amazon.com/chime/latest/ag/security-iam.html\">Identity and Access Management for Amazon Chime</a> in the <i>Amazon Chime Administration Guide</i>.</p>",
"operations": {
"AssociatePhoneNumberWithUser": "<p>Associates a phone number with the specified Amazon Chime user.</p>",
"AssociatePhoneNumbersWithVoiceConnector": "<p>Associates phone numbers with the specified Amazon Chime Voice Connector.</p>",
"AssociatePhoneNumbersWithVoiceConnectorGroup": "<p>Associates phone numbers with the specified Amazon Chime Voice Connector group.</p>",
"AssociateSigninDelegateGroupsWithAccount": "<p>Associates the specified sign-in delegate groups with the specified Amazon Chime account.</p>",
"BatchCreateAttendee": "<p> Creates up to 100 new attendees for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see <a href=\"https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html\">Using the Amazon Chime SDK</a> in the <i>Amazon Chime Developer Guide</i>. </p>",
"BatchCreateChannelMembership": "<p>Adds a specified number of users to a channel.</p>",
"BatchCreateRoomMembership": "<p>Adds up to 50 members to a chat room in an Amazon Chime Enterprise account. Members can be users or bots. The member role designates whether the member is a chat room administrator or a general chat room member.</p>",
"BatchDeletePhoneNumber": "<p> Moves phone numbers into the <b>Deletion queue</b>. Phone numbers must be disassociated from any users or Amazon Chime Voice Connectors before they can be deleted. </p> <p> Phone numbers remain in the <b>Deletion queue</b> for 7 days before they are deleted permanently. </p>",
"BatchSuspendUser": "<p>Suspends up to 50 users from a <code>Team</code> or <code>EnterpriseLWA</code> Amazon Chime account. For more information about different account types, see <a href=\"https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html\">Managing Your Amazon Chime Accounts</a> in the <i>Amazon Chime Administration Guide</i>.</p> <p>Users suspended from a <code>Team</code> account are disassociated from the account,but they can continue to use Amazon Chime as free users. To remove the suspension from suspended <code>Team</code> account users, invite them to the <code>Team</code> account again. You can use the <a>InviteUsers</a> action to do so.</p> <p>Users suspended from an <code>EnterpriseLWA</code> account are immediately signed out of Amazon Chime and can no longer sign in. To remove the suspension from suspended <code>EnterpriseLWA</code> account users, use the <a>BatchUnsuspendUser</a> action.</p> <p> To sign out users without suspending them, use the <a>LogoutUser</a> action. </p>",
"BatchUnsuspendUser": "<p>Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime <code>EnterpriseLWA</code> account. Only users on <code>EnterpriseLWA</code> accounts can be unsuspended using this action. For more information about different account types, see <a href=\"https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html\"> Managing Your Amazon Chime Accounts </a> in the account types, in the <i>Amazon Chime Administration Guide</i>. </p> <p> Previously suspended users who are unsuspended using this action are returned to <code>Registered</code> status. Users who are not previously suspended are ignored. </p>",
"BatchUpdatePhoneNumber": "<p>Updates phone number product types or calling names. You can update one attribute at a time for each <code>UpdatePhoneNumberRequestItem</code>. For example, you can update the product type or the calling name.</p> <p>For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type.</p> <p>Updates to outbound calling names can take up to 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.</p>",
"BatchUpdateUser": "<p>Updates user details within the <a>UpdateUserRequestItem</a> object for up to 20 users for the specified Amazon Chime account. Currently, only <code>LicenseType</code> updates are supported for this action.</p>",
"CreateAccount": "<p>Creates an Amazon Chime account under the administrator's AWS account. Only <code>Team</code> account types are currently supported for this action. For more information about different account types, see <a href=\"https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html\">Managing Your Amazon Chime Accounts</a> in the <i>Amazon Chime Administration Guide</i>.</p>",
"CreateAppInstance": "<p>Creates an Amazon Chime SDK messaging <code>AppInstance</code> under an AWS account. Only SDK messaging customers use this API. <code>CreateAppInstance</code> supports idempotency behavior as described in the AWS API Standard.</p>",
"CreateAppInstanceAdmin": "<p>Promotes an <code>AppInstanceUser</code> to an <code>AppInstanceAdmin</code>. The promoted user can perform the following actions. </p> <ul> <li> <p> <code>ChannelModerator</code> actions across all channels in the <code>AppInstance</code>.</p> </li> <li> <p> <code>DeleteChannelMessage</code> actions.</p> </li> </ul> <p>Only an <code>AppInstanceUser</code> can be promoted to an <code>AppInstanceAdmin</code> role.</p>",
"CreateAppInstanceUser": "<p>Creates a user under an Amazon Chime <code>AppInstance</code>. The request consists of a unique <code>appInstanceUserId</code> and <code>Name</code> for that user.</p>",
"CreateAttendee": "<p> Creates a new attendee for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see <a href=\"https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html\">Using the Amazon Chime SDK</a> in the <i>Amazon Chime Developer Guide</i>. </p>",
"CreateBot": "<p>Creates a bot for an Amazon Chime Enterprise account.</p>",
"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>",
"CreateChannelMembership": "<p>Adds a user to a channel. The <code>InvitedBy</code> response field 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>",
"CreateMediaCapturePipeline": "<p>Creates a media capture pipeline.</p>",
"CreateMeeting": "<p> Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees. For more information about specifying media Regions, see <a href=\"https://docs.aws.amazon.com/chime/latest/dg/chime-sdk-meetings-regions.html\">Amazon Chime SDK Media Regions</a> in the <i>Amazon Chime Developer Guide</i> . For more information about the Amazon Chime SDK, see <a href=\"https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html\">Using the Amazon Chime SDK</a> in the <i>Amazon Chime Developer Guide</i> . </p>",
"CreateMeetingDialOut": "<p>Uses the join token and call metadata in a meeting request (From number, To number, and so forth) to initiate an outbound call to a public switched telephone network (PSTN) and join them into a Chime meeting. Also ensures that the From number belongs to the customer.</p> <p>To play welcome audio or implement an interactive voice response (IVR), use the <code>CreateSipMediaApplicationCall</code> action with the corresponding SIP media application ID.</p>",
"CreateMeetingWithAttendees": "<p> Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees. For more information about specifying media Regions, see <a href=\"https://docs.aws.amazon.com/chime/latest/dg/chime-sdk-meetings-regions.html\">Amazon Chime SDK Media Regions</a> in the <i>Amazon Chime Developer Guide</i> . For more information about the Amazon Chime SDK, see <a href=\"https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html\">Using the Amazon Chime SDK</a> in the <i>Amazon Chime Developer Guide</i> . </p>",
"CreatePhoneNumberOrder": "<p>Creates an order for phone numbers to be provisioned. For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type.</p>",
"CreateProxySession": "<p>Creates a proxy session on the specified Amazon Chime Voice Connector for the specified participant phone numbers.</p>",
"CreateRoom": "<p>Creates a chat room for the specified Amazon Chime Enterprise account.</p>",
"CreateRoomMembership": "<p>Adds a member to a chat room in an Amazon Chime Enterprise account. A member can be either a user or a bot. The member role designates whether the member is a chat room administrator or a general chat room member.</p>",
"CreateSipMediaApplication": "<p>Creates a SIP media application.</p>",
"CreateSipMediaApplicationCall": "<p>Creates an outbound call to a phone number from the phone number specified in the request, and it invokes the endpoint of the specified <code>sipMediaApplicationId</code>.</p>",
"CreateSipRule": "<p>Creates a SIP rule which can be used to run a SIP media application as a target for a specific trigger type.</p>",
"CreateUser": "<p>Creates a user under the specified Amazon Chime account.</p>",
"CreateVoiceConnector": "<p>Creates an Amazon Chime Voice Connector under the administrator's AWS account. You can choose to create an Amazon Chime Voice Connector in a specific AWS Region.</p> <p> Enabling <a>CreateVoiceConnectorRequest$RequireEncryption</a> configures your Amazon Chime Voice Connector to use TLS transport for SIP signaling and Secure RTP (SRTP) for media. Inbound calls use TLS transport, and unencrypted outbound calls are blocked. </p>",
"CreateVoiceConnectorGroup": "<p>Creates an Amazon Chime Voice Connector group under the administrator's AWS account. You can associate Amazon Chime Voice Connectors with the Amazon Chime Voice Connector group by including <code>VoiceConnectorItems</code> in the request.</p> <p>You can include Amazon Chime Voice Connectors from different AWS Regions in your group. This creates a fault tolerant mechanism for fallback in case of availability events.</p>",
"DeleteAccount": "<p>Deletes the specified Amazon Chime account. You must suspend all users before deleting <code>Team</code> account. You can use the <a>BatchSuspendUser</a> action to dodo.</p> <p>For <code>EnterpriseLWA</code> and <code>EnterpriseAD</code> accounts, you must release the claimed domains for your Amazon Chime account before deletion. As soon as you release the domain, all users under that account are suspended.</p> <p>Deleted accounts appear in your <code>Disabled</code> accounts list for 90 days. To restore deleted account from your <code>Disabled</code> accounts list, you must contact AWS Support.</p> <p>After 90 days, deleted accounts are permanently removed from your <code>Disabled</code> accounts list.</p>",
"DeleteAppInstance": "<p>Deletes an <code>AppInstance</code> and all associated data asynchronously.</p>",
"DeleteAppInstanceAdmin": "<p>Demotes an <code>AppInstanceAdmin</code> to an <code>AppInstanceUser</code>. This action does not delete the user.</p>",
"DeleteAppInstanceStreamingConfigurations": "<p>Deletes the streaming configurations of an <code>AppInstance</code>.</p>",
"DeleteAppInstanceUser": "<p>Deletes an <code>AppInstanceUser</code>.</p>",
"DeleteAttendee": "<p>Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their <code>JoinToken</code>. Attendees are automatically deleted when a Amazon Chime SDK meeting is deleted. For more information about the Amazon Chime SDK, see <a href=\"https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html\">Using the Amazon Chime SDK</a> in the <i>Amazon Chime Developer Guide</i>.</p>",
"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>",
"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>",
"DeleteEventsConfiguration": "<p>Deletes the events configuration that allows a bot to receive outgoing events.</p>",
"DeleteMediaCapturePipeline": "<p>Deletes the media capture pipeline.</p>",
"DeleteMeeting": "<p>Deletes the specified Amazon Chime SDK meeting. The operation deletes all attendees, disconnects all clients, and prevents new clients from joining the meeting. For more information about the Amazon Chime SDK, see <a href=\"https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html\">Using the Amazon Chime SDK</a> in the <i>Amazon Chime Developer Guide</i>.</p>",
"DeletePhoneNumber": "<p>Moves the specified phone number into the <b>Deletion queue</b>. A phone number must be disassociated from any users or Amazon Chime Voice Connectors before it can be deleted.</p> <p>Deleted phone numbers remain in the <b>Deletion queue</b> for 7 days before they are deleted permanently.</p>",
"DeleteProxySession": "<p>Deletes the specified proxy session from the specified Amazon Chime Voice Connector.</p>",
"DeleteRoom": "<p>Deletes a chat room in an Amazon Chime Enterprise account.</p>",
"DeleteRoomMembership": "<p>Removes a member from a chat room in an Amazon Chime Enterprise account.</p>",
"DeleteSipMediaApplication": "<p>Deletes a SIP media application.</p>",
"DeleteSipRule": "<p>Deletes a SIP rule. You must disable a SIP rule before you can delete it.</p>",
"DeleteVoiceConnector": "<p>Deletes the specified Amazon Chime Voice Connector. Any phone numbers associated with the Amazon Chime Voice Connector must be disassociated from it before it can be deleted.</p>",
"DeleteVoiceConnectorEmergencyCallingConfiguration": "<p>Deletes the emergency calling configuration details from the specified Amazon Chime Voice Connector.</p>",
"DeleteVoiceConnectorGroup": "<p>Deletes the specified Amazon Chime Voice Connector group. Any <code>VoiceConnectorItems</code> and phone numbers associated with the group must be removed before it can be deleted.</p>",
"DeleteVoiceConnectorOrigination": "<p>Deletes the origination settings for the specified Amazon Chime Voice Connector.</p> <note> <p>If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to deleting the origination settings.</p> </note>",
"DeleteVoiceConnectorProxy": "<p>Deletes the proxy configuration from the specified Amazon Chime Voice Connector.</p>",
"DeleteVoiceConnectorStreamingConfiguration": "<p>Deletes the streaming configuration for the specified Amazon Chime Voice Connector.</p>",
"DeleteVoiceConnectorTermination": "<p>Deletes the termination settings for the specified Amazon Chime Voice Connector.</p> <note> <p>If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to deleting the termination settings.</p> </note>",
"DeleteVoiceConnectorTerminationCredentials": "<p>Deletes the specified SIP credentials used by your equipment to authenticate during call termination.</p>",
"DescribeAppInstance": "<p>Returns the full details of an <code>AppInstance</code>.</p>",
"DescribeAppInstanceAdmin": "<p>Returns the full details of an <code>AppInstanceAdmin</code>.</p>",
"DescribeAppInstanceUser": "<p>Returns the full details of an <code>AppInstanceUser</code>.</p>",
"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>",
"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>",
"DisassociatePhoneNumberFromUser": "<p>Disassociates the primary provisioned phone number from the specified Amazon Chime user.</p>",
"DisassociatePhoneNumbersFromVoiceConnector": "<p>Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector.</p>",
"DisassociatePhoneNumbersFromVoiceConnectorGroup": "<p>Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector group.</p>",
"DisassociateSigninDelegateGroupsFromAccount": "<p>Disassociates the specified sign-in delegate groups from the specified Amazon Chime account.</p>",
"GetAccount": "<p>Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.</p>",
"GetAccountSettings": "<p>Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dialout settings. For more information about these settings, see <a href=\"https://docs.aws.amazon.com/chime/latest/ag/policies.html\">Use the Policies Page</a> in the <i>Amazon Chime Administration Guide</i>. </p>",
"GetAppInstanceRetentionSettings": "<p>Gets the retention settings for an <code>AppInstance</code>.</p>",
"GetAppInstanceStreamingConfigurations": "<p>Gets the streaming settings for an <code>AppInstance</code>.</p>",
"GetAttendee": "<p> Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID. For more information about the Amazon Chime SDK, see <a href=\"https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html\">Using the Amazon Chime SDK</a> in the <i>Amazon Chime Developer Guide</i> . </p>",
"GetBot": "<p>Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.</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>",
"GetEventsConfiguration": "<p>Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.</p>",
"GetGlobalSettings": "<p>Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.</p>",
"GetMediaCapturePipeline": "<p>Gets an existing media capture pipeline.</p>",
"GetMeeting": "<p> Gets the Amazon Chime SDK meeting details for the specified meeting ID. For more information about the Amazon Chime SDK, see <a href=\"https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html\">Using the Amazon Chime SDK</a> in the <i>Amazon Chime Developer Guide</i> . </p>",
"GetMessagingSessionEndpoint": "<p>The details of the endpoint for the messaging session.</p>",
"GetPhoneNumber": "<p>Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.</p>",
"GetPhoneNumberOrder": "<p>Retrieves details for the specified phone number order, such as the order creation timestamp, phone numbers in E.164 format, product type, and order status.</p>",
"GetPhoneNumberSettings": "<p>Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.</p>",
"GetProxySession": "<p>Gets the specified proxy session details for the specified Amazon Chime Voice Connector.</p>",
"GetRetentionSettings": "<p> Gets the retention settings for the specified Amazon Chime Enterprise account. For more information about retention settings, see <a href=\"https://docs.aws.amazon.com/chime/latest/ag/chat-retention.html\">Managing Chat Retention Policies</a> in the <i>Amazon Chime Administration Guide</i>. </p>",
"GetRoom": "<p>Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.</p>",
"GetSipMediaApplication": "<p>Retrieves the information for a SIP media application, including name, AWS Region, and endpoints.</p>",
"GetSipMediaApplicationLoggingConfiguration": "<p>Returns the logging configuration for the specified SIP media application.</p>",
"GetSipRule": "<p>Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.</p>",
"GetUser": "<p>Retrieves details for the specified user ID, such as primary email address, license type,and personal meeting PIN.</p> <p> To retrieve user details with an email address instead of a user ID, use the <a>ListUsers</a> action, and then filter by email address. </p>",
"GetUserSettings": "<p>Retrieves settings for the specified user ID, such as any associated phone number settings.</p>",
"GetVoiceConnector": "<p>Retrieves details for the specified Amazon Chime Voice Connector, such as timestamps,name, outbound host, and encryption requirements.</p>",
"GetVoiceConnectorEmergencyCallingConfiguration": "<p>Gets the emergency calling configuration details for the specified Amazon Chime Voice Connector.</p>",
"GetVoiceConnectorGroup": "<p> Retrieves details for the specified Amazon Chime Voice Connector group, such as timestamps,name, and associated <code>VoiceConnectorItems</code>.</p>",
"GetVoiceConnectorLoggingConfiguration": "<p>Retrieves the logging configuration details for the specified Amazon Chime Voice Connector. Shows whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.</p>",
"GetVoiceConnectorOrigination": "<p>Retrieves origination setting details for the specified Amazon Chime Voice Connector.</p>",
"GetVoiceConnectorProxy": "<p>Gets the proxy configuration details for the specified Amazon Chime Voice Connector.</p>",
"GetVoiceConnectorStreamingConfiguration": "<p>Retrieves the streaming configuration details for the specified Amazon Chime Voice Connector. Shows whether media streaming is enabled for sending to Amazon Kinesis. It also shows the retention period, in hours, for the Amazon Kinesis data.</p>",
"GetVoiceConnectorTermination": "<p>Retrieves termination setting details for the specified Amazon Chime Voice Connector.</p>",
"GetVoiceConnectorTerminationHealth": "<p>Retrieves information about the last time a SIP <code>OPTIONS</code> ping was received from your SIP infrastructure for the specified Amazon Chime Voice Connector.</p>",
"InviteUsers": "<p>Sends email to a maximum of 50 users, inviting them to the specified Amazon Chime <code>Team</code> account. Only <code>Team</code> account types are currently supported for this action.</p>",
"ListAccounts": "<p>Lists the Amazon Chime accounts under the administrator's AWS account. You can filter accounts by account name prefix. To find out which Amazon Chime account a user belongs to, you can filter by the user's email address, which returns one account result.</p>",
"ListAppInstanceAdmins": "<p>Returns a list of the administrators in the <code>AppInstance</code>.</p>",
"ListAppInstanceUsers": "<p>List all <code>AppInstanceUsers</code> created under a single <code>AppInstance</code>. </p>",
"ListAppInstances": "<p>Lists all Amazon Chime <code>AppInstance</code>s created under a single AWS account.</p>",
"ListAttendeeTags": "<p>Lists the tags applied to an Amazon Chime SDK attendee resource.</p>",
"ListAttendees": "<p> Lists the attendees for the specified Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see <a href=\"https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html\">Using the Amazon Chime SDK</a> in the <i>Amazon Chime Developer Guide</i>. </p>",
"ListBots": "<p>Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.</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>",
"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>",
"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>",
"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>",
"ListMediaCapturePipelines": "<p>Returns a list of media capture pipelines.</p>",
"ListMeetingTags": "<p>Lists the tags applied to an Amazon Chime SDK meeting resource.</p>",
"ListMeetings": "<p> Lists up to 100 active Amazon Chime SDK meetings. For more information about the Amazon Chime SDK, see <a href=\"https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html\">Using the Amazon Chime SDK</a> in the <i>Amazon Chime Developer Guide</i>.</p>",
"ListPhoneNumberOrders": "<p>Lists the phone number orders for the administrator's Amazon Chime account.</p>",
"ListPhoneNumbers": "<p>Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.</p>",
"ListProxySessions": "<p>Lists the proxy sessions for the specified Amazon Chime Voice Connector.</p>",
"ListRoomMemberships": "<p>Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members' IDs, email addresses, and names.</p>",
"ListRooms": "<p>Lists the room details for the specified Amazon Chime Enterprise account. Optionally, filter the results by a member ID (user ID or bot ID) to see a list of rooms that the member belongs to.</p>",
"ListSipMediaApplications": "<p>Lists the SIP media applications under the administrator's AWS account.</p>",
"ListSipRules": "<p>Lists the SIP rules under the administrator's AWS account.</p>",
"ListSupportedPhoneNumberCountries": "<p>Lists supported phone number countries.</p>",
"ListTagsForResource": "<p>Lists the tags applied to an Amazon Chime SDK meeting resource.</p>",
"ListUsers": "<p>Lists the users that belong to the specified Amazon Chime account. You can specify an email address to list only the user that the email address belongs to.</p>",
"ListVoiceConnectorGroups": "<p>Lists the Amazon Chime Voice Connector groups for the administrator's AWS account.</p>",
"ListVoiceConnectorTerminationCredentials": "<p>Lists the SIP credentials for the specified Amazon Chime Voice Connector.</p>",
"ListVoiceConnectors": "<p>Lists the Amazon Chime Voice Connectors for the administrator's AWS account.</p>",
"LogoutUser": "<p>Logs out the specified user from all of the devices they are currently logged into.</p>",
"PutAppInstanceRetentionSettings": "<p>Sets the amount of time in days that a given <code>AppInstance</code> retains data.</p>",
"PutAppInstanceStreamingConfigurations": "<p>The data streaming configurations of an <code>AppInstance</code>.</p>",
"PutEventsConfiguration": "<p>Creates an events configuration that allows a bot to receive outgoing events sent by Amazon Chime. Choose either an HTTPS endpoint or a Lambda function ARN. For more information, see <a>Bot</a>.</p>",
"PutRetentionSettings": "<p> Puts retention settings for the specified Amazon Chime Enterprise account. We recommend using AWS CloudTrail to monitor usage of this API for your account. For more information, see <a href=\"https://docs.aws.amazon.com/chime/latest/ag/cloudtrail.html\">Logging Amazon Chime API Calls with AWS CloudTrail</a> in the <i>Amazon Chime Administration Guide</i>.</p> <p> To turn off existing retention settings, remove the number of days from the corresponding <b>RetentionDays</b> field in the <b>RetentionSettings</b> object. For more information about retention settings, see <a href=\"https://docs.aws.amazon.com/chime/latest/ag/chat-retention.html\">Managing Chat Retention Policies</a> in the <i>Amazon Chime Administration Guide</i>.</p>",
"PutSipMediaApplicationLoggingConfiguration": "<p>Updates the logging configuration for the specified SIP media application.</p>",
"PutVoiceConnectorEmergencyCallingConfiguration": "<p>Puts emergency calling configuration details to the specified Amazon Chime Voice Connector, such as emergency phone numbers and calling countries. Origination and termination settings must be enabled for the Amazon Chime Voice Connector before emergency calling can be configured.</p>",
"PutVoiceConnectorLoggingConfiguration": "<p>Adds a logging configuration for the specified Amazon Chime Voice Connector. The logging configuration specifies whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.</p>",
"PutVoiceConnectorOrigination": "<p>Adds origination settings for the specified Amazon Chime Voice Connector.</p> <note> <p>If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to turning off origination settings.</p> </note>",
"PutVoiceConnectorProxy": "<p>Puts the specified proxy configuration to the specified Amazon Chime Voice Connector.</p>",
"PutVoiceConnectorStreamingConfiguration": "<p>Adds a streaming configuration for the specified Amazon Chime Voice Connector. The streaming configuration specifies whether media streaming is enabled for sending to Indonesians. It also sets the retention period, in hours, for the Amazon Kinesis data.</p>",
"PutVoiceConnectorTermination": "<p>Adds termination settings for the specified Amazon Chime Voice Connector.</p> <note> <p>If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to turning off termination settings.</p> </note>",
"PutVoiceConnectorTerminationCredentials": "<p>Adds termination SIP credentials for the specified Amazon Chime Voice Connector.</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>",
"RedactConversationMessage": "<p>Redacts the specified message from the specified Amazon Chime conversation.</p>",
"RedactRoomMessage": "<p>Redacts the specified message from the specified Amazon Chime channel.</p>",
"RegenerateSecurityToken": "<p>Regenerates the security token for a bot.</p>",
"ResetPersonalPIN": "<p>Resets the personal meeting PIN for the specified user on an Amazon Chime account. Returns the <a>User</a> object with the updated personal meeting PIN.</p>",
"RestorePhoneNumber": "<p>Moves a phone number from the <b>Deletion queue</b> back into the phone number <b>Inventory</b>.</p>",
"SearchAvailablePhoneNumbers": "<p>Searches for phone numbers that can be ordered. For US numbers, provide at least one of the following search filters: <code>AreaCode</code>, <code>City</code>, <code>State</code>, or <code>TollFreePrefix</code>. If you provide <code>City</code>, you must also provide <code>State</code>. Numbers outside the US only support the <code>PhoneNumberType</code> filter, which you must use.</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>",
"StartMeetingTranscription": "<p>Starts transcription for the specified <code>meetingId</code>. </p>",
"StopMeetingTranscription": "<p>Stops transcription for the specified <code>meetingId</code>.</p>",
"TagAttendee": "<p>Applies the specified tags to the specified Amazon Chime SDK attendee.</p>",
"TagMeeting": "<p>Applies the specified tags to the specified Amazon Chime SDK meeting.</p>",
"TagResource": "<p>Applies the specified tags to the specified Amazon Chime SDK meeting resource.</p>",
"UntagAttendee": "<p>Untags the specified tags from the specified Amazon Chime SDK attendee.</p>",
"UntagMeeting": "<p>Untags the specified tags from the specified Amazon Chime SDK meeting.</p>",
"UntagResource": "<p>Untags the specified tags from the specified Amazon Chime SDK meeting resource.</p>",
"UpdateAccount": "<p>Updates account details for the specified Amazon Chime account. Currently, only account name and default license updates are supported for this action.</p>",
"UpdateAccountSettings": "<p>Updates the settings for the specified Amazon Chime account. You can update settings for remote control of shared screens, or for the dial-out option. For more information about these settings, see <a href=\"https://docs.aws.amazon.com/chime/latest/ag/policies.html\">Use the Policies Page</a> in the <i>Amazon Chime Administration Guide</i>.</p>",
"UpdateAppInstance": "<p>Updates <code>AppInstance</code> metadata.</p>",
"UpdateAppInstanceUser": "<p>Updates the details of an <code>AppInstanceUser</code>. You can update names and metadata.</p>",
"UpdateBot": "<p>Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.</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>",
"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>",
"UpdateGlobalSettings": "<p>Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.</p>",
"UpdatePhoneNumber": "<p>Updates phone number details, such as product type or calling name, for the specified phone number ID. You can update one phone number detail at a time. For example, you can update either the product type or the calling name in one action.</p> <p>For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type.</p> <p>Updates to outbound calling names can take 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.</p>",
"UpdatePhoneNumberSettings": "<p>Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name. You can update the default outbound calling name once every seven days. Outbound calling names can take up to 72 hours to update.</p>",
"UpdateProxySession": "<p>Updates the specified proxy session details, such as voice or SMS capabilities.</p>",
"UpdateRoom": "<p>Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account.</p>",
"UpdateRoomMembership": "<p>Updates room membership details, such as the member role, for a room in an Amazon Chime Enterprise account. The member role designates whether the member is a chat room administrator or a general chat room member. The member role can be updated only for user IDs.</p>",
"UpdateSipMediaApplication": "<p>Updates the details of the specified SIP media application.</p>",
"UpdateSipMediaApplicationCall": "<p>Allows you to trigger a Lambda function at any time while a call is active, and replace the current actions with new actions returned by the invocation.</p>",
"UpdateSipRule": "<p>Updates the details of the specified SIP rule.</p>",
"UpdateUser": "<p>Updates user details for a specified user ID. Currently, only <code>LicenseType</code> updates are supported for this action.</p>",
"UpdateUserSettings": "<p>Updates the settings for the specified user, such as phone number settings.</p>",
"UpdateVoiceConnector": "<p>Updates details for the specified Amazon Chime Voice Connector.</p>",
"UpdateVoiceConnectorGroup": "<p>Updates details of the specified Amazon Chime Voice Connector group, such as the name and Amazon Chime Voice Connector priority ranking.</p>"
},
"shapes": {
"AccessDeniedException": {
"base": "<p>You don't have permissions to perform the requested operation.</p>",
"refs": {
}
},
"Account": {
"base": "<p>The Amazon Chime account details. An AWS account can have multiple Amazon Chime accounts.</p>",
"refs": {
"AccountList$member": null,
"CreateAccountResponse$Account": "<p>The Amazon Chime account details.</p>",
"GetAccountResponse$Account": "<p>The Amazon Chime account details.</p>",
"UpdateAccountResponse$Account": "<p>The updated Amazon Chime account details.</p>"
}
},
"AccountList": {
"base": null,
"refs": {
"ListAccountsResponse$Accounts": "<p>List of Amazon Chime accounts and account details.</p>"
}
},
"AccountName": {
"base": null,
"refs": {
"CreateAccountRequest$Name": "<p>The name of the Amazon Chime account.</p>",
"ListAccountsRequest$Name": "<p>Amazon Chime account name prefix with which to filter results.</p>",
"UpdateAccountRequest$Name": "<p>The new name for the specified Amazon Chime account.</p>"
}
},
"AccountSettings": {
"base": "<p>Settings related to the Amazon Chime account. This includes settings that start or stop remote control of shared screens, or start or stop the dial-out option in the Amazon Chime web application. For more information about these settings, see <a href=\"https://docs.aws.amazon.com/chime/latest/ag/policies.html\">Use the Policies Page</a> in the <i>Amazon Chime Administration Guide</i>.</p>",
"refs": {
"GetAccountSettingsResponse$AccountSettings": "<p>The Amazon Chime account settings.</p>",
"UpdateAccountSettingsRequest$AccountSettings": "<p>The Amazon Chime account settings to update.</p>"
}
},
"AccountStatus": {
"base": null,
"refs": {
"Account$AccountStatus": "<p>The status of the account.</p>"
}
},
"AccountType": {
"base": null,
"refs": {
"Account$AccountType": "<p>The Amazon Chime account type. For more information about different account types, see <a href=\"https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html\">Managing Your Amazon Chime Accounts</a> in the <i>Amazon Chime Administration Guide</i>.</p>"
}
},
"AlexaForBusinessMetadata": {
"base": "<p>The Alexa for Business metadata associated with an Amazon Chime user, used to integrate Alexa for Business with a device.</p>",
"refs": {
"UpdateUserRequest$AlexaForBusinessMetadata": "<p>The Alexa for Business metadata.</p>",
"UpdateUserRequestItem$AlexaForBusinessMetadata": "<p>The Alexa for Business metadata.</p>",
"User$AlexaForBusinessMetadata": "<p>The Alexa for Business metadata.</p>"
}
},
"Alpha2CountryCode": {
"base": null,
"refs": {
"DNISEmergencyCallingConfiguration$CallingCountry": "<p>The country from which emergency calls are allowed, in ISO 3166-1 alpha-2 format.</p>",
"PhoneNumber$Country": "<p>The phone number country. Format: ISO 3166-1 alpha-2.</p>",
"PhoneNumberCountry$CountryCode": "<p>The phone number country code. Format: ISO 3166-1 alpha-2.</p>",
"SearchAvailablePhoneNumbersRequest$Country": "<p>The country used to filter results. Defaults to the US Format: ISO 3166-1 alpha-2.</p>"
}
},
"AppInstance": {
"base": "<p>The details of an <code>AppInstance</code>, an instance of an Amazon Chime SDK messaging application.</p>",
"refs": {
"DescribeAppInstanceResponse$AppInstance": "<p>The ARN, metadata, created and last-updated timestamps, and the name of the <code>AppInstance</code>. All timestamps use epoch milliseconds.</p>"
}
},
"AppInstanceAdmin": {
"base": "<p>The details of an <code>AppInstanceAdmin</code>.</p>",
"refs": {
"DescribeAppInstanceAdminResponse$AppInstanceAdmin": "<p>The ARN and name of the <code>AppInstanceUser</code>, the ARN of the <code>AppInstance</code>, and the created and last-updated timestamps. All timestamps use epoch milliseconds.</p>"
}
},
"AppInstanceAdminList": {
"base": null,
"refs": {
"ListAppInstanceAdminsResponse$AppInstanceAdmins": "<p>The information for each administrator.</p>"
}
},
"AppInstanceAdminSummary": {
"base": "<p>Summary of the details of an <code>AppInstanceAdmin</code>.</p>",
"refs": {
"AppInstanceAdminList$member": null
}
},
"AppInstanceDataType": {
"base": null,
"refs": {
"AppInstanceStreamingConfiguration$AppInstanceDataType": "<p>The type of data to be streamed.</p>"
}
},
"AppInstanceList": {
"base": null,
"refs": {
"ListAppInstancesResponse$AppInstances": "<p>The information for each <code>AppInstance</code>.</p>"
}
},
"AppInstanceRetentionSettings": {
"base": "<p>The details of the data-retention settings for an <code>AppInstance</code>.</p>",
"refs": {
"GetAppInstanceRetentionSettingsResponse$AppInstanceRetentionSettings": "<p>The retention settings for the <code>AppInstance</code>.</p>",
"PutAppInstanceRetentionSettingsRequest$AppInstanceRetentionSettings": "<p>The time in days to retain data. Data type: number.</p>",
"PutAppInstanceRetentionSettingsResponse$AppInstanceRetentionSettings": "<p>The time in days to retain data. Data type: number.</p>"
}
},
"AppInstanceStreamingConfiguration": {
"base": "<p>The details of the streaming configuration of an <code>AppInstance</code>.</p>",
"refs": {
"AppInstanceStreamingConfigurationList$member": null
}
},
"AppInstanceStreamingConfigurationList": {
"base": null,
"refs": {
"GetAppInstanceStreamingConfigurationsResponse$AppInstanceStreamingConfigurations": "<p>The streaming settings.</p>",
"PutAppInstanceStreamingConfigurationsRequest$AppInstanceStreamingConfigurations": "<p>The streaming configurations set for an <code>AppInstance</code>.</p>",
"PutAppInstanceStreamingConfigurationsResponse$AppInstanceStreamingConfigurations": "<p>The streaming configurations of an <code>AppInstance</code>.</p>"
}
},
"AppInstanceSummary": {
"base": "<p>Summary of the data for an <code>AppInstance</code>.</p>",
"refs": {
"AppInstanceList$member": null
}
},
"AppInstanceUser": {
"base": "<p>The details of an <code>AppInstanceUser</code>.</p>",
"refs": {
"DescribeAppInstanceUserResponse$AppInstanceUser": "<p>The name of the <code>AppInstanceUser</code>.</p>"
}
},
"AppInstanceUserList": {
"base": null,
"refs": {
"ListAppInstanceUsersResponse$AppInstanceUsers": "<p>The information for each requested <code>AppInstanceUser</code>.</p>"
}
},
"AppInstanceUserMembershipSummary": {
"base": "<p>Summary of the membership details of an <code>AppInstanceUser</code>.</p>",
"refs": {
"ChannelMembershipForAppInstanceUserSummary$AppInstanceUserMembershipSummary": null
}
},
"AppInstanceUserSummary": {
"base": "<p>Summary of the details of an <code>AppInstanceUser</code>.</p>",
"refs": {
"AppInstanceUserList$member": null
}
},
"AreaCode": {
"base": null,
"refs": {
"GeoMatchParams$AreaCode": "<p>The area code.</p>"
}
},
"Arn": {
"base": null,
"refs": {
"AppInstanceStreamingConfiguration$ResourceArn": "<p>The resource ARN.</p>",
"CreateMediaCapturePipelineRequest$SourceArn": "<p>ARN of the source from which the media artifacts are captured.</p>",
"CreateMediaCapturePipelineRequest$SinkArn": "<p>The ARN of the sink type.</p>",
"ListTagsForResourceRequest$ResourceARN": "<p>The resource ARN.</p>",
"MediaCapturePipeline$SourceArn": "<p>ARN of the source from which the media artifacts will be saved.</p>",
"MediaCapturePipeline$SinkArn": "<p>ARN of the destination to which the media artifacts are saved.</p>",
"MeetingNotificationConfiguration$SnsTopicArn": "<p>The SNS topic ARN.</p>",
"MeetingNotificationConfiguration$SqsQueueArn": "<p>The SQS queue ARN.</p>",
"TagResourceRequest$ResourceARN": "<p>The resource ARN.</p>",
"UntagResourceRequest$ResourceARN": "<p>The resource ARN.</p>"
}
},
"ArtifactsConfiguration": {
"base": "<p>The configuration for the artifacts.</p>",
"refs": {
"ChimeSdkMeetingConfiguration$ArtifactsConfiguration": "<p>The configuration for the artifacts in an Amazon Chime SDK meeting.</p>"
}
},
"ArtifactsState": {
"base": null,
"refs": {
"ContentArtifactsConfiguration$State": "<p>Indicates whether the content artifact is enabled or disabled.</p>",
"VideoArtifactsConfiguration$State": "<p>Indicates whether the video artifact is enabled or disabled.</p>"
}
},
"AssociatePhoneNumberWithUserRequest": {
"base": null,
"refs": {
}
},
"AssociatePhoneNumberWithUserResponse": {
"base": null,
"refs": {
}
},
"AssociatePhoneNumbersWithVoiceConnectorGroupRequest": {
"base": null,
"refs": {
}
},
"AssociatePhoneNumbersWithVoiceConnectorGroupResponse": {
"base": null,
"refs": {
}
},
"AssociatePhoneNumbersWithVoiceConnectorRequest": {
"base": null,
"refs": {
}
},
"AssociatePhoneNumbersWithVoiceConnectorResponse": {
"base": null,
"refs": {
}
},
"AssociateSigninDelegateGroupsWithAccountRequest": {
"base": null,
"refs": {
}
},
"AssociateSigninDelegateGroupsWithAccountResponse": {
"base": null,
"refs": {
}
},
"Attendee": {
"base": "<p> An Amazon Chime SDK meeting attendee. Includes a unique <code>AttendeeId</code> and <code>JoinToken</code> . The <code>JoinToken</code> allows a client to authenticate and join as the specified attendee. The <code>JoinToken</code> expires when the meeting ends or when <a>DeleteAttendee</a> is called. After that, the attendee is unable to join the meeting. </p> <p>We recommend securely transferring each <code>JoinToken</code> from your server application to the client so that no other client has access to the token except for the one authorized to represent the attendee.</p>",
"refs": {
"AttendeeList$member": null,
"CreateAttendeeResponse$Attendee": "<p>The attendee information, including attendee ID and join token.</p>",
"GetAttendeeResponse$Attendee": "<p>The Amazon Chime SDK attendee information.</p>"
}
},
"AttendeeIdList": {
"base": null,
"refs": {
"SelectedVideoStreams$AttendeeIds": "<p>The attendee IDs of the streams selected for a media capture pipeline. </p>"
}
},
"AttendeeList": {
"base": null,
"refs": {
"BatchCreateAttendeeResponse$Attendees": "<p>The attendee information, including attendees IDs and join tokens.</p>",
"CreateMeetingWithAttendeesResponse$Attendees": "<p>The attendee information, including attendees IDs and join tokens.</p>",
"ListAttendeesResponse$Attendees": "<p>The Amazon Chime SDK attendee information.</p>"
}
},
"AttendeeTagKeyList": {
"base": null,
"refs": {
"UntagAttendeeRequest$TagKeys": "<p>The tag keys.</p>"
}
},
"AttendeeTagList": {
"base": null,
"refs": {
"CreateAttendeeRequest$Tags": "<p>The tag key-value pairs.</p>",
"CreateAttendeeRequestItem$Tags": "<p>The tag key-value pairs.</p>",
"TagAttendeeRequest$Tags": "<p>The tag key-value pairs.</p>"
}
},
"AudioArtifactsConfiguration": {
"base": "<p>The audio artifact configuration object.</p>",
"refs": {
"ArtifactsConfiguration$Audio": "<p>The configuration for the audio artifacts.</p>"
}
},
"AudioMuxType": {
"base": null,
"refs": {
"AudioArtifactsConfiguration$MuxType": "<p>The MUX type of the audio artifact configuration object.</p>"
}
},
"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>"
}
},
"BatchCreateAttendeeErrorList": {
"base": null,
"refs": {
"BatchCreateAttendeeResponse$Errors": "<p>If the action fails for one or more of the attendees in the request, a list of the attendees is returned, along with error codes and error messages.</p>",
"CreateMeetingWithAttendeesResponse$Errors": "<p>If the action fails for one or more of the attendees in the request, a list of the attendees is returned, along with error codes and error messages.</p>"
}
},
"BatchCreateAttendeeRequest": {
"base": null,
"refs": {
}
},
"BatchCreateAttendeeResponse": {
"base": null,
"refs": {
}
},
"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": {
}
},
"BatchCreateRoomMembershipRequest": {
"base": null,
"refs": {
}
},
"BatchCreateRoomMembershipResponse": {
"base": null,
"refs": {
}
},
"BatchDeletePhoneNumberRequest": {
"base": null,
"refs": {
}
},
"BatchDeletePhoneNumberResponse": {
"base": null,
"refs": {
}
},
"BatchSuspendUserRequest": {
"base": null,
"refs": {
}
},
"BatchSuspendUserResponse": {
"base": null,
"refs": {
}
},
"BatchUnsuspendUserRequest": {
"base": null,
"refs": {
}
},
"BatchUnsuspendUserResponse": {
"base": null,
"refs": {
}
},
"BatchUpdatePhoneNumberRequest": {
"base": null,
"refs": {
}
},
"BatchUpdatePhoneNumberResponse": {
"base": null,
"refs": {
}
},
"BatchUpdateUserRequest": {
"base": null,
"refs": {
}
},
"BatchUpdateUserResponse": {
"base": null,
"refs": {
}
},
"Boolean": {
"base": null,
"refs": {
"AccountSettings$DisableRemoteControl": "<p>Setting that stops or starts remote control of shared screens during meetings.</p>",
"AccountSettings$EnableDialOut": "<p>Setting that allows meeting participants to choose the <b>Call me at a phone number</b> option. For more information, see <a href=\"https://docs.aws.amazon.com/chime/latest/ug/chime-join-meeting.html\">Join a Meeting without the Amazon Chime App</a>.</p>",
"AlexaForBusinessMetadata$IsAlexaForBusinessEnabled": "<p>Starts or stops Alexa for Business.</p>",
"CreateVoiceConnectorRequest$RequireEncryption": "<p>When enabled, requires encryption for the Amazon Chime Voice Connector.</p>",
"LoggingConfiguration$EnableSIPLogs": "<p>When true, enables SIP message logs for sending to Amazon CloudWatch Logs.</p>",
"Origination$Disabled": "<p>When origination settings are disabled, inbound calls are not enabled for your Amazon Chime Voice Connector. This parameter is not required, but you must specify this parameter or <code>Routes</code>.</p>",
"Proxy$Disabled": "<p>When true, stops proxy sessions from being created on the specified Amazon Chime Voice Connector.</p>",
"PutVoiceConnectorProxyRequest$Disabled": "<p>When true, stops proxy sessions from being created on the specified Amazon Chime Voice Connector.</p>",
"SipMediaApplicationLoggingConfiguration$EnableSipMediaApplicationMessageLogs": "<p>Enables application message logs for the SIP media application.</p>",
"SipRule$Disabled": "<p>Indicates whether the SIP rule is enabled or disabled. You must disable a rule before you can delete it.</p>",
"StreamingConfiguration$Disabled": "<p>When true, media streaming to Amazon Kinesis is turned off.</p>",
"TelephonySettings$InboundCalling": "<p>Allows or denies inbound calling.</p>",
"TelephonySettings$OutboundCalling": "<p>Allows or denies outbound calling.</p>",
"TelephonySettings$SMS": "<p>Allows or denies SMS messaging.</p>",
"Termination$Disabled": "<p>When termination settings are disabled, outbound calls can not be made.</p>",
"UpdateVoiceConnectorRequest$RequireEncryption": "<p>When enabled, requires encryption for the Amazon Chime Voice Connector.</p>",
"VoiceConnector$RequireEncryption": "<p>Designates whether encryption is required for the Amazon Chime Voice Connector.</p>"
}
},
"Bot": {
"base": "<p>A resource that allows Enterprise account administrators to configure an interface to receive events from Amazon Chime.</p>",
"refs": {
"BotList$member": null,
"CreateBotResponse$Bot": "<p>The bot details.</p>",
"GetBotResponse$Bot": "<p>The chat bot details.</p>",
"RegenerateSecurityTokenResponse$Bot": null,
"UpdateBotResponse$Bot": "<p>The updated bot details.</p>"
}
},
"BotList": {
"base": null,
"refs": {
"ListBotsResponse$Bots": "<p>List of bots and bot details.</p>"
}
},
"BotType": {
"base": null,
"refs": {
"Bot$BotType": "<p>The bot type.</p>"
}
},
"BusinessCallingSettings": {
"base": "<p>The Amazon Chime Business Calling settings for the administrator's AWS account. Includes any Amazon S3 buckets designated for storing call detail records.</p>",
"refs": {
"GetGlobalSettingsResponse$BusinessCalling": "<p>The Amazon Chime Business Calling settings.</p>",
"UpdateGlobalSettingsRequest$BusinessCalling": "<p>The Amazon Chime Business Calling settings.</p>"
}
},
"CallingName": {
"base": null,
"refs": {
"GetPhoneNumberSettingsResponse$CallingName": "<p>The default outbound calling name for the account.</p>",
"PhoneNumber$CallingName": "<p>The outbound calling name associated with the phone number.</p>",
"UpdatePhoneNumberRequest$CallingName": "<p>The outbound calling name associated with the phone number.</p>",
"UpdatePhoneNumberRequestItem$CallingName": "<p>The outbound calling name to update.</p>",
"UpdatePhoneNumberSettingsRequest$CallingName": "<p>The default outbound calling name for the account.</p>"
}
},
"CallingNameStatus": {
"base": null,
"refs": {
"PhoneNumber$CallingNameStatus": "<p>The outbound calling name status.</p>"
}
},
"CallingRegion": {
"base": null,
"refs": {
"CallingRegionList$member": null
}
},
"CallingRegionList": {
"base": null,
"refs": {
"Termination$CallingRegions": "<p>The countries to which calls are allowed, in ISO 3166-1 alpha-2 format. Required.</p>"
}
},
"Capability": {
"base": null,
"refs": {
"CapabilityList$member": null
}
},
"CapabilityList": {
"base": null,
"refs": {
"CreateProxySessionRequest$Capabilities": "<p>The proxy session capabilities.</p>",
"ProxySession$Capabilities": "<p>The proxy session capabilities.</p>",
"UpdateProxySessionRequest$Capabilities": "<p>The proxy session capabilities.</p>"
}
},
"Channel": {
"base": "<p>The details of a channel.</p>",
"refs": {
"DescribeChannelResponse$Channel": "<p>The channel details.</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>"
}
},
"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 token passed by previous API calls until all requested users are returned.</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 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.</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>"
}
},
"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>"
}
},
"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>",
"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>"
}
},
"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>",
"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>"
}
},
"ChannelRetentionSettings": {
"base": "<p>The details of the retention settings for a channel.</p>",
"refs": {
"AppInstanceRetentionSettings$ChannelRetentionSettings": "<p>The length of time in days to retain the messages in a channel.</p>"
}
},
"ChannelSummary": {
"base": "<p>Summary of the details of a <code>Channel</code>.</p>",
"refs": {
"ChannelMembershipForAppInstanceUserSummary$ChannelSummary": null,
"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>"
}
},
"ChimeArn": {
"base": null,
"refs": {
"AppInstance$AppInstanceArn": "<p>The ARN of the messaging instance.</p>",
"AppInstanceAdmin$AppInstanceArn": "<p>The ARN of the <code>AppInstance</code> for which the user is an administrator.</p>",
"AppInstanceSummary$AppInstanceArn": "<p>The <code>AppInstance</code> ARN.</p>",
"AppInstanceUser$AppInstanceUserArn": "<p>The ARN of the <code>AppInstanceUser</code>.</p>",
"AppInstanceUserSummary$AppInstanceUserArn": "<p>The ARN of the <code>AppInstanceUser</code>.</p>",
"BatchChannelMemberships$ChannelArn": "<p>The ARN of the channel to which you're adding users.</p>",
"BatchCreateChannelMembershipError$MemberArn": "<p>The ARN 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 the channel.</p>",
"ChannelBan$ChannelArn": "<p>The ARN of the channel from which a member is being banned.</p>",
"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>",
"ChannelSummary$ChannelArn": "<p>The ARN of the channel.</p>",
"CreateAppInstanceAdminRequest$AppInstanceAdminArn": "<p>The ARN of the administrator of the current <code>AppInstance</code>.</p>",
"CreateAppInstanceAdminRequest$AppInstanceArn": "<p>The ARN of the <code>AppInstance</code>.</p>",
"CreateAppInstanceAdminResponse$AppInstanceArn": "<p>The ARN of the of the admin for the <code>AppInstance</code>.</p>",
"CreateAppInstanceResponse$AppInstanceArn": "<p>The Amazon Resource Number (ARN) of the <code>AppInstance</code>.</p>",
"CreateAppInstanceUserRequest$AppInstanceArn": "<p>The ARN of the <code>AppInstance</code> request.</p>",
"CreateAppInstanceUserResponse$AppInstanceUserArn": "<p>The user's ARN.</p>",
"CreateChannelBanRequest$ChannelArn": "<p>The ARN of the ban request.</p>",
"CreateChannelBanRequest$MemberArn": "<p>The ARN 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>",
"CreateChannelMembershipRequest$ChannelArn": "<p>The ARN of the channel to which you're adding users.</p>",
"CreateChannelMembershipRequest$MemberArn": "<p>The ARN 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 ARN 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>",
"DeleteAppInstanceAdminRequest$AppInstanceAdminArn": "<p>The ARN of the <code>AppInstance</code>'s administrator.</p>",
"DeleteAppInstanceAdminRequest$AppInstanceArn": "<p>The ARN of the <code>AppInstance</code>.</p>",
"DeleteAppInstanceRequest$AppInstanceArn": "<p>The ARN of the <code>AppInstance</code>.</p>",
"DeleteAppInstanceStreamingConfigurationsRequest$AppInstanceArn": "<p>The ARN of the streaming configurations being deleted.</p>",
"DeleteAppInstanceUserRequest$AppInstanceUserArn": "<p>The ARN of the user request being deleted.</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>",
"DeleteChannelMembershipRequest$ChannelArn": "<p>The ARN of the channel from which you want to remove the user.</p>",
"DeleteChannelMembershipRequest$MemberArn": "<p>The ARN 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 ARN 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>",
"DescribeAppInstanceAdminRequest$AppInstanceAdminArn": "<p>The ARN of the <code>AppInstanceAdmin</code>.</p>",
"DescribeAppInstanceAdminRequest$AppInstanceArn": "<p>The ARN of the <code>AppInstance</code>.</p>",
"DescribeAppInstanceRequest$AppInstanceArn": "<p>The ARN of the <code>AppInstance</code>.</p>",
"DescribeAppInstanceUserRequest$AppInstanceUserArn": "<p>The ARN of the <code>AppInstanceUser</code>.</p>",
"DescribeChannelBanRequest$ChannelArn": "<p>The ARN of the channel from which the user is banned.</p>",
"DescribeChannelBanRequest$MemberArn": "<p>The ARN of the member being banned.</p>",
"DescribeChannelBanRequest$ChimeBearer": "<p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</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 ARN 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 ARN 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>",
"GetAppInstanceRetentionSettingsRequest$AppInstanceArn": "<p>The ARN of the <code>AppInstance</code>.</p>",
"GetAppInstanceStreamingConfigurationsRequest$AppInstanceArn": "<p>The ARN of the <code>AppInstance</code>.</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>",
"Identity$Arn": "<p>The ARN in an Identity.</p>",
"ListAppInstanceAdminsRequest$AppInstanceArn": "<p>The ARN of the <code>AppInstance</code>.</p>",
"ListAppInstanceAdminsResponse$AppInstanceArn": "<p>The ARN of the <code>AppInstance</code>.</p>",
"ListAppInstanceUsersRequest$AppInstanceArn": "<p>The ARN of the <code>AppInstance</code>.</p>",
"ListAppInstanceUsersResponse$AppInstanceArn": "<p>The ARN of the <code>AppInstance</code>.</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>",
"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>",
"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>",
"MemberArns$member": null,
"PutAppInstanceRetentionSettingsRequest$AppInstanceArn": "<p>The ARN of the <code>AppInstance</code>.</p>",
"PutAppInstanceStreamingConfigurationsRequest$AppInstanceArn": "<p>The ARN of the <code>AppInstance</code>.</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>",
"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>",
"UpdateAppInstanceRequest$AppInstanceArn": "<p>The ARN of the <code>AppInstance</code>.</p>",
"UpdateAppInstanceResponse$AppInstanceArn": "<p>The ARN of the <code>AppInstance</code>. </p>",
"UpdateAppInstanceUserRequest$AppInstanceUserArn": "<p>The ARN of the <code>AppInstanceUser</code>.</p>",
"UpdateAppInstanceUserResponse$AppInstanceUserArn": "<p>The ARN of the <code>AppInstanceUser</code>.</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>"
}
},
"ChimeSdkMeetingConfiguration": {
"base": "<p>The configuration object of the Amazon Chime SDK meeting for a specified media capture pipeline. <code>SourceType</code> must be <code>ChimeSdkMeeting</code>.</p>",
"refs": {
"CreateMediaCapturePipelineRequest$ChimeSdkMeetingConfiguration": "<p>The configuration for a specified media capture pipeline. <code>SourceType</code> must be <code>ChimeSdkMeeting</code>.</p>",
"MediaCapturePipeline$ChimeSdkMeetingConfiguration": "<p>The configuration for a specified media capture pipeline. <code>SourceType</code> must be <code>ChimeSdkMeeting</code>.</p>"
}
},
"ClientRequestToken": {
"base": null,
"refs": {
"CreateAppInstanceRequest$ClientRequestToken": "<p>The <code>ClientRequestToken</code> of the <code>AppInstance</code>.</p>",
"CreateAppInstanceUserRequest$ClientRequestToken": "<p>The token assigned to the user requesting an <code>AppInstance</code>.</p>",
"CreateChannelRequest$ClientRequestToken": "<p>The client token for the request. An <code>Idempotency</code> token.</p>",
"CreateMediaCapturePipelineRequest$ClientRequestToken": "<p>The token assigned to the client making the pipeline request.</p>",
"CreateMeetingRequest$ClientRequestToken": "<p>The unique identifier for the client request. Use a different token for different meetings.</p>",
"CreateMeetingWithAttendeesRequest$ClientRequestToken": "<p>The unique identifier for the client request. Use a different token for different meetings.</p>",
"CreateRoomRequest$ClientRequestToken": "<p>The idempotency token for the request.</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>",