/
chime.jl
7749 lines (7002 loc) · 238 KB
/
chime.jl
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
# This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: chime
using AWS.Compat
using AWS.UUIDs
"""
associate_phone_number_with_user(e164_phone_number, account_id, user_id)
associate_phone_number_with_user(e164_phone_number, account_id, user_id, params::Dict{String,<:Any})
Associates a phone number with the specified Amazon Chime user.
# Arguments
- `e164_phone_number`: The phone number, in E.164 format.
- `account_id`: The Amazon Chime account ID.
- `user_id`: The user ID.
"""
function associate_phone_number_with_user(
E164PhoneNumber, accountId, userId; aws_config::AbstractAWSConfig=global_aws_config()
)
return chime(
"POST",
"/accounts/$(accountId)/users/$(userId)?operation=associate-phone-number",
Dict{String,Any}("E164PhoneNumber" => E164PhoneNumber);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_phone_number_with_user(
E164PhoneNumber,
accountId,
userId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return chime(
"POST",
"/accounts/$(accountId)/users/$(userId)?operation=associate-phone-number",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("E164PhoneNumber" => E164PhoneNumber), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_phone_numbers_with_voice_connector(e164_phone_numbers, voice_connector_id)
associate_phone_numbers_with_voice_connector(e164_phone_numbers, voice_connector_id, params::Dict{String,<:Any})
Associates phone numbers with the specified Amazon Chime Voice Connector.
# Arguments
- `e164_phone_numbers`: List of phone numbers, in E.164 format.
- `voice_connector_id`: The Amazon Chime Voice Connector ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ForceAssociate"`: If true, associates the provided phone numbers with the provided
Amazon Chime Voice Connector and removes any previously existing associations. If false,
does not associate any phone numbers that have previously existing associations.
"""
function associate_phone_numbers_with_voice_connector(
E164PhoneNumbers, voiceConnectorId; aws_config::AbstractAWSConfig=global_aws_config()
)
return chime(
"POST",
"/voice-connectors/$(voiceConnectorId)?operation=associate-phone-numbers",
Dict{String,Any}("E164PhoneNumbers" => E164PhoneNumbers);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_phone_numbers_with_voice_connector(
E164PhoneNumbers,
voiceConnectorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return chime(
"POST",
"/voice-connectors/$(voiceConnectorId)?operation=associate-phone-numbers",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("E164PhoneNumbers" => E164PhoneNumbers), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_phone_numbers_with_voice_connector_group(e164_phone_numbers, voice_connector_group_id)
associate_phone_numbers_with_voice_connector_group(e164_phone_numbers, voice_connector_group_id, params::Dict{String,<:Any})
Associates phone numbers with the specified Amazon Chime Voice Connector group.
# Arguments
- `e164_phone_numbers`: List of phone numbers, in E.164 format.
- `voice_connector_group_id`: The Amazon Chime Voice Connector group ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ForceAssociate"`: If true, associates the provided phone numbers with the provided
Amazon Chime Voice Connector Group and removes any previously existing associations. If
false, does not associate any phone numbers that have previously existing associations.
"""
function associate_phone_numbers_with_voice_connector_group(
E164PhoneNumbers,
voiceConnectorGroupId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return chime(
"POST",
"/voice-connector-groups/$(voiceConnectorGroupId)?operation=associate-phone-numbers",
Dict{String,Any}("E164PhoneNumbers" => E164PhoneNumbers);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_phone_numbers_with_voice_connector_group(
E164PhoneNumbers,
voiceConnectorGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return chime(
"POST",
"/voice-connector-groups/$(voiceConnectorGroupId)?operation=associate-phone-numbers",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("E164PhoneNumbers" => E164PhoneNumbers), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_signin_delegate_groups_with_account(signin_delegate_groups, account_id)
associate_signin_delegate_groups_with_account(signin_delegate_groups, account_id, params::Dict{String,<:Any})
Associates the specified sign-in delegate groups with the specified Amazon Chime account.
# Arguments
- `signin_delegate_groups`: The sign-in delegate groups.
- `account_id`: The Amazon Chime account ID.
"""
function associate_signin_delegate_groups_with_account(
SigninDelegateGroups, accountId; aws_config::AbstractAWSConfig=global_aws_config()
)
return chime(
"POST",
"/accounts/$(accountId)?operation=associate-signin-delegate-groups",
Dict{String,Any}("SigninDelegateGroups" => SigninDelegateGroups);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_signin_delegate_groups_with_account(
SigninDelegateGroups,
accountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return chime(
"POST",
"/accounts/$(accountId)?operation=associate-signin-delegate-groups",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("SigninDelegateGroups" => SigninDelegateGroups),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_create_attendee(attendees, meeting_id)
batch_create_attendee(attendees, meeting_id, params::Dict{String,<:Any})
Creates up to 100 new attendees for an active Amazon Chime SDK meeting. For more
information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime
SDK Developer Guide.
# Arguments
- `attendees`: The request containing the attendees to create.
- `meeting_id`: The Amazon Chime SDK meeting ID.
"""
function batch_create_attendee(
Attendees, meetingId; aws_config::AbstractAWSConfig=global_aws_config()
)
return chime(
"POST",
"/meetings/$(meetingId)/attendees?operation=batch-create",
Dict{String,Any}("Attendees" => Attendees);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_create_attendee(
Attendees,
meetingId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return chime(
"POST",
"/meetings/$(meetingId)/attendees?operation=batch-create",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Attendees" => Attendees), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_create_channel_membership(member_arns, channel_arn)
batch_create_channel_membership(member_arns, channel_arn, params::Dict{String,<:Any})
Adds a specified number of users to a channel.
# Arguments
- `member_arns`: The ARNs of the members you want to add to the channel.
- `channel_arn`: The ARN of the channel to which you're adding users.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Type"`: The membership type of a user, DEFAULT or HIDDEN. Default members are always
returned as part of ListChannelMemberships. Hidden members are only returned if the type
filter in ListChannelMemberships equals HIDDEN. Otherwise hidden members are not returned.
This is only supported by moderators.
- `"x-amz-chime-bearer"`: The AppInstanceUserArn of the user that makes the API call.
"""
function batch_create_channel_membership(
MemberArns, channelArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return chime(
"POST",
"/channels/$(channelArn)/memberships?operation=batch-create",
Dict{String,Any}("MemberArns" => MemberArns);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_create_channel_membership(
MemberArns,
channelArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return chime(
"POST",
"/channels/$(channelArn)/memberships?operation=batch-create",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("MemberArns" => MemberArns), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_create_room_membership(membership_item_list, account_id, room_id)
batch_create_room_membership(membership_item_list, account_id, room_id, params::Dict{String,<:Any})
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.
# Arguments
- `membership_item_list`: The list of membership items.
- `account_id`: The Amazon Chime account ID.
- `room_id`: The room ID.
"""
function batch_create_room_membership(
MembershipItemList, accountId, roomId; aws_config::AbstractAWSConfig=global_aws_config()
)
return chime(
"POST",
"/accounts/$(accountId)/rooms/$(roomId)/memberships?operation=batch-create",
Dict{String,Any}("MembershipItemList" => MembershipItemList);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_create_room_membership(
MembershipItemList,
accountId,
roomId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return chime(
"POST",
"/accounts/$(accountId)/rooms/$(roomId)/memberships?operation=batch-create",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("MembershipItemList" => MembershipItemList), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_delete_phone_number(phone_number_ids)
batch_delete_phone_number(phone_number_ids, params::Dict{String,<:Any})
Moves phone numbers into the Deletion queue. Phone numbers must be disassociated from any
users or Amazon Chime Voice Connectors before they can be deleted. Phone numbers remain
in the Deletion queue for 7 days before they are deleted permanently.
# Arguments
- `phone_number_ids`: List of phone number IDs.
"""
function batch_delete_phone_number(
PhoneNumberIds; aws_config::AbstractAWSConfig=global_aws_config()
)
return chime(
"POST",
"/phone-numbers?operation=batch-delete",
Dict{String,Any}("PhoneNumberIds" => PhoneNumberIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_delete_phone_number(
PhoneNumberIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return chime(
"POST",
"/phone-numbers?operation=batch-delete",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("PhoneNumberIds" => PhoneNumberIds), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_suspend_user(user_id_list, account_id)
batch_suspend_user(user_id_list, account_id, params::Dict{String,<:Any})
Suspends up to 50 users from a Team or EnterpriseLWA Amazon Chime account. For more
information about different account types, see Managing Your Amazon Chime Accounts in the
Amazon Chime Administration Guide. Users suspended from a Team account are disassociated
from the account,but they can continue to use Amazon Chime as free users. To remove the
suspension from suspended Team account users, invite them to the Team account again. You
can use the InviteUsers action to do so. Users suspended from an EnterpriseLWA account are
immediately signed out of Amazon Chime and can no longer sign in. To remove the suspension
from suspended EnterpriseLWA account users, use the BatchUnsuspendUser action. To sign out
users without suspending them, use the LogoutUser action.
# Arguments
- `user_id_list`: The request containing the user IDs to suspend.
- `account_id`: The Amazon Chime account ID.
"""
function batch_suspend_user(
UserIdList, accountId; aws_config::AbstractAWSConfig=global_aws_config()
)
return chime(
"POST",
"/accounts/$(accountId)/users?operation=suspend",
Dict{String,Any}("UserIdList" => UserIdList);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_suspend_user(
UserIdList,
accountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return chime(
"POST",
"/accounts/$(accountId)/users?operation=suspend",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("UserIdList" => UserIdList), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_unsuspend_user(user_id_list, account_id)
batch_unsuspend_user(user_id_list, account_id, params::Dict{String,<:Any})
Removes the suspension from up to 50 previously suspended users for the specified Amazon
Chime EnterpriseLWA account. Only users on EnterpriseLWA accounts can be unsuspended using
this action. For more information about different account types, see Managing Your Amazon
Chime Accounts in the account types, in the Amazon Chime Administration Guide.
Previously suspended users who are unsuspended using this action are returned to Registered
status. Users who are not previously suspended are ignored.
# Arguments
- `user_id_list`: The request containing the user IDs to unsuspend.
- `account_id`: The Amazon Chime account ID.
"""
function batch_unsuspend_user(
UserIdList, accountId; aws_config::AbstractAWSConfig=global_aws_config()
)
return chime(
"POST",
"/accounts/$(accountId)/users?operation=unsuspend",
Dict{String,Any}("UserIdList" => UserIdList);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_unsuspend_user(
UserIdList,
accountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return chime(
"POST",
"/accounts/$(accountId)/users?operation=unsuspend",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("UserIdList" => UserIdList), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_update_phone_number(update_phone_number_request_items)
batch_update_phone_number(update_phone_number_request_items, params::Dict{String,<:Any})
Updates phone number product types or calling names. You can update one attribute at a time
for each UpdatePhoneNumberRequestItem. For example, you can update the product type or the
calling name. 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. 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.
# Arguments
- `update_phone_number_request_items`: The request containing the phone number IDs and
product types or calling names to update.
"""
function batch_update_phone_number(
UpdatePhoneNumberRequestItems; aws_config::AbstractAWSConfig=global_aws_config()
)
return chime(
"POST",
"/phone-numbers?operation=batch-update",
Dict{String,Any}("UpdatePhoneNumberRequestItems" => UpdatePhoneNumberRequestItems);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_update_phone_number(
UpdatePhoneNumberRequestItems,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return chime(
"POST",
"/phone-numbers?operation=batch-update",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"UpdatePhoneNumberRequestItems" => UpdatePhoneNumberRequestItems
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_update_user(update_user_request_items, account_id)
batch_update_user(update_user_request_items, account_id, params::Dict{String,<:Any})
Updates user details within the UpdateUserRequestItem object for up to 20 users for the
specified Amazon Chime account. Currently, only LicenseType updates are supported for this
action.
# Arguments
- `update_user_request_items`: The request containing the user IDs and details to update.
- `account_id`: The Amazon Chime account ID.
"""
function batch_update_user(
UpdateUserRequestItems, accountId; aws_config::AbstractAWSConfig=global_aws_config()
)
return chime(
"POST",
"/accounts/$(accountId)/users",
Dict{String,Any}("UpdateUserRequestItems" => UpdateUserRequestItems);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_update_user(
UpdateUserRequestItems,
accountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return chime(
"POST",
"/accounts/$(accountId)/users",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("UpdateUserRequestItems" => UpdateUserRequestItems),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_account(name)
create_account(name, params::Dict{String,<:Any})
Creates an Amazon Chime account under the administrator's AWS account. Only Team account
types are currently supported for this action. For more information about different account
types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.
# Arguments
- `name`: The name of the Amazon Chime account.
"""
function create_account(Name; aws_config::AbstractAWSConfig=global_aws_config())
return chime(
"POST",
"/accounts",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_account(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return chime(
"POST",
"/accounts",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_app_instance(client_request_token, name)
create_app_instance(client_request_token, name, params::Dict{String,<:Any})
Creates an Amazon Chime SDK messaging AppInstance under an AWS account. Only SDK messaging
customers use this API. CreateAppInstance supports idempotency behavior as described in the
AWS API Standard.
# Arguments
- `client_request_token`: The ClientRequestToken of the AppInstance.
- `name`: The name of the AppInstance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Metadata"`: The metadata of the AppInstance. Limited to a 1KB string in UTF-8.
- `"Tags"`: Tags assigned to the AppInstance.
"""
function create_app_instance(
ClientRequestToken, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return chime(
"POST",
"/app-instances",
Dict{String,Any}("ClientRequestToken" => ClientRequestToken, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_app_instance(
ClientRequestToken,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return chime(
"POST",
"/app-instances",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientRequestToken" => ClientRequestToken, "Name" => Name
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_app_instance_admin(app_instance_admin_arn, app_instance_arn)
create_app_instance_admin(app_instance_admin_arn, app_instance_arn, params::Dict{String,<:Any})
Promotes an AppInstanceUser to an AppInstanceAdmin. The promoted user can perform the
following actions. ChannelModerator actions across all channels in the AppInstance.
DeleteChannelMessage actions. Only an AppInstanceUser can be promoted to an
AppInstanceAdmin role.
# Arguments
- `app_instance_admin_arn`: The ARN of the administrator of the current AppInstance.
- `app_instance_arn`: The ARN of the AppInstance.
"""
function create_app_instance_admin(
AppInstanceAdminArn, appInstanceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return chime(
"POST",
"/app-instances/$(appInstanceArn)/admins",
Dict{String,Any}("AppInstanceAdminArn" => AppInstanceAdminArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_app_instance_admin(
AppInstanceAdminArn,
appInstanceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return chime(
"POST",
"/app-instances/$(appInstanceArn)/admins",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("AppInstanceAdminArn" => AppInstanceAdminArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_app_instance_user(app_instance_arn, app_instance_user_id, client_request_token, name)
create_app_instance_user(app_instance_arn, app_instance_user_id, client_request_token, name, params::Dict{String,<:Any})
Creates a user under an Amazon Chime AppInstance. The request consists of a unique
appInstanceUserId and Name for that user.
# Arguments
- `app_instance_arn`: The ARN of the AppInstance request.
- `app_instance_user_id`: The user ID of the AppInstance.
- `client_request_token`: The token assigned to the user requesting an AppInstance.
- `name`: The user's name.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Metadata"`: The request's metadata. Limited to a 1KB string in UTF-8.
- `"Tags"`: Tags assigned to the AppInstanceUser.
"""
function create_app_instance_user(
AppInstanceArn,
AppInstanceUserId,
ClientRequestToken,
Name;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return chime(
"POST",
"/app-instance-users",
Dict{String,Any}(
"AppInstanceArn" => AppInstanceArn,
"AppInstanceUserId" => AppInstanceUserId,
"ClientRequestToken" => ClientRequestToken,
"Name" => Name,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_app_instance_user(
AppInstanceArn,
AppInstanceUserId,
ClientRequestToken,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return chime(
"POST",
"/app-instance-users",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AppInstanceArn" => AppInstanceArn,
"AppInstanceUserId" => AppInstanceUserId,
"ClientRequestToken" => ClientRequestToken,
"Name" => Name,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_attendee(external_user_id, meeting_id)
create_attendee(external_user_id, meeting_id, params::Dict{String,<:Any})
Creates a new attendee for an active Amazon Chime SDK meeting. For more information about
the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer
Guide.
# Arguments
- `external_user_id`: The Amazon Chime SDK external user ID. An idempotency token. Links
the attendee to an identity managed by a builder application.
- `meeting_id`: The Amazon Chime SDK meeting ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: The tag key-value pairs.
"""
function create_attendee(
ExternalUserId, meetingId; aws_config::AbstractAWSConfig=global_aws_config()
)
return chime(
"POST",
"/meetings/$(meetingId)/attendees",
Dict{String,Any}("ExternalUserId" => ExternalUserId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_attendee(
ExternalUserId,
meetingId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return chime(
"POST",
"/meetings/$(meetingId)/attendees",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ExternalUserId" => ExternalUserId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_bot(display_name, account_id)
create_bot(display_name, account_id, params::Dict{String,<:Any})
Creates a bot for an Amazon Chime Enterprise account.
# Arguments
- `display_name`: The bot display name.
- `account_id`: The Amazon Chime account ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Domain"`: The domain of the Amazon Chime Enterprise account.
"""
function create_bot(
DisplayName, accountId; aws_config::AbstractAWSConfig=global_aws_config()
)
return chime(
"POST",
"/accounts/$(accountId)/bots",
Dict{String,Any}("DisplayName" => DisplayName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_bot(
DisplayName,
accountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return chime(
"POST",
"/accounts/$(accountId)/bots",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DisplayName" => DisplayName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_channel(app_instance_arn, client_request_token, name)
create_channel(app_instance_arn, client_request_token, name, params::Dict{String,<:Any})
Creates a channel to which you can add users and send messages. Restriction: You can't
change a channel's privacy. The x-amz-chime-bearer request header is mandatory. Use the
AppInstanceUserArn of the user that makes the API call as the value in the header.
# Arguments
- `app_instance_arn`: The ARN of the channel request.
- `client_request_token`: The client token for the request. An Idempotency token.
- `name`: The name of the channel.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Metadata"`: The metadata of the creation request. Limited to 1KB and UTF-8.
- `"Mode"`: The channel mode: UNRESTRICTED or RESTRICTED. Administrators, moderators, and
channel members can add themselves and other members to unrestricted channels. Only
administrators and moderators can add members to restricted channels.
- `"Privacy"`: The channel's privacy level: PUBLIC or PRIVATE. Private channels aren't
discoverable by users outside the channel. Public channels are discoverable by anyone in
the AppInstance.
- `"Tags"`: The tags for the creation request.
- `"x-amz-chime-bearer"`: The AppInstanceUserArn of the user that makes the API call.
"""
function create_channel(
AppInstanceArn,
ClientRequestToken,
Name;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return chime(
"POST",
"/channels",
Dict{String,Any}(
"AppInstanceArn" => AppInstanceArn,
"ClientRequestToken" => ClientRequestToken,
"Name" => Name,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_channel(
AppInstanceArn,
ClientRequestToken,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return chime(
"POST",
"/channels",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AppInstanceArn" => AppInstanceArn,
"ClientRequestToken" => ClientRequestToken,
"Name" => Name,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_channel_ban(member_arn, channel_arn)
create_channel_ban(member_arn, channel_arn, params::Dict{String,<:Any})
Permanently bans a member from a channel. Moderators can't add banned members to a channel.
To undo a ban, you first have to DeleteChannelBan, and then CreateChannelMembership. Bans
are cleaned up when you delete users or channels. If you ban a user who is already part of
a channel, that user is automatically kicked from the channel. The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call
as the value in the header.
# Arguments
- `member_arn`: The ARN of the member being banned.
- `channel_arn`: The ARN of the ban request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-chime-bearer"`: The AppInstanceUserArn of the user that makes the API call.
"""
function create_channel_ban(
MemberArn, channelArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return chime(
"POST",
"/channels/$(channelArn)/bans",
Dict{String,Any}("MemberArn" => MemberArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_channel_ban(
MemberArn,
channelArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return chime(
"POST",
"/channels/$(channelArn)/bans",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("MemberArn" => MemberArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_channel_membership(member_arn, type, channel_arn)
create_channel_membership(member_arn, type, channel_arn, params::Dict{String,<:Any})
Adds a user to a channel. The InvitedBy response field is derived from the request header.
A channel member can: List messages Send messages Receive messages Edit their own
messages Leave the channel Privacy settings impact this action as follows: Public
Channels: You do not need to be a member to list messages, but you must be a member to send
messages. Private Channels: You must be a member to list or send messages. The
x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that
makes the API call as the value in the header.
# Arguments
- `member_arn`: The ARN of the member you want to add to the channel.
- `type`: The membership type of a user, DEFAULT or HIDDEN. Default members are always
returned as part of ListChannelMemberships. Hidden members are only returned if the type
filter in ListChannelMemberships equals HIDDEN. Otherwise hidden members are not returned.
This is only supported by moderators.
- `channel_arn`: The ARN of the channel to which you're adding users.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-chime-bearer"`: The AppInstanceUserArn of the user that makes the API call.
"""
function create_channel_membership(
MemberArn, Type, channelArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return chime(
"POST",
"/channels/$(channelArn)/memberships",
Dict{String,Any}("MemberArn" => MemberArn, "Type" => Type);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_channel_membership(
MemberArn,
Type,
channelArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return chime(
"POST",
"/channels/$(channelArn)/memberships",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("MemberArn" => MemberArn, "Type" => Type), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_channel_moderator(channel_moderator_arn, channel_arn)
create_channel_moderator(channel_moderator_arn, channel_arn, params::Dict{String,<:Any})