Amazon Chime SDK

API Reference
 Amazon Chime SDK API Reference

Amazon Chime SDK: API Reference

Copyright © 2023 Amazon Web Services, Inc. and/or its affiliates. All rights reserved.

Amazon's trademarks and trade dress may not be used in connection with any product or service that is not
Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or
discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may
or may not be affiliated with, connected to, or sponsored by Amazon.
 Amazon Chime SDK API Reference

Table of Contents
Welcome ........................................................................................................................................... 1
Amazon Chime SDK Identity ........................................................................................................ 1
Amazon Chime SDK Media Pipelines ............................................................................................. 2
Amazon Chime SDK Meetings ...................................................................................................... 2
Amazon Chime SDK Messaging .................................................................................................... 2
Amazon Chime SDK Voice ........................................................................................................... 2
Actions ............................................................................................................................................. 3
Amazon Chime ......................................................................................................................... 11
AssociatePhoneNumbersWithVoiceConnector ....................................................................... 16
AssociatePhoneNumbersWithVoiceConnectorGroup .............................................................. 19
AssociatePhoneNumberWithUser ........................................................................................ 23
AssociateSigninDelegateGroupsWithAccount ........................................................................ 26
BatchCreateAttendee ........................................................................................................ 29
BatchCreateChannelMembership ........................................................................................ 32
BatchCreateRoomMembership ............................................................................................ 35
BatchDeletePhoneNumber ................................................................................................. 38
BatchSuspendUser ............................................................................................................ 41
BatchUnsuspendUser ........................................................................................................ 44
BatchUpdatePhoneNumber ................................................................................................ 47
BatchUpdateUser .............................................................................................................. 51
CreateAccount .................................................................................................................. 54
CreateAppInstance ............................................................................................................ 57
CreateAppInstanceAdmin ................................................................................................... 60
CreateAppInstanceUser ..................................................................................................... 63
CreateAttendee ................................................................................................................ 67
CreateBot ........................................................................................................................ 70
CreateChannel .................................................................................................................. 74
CreateChannelBan ............................................................................................................ 78
CreateChannelMembership ................................................................................................ 81
CreateChannelModerator ................................................................................................... 85
CreateMediaCapturePipeline .............................................................................................. 88
CreateMeeting .................................................................................................................. 92
CreateMeetingDialOut ....................................................................................................... 96
CreateMeetingWithAttendees ............................................................................................. 99
CreatePhoneNumberOrder ............................................................................................... 103
CreateProxySession ......................................................................................................... 106
CreateRoom ................................................................................................................... 111
CreateRoomMembership .................................................................................................. 114
CreateSipMediaApplication ............................................................................................... 118
CreateSipMediaApplicationCall ......................................................................................... 121
CreateSipRule ................................................................................................................. 124
CreateUser ..................................................................................................................... 128
CreateVoiceConnector ..................................................................................................... 132
CreateVoiceConnectorGroup ............................................................................................. 136
DeleteAccount ................................................................................................................ 140
DeleteAppInstance .......................................................................................................... 143
DeleteAppInstanceAdmin ................................................................................................. 145
DeleteAppInstanceStreamingConfigurations ....................................................................... 147
DeleteAppInstanceUser .................................................................................................... 149
DeleteAttendee .............................................................................................................. 151
DeleteChannel ................................................................................................................ 153
DeleteChannelBan .......................................................................................................... 155
DeleteChannelMembership .............................................................................................. 157
DeleteChannelMessage .................................................................................................... 160

iii
 Amazon Chime SDK API Reference

DeleteChannelModerator ................................................................................................. 162

DeleteEventsConfiguration ............................................................................................... 164
DeleteMediaCapturePipeline ............................................................................................. 166
DeleteMeeting ................................................................................................................ 168
DeletePhoneNumber ....................................................................................................... 170
DeleteProxySession ......................................................................................................... 173
DeleteRoom ................................................................................................................... 176
DeleteRoomMembership .................................................................................................. 179
DeleteSipMediaApplication ............................................................................................... 182
DeleteSipRule ................................................................................................................. 184
DeleteVoiceConnector ..................................................................................................... 186
DeleteVoiceConnectorEmergencyCallingConfiguration ......................................................... 189
DeleteVoiceConnectorGroup ............................................................................................. 191
DeleteVoiceConnectorOrigination ..................................................................................... 194
DeleteVoiceConnectorProxy ............................................................................................. 197
DeleteVoiceConnectorStreamingConfiguration .................................................................... 200
DeleteVoiceConnectorTermination .................................................................................... 203
DeleteVoiceConnectorTerminationCredentials ..................................................................... 206
DescribeAppInstance ....................................................................................................... 209
DescribeAppInstanceAdmin .............................................................................................. 211
DescribeAppInstanceUser ................................................................................................. 214
DescribeChannel ............................................................................................................. 216
DescribeChannelBan ........................................................................................................ 219
DescribeChannelMembership ............................................................................................ 222
DescribeChannelMembershipForAppInstanceUser ................................................................ 225
DescribeChannelModeratedByAppInstanceUser ................................................................... 228
DescribeChannelModerator .............................................................................................. 231
DisassociatePhoneNumberFromUser .................................................................................. 234
DisassociatePhoneNumbersFromVoiceConnector ................................................................. 237
DisassociatePhoneNumbersFromVoiceConnectorGroup ........................................................ 240
DisassociateSigninDelegateGroupsFromAccount .................................................................. 243
GetAccount .................................................................................................................... 246
GetAccountSettings ......................................................................................................... 249
GetAppInstanceRetentionSettings ..................................................................................... 252
GetAppInstanceStreamingConfigurations ........................................................................... 255
GetAttendee .................................................................................................................. 257
GetBot .......................................................................................................................... 260
GetChannelMessage ........................................................................................................ 263
GetEventsConfiguration ................................................................................................... 266
GetGlobalSettings ........................................................................................................... 269
GetMediaCapturePipeline ................................................................................................. 272
GetMeeting .................................................................................................................... 275
GetMessagingSessionEndpoint .......................................................................................... 278
GetPhoneNumber ........................................................................................................... 280
GetPhoneNumberOrder ................................................................................................... 283
GetPhoneNumberSettings ................................................................................................ 286
GetProxySession ............................................................................................................. 289
GetRetentionSettings ...................................................................................................... 292
GetRoom ....................................................................................................................... 295
GetSipMediaApplication ................................................................................................... 298
GetSipMediaApplicationLoggingConfiguration .................................................................... 300
GetSipRule ..................................................................................................................... 302
GetUser ......................................................................................................................... 305
GetUserSettings ............................................................................................................. 308
GetVoiceConnector ......................................................................................................... 311
GetVoiceConnectorEmergencyCallingConfiguration ............................................................. 314
GetVoiceConnectorGroup ................................................................................................. 316

iv
 Amazon Chime SDK API Reference

GetVoiceConnectorLoggingConfiguration ........................................................................... 319

GetVoiceConnectorOrigination .......................................................................................... 322
GetVoiceConnectorProxy .................................................................................................. 325
GetVoiceConnectorStreamingConfiguration ........................................................................ 328
GetVoiceConnectorTermination ......................................................................................... 331
GetVoiceConnectorTerminationHealth ............................................................................... 334
InviteUsers ..................................................................................................................... 337
ListAccounts ................................................................................................................... 340
ListAppInstanceAdmins .................................................................................................... 344
ListAppInstances ............................................................................................................. 347
ListAppInstanceUsers ...................................................................................................... 350
ListAttendees ................................................................................................................. 353
ListAttendeeTags ............................................................................................................ 356
ListBots ......................................................................................................................... 359
ListChannelBans ............................................................................................................. 362
ListChannelMemberships ................................................................................................. 365
ListChannelMembershipsForAppInstanceUser ..................................................................... 368
ListChannelMessages ....................................................................................................... 371
ListChannelModerators .................................................................................................... 375
ListChannels ................................................................................................................... 378
ListChannelsModeratedByAppInstanceUser ......................................................................... 381
ListMediaCapturePipelines ............................................................................................... 384
ListMeetings ................................................................................................................... 387
ListMeetingTags .............................................................................................................. 390
ListPhoneNumberOrders .................................................................................................. 392
ListPhoneNumbers .......................................................................................................... 395
ListProxySessions ............................................................................................................ 399
ListRoomMemberships ..................................................................................................... 403
ListRooms ...................................................................................................................... 407
ListSipMediaApplications ................................................................................................. 410
ListSipRules ................................................................................................................... 413
ListSupportedPhoneNumberCountries ............................................................................... 416
ListTagsForResource ........................................................................................................ 418
ListUsers ........................................................................................................................ 420
ListVoiceConnectorGroups ............................................................................................... 424
ListVoiceConnectors ........................................................................................................ 427
ListVoiceConnectorTerminationCredentials ......................................................................... 430
LogoutUser .................................................................................................................... 433
PutAppInstanceRetentionSettings ..................................................................................... 436
PutAppInstanceStreamingConfigurations ........................................................................... 439
PutEventsConfiguration ................................................................................................... 442
PutRetentionSettings ...................................................................................................... 445
PutSipMediaApplicationLoggingConfiguration .................................................................... 448
PutVoiceConnectorEmergencyCallingConfiguration ............................................................. 451
PutVoiceConnectorLoggingConfiguration ........................................................................... 454
PutVoiceConnectorOrigination .......................................................................................... 457
PutVoiceConnectorProxy .................................................................................................. 461
PutVoiceConnectorStreamingConfiguration ........................................................................ 465
PutVoiceConnectorTermination ......................................................................................... 468
PutVoiceConnectorTerminationCredentials ......................................................................... 471
RedactChannelMessage ................................................................................................... 474
RedactConversationMessage ............................................................................................. 477
RedactRoomMessage ....................................................................................................... 479
RegenerateSecurityToken ................................................................................................. 481
ResetPersonalPIN ............................................................................................................ 484
RestorePhoneNumber ...................................................................................................... 487
SearchAvailablePhoneNumbers ......................................................................................... 490

v
 Amazon Chime SDK API Reference

SendChannelMessage ...................................................................................................... 494

StartMeetingTranscription ................................................................................................ 498
StopMeetingTranscription ................................................................................................ 501
TagAttendee .................................................................................................................. 503
TagMeeting .................................................................................................................... 506
TagResource ................................................................................................................... 508
UntagAttendee ............................................................................................................... 510
UntagMeeting ................................................................................................................ 512
UntagResource ............................................................................................................... 514
UpdateAccount ............................................................................................................... 516
UpdateAccountSettings ................................................................................................... 520
UpdateAppInstance ......................................................................................................... 523
UpdateAppInstanceUser .................................................................................................. 526
UpdateBot ..................................................................................................................... 529
UpdateChannel ............................................................................................................... 532
UpdateChannelMessage ................................................................................................... 535
UpdateChannelReadMarker .............................................................................................. 538
UpdateGlobalSettings ..................................................................................................... 541
UpdatePhoneNumber ...................................................................................................... 544
UpdatePhoneNumberSettings .......................................................................................... 548
UpdateProxySession ........................................................................................................ 551
UpdateRoom .................................................................................................................. 555
UpdateRoomMembership ................................................................................................. 558
UpdateSipMediaApplication ............................................................................................. 562
UpdateSipMediaApplicationCall ........................................................................................ 565
UpdateSipRule ............................................................................................................... 568
UpdateUser .................................................................................................................... 571
UpdateUserSettings ........................................................................................................ 575
UpdateVoiceConnector .................................................................................................... 578
UpdateVoiceConnectorGroup ........................................................................................... 581
ValidateE911Address ....................................................................................................... 585
Amazon Chime SDK Identity .................................................................................................... 588
CreateAppInstance .......................................................................................................... 590
CreateAppInstanceAdmin ................................................................................................. 593
CreateAppInstanceUser .................................................................................................... 596
DeleteAppInstance .......................................................................................................... 600
DeleteAppInstanceAdmin ................................................................................................. 602
DeleteAppInstanceUser .................................................................................................... 604
DeregisterAppInstanceUserEndpoint .................................................................................. 606
DescribeAppInstance ....................................................................................................... 608
DescribeAppInstanceAdmin .............................................................................................. 610
DescribeAppInstanceUser ................................................................................................. 613
DescribeAppInstanceUserEndpoint .................................................................................... 615
GetAppInstanceRetentionSettings ..................................................................................... 618
ListAppInstanceAdmins .................................................................................................... 620
ListAppInstances ............................................................................................................. 623
ListAppInstanceUserEndpoints .......................................................................................... 626
ListAppInstanceUsers ...................................................................................................... 629
ListTagsForResource ........................................................................................................ 632
PutAppInstanceRetentionSettings ..................................................................................... 634
RegisterAppInstanceUserEndpoint ..................................................................................... 637
TagResource ................................................................................................................... 641
UntagResource ............................................................................................................... 643
UpdateAppInstance ......................................................................................................... 645
UpdateAppInstanceUser .................................................................................................. 648
UpdateAppInstanceUserEndpoint ...................................................................................... 651
Amazon Chime SDK Media Pipelines ......................................................................................... 653

vi
 Amazon Chime SDK API Reference

CreateMediaCapturePipeline ............................................................................................. 655

CreateMediaConcatenationPipeline ................................................................................... 660
CreateMediaLiveConnectorPipeline .................................................................................... 664
DeleteMediaCapturePipeline ............................................................................................. 668
DeleteMediaPipeline ........................................................................................................ 670
GetMediaCapturePipeline ................................................................................................. 672
GetMediaPipeline ............................................................................................................ 675
ListMediaCapturePipelines ............................................................................................... 679
ListMediaPipelines .......................................................................................................... 682
ListTagsForResource ........................................................................................................ 685
TagResource ................................................................................................................... 687
UntagResource ............................................................................................................... 690
Amazon Chime SDK Meetings .................................................................................................. 692
BatchCreateAttendee ...................................................................................................... 693
BatchUpdateAttendeeCapabilitiesExcept ............................................................................ 696
CreateAttendee .............................................................................................................. 699
CreateMeeting ................................................................................................................ 703
CreateMeetingWithAttendees ........................................................................................... 708
DeleteAttendee .............................................................................................................. 713
DeleteMeeting ................................................................................................................ 715
GetAttendee .................................................................................................................. 717
GetMeeting .................................................................................................................... 720
ListAttendees ................................................................................................................. 723
ListTagsForResource ........................................................................................................ 726
StartMeetingTranscription ................................................................................................ 728
StopMeetingTranscription ................................................................................................ 731
TagResource ................................................................................................................... 733
UntagResource ............................................................................................................... 735
UpdateAttendeeCapabilities ............................................................................................. 737
Amazon Chime SDK Messaging ................................................................................................ 739
AssociateChannelFlow ..................................................................................................... 741
BatchCreateChannelMembership ....................................................................................... 744
ChannelFlowCallback ...................................................................................................... 748
CreateChannel ................................................................................................................ 751
CreateChannelBan .......................................................................................................... 756
CreateChannelFlow ......................................................................................................... 759
CreateChannelMembership .............................................................................................. 763
CreateChannelModerator ................................................................................................. 767
DeleteChannel ................................................................................................................ 770
DeleteChannelBan .......................................................................................................... 772
DeleteChannelFlow ......................................................................................................... 774
DeleteChannelMembership .............................................................................................. 776
DeleteChannelMessage .................................................................................................... 779
DeleteChannelModerator ................................................................................................. 782
DescribeChannel ............................................................................................................. 784
DescribeChannelBan ........................................................................................................ 787
DescribeChannelFlow ...................................................................................................... 790
DescribeChannelMembership ............................................................................................ 793
DescribeChannelMembershipForAppInstanceUser ................................................................ 796
DescribeChannelModeratedByAppInstanceUser ................................................................... 799
DescribeChannelModerator .............................................................................................. 802
DisassociateChannelFlow ................................................................................................. 805
GetChannelMembershipPreferences .................................................................................. 808
GetChannelMessage ........................................................................................................ 811
GetChannelMessageStatus ............................................................................................... 814
GetMessagingSessionEndpoint .......................................................................................... 817
ListChannelBans ............................................................................................................. 819

vii
 Amazon Chime SDK API Reference

ListChannelFlows ............................................................................................................ 822

ListChannelMemberships ................................................................................................. 825
ListChannelMembershipsForAppInstanceUser ..................................................................... 829
ListChannelMessages ....................................................................................................... 832
ListChannelModerators .................................................................................................... 836
ListChannels ................................................................................................................... 839
ListChannelsAssociatedWithChannelFlow ........................................................................... 842
ListChannelsModeratedByAppInstanceUser ......................................................................... 845
ListSubChannels ............................................................................................................. 848
ListTagsForResource ........................................................................................................ 851
PutChannelMembershipPreferences ................................................................................... 853
RedactChannelMessage ................................................................................................... 856
SearchChannels .............................................................................................................. 860
SendChannelMessage ...................................................................................................... 863
TagResource ................................................................................................................... 868
UntagResource ............................................................................................................... 870
UpdateChannel ............................................................................................................... 872
UpdateChannelFlow ........................................................................................................ 875
UpdateChannelMessage ................................................................................................... 878
UpdateChannelReadMarker .............................................................................................. 882
Amazon Chime SDK Voice ....................................................................................................... 884
AssociatePhoneNumbersWithVoiceConnector ..................................................................... 887
AssociatePhoneNumbersWithVoiceConnectorGroup ............................................................. 891
BatchDeletePhoneNumber ............................................................................................... 895
BatchUpdatePhoneNumber .............................................................................................. 898
CreatePhoneNumberOrder ............................................................................................... 901
CreateProxySession ......................................................................................................... 904
CreateSipMediaApplication ............................................................................................... 908
CreateSipMediaApplicationCall ......................................................................................... 911
CreateSipRule ................................................................................................................. 914
CreateVoiceConnector ..................................................................................................... 918
CreateVoiceConnectorGroup ............................................................................................. 921
DeletePhoneNumber ....................................................................................................... 924
DeleteProxySession ......................................................................................................... 926
DeleteSipMediaApplication ............................................................................................... 928
DeleteSipRule ................................................................................................................. 930
DeleteVoiceConnector ..................................................................................................... 932
DeleteVoiceConnectorEmergencyCallingConfiguration ......................................................... 934
DeleteVoiceConnectorGroup ............................................................................................. 936
DeleteVoiceConnectorOrigination ..................................................................................... 938
DeleteVoiceConnectorProxy ............................................................................................. 940
DeleteVoiceConnectorStreamingConfiguration .................................................................... 942
DeleteVoiceConnectorTermination .................................................................................... 944
DeleteVoiceConnectorTerminationCredentials ..................................................................... 946
DisassociatePhoneNumbersFromVoiceConnector ................................................................. 948
DisassociatePhoneNumbersFromVoiceConnectorGroup ........................................................ 951
GetGlobalSettings ........................................................................................................... 954
GetPhoneNumber ........................................................................................................... 956
GetPhoneNumberOrder ................................................................................................... 959
GetPhoneNumberSettings ................................................................................................ 962
GetProxySession ............................................................................................................. 964
GetSipMediaApplication ................................................................................................... 967
GetSipMediaApplicationAlexaSkillConfiguration .................................................................. 969
GetSipMediaApplicationLoggingConfiguration .................................................................... 971
GetSipRule ..................................................................................................................... 973
GetVoiceConnector ......................................................................................................... 976
GetVoiceConnectorEmergencyCallingConfiguration ............................................................. 978

viii
 Amazon Chime SDK API Reference

GetVoiceConnectorGroup ................................................................................................. 980

GetVoiceConnectorLoggingConfiguration ........................................................................... 983
GetVoiceConnectorOrigination .......................................................................................... 985
GetVoiceConnectorProxy .................................................................................................. 987
GetVoiceConnectorStreamingConfiguration ........................................................................ 989
GetVoiceConnectorTermination ......................................................................................... 991
GetVoiceConnectorTerminationHealth ............................................................................... 993
ListAvailableVoiceConnectorRegions .................................................................................. 995
ListPhoneNumberOrders .................................................................................................. 997
ListPhoneNumbers ........................................................................................................ 1000
ListProxySessions .......................................................................................................... 1003
ListSipMediaApplications ................................................................................................ 1006
ListSipRules .................................................................................................................. 1009
ListSupportedPhoneNumberCountries ............................................................................. 1012
ListVoiceConnectorGroups .............................................................................................. 1014
ListVoiceConnectors ...................................................................................................... 1017
ListVoiceConnectorTerminationCredentials ....................................................................... 1020
PutSipMediaApplicationAlexaSkillConfiguration ................................................................ 1022
PutSipMediaApplicationLoggingConfiguration .................................................................. 1025
PutVoiceConnectorEmergencyCallingConfiguration ............................................................ 1028
PutVoiceConnectorLoggingConfiguration ......................................................................... 1031
PutVoiceConnectorOrigination ........................................................................................ 1034
PutVoiceConnectorProxy ................................................................................................ 1037
PutVoiceConnectorStreamingConfiguration ...................................................................... 1040
PutVoiceConnectorTermination ....................................................................................... 1043
PutVoiceConnectorTerminationCredentials ....................................................................... 1046
RestorePhoneNumber .................................................................................................... 1048
SearchAvailablePhoneNumbers ....................................................................................... 1051
UpdateGlobalSettings .................................................................................................... 1054
UpdatePhoneNumber .................................................................................................... 1056
UpdatePhoneNumberSettings ......................................................................................... 1059
UpdateProxySession ...................................................................................................... 1061
UpdateSipMediaApplication ............................................................................................ 1064
UpdateSipMediaApplicationCall ...................................................................................... 1067
UpdateSipRule .............................................................................................................. 1070
UpdateVoiceConnector .................................................................................................. 1073
UpdateVoiceConnectorGroup .......................................................................................... 1076
ValidateE911Address ..................................................................................................... 1079
Data Types ................................................................................................................................... 1083
Amazon Chime ..................................................................................................................... 1088
Account ....................................................................................................................... 1091
AccountSettings ............................................................................................................ 1093
Address ....................................................................................................................... 1094
AlexaForBusinessMetadata ............................................................................................. 1096
AppInstance ................................................................................................................. 1097
AppInstanceAdmin ........................................................................................................ 1099
AppInstanceAdminSummary ........................................................................................... 1100
AppInstanceRetentionSettings ........................................................................................ 1101
AppInstanceStreamingConfiguration ................................................................................ 1102
AppInstanceSummary .................................................................................................... 1103
AppInstanceUser ........................................................................................................... 1104
AppInstanceUserMembershipSummary ............................................................................ 1106
AppInstanceUserSummary ............................................................................................. 1107
ArtifactsConfiguration ................................................................................................... 1108
Attendee ..................................................................................................................... 1109
AudioArtifactsConfiguration ........................................................................................... 1110
BatchChannelMemberships ............................................................................................ 1111

ix
 Amazon Chime SDK API Reference

BatchCreateChannelMembershipError .............................................................................. 1112

Bot ............................................................................................................................. 1113
BusinessCallingSettings ................................................................................................. 1115
CandidateAddress ......................................................................................................... 1116
Channel ....................................................................................................................... 1118
ChannelBan .................................................................................................................. 1120
ChannelBanSummary .................................................................................................... 1121
ChannelMembership ...................................................................................................... 1122
ChannelMembershipForAppInstanceUserSummary ............................................................ 1124
ChannelMembershipSummary ........................................................................................ 1125
ChannelMessage ........................................................................................................... 1126
ChannelMessageSummary .............................................................................................. 1128
ChannelModeratedByAppInstanceUserSummary ................................................................ 1130
ChannelModerator ........................................................................................................ 1131
ChannelModeratorSummary ........................................................................................... 1132
ChannelRetentionSettings .............................................................................................. 1133
ChannelSummary .......................................................................................................... 1134
ChimeSdkMeetingConfiguration ...................................................................................... 1136
ContentArtifactsConfiguration ........................................................................................ 1137
ConversationRetentionSettings ....................................................................................... 1138
CreateAttendeeError ...................................................................................................... 1139
CreateAttendeeRequestItem ........................................................................................... 1140
Credential .................................................................................................................... 1141
DNISEmergencyCallingConfiguration ............................................................................... 1142
EmergencyCallingConfiguration ...................................................................................... 1143
EngineTranscribeMedicalSettings .................................................................................... 1144
EngineTranscribeSettings ............................................................................................... 1146
EventsConfiguration ...................................................................................................... 1149
GeoMatchParams .......................................................................................................... 1150
Identity ....................................................................................................................... 1151
Invite ........................................................................................................................... 1152
LoggingConfiguration .................................................................................................... 1153
MediaCapturePipeline .................................................................................................... 1154
MediaPlacement ........................................................................................................... 1156
Meeting ....................................................................................................................... 1158
MeetingNotificationConfiguration ................................................................................... 1159
Member ....................................................................................................................... 1160
MemberError ................................................................................................................ 1162
MembershipItem ........................................................................................................... 1163
MessagingSessionEndpoint ............................................................................................. 1164
OrderedPhoneNumber ................................................................................................... 1165
Origination .................................................................................................................. 1166
OriginationRoute .......................................................................................................... 1167
Participant ................................................................................................................... 1169
PhoneNumber .............................................................................................................. 1170
PhoneNumberAssociation .............................................................................................. 1173
PhoneNumberCapabilities .............................................................................................. 1174
PhoneNumberCountry ................................................................................................... 1176
PhoneNumberError ....................................................................................................... 1177
PhoneNumberOrder ...................................................................................................... 1178
Proxy ........................................................................................................................... 1180
ProxySession ................................................................................................................ 1181
RetentionSettings ......................................................................................................... 1184
Room .......................................................................................................................... 1185
RoomMembership ......................................................................................................... 1187
RoomRetentionSettings ................................................................................................. 1189
SelectedVideoStreams ................................................................................................... 1190

x
 Amazon Chime SDK API Reference

SigninDelegateGroup ..................................................................................................... 1191

SipMediaApplication ...................................................................................................... 1192
SipMediaApplicationCall ................................................................................................. 1194
SipMediaApplicationEndpoint ......................................................................................... 1195
SipMediaApplicationLoggingConfiguration ....................................................................... 1196
SipRule ........................................................................................................................ 1197
SipRuleTargetApplication ............................................................................................... 1199
SourceConfiguration ...................................................................................................... 1200
StreamingConfiguration ................................................................................................. 1201
StreamingNotificationTarget ........................................................................................... 1202
Tag ............................................................................................................................. 1203
TelephonySettings ........................................................................................................ 1204
Termination ................................................................................................................. 1205
TerminationHealth ........................................................................................................ 1207
TranscriptionConfiguration ............................................................................................. 1208
UpdatePhoneNumberRequestItem .................................................................................. 1209
UpdateUserRequestItem ................................................................................................ 1210
User ............................................................................................................................ 1211
UserError ..................................................................................................................... 1214
UserSettings ................................................................................................................. 1215
VideoArtifactsConfiguration ........................................................................................... 1216
VoiceConnector ............................................................................................................ 1217
VoiceConnectorGroup .................................................................................................... 1219
VoiceConnectorItem ...................................................................................................... 1221
VoiceConnectorSettings ................................................................................................. 1222
Amazon Chime SDK Identity .................................................................................................. 1222
AppInstance ................................................................................................................. 1223
AppInstanceAdmin ........................................................................................................ 1225
AppInstanceAdminSummary ........................................................................................... 1226
AppInstanceRetentionSettings ........................................................................................ 1227
AppInstanceSummary .................................................................................................... 1228
AppInstanceUser ........................................................................................................... 1229
AppInstanceUserEndpoint .............................................................................................. 1231
AppInstanceUserEndpointSummary ................................................................................. 1234
AppInstanceUserSummary ............................................................................................. 1236
ChannelRetentionSettings .............................................................................................. 1237
EndpointAttributes ........................................................................................................ 1238
EndpointState .............................................................................................................. 1239
Identity ....................................................................................................................... 1240
Tag ............................................................................................................................. 1241
Amazon Chime SDK Media Pipelines ....................................................................................... 1241
ArtifactsConcatenationConfiguration ............................................................................... 1243
ArtifactsConfiguration ................................................................................................... 1245
AudioArtifactsConfiguration ........................................................................................... 1246
AudioConcatenationConfiguration ................................................................................... 1247
ChimeSdkMeetingConcatenationConfiguration .................................................................. 1248
ChimeSdkMeetingConfiguration ...................................................................................... 1249
ChimeSdkMeetingLiveConnectorConfiguration .................................................................. 1250
CompositedVideoArtifactsConfiguration ........................................................................... 1251
CompositedVideoConcatenationConfiguration .................................................................. 1252
ConcatenationSink ........................................................................................................ 1253
ConcatenationSource ..................................................................................................... 1254
ContentArtifactsConfiguration ........................................................................................ 1255
ContentConcatenationConfiguration ................................................................................ 1256
DataChannelConcatenationConfiguration ......................................................................... 1257
GridViewConfiguration ................................................................................................... 1258
LiveConnectorRTMPConfiguration ................................................................................... 1259

xi
 Amazon Chime SDK API Reference

LiveConnectorSinkConfiguration ..................................................................................... 1260

LiveConnectorSourceConfiguration .................................................................................. 1261
MediaCapturePipeline .................................................................................................... 1262
MediaCapturePipelineSourceConfiguration ....................................................................... 1264
MediaCapturePipelineSummary ...................................................................................... 1265
MediaConcatenationPipeline ........................................................................................... 1266
MediaLiveConnectorPipeline ........................................................................................... 1268
MediaPipeline ............................................................................................................... 1270
MediaPipelineSummary ................................................................................................. 1271
MeetingEventsConcatenationConfiguration ...................................................................... 1272
PresenterOnlyConfiguration ........................................................................................... 1273
S3BucketSinkConfiguration ............................................................................................ 1274
SelectedVideoStreams ................................................................................................... 1275
SourceConfiguration ...................................................................................................... 1276
Tag ............................................................................................................................. 1277
TranscriptionMessagesConcatenationConfiguration ............................................................ 1278
VideoArtifactsConfiguration ........................................................................................... 1279
VideoConcatenationConfiguration ................................................................................... 1280
Amazon Chime SDK Meetings ................................................................................................ 1280
Attendee ..................................................................................................................... 1281
AttendeeCapabilities ..................................................................................................... 1283
AttendeeIdItem ............................................................................................................ 1285
AudioFeatures .............................................................................................................. 1286
CreateAttendeeError ...................................................................................................... 1287
CreateAttendeeRequestItem ........................................................................................... 1288
EngineTranscribeMedicalSettings .................................................................................... 1289
EngineTranscribeSettings ............................................................................................... 1291
MediaPlacement ........................................................................................................... 1294
Meeting ....................................................................................................................... 1296
MeetingFeaturesConfiguration ........................................................................................ 1298
NotificationsConfiguration ............................................................................................. 1299
Tag ............................................................................................................................. 1300
TranscriptionConfiguration ............................................................................................. 1301
Amazon Chime SDK Messaging ............................................................................................... 1301
AppInstanceUserMembershipSummary ............................................................................ 1303
BatchChannelMemberships ............................................................................................ 1304
BatchCreateChannelMembershipError .............................................................................. 1306
Channel ....................................................................................................................... 1307
ChannelAssociatedWithFlowSummary .............................................................................. 1310
ChannelBan .................................................................................................................. 1312
ChannelBanSummary .................................................................................................... 1313
ChannelFlow ................................................................................................................ 1314
ChannelFlowSummary ................................................................................................... 1316
ChannelMembership ...................................................................................................... 1317
ChannelMembershipForAppInstanceUserSummary ............................................................ 1319
ChannelMembershipPreferences ..................................................................................... 1320
ChannelMembershipSummary ........................................................................................ 1321
ChannelMessage ........................................................................................................... 1322
ChannelMessageCallback ............................................................................................... 1325
ChannelMessageStatusStructure ..................................................................................... 1327
ChannelMessageSummary .............................................................................................. 1328
ChannelModeratedByAppInstanceUserSummary ................................................................ 1330
ChannelModerator ........................................................................................................ 1331
ChannelModeratorSummary ........................................................................................... 1332
ChannelSummary .......................................................................................................... 1333
ElasticChannelConfiguration ........................................................................................... 1335
Identity ....................................................................................................................... 1336

xii
 Amazon Chime SDK API Reference

LambdaConfiguration .................................................................................................... 1337

MessageAttributeValue .................................................................................................. 1338
MessagingSessionEndpoint ............................................................................................. 1339
Processor ..................................................................................................................... 1340
ProcessorConfiguration .................................................................................................. 1342
PushNotificationConfiguration ........................................................................................ 1343
PushNotificationPreferences ........................................................................................... 1344
SearchField .................................................................................................................. 1345
SubChannelSummary .................................................................................................... 1347
Tag ............................................................................................................................. 1348
Amazon Chime SDK Voice ...................................................................................................... 1348
Address ....................................................................................................................... 1350
CandidateAddress ......................................................................................................... 1352
Credential .................................................................................................................... 1354
DNISEmergencyCallingConfiguration ............................................................................... 1355
EmergencyCallingConfiguration ...................................................................................... 1356
GeoMatchParams .......................................................................................................... 1357
LoggingConfiguration .................................................................................................... 1358
OrderedPhoneNumber ................................................................................................... 1359
Origination .................................................................................................................. 1360
OriginationRoute .......................................................................................................... 1361
Participant ................................................................................................................... 1363
PhoneNumber .............................................................................................................. 1364
PhoneNumberAssociation .............................................................................................. 1367
PhoneNumberCapabilities .............................................................................................. 1368
PhoneNumberCountry ................................................................................................... 1370
PhoneNumberError ....................................................................................................... 1371
PhoneNumberOrder ...................................................................................................... 1372
Proxy ........................................................................................................................... 1374
ProxySession ................................................................................................................ 1375
SipMediaApplication ...................................................................................................... 1378
SipMediaApplicationAlexaSkillConfiguration ..................................................................... 1380
SipMediaApplicationCall ................................................................................................. 1381
SipMediaApplicationEndpoint ......................................................................................... 1382
SipMediaApplicationLoggingConfiguration ....................................................................... 1383
SipRule ........................................................................................................................ 1384
SipRuleTargetApplication ............................................................................................... 1386
StreamingConfiguration ................................................................................................. 1387
StreamingNotificationTarget ........................................................................................... 1388
Termination ................................................................................................................. 1389
TerminationHealth ........................................................................................................ 1391
UpdatePhoneNumberRequestItem .................................................................................. 1392
VoiceConnector ............................................................................................................ 1393
VoiceConnectorGroup .................................................................................................... 1395
VoiceConnectorItem ...................................................................................................... 1397
VoiceConnectorSettings ................................................................................................. 1398
Common Errors ............................................................................................................................ 1399

xiii
 Amazon Chime SDK API Reference
Amazon Chime SDK Identity

Welcome to the Amazon Chime SDK

API Reference
The Amazon Chime SDK application programming interface (API) is designed for developers to build
real-time media applications that can send and receive audio and video and allow content sharing. The
Amazon Chime SDK works independently of any Amazon Chime administrator accounts and does not
affect meetings hosted on Amazon Chime. Instead, the Amazon Chime SDK provides builder tools that
you can use to build your own meeting applications. This API reference provides detailed information
about the actions, data types, parameters, and errors included in the Amazon Chime SDK service.

For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon
Chime SDK Developer Guide. For more information about administering the Amazon Chime SDK, see the
Amazon Chime SDK Administrator Guide.

You can use an AWS SDK, the AWS Command Line Interface (AWS CLI), or the REST API to make API
calls for the Amazon Chime SDK. We recommend using an AWS SDK or the AWS CLI. The page for each
API action contains a See Also section that includes links to information about using the action with a
language-specific AWS SDK or the AWS CLI.

Using an AWS SDK

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 AWS Developer Center.
Using the AWS CLI

Use your access keys with the AWS CLI to make API calls. For information about setting up the AWS
CLI, see Installing the AWS Command Line Interface in the AWS Command Line Interface User Guide.
For a list of Amazon Chime commands, see the Amazon Chime commands in the AWS CLI Command
Reference. For a list of Amazon Chime SDK Identity commands, see the Amazon Chime commands
in the AWS CLI Command Reference. For a list of Amazon Chime SDK Meetings commands, see the
Amazon Chime commands in the AWS CLI Command Reference. For a list of Amazon Chime SDK
Messaging commands, see the Amazon Chime commands in the AWS CLI Command Reference.
Using REST APIs

If you use REST to make API calls, you must authenticate your request by providing a signature.
Amazon Chime SDK supports Signature Version 4. For more information, see Signature Version 4
Signing Process in the AWS General Reference.

When making REST API calls, use the service name chime and REST endpoint https://
service.chime.aws.amazon.com.

Administrative permissions are controlled using AWS Identity and Access Management (IAM). For more
information, see AWS Identity and Access Management for Amazon Chime in the Amazon Chime SDK
Administration Guide.

Amazon Chime SDK Identity

The Amazon Chime SDK Identity APIs in this section let software developers to create and manage
unique instances of their messaging applications. These APIs provide the overarching framework for

1
 Amazon Chime SDK API Reference
Amazon Chime SDK Media Pipelines

creating and sending messages. For more information about the identity APIs, refer to Amazon Chime
SDK Identity.

Amazon Chime SDK Media Pipelines

The Amazon Chime SDK Media Pipeline APIs in this section let software developers to create Amazon
Chime SDK media pipelines and capture audio, video, events, and data messages from Amazon Chime
SDK meetings. For more information about media pipelines APIs, see Amazon Chime SDK Media
Pipelines.

Amazon Chime SDK Meetings

The Amazon Chime SDK Meetings APIs in this section let software developers to create Amazon Chime
SDK meetings, set the AWS Regions for meetings, create and manage users, and send and receive
meeting notifications. For more information about the meeting APIs, see Amazon Chime SDK Meetings.

Amazon Chime SDK Messaging

The Amazon Chime SDK Messaging APIs in this section let software developers send and receive
messages in custom messaging applications. These APIs depend on the frameworks provided by the
Amazon Chime SDK Identity APIs. For more information about the messaging APIs, see Amazon Chime
SDK Messaging.

Amazon Chime SDK Voice

The Amazon Chime SDK Voice APIs enable software developers to add telephony capabilties to their
custom communication solutions. You use these APIs with SIP infrastructure and Amazon Chime SDK
Voice Connectors. For more information, see Amazon Chime SDK Voice.

2
 Amazon Chime SDK API Reference

Actions
The following actions are supported by Amazon Chime:

• AssociatePhoneNumbersWithVoiceConnector (p. 16)

• AssociatePhoneNumbersWithVoiceConnectorGroup (p. 19)
• AssociatePhoneNumberWithUser (p. 23)
• AssociateSigninDelegateGroupsWithAccount (p. 26)
• BatchCreateAttendee (p. 29)
• BatchCreateChannelMembership (p. 32)
• BatchCreateRoomMembership (p. 35)
• BatchDeletePhoneNumber (p. 38)
• BatchSuspendUser (p. 41)
• BatchUnsuspendUser (p. 44)
• BatchUpdatePhoneNumber (p. 47)
• BatchUpdateUser (p. 51)
• CreateAccount (p. 54)
• CreateAppInstance (p. 57)
• CreateAppInstanceAdmin (p. 60)
• CreateAppInstanceUser (p. 63)
• CreateAttendee (p. 67)
• CreateBot (p. 70)
• CreateChannel (p. 74)
• CreateChannelBan (p. 78)
• CreateChannelMembership (p. 81)
• CreateChannelModerator (p. 85)
• CreateMediaCapturePipeline (p. 88)
• CreateMeeting (p. 92)
• CreateMeetingDialOut (p. 96)
• CreateMeetingWithAttendees (p. 99)
• CreatePhoneNumberOrder (p. 103)
• CreateProxySession (p. 106)
• CreateRoom (p. 111)
• CreateRoomMembership (p. 114)
• CreateSipMediaApplication (p. 118)
• CreateSipMediaApplicationCall (p. 121)
• CreateSipRule (p. 124)
• CreateUser (p. 128)
• CreateVoiceConnector (p. 132)
• CreateVoiceConnectorGroup (p. 136)
• DeleteAccount (p. 140)
• DeleteAppInstance (p. 143)
• DeleteAppInstanceAdmin (p. 145)
• DeleteAppInstanceStreamingConfigurations (p. 147)

3
 Amazon Chime SDK API Reference

• DeleteAppInstanceUser (p. 149)

• DeleteAttendee (p. 151)
• DeleteChannel (p. 153)
• DeleteChannelBan (p. 155)
• DeleteChannelMembership (p. 157)
• DeleteChannelMessage (p. 160)
• DeleteChannelModerator (p. 162)
• DeleteEventsConfiguration (p. 164)
• DeleteMediaCapturePipeline (p. 166)
• DeleteMeeting (p. 168)
• DeletePhoneNumber (p. 170)
• DeleteProxySession (p. 173)
• DeleteRoom (p. 176)
• DeleteRoomMembership (p. 179)
• DeleteSipMediaApplication (p. 182)
• DeleteSipRule (p. 184)
• DeleteVoiceConnector (p. 186)
• DeleteVoiceConnectorEmergencyCallingConfiguration (p. 189)
• DeleteVoiceConnectorGroup (p. 191)
• DeleteVoiceConnectorOrigination (p. 194)
• DeleteVoiceConnectorProxy (p. 197)
• DeleteVoiceConnectorStreamingConfiguration (p. 200)
• DeleteVoiceConnectorTermination (p. 203)
• DeleteVoiceConnectorTerminationCredentials (p. 206)
• DescribeAppInstance (p. 209)
• DescribeAppInstanceAdmin (p. 211)
• DescribeAppInstanceUser (p. 214)
• DescribeChannel (p. 216)
• DescribeChannelBan (p. 219)
• DescribeChannelMembership (p. 222)
• DescribeChannelMembershipForAppInstanceUser (p. 225)
• DescribeChannelModeratedByAppInstanceUser (p. 228)
• DescribeChannelModerator (p. 231)
• DisassociatePhoneNumberFromUser (p. 234)
• DisassociatePhoneNumbersFromVoiceConnector (p. 237)
• DisassociatePhoneNumbersFromVoiceConnectorGroup (p. 240)
• DisassociateSigninDelegateGroupsFromAccount (p. 243)
• GetAccount (p. 246)
• GetAccountSettings (p. 249)
• GetAppInstanceRetentionSettings (p. 252)
• GetAppInstanceStreamingConfigurations (p. 255)
• GetAttendee (p. 257)
• GetBot (p. 260)
• GetChannelMessage (p. 263)
• GetEventsConfiguration (p. 266)
• GetGlobalSettings (p. 269)

4
 Amazon Chime SDK API Reference

• GetMediaCapturePipeline (p. 272)

• GetMeeting (p. 275)
• GetMessagingSessionEndpoint (p. 278)
• GetPhoneNumber (p. 280)
• GetPhoneNumberOrder (p. 283)
• GetPhoneNumberSettings (p. 286)
• GetProxySession (p. 289)
• GetRetentionSettings (p. 292)
• GetRoom (p. 295)
• GetSipMediaApplication (p. 298)
• GetSipMediaApplicationLoggingConfiguration (p. 300)
• GetSipRule (p. 302)
• GetUser (p. 305)
• GetUserSettings (p. 308)
• GetVoiceConnector (p. 311)
• GetVoiceConnectorEmergencyCallingConfiguration (p. 314)
• GetVoiceConnectorGroup (p. 316)
• GetVoiceConnectorLoggingConfiguration (p. 319)
• GetVoiceConnectorOrigination (p. 322)
• GetVoiceConnectorProxy (p. 325)
• GetVoiceConnectorStreamingConfiguration (p. 328)
• GetVoiceConnectorTermination (p. 331)
• GetVoiceConnectorTerminationHealth (p. 334)
• InviteUsers (p. 337)
• ListAccounts (p. 340)
• ListAppInstanceAdmins (p. 344)
• ListAppInstances (p. 347)
• ListAppInstanceUsers (p. 350)
• ListAttendees (p. 353)
• ListAttendeeTags (p. 356)
• ListBots (p. 359)
• ListChannelBans (p. 362)
• ListChannelMemberships (p. 365)
• ListChannelMembershipsForAppInstanceUser (p. 368)
• ListChannelMessages (p. 371)
• ListChannelModerators (p. 375)
• ListChannels (p. 378)
• ListChannelsModeratedByAppInstanceUser (p. 381)
• ListMediaCapturePipelines (p. 384)
• ListMeetings (p. 387)
• ListMeetingTags (p. 390)
• ListPhoneNumberOrders (p. 392)
• ListPhoneNumbers (p. 395)
• ListProxySessions (p. 399)
• ListRoomMemberships (p. 403)
• ListRooms (p. 407)

5
 Amazon Chime SDK API Reference

• ListSipMediaApplications (p. 410)

• ListSipRules (p. 413)
• ListSupportedPhoneNumberCountries (p. 416)
• ListTagsForResource (p. 418)
• ListUsers (p. 420)
• ListVoiceConnectorGroups (p. 424)
• ListVoiceConnectors (p. 427)
• ListVoiceConnectorTerminationCredentials (p. 430)
• LogoutUser (p. 433)
• PutAppInstanceRetentionSettings (p. 436)
• PutAppInstanceStreamingConfigurations (p. 439)
• PutEventsConfiguration (p. 442)
• PutRetentionSettings (p. 445)
• PutSipMediaApplicationLoggingConfiguration (p. 448)
• PutVoiceConnectorEmergencyCallingConfiguration (p. 451)
• PutVoiceConnectorLoggingConfiguration (p. 454)
• PutVoiceConnectorOrigination (p. 457)
• PutVoiceConnectorProxy (p. 461)
• PutVoiceConnectorStreamingConfiguration (p. 465)
• PutVoiceConnectorTermination (p. 468)
• PutVoiceConnectorTerminationCredentials (p. 471)
• RedactChannelMessage (p. 474)
• RedactConversationMessage (p. 477)
• RedactRoomMessage (p. 479)
• RegenerateSecurityToken (p. 481)
• ResetPersonalPIN (p. 484)
• RestorePhoneNumber (p. 487)
• SearchAvailablePhoneNumbers (p. 490)
• SendChannelMessage (p. 494)
• StartMeetingTranscription (p. 498)
• StopMeetingTranscription (p. 501)
• TagAttendee (p. 503)
• TagMeeting (p. 506)
• TagResource (p. 508)
• UntagAttendee (p. 510)
• UntagMeeting (p. 512)
• UntagResource (p. 514)
• UpdateAccount (p. 516)
• UpdateAccountSettings (p. 520)
• UpdateAppInstance (p. 523)
• UpdateAppInstanceUser (p. 526)
• UpdateBot (p. 529)
• UpdateChannel (p. 532)
• UpdateChannelMessage (p. 535)
• UpdateChannelReadMarker (p. 538)
• UpdateGlobalSettings (p. 541)

6
 Amazon Chime SDK API Reference

• UpdatePhoneNumber (p. 544)

• UpdatePhoneNumberSettings (p. 548)
• UpdateProxySession (p. 551)
• UpdateRoom (p. 555)
• UpdateRoomMembership (p. 558)
• UpdateSipMediaApplication (p. 562)
• UpdateSipMediaApplicationCall (p. 565)
• UpdateSipRule (p. 568)
• UpdateUser (p. 571)
• UpdateUserSettings (p. 575)
• UpdateVoiceConnector (p. 578)
• UpdateVoiceConnectorGroup (p. 581)
• ValidateE911Address (p. 585)

The following actions are supported by Amazon Chime SDK Identity:

• CreateAppInstance (p. 590)

• CreateAppInstanceAdmin (p. 593)
• CreateAppInstanceUser (p. 596)
• DeleteAppInstance (p. 600)
• DeleteAppInstanceAdmin (p. 602)
• DeleteAppInstanceUser (p. 604)
• DeregisterAppInstanceUserEndpoint (p. 606)
• DescribeAppInstance (p. 608)
• DescribeAppInstanceAdmin (p. 610)
• DescribeAppInstanceUser (p. 613)
• DescribeAppInstanceUserEndpoint (p. 615)
• GetAppInstanceRetentionSettings (p. 618)
• ListAppInstanceAdmins (p. 620)
• ListAppInstances (p. 623)
• ListAppInstanceUserEndpoints (p. 626)
• ListAppInstanceUsers (p. 629)
• ListTagsForResource (p. 632)
• PutAppInstanceRetentionSettings (p. 634)
• RegisterAppInstanceUserEndpoint (p. 637)
• TagResource (p. 641)
• UntagResource (p. 643)
• UpdateAppInstance (p. 645)
• UpdateAppInstanceUser (p. 648)
• UpdateAppInstanceUserEndpoint (p. 651)

The following actions are supported by Amazon Chime SDK Media Pipelines:

• CreateMediaCapturePipeline (p. 655)

• CreateMediaConcatenationPipeline (p. 660)
• CreateMediaLiveConnectorPipeline (p. 664)

7
 Amazon Chime SDK API Reference

• DeleteMediaCapturePipeline (p. 668)

• DeleteMediaPipeline (p. 670)
• GetMediaCapturePipeline (p. 672)
• GetMediaPipeline (p. 675)
• ListMediaCapturePipelines (p. 679)
• ListMediaPipelines (p. 682)
• ListTagsForResource (p. 685)
• TagResource (p. 687)
• UntagResource (p. 690)

The following actions are supported by Amazon Chime SDK Meetings:

• BatchCreateAttendee (p. 693)

• BatchUpdateAttendeeCapabilitiesExcept (p. 696)
• CreateAttendee (p. 699)
• CreateMeeting (p. 703)
• CreateMeetingWithAttendees (p. 708)
• DeleteAttendee (p. 713)
• DeleteMeeting (p. 715)
• GetAttendee (p. 717)
• GetMeeting (p. 720)
• ListAttendees (p. 723)
• ListTagsForResource (p. 726)
• StartMeetingTranscription (p. 728)
• StopMeetingTranscription (p. 731)
• TagResource (p. 733)
• UntagResource (p. 735)
• UpdateAttendeeCapabilities (p. 737)

The following actions are supported by Amazon Chime SDK Messaging:

• AssociateChannelFlow (p. 741)

• BatchCreateChannelMembership (p. 744)
• ChannelFlowCallback (p. 748)
• CreateChannel (p. 751)
• CreateChannelBan (p. 756)
• CreateChannelFlow (p. 759)
• CreateChannelMembership (p. 763)
• CreateChannelModerator (p. 767)
• DeleteChannel (p. 770)
• DeleteChannelBan (p. 772)
• DeleteChannelFlow (p. 774)
• DeleteChannelMembership (p. 776)
• DeleteChannelMessage (p. 779)
• DeleteChannelModerator (p. 782)
• DescribeChannel (p. 784)

8
 Amazon Chime SDK API Reference

• DescribeChannelBan (p. 787)

• DescribeChannelFlow (p. 790)
• DescribeChannelMembership (p. 793)
• DescribeChannelMembershipForAppInstanceUser (p. 796)
• DescribeChannelModeratedByAppInstanceUser (p. 799)
• DescribeChannelModerator (p. 802)
• DisassociateChannelFlow (p. 805)
• GetChannelMembershipPreferences (p. 808)
• GetChannelMessage (p. 811)
• GetChannelMessageStatus (p. 814)
• GetMessagingSessionEndpoint (p. 817)
• ListChannelBans (p. 819)
• ListChannelFlows (p. 822)
• ListChannelMemberships (p. 825)
• ListChannelMembershipsForAppInstanceUser (p. 829)
• ListChannelMessages (p. 832)
• ListChannelModerators (p. 836)
• ListChannels (p. 839)
• ListChannelsAssociatedWithChannelFlow (p. 842)
• ListChannelsModeratedByAppInstanceUser (p. 845)
• ListSubChannels (p. 848)
• ListTagsForResource (p. 851)
• PutChannelMembershipPreferences (p. 853)
• RedactChannelMessage (p. 856)
• SearchChannels (p. 860)
• SendChannelMessage (p. 863)
• TagResource (p. 868)
• UntagResource (p. 870)
• UpdateChannel (p. 872)
• UpdateChannelFlow (p. 875)
• UpdateChannelMessage (p. 878)
• UpdateChannelReadMarker (p. 882)

The following actions are supported by Amazon Chime SDK Voice:

• AssociatePhoneNumbersWithVoiceConnector (p. 887)

• AssociatePhoneNumbersWithVoiceConnectorGroup (p. 891)
• BatchDeletePhoneNumber (p. 895)
• BatchUpdatePhoneNumber (p. 898)
• CreatePhoneNumberOrder (p. 901)
• CreateProxySession (p. 904)
• CreateSipMediaApplication (p. 908)
• CreateSipMediaApplicationCall (p. 911)
• CreateSipRule (p. 914)
• CreateVoiceConnector (p. 918)
• CreateVoiceConnectorGroup (p. 921)

9
 Amazon Chime SDK API Reference

• DeletePhoneNumber (p. 924)

• DeleteProxySession (p. 926)
• DeleteSipMediaApplication (p. 928)
• DeleteSipRule (p. 930)
• DeleteVoiceConnector (p. 932)
• DeleteVoiceConnectorEmergencyCallingConfiguration (p. 934)
• DeleteVoiceConnectorGroup (p. 936)
• DeleteVoiceConnectorOrigination (p. 938)
• DeleteVoiceConnectorProxy (p. 940)
• DeleteVoiceConnectorStreamingConfiguration (p. 942)
• DeleteVoiceConnectorTermination (p. 944)
• DeleteVoiceConnectorTerminationCredentials (p. 946)
• DisassociatePhoneNumbersFromVoiceConnector (p. 948)
• DisassociatePhoneNumbersFromVoiceConnectorGroup (p. 951)
• GetGlobalSettings (p. 954)
• GetPhoneNumber (p. 956)
• GetPhoneNumberOrder (p. 959)
• GetPhoneNumberSettings (p. 962)
• GetProxySession (p. 964)
• GetSipMediaApplication (p. 967)
• GetSipMediaApplicationAlexaSkillConfiguration (p. 969)
• GetSipMediaApplicationLoggingConfiguration (p. 971)
• GetSipRule (p. 973)
• GetVoiceConnector (p. 976)
• GetVoiceConnectorEmergencyCallingConfiguration (p. 978)
• GetVoiceConnectorGroup (p. 980)
• GetVoiceConnectorLoggingConfiguration (p. 983)
• GetVoiceConnectorOrigination (p. 985)
• GetVoiceConnectorProxy (p. 987)
• GetVoiceConnectorStreamingConfiguration (p. 989)
• GetVoiceConnectorTermination (p. 991)
• GetVoiceConnectorTerminationHealth (p. 993)
• ListAvailableVoiceConnectorRegions (p. 995)
• ListPhoneNumberOrders (p. 997)
• ListPhoneNumbers (p. 1000)
• ListProxySessions (p. 1003)
• ListSipMediaApplications (p. 1006)
• ListSipRules (p. 1009)
• ListSupportedPhoneNumberCountries (p. 1012)
• ListVoiceConnectorGroups (p. 1014)
• ListVoiceConnectors (p. 1017)
• ListVoiceConnectorTerminationCredentials (p. 1020)
• PutSipMediaApplicationAlexaSkillConfiguration (p. 1022)
• PutSipMediaApplicationLoggingConfiguration (p. 1025)
• PutVoiceConnectorEmergencyCallingConfiguration (p. 1028)
• PutVoiceConnectorLoggingConfiguration (p. 1031)

10
 Amazon Chime SDK API Reference
Amazon Chime

• PutVoiceConnectorOrigination (p. 1034)

• PutVoiceConnectorProxy (p. 1037)
• PutVoiceConnectorStreamingConfiguration (p. 1040)
• PutVoiceConnectorTermination (p. 1043)
• PutVoiceConnectorTerminationCredentials (p. 1046)
• RestorePhoneNumber (p. 1048)
• SearchAvailablePhoneNumbers (p. 1051)
• UpdateGlobalSettings (p. 1054)
• UpdatePhoneNumber (p. 1056)
• UpdatePhoneNumberSettings (p. 1059)
• UpdateProxySession (p. 1061)
• UpdateSipMediaApplication (p. 1064)
• UpdateSipMediaApplicationCall (p. 1067)
• UpdateSipRule (p. 1070)
• UpdateVoiceConnector (p. 1073)
• UpdateVoiceConnectorGroup (p. 1076)
• ValidateE911Address (p. 1079)

Amazon Chime
The following actions are supported by Amazon Chime:

• AssociatePhoneNumbersWithVoiceConnector (p. 16)

• AssociatePhoneNumbersWithVoiceConnectorGroup (p. 19)
• AssociatePhoneNumberWithUser (p. 23)
• AssociateSigninDelegateGroupsWithAccount (p. 26)
• BatchCreateAttendee (p. 29)
• BatchCreateChannelMembership (p. 32)
• BatchCreateRoomMembership (p. 35)
• BatchDeletePhoneNumber (p. 38)
• BatchSuspendUser (p. 41)
• BatchUnsuspendUser (p. 44)
• BatchUpdatePhoneNumber (p. 47)
• BatchUpdateUser (p. 51)
• CreateAccount (p. 54)
• CreateAppInstance (p. 57)
• CreateAppInstanceAdmin (p. 60)
• CreateAppInstanceUser (p. 63)
• CreateAttendee (p. 67)
• CreateBot (p. 70)
• CreateChannel (p. 74)
• CreateChannelBan (p. 78)
• CreateChannelMembership (p. 81)
• CreateChannelModerator (p. 85)
• CreateMediaCapturePipeline (p. 88)

11
 Amazon Chime SDK API Reference
Amazon Chime

• CreateMeeting (p. 92)

• CreateMeetingDialOut (p. 96)
• CreateMeetingWithAttendees (p. 99)
• CreatePhoneNumberOrder (p. 103)
• CreateProxySession (p. 106)
• CreateRoom (p. 111)
• CreateRoomMembership (p. 114)
• CreateSipMediaApplication (p. 118)
• CreateSipMediaApplicationCall (p. 121)
• CreateSipRule (p. 124)
• CreateUser (p. 128)
• CreateVoiceConnector (p. 132)
• CreateVoiceConnectorGroup (p. 136)
• DeleteAccount (p. 140)
• DeleteAppInstance (p. 143)
• DeleteAppInstanceAdmin (p. 145)
• DeleteAppInstanceStreamingConfigurations (p. 147)
• DeleteAppInstanceUser (p. 149)
• DeleteAttendee (p. 151)
• DeleteChannel (p. 153)
• DeleteChannelBan (p. 155)
• DeleteChannelMembership (p. 157)
• DeleteChannelMessage (p. 160)
• DeleteChannelModerator (p. 162)
• DeleteEventsConfiguration (p. 164)
• DeleteMediaCapturePipeline (p. 166)
• DeleteMeeting (p. 168)
• DeletePhoneNumber (p. 170)
• DeleteProxySession (p. 173)
• DeleteRoom (p. 176)
• DeleteRoomMembership (p. 179)
• DeleteSipMediaApplication (p. 182)
• DeleteSipRule (p. 184)
• DeleteVoiceConnector (p. 186)
• DeleteVoiceConnectorEmergencyCallingConfiguration (p. 189)
• DeleteVoiceConnectorGroup (p. 191)
• DeleteVoiceConnectorOrigination (p. 194)
• DeleteVoiceConnectorProxy (p. 197)
• DeleteVoiceConnectorStreamingConfiguration (p. 200)
• DeleteVoiceConnectorTermination (p. 203)
• DeleteVoiceConnectorTerminationCredentials (p. 206)
• DescribeAppInstance (p. 209)
• DescribeAppInstanceAdmin (p. 211)
• DescribeAppInstanceUser (p. 214)
• DescribeChannel (p. 216)
• DescribeChannelBan (p. 219)

12
 Amazon Chime SDK API Reference
Amazon Chime

• DescribeChannelMembership (p. 222)

• DescribeChannelMembershipForAppInstanceUser (p. 225)
• DescribeChannelModeratedByAppInstanceUser (p. 228)
• DescribeChannelModerator (p. 231)
• DisassociatePhoneNumberFromUser (p. 234)
• DisassociatePhoneNumbersFromVoiceConnector (p. 237)
• DisassociatePhoneNumbersFromVoiceConnectorGroup (p. 240)
• DisassociateSigninDelegateGroupsFromAccount (p. 243)
• GetAccount (p. 246)
• GetAccountSettings (p. 249)
• GetAppInstanceRetentionSettings (p. 252)
• GetAppInstanceStreamingConfigurations (p. 255)
• GetAttendee (p. 257)
• GetBot (p. 260)
• GetChannelMessage (p. 263)
• GetEventsConfiguration (p. 266)
• GetGlobalSettings (p. 269)
• GetMediaCapturePipeline (p. 272)
• GetMeeting (p. 275)
• GetMessagingSessionEndpoint (p. 278)
• GetPhoneNumber (p. 280)
• GetPhoneNumberOrder (p. 283)
• GetPhoneNumberSettings (p. 286)
• GetProxySession (p. 289)
• GetRetentionSettings (p. 292)
• GetRoom (p. 295)
• GetSipMediaApplication (p. 298)
• GetSipMediaApplicationLoggingConfiguration (p. 300)
• GetSipRule (p. 302)
• GetUser (p. 305)
• GetUserSettings (p. 308)
• GetVoiceConnector (p. 311)
• GetVoiceConnectorEmergencyCallingConfiguration (p. 314)
• GetVoiceConnectorGroup (p. 316)
• GetVoiceConnectorLoggingConfiguration (p. 319)
• GetVoiceConnectorOrigination (p. 322)
• GetVoiceConnectorProxy (p. 325)
• GetVoiceConnectorStreamingConfiguration (p. 328)
• GetVoiceConnectorTermination (p. 331)
• GetVoiceConnectorTerminationHealth (p. 334)
• InviteUsers (p. 337)
• ListAccounts (p. 340)
• ListAppInstanceAdmins (p. 344)
• ListAppInstances (p. 347)
• ListAppInstanceUsers (p. 350)
• ListAttendees (p. 353)

13
 Amazon Chime SDK API Reference
Amazon Chime

• ListAttendeeTags (p. 356)

• ListBots (p. 359)
• ListChannelBans (p. 362)
• ListChannelMemberships (p. 365)
• ListChannelMembershipsForAppInstanceUser (p. 368)
• ListChannelMessages (p. 371)
• ListChannelModerators (p. 375)
• ListChannels (p. 378)
• ListChannelsModeratedByAppInstanceUser (p. 381)
• ListMediaCapturePipelines (p. 384)
• ListMeetings (p. 387)
• ListMeetingTags (p. 390)
• ListPhoneNumberOrders (p. 392)
• ListPhoneNumbers (p. 395)
• ListProxySessions (p. 399)
• ListRoomMemberships (p. 403)
• ListRooms (p. 407)
• ListSipMediaApplications (p. 410)
• ListSipRules (p. 413)
• ListSupportedPhoneNumberCountries (p. 416)
• ListTagsForResource (p. 418)
• ListUsers (p. 420)
• ListVoiceConnectorGroups (p. 424)
• ListVoiceConnectors (p. 427)
• ListVoiceConnectorTerminationCredentials (p. 430)
• LogoutUser (p. 433)
• PutAppInstanceRetentionSettings (p. 436)
• PutAppInstanceStreamingConfigurations (p. 439)
• PutEventsConfiguration (p. 442)
• PutRetentionSettings (p. 445)
• PutSipMediaApplicationLoggingConfiguration (p. 448)
• PutVoiceConnectorEmergencyCallingConfiguration (p. 451)
• PutVoiceConnectorLoggingConfiguration (p. 454)
• PutVoiceConnectorOrigination (p. 457)
• PutVoiceConnectorProxy (p. 461)
• PutVoiceConnectorStreamingConfiguration (p. 465)
• PutVoiceConnectorTermination (p. 468)
• PutVoiceConnectorTerminationCredentials (p. 471)
• RedactChannelMessage (p. 474)
• RedactConversationMessage (p. 477)
• RedactRoomMessage (p. 479)
• RegenerateSecurityToken (p. 481)
• ResetPersonalPIN (p. 484)
• RestorePhoneNumber (p. 487)
• SearchAvailablePhoneNumbers (p. 490)
• SendChannelMessage (p. 494)

14
 Amazon Chime SDK API Reference
Amazon Chime

• StartMeetingTranscription (p. 498)

• StopMeetingTranscription (p. 501)
• TagAttendee (p. 503)
• TagMeeting (p. 506)
• TagResource (p. 508)
• UntagAttendee (p. 510)
• UntagMeeting (p. 512)
• UntagResource (p. 514)
• UpdateAccount (p. 516)
• UpdateAccountSettings (p. 520)
• UpdateAppInstance (p. 523)
• UpdateAppInstanceUser (p. 526)
• UpdateBot (p. 529)
• UpdateChannel (p. 532)
• UpdateChannelMessage (p. 535)
• UpdateChannelReadMarker (p. 538)
• UpdateGlobalSettings (p. 541)
• UpdatePhoneNumber (p. 544)
• UpdatePhoneNumberSettings (p. 548)
• UpdateProxySession (p. 551)
• UpdateRoom (p. 555)
• UpdateRoomMembership (p. 558)
• UpdateSipMediaApplication (p. 562)
• UpdateSipMediaApplicationCall (p. 565)
• UpdateSipRule (p. 568)
• UpdateUser (p. 571)
• UpdateUserSettings (p. 575)
• UpdateVoiceConnector (p. 578)
• UpdateVoiceConnectorGroup (p. 581)
• ValidateE911Address (p. 585)

15
 Amazon Chime SDK API Reference
AssociatePhoneNumbersWithVoiceConnector

AssociatePhoneNumbersWithVoiceConnector
Service: Amazon Chime

Associates phone numbers with the specified Amazon Chime Voice Connector.

Request Syntax
POST /voice-connectors/{voiceConnectorId}?operation=associate-phone-numbers HTTP/1.1
Content-type: application/json

{
"E164PhoneNumbers": [ "string" ],
"ForceAssociate": boolean
}

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId (p. 16)

The Amazon Chime Voice Connector ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

E164PhoneNumbers (p. 16)

List of phone numbers, in E.164 format.

Type: Array of strings

Pattern: ^\+?[1-9]\d{1,14}$

Required: Yes
ForceAssociate (p. 16)

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.

Type: Boolean

Required: No

Response Syntax
HTTP/1.1 200
Content-type: application/json

16
 Amazon Chime SDK API Reference
AssociatePhoneNumbersWithVoiceConnector

{
"PhoneNumberErrors": [
{
"ErrorCode": "string",
"ErrorMessage": "string",
"PhoneNumberId": "string"
}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

PhoneNumberErrors (p. 16)

If the action fails for one or more of the phone numbers in the request, a list of the phone numbers
is returned, along with error codes and error messages.

Type: Array of PhoneNumberError (p. 1177) objects

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

AccessDeniedException

You don't have permissions to perform the requested operation.

HTTP Status Code: 403

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

17
 Amazon Chime SDK API Reference
AssociatePhoneNumbersWithVoiceConnector

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents(AUTHPARAMS) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example associates the specified phone number with the specified Amazon Chime Voice Connector.

Sample Request

POST /voice-connectors/abcdef1ghij2klmno3pqr4?operation=associate-phone-numbers HTTP/1.1

Host: service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.170
Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-Date: 20191028T184037Z Authorization:
AUTHPARAMS Content-Length: 78 {"E164PhoneNumbers": ["+12065550100", "+12065550101"],
"ForceAssociate": true}

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: ac266ffd-3732-4a4a-b8dd-4b64399dde0c Content-Type:

application/json Content-Length: 24 Date: Mon, 28 Oct 2019 18:40:37 GMT Connection: keep-
alive {"PhoneNumberErrors":[]}

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

18
 Amazon Chime SDK API Reference
AssociatePhoneNumbersWithVoiceConnectorGroup

AssociatePhoneNumbersWithVoiceConnectorGroup
Service: Amazon Chime

Associates phone numbers with the specified Amazon Chime Voice Connector group.

Request Syntax
POST /voice-connector-groups/{voiceConnectorGroupId}?operation=associate-phone-numbers
HTTP/1.1
Content-type: application/json

{
"E164PhoneNumbers": [ "string" ],
"ForceAssociate": boolean
}

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorGroupId (p. 19)

The Amazon Chime Voice Connector group ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

E164PhoneNumbers (p. 19)

List of phone numbers, in E.164 format.

Type: Array of strings

Pattern: ^\+?[1-9]\d{1,14}$

Required: Yes
ForceAssociate (p. 19)

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.

Type: Boolean

Required: No

Response Syntax
HTTP/1.1 200
Content-type: application/json

19
 Amazon Chime SDK API Reference
AssociatePhoneNumbersWithVoiceConnectorGroup

{
"PhoneNumberErrors": [
{
"ErrorCode": "string",
"ErrorMessage": "string",
"PhoneNumberId": "string"
}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

PhoneNumberErrors (p. 19)

If the action fails for one or more of the phone numbers in the request, a list of the phone numbers
is returned, along with error codes and error messages.

Type: Array of PhoneNumberError (p. 1177) objects

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

AccessDeniedException

You don't have permissions to perform the requested operation.

HTTP Status Code: 403

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

20
 Amazon Chime SDK API Reference
AssociatePhoneNumbersWithVoiceConnectorGroup

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example associates the specified phone numbers with the specified Amazon Chime Voice Connector
group.

Sample Request

POST /voice-connector-groups/123a456b-c7d8-90e1-fg23-4h567jkl8901?operation=associate-
phone-numbers HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding: identity
User-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-Date:
20191028T185326Z Authorization: AUTHPARAMS Content-Length: 78 {"E164PhoneNumbers":
["+12065550100", "+12065550101"], "ForceAssociate": true}

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 96f64ec4-db6a-41c9-9315-2517fb130c80 Content-Type:

application/json Content-Length: 24 Date: Mon, 28 Oct 2019 18:53:27 GMT Connection: keep-
alive {"PhoneNumberErrors":[]}

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

21
 Amazon Chime SDK API Reference
AssociatePhoneNumbersWithVoiceConnectorGroup

22
 Amazon Chime SDK API Reference
AssociatePhoneNumberWithUser

AssociatePhoneNumberWithUser
Service: Amazon Chime

Associates a phone number with the specified Amazon Chime user.

Request Syntax
POST /accounts/accountId/users/{userId}?operation=associate-phone-number HTTP/1.1
Content-type: application/json

{
"E164PhoneNumber": "string"
}

URI Request Parameters

The request uses the following URI parameters.

accountId (p. 23)

The Amazon Chime account ID.

Required: Yes
userId (p. 23)

The user ID.

Required: Yes

Request Body
The request accepts the following data in JSON format.

E164PhoneNumber (p. 23)

The phone number, in E.164 format.

Type: String

Pattern: ^\+?[1-9]\d{1,14}$

Required: Yes

Response Syntax
HTTP/1.1 200

Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

23
 Amazon Chime SDK API Reference
AssociatePhoneNumberWithUser

AccessDeniedException

You don't have permissions to perform the requested operation.

HTTP Status Code: 403

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference .

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example associates the specified phone number with the specified Amazon Chime user.

24
 Amazon Chime SDK API Reference
AssociatePhoneNumberWithUser

Sample Request

POST /accounts/12a3456b-7c89-012d-3456-78901e23fg45/users/1ab2345c-67de-8901-
f23g-45h678901j2k?operation=associate-phone-number HTTP/1.1 Host:
service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.170
Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-Date: 20190918T181244Z Authorization:
AUTHPARAMS Content-Length: 35 {"E164PhoneNumber": "+12065550100"}

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: d70a1eae-c35a-4607-ac37-6e9a62f7c163 Content-Type:

application/json Content-Length: 2 Date: Wed, 18 Sep 2019 18:12:45 GMT Connection: keep-
alive {}

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

25
 Amazon Chime SDK API Reference
AssociateSigninDelegateGroupsWithAccount

AssociateSigninDelegateGroupsWithAccount
Service: Amazon Chime

Associates the specified sign-in delegate groups with the specified Amazon Chime account.

Request Syntax
POST /accounts/{accountId}?operation=associate-signin-delegate-groups HTTP/1.1
Content-type: application/json

{
"SigninDelegateGroups": [
{
"GroupName": "string"
}
]
}

URI Request Parameters

The request uses the following URI parameters.

accountId (p. 26)

The Amazon Chime account ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

SigninDelegateGroups (p. 26)

The sign-in delegate groups.

Type: Array of SigninDelegateGroup (p. 1191) objects

Required: Yes

Response Syntax
HTTP/1.1 200

Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

26
 Amazon Chime SDK API Reference
AssociateSigninDelegateGroupsWithAccount

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example associates the specified sign-in delegate group with the specified Amazon Chime account.

Sample Request

POST /accounts/12a3456b-7c89-012d-3456-78901e23fg45?operation=associate-signin-delegate-
groups HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding: identity User-Agent:
aws-cli/1.17.0 Python/3.8.0 Windows/10 botocore/1.14.0 X-Amz-Date: 20200113T173245Z
AUTHPARAMS

27
 Amazon Chime SDK API Reference
AssociateSigninDelegateGroupsWithAccount

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 7cf3751e-9371-47b2-8972-6d1dbbd9554b Content-Type:

application/json Content-Length: 2 Date: Mon, 13 Jan 2020 17:32:45 GMT Connection: keep-
alive {}

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

28
 Amazon Chime SDK API Reference
BatchCreateAttendee

BatchCreateAttendee
Service: Amazon Chime

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.

Request Syntax
POST /meetings/meetingId/attendees?operation=batch-create HTTP/1.1
Content-type: application/json

{
"Attendees": [
{
"ExternalUserId": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
]
}

URI Request Parameters

The request uses the following URI parameters.

meetingId (p. 29)

The Amazon Chime SDK meeting ID.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: Yes

Request Body
The request accepts the following data in JSON format.

Attendees (p. 29)

The request containing the attendees to create.

Type: Array of CreateAttendeeRequestItem (p. 1140) objects

Required: Yes

Response Syntax
HTTP/1.1 201
Content-type: application/json

{
"Attendees": [
{

29
 Amazon Chime SDK API Reference
BatchCreateAttendee

"AttendeeId": "string",
"ExternalUserId": "string",
"JoinToken": "string"
}
],
"Errors": [
{
"ErrorCode": "string",
"ErrorMessage": "string",
"ExternalUserId": "string"
}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

Attendees (p. 29)

The attendee information, including attendees IDs and join tokens.

Type: Array of Attendee (p. 1109) objects

Errors (p. 29)

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.

Type: Array of CreateAttendeeError (p. 1139) objects

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

30
 Amazon Chime SDK API Reference
BatchCreateAttendee

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

31
 Amazon Chime SDK API Reference
BatchCreateChannelMembership

BatchCreateChannelMembership
Service: Amazon Chime

Adds a specified number of users to a channel.

Request Syntax
POST /channels/channelArn/memberships?operation=batch-create HTTP/1.1
x-amz-chime-bearer: ChimeBearer
Content-type: application/json

{
"MemberArns": [ "string" ],
"Type": "string"
}

URI Request Parameters

The request uses the following URI parameters.

channelArn (p. 32)

The ARN of the channel to which you're adding users.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 32)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Request Body
The request accepts the following data in JSON format.

MemberArns (p. 32)

The ARNs of the members you want to add to the channel.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

32
 Amazon Chime SDK API Reference
BatchCreateChannelMembership

Type (p. 32)

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.

Type: String

Valid Values: DEFAULT | HIDDEN

Required: No

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"BatchChannelMemberships": {
"ChannelArn": "string",
"InvitedBy": {
"Arn": "string",
"Name": "string"
},
"Members": [
{
"Arn": "string",
"Name": "string"
}
],
"Type": "string"
},
"Errors": [
{
"ErrorCode": "string",
"ErrorMessage": "string",
"MemberArn": "string"
}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

BatchChannelMemberships (p. 33)

The list of channel memberships in the response.

Type: BatchChannelMemberships (p. 1111) object

Errors (p. 33)

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.

Type: Array of BatchCreateChannelMembershipError (p. 1112) objects

33
 Amazon Chime SDK API Reference
BatchCreateChannelMembership

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

34
 Amazon Chime SDK API Reference
BatchCreateRoomMembership

BatchCreateRoomMembership
Service: Amazon Chime

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.

Request Syntax
POST /accounts/accountId/rooms/roomId/memberships?operation=batch-create HTTP/1.1
Content-type: application/json

{
"MembershipItemList": [
{
"MemberId": "string",
"Role": "string"
}
]
}

URI Request Parameters

The request uses the following URI parameters.

accountId (p. 35)

The Amazon Chime account ID.

Pattern: .*\S.*

Required: Yes
roomId (p. 35)

The room ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

MembershipItemList (p. 35)

The list of membership items.

Type: Array of MembershipItem (p. 1163) objects

Array Members: Maximum number of 50 items.

Required: Yes

Response Syntax
HTTP/1.1 201

35
 Amazon Chime SDK API Reference
BatchCreateRoomMembership

Content-type: application/json

{
"Errors": [
{
"ErrorCode": "string",
"ErrorMessage": "string",
"MemberId": "string"
}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

Errors (p. 35)

If the action fails for one or more of the member IDs in the request, a list of the member IDs is
returned, along with error codes and error messages.

Type: Array of MemberError (p. 1162) objects

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

36
 Amazon Chime SDK API Reference
BatchCreateRoomMembership

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example adds multiple users to the chat room as chat room members. It also assigns administrator
and member roles to the users.

Sample Request

POST /accounts/12a3456b-7c89-012d-3456-78901e23fg45/rooms/
abcd1e2d-3e45-6789-01f2-3g45h67i890j/memberships?operation=batch-create HTTP/1.1 Host:
service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.293
Python/3.8.0 Windows/10 botocore/1.13.29 X-Amz-Date: 20191202T224658Z Authorization:
AUTHPARAMS Content-Length: 175 {"MembershipItemList": [{"MemberId": "1ab2345c-67de-8901-
f23g-45h678901j2k", "Role": "Administrator"}, {"MemberId": "2ab2345c-67de-8901-
f23g-45h678901j2k", "Role": "Member"}]}

Sample Response

HTTP/1.1 201 Created x-amzn-RequestId: 169ba401-d886-475f-8b3f-e01eac6fadfb Content-Type:

application/json Content-Length: 13 Date: Mon, 02 Dec 2019 22:46:58 GMT Connection: keep-
alive {"Errors":[]}

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

37
 Amazon Chime SDK API Reference
BatchDeletePhoneNumber

BatchDeletePhoneNumber
Service: Amazon Chime

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.

Request Syntax
POST /phone-numbers?operation=batch-delete HTTP/1.1
Content-type: application/json

{
"PhoneNumberIds": [ "string" ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

PhoneNumberIds (p. 38)

List of phone number IDs.

Type: Array of strings

Array Members: Minimum number of 1 item.

Required: Yes

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"PhoneNumberErrors": [
{
"ErrorCode": "string",
"ErrorMessage": "string",
"PhoneNumberId": "string"
}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

38
 Amazon Chime SDK API Reference
BatchDeletePhoneNumber

PhoneNumberErrors (p. 38)

If the action fails for one or more of the phone numbers in the request, a list of the phone numbers
is returned, along with error codes and error messages.

Type: Array of PhoneNumberError (p. 1177) objects

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

39
 Amazon Chime SDK API Reference
BatchDeletePhoneNumber

Example
This example moves multiple phone numbers into the Deletion queue .

Sample Request

POST /phone-numbers?operation=batch-delete HTTP/1.1 Host: service.chime.aws.amazon.com

Accept-Encoding: identity User-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10
botocore/1.12.160 X-Amz-Date: 20190918T195348Z Authorization: AUTHPARAMS Content-Length:
56 {"PhoneNumberIds": ["%2B12065550100", "%2B12065550101"]}

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: f6ac5632-e71a-4755-997b-971c4dbff22c Content-Type:

application/json Content-Length: 24 Date: Wed, 18 Sep 2019 19:53:49 GMT Connection: keep-
alive {"PhoneNumberErrors":[]}

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

40
 Amazon Chime SDK API Reference
BatchSuspendUser

BatchSuspendUser
Service: Amazon Chime

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 (p. 337) 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 (p. 44) action.

To sign out users without suspending them, use the LogoutUser (p. 433) action.

Request Syntax
POST /accounts/accountId/users?operation=suspend HTTP/1.1
Content-type: application/json

{
"UserIdList": [ "string" ]
}

URI Request Parameters

The request uses the following URI parameters.

accountId (p. 41)

The Amazon Chime account ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

UserIdList (p. 41)

The request containing the user IDs to suspend.

Type: Array of strings

Array Members: Maximum number of 50 items.

Pattern: .*\S.*

Required: Yes

Response Syntax
HTTP/1.1 200

41
 Amazon Chime SDK API Reference
BatchSuspendUser

Content-type: application/json

{
"UserErrors": [
{
"ErrorCode": "string",
"ErrorMessage": "string",
"UserId": "string"
}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

UserErrors (p. 41)

If the BatchSuspendUser (p. 41) action fails for one or more of the user IDs in the request, a list of
the user IDs is returned, along with error codes and error messages.

Type: Array of UserError (p. 1214) objects

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

42
 Amazon Chime SDK API Reference
BatchSuspendUser

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example suspends the listed users from the specified Amazon Chime account.

Sample Request

POST /console/accounts/12a3456b-7c89-012d-3456-78901e23fg45/users?operation=suspend
HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding: identity User-Agent:
aws-cli/1.16.83 Python/3.6.6 Windows/10 botocore/1.12.73 X-Amz-Date: 20190108T183005Z
Authorization: AUTHPARAMS Content-Length: 56 {"UserIdList": ["4ab2345c-67de-8901-
f23g-45h678901j2k"]}

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 5343c54a-eedf-487a-8178-38afb05c33ef Content-Type:

application/json Content-Length: 146 Date: Tue, 08 Jan 2019 18:30:05 GMT Connection: keep-
alive {"UserErrors": [] }

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

43
 Amazon Chime SDK API Reference
BatchUnsuspendUser

BatchUnsuspendUser
Service: Amazon Chime

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.

Request Syntax
POST /accounts/accountId/users?operation=unsuspend HTTP/1.1
Content-type: application/json

{
"UserIdList": [ "string" ]
}

URI Request Parameters

The request uses the following URI parameters.

accountId (p. 44)

The Amazon Chime account ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

UserIdList (p. 44)

The request containing the user IDs to unsuspend.

Type: Array of strings

Array Members: Maximum number of 50 items.

Pattern: .*\S.*

Required: Yes

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"UserErrors": [

44
 Amazon Chime SDK API Reference
BatchUnsuspendUser

{
"ErrorCode": "string",
"ErrorMessage": "string",
"UserId": "string"
}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

UserErrors (p. 44)

If the BatchUnsuspendUser (p. 44) action fails for one or more of the user IDs in the request, a list
of the user IDs is returned, along with error codes and error messages.

Type: Array of UserError (p. 1214) objects

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

45
 Amazon Chime SDK API Reference
BatchUnsuspendUser

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example removes the previous suspension for the listed users on the specified Amazon Chime
account.

Sample Request

POST /console/accounts/12a3456b-7c89-012d-3456-78901e23fg45/users?operation=unsuspend
HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding: identity User-Agent:
aws-cli/1.16.83 Python/3.6.6 Windows/10 botocore/1.12.73 X-Amz-Date: 20190108T220526Z
Authorization: AUTHPARAMS Content-Length: 96 {"UserIdList": ["1ab2345c-67de-8901-
f23g-45h678901j2k", "2ab2345c-67de-8901-f23g-45h678901j2k", "3ab2345c-67de-8901-
f23g-45h678901j2k"]}

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: d97c7380-cb87-40ce-b4c3-c250999a92dc Content-Type:

application/json Content-Length: 17 Date: Tue, 08 Jan 2019 22:05:26 GMT Connection: keep-
alive {"UserErrors": [] }

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

46
 Amazon Chime SDK API Reference
BatchUpdatePhoneNumber

BatchUpdatePhoneNumber
Service: Amazon Chime

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.

Request Syntax
POST /phone-numbers?operation=batch-update HTTP/1.1
Content-type: application/json

{
"UpdatePhoneNumberRequestItems": [
{
"CallingName": "string",
"PhoneNumberId": "string",
"ProductType": "string"
}
]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

UpdatePhoneNumberRequestItems (p. 47)

The request containing the phone number IDs and product types or calling names to update.

Type: Array of UpdatePhoneNumberRequestItem (p. 1209) objects

Required: Yes

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"PhoneNumberErrors": [
{
"ErrorCode": "string",
"ErrorMessage": "string",
"PhoneNumberId": "string"
}
]
}

47
 Amazon Chime SDK API Reference
BatchUpdatePhoneNumber

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

PhoneNumberErrors (p. 47)

If the action fails for one or more of the phone numbers in the request, a list of the phone numbers
is returned, along with error codes and error messages.

Type: Array of PhoneNumberError (p. 1177) objects

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

48
 Amazon Chime SDK API Reference
BatchUpdatePhoneNumber

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example: Update Product Types

This example updates the product type for multiple phone numbers.

Sample Request

POST /phone-numbers?operation=batch-update HTTP/1.1 Host: service.chime.aws.amazon.com

Accept-Encoding: identity User-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10
botocore/1.12.160 X-Amz-Date: 20190918T195200Z Authorization: AUTHPARAMS Content-
Length: 177 {"UpdatePhoneNumberRequestItems": [{"PhoneNumberId": "%2B12065550100",
"ProductType": "BusinessCalling"}, {"PhoneNumberId": "%2B12065550101", "ProductType":
"Voice Connector"}]}

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 78f4ee00-d8e0-4a13-b24e-147557576368 Content-Type:

application/json Content-Length: 24 Date: Wed, 18 Sep 2019 19:52:01 GMT Connection: keep-
alive {"PhoneNumberErrors":[]}

Example: Update Outbound Calling Names

This example updates the outbound calling name for multiple phone numbers.

Sample Request

POST /phone-numbers?operation=batch-update HTTP/1.1 Host: service.chime.aws.amazon.com

Accept-Encoding: identity User-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10
botocore/1.12.160 X-Amz-Date: 20191028T183405Z Authorization: AUTHPARAMS Content-Length:
171 {"UpdatePhoneNumberRequestItems": [{"PhoneNumberId": "%2B12065550100", "CallingName":
"phonenumber1"}, {"PhoneNumberId": "%2B12065550101", "CallingName": "phonenumber2"}]}

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 32f678c1-21d2-43ab-ac8f-cd922c1ab42e Content-Type:

application/json Content-Length: 24 Date: Mon, 28 Oct 2019 18:34:05 GMT Connection: keep-
alive {"PhoneNumberErrors":[]}

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python

49
 Amazon Chime SDK API Reference
BatchUpdatePhoneNumber

• AWS SDK for Ruby V3

50
 Amazon Chime SDK API Reference
BatchUpdateUser

BatchUpdateUser
Service: Amazon Chime

Updates user details within the UpdateUserRequestItem (p. 1210) object for up to 20 users for the
specified Amazon Chime account. Currently, only LicenseType updates are supported for this action.

Request Syntax
POST /accounts/accountId/users HTTP/1.1
Content-type: application/json

{
"UpdateUserRequestItems": [
{
"AlexaForBusinessMetadata": {
"AlexaForBusinessRoomArn": "string",
"IsAlexaForBusinessEnabled": boolean
},
"LicenseType": "string",
"UserId": "string",
"UserType": "string"
}
]
}

URI Request Parameters

The request uses the following URI parameters.

accountId (p. 51)

The Amazon Chime account ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

UpdateUserRequestItems (p. 51)

The request containing the user IDs and details to update.

Type: Array of UpdateUserRequestItem (p. 1210) objects

Array Members: Maximum number of 20 items.

Required: Yes

Response Syntax
HTTP/1.1 200
Content-type: application/json

51
 Amazon Chime SDK API Reference
BatchUpdateUser

{
"UserErrors": [
{
"ErrorCode": "string",
"ErrorMessage": "string",
"UserId": "string"
}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

UserErrors (p. 51)

If the BatchUpdateUser (p. 51) action fails for one or more of the user IDs in the request, a list of
the user IDs is returned, along with error codes and error messages.

Type: Array of UserError (p. 1214) objects

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

52
 Amazon Chime SDK API Reference
BatchUpdateUser

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example updates details for the listed users in the specified Amazon Chime account.

Sample Request

POST /console/accounts/12a3456b-7c89-012d-3456-78901e23fg45/users HTTP/1.1 Host:

service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.83
Python/3.6.6 Windows/10 botocore/1.12.73 X-Amz-Date: 20190108T215856Z Authorization:
AUTHPARAMS Content-Length: 180 {"UpdateUserRequestItems": [{"UserId": "1ab2345c-67de-8901-
f23g-45h678901j2k", "LicenseType": "Basic"}, {"UserId": "2ab2345c-67de-8901-
f23g-45h678901j2k", "LicenseType": "Basic"}]}

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 035a3bcd-1a1f-4ccc-bf7f-d2c9027637d2 Content-Type:

application/json Content-Length: 17 Date: Tue, 08 Jan 2019 21:58:56 GMT Connection: keep-
alive {"UserErrors": [] }

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

53
 Amazon Chime SDK API Reference
CreateAccount

CreateAccount
Service: Amazon Chime

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.

Request Syntax
POST /accounts HTTP/1.1
Content-type: application/json

{
"Name": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

Name (p. 54)

The name of the Amazon Chime account.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: .*\S.*

Required: Yes

Response Syntax
HTTP/1.1 201
Content-type: application/json

{
"Account": {
"AccountId": "string",
"AccountStatus": "string",
"AccountType": "string",
"AwsAccountId": "string",
"CreatedTimestamp": number,
"DefaultLicense": "string",
"Name": "string",
"SigninDelegateGroups": [
{
"GroupName": "string"
}
],
"SupportedLicenses": [ "string" ]
}
}

54
 Amazon Chime SDK API Reference
CreateAccount

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

Account (p. 54)

The Amazon Chime account details.

Type: Account (p. 1091) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

55
 Amazon Chime SDK API Reference
CreateAccount

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example creates a new Amazon Chime account under the administrator's AWS account.

Sample Request

POST /console/accounts HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding:

identity User-Agent: aws-cli/1.16.83 Python/3.6.6 Windows/10 botocore/1.12.73 X-Amz-Date:
20190108T175917Z Authorization: AUTHPARAMS Content-Length: 17 {"Name": "example"}

Sample Response

HTTP/1.1 201 Created x-amzn-RequestId: d4f09103-9543-4ff9-b0a0-f1d4c6e2aec7

Content-Type: application/json Content-Length: 422 Date: Tue, 08 Jan
2019 17:59:18 GMT Connection: keep-alive {"Account": {"AccountId":
"12a3456b-7c89-012d-3456-78901e23fg45","AccountStatus": "Active","AccountType":
"Team","Admins": null,"AwsAccountId": "111122223333","BillingType":
"SeatBilling","CreatedTimestamp": "2019-01-08T17:59:18.006Z","DefaultLicense":
"Pro","DelegationStatus": "NoDelegation","DirectoryId": null,"Domains":
null,"Groups": [],"Name": "example","Owner": null,"SupportedLicenses": ["Basic",
"Pro"],"UseProTrialLicense": false} }

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

56
 Amazon Chime SDK API Reference
CreateAppInstance

CreateAppInstance
Service: Amazon Chime

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.

Request Syntax
POST /app-instances HTTP/1.1
Content-type: application/json

{
"ClientRequestToken": "string",
"Metadata": "string",
"Name": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

ClientRequestToken (p. 57)

The ClientRequestToken of the AppInstance.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

Pattern: [-_a-zA-Z0-9]*

Required: Yes
Metadata (p. 57)

The metadata of the AppInstance. Limited to a 1KB string in UTF-8.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: .*

Required: No
Name (p. 57)

The name of the AppInstance.

57
 Amazon Chime SDK API Reference
CreateAppInstance

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD
\u10000-\u10FFFF]*

Required: Yes
Tags (p. 57)

Tags assigned to the AppInstance.

Type: Array of Tag (p. 1203) objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Required: No

Response Syntax
HTTP/1.1 201
Content-type: application/json

{
"AppInstanceArn": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

AppInstanceArn (p. 58)

The Amazon Resource Number (ARN) of the AppInstance.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

58
 Amazon Chime SDK API Reference
CreateAppInstance

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

59
 Amazon Chime SDK API Reference
CreateAppInstanceAdmin

CreateAppInstanceAdmin
Service: Amazon Chime

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.

Request Syntax
POST /app-instances/appInstanceArn/admins HTTP/1.1
Content-type: application/json

{
"AppInstanceAdminArn": "string"
}

URI Request Parameters

The request uses the following URI parameters.

appInstanceArn (p. 60)

The ARN of the AppInstance.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Request Body
The request accepts the following data in JSON format.

AppInstanceAdminArn (p. 60)

The ARN of the administrator of the current AppInstance.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Response Syntax
HTTP/1.1 201

60
 Amazon Chime SDK API Reference
CreateAppInstanceAdmin

Content-type: application/json

{
"AppInstanceAdmin": {
"Arn": "string",
"Name": "string"
},
"AppInstanceArn": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

AppInstanceAdmin (p. 60)

The name and ARN of the admin for the AppInstance.

Type: Identity (p. 1151) object

AppInstanceArn (p. 60)

The ARN of the of the admin for the AppInstance.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

61
 Amazon Chime SDK API Reference
CreateAppInstanceAdmin

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

62
 Amazon Chime SDK API Reference
CreateAppInstanceUser

CreateAppInstanceUser
Service: Amazon Chime

Creates a user under an Amazon Chime AppInstance. The request consists of a unique
appInstanceUserId and Name for that user.

Request Syntax
POST /app-instance-users HTTP/1.1
Content-type: application/json

{
"AppInstanceArn": "string",
"AppInstanceUserId": "string",
"ClientRequestToken": "string",
"Metadata": "string",
"Name": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

AppInstanceArn (p. 63)

The ARN of the AppInstance request.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
AppInstanceUserId (p. 63)

The user ID of the AppInstance.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [A-Za-z0-9]([A-Za-z0-9\:\-\_\.\@]{0,62}[A-Za-z0-9])?

Required: Yes
ClientRequestToken (p. 63)

The token assigned to the user requesting an AppInstance.

63
 Amazon Chime SDK API Reference
CreateAppInstanceUser

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

Pattern: [-_a-zA-Z0-9]*

Required: Yes
Metadata (p. 63)

The request's metadata. Limited to a 1KB string in UTF-8.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: .*

Required: No
Name (p. 63)

The user's name.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: .*\S.*

Required: Yes
Tags (p. 63)

Tags assigned to the AppInstanceUser.

Type: Array of Tag (p. 1203) objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Required: No

Response Syntax
HTTP/1.1 201
Content-type: application/json

{
"AppInstanceUserArn": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

AppInstanceUserArn (p. 64)

The user's ARN.

Type: String

64
 Amazon Chime SDK API Reference
CreateAppInstanceUser

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

65
 Amazon Chime SDK API Reference
CreateAppInstanceUser

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

66
 Amazon Chime SDK API Reference
CreateAttendee

CreateAttendee
Service: Amazon Chime

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.

Request Syntax
POST /meetings/meetingId/attendees HTTP/1.1
Content-type: application/json

{
"ExternalUserId": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}

URI Request Parameters

The request uses the following URI parameters.

meetingId (p. 67)

The Amazon Chime SDK meeting ID.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: Yes

Request Body
The request accepts the following data in JSON format.

ExternalUserId (p. 67)

The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity
managed by a builder application.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

Required: Yes
Tags (p. 67)

The tag key-value pairs.

Type: Array of Tag (p. 1203) objects

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Required: No

67
 Amazon Chime SDK API Reference
CreateAttendee

Response Syntax
HTTP/1.1 201
Content-type: application/json

{
"Attendee": {
"AttendeeId": "string",
"ExternalUserId": "string",
"JoinToken": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

Attendee (p. 68)

The attendee information, including attendee ID and join token.

Type: Attendee (p. 1109) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

68
 Amazon Chime SDK API Reference
CreateAttendee

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

69
 Amazon Chime SDK API Reference
CreateBot

CreateBot
Service: Amazon Chime

Creates a bot for an Amazon Chime Enterprise account.

Request Syntax
POST /accounts/accountId/bots HTTP/1.1
Content-type: application/json

{
"DisplayName": "string",
"Domain": "string"
}

URI Request Parameters

The request uses the following URI parameters.

accountId (p. 70)

The Amazon Chime account ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

DisplayName (p. 70)

The bot display name.

Type: String

Required: Yes
Domain (p. 70)

The domain of the Amazon Chime Enterprise account.

Type: String

Pattern: .*\S.*

Required: No

Response Syntax
HTTP/1.1 201
Content-type: application/json

{
"Bot": {

70
 Amazon Chime SDK API Reference
CreateBot

"BotEmail": "string",
"BotId": "string",
"BotType": "string",
"CreatedTimestamp": number,
"Disabled": boolean,
"DisplayName": "string",
"SecurityToken": "string",
"UpdatedTimestamp": number,
"UserId": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

Bot (p. 70)

The bot details.

Type: Bot (p. 1113) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

71
 Amazon Chime SDK API Reference
CreateBot

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example creates a bot.

Sample Request

POST /accounts/12a3456b-7c89-012d-3456-78901e23fg45/bots HTTP/1.1 Host:

service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.170
Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-Date: 20190918T172439Z Authorization:
AUTHPARAMS Content-Length: 60 {"DisplayName": "myBot", "Domain": "example.com"}

Sample Response

HTTP/1.1 201 Created x-amzn-RequestId: 4c54e5bc-4ff5-4828-a222-59996acbc6ee

Content-Type: application/json Content-Length: 374 Date: Wed, 18 Sep
2019 17:24:39 GMT Connection: keep-alive {"Bot":{"BotEmail":"myBot-
[email protected]","BotId":"123abcd4-5ef6-789g-0h12-34j56789012k","BotType":"ChatBot","CreatedTimest
(Bot)","SecurityToken":"wJalrXUtnFEMI/K7MDENG/
bPxRfiCYEXAMPLEKEY","UpdatedTimestamp":"2019-09-18T17:24:39.534Z","UserId":"123abcd4-5ef6-789g-0h12-34j

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python

72
 Amazon Chime SDK API Reference
CreateBot

• AWS SDK for Ruby V3

73
 Amazon Chime SDK API Reference
CreateChannel

CreateChannel
Service: Amazon Chime

Creates a channel to which you can add users and send messages.

Restriction: You can't change a channel's privacy.

Note
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.

Request Syntax
POST /channels HTTP/1.1
x-amz-chime-bearer: ChimeBearer
Content-type: application/json

{
"AppInstanceArn": "string",
"ClientRequestToken": "string",
"Metadata": "string",
"Mode": "string",
"Name": "string",
"Privacy": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}

URI Request Parameters

The request uses the following URI parameters.

ChimeBearer (p. 74)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Request Body
The request accepts the following data in JSON format.

AppInstanceArn (p. 74)

The ARN of the channel request.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

74
 Amazon Chime SDK API Reference
CreateChannel

Required: Yes
ClientRequestToken (p. 74)

The client token for the request. An Idempotency token.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

Pattern: [-_a-zA-Z0-9]*

Required: Yes
Metadata (p. 74)

The metadata of the creation request. Limited to 1KB and UTF-8.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: .*

Required: No
Mode (p. 74)

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.

Type: String

Valid Values: UNRESTRICTED | RESTRICTED

Required: No
Name (p. 74)

The name of the channel.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD
\u10000-\u10FFFF]*

Required: Yes
Privacy (p. 74)

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.

Type: String

Valid Values: PUBLIC | PRIVATE

Required: No
Tags (p. 74)

The tags for the creation request.

75
 Amazon Chime SDK API Reference
CreateChannel

Type: Array of Tag (p. 1203) objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Required: No

Response Syntax
HTTP/1.1 201
Content-type: application/json

{
"ChannelArn": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

ChannelArn (p. 76)

The ARN of the channel.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

76
 Amazon Chime SDK API Reference
CreateChannel

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

77
 Amazon Chime SDK API Reference
CreateChannelBan

CreateChannelBan
Service: Amazon Chime

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.
Note
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.

Request Syntax
POST /channels/channelArn/bans HTTP/1.1
x-amz-chime-bearer: ChimeBearer
Content-type: application/json

{
"MemberArn": "string"
}

URI Request Parameters

The request uses the following URI parameters.

channelArn (p. 78)

The ARN of the ban request.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 78)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Request Body
The request accepts the following data in JSON format.

MemberArn (p. 78)

The ARN of the member being banned.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

78
 Amazon Chime SDK API Reference
CreateChannelBan

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Response Syntax
HTTP/1.1 201
Content-type: application/json

{
"ChannelArn": "string",
"Member": {
"Arn": "string",
"Name": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

ChannelArn (p. 79)

The ARN of the response to the ban request.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}
Member (p. 79)

The ChannelArn and BannedIdentity of the member in the ban response.

Type: Identity (p. 1151) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

79
 Amazon Chime SDK API Reference
CreateChannelBan

HTTP Status Code: 403

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

80
 Amazon Chime SDK API Reference
CreateChannelMembership

CreateChannelMembership
Service: Amazon Chime

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.

Note
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.

Request Syntax
POST /channels/channelArn/memberships HTTP/1.1
x-amz-chime-bearer: ChimeBearer
Content-type: application/json

{
"MemberArn": "string",
"Type": "string"
}

URI Request Parameters

The request uses the following URI parameters.

channelArn (p. 81)

The ARN of the channel to which you're adding users.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 81)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

81
 Amazon Chime SDK API Reference
CreateChannelMembership

Request Body
The request accepts the following data in JSON format.

MemberArn (p. 81)

The ARN of the member you want to add to the channel.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
Type (p. 81)

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.

Type: String

Valid Values: DEFAULT | HIDDEN

Required: Yes

Response Syntax
HTTP/1.1 201
Content-type: application/json

{
"ChannelArn": "string",
"Member": {
"Arn": "string",
"Name": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

ChannelArn (p. 82)

The ARN of the channel.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

82
 Amazon Chime SDK API Reference
CreateChannelMembership

Member (p. 82)

The ARN and metadata of the member being added.

Type: Identity (p. 1151) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

83
 Amazon Chime SDK API Reference
CreateChannelMembership

• AWS SDK for .NET

• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

84
 Amazon Chime SDK API Reference
CreateChannelModerator

CreateChannelModerator
Service: Amazon Chime

Creates a new ChannelModerator. A channel moderator can:

• Add and remove other members of the channel.

• Add and remove other moderators of the channel.
• Add and remove user bans for the channel.
• Redact messages in the channel.
• List messages in the channel.

Note
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.

Request Syntax
POST /channels/channelArn/moderators HTTP/1.1
x-amz-chime-bearer: ChimeBearer
Content-type: application/json

{
"ChannelModeratorArn": "string"
}

URI Request Parameters

The request uses the following URI parameters.

channelArn (p. 85)

The ARN of the channel.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 85)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Request Body
The request accepts the following data in JSON format.

ChannelModeratorArn (p. 85)

The ARN of the moderator.

85
 Amazon Chime SDK API Reference
CreateChannelModerator

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Response Syntax
HTTP/1.1 201
Content-type: application/json

{
"ChannelArn": "string",
"ChannelModerator": {
"Arn": "string",
"Name": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

ChannelArn (p. 86)

The ARN of the channel.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}
ChannelModerator (p. 86)

The ARNs of the channel and the moderator.

Type: Identity (p. 1151) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

86
 Amazon Chime SDK API Reference
CreateChannelModerator

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

87
 Amazon Chime SDK API Reference
CreateMediaCapturePipeline

CreateMediaCapturePipeline
Service: Amazon Chime

Creates a media capture pipeline.

Request Syntax
POST /media-capture-pipelines HTTP/1.1
Content-type: application/json

{
"ChimeSdkMeetingConfiguration": {
"ArtifactsConfiguration": {
"Audio": {
"MuxType": "string"
},
"Content": {
"MuxType": "string",
"State": "string"
},
"Video": {
"MuxType": "string",
"State": "string"
}
},
"SourceConfiguration": {
"SelectedVideoStreams": {
"AttendeeIds": [ "string" ],
"ExternalUserIds": [ "string" ]
}
}
},
"ClientRequestToken": "string",
"SinkArn": "string",
"SinkType": "string",
"SourceArn": "string",
"SourceType": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

ChimeSdkMeetingConfiguration (p. 88)

The configuration for a specified media capture pipeline. SourceType must be ChimeSdkMeeting.

Type: ChimeSdkMeetingConfiguration (p. 1136) object

Required: No
ClientRequestToken (p. 88)

The unique identifier for the client request. The token makes the API request idempotent. Use a
different token for different media pipeline requests.

Type: String

88
 Amazon Chime SDK API Reference
CreateMediaCapturePipeline

Length Constraints: Minimum length of 2. Maximum length of 64.

Pattern: [-_a-zA-Z0-9]*

Required: No
SinkArn (p. 88)

The ARN of the sink type.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^arn[\/\:\-\_\.a-zA-Z0-9]+$

Required: Yes
SinkType (p. 88)

Destination type to which the media artifacts are saved. You must use an S3 bucket.

Type: String

Valid Values: S3Bucket

Required: Yes
SourceArn (p. 88)

ARN of the source from which the media artifacts are captured.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^arn[\/\:\-\_\.a-zA-Z0-9]+$

Required: Yes
SourceType (p. 88)

Source type from which the media artifacts will be captured. A Chime SDK Meeting is the only
supported source.

Type: String

Valid Values: ChimeSdkMeeting

Required: Yes

Response Syntax
HTTP/1.1 201
Content-type: application/json

{
"MediaCapturePipeline": {
"ChimeSdkMeetingConfiguration": {
"ArtifactsConfiguration": {
"Audio": {
"MuxType": "string"

89
 Amazon Chime SDK API Reference
CreateMediaCapturePipeline

},
"Content": {
"MuxType": "string",
"State": "string"
},
"Video": {
"MuxType": "string",
"State": "string"
}
},
"SourceConfiguration": {
"SelectedVideoStreams": {
"AttendeeIds": [ "string" ],
"ExternalUserIds": [ "string" ]
}
}
},
"CreatedTimestamp": number,
"MediaPipelineId": "string",
"SinkArn": "string",
"SinkType": "string",
"SourceArn": "string",
"SourceType": "string",
"Status": "string",
"UpdatedTimestamp": number
}
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

MediaCapturePipeline (p. 89)

A media capture pipeline object, the ID, source type, source ARN, sink type, and sink ARN of a media
capture pipeline object.

Type: MediaCapturePipeline (p. 1154) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

90
 Amazon Chime SDK API Reference
CreateMediaCapturePipeline

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

91
 Amazon Chime SDK API Reference
CreateMeeting

CreateMeeting
Service: Amazon Chime

Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees. For
more information about specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon
Chime SDK Developer Guide . For more information about the Amazon Chime SDK, see Using the Amazon
Chime SDK in the Amazon Chime SDK Developer Guide .

Request Syntax
POST /meetings HTTP/1.1
Content-type: application/json

{
"ClientRequestToken": "string",
"ExternalMeetingId": "string",
"MediaRegion": "string",
"MeetingHostId": "string",
"NotificationsConfiguration": {
"SnsTopicArn": "string",
"SqsQueueArn": "string"
},
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

ClientRequestToken (p. 92)

The unique identifier for the client request. Use a different token for different meetings.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

Pattern: [-_a-zA-Z0-9]*

Required: Yes
ExternalMeetingId (p. 92)

The external meeting ID.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

Required: No

92
 Amazon Chime SDK API Reference
CreateMeeting

MediaRegion (p. 92)

The Region in which to create the meeting. Default: us-east-1.

Available values: af-south-1 , ap-northeast-1 , ap-northeast-2 , ap-south-1 , ap-

southeast-1 , ap-southeast-2 , ca-central-1 , eu-central-1 , eu-north-1 , eu-south-1
, eu-west-1 , eu-west-2 , eu-west-3 , sa-east-1 , us-east-1 , us-east-2 , us-west-1 , us-
west-2 .

Type: String

Required: No
MeetingHostId (p. 92)

Reserved.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

Required: No
NotificationsConfiguration (p. 92)

The configuration for resource targets to receive notifications when meeting and attendee events
occur.

Type: MeetingNotificationConfiguration (p. 1159) object

Required: No
Tags (p. 92)

The tag key-value pairs.

Type: Array of Tag (p. 1203) objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Required: No

Response Syntax
HTTP/1.1 201
Content-type: application/json

{
"Meeting": {
"ExternalMeetingId": "string",
"MediaPlacement": {
"AudioFallbackUrl": "string",
"AudioHostUrl": "string",
"EventIngestionUrl": "string",
"ScreenDataUrl": "string",
"ScreenSharingUrl": "string",
"ScreenViewingUrl": "string",
"SignalingUrl": "string",
"TurnControlUrl": "string"
},
"MediaRegion": "string",
"MeetingId": "string"
}

93
 Amazon Chime SDK API Reference
CreateMeeting

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

Meeting (p. 93)

The meeting information, including the meeting ID and MediaPlacement .

Type: Meeting (p. 1158) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

94
 Amazon Chime SDK API Reference
CreateMeeting

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

95
 Amazon Chime SDK API Reference
CreateMeetingDialOut

CreateMeetingDialOut
Service: Amazon Chime

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.

To play welcome audio or implement an interactive voice response (IVR), use the
CreateSipMediaApplicationCall action with the corresponding SIP media application ID.

Request Syntax
POST /meetings/meetingId/dial-outs HTTP/1.1
Content-type: application/json

{
"FromPhoneNumber": "string",
"JoinToken": "string",
"ToPhoneNumber": "string"
}

URI Request Parameters

The request uses the following URI parameters.

meetingId (p. 96)

The Amazon Chime SDK meeting ID.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: Yes

Request Body
The request accepts the following data in JSON format.

FromPhoneNumber (p. 96)

Phone number used as the caller ID when the remote party receives a call.

Type: String

Pattern: ^\+?[1-9]\d{1,14}$

Required: Yes
JoinToken (p. 96)

Token used by the Amazon Chime SDK attendee. Call the CreateAttendee action to get a join token.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 2048.

Pattern: ^[a-zA-Z0-9+/]+$

Required: Yes

96
 Amazon Chime SDK API Reference
CreateMeetingDialOut

ToPhoneNumber (p. 96)

Phone number called when inviting someone to a meeting.

Type: String

Pattern: ^\+?[1-9]\d{1,14}$

Required: Yes

Response Syntax
HTTP/1.1 201
Content-type: application/json

{
"TransactionId": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

TransactionId (p. 97)

Unique ID that tracks API calls.

Type: String

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

AccessDeniedException

You don't have permissions to perform the requested operation.

HTTP Status Code: 403

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

97
 Amazon Chime SDK API Reference
CreateMeetingDialOut

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

98
 Amazon Chime SDK API Reference
CreateMeetingWithAttendees

CreateMeetingWithAttendees
Service: Amazon Chime

Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees. For more
information about specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon
Chime SDK Developer Guide . For more information about the Amazon Chime SDK, see Using the Amazon
Chime SDK in the Amazon Chime SDK Developer Guide .

Request Syntax
POST /meetings?operation=create-attendees HTTP/1.1
Content-type: application/json

{
"Attendees": [
{
"ExternalUserId": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
],
"ClientRequestToken": "string",
"ExternalMeetingId": "string",
"MediaRegion": "string",
"MeetingHostId": "string",
"NotificationsConfiguration": {
"SnsTopicArn": "string",
"SqsQueueArn": "string"
},
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

Attendees (p. 99)

The request containing the attendees to create.

Type: Array of CreateAttendeeRequestItem (p. 1140) objects

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Required: No

99
 Amazon Chime SDK API Reference
CreateMeetingWithAttendees

ClientRequestToken (p. 99)

The unique identifier for the client request. Use a different token for different meetings.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

Pattern: [-_a-zA-Z0-9]*

Required: Yes
ExternalMeetingId (p. 99)

The external meeting ID.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

Required: No
MediaRegion (p. 99)

The Region in which to create the meeting. Default: us-east-1 .

Available values: af-south-1 , ap-northeast-1 , ap-northeast-2 , ap-south-1 , ap-

southeast-1 , ap-southeast-2 , ca-central-1 , eu-central-1 , eu-north-1 , eu-south-1
, eu-west-1 , eu-west-2 , eu-west-3 , sa-east-1 , us-east-1 , us-east-2 , us-west-1 , us-
west-2 .

Type: String

Required: No
MeetingHostId (p. 99)

Reserved.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

Required: No
NotificationsConfiguration (p. 99)

The resource target configurations for receiving Amazon Chime SDK meeting and attendee event
notifications. The Amazon Chime SDK supports resource targets located in the US East (N. Virginia)
AWS Region (us-east-1).

Type: MeetingNotificationConfiguration (p. 1159) object

Required: No
Tags (p. 99)

The tag key-value pairs.

Type: Array of Tag (p. 1203) objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

100
 Amazon Chime SDK API Reference
CreateMeetingWithAttendees

Required: No

Response Syntax
HTTP/1.1 201
Content-type: application/json

{
"Attendees": [
{
"AttendeeId": "string",
"ExternalUserId": "string",
"JoinToken": "string"
}
],
"Errors": [
{
"ErrorCode": "string",
"ErrorMessage": "string",
"ExternalUserId": "string"
}
],
"Meeting": {
"ExternalMeetingId": "string",
"MediaPlacement": {
"AudioFallbackUrl": "string",
"AudioHostUrl": "string",
"EventIngestionUrl": "string",
"ScreenDataUrl": "string",
"ScreenSharingUrl": "string",
"ScreenViewingUrl": "string",
"SignalingUrl": "string",
"TurnControlUrl": "string"
},
"MediaRegion": "string",
"MeetingId": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

Attendees (p. 101)

The attendee information, including attendees IDs and join tokens.

Type: Array of Attendee (p. 1109) objects

Errors (p. 101)

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.

Type: Array of CreateAttendeeError (p. 1139) objects

Meeting (p. 101)

A meeting created using the Amazon Chime SDK.

Type: Meeting (p. 1158) object

101
 Amazon Chime SDK API Reference
CreateMeetingWithAttendees

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

102
 Amazon Chime SDK API Reference
CreatePhoneNumberOrder

CreatePhoneNumberOrder
Service: Amazon Chime

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.

Request Syntax
POST /phone-number-orders HTTP/1.1
Content-type: application/json

{
"E164PhoneNumbers": [ "string" ],
"ProductType": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

E164PhoneNumbers (p. 103)

List of phone numbers, in E.164 format.

Type: Array of strings

Pattern: ^\+?[1-9]\d{1,14}$

Required: Yes
ProductType (p. 103)

The phone number product type.

Type: String

Valid Values: BusinessCalling | VoiceConnector | SipMediaApplicationDialIn

Required: Yes

Response Syntax
HTTP/1.1 201
Content-type: application/json

{
"PhoneNumberOrder": {
"CreatedTimestamp": number,
"OrderedPhoneNumbers": [
{
"E164PhoneNumber": "string",
"Status": "string"

103
 Amazon Chime SDK API Reference
CreatePhoneNumberOrder

}
],
"PhoneNumberOrderId": "string",
"ProductType": "string",
"Status": "string",
"UpdatedTimestamp": number
}
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

PhoneNumberOrder (p. 103)

The phone number order details.

Type: PhoneNumberOrder (p. 1178) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

AccessDeniedException

You don't have permissions to perform the requested operation.

HTTP Status Code: 403

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

104
 Amazon Chime SDK API Reference
CreatePhoneNumberOrder

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example creates an order for phone numbers to be provisioned.

Sample Request

POST /phone-number-orders HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding:

identity User-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-
Date: 20190918T175735Z Authorization: AUTHPARAMS Content-Length: 88 {"ProductType":
"BusinessCalling", "E164PhoneNumbers": ["+12065550100", "+12065550101"]}

Sample Response

HTTP/1.1 201 Created x-amzn-RequestId: 7ac7b213-6e5d-4b2a-a142-ce9a7bb7e455

Content-Type: application/json Content-Length: 366 Date: Wed, 18
Sep 2019 17:57:43 GMT Connection: keep-alive {"PhoneNumberOrder":
{"CreatedTimestamp":"2019-09-18T17:57:36.280Z","OrderedPhoneNumbers":
[{"E164PhoneNumber":"+12065550100","Status":"Processing"},
{"E164PhoneNumber":"+12065550101","Status":"Processing"}],"PhoneNumberOrderId":"abc12345-
de67-89f0-123g-
h45i678j9012","ProductType":"BusinessCalling","Status":"Processing","UpdatedTimestamp":"2019-09-18T17:5

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

105
 Amazon Chime SDK API Reference
CreateProxySession

CreateProxySession
Service: Amazon Chime

Creates a proxy session on the specified Amazon Chime Voice Connector for the specified participant
phone numbers.

Request Syntax
POST /voice-connectors/voiceConnectorId/proxy-sessions HTTP/1.1
Content-type: application/json

{
"Capabilities": [ "string" ],
"ExpiryMinutes": number,
"GeoMatchLevel": "string",
"GeoMatchParams": {
"AreaCode": "string",
"Country": "string"
},
"Name": "string",
"NumberSelectionBehavior": "string",
"ParticipantPhoneNumbers": [ "string" ]
}

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId (p. 106)

The Amazon Chime voice connector ID.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

Capabilities (p. 106)

The proxy session capabilities.

Type: Array of strings

Valid Values: Voice | SMS

Required: Yes
ExpiryMinutes (p. 106)

The number of minutes allowed for the proxy session.

Type: Integer

Valid Range: Minimum value of 1.

106
 Amazon Chime SDK API Reference
CreateProxySession

Required: No
GeoMatchLevel (p. 106)

The preference for matching the country or area code of the proxy phone number with that of the
first participant.

Type: String

Valid Values: Country | AreaCode

Required: No
GeoMatchParams (p. 106)

The country and area code for the proxy phone number.

Type: GeoMatchParams (p. 1150) object

Required: No
Name (p. 106)

The name of the proxy session.

Type: String

Pattern: ^$|^[a-zA-Z0-9 ]{0,30}$

Required: No
NumberSelectionBehavior (p. 106)

The preference for proxy phone number reuse, or stickiness, between the same participants across
sessions.

Type: String

Valid Values: PreferSticky | AvoidSticky

Required: No
ParticipantPhoneNumbers (p. 106)

The participant phone numbers.

Type: Array of strings

Array Members: Fixed number of 2 items.

Pattern: ^\+?[1-9]\d{1,14}$

Required: Yes

Response Syntax
HTTP/1.1 201
Content-type: application/json

{
"ProxySession": {
"Capabilities": [ "string" ],
"CreatedTimestamp": number,
"EndedTimestamp": number,

107
 Amazon Chime SDK API Reference
CreateProxySession

"ExpiryMinutes": number,
"GeoMatchLevel": "string",
"GeoMatchParams": {
"AreaCode": "string",
"Country": "string"
},
"Name": "string",
"NumberSelectionBehavior": "string",
"Participants": [
{
"PhoneNumber": "string",
"ProxyPhoneNumber": "string"
}
],
"ProxySessionId": "string",
"Status": "string",
"UpdatedTimestamp": number,
"VoiceConnectorId": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

ProxySession (p. 107)

The proxy session details.

Type: ProxySession (p. 1181) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

108
 Amazon Chime SDK API Reference
CreateProxySession

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example creates a proxy session on your Amazon Chime Voice Connector.

Sample Request

POST /voice-connectors/abcdef1ghij2klmno3pqr4/proxy-sessions HTTP/1.1 Host:

service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.18.39
Python/3.8.0 Windows/10 botocore/1.15.39 X-Amz-Date: 20200415T161009Z Authorization:
AUTHPARAMS Content-Length: 95 {"ParticipantPhoneNumbers": ["+14015550101",
"+12065550100"], "Capabilities": ["Voice", "SMS"]}

Sample Response

HTTP/1.1 201 Created x-amzn-RequestId: f40fe3fd-06fb-45e8-9d85-51833d44e651

Content-Type: application/json Content-Length: 531 Date: Wed, 15 Apr
2020 16:10:09 GMT Connection: keep-alive {"ProxySession":{"Capabilities":
["SMS","Voice"],"CreatedTimestamp":"2020-04-15T16:10:10.288Z","EndedTimestamp":null,"ExpiryMinutes":60,
[{"PhoneNumber":"+12065550100","ProxyPhoneNumber":"+19135550199"},
{"PhoneNumber":"+14015550101","ProxyPhoneNumber":"+19135550199"}],"ProxySessionId":"123a4bc5-67d8-901e-
h4ghjk56789l","Status":"Open","UpdatedTimestamp":"2020-04-15T16:10:10.288Z","VoiceConnectorId":"abcdef1

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript

109
 Amazon Chime SDK API Reference
CreateProxySession

• AWS SDK for PHP V3

• AWS SDK for Python
• AWS SDK for Ruby V3

110
 Amazon Chime SDK API Reference
CreateRoom

CreateRoom
Service: Amazon Chime

Creates a chat room for the specified Amazon Chime Enterprise account.

Request Syntax
POST /accounts/accountId/rooms HTTP/1.1
Content-type: application/json

{
"ClientRequestToken": "string",
"Name": "string"
}

URI Request Parameters

The request uses the following URI parameters.

accountId (p. 111)

The Amazon Chime account ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

ClientRequestToken (p. 111)

The idempotency token for the request.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

Pattern: [-_a-zA-Z0-9]*

Required: No
Name (p. 111)

The room name.

Type: String

Required: Yes

Response Syntax
HTTP/1.1 201
Content-type: application/json

111
 Amazon Chime SDK API Reference
CreateRoom

"Room": {
"AccountId": "string",
"CreatedBy": "string",
"CreatedTimestamp": number,
"Name": "string",
"RoomId": "string",
"UpdatedTimestamp": number
}
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

Room (p. 111)

The room details.

Type: Room (p. 1185) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

112
 Amazon Chime SDK API Reference
CreateRoom

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

113
 Amazon Chime SDK API Reference
CreateRoomMembership

CreateRoomMembership
Service: Amazon Chime

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.

Request Syntax
POST /accounts/accountId/rooms/roomId/memberships HTTP/1.1
Content-type: application/json

{
"MemberId": "string",
"Role": "string"
}

URI Request Parameters

The request uses the following URI parameters.

accountId (p. 114)

The Amazon Chime account ID.

Pattern: .*\S.*

Required: Yes
roomId (p. 114)

The room ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

MemberId (p. 114)

The Amazon Chime member ID (user ID or bot ID).

Type: String

Pattern: .*\S.*

Required: Yes
Role (p. 114)

The role of the member.

Type: String

Valid Values: Administrator | Member

114
 Amazon Chime SDK API Reference
CreateRoomMembership

Required: No

Response Syntax
HTTP/1.1 201
Content-type: application/json

{
"RoomMembership": {
"InvitedBy": "string",
"Member": {
"AccountId": "string",
"Email": "string",
"FullName": "string",
"MemberId": "string",
"MemberType": "string"
},
"Role": "string",
"RoomId": "string",
"UpdatedTimestamp": number
}
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

RoomMembership (p. 115)

The room membership details.

Type: RoomMembership (p. 1187) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

115
 Amazon Chime SDK API Reference
CreateRoomMembership

HTTP Status Code: 404

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example adds the specified user to the chat room as a chat room member.

Sample Request

POST /accounts/12a3456b-7c89-012d-3456-78901e23fg45/rooms/
abcd1e2d-3e45-6789-01f2-3g45h67i890j/memberships HTTP/1.1 Host:
service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.293
Python/3.8.0 Windows/10 botocore/1.13.29 X-Amz-Date: 20191202T223641Z Authorization:
AUTHPARAMS Content-Length: 52 {"MemberId": "1ab2345c-67de-8901-f23g-45h678901j2k"}

Sample Response

HTTP/1.1 201 Created x-amzn-RequestId: 899d868f-767e-45f7-b516-7066985c96ff Content-Type:

application/json Content-Length: 381 Date: Mon, 02 Dec 2019 22:36:42 GMT Connection: keep-
alive {"RoomMembership":{"InvitedBy":"arn:aws:iam::111122223333:user/alejandro","Member":
{"AccountId":"12a3456b-7c89-012d-3456-78901e23fg45","Email":"[email protected]","FullName":"Jane

116
 Amazon Chime SDK API Reference
CreateRoomMembership

Doe","MemberId":"1ab2345c-67de-8901-
f23g-45h678901j2k","MemberType":"User"},"Role":"Member","RoomId":"abcd1e2d-3e45-6789-01f2-3g45h67i890j"

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

117
 Amazon Chime SDK API Reference
CreateSipMediaApplication

CreateSipMediaApplication
Service: Amazon Chime

Creates a SIP media application.

Request Syntax
POST /sip-media-applications HTTP/1.1
Content-type: application/json

{
"AwsRegion": "string",
"Endpoints": [
{
"LambdaArn": "string"
}
],
"Name": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

AwsRegion (p. 118)

The AWS Region assigned to the SIP media application.

Type: String

Required: Yes
Endpoints (p. 118)

List of endpoints (Lambda Amazon Resource Names) specified for the SIP media application.
Currently, only one endpoint is supported.

Type: Array of SipMediaApplicationEndpoint (p. 1195) objects

Array Members: Fixed number of 1 item.

Required: Yes
Name (p. 118)

The SIP media application name.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

Response Syntax
HTTP/1.1 201

118
 Amazon Chime SDK API Reference
CreateSipMediaApplication

Content-type: application/json

{
"SipMediaApplication": {
"AwsRegion": "string",
"CreatedTimestamp": number,
"Endpoints": [
{
"LambdaArn": "string"
}
],
"Name": "string",
"SipMediaApplicationId": "string",
"UpdatedTimestamp": number
}
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

SipMediaApplication (p. 118)

The SIP media application details.

Type: SipMediaApplication (p. 1192) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

AccessDeniedException

You don't have permissions to perform the requested operation.

HTTP Status Code: 403

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

119
 Amazon Chime SDK API Reference
CreateSipMediaApplication

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

120
 Amazon Chime SDK API Reference
CreateSipMediaApplicationCall

CreateSipMediaApplicationCall
Service: Amazon Chime

Creates an outbound call to a phone number from the phone number specified in the request, and it
invokes the endpoint of the specified sipMediaApplicationId.

Request Syntax
POST /sip-media-applications/sipMediaApplicationId/calls HTTP/1.1
Content-type: application/json

{
"FromPhoneNumber": "string",
"SipHeaders": {
"string" : "string"
},
"ToPhoneNumber": "string"
}

URI Request Parameters

The request uses the following URI parameters.

sipMediaApplicationId (p. 121)

The ID of the SIP media application.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

FromPhoneNumber (p. 121)

The phone number that a user calls from. This is a phone number in your Amazon Chime phone
number inventory.

Type: String

Pattern: ^\+?[1-9]\d{1,14}$

Required: Yes
SipHeaders (p. 121)

The SIP headers added to an outbound call leg.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 20 items.

Required: No
ToPhoneNumber (p. 121)

The phone number that the service should call.

121
 Amazon Chime SDK API Reference
CreateSipMediaApplicationCall

Type: String

Pattern: ^\+?[1-9]\d{1,14}$

Required: Yes

Response Syntax
HTTP/1.1 201
Content-type: application/json

{
"SipMediaApplicationCall": {
"TransactionId": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

SipMediaApplicationCall (p. 122)

The actual call.

Type: SipMediaApplicationCall (p. 1194) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

AccessDeniedException

You don't have permissions to perform the requested operation.

HTTP Status Code: 403

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

122
 Amazon Chime SDK API Reference
CreateSipMediaApplicationCall

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

123
 Amazon Chime SDK API Reference
CreateSipRule

CreateSipRule
Service: Amazon Chime

Creates a SIP rule which can be used to run a SIP media application as a target for a specific trigger type.

Request Syntax
POST /sip-rules HTTP/1.1
Content-type: application/json

{
"Disabled": boolean,
"Name": "string",
"TargetApplications": [
{
"AwsRegion": "string",
"Priority": number,
"SipMediaApplicationId": "string"
}
],
"TriggerType": "string",
"TriggerValue": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

Disabled (p. 124)

Enables or disables a rule. You must disable rules before you can delete them.

Type: Boolean

Required: No
Name (p. 124)

The name of the SIP rule.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes
TargetApplications (p. 124)

List of SIP media applications with priority and AWS Region. Only one SIP application per AWS
Region can be used.

Type: Array of SipRuleTargetApplication (p. 1199) objects

Array Members: Minimum number of 1 item. Maximum number of 25 items.

Required: Yes

124
 Amazon Chime SDK API Reference
CreateSipRule

TriggerType (p. 124)

The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname or
ToPhoneNumber.

Type: String

Valid Values: ToPhoneNumber | RequestUriHostname

Required: Yes
TriggerValue (p. 124)

If TriggerType is RequestUriHostname, the value can be the outbound host name of an Amazon
Chime Voice Connector. If TriggerType is ToPhoneNumber, the value can be a customer-owned
phone number in the E164 format. The SipMediaApplication specified in the SipRule is
triggered if the request URI in an incoming SIP request matches the RequestUriHostname, or if
the To header in the incoming SIP request matches the ToPhoneNumber value.

Type: String

Pattern: .*\S.*

Required: Yes

Response Syntax
HTTP/1.1 201
Content-type: application/json

{
"SipRule": {
"CreatedTimestamp": number,
"Disabled": boolean,
"Name": "string",
"SipRuleId": "string",
"TargetApplications": [
{
"AwsRegion": "string",
"Priority": number,
"SipMediaApplicationId": "string"
}
],
"TriggerType": "string",
"TriggerValue": "string",
"UpdatedTimestamp": number
}
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

SipRule (p. 125)

Returns the SIP rule information, including the rule ID, triggers, and target applications.

Type: SipRule (p. 1197) object

125
 Amazon Chime SDK API Reference
CreateSipRule

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

AccessDeniedException

You don't have permissions to perform the requested operation.

HTTP Status Code: 403

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++

126
 Amazon Chime SDK API Reference
CreateSipRule

• AWS SDK for Go

• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

127
 Amazon Chime SDK API Reference
CreateUser

CreateUser
Service: Amazon Chime

Creates a user under the specified Amazon Chime account.

Request Syntax
POST /accounts/accountId/users?operation=create HTTP/1.1
Content-type: application/json

{
"Email": "string",
"Username": "string",
"UserType": "string"
}

URI Request Parameters

The request uses the following URI parameters.

accountId (p. 128)

The Amazon Chime account ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

Email (p. 128)

The user's email address.

Type: String

Pattern: .+@.+\..+

Required: No
Username (p. 128)

The user name.

Type: String

Required: No
UserType (p. 128)

The user type.

Type: String

Valid Values: PrivateUser | SharedDevice

128
 Amazon Chime SDK API Reference
CreateUser

Required: No

Response Syntax
HTTP/1.1 201
Content-type: application/json

{
"User": {
"AccountId": "string",
"AlexaForBusinessMetadata": {
"AlexaForBusinessRoomArn": "string",
"IsAlexaForBusinessEnabled": boolean
},
"DisplayName": "string",
"InvitedOn": number,
"LicenseType": "string",
"PersonalPIN": "string",
"PrimaryEmail": "string",
"PrimaryProvisionedNumber": "string",
"RegisteredOn": number,
"UserId": "string",
"UserInvitationStatus": "string",
"UserRegistrationStatus": "string",
"UserType": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

User (p. 129)

The user on the Amazon Chime account.

Type: User (p. 1211) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

129
 Amazon Chime SDK API Reference
CreateUser

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example creates a shared device profile for the specified email address.

Sample Request

POST /accounts/12a3456b-7c89-012d-3456-78901e23fg45/users?operation=create HTTP/1.1

Host: service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.17.3
Python/3.8.0 Windows/10 botocore/1.14.3 X-Amz-Date: 20200115T223809Z AUTHPARAMS {"Email":
"[email protected]", "UserType": "SharedDevice"}

Sample Response

HTTP/1.1 201 Created x-amzn-RequestId: 4225c49a-307a-413b-

bc8f-37bb145c1483 Content-Type: application/json Content-Length: 664
Date: Wed, 15 Jan 2020 22:38:09 GMT Connection: keep-alive {"User":
{"AccountId":"12a3456b-7c89-012d-3456-78901e23fg45","AlexaForBusinessMetadata":
{"AlexaForBusinessRoomArn":null,"IsAlexaForBusinessEnabled":false},"Delegates":null,"Devices":null,"Dis
device","EmailAlias":[],"FullName":"Room

130
 Amazon Chime SDK API Reference
CreateUser

Device","InvitedOn":null,"IsProTrial":false,"LastActiveOn":null,"LicenseType":"Pro","PersonalPIN":null
f23g-45h678901j2k","UserInvitationStatus":null,"UserLocale":null,"UserRegistrationStatus":"Registered",

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

131
 Amazon Chime SDK API Reference
CreateVoiceConnector

CreateVoiceConnector
Service: Amazon Chime

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.

Enabling CreateVoiceConnector:RequireEncryption (p. 132) 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.

Request Syntax
POST /voice-connectors HTTP/1.1
Content-type: application/json

{
"AwsRegion": "string",
"Name": "string",
"RequireEncryption": boolean
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

AwsRegion (p. 132)

The AWS Region in which the Amazon Chime Voice Connector is created. Default value: us-east-1 .

Type: String

Valid Values: us-east-1 | us-west-2

Required: No
Name (p. 132)

The name of the Amazon Chime Voice Connector.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes
RequireEncryption (p. 132)

When enabled, requires encryption for the Amazon Chime Voice Connector.

Type: Boolean

Required: Yes

Response Syntax
HTTP/1.1 201

132
 Amazon Chime SDK API Reference
CreateVoiceConnector

Content-type: application/json

{
"VoiceConnector": {
"AwsRegion": "string",
"CreatedTimestamp": number,
"Name": "string",
"OutboundHostName": "string",
"RequireEncryption": boolean,
"UpdatedTimestamp": number,
"VoiceConnectorArn": "string",
"VoiceConnectorId": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

VoiceConnector (p. 132)

The Amazon Chime Voice Connector details.

Type: VoiceConnector (p. 1217) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

AccessDeniedException

You don't have permissions to perform the requested operation.

HTTP Status Code: 403

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

133
 Amazon Chime SDK API Reference
CreateVoiceConnector

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example creates an Amazon Chime Voice Connector.

Sample Request

POST /voice-connectors HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding:

identity User-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160
X-Amz-Date: 20190918T203400Z Authorization: AUTHPARAMS Content-Length: 82 {"Name":
"newVoiceConnector", "AwsRegion": "us-west-2", "RequireEncryption": true}

Sample Response

HTTP/1.1 201 Created x-amzn-RequestId: 3f08f447-316c-45a8-b3ad-12dec6231828

Content-Type: application/json Content-Length: 301 Date: Wed, 18 Sep 2019
20:34:01 GMT Connection: keep-alive {"Voice Connector":{"AwsRegion":"us-
west-2","CreatedTimestamp":"2019-09-18T20:34:01.352Z","Name":"newVoiceConnector","OutboundHostName":"ab

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

134
Amazon Chime SDK API Reference
CreateVoiceConnector

135
 Amazon Chime SDK API Reference
CreateVoiceConnectorGroup

CreateVoiceConnectorGroup
Service: Amazon Chime

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
VoiceConnectorItems in the request.

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.

Request Syntax
POST /voice-connector-groups HTTP/1.1
Content-type: application/json

{
"Name": "string",
"VoiceConnectorItems": [
{
"Priority": number,
"VoiceConnectorId": "string"
}
]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

Name (p. 136)

The name of the Amazon Chime Voice Connector group.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes
VoiceConnectorItems (p. 136)

The Amazon Chime Voice Connectors to route inbound calls to.

Type: Array of VoiceConnectorItem (p. 1221) objects

Required: No

Response Syntax
HTTP/1.1 201
Content-type: application/json

136
 Amazon Chime SDK API Reference
CreateVoiceConnectorGroup

"VoiceConnectorGroup": {
"CreatedTimestamp": number,
"Name": "string",
"UpdatedTimestamp": number,
"VoiceConnectorGroupArn": "string",
"VoiceConnectorGroupId": "string",
"VoiceConnectorItems": [
{
"Priority": number,
"VoiceConnectorId": "string"
}
]
}
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

VoiceConnectorGroup (p. 136)

The Amazon Chime Voice Connector group details.

Type: VoiceConnectorGroup (p. 1219) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

AccessDeniedException

You don't have permissions to perform the requested operation.

HTTP Status Code: 403

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

137
 Amazon Chime SDK API Reference
CreateVoiceConnectorGroup

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example creates an Amazon Chime Voice Connector group.

Sample Request

POST /voice-connector-groups HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding:

identity User-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-
Date: 20190918T163834Z Authorization: AUTHPARAMS Content-Length: 107 {"Name": "myGroup",
"VoiceConnectorItems": [{"VoiceConnectorId": "abcdef1ghij2klmno3pqr4", "Priority": 2}]}

Sample Response

HTTP/1.1 201 Created x-amzn-RequestId: bb6c861a-bfb6-42d2-9655-898780f6e7f8

Content-Type: application/json Content-Length: 222 Date: Wed, 18
Sep 2019 16:38:33 GMT Connection: keep-alive {"VoiceConnectorGroup":
{"CreatedTimestamp":"2019-09-18T16:38:34.734Z","Name":"myGroup","UpdatedTimestamp":"2019-09-18T16:38:34
c7d8-90e1-fg23-4h567jkl8901","VoiceConnectorItems":[]}}

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python

138
 Amazon Chime SDK API Reference
CreateVoiceConnectorGroup

• AWS SDK for Ruby V3

139
 Amazon Chime SDK API Reference
DeleteAccount

DeleteAccount
Service: Amazon Chime

Deletes the specified Amazon Chime account. You must suspend all users before deleting Team account.
You can use the BatchSuspendUser (p. 41) action to dodo.

For EnterpriseLWA and EnterpriseAD 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.

Deleted accounts appear in your Disabled accounts list for 90 days. To restore deleted account from
your Disabled accounts list, you must contact AWS Support.

After 90 days, deleted accounts are permanently removed from your Disabled accounts list.

Request Syntax
DELETE /accounts/accountId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

accountId (p. 140)

The Amazon Chime account ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

140
 Amazon Chime SDK API Reference
DeleteAccount

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

UnprocessableEntityException

The request was well-formed but was unable to be followed due to semantic errors.

HTTP Status Code: 422

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example deletes the specified account.

Sample Request

DELETE /console/accounts/12a3456b-7c89-012d-3456-78901e23fg45 HTTP/1.1 Host:

service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.83
Python/3.6.6 Windows/10 botocore/1.12.73 X-Amz-Date: 20190108T180112Z Authorization:
AUTHPARAMS Content-Length: 0

141
 Amazon Chime SDK API Reference
DeleteAccount

Sample Response

HTTP/1.1 204 No Content x-amzn-RequestId: ac41c46f-e26f-4cc1-a9cf-c6056e743647 Content-

Type: application/json Date: Tue, 08 Jan 2019 18:01:13 GMT Connection: keep-alive

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

142
 Amazon Chime SDK API Reference
DeleteAppInstance

DeleteAppInstance
Service: Amazon Chime

Deletes an AppInstance and all associated data asynchronously.

Request Syntax
DELETE /app-instances/appInstanceArn HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

appInstanceArn (p. 143)

The ARN of the AppInstance.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

143
 Amazon Chime SDK API Reference
DeleteAppInstance

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

144
 Amazon Chime SDK API Reference
DeleteAppInstanceAdmin

DeleteAppInstanceAdmin
Service: Amazon Chime

Demotes an AppInstanceAdmin to an AppInstanceUser. This action does not delete the user.

Request Syntax
DELETE /app-instances/appInstanceArn/admins/appInstanceAdminArn HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

appInstanceAdminArn (p. 145)

The ARN of the AppInstance's administrator.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
appInstanceArn (p. 145)

The ARN of the AppInstance.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

145
 Amazon Chime SDK API Reference
DeleteAppInstanceAdmin

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

146
 Amazon Chime SDK API Reference
DeleteAppInstanceStreamingConfigurations

DeleteAppInstanceStreamingConfigurations
Service: Amazon Chime

Deletes the streaming configurations of an AppInstance.

Request Syntax
DELETE /app-instances/appInstanceArn/streaming-configurations HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

appInstanceArn (p. 147)

The ARN of the streaming configurations being deleted.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

147
 Amazon Chime SDK API Reference
DeleteAppInstanceStreamingConfigurations

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

148
 Amazon Chime SDK API Reference
DeleteAppInstanceUser

DeleteAppInstanceUser
Service: Amazon Chime

Deletes an AppInstanceUser.

Request Syntax
DELETE /app-instance-users/appInstanceUserArn HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

appInstanceUserArn (p. 149)

The ARN of the user request being deleted.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

149
 Amazon Chime SDK API Reference
DeleteAppInstanceUser

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

150
 Amazon Chime SDK API Reference
DeleteAttendee

DeleteAttendee
Service: Amazon Chime

Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their JoinToken.
Attendees are automatically deleted when a Amazon Chime SDK meeting is deleted. For more
information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK
Developer Guide.

Request Syntax
DELETE /meetings/meetingId/attendees/attendeeId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

attendeeId (p. 151)

The Amazon Chime SDK attendee ID.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: Yes
meetingId (p. 151)

The Amazon Chime SDK meeting ID.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

151
 Amazon Chime SDK API Reference
DeleteAttendee

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

152
 Amazon Chime SDK API Reference
DeleteChannel

DeleteChannel
Service: Amazon Chime

Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an
irreversible process.
Note
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.

Request Syntax
DELETE /channels/channelArn HTTP/1.1
x-amz-chime-bearer: ChimeBearer

URI Request Parameters

The request uses the following URI parameters.

channelArn (p. 153)

The ARN of the channel being deleted.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 153)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

153
 Amazon Chime SDK API Reference
DeleteChannel

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

154
 Amazon Chime SDK API Reference
DeleteChannelBan

DeleteChannelBan
Service: Amazon Chime

Removes a user from a channel's ban list.

Note
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.

Request Syntax
DELETE /channels/channelArn/bans/memberArn HTTP/1.1
x-amz-chime-bearer: ChimeBearer

URI Request Parameters

The request uses the following URI parameters.

channelArn (p. 155)

The ARN of the channel from which the AppInstanceUser was banned.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 155)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}
memberArn (p. 155)

The ARN of the AppInstanceUser that you want to reinstate.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

155
 Amazon Chime SDK API Reference
DeleteChannelBan

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

156
 Amazon Chime SDK API Reference
DeleteChannelMembership

DeleteChannelMembership
Service: Amazon Chime

Removes a member from a channel.

Note
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.

Request Syntax
DELETE /channels/channelArn/memberships/memberArn HTTP/1.1
x-amz-chime-bearer: ChimeBearer

URI Request Parameters

The request uses the following URI parameters.

channelArn (p. 157)

The ARN of the channel from which you want to remove the user.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 157)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}
memberArn (p. 157)

The ARN of the member that you're removing from the channel.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

157
 Amazon Chime SDK API Reference
DeleteChannelMembership

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3

158
 Amazon Chime SDK API Reference
DeleteChannelMembership

• AWS SDK for Python

• AWS SDK for Ruby V3

159
 Amazon Chime SDK API Reference
DeleteChannelMessage

DeleteChannelMessage
Service: Amazon Chime

Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible
immediately. A background process deletes any revisions created by UpdateChannelMessage.
Note
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.

Request Syntax
DELETE /channels/channelArn/messages/messageId HTTP/1.1
x-amz-chime-bearer: ChimeBearer

URI Request Parameters

The request uses the following URI parameters.

channelArn (p. 160)

The ARN of the channel.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 160)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}
messageId (p. 160)

The ID of the message being deleted.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [-_a-zA-Z0-9]*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

160
 Amazon Chime SDK API Reference
DeleteChannelMessage

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

161
 Amazon Chime SDK API Reference
DeleteChannelModerator

DeleteChannelModerator
Service: Amazon Chime

Deletes a channel moderator.

Note
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.

Request Syntax
DELETE /channels/channelArn/moderators/channelModeratorArn HTTP/1.1
x-amz-chime-bearer: ChimeBearer

URI Request Parameters

The request uses the following URI parameters.

channelArn (p. 162)

The ARN of the channel.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
channelModeratorArn (p. 162)

The ARN of the moderator being deleted.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 162)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

162
 Amazon Chime SDK API Reference
DeleteChannelModerator

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

163
 Amazon Chime SDK API Reference
DeleteEventsConfiguration

DeleteEventsConfiguration
Service: Amazon Chime

Deletes the events configuration that allows a bot to receive outgoing events.

Request Syntax
DELETE /accounts/accountId/bots/botId/events-configuration HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

accountId (p. 164)

The Amazon Chime account ID.

Pattern: .*\S.*

Required: Yes
botId (p. 164)

The bot ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

164
 Amazon Chime SDK API Reference
DeleteEventsConfiguration

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

165
 Amazon Chime SDK API Reference
DeleteMediaCapturePipeline

DeleteMediaCapturePipeline
Service: Amazon Chime

Deletes the media capture pipeline.

Request Syntax
DELETE /media-capture-pipelines/mediaPipelineId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

mediaPipelineId (p. 166)

The ID of the media capture pipeline being deleted.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

166
 Amazon Chime SDK API Reference
DeleteMediaCapturePipeline

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

167
 Amazon Chime SDK API Reference
DeleteMeeting

DeleteMeeting
Service: Amazon Chime

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 Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.

Request Syntax
DELETE /meetings/meetingId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

meetingId (p. 168)

The Amazon Chime SDK meeting ID.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

168
 Amazon Chime SDK API Reference
DeleteMeeting

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

169
 Amazon Chime SDK API Reference
DeletePhoneNumber

DeletePhoneNumber
Service: Amazon Chime

Moves the specified phone number into the Deletion queue. A phone number must be disassociated
from any users or Amazon Chime Voice Connectors before it can be deleted.

Deleted phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.

Request Syntax
DELETE /phone-numbers/phoneNumberId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

phoneNumberId (p. 170)

The phone number ID.

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

170
 Amazon Chime SDK API Reference
DeletePhoneNumber

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents ( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example moves the specified phone number into the Deletion queue.

Sample Request

DELETE /phone-numbers/%2B12065550100 HTTP/1.1 Host: service.chime.aws.amazon.com Accept-

Encoding: identity User-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160
X-Amz-Date: 20190918T182415Z Authorization: AUTHPARAMS Content-Length: 0

Sample Response

HTTP/1.1 204 No Content x-amzn-RequestId: 9b914fc0-4d11-4194-81be-17601c896259 Content-

Type: application/json Date: Wed, 18 Sep 2019 18:24:16 GMT Connection: keep-alive

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go

171
 Amazon Chime SDK API Reference
DeletePhoneNumber

• AWS SDK for Java V2

• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

172
 Amazon Chime SDK API Reference
DeleteProxySession

DeleteProxySession
Service: Amazon Chime

Deletes the specified proxy session from the specified Amazon Chime Voice Connector.

Request Syntax
DELETE /voice-connectors/voiceConnectorId/proxy-sessions/proxySessionId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

proxySessionId (p. 173)

The proxy session ID.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: .*\S.*

Required: Yes
voiceConnectorId (p. 173)

The Amazon Chime voice connector ID.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

173
 Amazon Chime SDK API Reference
DeleteProxySession

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example deletes a proxy session from your Amazon Chime Voice Connector.

Sample Request

DELETE /voice-connectors/abcdef1ghij2klmno3pqr4/proxy-sessions/123a4bc5-67d8-901e-2f3g-
h4ghjk56789l HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding: identity
User-Agent: aws-cli/1.18.39 Python/3.8.0 Windows/10 botocore/1.15.39 X-Amz-Date:
20200415T161710Z Authorization: AUTHPARAMS Content-Length: 0

Sample Response

HTTP/1.1 204 No Content x-amzn-RequestId: 05a30cbd-828d-4913-8c26-0d1d3252a406 Content-

Type: application/json Date: Wed, 15 Apr 2020 16:17:10 GMT Connection: keep-alive

174
 Amazon Chime SDK API Reference
DeleteProxySession

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

175
 Amazon Chime SDK API Reference
DeleteRoom

DeleteRoom
Service: Amazon Chime

Deletes a chat room in an Amazon Chime Enterprise account.

Request Syntax
DELETE /accounts/accountId/rooms/roomId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

accountId (p. 176)

The Amazon Chime account ID.

Pattern: .*\S.*

Required: Yes
roomId (p. 176)

The chat room ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

176
 Amazon Chime SDK API Reference
DeleteRoom

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example deletes the specified chat room and removes the chat room memberships.

Sample Request

DELETE /accounts/12a3456b-7c89-012d-3456-78901e23fg45/rooms/
abcd1e2d-3e45-6789-01f2-3g45h67i890j HTTP/1.1 Host: service.chime.aws.amazon.com Accept-
Encoding: identity User-Agent: aws-cli/1.16.293 Python/3.8.0 Windows/10 botocore/1.13.29 X-
Amz-Date: 20191202T225016Z Authorization: AUTHPARAMS Content-Length: 0

Sample Response

HTTP/1.1 204 No Content x-amzn-RequestId: bb7b039d-e94d-4390-803a-da3ef32c85c5 Content-

Type: application/json Date: Mon, 02 Dec 2019 22:50:16 GMT Connection: keep-alive

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

177
 Amazon Chime SDK API Reference
DeleteRoom

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

178
 Amazon Chime SDK API Reference
DeleteRoomMembership

DeleteRoomMembership
Service: Amazon Chime

Removes a member from a chat room in an Amazon Chime Enterprise account.

Request Syntax
DELETE /accounts/accountId/rooms/roomId/memberships/memberId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

accountId (p. 179)

The Amazon Chime account ID.

Pattern: .*\S.*

Required: Yes
memberId (p. 179)

The member ID (user ID or bot ID).

Pattern: .*\S.*

Required: Yes
roomId (p. 179)

The room ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

179
 Amazon Chime SDK API Reference
DeleteRoomMembership

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example removes the specified member from the specified chat room.

Sample Request

DELETE /accounts/12a3456b-7c89-012d-3456-78901e23fg45/rooms/
abcd1e2d-3e45-6789-01f2-3g45h67i890j/memberships/1ab2345c-67de-8901-f23g-45h678901j2k
HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding: identity User-Agent:
aws-cli/1.16.293 Python/3.8.0 Windows/10 botocore/1.13.29 X-Amz-Date: 20191202T224215Z
Authorization: AUTHPARAMS Content-Length: 0

Sample Response

HTTP/1.1 204 No Content x-amzn-RequestId: ef9a1046-4fe3-4014-b27b-eef82fb23878 Content-

Type: application/json Date: Mon, 02 Dec 2019 22:42:15 GMT Connection: keep-alive

180
 Amazon Chime SDK API Reference
DeleteRoomMembership

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

181
 Amazon Chime SDK API Reference
DeleteSipMediaApplication

DeleteSipMediaApplication
Service: Amazon Chime

Deletes a SIP media application.

Request Syntax
DELETE /sip-media-applications/sipMediaApplicationId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

sipMediaApplicationId (p. 182)

The SIP media application ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

182
 Amazon Chime SDK API Reference
DeleteSipMediaApplication

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

183
 Amazon Chime SDK API Reference
DeleteSipRule

DeleteSipRule
Service: Amazon Chime

Deletes a SIP rule. You must disable a SIP rule before you can delete it.

Request Syntax
DELETE /sip-rules/sipRuleId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

sipRuleId (p. 184)

The SIP rule ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

184
 Amazon Chime SDK API Reference
DeleteSipRule

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

185
 Amazon Chime SDK API Reference
DeleteVoiceConnector

DeleteVoiceConnector
Service: Amazon Chime

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.

Request Syntax
DELETE /voice-connectors/voiceConnectorId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId (p. 186)

The Amazon Chime Voice Connector ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

186
 Amazon Chime SDK API Reference
DeleteVoiceConnector

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example deletes the specified Amazon Chime Voice Connector.

Sample Request

DELETE /voice-connectors/abcdef1ghij2klmno3pqr4 HTTP/1.1 Host: service.chime.aws.amazon.com

Accept-Encoding: identity User-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10
botocore/1.12.160 X-Amz-Date: 20190918T204258Z Authorization: AUTHPARAMS Content-Length: 0

Sample Response

HTTP/1.1 204 No Content x-amzn-RequestId: eae708a7-2bd5-4248-8c56-12eea3b042cc Content-

Type: application/json Date: Wed, 18 Sep 2019 20:42:59 GMT Connection: keep-alive

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

187
 Amazon Chime SDK API Reference
DeleteVoiceConnector

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

188
 Amazon Chime SDK API Reference
DeleteVoiceConnectorEmergencyCallingConfiguration

DeleteVoiceConnectorEmergencyCallingConfiguration
Service: Amazon Chime

Deletes the emergency calling configuration details from the specified Amazon Chime Voice Connector.

Request Syntax
DELETE /voice-connectors/voiceConnectorId/emergency-calling-configuration HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId (p. 189)

The Amazon Chime Voice Connector ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

189
 Amazon Chime SDK API Reference
DeleteVoiceConnectorEmergencyCallingConfiguration

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

190
 Amazon Chime SDK API Reference
DeleteVoiceConnectorGroup

DeleteVoiceConnectorGroup
Service: Amazon Chime

Deletes the specified Amazon Chime Voice Connector group. Any VoiceConnectorItems and phone
numbers associated with the group must be removed before it can be deleted.

Request Syntax
DELETE /voice-connector-groups/voiceConnectorGroupId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorGroupId (p. 191)

The Amazon Chime Voice Connector group ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

191
 Amazon Chime SDK API Reference
DeleteVoiceConnectorGroup

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example deletes the specified Amazon Chime Voice Connector group.

Sample Request

DELETE /voice-connector-groups/123a456b-c7d8-90e1-fg23-4h567jkl8901 HTTP/1.1 Host:

service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.170
Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-Date: 20191029T182127Z Authorization:
AUTHPARAMS Content-Length: 0

Sample Response

HTTP/1.1 204 No Content x-amzn-RequestId: eb11efad-b9e3-4353-a839-33e100177e94 Content-

Type: application/json Date: Tue, 29 Oct 2019 18:21:27 GMT Connection: keep-alive

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

192
 Amazon Chime SDK API Reference
DeleteVoiceConnectorGroup

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

193
 Amazon Chime SDK API Reference
DeleteVoiceConnectorOrigination

DeleteVoiceConnectorOrigination
Service: Amazon Chime

Deletes the origination settings for the specified Amazon Chime Voice Connector.
Note
If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted
prior to deleting the origination settings.

Request Syntax
DELETE /voice-connectors/voiceConnectorId/origination HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId (p. 194)

The Amazon Chime Voice Connector ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

194
 Amazon Chime SDK API Reference
DeleteVoiceConnectorOrigination

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example deletes the origination settings for the specified Amazon Chime Voice Connector.

Sample Request

DELETE /voice-connectors/abcdef1ghij2klmno3pqr4/origination HTTP/1.1 Host:

service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.170
Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-Date: 20190823T183010Z Authorization:
AUTHPARAMS Content-Length: 0

Sample Response

HTTP/1.1 204 No Content x-amzn-RequestId: 40326e8d-f4e9-454f-9858-032be0b50b49 Content-

Type: application/json Date: Fri, 23 Aug 2019 18:30:10 GMT Connection: keep-alive

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

195
 Amazon Chime SDK API Reference
DeleteVoiceConnectorOrigination

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

196
 Amazon Chime SDK API Reference
DeleteVoiceConnectorProxy

DeleteVoiceConnectorProxy
Service: Amazon Chime

Deletes the proxy configuration from the specified Amazon Chime Voice Connector.

Request Syntax
DELETE /voice-connectors/voiceConnectorId/programmable-numbers/proxy HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId (p. 197)

The Amazon Chime Voice Connector ID.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

197
 Amazon Chime SDK API Reference
DeleteVoiceConnectorProxy

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example deletes a proxy configuration from your Amazon Chime Voice Connector.

Sample Request

DELETE /voice-connectors/abcdef1ghij2klmno3pqr4/programmable-numbers/proxy HTTP/1.1

Host: service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.18.39
Python/3.8.0 Windows/10 botocore/1.15.39 X-Amz-Date: 20200415T161917Z Authorization:
AUTHPARAMS Content-Length: 0

Sample Response

HTTP/1.1 204 No Content x-amzn-RequestId: 8c961245-2db3-4e6e-9e54-8b97f517585d Content-

Type: application/json Date: Wed, 15 Apr 2020 16:19:17 GMT Connection: keep-alive

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++

198
 Amazon Chime SDK API Reference
DeleteVoiceConnectorProxy

• AWS SDK for Go

• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

199
 Amazon Chime SDK API Reference
DeleteVoiceConnectorStreamingConfiguration

DeleteVoiceConnectorStreamingConfiguration
Service: Amazon Chime

Deletes the streaming configuration for the specified Amazon Chime Voice Connector.

Request Syntax
DELETE /voice-connectors/voiceConnectorId/streaming-configuration HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId (p. 200)

The Amazon Chime Voice Connector ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

200
 Amazon Chime SDK API Reference
DeleteVoiceConnectorStreamingConfiguration

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example deletes the streaming configuration for the specified Amazon Chime Voice Connector.

Sample Request

DELETE /voice-connectors/abcdef1ghij2klmno3pqr4/streaming-configuration HTTP/1.1 Host:

service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.170
Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-Date: 20190918T163300Z Authorization:
AUTHPARAMS Content-Length: 0

Sample Response

HTTP/1.1 204 No Content x-amzn-RequestId: 5402d7e9-534e-4db7-9011-56d71ae221be Content-

Type: application/json Date: Wed, 18 Sep 2019 16:33:00 GMT Connection: keep-alive

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++

201
 Amazon Chime SDK API Reference
DeleteVoiceConnectorStreamingConfiguration

• AWS SDK for Go

• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

202
 Amazon Chime SDK API Reference
DeleteVoiceConnectorTermination

DeleteVoiceConnectorTermination
Service: Amazon Chime

Deletes the termination settings for the specified Amazon Chime Voice Connector.
Note
If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted
prior to deleting the termination settings.

Request Syntax
DELETE /voice-connectors/voiceConnectorId/termination HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId (p. 203)

The Amazon Chime Voice Connector ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

203
 Amazon Chime SDK API Reference
DeleteVoiceConnectorTermination

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example deletes the termination settings for the specified Amazon Chime Voice Connector.

Sample Request

DELETE /voice-connectors/abcdef1ghij2klmno3pqr4/termination HTTP/1.1 Host:

service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.170
Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-Date: 20190823T183531Z Authorization:
AUTHPARAMS Content-Length: 0

Sample Response

HTTP/1.1 204 No Content x-amzn-RequestId: 651ab557-2123-42d9-89ad-ba4cd951dbce Content-

Type: application/json Date: Fri, 23 Aug 2019 18:35:31 GMT Connection: keep-alive

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

204
 Amazon Chime SDK API Reference
DeleteVoiceConnectorTermination

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

205
 Amazon Chime SDK API Reference
DeleteVoiceConnectorTerminationCredentials

DeleteVoiceConnectorTerminationCredentials
Service: Amazon Chime

Deletes the specified SIP credentials used by your equipment to authenticate during call termination.

Request Syntax
POST /voice-connectors/voiceConnectorId/termination/credentials?operation=delete HTTP/1.1
Content-type: application/json

{
"Usernames": [ "string" ]
}

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId (p. 206)

The Amazon Chime Voice Connector ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

Usernames (p. 206)

The RFC2617 compliant username associated with the SIP credentials, in US-ASCII format.

Type: Array of strings

Required: Yes

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

206
 Amazon Chime SDK API Reference
DeleteVoiceConnectorTerminationCredentials

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example deletes the specified SIP credentials.

Sample Request

POST /voice-connectors/abcdef1ghij2klmno3pqr4/termination/credentials?operation=delete
HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-
cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-Date: 20190823T184644Z
Authorization: AUTHPARAMS Content-Length: 27 {"Usernames": ["jdoe"]}

Sample Response

HTTP/1.1 204 No Content x-amzn-RequestId: a5b5b585-3bd1-44fe-9adc-e15b8a0ec39a Content-

Type: application/json Date: Fri, 23 Aug 2019 18:46:44 GMT Connection: keep-alive

207
 Amazon Chime SDK API Reference
DeleteVoiceConnectorTerminationCredentials

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

208
 Amazon Chime SDK API Reference
DescribeAppInstance

DescribeAppInstance
Service: Amazon Chime

Returns the full details of an AppInstance.

Request Syntax
GET /app-instances/appInstanceArn HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

appInstanceArn (p. 209)

The ARN of the AppInstance.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"AppInstance": {
"AppInstanceArn": "string",
"CreatedTimestamp": number,
"LastUpdatedTimestamp": number,
"Metadata": "string",
"Name": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AppInstance (p. 209)

The ARN, metadata, created and last-updated timestamps, and the name of the AppInstance. All
timestamps use epoch milliseconds.

Type: AppInstance (p. 1097) object

209
 Amazon Chime SDK API Reference
DescribeAppInstance

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

210
 Amazon Chime SDK API Reference
DescribeAppInstanceAdmin

DescribeAppInstanceAdmin
Service: Amazon Chime

Returns the full details of an AppInstanceAdmin.

Request Syntax
GET /app-instances/appInstanceArn/admins/appInstanceAdminArn HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

appInstanceAdminArn (p. 211)

The ARN of the AppInstanceAdmin.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
appInstanceArn (p. 211)

The ARN of the AppInstance.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"AppInstanceAdmin": {
"Admin": {
"Arn": "string",
"Name": "string"
},
"AppInstanceArn": "string",
"CreatedTimestamp": number
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

211
 Amazon Chime SDK API Reference
DescribeAppInstanceAdmin

The following data is returned in JSON format by the service.

AppInstanceAdmin (p. 211)

The ARN and name of the AppInstanceUser, the ARN of the AppInstance, and the created and
last-updated timestamps. All timestamps use epoch milliseconds.

Type: AppInstanceAdmin (p. 1099) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3

212
 Amazon Chime SDK API Reference
DescribeAppInstanceAdmin

• AWS SDK for Python

• AWS SDK for Ruby V3

213
 Amazon Chime SDK API Reference
DescribeAppInstanceUser

DescribeAppInstanceUser
Service: Amazon Chime

Returns the full details of an AppInstanceUser.

Request Syntax
GET /app-instance-users/appInstanceUserArn HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

appInstanceUserArn (p. 214)

The ARN of the AppInstanceUser.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"AppInstanceUser": {
"AppInstanceUserArn": "string",
"CreatedTimestamp": number,
"LastUpdatedTimestamp": number,
"Metadata": "string",
"Name": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AppInstanceUser (p. 214)

The name of the AppInstanceUser.

Type: AppInstanceUser (p. 1104) object

214
 Amazon Chime SDK API Reference
DescribeAppInstanceUser

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

215
 Amazon Chime SDK API Reference
DescribeChannel

DescribeChannel
Service: Amazon Chime

Returns the full details of a channel in an Amazon Chime AppInstance.

Note
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.

Request Syntax
GET /channels/channelArn HTTP/1.1
x-amz-chime-bearer: ChimeBearer

URI Request Parameters

The request uses the following URI parameters.

channelArn (p. 216)

The ARN of the channel.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 216)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"Channel": {
"ChannelArn": "string",
"CreatedBy": {
"Arn": "string",
"Name": "string"
},
"CreatedTimestamp": number,
"LastMessageTimestamp": number,
"LastUpdatedTimestamp": number,
"Metadata": "string",

216
 Amazon Chime SDK API Reference
DescribeChannel

"Mode": "string",
"Name": "string",
"Privacy": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Channel (p. 216)

The channel details.

Type: Channel (p. 1118) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

217
 Amazon Chime SDK API Reference
DescribeChannel

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

218
 Amazon Chime SDK API Reference
DescribeChannelBan

DescribeChannelBan
Service: Amazon Chime

Returns the full details of a channel ban.

Note
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.

Request Syntax
GET /channels/channelArn/bans/memberArn HTTP/1.1
x-amz-chime-bearer: ChimeBearer

URI Request Parameters

The request uses the following URI parameters.

channelArn (p. 219)

The ARN of the channel from which the user is banned.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 219)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}
memberArn (p. 219)

The ARN of the member being banned.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

219
 Amazon Chime SDK API Reference
DescribeChannelBan

{
"ChannelBan": {
"ChannelArn": "string",
"CreatedBy": {
"Arn": "string",
"Name": "string"
},
"CreatedTimestamp": number,
"Member": {
"Arn": "string",
"Name": "string"
}
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ChannelBan (p. 219)

The details of the ban.

Type: ChannelBan (p. 1120) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

220
 Amazon Chime SDK API Reference
DescribeChannelBan

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

221
 Amazon Chime SDK API Reference
DescribeChannelMembership

DescribeChannelMembership
Service: Amazon Chime

Returns the full details of a user's channel membership.

Note
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.

Request Syntax
GET /channels/channelArn/memberships/memberArn HTTP/1.1
x-amz-chime-bearer: ChimeBearer

URI Request Parameters

The request uses the following URI parameters.

channelArn (p. 222)

The ARN of the channel.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 222)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}
memberArn (p. 222)

The ARN of the member.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

222
 Amazon Chime SDK API Reference
DescribeChannelMembership

{
"ChannelMembership": {
"ChannelArn": "string",
"CreatedTimestamp": number,
"InvitedBy": {
"Arn": "string",
"Name": "string"
},
"LastUpdatedTimestamp": number,
"Member": {
"Arn": "string",
"Name": "string"
},
"Type": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ChannelMembership (p. 222)

The details of the membership.

Type: ChannelMembership (p. 1122) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

223
 Amazon Chime SDK API Reference
DescribeChannelMembership

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

224
 Amazon Chime SDK API Reference
DescribeChannelMembershipForAppInstanceUser

DescribeChannelMembershipForAppInstanceUser
Service: Amazon Chime

Returns the details of a channel based on the membership of the specified AppInstanceUser.
Note
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.

Request Syntax
GET /channels/{channelArn}?scope=app-instance-user-membership&app-instance-user-
arn=AppInstanceUserArn HTTP/1.1
x-amz-chime-bearer: ChimeBearer

URI Request Parameters

The request uses the following URI parameters.

AppInstanceUserArn (p. 225)

The ARN of the user in a channel.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
channelArn (p. 225)

The ARN of the channel to which the user belongs.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 225)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

225
 Amazon Chime SDK API Reference
DescribeChannelMembershipForAppInstanceUser

{
"ChannelMembership": {
"AppInstanceUserMembershipSummary": {
"ReadMarkerTimestamp": number,
"Type": "string"
},
"ChannelSummary": {
"ChannelArn": "string",
"LastMessageTimestamp": number,
"Metadata": "string",
"Mode": "string",
"Name": "string",
"Privacy": "string"
}
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ChannelMembership (p. 225)

The channel to which a user belongs.

Type: ChannelMembershipForAppInstanceUserSummary (p. 1124) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

226
 Amazon Chime SDK API Reference
DescribeChannelMembershipForAppInstanceUser

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

227
 Amazon Chime SDK API Reference
DescribeChannelModeratedByAppInstanceUser

DescribeChannelModeratedByAppInstanceUser
Service: Amazon Chime

Returns the full details of a channel moderated by the specified AppInstanceUser.

Note
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.

Request Syntax
GET /channels/{channelArn}?scope=app-instance-user-moderated-channel&app-instance-user-
arn=AppInstanceUserArn HTTP/1.1
x-amz-chime-bearer: ChimeBearer

URI Request Parameters

The request uses the following URI parameters.

AppInstanceUserArn (p. 228)

The ARN of the AppInstanceUser in the moderated channel.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
channelArn (p. 228)

The ARN of the moderated channel.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 228)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200

228
 Amazon Chime SDK API Reference
DescribeChannelModeratedByAppInstanceUser

Content-type: application/json

{
"Channel": {
"ChannelSummary": {
"ChannelArn": "string",
"LastMessageTimestamp": number,
"Metadata": "string",
"Mode": "string",
"Name": "string",
"Privacy": "string"
}
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Channel (p. 228)

The moderated channel.

Type: ChannelModeratedByAppInstanceUserSummary (p. 1130) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

229
 Amazon Chime SDK API Reference
DescribeChannelModeratedByAppInstanceUser

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

230
 Amazon Chime SDK API Reference
DescribeChannelModerator

DescribeChannelModerator
Service: Amazon Chime

Returns the full details of a single ChannelModerator.

Note
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.

Request Syntax
GET /channels/channelArn/moderators/channelModeratorArn HTTP/1.1
x-amz-chime-bearer: ChimeBearer

URI Request Parameters

The request uses the following URI parameters.

channelArn (p. 231)

The ARN of the channel.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
channelModeratorArn (p. 231)

The ARN of the channel moderator.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 231)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

231
 Amazon Chime SDK API Reference
DescribeChannelModerator

{
"ChannelModerator": {
"ChannelArn": "string",
"CreatedBy": {
"Arn": "string",
"Name": "string"
},
"CreatedTimestamp": number,
"Moderator": {
"Arn": "string",
"Name": "string"
}
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ChannelModerator (p. 231)

The details of the channel moderator.

Type: ChannelModerator (p. 1131) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

232
 Amazon Chime SDK API Reference
DescribeChannelModerator

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

233
 Amazon Chime SDK API Reference
DisassociatePhoneNumberFromUser

DisassociatePhoneNumberFromUser
Service: Amazon Chime

Disassociates the primary provisioned phone number from the specified Amazon Chime user.

Request Syntax
POST /accounts/accountId/users/{userId}?operation=disassociate-phone-number HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

accountId (p. 234)

The Amazon Chime account ID.

Required: Yes
userId (p. 234)

The user ID.

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200

Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

234
 Amazon Chime SDK API Reference
DisassociatePhoneNumberFromUser

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example disassociates the primary provisioned phone number from the specified Amazon Chime
user.

Sample Request

POST /accounts/12a3456b-7c89-012d-3456-78901e23fg45/users/1ab2345c-67de-8901-
f23g-45h678901j2k?operation=disassociate-phone-number HTTP/1.1 Host:
service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.170
Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-Date: 20190918T181957Z Authorization:
AUTHPARAMS Content-Length: 0

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 91c771a6-5816-4a6a-95aa-2c3ba9d36862 Content-Type:

application/json Content-Length: 2 Date: Wed, 18 Sep 2019 18:19:57 GMT Connection: keep-
alive {}

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

235
 Amazon Chime SDK API Reference
DisassociatePhoneNumberFromUser

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

236
 Amazon Chime SDK API Reference
DisassociatePhoneNumbersFromVoiceConnector

DisassociatePhoneNumbersFromVoiceConnector
Service: Amazon Chime

Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector.

Request Syntax
POST /voice-connectors/{voiceConnectorId}?operation=disassociate-phone-numbers HTTP/1.1
Content-type: application/json

{
"E164PhoneNumbers": [ "string" ]
}

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId (p. 237)

The Amazon Chime Voice Connector ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

E164PhoneNumbers (p. 237)

List of phone numbers, in E.164 format.

Type: Array of strings

Pattern: ^\+?[1-9]\d{1,14}$

Required: Yes

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"PhoneNumberErrors": [
{
"ErrorCode": "string",
"ErrorMessage": "string",
"PhoneNumberId": "string"
}
]
}

237
 Amazon Chime SDK API Reference
DisassociatePhoneNumbersFromVoiceConnector

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

PhoneNumberErrors (p. 237)

If the action fails for one or more of the phone numbers in the request, a list of the phone numbers
is returned, along with error codes and error messages.

Type: Array of PhoneNumberError (p. 1177) objects

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

238
 Amazon Chime SDK API Reference
DisassociatePhoneNumbersFromVoiceConnector

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example disassociates the specified phone numbers from the specified Amazon Chime Voice
Connector.

Sample Request

POST /voice-connectors/abcdef1ghij2klmno3pqr4?operation=disassociate-phone-numbers HTTP/1.1

Host: service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.170
Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-Date: 20190918T193932Z Authorization:
AUTHPARAMS Content-Length: 38 {"E164PhoneNumbers": ["+12065550100"]}

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: aad4c082-8338-47e0-959a-f41fd9f2719f Content-Type:

application/json Content-Length: 24 Date: Wed, 18 Sep 2019 19:39:33 GMT Connection: keep-
alive {"PhoneNumberErrors":[]}

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

239
 Amazon Chime SDK API Reference
DisassociatePhoneNumbersFromVoiceConnectorGroup

DisassociatePhoneNumbersFromVoiceConnectorGroup
Service: Amazon Chime

Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector group.

Request Syntax
POST /voice-connector-groups/{voiceConnectorGroupId}?operation=disassociate-phone-numbers
HTTP/1.1
Content-type: application/json

{
"E164PhoneNumbers": [ "string" ]
}

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorGroupId (p. 240)

The Amazon Chime Voice Connector group ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

E164PhoneNumbers (p. 240)

List of phone numbers, in E.164 format.

Type: Array of strings

Pattern: ^\+?[1-9]\d{1,14}$

Required: Yes

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"PhoneNumberErrors": [
{
"ErrorCode": "string",
"ErrorMessage": "string",
"PhoneNumberId": "string"
}
]
}

240
 Amazon Chime SDK API Reference
DisassociatePhoneNumbersFromVoiceConnectorGroup

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

PhoneNumberErrors (p. 240)

If the action fails for one or more of the phone numbers in the request, a list of the phone numbers
is returned, along with error codes and error messages.

Type: Array of PhoneNumberError (p. 1177) objects

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

241
 Amazon Chime SDK API Reference
DisassociatePhoneNumbersFromVoiceConnectorGroup

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example disassociates the specified phone numbers from the specified Amazon Chime Voice
Connector group.

Sample Request

POST /voice-connector-groups/123a456b-c7d8-90e1-fg23-4h567jkl8901?operation=disassociate-
phone-numbers HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding: identity
User-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-Date:
20191028T190806Z Authorization: AUTHPARAMS Content-Length: 54 {"E164PhoneNumbers":
["+12065550100", "+12065550101"]}

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 30399d07-5e83-4235-8972-b113b491dd68 Content-Type:

application/json Content-Length: 24 Date: Mon, 28 Oct 2019 19:08:06 GMT Connection: keep-
alive {"PhoneNumberErrors":[]}

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

242
 Amazon Chime SDK API Reference
DisassociateSigninDelegateGroupsFromAccount

DisassociateSigninDelegateGroupsFromAccount
Service: Amazon Chime

Disassociates the specified sign-in delegate groups from the specified Amazon Chime account.

Request Syntax
POST /accounts/{accountId}?operation=disassociate-signin-delegate-groups HTTP/1.1
Content-type: application/json

{
"GroupNames": [ "string" ]
}

URI Request Parameters

The request uses the following URI parameters.

accountId (p. 243)

The Amazon Chime account ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

GroupNames (p. 243)

The sign-in delegate group names.

Type: Array of strings

Array Members: Minimum number of 1 item.

Required: Yes

Response Syntax
HTTP/1.1 200

Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

243
 Amazon Chime SDK API Reference
DisassociateSigninDelegateGroupsFromAccount

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example disassociates the specified sign-in delegate group from the specified Amazon Chime
account.

Sample Request

POST /accounts/12a3456b-7c89-012d-3456-78901e23fg45?operation=disassociate-signin-delegate-
groups HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding: identity User-Agent:
aws-cli/1.17.0 Python/3.8.0 Windows/10 botocore/1.14.0 X-Amz-Date: 20200113T173832Z
AUTHPARAMS

244
 Amazon Chime SDK API Reference
DisassociateSigninDelegateGroupsFromAccount

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 53abc648-2d5a-4e21-b077-39099183a769 Content-Type:

application/json Content-Length: 2 Date: Mon, 13 Jan 2020 17:38:32 GMT Connection: keep-
alive {}

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

245
 Amazon Chime SDK API Reference
GetAccount

GetAccount
Service: Amazon Chime

Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.

Request Syntax
GET /accounts/accountId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

accountId (p. 246)

The Amazon Chime account ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"Account": {
"AccountId": "string",
"AccountStatus": "string",
"AccountType": "string",
"AwsAccountId": "string",
"CreatedTimestamp": number,
"DefaultLicense": "string",
"Name": "string",
"SigninDelegateGroups": [
{
"GroupName": "string"
}
],
"SupportedLicenses": [ "string" ]
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Account (p. 246)

The Amazon Chime account details.

246
 Amazon Chime SDK API Reference
GetAccount

Type: Account (p. 1091) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example retrieves details for the specified Amazon Chime account.

247
 Amazon Chime SDK API Reference
GetAccount

Sample Request

GET /console/accounts/12a3456b-7c89-012d-3456-78901e23fg45 HTTP/1.1 Host:

service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.83
Python/3.6.6 Windows/10 botocore/1.12.73 X-Amz-Date: 20190108T180420Z Authorization:
AUTHPARAMS

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: bd51dac3-b142-405c-ab02-c9d0373ca476

Content-Type: application/json Content-Length: 544 Date: Tue, 08 Jan
2019 18:04:20 GMT Connection: keep-alive {"Account": {"AccountId":
"12a3456b-7c89-012d-3456-78901e23fg45","AccountStatus": "Active","AccountType":
"EnterpriseDirectory","Admins": null,"AwsAccountId": "111122223333","BillingType":
"SeatBilling","CreatedTimestamp": "2018-12-20T18:38:02.181Z","DefaultLicense":
"Pro","DelegationStatus": "NoDelegation","DirectoryId": "d-906717dc08","Domains":
null,"Groups": [{"GroupId": "basic_users","License": "Basic"}, {"GroupId":
"pro_users","License": "Pro"}],"Name": "EnterpriseDirectory","Owner":
null,"SupportedLicenses": ["Basic", "Pro"],"UseProTrialLicense": false} }

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

248
 Amazon Chime SDK API Reference
GetAccountSettings

GetAccountSettings
Service: Amazon Chime

Retrieves account settings for the specified Amazon Chime account ID, such as remote control and
dialout settings. For more information about these settings, see Use the Policies Page in the Amazon
Chime Administration Guide.

Request Syntax
GET /accounts/accountId/settings HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

accountId (p. 249)

The Amazon Chime account ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"AccountSettings": {
"DisableRemoteControl": boolean,
"EnableDialOut": boolean
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AccountSettings (p. 249)

The Amazon Chime account settings.

Type: AccountSettings (p. 1093) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

249
 Amazon Chime SDK API Reference
GetAccountSettings

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example retrieves account settings for the specified account.

Sample Request

GET /console/accounts/12a3456b-7c89-012d-3456-78901e23fg45/settings HTTP/1.1 Host:

service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.83
Python/3.6.6 Windows/10 botocore/1.12.73 X-Amz-Date: 20190108T180532Z Authorization:
AUTHPARAMS

250
 Amazon Chime SDK API Reference
GetAccountSettings

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 109d8cac-ab8b-4bf2-9254-c078ba2d9534 Content-Type:

application/json Content-Length: 117 Date: Tue, 08 Jan 2019 18:05:33 GMT Connection: keep-
alive {"AccountSettings": {"DisableRemoteControl": false,"EnableDialOut": false} }

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

251
 Amazon Chime SDK API Reference
GetAppInstanceRetentionSettings

GetAppInstanceRetentionSettings
Service: Amazon Chime

Gets the retention settings for an AppInstance.

Request Syntax
GET /app-instances/appInstanceArn/retention-settings HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

appInstanceArn (p. 252)

The ARN of the AppInstance.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"AppInstanceRetentionSettings": {
"ChannelRetentionSettings": {
"RetentionDays": number
}
},
"InitiateDeletionTimestamp": number
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AppInstanceRetentionSettings (p. 252)

The retention settings for the AppInstance.

Type: AppInstanceRetentionSettings (p. 1101) object

InitiateDeletionTimestamp (p. 252)

The timestamp representing the time at which the specified items are retained, in Epoch Seconds.

252
 Amazon Chime SDK API Reference
GetAppInstanceRetentionSettings

Type: Timestamp

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python

253
 Amazon Chime SDK API Reference
GetAppInstanceRetentionSettings

• AWS SDK for Ruby V3

254
 Amazon Chime SDK API Reference
GetAppInstanceStreamingConfigurations

GetAppInstanceStreamingConfigurations
Service: Amazon Chime

Gets the streaming settings for an AppInstance.

Request Syntax
GET /app-instances/appInstanceArn/streaming-configurations HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

appInstanceArn (p. 255)

The ARN of the AppInstance.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"AppInstanceStreamingConfigurations": [
{
"AppInstanceDataType": "string",
"ResourceArn": "string"
}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AppInstanceStreamingConfigurations (p. 255)

The streaming settings.

Type: Array of AppInstanceStreamingConfiguration (p. 1102) objects

Array Members: Minimum number of 1 item. Maximum number of 2 items.

255
 Amazon Chime SDK API Reference
GetAppInstanceStreamingConfigurations

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

256
 Amazon Chime SDK API Reference
GetAttendee

GetAttendee
Service: Amazon Chime

Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID. For more
information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK
Developer Guide .

Request Syntax
GET /meetings/meetingId/attendees/attendeeId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

attendeeId (p. 257)

The Amazon Chime SDK attendee ID.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: Yes
meetingId (p. 257)

The Amazon Chime SDK meeting ID.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"Attendee": {
"AttendeeId": "string",
"ExternalUserId": "string",
"JoinToken": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Attendee (p. 257)

The Amazon Chime SDK attendee information.

257
 Amazon Chime SDK API Reference
GetAttendee

Type: Attendee (p. 1109) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python

258
 Amazon Chime SDK API Reference
GetAttendee

• AWS SDK for Ruby V3

259
 Amazon Chime SDK API Reference
GetBot

GetBot
Service: Amazon Chime

Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.

Request Syntax
GET /accounts/accountId/bots/botId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

accountId (p. 260)

The Amazon Chime account ID.

Pattern: .*\S.*

Required: Yes
botId (p. 260)

The bot ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"Bot": {
"BotEmail": "string",
"BotId": "string",
"BotType": "string",
"CreatedTimestamp": number,
"Disabled": boolean,
"DisplayName": "string",
"SecurityToken": "string",
"UpdatedTimestamp": number,
"UserId": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

260
 Amazon Chime SDK API Reference
GetBot

Bot (p. 260)

The chat bot details.

Type: Bot (p. 1113) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

261
 Amazon Chime SDK API Reference
GetBot

Example
This example retrieves details for the specified bot.

Sample Request

GET /accounts/12a3456b-7c89-012d-3456-78901e23fg45/
bots/123abcd4-5ef6-789g-0h12-34j56789012k HTTP/1.1 Host: service.chime.aws.amazon.com
Accept-Encoding: identity User-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10
botocore/1.12.160 X-Amz-Date: 20190918T172527Z Authorization: AUTHPARAMS

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 4231cfc1-ddd0-42a3-bb25-02aef731f367

Content-Type: application/json Content-Length: 374 Date: Wed, 18 Sep
2019 17:25:27 GMT Connection: keep-alive {"Bot":{"BotEmail":"myBot-
[email protected]","BotId":"123abcd4-5ef6-789g-0h12-34j56789012k","BotType":"ChatBot","CreatedTimest
(Bot)","SecurityToken":"wJalrXUtnFEMI/K7MDENG/
bPxRfiCYEXAMPLEKEY","UpdatedTimestamp":"2019-09-18T17:24:39.534Z","UserId":"123abcd4-5ef6-789g-0h12-34j

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

262
 Amazon Chime SDK API Reference
GetChannelMessage

GetChannelMessage
Service: Amazon Chime

Gets the full details of a channel message.

Note
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.

Request Syntax
GET /channels/channelArn/messages/messageId HTTP/1.1
x-amz-chime-bearer: ChimeBearer

URI Request Parameters

The request uses the following URI parameters.

channelArn (p. 263)

The ARN of the channel.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 263)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}
messageId (p. 263)

The ID of the message.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [-_a-zA-Z0-9]*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

263
 Amazon Chime SDK API Reference
GetChannelMessage

"ChannelMessage": {
"ChannelArn": "string",
"Content": "string",
"CreatedTimestamp": number,
"LastEditedTimestamp": number,
"LastUpdatedTimestamp": number,
"MessageId": "string",
"Metadata": "string",
"Persistence": "string",
"Redacted": boolean,
"Sender": {
"Arn": "string",
"Name": "string"
},
"Type": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ChannelMessage (p. 263)

The details of and content in the message.

Type: ChannelMessage (p. 1126) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

264
 Amazon Chime SDK API Reference
GetChannelMessage

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

265
 Amazon Chime SDK API Reference
GetEventsConfiguration

GetEventsConfiguration
Service: Amazon Chime

Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS
endpoint or Lambda function ARN.

Request Syntax
GET /accounts/accountId/bots/botId/events-configuration HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

accountId (p. 266)

The Amazon Chime account ID.

Pattern: .*\S.*

Required: Yes
botId (p. 266)

The bot ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"EventsConfiguration": {
"BotId": "string",
"LambdaFunctionArn": "string",
"OutboundEventsHTTPSEndpoint": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

EventsConfiguration (p. 266)

The events configuration details.

266
 Amazon Chime SDK API Reference
GetEventsConfiguration

Type: EventsConfiguration (p. 1149) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python

267
 Amazon Chime SDK API Reference
GetEventsConfiguration

• AWS SDK for Ruby V3

268
 Amazon Chime SDK API Reference
GetGlobalSettings

GetGlobalSettings
Service: Amazon Chime

Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling
and Amazon Chime Voice Connector settings.

Request Syntax
GET /settings HTTP/1.1

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"BusinessCalling": {
"CdrBucket": "string"
},
"VoiceConnector": {
"CdrBucket": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

BusinessCalling (p. 269)

The Amazon Chime Business Calling settings.

Type: BusinessCallingSettings (p. 1115) object

VoiceConnector (p. 269)

The Amazon Chime Voice Connector settings.

Type: VoiceConnectorSettings (p. 1222) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

269
 Amazon Chime SDK API Reference
GetGlobalSettings

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example retrieves the global settings for the administrator's AWS account.

Sample Request

GET /settings HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding: identity

User-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-Date:
20190918T194823Z Authorization: AUTHPARAMS

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: e92df7ba-fdb6-4125-91cd-b5991558366b Content-

Type: application/json Content-Length: 104 Date: Wed, 18 Sep 2019 19:48:24 GMT
Connection: keep-alive {"BusinessCalling":{"CdrBucket":"s3bucket"},"Voice Connector":
{"CdrBucket":"s3bucket"}}

270
 Amazon Chime SDK API Reference
GetGlobalSettings

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

271
 Amazon Chime SDK API Reference
GetMediaCapturePipeline

GetMediaCapturePipeline
Service: Amazon Chime

Gets an existing media capture pipeline.

Request Syntax
GET /media-capture-pipelines/mediaPipelineId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

mediaPipelineId (p. 272)

The ID of the pipeline that you want to get.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"MediaCapturePipeline": {
"ChimeSdkMeetingConfiguration": {
"ArtifactsConfiguration": {
"Audio": {
"MuxType": "string"
},
"Content": {
"MuxType": "string",
"State": "string"
},
"Video": {
"MuxType": "string",
"State": "string"
}
},
"SourceConfiguration": {
"SelectedVideoStreams": {
"AttendeeIds": [ "string" ],
"ExternalUserIds": [ "string" ]
}
}
},
"CreatedTimestamp": number,
"MediaPipelineId": "string",
"SinkArn": "string",
"SinkType": "string",
"SourceArn": "string",

272
 Amazon Chime SDK API Reference
GetMediaCapturePipeline

"SourceType": "string",
"Status": "string",
"UpdatedTimestamp": number
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

MediaCapturePipeline (p. 272)

The media capture pipeline object.

Type: MediaCapturePipeline (p. 1154) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

273
 Amazon Chime SDK API Reference
GetMediaCapturePipeline

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

274
 Amazon Chime SDK API Reference
GetMeeting

GetMeeting
Service: Amazon Chime

Gets the Amazon Chime SDK meeting details for the specified meeting ID. For more information about
the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide .

Request Syntax
GET /meetings/meetingId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

meetingId (p. 275)

The Amazon Chime SDK meeting ID.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"Meeting": {
"ExternalMeetingId": "string",
"MediaPlacement": {
"AudioFallbackUrl": "string",
"AudioHostUrl": "string",
"EventIngestionUrl": "string",
"ScreenDataUrl": "string",
"ScreenSharingUrl": "string",
"ScreenViewingUrl": "string",
"SignalingUrl": "string",
"TurnControlUrl": "string"
},
"MediaRegion": "string",
"MeetingId": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

275
 Amazon Chime SDK API Reference
GetMeeting

Meeting (p. 275)

The Amazon Chime SDK meeting information.

Type: Meeting (p. 1158) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2

276
 Amazon Chime SDK API Reference
GetMeeting

• AWS SDK for JavaScript

• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

277
 Amazon Chime SDK API Reference
GetMessagingSessionEndpoint

GetMessagingSessionEndpoint
Service: Amazon Chime

The details of the endpoint for the messaging session.

Request Syntax
GET /endpoints/messaging-session HTTP/1.1

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"Endpoint": {
"Url": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Endpoint (p. 278)

The endpoint returned in the response.

Type: MessagingSessionEndpoint (p. 1164) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

278
 Amazon Chime SDK API Reference
GetMessagingSessionEndpoint

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

279
 Amazon Chime SDK API Reference
GetPhoneNumber

GetPhoneNumber
Service: Amazon Chime

Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.

Request Syntax
GET /phone-numbers/phoneNumberId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

phoneNumberId (p. 280)

The phone number ID.

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"PhoneNumber": {
"Associations": [
{
"AssociatedTimestamp": number,
"Name": "string",
"Value": "string"
}
],
"CallingName": "string",
"CallingNameStatus": "string",
"Capabilities": {
"InboundCall": boolean,
"InboundMMS": boolean,
"InboundSMS": boolean,
"OutboundCall": boolean,
"OutboundMMS": boolean,
"OutboundSMS": boolean
},
"Country": "string",
"CreatedTimestamp": number,
"DeletionTimestamp": number,
"E164PhoneNumber": "string",
"PhoneNumberId": "string",
"ProductType": "string",
"Status": "string",
"Type": "string",
"UpdatedTimestamp": number
}
}

280
 Amazon Chime SDK API Reference
GetPhoneNumber

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

PhoneNumber (p. 280)

The phone number details.

Type: PhoneNumber (p. 1170) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

281
 Amazon Chime SDK API Reference
GetPhoneNumber

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example retrieves details for the specified phone number ID.

Sample Request

GET /phone-numbers/%2B12065550100 HTTP/1.1 Host: service.chime.aws.amazon.com Accept-

Encoding: identity User-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160
X-Amz-Date: 20191028T184310Z Authorization: AUTHPARAMS

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 4105c588-140d-4904-a0ed-80be2157ebcf

Content-Type: application/json Content-Length: 581 Date: Mon, 28 Oct
2019 18:43:10 GMT Connection: keep-alive {"PhoneNumber":{"Associations":
[{"AssociatedTimestamp":"2019-10-28T18:40:37.453Z","Name":"VoiceConnectorId","Value":"abcdef1ghij2klmno
{"InboundCall":true,"InboundMMS":true,"InboundSMS":true,"OutboundCall":true,"OutboundMMS":true,"Outboun
Connector","Status":"Assigned","Type":"Local","UpdatedTimestamp":"2019-10-28T18:42:07.964Z"}}

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

282
 Amazon Chime SDK API Reference
GetPhoneNumberOrder

GetPhoneNumberOrder
Service: Amazon Chime

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.

Request Syntax
GET /phone-number-orders/phoneNumberOrderId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

phoneNumberOrderId (p. 283)

The ID for the phone number order.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"PhoneNumberOrder": {
"CreatedTimestamp": number,
"OrderedPhoneNumbers": [
{
"E164PhoneNumber": "string",
"Status": "string"
}
],
"PhoneNumberOrderId": "string",
"ProductType": "string",
"Status": "string",
"UpdatedTimestamp": number
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

PhoneNumberOrder (p. 283)

The phone number order details.

283
 Amazon Chime SDK API Reference
GetPhoneNumberOrder

Type: PhoneNumberOrder (p. 1178) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example retrieves details for the specified phone number order.

284
 Amazon Chime SDK API Reference
GetPhoneNumberOrder

Sample Request

GET /phone-number-orders/abc12345-de67-89f0-123g-h45i678j9012 HTTP/1.1 Host:

service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.170
Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-Date: 20190918T175948Z Authorization:
AUTHPARAMS

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 2cac62a6-cdda-43fe-9053-d11f85cbc7e9

Content-Type: application/json Content-Length: 362 Date: Wed, 18
Sep 2019 17:59:49 GMT Connection: keep-alive {"PhoneNumberOrder":
{"CreatedTimestamp":"2019-09-18T17:57:36.280Z","OrderedPhoneNumbers":
[{"E164PhoneNumber":"+12065550100","Status":"Acquired"},
{"E164PhoneNumber":"+12065550101","Status":"Acquired"}],"PhoneNumberOrderId":"abc12345-
de67-89f0-123g-
h45i678j9012","ProductType":"BusinessCalling","Status":"Successful","UpdatedTimestamp":"2019-09-18T17:5

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

285
 Amazon Chime SDK API Reference
GetPhoneNumberSettings

GetPhoneNumberSettings
Service: Amazon Chime

Retrieves the phone number settings for the administrator's AWS account, such as the default outbound
calling name.

Request Syntax
GET /settings/phone-number HTTP/1.1

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"CallingName": "string",
"CallingNameUpdatedTimestamp": number
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

CallingName (p. 286)

The default outbound calling name for the account.

Type: String

Pattern: ^$|^[a-zA-Z0-9 ]{2,15}$

CallingNameUpdatedTimestamp (p. 286)

The updated outbound calling name timestamp, in ISO 8601 format.

Type: Timestamp

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

286
 Amazon Chime SDK API Reference
GetPhoneNumberSettings

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example retrieves the phone number settings for the administrator's AWS account.

Sample Request

GET /settings/phone-number HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding:

identity User-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-
Date: 20191028T185743Z Authorization: AUTHPARAMS

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 34cb347e-cc3f-440c-a78f-b7e128207e75 Content-Type:

application/json Content-Length: 81 Date: Mon, 28 Oct 2019 18:57:43 GMT Connection: keep-
alive {"CallingName":"myName","CallingNameUpdatedTimestamp":"2019-10-28T18:56:42.911Z"}

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

287
 Amazon Chime SDK API Reference
GetPhoneNumberSettings

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

288
 Amazon Chime SDK API Reference
GetProxySession

GetProxySession
Service: Amazon Chime

Gets the specified proxy session details for the specified Amazon Chime Voice Connector.

Request Syntax
GET /voice-connectors/voiceConnectorId/proxy-sessions/proxySessionId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

proxySessionId (p. 289)

The proxy session ID.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: .*\S.*

Required: Yes
voiceConnectorId (p. 289)

The Amazon Chime voice connector ID.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"ProxySession": {
"Capabilities": [ "string" ],
"CreatedTimestamp": number,
"EndedTimestamp": number,
"ExpiryMinutes": number,
"GeoMatchLevel": "string",
"GeoMatchParams": {
"AreaCode": "string",
"Country": "string"
},
"Name": "string",
"NumberSelectionBehavior": "string",
"Participants": [
{
"PhoneNumber": "string",

289
 Amazon Chime SDK API Reference
GetProxySession

"ProxyPhoneNumber": "string"
}
],
"ProxySessionId": "string",
"Status": "string",
"UpdatedTimestamp": number,
"VoiceConnectorId": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ProxySession (p. 289)

The proxy session details.

Type: ProxySession (p. 1181) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

290
 Amazon Chime SDK API Reference
GetProxySession

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example gets the details of a proxy session.

Sample Request

GET /voice-connectors/abcdef1ghij2klmno3pqr4/proxy-sessions/123a4bc5-67d8-901e-2f3g-
h4ghjk56789l HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding: identity
User-Agent: aws-cli/1.18.39 Python/3.8.0 Windows/10 botocore/1.15.39 X-Amz-Date:
20200415T161150Z Authorization: AUTHPARAMS

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: ef91ce84-33bb-4bc1-b5bf-fd414bb19621

Content-Type: application/json Content-Length: 531 Date: Wed, 15 Apr
2020 16:11:50 GMT Connection: keep-alive {"ProxySession":{"Capabilities":
["SMS","Voice"],"CreatedTimestamp":"2020-04-15T16:10:10.288Z","EndedTimestamp":null,"ExpiryMinutes":60,
[{"PhoneNumber":"+12065550100","ProxyPhoneNumber":"+19135550199"},
{"PhoneNumber":"+14015550101","ProxyPhoneNumber":"+19135550199"}],"ProxySessionId":"123a4bc5-67d8-901e-
h4ghjk56789l","Status":"Open","UpdatedTimestamp":"2020-04-15T16:10:10.288Z","VoiceConnectorId":"abcdef1

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

291
 Amazon Chime SDK API Reference
GetRetentionSettings

GetRetentionSettings
Service: Amazon Chime

Gets the retention settings for the specified Amazon Chime Enterprise account. For more information
about retention settings, see Managing Chat Retention Policies in the Amazon Chime Administration
Guide.

Request Syntax
GET /accounts/accountId/retention-settings HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

accountId (p. 292)

The Amazon Chime account ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"InitiateDeletionTimestamp": number,
"RetentionSettings": {
"ConversationRetentionSettings": {
"RetentionDays": number
},
"RoomRetentionSettings": {
"RetentionDays": number
}
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

InitiateDeletionTimestamp (p. 292)

The timestamp representing the time at which the specified items are permanently deleted, in ISO
8601 format.

Type: Timestamp

292
 Amazon Chime SDK API Reference
GetRetentionSettings

RetentionSettings (p. 292)

The retention settings.

Type: RetentionSettings (p. 1184) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2

293
 Amazon Chime SDK API Reference
GetRetentionSettings

• AWS SDK for JavaScript

• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

294
 Amazon Chime SDK API Reference
GetRoom

GetRoom
Service: Amazon Chime

Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.

Request Syntax
GET /accounts/accountId/rooms/roomId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

accountId (p. 295)

The Amazon Chime account ID.

Pattern: .*\S.*

Required: Yes
roomId (p. 295)

The room ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"Room": {
"AccountId": "string",
"CreatedBy": "string",
"CreatedTimestamp": number,
"Name": "string",
"RoomId": "string",
"UpdatedTimestamp": number
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Room (p. 295)

The room details.

295
 Amazon Chime SDK API Reference
GetRoom

Type: Room (p. 1185) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example gets the details about the specified chat room, including the name.

296
 Amazon Chime SDK API Reference
GetRoom

Sample Request

GET /accounts/12a3456b-7c89-012d-3456-78901e23fg45/rooms/
abcd1e2d-3e45-6789-01f2-3g45h67i890j HTTP/1.1 Host: service.chime.aws.amazon.com Accept-
Encoding: identity User-Agent: aws-cli/1.16.293 Python/3.8.0 Windows/10 botocore/1.13.29 X-
Amz-Date: 20191202T223145Z Authorization: AUTHPARAMS

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 6b2786c6-e616-4e0d-a991-

f635fa827583 Content-Type: application/json Content-Length: 273
Date: Mon, 02 Dec 2019 22:31:45 GMT Connection: keep-alive {"Room":
{"AccountId":"12a3456b-7c89-012d-3456-78901e23fg45","CreatedBy":"arn:aws:iam::111122223333:user/
alejandro","CreatedTimestamp":"2019-12-02T22:29:31.549Z","Name":"chatRoom","RoomId":"abcd1e2d-3e45-6789

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

297
 Amazon Chime SDK API Reference
GetSipMediaApplication

GetSipMediaApplication
Service: Amazon Chime

Retrieves the information for a SIP media application, including name, AWS Region, and endpoints.

Request Syntax
GET /sip-media-applications/sipMediaApplicationId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

sipMediaApplicationId (p. 298)

The SIP media application ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"SipMediaApplication": {
"AwsRegion": "string",
"CreatedTimestamp": number,
"Endpoints": [
{
"LambdaArn": "string"
}
],
"Name": "string",
"SipMediaApplicationId": "string",
"UpdatedTimestamp": number
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

SipMediaApplication (p. 298)

The SIP media application details.

Type: SipMediaApplication (p. 1192) object

298
 Amazon Chime SDK API Reference
GetSipMediaApplication

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

299
 Amazon Chime SDK API Reference
GetSipMediaApplicationLoggingConfiguration

GetSipMediaApplicationLoggingConfiguration
Service: Amazon Chime

Returns the logging configuration for the specified SIP media application.

Request Syntax
GET /sip-media-applications/sipMediaApplicationId/logging-configuration HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

sipMediaApplicationId (p. 300)

The SIP media application ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"SipMediaApplicationLoggingConfiguration": {
"EnableSipMediaApplicationMessageLogs": boolean
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

SipMediaApplicationLoggingConfiguration (p. 300)

The actual logging configuration.

Type: SipMediaApplicationLoggingConfiguration (p. 1196) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

300
 Amazon Chime SDK API Reference
GetSipMediaApplicationLoggingConfiguration

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

301
 Amazon Chime SDK API Reference
GetSipRule

GetSipRule
Service: Amazon Chime

Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.

Request Syntax
GET /sip-rules/sipRuleId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

sipRuleId (p. 302)

The SIP rule ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"SipRule": {
"CreatedTimestamp": number,
"Disabled": boolean,
"Name": "string",
"SipRuleId": "string",
"TargetApplications": [
{
"AwsRegion": "string",
"Priority": number,
"SipMediaApplicationId": "string"
}
],
"TriggerType": "string",
"TriggerValue": "string",
"UpdatedTimestamp": number
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

SipRule (p. 302)

The SIP rule details.

302
 Amazon Chime SDK API Reference
GetSipRule

Type: SipRule (p. 1197) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python

303
 Amazon Chime SDK API Reference
GetSipRule

• AWS SDK for Ruby V3

304
 Amazon Chime SDK API Reference
GetUser

GetUser
Service: Amazon Chime

Retrieves details for the specified user ID, such as primary email address, license type,and personal
meeting PIN.

To retrieve user details with an email address instead of a user ID, use the ListUsers (p. 420) action, and
then filter by email address.

Request Syntax
GET /accounts/accountId/users/userId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

accountId (p. 305)

The Amazon Chime account ID.

Pattern: .*\S.*

Required: Yes
userId (p. 305)

The user ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"User": {
"AccountId": "string",
"AlexaForBusinessMetadata": {
"AlexaForBusinessRoomArn": "string",
"IsAlexaForBusinessEnabled": boolean
},
"DisplayName": "string",
"InvitedOn": number,
"LicenseType": "string",
"PersonalPIN": "string",
"PrimaryEmail": "string",
"PrimaryProvisionedNumber": "string",
"RegisteredOn": number,
"UserId": "string",

305
 Amazon Chime SDK API Reference
GetUser

"UserInvitationStatus": "string",
"UserRegistrationStatus": "string",
"UserType": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

User (p. 305)

The user details.

Type: User (p. 1211) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

306
 Amazon Chime SDK API Reference
GetUser

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example lists details for the specified user.

Sample Request

GET /console/accounts/12a3456b-7c89-012d-3456-78901e23fg45/users/1ab2345c-67de-8901-
f23g-45h678901j2k HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding: identity
User-Agent: aws-cli/1.16.83 Python/3.6.6 Windows/10 botocore/1.12.73 X-Amz-Date:
20190108T180643Z Authorization: AUTHPARAMS

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 6d2ef025-d8a7-42f4-8170-84cb09b70d3d Content-Type:

application/json Content-Length: 562 Date: Tue, 08 Jan 2019 18:06:43 GMT Connection:
keep-alive {"User": {"AccountId": "12a3456b-7c89-012d-3456-78901e23fg45","Delegates":
null,"Devices": null,"DisplayName": "user1 user1","EmailAlias": [],"FullName":
"user1 user1","InvitedOn": null,"IsProTrial": false,"LastActiveOn":
null,"LicenseType": "Pro","PersonalPIN": "XXXXXXXXXX","PresenceVisibility":
"Public","PrimaryEmail": "[email protected]","PrimaryProvisionedNumber":
null,"RegisteredOn": "2018-12-20T18:45:25.231Z","UserId": "1ab2345c-67de-8901-
f23g-45h678901j2k","UserInvitationStatus": null,"UserLocale":
null,"UserRegistrationStatus": "Registered","Vanity": null} }

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

307
 Amazon Chime SDK API Reference
GetUserSettings

GetUserSettings
Service: Amazon Chime

Retrieves settings for the specified user ID, such as any associated phone number settings.

Request Syntax
GET /accounts/accountId/users/userId/settings HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

accountId (p. 308)

The Amazon Chime account ID.

Required: Yes
userId (p. 308)

The user ID.

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"UserSettings": {
"Telephony": {
"InboundCalling": boolean,
"OutboundCalling": boolean,
"SMS": boolean
}
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

UserSettings (p. 308)

The user settings.

Type: UserSettings (p. 1215) object

308
 Amazon Chime SDK API Reference
GetUserSettings

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example retrieves settings for the specified user ID.

Sample Request

GET /accounts/12a3456b-7c89-012d-3456-78901e23fg45/users/1ab2345c-67de-8901-
f23g-45h678901j2k/settings HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding:

309
 Amazon Chime SDK API Reference
GetUserSettings

identity User-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-

Date: 20190918T181628Z Authorization: AUTHPARAMS

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 5ee5b029-f523-4c32-94bd-20c1cfb03815

Content-Type: application/json Content-Length: 91 Date: Wed, 18 Sep
2019 18:16:28 GMT Connection: keep-alive {"UserSettings":{"Telephony":
{"InboundCalling":true,"OutboundCalling":true,"SMS":true}}}

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

310
 Amazon Chime SDK API Reference
GetVoiceConnector

GetVoiceConnector
Service: Amazon Chime

Retrieves details for the specified Amazon Chime Voice Connector, such as timestamps,name, outbound
host, and encryption requirements.

Request Syntax
GET /voice-connectors/voiceConnectorId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId (p. 311)

The Amazon Chime Voice Connector ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"VoiceConnector": {
"AwsRegion": "string",
"CreatedTimestamp": number,
"Name": "string",
"OutboundHostName": "string",
"RequireEncryption": boolean,
"UpdatedTimestamp": number,
"VoiceConnectorArn": "string",
"VoiceConnectorId": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

VoiceConnector (p. 311)

The Amazon Chime Voice Connector details.

Type: VoiceConnector (p. 1217) object

311
 Amazon Chime SDK API Reference
GetVoiceConnector

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example retrieves details for the specified Amazon Chime Voice Connector.

312
 Amazon Chime SDK API Reference
GetVoiceConnector

Sample Request

GET /voice-connectors/abcdef1ghij2klmno3pqr4 HTTP/1.1 Host: service.chime.aws.amazon.com

Accept-Encoding: identity User-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10
botocore/1.12.160 X-Amz-Date: 20190918T203609Z Authorization: AUTHPARAMS

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: dbeaecf5-60e5-4914-a796-d2e2232d13f3

Content-Type: application/json Content-Length: 301 Date: Wed, 18 Sep 2019
20:36:09 GMT Connection: keep-alive {"Voice Connector":{"AwsRegion":"us-
west-2","CreatedTimestamp":"2019-09-18T20:34:01.352Z","Name":"newVoiceConnector","OutboundHostName":"ab

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

313
 Amazon Chime SDK API Reference
GetVoiceConnectorEmergencyCallingConfiguration

GetVoiceConnectorEmergencyCallingConfiguration
Service: Amazon Chime

Gets the emergency calling configuration details for the specified Amazon Chime Voice Connector.

Request Syntax
GET /voice-connectors/voiceConnectorId/emergency-calling-configuration HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId (p. 314)

The Amazon Chime Voice Connector ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"EmergencyCallingConfiguration": {
"DNIS": [
{
"CallingCountry": "string",
"EmergencyPhoneNumber": "string",
"TestPhoneNumber": "string"
}
]
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

EmergencyCallingConfiguration (p. 314)

The emergency calling configuration details.

Type: EmergencyCallingConfiguration (p. 1143) object

314
 Amazon Chime SDK API Reference
GetVoiceConnectorEmergencyCallingConfiguration

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

315
 Amazon Chime SDK API Reference
GetVoiceConnectorGroup

GetVoiceConnectorGroup
Service: Amazon Chime

Retrieves details for the specified Amazon Chime Voice Connector group, such as timestamps,name, and
associated VoiceConnectorItems.

Request Syntax
GET /voice-connector-groups/voiceConnectorGroupId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorGroupId (p. 316)

The Amazon Chime Voice Connector group ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"VoiceConnectorGroup": {
"CreatedTimestamp": number,
"Name": "string",
"UpdatedTimestamp": number,
"VoiceConnectorGroupArn": "string",
"VoiceConnectorGroupId": "string",
"VoiceConnectorItems": [
{
"Priority": number,
"VoiceConnectorId": "string"
}
]
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

VoiceConnectorGroup (p. 316)

The Amazon Chime Voice Connector group details.

316
 Amazon Chime SDK API Reference
GetVoiceConnectorGroup

Type: VoiceConnectorGroup (p. 1219) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example retrieves details for the specified Amazon Chime Voice Connector group.

317
 Amazon Chime SDK API Reference
GetVoiceConnectorGroup

Sample Request

GET /voice-connector-groups/123a456b-c7d8-90e1-fg23-4h567jkl8901 HTTP/1.1 Host:

service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.170
Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-Date: 20190918T164157Z Authorization:
AUTHPARAMS

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 560af47f-2d8d-45c8-9909-615466073d7c

Content-Type: application/json Content-Length: 222 Date: Wed, 18
Sep 2019 16:41:57 GMT Connection: keep-alive {"VoiceConnectorGroup":
{"CreatedTimestamp":"2019-09-18T16:38:34.734Z","Name":"myGroup","UpdatedTimestamp":"2019-09-18T16:38:34
c7d8-90e1-fg23-4h567jkl8901","VoiceConnectorItems":[]}}

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

318
 Amazon Chime SDK API Reference
GetVoiceConnectorLoggingConfiguration

GetVoiceConnectorLoggingConfiguration
Service: Amazon Chime

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.

Request Syntax
GET /voice-connectors/voiceConnectorId/logging-configuration HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId (p. 319)

The Amazon Chime Voice Connector ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"LoggingConfiguration": {
"EnableMediaMetricLogs": boolean,
"EnableSIPLogs": boolean
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

LoggingConfiguration (p. 319)

The logging configuration details.

Type: LoggingConfiguration (p. 1153) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

319
 Amazon Chime SDK API Reference
GetVoiceConnectorLoggingConfiguration

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example retrieves the logging configuration details for the specified Amazon Chime Voice
Connector.

Sample Request

GET /voice-connectors/abcdef1ghij2klmno3pqr4/logging-configuration HTTP/1.1 Host:

service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.170

320
 Amazon Chime SDK API Reference
GetVoiceConnectorLoggingConfiguration

Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-Date: 20191028T190458Z Authorization:

AUTHPARAMS

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 6f51ef1f-1861-4b9d-9b17-aa8dab224ed0 Content-Type:

application/json Content-Length: 47 Date: Mon, 28 Oct 2019 19:04:58 GMT Connection: keep-
alive {"LoggingConfiguration":{"EnableSIPLogs":true}}

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

321
 Amazon Chime SDK API Reference
GetVoiceConnectorOrigination

GetVoiceConnectorOrigination
Service: Amazon Chime

Retrieves origination setting details for the specified Amazon Chime Voice Connector.

Request Syntax
GET /voice-connectors/voiceConnectorId/origination HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId (p. 322)

The Amazon Chime Voice Connector ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"Origination": {
"Disabled": boolean,
"Routes": [
{
"Host": "string",
"Port": number,
"Priority": number,
"Protocol": "string",
"Weight": number
}
]
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Origination (p. 322)

The origination setting details.

Type: Origination (p. 1166) object

322
 Amazon Chime SDK API Reference
GetVoiceConnectorOrigination

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example retrieves origination setting details for the specified Amazon Chime Voice Connector.

Sample Request

GET /voice-connectors/abcdef1ghij2klmno3pqr4/origination HTTP/1.1 Host:

service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.170

323
 Amazon Chime SDK API Reference
GetVoiceConnectorOrigination

Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-Date: 20190823T182831Z Authorization:

AUTHPARAMS

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: bf151a51-1797-4980-8dc0-7cb7b28347e2

Content-Type: application/json Content-Length: 122 Date: Fri, 23 Aug 2019
18:28:31 GMT Connection: keep-alive {"Origination":{"Disabled":false,"Routes":
[{"Host":"10.24.34.0","Port":1234,"Priority":1,"Protocol":"TCP","Weight":5}]}}

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

324
 Amazon Chime SDK API Reference
GetVoiceConnectorProxy

GetVoiceConnectorProxy
Service: Amazon Chime

Gets the proxy configuration details for the specified Amazon Chime Voice Connector.

Request Syntax
GET /voice-connectors/voiceConnectorId/programmable-numbers/proxy HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId (p. 325)

The Amazon Chime voice connector ID.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"Proxy": {
"DefaultSessionExpiryMinutes": number,
"Disabled": boolean,
"FallBackPhoneNumber": "string",
"PhoneNumberCountries": [ "string" ]
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Proxy (p. 325)

The proxy configuration details.

Type: Proxy (p. 1180) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

325
 Amazon Chime SDK API Reference
GetVoiceConnectorProxy

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example gets the proxy configuration details for your Amazon Chime Voice Connector.

Sample Request

GET /voice-connectors/abcdef1ghij2klmno3pqr4/programmable-numbers/proxy HTTP/1.1 Host:

service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.18.39
Python/3.8.0 Windows/10 botocore/1.15.39 X-Amz-Date: 20200415T160617Z Authorization:
AUTHPARAMS

326
 Amazon Chime SDK API Reference
GetVoiceConnectorProxy

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: b88a0151-196f-467b-be69-03d3dc8f8171

Content-Type: application/json Content-Length: 118 Date: Wed,
15 Apr 2020 16:06:17 GMT Connection: keep-alive {"Proxy":
{"DefaultSessionExpiryMinutes":60,"Disabled":false,"FallBackPhoneNumber":null,"PhoneNumberCountries":
["US"]}}

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

327
 Amazon Chime SDK API Reference
GetVoiceConnectorStreamingConfiguration

GetVoiceConnectorStreamingConfiguration
Service: Amazon Chime

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.

Request Syntax
GET /voice-connectors/voiceConnectorId/streaming-configuration HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId (p. 328)

The Amazon Chime Voice Connector ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"StreamingConfiguration": {
"DataRetentionInHours": number,
"Disabled": boolean,
"StreamingNotificationTargets": [
{
"NotificationTarget": "string"
}
]
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

StreamingConfiguration (p. 328)

The streaming configuration details.

Type: StreamingConfiguration (p. 1201) object

328
 Amazon Chime SDK API Reference
GetVoiceConnectorStreamingConfiguration

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example retrieves the streaming configuration details for the specified Amazon Chime Voice
Connector.

329
 Amazon Chime SDK API Reference
GetVoiceConnectorStreamingConfiguration

Sample Request

GET /voice-connectors/abcdef1ghij2klmno3pqr4/streaming-configuration HTTP/1.1 Host:

service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.170
Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-Date: 20190918T162749Z Authorization:
AUTHPARAMS

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 78f8557f-91d7-4083-8b48-80e499d7ecb5 Content-Type:

application/json Content-Length: 71 Date: Wed, 18 Sep 2019 16:27:50 GMT Connection: keep-
alive {"StreamingConfiguration":{"DataRetentionInHours":24,"Disabled":false}}

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

330
 Amazon Chime SDK API Reference
GetVoiceConnectorTermination

GetVoiceConnectorTermination
Service: Amazon Chime

Retrieves termination setting details for the specified Amazon Chime Voice Connector.

Request Syntax
GET /voice-connectors/voiceConnectorId/termination HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId (p. 331)

The Amazon Chime Voice Connector ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"Termination": {
"CallingRegions": [ "string" ],
"CidrAllowedList": [ "string" ],
"CpsLimit": number,
"DefaultPhoneNumber": "string",
"Disabled": boolean
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Termination (p. 331)

The termination setting details.

Type: Termination (p. 1205) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

331
 Amazon Chime SDK API Reference
GetVoiceConnectorTermination

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example retrieves termination setting details for the specified Amazon Chime Voice Connector.

Sample Request

GET /voice-connectors/abcdef1ghij2klmno3pqr4/termination HTTP/1.1 Host:

service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.170
Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-Date: 20190823T183401Z Authorization:
AUTHPARAMS

332
 Amazon Chime SDK API Reference
GetVoiceConnectorTermination

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 6f3ed77c-f44f-45d6-adc3-86337926911d Content-

Type: application/json Content-Length: 145 Date: Fri, 23 Aug 2019 18:34:01 GMT
Connection: keep-alive {"Termination":{"CallingRegions":["US"],"CidrAllowedList":
["10.24.34.0/23"],"CpsLimit":1,"DefaultPhoneNumber":"+12065550100","Disabled":false}}

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

333
 Amazon Chime SDK API Reference
GetVoiceConnectorTerminationHealth

GetVoiceConnectorTerminationHealth
Service: Amazon Chime

Retrieves information about the last time a SIP OPTIONS ping was received from your SIP infrastructure
for the specified Amazon Chime Voice Connector.

Request Syntax
GET /voice-connectors/voiceConnectorId/termination/health HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId (p. 334)

The Amazon Chime Voice Connector ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"TerminationHealth": {
"Source": "string",
"Timestamp": number
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

TerminationHealth (p. 334)

The termination health details.

Type: TerminationHealth (p. 1207) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

334
 Amazon Chime SDK API Reference
GetVoiceConnectorTerminationHealth

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example retrieves termination health for the specified Amazon Chime Voice Connector.

Sample Request

GET /voice-connectors/abcdef1ghij2klmno3pqr4/termination/health HTTP/1.1 Host:

service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.170
Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-Date: 20190918T202903Z Authorization:
AUTHPARAMS

335
 Amazon Chime SDK API Reference
GetVoiceConnectorTerminationHealth

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 85415f15-3e91-4ecd-8ed1-d4f9c5a36e07 Content-Type:

application/json Content-Length: 90 Date: Wed, 18 Sep 2019 20:29:04 GMT Connection: keep-
alive {"TerminationHealth":{"Source":"10.24.34.0","Timestamp":"Wed Sep 18 20:29:00 UTC
2019"}}

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

336
 Amazon Chime SDK API Reference
InviteUsers

InviteUsers
Service: Amazon Chime

Sends email to a maximum of 50 users, inviting them to the specified Amazon Chime Team account. Only
Team account types are currently supported for this action.

Request Syntax
POST /accounts/accountId/users?operation=add HTTP/1.1
Content-type: application/json

{
"UserEmailList": [ "string" ],
"UserType": "string"
}

URI Request Parameters

The request uses the following URI parameters.

accountId (p. 337)

The Amazon Chime account ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

UserEmailList (p. 337)

The user email addresses to which to send the email invitation.

Type: Array of strings

Array Members: Maximum number of 50 items.

Pattern: .+@.+\..+

Required: Yes
UserType (p. 337)

The user type.

Type: String

Valid Values: PrivateUser | SharedDevice

Required: No

Response Syntax
HTTP/1.1 201

337
 Amazon Chime SDK API Reference
InviteUsers

Content-type: application/json

{
"Invites": [
{
"EmailAddress": "string",
"EmailStatus": "string",
"InviteId": "string",
"Status": "string"
}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

Invites (p. 337)

The email invitation details.

Type: Array of Invite (p. 1152) objects

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

338
 Amazon Chime SDK API Reference
InviteUsers

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example sends an email to invite users to the specified account.

Sample Request

POST /console/accounts/12a3456b-7c89-012d-3456-78901e23fg45/users?operation=add
HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding: identity User-Agent:
aws-cli/1.16.83 Python/3.6.6 Windows/10 botocore/1.12.73 X-Amz-Date: 20190108T180827Z
Authorization: AUTHPARAMS Content-Length: 46 {"UserEmailList": ["[email protected]",
"[email protected]"]}

Sample Response

HTTP/1.1 201 Created x-amzn-RequestId: e1b2ea98-2934-400d-a5f1-f68d74658ea6 Content-

Type: application/json Content-Length: 204 Date: Tue, 08 Jan 2019 18:08:27 GMT
Connection: keep-alive {"Invites": [{"EmailAddress": "[email protected]","EmailStatus":
"Sent","InviteId": "a12bc345-6def-78g9-01h2-34jk56789012","Status": "Pending",}
{"EmailAddress": "[email protected]","EmailStatus": "Sent","InviteId":
"b12bc345-6def-78g9-01h2-34jk56789012","Status": "Pending",}] }

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

339
 Amazon Chime SDK API Reference
ListAccounts

ListAccounts
Service: Amazon Chime

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.

Request Syntax
GET /accounts?max-results=MaxResults&name=Name&next-token=NextToken&user-email=UserEmail
HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MaxResults (p. 340)

The maximum number of results to return in a single call. Defaults to 100.

Valid Range: Minimum value of 1. Maximum value of 200.

Name (p. 340)

Amazon Chime account name prefix with which to filter results.

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: .*\S.*
NextToken (p. 340)

The token to use to retrieve the next page of results.

UserEmail (p. 340)

User email address with which to filter results.

Pattern: .+@.+\..+

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"Accounts": [
{
"AccountId": "string",
"AccountStatus": "string",
"AccountType": "string",
"AwsAccountId": "string",
"CreatedTimestamp": number,
"DefaultLicense": "string",

340
 Amazon Chime SDK API Reference
ListAccounts

"Name": "string",
"SigninDelegateGroups": [
{
"GroupName": "string"
}
],
"SupportedLicenses": [ "string" ]
}
],
"NextToken": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Accounts (p. 340)

List of Amazon Chime accounts and account details.

Type: Array of Account (p. 1091) objects

NextToken (p. 340)

The token to use to retrieve the next page of results.

Type: String

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

341
 Amazon Chime SDK API Reference
ListAccounts

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example lists the Amazon Chime accounts under the administrator's AWS account.

Sample Request

GET /console/accounts HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding:

identity User-Agent: aws-cli/1.16.83 Python/3.6.6 Windows/10 botocore/1.12.73 X-Amz-Date:
20190108T175510Z Authorization: AUTHPARAMS

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 304c0ad6-f7cd-4541-a0dd-b82560062979

Content-Type: application/json Content-Length: 2218 Date: Tue, 08 Jan
2019 17:55:10 GMT Connection: keep-alive {"Accounts": [{"AccountId":
"12a3456b-7c89-012d-3456-78901e23fg45","AccountStatus": "Active","AccountType":
"EnterpriseDirectory","Admins": null,"AwsAccountId": "111122223333","BillingType":
"SeatBilling","CreatedTimestamp": "2018-12-20T18:38:02.181Z","DefaultLicense":
"Pro","DelegationStatus": "NoDelegation","DirectoryId": "d-906717dc08","Domains":
null,"Groups": [{"GroupId": "basic_users","License": "Basic"},
{"GroupId": "pro_users","License": "Pro"}],"Name": "Example1","Owner":
null,"SupportedLicenses": ["Basic", "Pro"],"UseProTrialLicense": false}, {"AccountId":
"22a3456b-7c89-012d-3456-78901e23fg45","AccountStatus": "Active","AccountType":
"Team","Admins": null,"AwsAccountId": "111122223333","BillingType":
"SeatBilling","CreatedTimestamp": "2018-12-18T20:47:27.121Z","DefaultLicense":
"Pro","DelegationStatus": "NoDelegation","DirectoryId": null,"Domains":
null,"Groups": [],"Name": "Example2","Owner": null,"SupportedLicenses": ["Basic",
"Pro"],"UseProTrialLicense": false}],"NextToken": null }

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

342
 Amazon Chime SDK API Reference
ListAccounts

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

343
 Amazon Chime SDK API Reference
ListAppInstanceAdmins

ListAppInstanceAdmins
Service: Amazon Chime

Returns a list of the administrators in the AppInstance.

Request Syntax
GET /app-instances/appInstanceArn/admins?max-results=MaxResults&next-token=NextToken
HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

appInstanceArn (p. 344)

The ARN of the AppInstance.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
MaxResults (p. 344)

The maximum number of administrators that you want to return.

Valid Range: Minimum value of 1. Maximum value of 50.

NextToken (p. 344)

The token returned from previous API requests until the number of administrators is reached.

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"AppInstanceAdmins": [
{
"Admin": {
"Arn": "string",
"Name": "string"
}
}
],
"AppInstanceArn": "string",

344
 Amazon Chime SDK API Reference
ListAppInstanceAdmins

"NextToken": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AppInstanceAdmins (p. 344)

The information for each administrator.

Type: Array of AppInstanceAdminSummary (p. 1100) objects

AppInstanceArn (p. 344)

The ARN of the AppInstance.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}
NextToken (p. 344)

The token returned from previous API requests until the number of administrators is reached.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

345
 Amazon Chime SDK API Reference
ListAppInstanceAdmins

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

346
 Amazon Chime SDK API Reference
ListAppInstances

ListAppInstances
Service: Amazon Chime

Lists all Amazon Chime AppInstances created under a single AWS account.

Request Syntax
GET /app-instances?max-results=MaxResults&next-token=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MaxResults (p. 347)

The maximum number of AppInstances that you want to return.

Valid Range: Minimum value of 1. Maximum value of 50.

NextToken (p. 347)

The token passed by previous API requests until you reach the maximum number of AppInstances.

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"AppInstances": [
{
"AppInstanceArn": "string",
"Metadata": "string",
"Name": "string"
}
],
"NextToken": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AppInstances (p. 347)

The information for each AppInstance.

347
 Amazon Chime SDK API Reference
ListAppInstances

Type: Array of AppInstanceSummary (p. 1103) objects

NextToken (p. 347)

The token passed by previous API requests until the maximum number of AppInstances is reached.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2

348
 Amazon Chime SDK API Reference
ListAppInstances

• AWS SDK for JavaScript

• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

349
 Amazon Chime SDK API Reference
ListAppInstanceUsers

ListAppInstanceUsers
Service: Amazon Chime

List all AppInstanceUsers created under a single AppInstance.

Request Syntax
GET /app-instance-users?app-instance-arn=AppInstanceArn&max-results=MaxResults&next-
token=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

AppInstanceArn (p. 350)

The ARN of the AppInstance.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
MaxResults (p. 350)

The maximum number of requests that you want returned.

Valid Range: Minimum value of 1. Maximum value of 50.

NextToken (p. 350)

The token passed by previous API calls until all requested users are returned.

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"AppInstanceArn": "string",
"AppInstanceUsers": [
{
"AppInstanceUserArn": "string",
"Metadata": "string",
"Name": "string"
}
],
"NextToken": "string"

350
 Amazon Chime SDK API Reference
ListAppInstanceUsers

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AppInstanceArn (p. 350)

The ARN of the AppInstance.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}
AppInstanceUsers (p. 350)

The information for each requested AppInstanceUser.

Type: Array of AppInstanceUserSummary (p. 1107) objects

NextToken (p. 350)

The token passed by previous API calls until all requested users are returned.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

351
 Amazon Chime SDK API Reference
ListAppInstanceUsers

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

352
 Amazon Chime SDK API Reference
ListAttendees

ListAttendees
Service: Amazon Chime

Lists the attendees for the specified 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.

Request Syntax
GET /meetings/meetingId/attendees?max-results=MaxResults&next-token=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MaxResults (p. 353)

The maximum number of results to return in a single call.

Valid Range: Minimum value of 1. Maximum value of 99.

meetingId (p. 353)

The Amazon Chime SDK meeting ID.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: Yes
NextToken (p. 353)

The token to use to retrieve the next page of results.

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"Attendees": [
{
"AttendeeId": "string",
"ExternalUserId": "string",
"JoinToken": "string"
}
],
"NextToken": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

353
 Amazon Chime SDK API Reference
ListAttendees

Attendees (p. 353)

The Amazon Chime SDK attendee information.

Type: Array of Attendee (p. 1109) objects

NextToken (p. 353)

The token to use to retrieve the next page of results.

Type: String

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

354
 Amazon Chime SDK API Reference
ListAttendees

• AWS SDK for .NET

• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

355
 Amazon Chime SDK API Reference
ListAttendeeTags

ListAttendeeTags
Service: Amazon Chime

Lists the tags applied to an Amazon Chime SDK attendee resource.

Request Syntax
GET /meetings/meetingId/attendees/attendeeId/tags HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

attendeeId (p. 356)

The Amazon Chime SDK attendee ID.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: Yes
meetingId (p. 356)

The Amazon Chime SDK meeting ID.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Tags (p. 356)

A list of tag key-value pairs.

356
 Amazon Chime SDK API Reference
ListAttendeeTags

Type: Array of Tag (p. 1203) objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3

357
 Amazon Chime SDK API Reference
ListAttendeeTags

• AWS SDK for Python

• AWS SDK for Ruby V3

358
 Amazon Chime SDK API Reference
ListBots

ListBots
Service: Amazon Chime

Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.

Request Syntax
GET /accounts/accountId/bots?max-results=MaxResults&next-token=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

accountId (p. 359)

The Amazon Chime account ID.

Pattern: .*\S.*

Required: Yes
MaxResults (p. 359)

The maximum number of results to return in a single call. The default is 10.

Valid Range: Minimum value of 1. Maximum value of 99.

NextToken (p. 359)

The token to use to retrieve the next page of results.

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"Bots": [
{
"BotEmail": "string",
"BotId": "string",
"BotType": "string",
"CreatedTimestamp": number,
"Disabled": boolean,
"DisplayName": "string",
"SecurityToken": "string",
"UpdatedTimestamp": number,
"UserId": "string"
}
],
"NextToken": "string"
}

359
 Amazon Chime SDK API Reference
ListBots

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Bots (p. 359)

List of bots and bot details.

Type: Array of Bot (p. 1113) objects

NextToken (p. 359)

The token to use to retrieve the next page of results.

Type: String

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

360
 Amazon Chime SDK API Reference
ListBots

Examples
In the following example or examples, the Authorization header contents ( AUTHPARAMS) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example lists the bots associated with the administrator's Amazon Chime Enterprise account ID.

Sample Request

GET /accounts/12a3456b-7c89-012d-3456-78901e23fg45/bots HTTP/1.1 Host:

service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.170
Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-Date: 20190918T172805Z Authorization:
AUTHPARAMS

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: ee577706-63e7-4524-b412-0711eb86e5ae

Content-Type: application/json Content-Length: 774 Date: Wed, 18 Sep
2019 17:28:05 GMT Connection: keep-alive {"Bots":[{"BotEmail":"myBot-
[email protected]","BotId":"123abcd4-5ef6-789g-0h12-34j56789012k","BotType":"ChatBot","CreatedTimest
(Bot)","SecurityToken":"wJalrXUtnFEMI/K7MDENG/
bPxRfiCYEXAMPLEKEY","UpdatedTimestamp":"2019-09-18T17:24:39.534Z","UserId":"123abcd4-5ef6-789g-0h12-34j
{"BotEmail":"ChatBot-
[email protected]","BotId":"321abcd4-5ef6-789g-0h12-34j56789012k","BotType":"ChatBot","CreatedTimest
(Bot)","SecurityToken":"je7MtGbClwBF/2Zp9Utk/
h3yCo8nvbEXAMPLEKEY","UpdatedTimestamp":"2019-09-09T18:24:25.437Z","UserId":"321abcd4-5ef6-789g-0h12-34

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

361
 Amazon Chime SDK API Reference
ListChannelBans

ListChannelBans
Service: Amazon Chime

Lists all the users banned from a particular channel.

Note
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.

Request Syntax
GET /channels/channelArn/bans?max-results=MaxResults&next-token=NextToken HTTP/1.1
x-amz-chime-bearer: ChimeBearer

URI Request Parameters

The request uses the following URI parameters.

channelArn (p. 362)

The ARN of the channel.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 362)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}
MaxResults (p. 362)

The maximum number of bans that you want returned.

Valid Range: Minimum value of 1. Maximum value of 50.

NextToken (p. 362)

The token passed by previous API calls until all requested bans are returned.

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200

362
 Amazon Chime SDK API Reference
ListChannelBans

Content-type: application/json

{
"ChannelArn": "string",
"ChannelBans": [
{
"Member": {
"Arn": "string",
"Name": "string"
}
}
],
"NextToken": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ChannelArn (p. 362)

The ARN of the channel.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}
ChannelBans (p. 362)

The information for each requested ban.

Type: Array of ChannelBanSummary (p. 1121) objects

NextToken (p. 362)

The token passed by previous API calls until all requested bans are returned.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

363
 Amazon Chime SDK API Reference
ListChannelBans

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

364
 Amazon Chime SDK API Reference
ListChannelMemberships

ListChannelMemberships
Service: Amazon Chime

Lists all channel memberships in a channel.

Note
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.

Request Syntax
GET /channels/channelArn/memberships?max-results=MaxResults&next-token=NextToken&type=Type
HTTP/1.1
x-amz-chime-bearer: ChimeBearer

URI Request Parameters

The request uses the following URI parameters.

channelArn (p. 365)

The maximum number of channel memberships that you want returned.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 365)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}
MaxResults (p. 365)

The maximum number of channel memberships that you want returned.

Valid Range: Minimum value of 1. Maximum value of 50.

NextToken (p. 365)

The token passed by previous API calls until all requested channel memberships are returned.

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*
Type (p. 365)

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.

Valid Values: DEFAULT | HIDDEN

365
 Amazon Chime SDK API Reference
ListChannelMemberships

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"ChannelArn": "string",
"ChannelMemberships": [
{
"Member": {
"Arn": "string",
"Name": "string"
}
}
],
"NextToken": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ChannelArn (p. 366)

The ARN of the channel.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}
ChannelMemberships (p. 366)

The information for the requested channel memberships.

Type: Array of ChannelMembershipSummary (p. 1125) objects

NextToken (p. 366)

The token passed by previous API calls until all requested channel memberships are returned.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

366
 Amazon Chime SDK API Reference
ListChannelMemberships

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

367
 Amazon Chime SDK API Reference
ListChannelMembershipsForAppInstanceUser

ListChannelMembershipsForAppInstanceUser
Service: Amazon Chime

Lists all channels that a particular AppInstanceUser is a part of. Only an AppInstanceAdmin can call
the API with a user ARN that is not their own.
Note
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.

Request Syntax
GET /channels?scope=app-instance-user-memberships&app-instance-user-
arn=AppInstanceUserArn&max-results=MaxResults&next-token=NextToken HTTP/1.1
x-amz-chime-bearer: ChimeBearer

URI Request Parameters

The request uses the following URI parameters.

AppInstanceUserArn (p. 368)

The ARN of the AppInstanceUsers

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}
ChimeBearer (p. 368)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}
MaxResults (p. 368)

The maximum number of users that you want returned.

Valid Range: Minimum value of 1. Maximum value of 50.

NextToken (p. 368)

The token returned from previous API requests until the number of channel memberships is reached.

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200

368
 Amazon Chime SDK API Reference
ListChannelMembershipsForAppInstanceUser

Content-type: application/json

{
"ChannelMemberships": [
{
"AppInstanceUserMembershipSummary": {
"ReadMarkerTimestamp": number,
"Type": "string"
},
"ChannelSummary": {
"ChannelArn": "string",
"LastMessageTimestamp": number,
"Metadata": "string",
"Mode": "string",
"Name": "string",
"Privacy": "string"
}
}
],
"NextToken": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ChannelMemberships (p. 368)

The information for the requested channel memberships.

Type: Array of ChannelMembershipForAppInstanceUserSummary (p. 1124) objects

NextToken (p. 368)

The token passed by previous API calls until all requested users are returned.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

369
 Amazon Chime SDK API Reference
ListChannelMembershipsForAppInstanceUser

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

370
 Amazon Chime SDK API Reference
ListChannelMessages

ListChannelMessages
Service: Amazon Chime

List all the messages in a channel. Returns a paginated list of ChannelMessages. By default, sorted by
creation timestamp in descending order.
Note
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.
Also, 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.

Request Syntax
GET /channels/channelArn/messages?max-results=MaxResults&next-token=NextToken&not-
after=NotAfter&not-before=NotBefore&sort-order=SortOrder HTTP/1.1
x-amz-chime-bearer: ChimeBearer

URI Request Parameters

The request uses the following URI parameters.

channelArn (p. 371)

The ARN of the channel.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 371)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}
MaxResults (p. 371)

The maximum number of messages that you want returned.

Valid Range: Minimum value of 1. Maximum value of 50.

NextToken (p. 371)

The token passed by previous API calls until all requested messages are returned.

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*
NotAfter (p. 371)

The final or ending time stamp for your requested messages.

371
 Amazon Chime SDK API Reference
ListChannelMessages

NotBefore (p. 371)

The initial or starting time stamp for your requested messages.

SortOrder (p. 371)

The order in which you want messages sorted. Default is Descending, based on time created.

Valid Values: ASCENDING | DESCENDING

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"ChannelArn": "string",
"ChannelMessages": [
{
"Content": "string",
"CreatedTimestamp": number,
"LastEditedTimestamp": number,
"LastUpdatedTimestamp": number,
"MessageId": "string",
"Metadata": "string",
"Redacted": boolean,
"Sender": {
"Arn": "string",
"Name": "string"
},
"Type": "string"
}
],
"NextToken": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ChannelArn (p. 372)

The ARN of the channel containing the requested messages.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}
ChannelMessages (p. 372)

The information about, and content of, each requested message.

372
 Amazon Chime SDK API Reference
ListChannelMessages

Type: Array of ChannelMessageSummary (p. 1128) objects

NextToken (p. 372)

The token passed by previous API calls until all requested messages are returned.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2

373
 Amazon Chime SDK API Reference
ListChannelMessages

• AWS SDK for JavaScript

• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

374
 Amazon Chime SDK API Reference
ListChannelModerators

ListChannelModerators
Service: Amazon Chime

Lists all the moderators for a channel.

Note
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.

Request Syntax
GET /channels/channelArn/moderators?max-results=MaxResults&next-token=NextToken HTTP/1.1
x-amz-chime-bearer: ChimeBearer

URI Request Parameters

The request uses the following URI parameters.

channelArn (p. 375)

The ARN of the channel.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 375)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}
MaxResults (p. 375)

The maximum number of moderators that you want returned.

Valid Range: Minimum value of 1. Maximum value of 50.

NextToken (p. 375)

The token passed by previous API calls until all requested moderators are returned.

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200

375
 Amazon Chime SDK API Reference
ListChannelModerators

Content-type: application/json

{
"ChannelArn": "string",
"ChannelModerators": [
{
"Moderator": {
"Arn": "string",
"Name": "string"
}
}
],
"NextToken": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ChannelArn (p. 375)

The ARN of the channel.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}
ChannelModerators (p. 375)

The information about and names of each moderator.

Type: Array of ChannelModeratorSummary (p. 1132) objects

NextToken (p. 375)

The token passed by previous API calls until all requested moderators are returned.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

376
 Amazon Chime SDK API Reference
ListChannelModerators

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

377
 Amazon Chime SDK API Reference
ListChannels

ListChannels
Service: Amazon Chime

Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow
results.

Functionality & restrictions

• Use privacy = PUBLIC to retrieve all public channels in the account.

• Only an AppInstanceAdmin can set privacy = PRIVATE to list the private channels in an account.

Note
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.

Request Syntax
GET /channels?app-instance-arn=AppInstanceArn&max-results=MaxResults&next-
token=NextToken&privacy=Privacy HTTP/1.1
x-amz-chime-bearer: ChimeBearer

URI Request Parameters

The request uses the following URI parameters.

AppInstanceArn (p. 378)

The ARN of the AppInstance.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 378)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}
MaxResults (p. 378)

The maximum number of channels that you want to return.

Valid Range: Minimum value of 1. Maximum value of 50.

NextToken (p. 378)

The token passed by previous API calls until all requested channels are returned.

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

378
 Amazon Chime SDK API Reference
ListChannels

Privacy (p. 378)

The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves private channels.
Only an AppInstanceAdmin can retrieve private channels.

Valid Values: PUBLIC | PRIVATE

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"Channels": [
{
"ChannelArn": "string",
"LastMessageTimestamp": number,
"Metadata": "string",
"Mode": "string",
"Name": "string",
"Privacy": "string"
}
],
"NextToken": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Channels (p. 379)

The information about each channel.

Type: Array of ChannelSummary (p. 1134) objects

NextToken (p. 379)

The token returned from previous API requests until the number of channels is reached.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

379
 Amazon Chime SDK API Reference
ListChannels

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

380
 Amazon Chime SDK API Reference
ListChannelsModeratedByAppInstanceUser

ListChannelsModeratedByAppInstanceUser
Service: Amazon Chime

A list of the channels moderated by an AppInstanceUser.

Note
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.

Request Syntax
GET /channels?scope=app-instance-user-moderated-channels&app-instance-user-
arn=AppInstanceUserArn&max-results=MaxResults&next-token=NextToken HTTP/1.1
x-amz-chime-bearer: ChimeBearer

URI Request Parameters

The request uses the following URI parameters.

AppInstanceUserArn (p. 381)

The ARN of the user in the moderated channel.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}
ChimeBearer (p. 381)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}
MaxResults (p. 381)

The maximum number of channels in the request.

Valid Range: Minimum value of 1. Maximum value of 50.

NextToken (p. 381)

The token returned from previous API requests until the number of channels moderated by the user
is reached.

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200

381
 Amazon Chime SDK API Reference
ListChannelsModeratedByAppInstanceUser

Content-type: application/json

{
"Channels": [
{
"ChannelSummary": {
"ChannelArn": "string",
"LastMessageTimestamp": number,
"Metadata": "string",
"Mode": "string",
"Name": "string",
"Privacy": "string"
}
}
],
"NextToken": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Channels (p. 381)

The moderated channels in the request.

Type: Array of ChannelModeratedByAppInstanceUserSummary (p. 1130) objects

NextToken (p. 381)

The token returned from previous API requests until the number of channels moderated by the user
is reached.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

382
 Amazon Chime SDK API Reference
ListChannelsModeratedByAppInstanceUser

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

383
 Amazon Chime SDK API Reference
ListMediaCapturePipelines

ListMediaCapturePipelines
Service: Amazon Chime

Returns a list of media capture pipelines.

Request Syntax
GET /media-capture-pipelines?max-results=MaxResults&next-token=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MaxResults (p. 384)

The maximum number of results to return in a single call. Valid Range: 1 - 99.

Valid Range: Minimum value of 1. Maximum value of 99.

NextToken (p. 384)

The token used to retrieve the next page of results.

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"MediaCapturePipelines": [
{
"ChimeSdkMeetingConfiguration": {
"ArtifactsConfiguration": {
"Audio": {
"MuxType": "string"
},
"Content": {
"MuxType": "string",
"State": "string"
},
"Video": {
"MuxType": "string",
"State": "string"
}
},
"SourceConfiguration": {
"SelectedVideoStreams": {
"AttendeeIds": [ "string" ],
"ExternalUserIds": [ "string" ]
}
}
},
"CreatedTimestamp": number,
"MediaPipelineId": "string",

384
 Amazon Chime SDK API Reference
ListMediaCapturePipelines

"SinkArn": "string",
"SinkType": "string",
"SourceArn": "string",
"SourceType": "string",
"Status": "string",
"UpdatedTimestamp": number
}
],
"NextToken": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

MediaCapturePipelines (p. 384)

The media capture pipeline objects in the list.

Type: Array of MediaCapturePipeline (p. 1154) objects

NextToken (p. 384)

The token used to retrieve the next page of results.

Type: String

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

385
 Amazon Chime SDK API Reference
ListMediaCapturePipelines

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

386
 Amazon Chime SDK API Reference
ListMeetings

ListMeetings
Service: Amazon Chime

Lists up to 100 active Amazon Chime SDK meetings. For more information about the Amazon Chime
SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.

Request Syntax
GET /meetings?max-results=MaxResults&next-token=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MaxResults (p. 387)

The maximum number of results to return in a single call.

Valid Range: Minimum value of 1. Maximum value of 99.

NextToken (p. 387)

The token to use to retrieve the next page of results.

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"Meetings": [
{
"ExternalMeetingId": "string",
"MediaPlacement": {
"AudioFallbackUrl": "string",
"AudioHostUrl": "string",
"EventIngestionUrl": "string",
"ScreenDataUrl": "string",
"ScreenSharingUrl": "string",
"ScreenViewingUrl": "string",
"SignalingUrl": "string",
"TurnControlUrl": "string"
},
"MediaRegion": "string",
"MeetingId": "string"
}
],
"NextToken": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

387
 Amazon Chime SDK API Reference
ListMeetings

The following data is returned in JSON format by the service.

Meetings (p. 387)

The Amazon Chime SDK meeting information.

Type: Array of Meeting (p. 1158) objects

NextToken (p. 387)

The token to use to retrieve the next page of results.

Type: String

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go

388
 Amazon Chime SDK API Reference
ListMeetings

• AWS SDK for Java V2

• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

389
 Amazon Chime SDK API Reference
ListMeetingTags

ListMeetingTags
Service: Amazon Chime

Lists the tags applied to an Amazon Chime SDK meeting resource.

Request Syntax
GET /meetings/meetingId/tags HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

meetingId (p. 390)

The Amazon Chime SDK meeting ID.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Tags (p. 390)

A list of tag key-value pairs.

Type: Array of Tag (p. 1203) objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

390
 Amazon Chime SDK API Reference
ListMeetingTags

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

391
 Amazon Chime SDK API Reference
ListPhoneNumberOrders

ListPhoneNumberOrders
Service: Amazon Chime

Lists the phone number orders for the administrator's Amazon Chime account.

Request Syntax
GET /phone-number-orders?max-results=MaxResults&next-token=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MaxResults (p. 392)

The maximum number of results to return in a single call.

Valid Range: Minimum value of 1. Maximum value of 99.

NextToken (p. 392)

The token to use to retrieve the next page of results.

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"NextToken": "string",
"PhoneNumberOrders": [
{
"CreatedTimestamp": number,
"OrderedPhoneNumbers": [
{
"E164PhoneNumber": "string",
"Status": "string"
}
],
"PhoneNumberOrderId": "string",
"ProductType": "string",
"Status": "string",
"UpdatedTimestamp": number
}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

392
 Amazon Chime SDK API Reference
ListPhoneNumberOrders

NextToken (p. 392)

The token to use to retrieve the next page of results.

Type: String
PhoneNumberOrders (p. 392)

The phone number order details.

Type: Array of PhoneNumberOrder (p. 1178) objects

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

393
 Amazon Chime SDK API Reference
ListPhoneNumberOrders

Example
This example lists the phone number orders for the administrator's Amazon Chime account.

Sample Request

GET /phone-number-orders HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding:

identity User-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-
Date: 20190918T175325Z Authorization: AUTHPARAMS

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 6e79c3b2-a0e4-443e-a280-9057b0edd4e8

Content-Type: application/json Content-Length: 770 Date: Wed, 18 Sep 2019
17:53:26 GMT Connection: keep-alive {"NextToken":null,"PhoneNumberOrders":
[{"CreatedTimestamp":"2019-08-12T22:10:20.504Z","OrderedPhoneNumbers":
[{"E164PhoneNumber":"+12065550100","Status":"Acquired"},
{"E164PhoneNumber":"+12065550101","Status":"Acquired"}],"PhoneNumberOrderId":"abc12345-
de67-89f0-123g-h45i678j9012","ProductType":"Voice
Connector","Status":"Successful","UpdatedTimestamp":"2019-08-12T22:10:31.186Z"}]}

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

394
 Amazon Chime SDK API Reference
ListPhoneNumbers

ListPhoneNumbers
Service: Amazon Chime

Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime
Voice Connector, or Amazon Chime Voice Connector group.

Request Syntax
GET /phone-numbers?filter-name=FilterName&filter-value=FilterValue&max-
results=MaxResults&next-token=NextToken&product-type=ProductType&status=Status HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

FilterName (p. 395)

The filter to use to limit the number of results.

Valid Values: AccountId | UserId | VoiceConnectorId | VoiceConnectorGroupId |

SipRuleId
FilterValue (p. 395)

The value to use for the filter.

MaxResults (p. 395)

The maximum number of results to return in a single call.

Valid Range: Minimum value of 1. Maximum value of 99.

NextToken (p. 395)

The token to use to retrieve the next page of results.

ProductType (p. 395)

The phone number product type.

Valid Values: BusinessCalling | VoiceConnector | SipMediaApplicationDialIn

Status (p. 395)

The phone number status.

Valid Values: AcquireInProgress | AcquireFailed | Unassigned | Assigned |

ReleaseInProgress | DeleteInProgress | ReleaseFailed | DeleteFailed

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"NextToken": "string",

395
 Amazon Chime SDK API Reference
ListPhoneNumbers

"PhoneNumbers": [
{
"Associations": [
{
"AssociatedTimestamp": number,
"Name": "string",
"Value": "string"
}
],
"CallingName": "string",
"CallingNameStatus": "string",
"Capabilities": {
"InboundCall": boolean,
"InboundMMS": boolean,
"InboundSMS": boolean,
"OutboundCall": boolean,
"OutboundMMS": boolean,
"OutboundSMS": boolean
},
"Country": "string",
"CreatedTimestamp": number,
"DeletionTimestamp": number,
"E164PhoneNumber": "string",
"PhoneNumberId": "string",
"ProductType": "string",
"Status": "string",
"Type": "string",
"UpdatedTimestamp": number
}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken (p. 395)

The token to use to retrieve the next page of results.

Type: String
PhoneNumbers (p. 395)

The phone number details.

Type: Array of PhoneNumber (p. 1170) objects

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

396
 Amazon Chime SDK API Reference
ListPhoneNumbers

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example lists the phone numbers for the account.

Sample Request

GET /phone-numbers HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding: identity

User-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-Date:
20191028T184455Z Authorization: AUTHPARAMS

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: c859a1d1-84ce-4cfc-a3ad-4dcde29d9265 Content-

Type: application/json Content-Length: 1620 Date: Mon, 28 Oct 2019 18:44:55
GMT Connection: keep-alive {"NextToken":null,"PhoneNumbers":[{"Associations":
[{"AssociatedTimestamp":"2019-10-28T18:40:37.453Z","Name":"VoiceConnectorId","Value":"abcdef1ghij2klmno
{"InboundCall":true,"InboundMMS":true,"InboundSMS":true,"OutboundCall":true,"OutboundMMS":true,"Outboun
Connector","Status":"Assigned","Type":"Local","UpdatedTimestamp":"2019-10-28T18:42:07.964Z"},
{"Associations":

397
 Amazon Chime SDK API Reference
ListPhoneNumbers

[{"AssociatedTimestamp":"2019-10-28T18:40:37.511Z","Name":"VoiceConnectorId","Value":"abcdef1ghij2klmno
{"InboundCall":true,"InboundMMS":true,"InboundSMS":true,"OutboundCall":true,"OutboundMMS":true,"Outboun
Connector","Status":"Assigned","Type":"Local","UpdatedTimestamp":"2019-10-28T18:42:07.960Z"},
{"Associations":[],"CallingName":null,"CallingNameStatus":"Unassigned","Capabilities":
{"InboundCall":true,"InboundMMS":true,"InboundSMS":true,"OutboundCall":true,"OutboundMMS":true,"Outboun
Connector","Status":"Unassigned","Type":"Local","UpdatedTimestamp":"2019-10-28T18:31:55.339Z"}]}

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

398
 Amazon Chime SDK API Reference
ListProxySessions

ListProxySessions
Service: Amazon Chime

Lists the proxy sessions for the specified Amazon Chime Voice Connector.

Request Syntax
GET /voice-connectors/voiceConnectorId/proxy-sessions?max-results=MaxResults&next-
token=NextToken&status=Status HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MaxResults (p. 399)

The maximum number of results to return in a single call.

Valid Range: Minimum value of 1. Maximum value of 99.

NextToken (p. 399)

The token to use to retrieve the next page of results.

Length Constraints: Maximum length of 65535.

Status (p. 399)

The proxy session status.

Valid Values: Open | InProgress | Closed

voiceConnectorId (p. 399)

The Amazon Chime voice connector ID.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"NextToken": "string",
"ProxySessions": [
{
"Capabilities": [ "string" ],
"CreatedTimestamp": number,
"EndedTimestamp": number,
"ExpiryMinutes": number,

399
 Amazon Chime SDK API Reference
ListProxySessions

"GeoMatchLevel": "string",
"GeoMatchParams": {
"AreaCode": "string",
"Country": "string"
},
"Name": "string",
"NumberSelectionBehavior": "string",
"Participants": [
{
"PhoneNumber": "string",
"ProxyPhoneNumber": "string"
}
],
"ProxySessionId": "string",
"Status": "string",
"UpdatedTimestamp": number,
"VoiceConnectorId": "string"
}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken (p. 399)

The token to use to retrieve the next page of results.

Type: String

Length Constraints: Maximum length of 65535.

ProxySessions (p. 399)

The proxy session details.

Type: Array of ProxySession (p. 1181) objects

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

400
 Amazon Chime SDK API Reference
ListProxySessions

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example lists the proxy sessions for your Amazon Chime Voice Connector.

Sample Request

GET /voice-connectors/abcdef1ghij2klmno3pqr4/proxy-sessions HTTP/1.1 Host:

service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.18.39
Python/3.8.0 Windows/10 botocore/1.15.39 X-Amz-Date: 20200415T161309Z Authorization:
AUTHPARAMS

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 7a6e9cf0-6200-4296-9e50-b6dbb2bbcf76 Content-

Type: application/json Content-Length: 551 Date: Wed, 15 Apr 2020 16:13:08 GMT
Connection: keep-alive {"NextToken":null,"ProxySessions":[{"Capabilities":
["SMS","Voice"],"CreatedTimestamp":"2020-04-15T16:10:10.288Z","EndedTimestamp":null,"ExpiryMinutes":60,
[{"PhoneNumber":"+12065550100","ProxyPhoneNumber":"+19135550199"},
{"PhoneNumber":"+14015550101","ProxyPhoneNumber":"+19135550199"}],"ProxySessionId":"123a4bc5-67d8-901e-
h4ghjk56789l","Status":"Open","UpdatedTimestamp":"2020-04-15T16:10:10.288Z","VoiceConnectorId":"abcdef1

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

401
 Amazon Chime SDK API Reference
ListProxySessions

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

402
 Amazon Chime SDK API Reference
ListRoomMemberships

ListRoomMemberships
Service: Amazon Chime

Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the
members' IDs, email addresses, and names.

Request Syntax
GET /accounts/accountId/rooms/roomId/memberships?max-results=MaxResults&next-
token=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

accountId (p. 403)

The Amazon Chime account ID.

Pattern: .*\S.*

Required: Yes
MaxResults (p. 403)

The maximum number of results to return in a single call.

Valid Range: Minimum value of 1. Maximum value of 99.

NextToken (p. 403)

The token to use to retrieve the next page of results.

roomId (p. 403)

The room ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"NextToken": "string",
"RoomMemberships": [
{
"InvitedBy": "string",
"Member": {
"AccountId": "string",
"Email": "string",
"FullName": "string",

403
 Amazon Chime SDK API Reference
ListRoomMemberships

"MemberId": "string",
"MemberType": "string"
},
"Role": "string",
"RoomId": "string",
"UpdatedTimestamp": number
}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken (p. 403)

The token to use to retrieve the next page of results.

Type: String
RoomMemberships (p. 403)

The room membership details.

Type: Array of RoomMembership (p. 1187) objects

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

404
 Amazon Chime SDK API Reference
ListRoomMemberships

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example lists the membership details for the specified chat room.

Sample Request

GET /accounts/12a3456b-7c89-012d-3456-78901e23fg45/rooms/
abcd1e2d-3e45-6789-01f2-3g45h67i890j/memberships HTTP/1.1 Host:
service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.293
Python/3.8.0 Windows/10 botocore/1.13.29 X-Amz-Date: 20191202T224849Z Authorization:
AUTHPARAMS

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: d8414bdb-5ba9-48ae-9305-f4162ad7062f

Content-Type: application/json Content-Length: 771 Date: Mon, 02 Dec 2019
22:48:49 GMT Connection: keep-alive {"NextToken":null,"RoomMemberships":
[{"InvitedBy":"arn:aws:iam::111122223333:user/alejandro","Member":
{"AccountId":"12a3456b-7c89-012d-3456-78901e23fg45","Email":"[email protected]","FullName":"Zhang
Wei","MemberId":"2ab2345c-67de-8901-
f23g-45h678901j2k","MemberType":"User"},"Role":"Member","RoomId":"abcd1e2d-3e45-6789-01f2-3g45h67i890j"
{"InvitedBy":"arn:aws:iam::111122223333:user/alejandro","Member":
{"AccountId":"12a3456b-7c89-012d-3456-78901e23fg45","Email":"[email protected]","FullName":"Jane
Doe","MemberId":"1ab2345c-67de-8901-
f23g-45h678901j2k","MemberType":"User"},"Role":"Administrator","RoomId":"abcd1e2d-3e45-6789-01f2-3g45h6

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3

405
 Amazon Chime SDK API Reference
ListRoomMemberships

• AWS SDK for Python

• AWS SDK for Ruby V3

406
 Amazon Chime SDK API Reference
ListRooms

ListRooms
Service: Amazon Chime

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.

Request Syntax
GET /accounts/accountId/rooms?max-results=MaxResults&member-id=MemberId&next-
token=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

accountId (p. 407)

The Amazon Chime account ID.

Pattern: .*\S.*

Required: Yes
MaxResults (p. 407)

The maximum number of results to return in a single call.

Valid Range: Minimum value of 1. Maximum value of 99.

MemberId (p. 407)

The member ID (user ID or bot ID).

NextToken (p. 407)

The token to use to retrieve the next page of results.

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"NextToken": "string",
"Rooms": [
{
"AccountId": "string",
"CreatedBy": "string",
"CreatedTimestamp": number,
"Name": "string",
"RoomId": "string",
"UpdatedTimestamp": number
}
]

407
 Amazon Chime SDK API Reference
ListRooms

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken (p. 407)

The token to use to retrieve the next page of results.

Type: String
Rooms (p. 407)

The room details.

Type: Array of Room (p. 1185) objects

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

408
 Amazon Chime SDK API Reference
ListRooms

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example returns a list of chat rooms in the specified account. The list is filtered by the chat rooms
that the specified member belongs to.

Sample Request

GET /accounts/12a3456b-7c89-012d-3456-78901e23fg45/rooms?member-id=1ab2345c-67de-8901-
f23g-45h678901j2k HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding: identity
User-Agent: aws-cli/1.16.293 Python/3.8.0 Windows/10 botocore/1.13.29 X-Amz-Date:
20191202T223837Z Authorization: AUTHPARAMS

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: eb4b1f38-a2fa-4313-99f9-28cdf100c851

Content-Type: application/json Content-Length: 294 Date: Mon, 02 Dec
2019 22:38:36 GMT Connection: keep-alive {"NextToken":null,"Rooms":
[{"AccountId":"12a3456b-7c89-012d-3456-78901e23fg45","CreatedBy":"arn:aws:iam::111122223333:user/
alejandro","CreatedTimestamp":"2019-12-02T22:29:31.549Z","Name":"chatRoom","RoomId":"abcd1e2d-3e45-6789

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

409
 Amazon Chime SDK API Reference
ListSipMediaApplications

ListSipMediaApplications
Service: Amazon Chime

Lists the SIP media applications under the administrator's AWS account.

Request Syntax
GET /sip-media-applications?max-results=MaxResults&next-token=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MaxResults (p. 410)

The maximum number of results to return in a single call. Defaults to 100.

Valid Range: Minimum value of 1. Maximum value of 99.

NextToken (p. 410)

The token to use to retrieve the next page of results.

Length Constraints: Maximum length of 65535.

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"NextToken": "string",
"SipMediaApplications": [
{
"AwsRegion": "string",
"CreatedTimestamp": number,
"Endpoints": [
{
"LambdaArn": "string"
}
],
"Name": "string",
"SipMediaApplicationId": "string",
"UpdatedTimestamp": number
}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

410
 Amazon Chime SDK API Reference
ListSipMediaApplications

NextToken (p. 410)

The token to use to retrieve the next page of results.

Type: String

Length Constraints: Maximum length of 65535.

SipMediaApplications (p. 410)

List of SIP media applications and application details.

Type: Array of SipMediaApplication (p. 1192) objects

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go

411
 Amazon Chime SDK API Reference
ListSipMediaApplications

• AWS SDK for Java V2

• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

412
 Amazon Chime SDK API Reference
ListSipRules

ListSipRules
Service: Amazon Chime

Lists the SIP rules under the administrator's AWS account.

Request Syntax
GET /sip-rules?max-results=MaxResults&next-token=NextToken&sip-media-
application=SipMediaApplicationId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MaxResults (p. 413)

The maximum number of results to return in a single call. Defaults to 100.

Valid Range: Minimum value of 1. Maximum value of 99.

NextToken (p. 413)

The token to use to retrieve the next page of results.

Length Constraints: Maximum length of 65535.

SipMediaApplicationId (p. 413)

The SIP media application ID.

Pattern: .*\S.*

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"NextToken": "string",
"SipRules": [
{
"CreatedTimestamp": number,
"Disabled": boolean,
"Name": "string",
"SipRuleId": "string",
"TargetApplications": [
{
"AwsRegion": "string",
"Priority": number,
"SipMediaApplicationId": "string"
}
],
"TriggerType": "string",
"TriggerValue": "string",
"UpdatedTimestamp": number

413
 Amazon Chime SDK API Reference
ListSipRules

}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken (p. 413)

The token to use to retrieve the next page of results.

Type: String

Length Constraints: Maximum length of 65535.

SipRules (p. 413)

List of SIP rules and rule details.

Type: Array of SipRule (p. 1197) objects

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

414
 Amazon Chime SDK API Reference
ListSipRules

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

415
 Amazon Chime SDK API Reference
ListSupportedPhoneNumberCountries

ListSupportedPhoneNumberCountries
Service: Amazon Chime

Lists supported phone number countries.

Request Syntax
GET /phone-number-countries?product-type=ProductType HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

ProductType (p. 416)

The phone number product type.

Valid Values: BusinessCalling | VoiceConnector | SipMediaApplicationDialIn

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"PhoneNumberCountries": [
{
"CountryCode": "string",
"SupportedPhoneNumberTypes": [ "string" ]
}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

PhoneNumberCountries (p. 416)

The supported phone number countries.

Type: Array of PhoneNumberCountry (p. 1176) objects

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

416
 Amazon Chime SDK API Reference
ListSupportedPhoneNumberCountries

AccessDeniedException

You don't have permissions to perform the requested operation.

HTTP Status Code: 403

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

417
 Amazon Chime SDK API Reference
ListTagsForResource

ListTagsForResource
Service: Amazon Chime

Lists the tags applied to an Amazon Chime SDK meeting resource.

Request Syntax
GET /tags?arn=ResourceARN HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

ResourceARN (p. 418)

The resource ARN.

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^arn[\/\:\-\_\.a-zA-Z0-9]+$

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Tags (p. 418)

A list of tag-key value pairs.

Type: Array of Tag (p. 1203) objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

418
 Amazon Chime SDK API Reference
ListTagsForResource

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

419
 Amazon Chime SDK API Reference
ListUsers

ListUsers
Service: Amazon Chime

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.

Request Syntax
GET /accounts/accountId/users?max-results=MaxResults&next-token=NextToken&user-
email=UserEmail&user-type=UserType HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

accountId (p. 420)

The Amazon Chime account ID.

Pattern: .*\S.*

Required: Yes
MaxResults (p. 420)

The maximum number of results to return in a single call. Defaults to 100.

Valid Range: Minimum value of 1. Maximum value of 200.

NextToken (p. 420)

The token to use to retrieve the next page of results.

UserEmail (p. 420)

Optional. The user email address used to filter results. Maximum 1.

Pattern: .+@.+\..+
UserType (p. 420)

The user type.

Valid Values: PrivateUser | SharedDevice

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"NextToken": "string",
"Users": [
{
"AccountId": "string",
"AlexaForBusinessMetadata": {

420
 Amazon Chime SDK API Reference
ListUsers

"AlexaForBusinessRoomArn": "string",
"IsAlexaForBusinessEnabled": boolean
},
"DisplayName": "string",
"InvitedOn": number,
"LicenseType": "string",
"PersonalPIN": "string",
"PrimaryEmail": "string",
"PrimaryProvisionedNumber": "string",
"RegisteredOn": number,
"UserId": "string",
"UserInvitationStatus": "string",
"UserRegistrationStatus": "string",
"UserType": "string"
}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken (p. 420)

The token to use to retrieve the next page of results.

Type: String
Users (p. 420)

List of users and user details.

Type: Array of User (p. 1211) objects

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

421
 Amazon Chime SDK API Reference
ListUsers

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example lists the users for the specified Amazon Chime account.

Sample Request

GET /console/accounts/12a3456b-7c89-012d-3456-78901e23fg45/users HTTP/1.1 Host:

service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.83
Python/3.6.6 Windows/10 botocore/1.12.73 X-Amz-Date: 20190108T165935Z Authorization:
AUTHPARAMS

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 429f487b-6f1d-4a76-8361-9809f6885ee8

Content-Type: application/json Content-Length: 2200 Date: Tue, 08 Jan 2019
16:59:36 GMT Connection: keep-alive {"NextToken": null,"Users": [{"AccountId":
"12a3456b-7c89-012d-3456-78901e23fg45","Delegates": null,"Devices": null,"DisplayName":
"user1 user1","EmailAlias": [],"FullName": "user1 user1","InvitedOn": null,"IsProTrial":
false,"LastActiveOn": null,"LicenseType": "Pro","PersonalPIN": null,"PresenceVisibility":
null,"PrimaryEmail": "[email protected]","PrimaryProvisionedNumber":
null,"RegisteredOn": "2018-12-20T18:45:25.231Z","UserId": "1ab2345c-67de-8901-
f23g-45h678901j2k","UserInvitationStatus": null,"UserLocale":
null,"UserRegistrationStatus": "Registered","Vanity": null}, {"AccountId":
"12a3456b-7c89-012d-3456-78901e23fg45","Delegates": null,"Devices": null,"DisplayName":
"user2 user2","EmailAlias": [],"FullName": "user2 user2","InvitedOn": null,"IsProTrial":
false,"LastActiveOn": null,"LicenseType": "Pro","PersonalPIN": null,"PresenceVisibility":
null,"PrimaryEmail": "[email protected]","PrimaryProvisionedNumber":
null,"RegisteredOn": "2018-12-20T18:45:45.415Z","UserId": "2ab2345c-67de-8901-
f23g-45h678901j2k","UserInvitationStatus": null,"UserLocale":
null,"UserRegistrationStatus": "Registered","Vanity": null}, {"AccountId":
"12a3456b-7c89-012d-3456-78901e23fg45","Delegates": null,"Devices":
null,"DisplayName": "user3 user3","EmailAlias": [],"FullName":

422
 Amazon Chime SDK API Reference
ListUsers

"user3 user3","InvitedOn": null,"IsProTrial": false,"LastActiveOn":

null,"LicenseType": "Basic","PersonalPIN": null,"PresenceVisibility":
null,"PrimaryEmail": "[email protected]","PrimaryProvisionedNumber":
null,"RegisteredOn": "2018-12-20T18:46:57.747Z","UserId": "3ab2345c-67de-8901-
f23g-45h678901j2k","UserInvitationStatus": null,"UserLocale":
null,"UserRegistrationStatus": "Registered","Vanity": null}, {"AccountId":
"12a3456b-7c89-012d-3456-78901e23fg45","Delegates": null,"Devices":
null,"DisplayName": "user4 user4","EmailAlias": [],"FullName":
"user4 user4","InvitedOn": null,"IsProTrial": false,"LastActiveOn":
null,"LicenseType": "Basic","PersonalPIN": null,"PresenceVisibility":
null,"PrimaryEmail": "[email protected]","PrimaryProvisionedNumber":
null,"RegisteredOn": "2018-12-20T18:47:15.390Z","UserId": "4ab2345c-67de-8901-
f23g-45h678901j2k","UserInvitationStatus": null,"UserLocale":
null,"UserRegistrationStatus": "Registered","Vanity": null}] }

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

423
 Amazon Chime SDK API Reference
ListVoiceConnectorGroups

ListVoiceConnectorGroups
Service: Amazon Chime

Lists the Amazon Chime Voice Connector groups for the administrator's AWS account.

Request Syntax
GET /voice-connector-groups?max-results=MaxResults&next-token=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MaxResults (p. 424)

The maximum number of results to return in a single call.

Valid Range: Minimum value of 1. Maximum value of 99.

NextToken (p. 424)

The token to use to retrieve the next page of results.

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"NextToken": "string",
"VoiceConnectorGroups": [
{
"CreatedTimestamp": number,
"Name": "string",
"UpdatedTimestamp": number,
"VoiceConnectorGroupArn": "string",
"VoiceConnectorGroupId": "string",
"VoiceConnectorItems": [
{
"Priority": number,
"VoiceConnectorId": "string"
}
]
}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

424
 Amazon Chime SDK API Reference
ListVoiceConnectorGroups

NextToken (p. 424)

The token to use to retrieve the next page of results.

Type: String
VoiceConnectorGroups (p. 424)

The details of the Amazon Chime Voice Connector groups.

Type: Array of VoiceConnectorGroup (p. 1219) objects

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

425
 Amazon Chime SDK API Reference
ListVoiceConnectorGroups

Example
This example lists the Amazon Chime Voice Connector groups for the administrator's AWS account.

Sample Request

GET /voice-connector-groups HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding:

identity User-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-
Date: 20191028T185101Z Authorization: AUTHPARAMS

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: f74f1f09-4fd9-4342-836d-b6865c5d0ff7

Content-Type: application/json Content-Length: 242 Date: Mon, 28 Oct 2019
18:51:01 GMT Connection: keep-alive {"NextToken":null,"VoiceConnectorGroups":
[{"CreatedTimestamp":"2019-09-18T16:38:34.734Z","Name":"myGroup","UpdatedTimestamp":"2019-09-18T16:38:3
c7d8-90e1-fg23-4h567jkl8901","VoiceConnectorItems":[]}]}

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

426
 Amazon Chime SDK API Reference
ListVoiceConnectors

ListVoiceConnectors
Service: Amazon Chime

Lists the Amazon Chime Voice Connectors for the administrator's AWS account.

Request Syntax
GET /voice-connectors?max-results=MaxResults&next-token=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MaxResults (p. 427)

The maximum number of results to return in a single call.

Valid Range: Minimum value of 1. Maximum value of 99.

NextToken (p. 427)

The token to use to retrieve the next page of results.

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"NextToken": "string",
"VoiceConnectors": [
{
"AwsRegion": "string",
"CreatedTimestamp": number,
"Name": "string",
"OutboundHostName": "string",
"RequireEncryption": boolean,
"UpdatedTimestamp": number,
"VoiceConnectorArn": "string",
"VoiceConnectorId": "string"
}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken (p. 427)

The token to use to retrieve the next page of results.

427
 Amazon Chime SDK API Reference
ListVoiceConnectors

Type: String
VoiceConnectors (p. 427)

The details of the Amazon Chime Voice Connectors.

Type: Array of VoiceConnector (p. 1217) objects

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example lists the Amazon Chime Voice Connectors for the administrator's AWS account.

428
 Amazon Chime SDK API Reference
ListVoiceConnectors

Sample Request

GET /voice-connectors HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding: identity

User-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-Date:
20190918T203740Z Authorization: AUTHPARAMS

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 47fa6799-3b53-43c7-b80d-00fb064c55d8 Content-

Type: application/json Content-Length: 603 Date: Wed, 18 Sep 2019 20:37:41 GMT
Connection: keep-alive {"NextToken":null,"Voice Connectors":[{"AwsRegion":"us-
east-1","CreatedTimestamp":"2019-06-04T18:46:56.508Z","Name":"myVoiceConnector","OutboundHostName":"abc
{"AwsRegion":"us-
west-2","CreatedTimestamp":"2019-09-18T20:34:01.352Z","Name":"newVoiceConnector","OutboundHostName":"ab

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

429
 Amazon Chime SDK API Reference
ListVoiceConnectorTerminationCredentials

ListVoiceConnectorTerminationCredentials
Service: Amazon Chime

Lists the SIP credentials for the specified Amazon Chime Voice Connector.

Request Syntax
GET /voice-connectors/voiceConnectorId/termination/credentials HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId (p. 430)

The Amazon Chime Voice Connector ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"Usernames": [ "string" ]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Usernames (p. 430)

A list of user names.

Type: Array of strings

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

430
 Amazon Chime SDK API Reference
ListVoiceConnectorTerminationCredentials

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example lists the SIP credentials for the specified Amazon Chime Voice Connector.

Sample Request

GET /voice-connectors/abcdef1ghij2klmno3pqr4/termination/credentials HTTP/1.1 Host:

service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.170
Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-Date: 20190823T184433Z Authorization:
AUTHPARAMS

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: fb18412c-4a68-4198-9850-1e44279b8217 Content-Type:

application/json Content-Length: 26 Date: Fri, 23 Aug 2019 18:44:34 GMT Connection: keep-
alive {"Usernames":["jdoe"]}

431
 Amazon Chime SDK API Reference
ListVoiceConnectorTerminationCredentials

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

432
 Amazon Chime SDK API Reference
LogoutUser

LogoutUser
Service: Amazon Chime

Logs out the specified user from all of the devices they are currently logged into.

Request Syntax
POST /accounts/accountId/users/{userId}?operation=logout HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

accountId (p. 433)

The Amazon Chime account ID.

Pattern: .*\S.*

Required: Yes
userId (p. 433)

The user ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

433
 Amazon Chime SDK API Reference
LogoutUser

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example logs out the specified user.

Sample Request

POST /console/accounts/12a3456b-7c89-012d-3456-78901e23fg45/users/1ab2345c-67de-8901-
f23g-45h678901j2k?operation=logout HTTP/1.1 Host: service.chime.aws.amazon.com Accept-
Encoding: identity User-Agent: aws-cli/1.16.83 Python/3.6.6 Windows/10 botocore/1.12.73 X-
Amz-Date: 20190108T180307Z Authorization: AUTHPARAMS Content-Length: 0

Sample Response

HTTP/1.1 204 No Content x-amzn-RequestId: a67c559a-968a-4791-9e32-9a42c0dace42 Content-

Type: application/json Date: Tue, 08 Jan 2019 18:03:07 GMT Connection: keep-alive

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

434
 Amazon Chime SDK API Reference
LogoutUser

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

435
 Amazon Chime SDK API Reference
PutAppInstanceRetentionSettings

PutAppInstanceRetentionSettings
Service: Amazon Chime

Sets the amount of time in days that a given AppInstance retains data.

Request Syntax
PUT /app-instances/appInstanceArn/retention-settings HTTP/1.1
Content-type: application/json

{
"AppInstanceRetentionSettings": {
"ChannelRetentionSettings": {
"RetentionDays": number
}
}
}

URI Request Parameters

The request uses the following URI parameters.

appInstanceArn (p. 436)

The ARN of the AppInstance.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Request Body
The request accepts the following data in JSON format.

AppInstanceRetentionSettings (p. 436)

The time in days to retain data. Data type: number.

Type: AppInstanceRetentionSettings (p. 1101) object

Required: Yes

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"AppInstanceRetentionSettings": {
"ChannelRetentionSettings": {
"RetentionDays": number
}
},

436
 Amazon Chime SDK API Reference
PutAppInstanceRetentionSettings

"InitiateDeletionTimestamp": number
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AppInstanceRetentionSettings (p. 436)

The time in days to retain data. Data type: number.

Type: AppInstanceRetentionSettings (p. 1101) object

InitiateDeletionTimestamp (p. 436)

The time at which the API deletes data.

Type: Timestamp

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

437
 Amazon Chime SDK API Reference
PutAppInstanceRetentionSettings

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

438
 Amazon Chime SDK API Reference
PutAppInstanceStreamingConfigurations

PutAppInstanceStreamingConfigurations
Service: Amazon Chime

The data streaming configurations of an AppInstance.

Request Syntax
PUT /app-instances/appInstanceArn/streaming-configurations HTTP/1.1
Content-type: application/json

{
"AppInstanceStreamingConfigurations": [
{
"AppInstanceDataType": "string",
"ResourceArn": "string"
}
]
}

URI Request Parameters

The request uses the following URI parameters.

appInstanceArn (p. 439)

The ARN of the AppInstance.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Request Body
The request accepts the following data in JSON format.

AppInstanceStreamingConfigurations (p. 439)

The streaming configurations set for an AppInstance.

Type: Array of AppInstanceStreamingConfiguration (p. 1102) objects

Array Members: Minimum number of 1 item. Maximum number of 2 items.

Required: Yes

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"AppInstanceStreamingConfigurations": [
{

439
 Amazon Chime SDK API Reference
PutAppInstanceStreamingConfigurations

"AppInstanceDataType": "string",
"ResourceArn": "string"
}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AppInstanceStreamingConfigurations (p. 439)

The streaming configurations of an AppInstance.

Type: Array of AppInstanceStreamingConfiguration (p. 1102) objects

Array Members: Minimum number of 1 item. Maximum number of 2 items.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

440
 Amazon Chime SDK API Reference
PutAppInstanceStreamingConfigurations

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

441
 Amazon Chime SDK API Reference
PutEventsConfiguration

PutEventsConfiguration
Service: Amazon Chime

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 Bot (p. 1113).

Request Syntax
PUT /accounts/accountId/bots/botId/events-configuration HTTP/1.1
Content-type: application/json

{
"LambdaFunctionArn": "string",
"OutboundEventsHTTPSEndpoint": "string"
}

URI Request Parameters

The request uses the following URI parameters.

accountId (p. 442)

The Amazon Chime account ID.

Pattern: .*\S.*

Required: Yes
botId (p. 442)

The bot ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

LambdaFunctionArn (p. 442)

Lambda function ARN that allows the bot to receive outgoing events.

Type: String

Required: No
OutboundEventsHTTPSEndpoint (p. 442)

HTTPS endpoint that allows the bot to receive outgoing events.

Type: String

Required: No

Response Syntax
HTTP/1.1 201

442
 Amazon Chime SDK API Reference
PutEventsConfiguration

Content-type: application/json

{
"EventsConfiguration": {
"BotId": "string",
"LambdaFunctionArn": "string",
"OutboundEventsHTTPSEndpoint": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

EventsConfiguration (p. 442)

The configuration that allows a bot to receive outgoing events. Can be an HTTPS endpoint or an
AWS Lambda function ARN.

Type: EventsConfiguration (p. 1149) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

443
 Amazon Chime SDK API Reference
PutEventsConfiguration

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

444
 Amazon Chime SDK API Reference
PutRetentionSettings

PutRetentionSettings
Service: Amazon Chime

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 Logging Amazon
Chime API Calls with AWS CloudTrail in the Amazon Chime Administration Guide.

To turn off existing retention settings, remove the number of days from the corresponding
RetentionDays field in the RetentionSettings object. For more information about retention settings, see
Managing Chat Retention Policies in the Amazon Chime Administration Guide.

Request Syntax
PUT /accounts/accountId/retention-settings HTTP/1.1
Content-type: application/json

{
"RetentionSettings": {
"ConversationRetentionSettings": {
"RetentionDays": number
},
"RoomRetentionSettings": {
"RetentionDays": number
}
}
}

URI Request Parameters

The request uses the following URI parameters.

accountId (p. 445)

The Amazon Chime account ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

RetentionSettings (p. 445)

The retention settings.

Type: RetentionSettings (p. 1184) object

Required: Yes

Response Syntax
HTTP/1.1 204
Content-type: application/json

445
 Amazon Chime SDK API Reference
PutRetentionSettings

{
"InitiateDeletionTimestamp": number,
"RetentionSettings": {
"ConversationRetentionSettings": {
"RetentionDays": number
},
"RoomRetentionSettings": {
"RetentionDays": number
}
}
}

Response Elements
If the action is successful, the service sends back an HTTP 204 response.

The following data is returned in JSON format by the service.

InitiateDeletionTimestamp (p. 445)

The timestamp representing the time at which the specified items are permanently deleted, in ISO
8601 format.

Type: Timestamp
RetentionSettings (p. 445)

The retention settings.

Type: RetentionSettings (p. 1184) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

446
 Amazon Chime SDK API Reference
PutRetentionSettings

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

447
 Amazon Chime SDK API Reference
PutSipMediaApplicationLoggingConfiguration

PutSipMediaApplicationLoggingConfiguration
Service: Amazon Chime

Updates the logging configuration for the specified SIP media application.

Request Syntax
PUT /sip-media-applications/sipMediaApplicationId/logging-configuration HTTP/1.1
Content-type: application/json

{
"SipMediaApplicationLoggingConfiguration": {
"EnableSipMediaApplicationMessageLogs": boolean
}
}

URI Request Parameters

The request uses the following URI parameters.

sipMediaApplicationId (p. 448)

The SIP media application ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

SipMediaApplicationLoggingConfiguration (p. 448)

The actual logging configuration.

Type: SipMediaApplicationLoggingConfiguration (p. 1196) object

Required: No

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"SipMediaApplicationLoggingConfiguration": {
"EnableSipMediaApplicationMessageLogs": boolean
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

448
 Amazon Chime SDK API Reference
PutSipMediaApplicationLoggingConfiguration

The following data is returned in JSON format by the service.

SipMediaApplicationLoggingConfiguration (p. 448)

The logging configuration of the SIP media application.

Type: SipMediaApplicationLoggingConfiguration (p. 1196) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go

449
 Amazon Chime SDK API Reference
PutSipMediaApplicationLoggingConfiguration

• AWS SDK for Java V2

• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

450
 Amazon Chime SDK API Reference
PutVoiceConnectorEmergencyCallingConfiguration

PutVoiceConnectorEmergencyCallingConfiguration
Service: Amazon Chime

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.

Request Syntax
PUT /voice-connectors/voiceConnectorId/emergency-calling-configuration HTTP/1.1
Content-type: application/json

{
"EmergencyCallingConfiguration": {
"DNIS": [
{
"CallingCountry": "string",
"EmergencyPhoneNumber": "string",
"TestPhoneNumber": "string"
}
]
}
}

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId (p. 451)

The Amazon Chime Voice Connector ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

EmergencyCallingConfiguration (p. 451)

The emergency calling configuration details.

Type: EmergencyCallingConfiguration (p. 1143) object

Required: Yes

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"EmergencyCallingConfiguration": {
"DNIS": [

451
 Amazon Chime SDK API Reference
PutVoiceConnectorEmergencyCallingConfiguration

{
"CallingCountry": "string",
"EmergencyPhoneNumber": "string",
"TestPhoneNumber": "string"
}
]
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

EmergencyCallingConfiguration (p. 451)

The emergency calling configuration details.

Type: EmergencyCallingConfiguration (p. 1143) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

452
 Amazon Chime SDK API Reference
PutVoiceConnectorEmergencyCallingConfiguration

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

453
 Amazon Chime SDK API Reference
PutVoiceConnectorLoggingConfiguration

PutVoiceConnectorLoggingConfiguration
Service: Amazon Chime

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.

Request Syntax
PUT /voice-connectors/voiceConnectorId/logging-configuration HTTP/1.1
Content-type: application/json

{
"LoggingConfiguration": {
"EnableMediaMetricLogs": boolean,
"EnableSIPLogs": boolean
}
}

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId (p. 454)

The Amazon Chime Voice Connector ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

LoggingConfiguration (p. 454)

The logging configuration details to add.

Type: LoggingConfiguration (p. 1153) object

Required: Yes

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"LoggingConfiguration": {
"EnableMediaMetricLogs": boolean,
"EnableSIPLogs": boolean
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

454
 Amazon Chime SDK API Reference
PutVoiceConnectorLoggingConfiguration

The following data is returned in JSON format by the service.

LoggingConfiguration (p. 454)

The updated logging configuration details.

Type: LoggingConfiguration (p. 1153) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these

455
 Amazon Chime SDK API Reference
PutVoiceConnectorLoggingConfiguration

tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example turns on the SIP logging configuration for the specified Amazon Chime Voice Connector.

Sample Request

PUT /voice-connectors/abcdef1ghij2klmno3pqr4/logging-configuration HTTP/1.1 Host:

service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.170
Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-Date: 20191028T190315Z Authorization:
AUTHPARAMS Content-Length: 49 {"LoggingConfiguration": {"EnableSIPLogs": true}}

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 7e671d10-67f8-44cd-bd32-8154a56ef505 Content-Type:

application/json Content-Length: 47 Date: Mon, 28 Oct 2019 19:03:14 GMT Connection: keep-
alive {"LoggingConfiguration":{"EnableSIPLogs":true}}

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

456
 Amazon Chime SDK API Reference
PutVoiceConnectorOrigination

PutVoiceConnectorOrigination
Service: Amazon Chime

Adds origination settings for the specified Amazon Chime Voice Connector.
Note
If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted
prior to turning off origination settings.

Request Syntax
PUT /voice-connectors/voiceConnectorId/origination HTTP/1.1
Content-type: application/json

{
"Origination": {
"Disabled": boolean,
"Routes": [
{
"Host": "string",
"Port": number,
"Priority": number,
"Protocol": "string",
"Weight": number
}
]
}
}

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId (p. 457)

The Amazon Chime Voice Connector ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

Origination (p. 457)

The origination setting details to add.

Type: Origination (p. 1166) object

Required: Yes

Response Syntax
HTTP/1.1 200

457
 Amazon Chime SDK API Reference
PutVoiceConnectorOrigination

Content-type: application/json

{
"Origination": {
"Disabled": boolean,
"Routes": [
{
"Host": "string",
"Port": number,
"Priority": number,
"Protocol": "string",
"Weight": number
}
]
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Origination (p. 457)

The updated origination setting details.

Type: Origination (p. 1166) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

458
 Amazon Chime SDK API Reference
PutVoiceConnectorOrigination

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example adds origination settings for the specified Amazon Chime Voice Connector.

Sample Request

PUT /voice-connectors/abcdef1ghij2klmno3pqr4/origination HTTP/1.1 Host:

service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.170
Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-Date: 20190819T225632Z Authorization:
AUTHPARAMS Content-Length: 135 {"Origination": {"Routes": [{"Host": "10.24.34.0", "Port":
1234, "Protocol": "TCP", "Priority": 1, "Weight": 5}], "Disabled": false}}

Sample Response

Response: HTTP/1.1 200 OK x-amzn-RequestId: d3553710-2dee-4b18-afd1-903aa88d53be

Content-Type: application/json Content-Length: 122 Date: Mon, 19 Aug 2019
22:56:33 GMT Connection: keep-alive {"Origination":{"Disabled":false,"Routes":
[{"Host":"10.24.34.0","Port":1234,"Priority":1,"Protocol":"TCP","Weight":5}]}}

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

459
Amazon Chime SDK API Reference
PutVoiceConnectorOrigination

460
 Amazon Chime SDK API Reference
PutVoiceConnectorProxy

PutVoiceConnectorProxy
Service: Amazon Chime

Puts the specified proxy configuration to the specified Amazon Chime Voice Connector.

Request Syntax
PUT /voice-connectors/voiceConnectorId/programmable-numbers/proxy HTTP/1.1
Content-type: application/json

{
"DefaultSessionExpiryMinutes": number,
"Disabled": boolean,
"FallBackPhoneNumber": "string",
"PhoneNumberPoolCountries": [ "string" ]
}

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId (p. 461)

The Amazon Chime voice connector ID.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

DefaultSessionExpiryMinutes (p. 461)

The default number of minutes allowed for proxy sessions.

Type: Integer

Required: Yes
Disabled (p. 461)

When true, stops proxy sessions from being created on the specified Amazon Chime Voice
Connector.

Type: Boolean

Required: No
FallBackPhoneNumber (p. 461)

The phone number to route calls to after a proxy session expires.

Type: String

Pattern: ^\+?[1-9]\d{1,14}$

461
 Amazon Chime SDK API Reference
PutVoiceConnectorProxy

Required: No
PhoneNumberPoolCountries (p. 461)

The countries for proxy phone numbers to be selected from.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Pattern: ^$|^[A-Z]{2,2}$

Required: Yes

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"Proxy": {
"DefaultSessionExpiryMinutes": number,
"Disabled": boolean,
"FallBackPhoneNumber": "string",
"PhoneNumberCountries": [ "string" ]
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Proxy (p. 462)

The proxy configuration details.

Type: Proxy (p. 1180) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

AccessDeniedException

You don't have permissions to perform the requested operation.

HTTP Status Code: 403

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

462
 Amazon Chime SDK API Reference
PutVoiceConnectorProxy

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example puts a proxy configuration to your Amazon Chime Voice Connector.

Sample Request

PUT /voice-connectors/abcdef1ghij2klmno3pqr4/programmable-numbers/proxy HTTP/1.1

Host: service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-
cli/1.18.39 Python/3.8.0 Windows/10 botocore/1.15.39 X-Amz-Date: 20200415T160418Z
Authorization: AUTHPARAMS Content-Length: 71 {"DefaultSessionExpiryMinutes": 60,
"PhoneNumberPoolCountries": ["US"]}

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 9f80051f-62b3-43d5-9630-

bc28c098255b Content-Type: application/json Content-Length: 118
Date: Wed, 15 Apr 2020 16:04:19 GMT Connection: keep-alive {"Proxy":
{"DefaultSessionExpiryMinutes":60,"Disabled":false,"FallBackPhoneNumber":null,"PhoneNumberCountries":
["US"]}}

463
 Amazon Chime SDK API Reference
PutVoiceConnectorProxy

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

464
 Amazon Chime SDK API Reference
PutVoiceConnectorStreamingConfiguration

PutVoiceConnectorStreamingConfiguration
Service: Amazon Chime

Adds a streaming configuration for the specified Amazon Chime Voice Connector. The streaming
configuration specifies whether media streaming is enabled for sending to Kinesis. It also sets the
retention period, in hours, for the Amazon Kinesis data.

Request Syntax
PUT /voice-connectors/voiceConnectorId/streaming-configuration HTTP/1.1
Content-type: application/json

{
"StreamingConfiguration": {
"DataRetentionInHours": number,
"Disabled": boolean,
"StreamingNotificationTargets": [
{
"NotificationTarget": "string"
}
]
}
}

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId (p. 465)

The Amazon Chime Voice Connector ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

StreamingConfiguration (p. 465)

The streaming configuration details to add.

Type: StreamingConfiguration (p. 1201) object

Required: Yes

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"StreamingConfiguration": {
"DataRetentionInHours": number,

465
 Amazon Chime SDK API Reference
PutVoiceConnectorStreamingConfiguration

"Disabled": boolean,
"StreamingNotificationTargets": [
{
"NotificationTarget": "string"
}
]
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

StreamingConfiguration (p. 465)

The updated streaming configuration details.

Type: StreamingConfiguration (p. 1201) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

466
 Amazon Chime SDK API Reference
PutVoiceConnectorStreamingConfiguration

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example adds a streaming configuration for the specified Amazon Chime Voice Connector.

Sample Request

PUT /voice-connectors/abcdef1ghij2klmno3pqr4/streaming-configuration HTTP/1.1 Host:

service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.170
Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-Date: 20190918T161659Z Authorization:
AUTHPARAMS Content-Length: 75 {"StreamingConfiguration": {"DataRetentionInHours": 24,
"Disabled": false}}

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 9ac21e90-1aae-40f2-b4c4-4e7be37b8a97 Content-Type:

application/json Content-Length: 71 Date: Wed, 18 Sep 2019 16:16:59 GMT Connection: keep-
alive {"StreamingConfiguration":{"DataRetentionInHours":24,"Disabled":false}}

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

467
 Amazon Chime SDK API Reference
PutVoiceConnectorTermination

PutVoiceConnectorTermination
Service: Amazon Chime

Adds termination settings for the specified Amazon Chime Voice Connector.
Note
If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted
prior to turning off termination settings.

Request Syntax
PUT /voice-connectors/voiceConnectorId/termination HTTP/1.1
Content-type: application/json

{
"Termination": {
"CallingRegions": [ "string" ],
"CidrAllowedList": [ "string" ],
"CpsLimit": number,
"DefaultPhoneNumber": "string",
"Disabled": boolean
}
}

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId (p. 468)

The Amazon Chime Voice Connector ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

Termination (p. 468)

The termination setting details to add.

Type: Termination (p. 1205) object

Required: Yes

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"Termination": {
"CallingRegions": [ "string" ],

468
 Amazon Chime SDK API Reference
PutVoiceConnectorTermination

"CidrAllowedList": [ "string" ],
"CpsLimit": number,
"DefaultPhoneNumber": "string",
"Disabled": boolean
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Termination (p. 468)

The updated termination setting details.

Type: Termination (p. 1205) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

AccessDeniedException

You don't have permissions to perform the requested operation.

HTTP Status Code: 403

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

469
 Amazon Chime SDK API Reference
PutVoiceConnectorTermination

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example adds termination settings for the specified Amazon Chime Voice Connector.

Sample Request

PUT /voice-connectors/abcdef1ghij2klmno3pqr4/termination HTTP/1.1 Host:

service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.170
Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-Date: 20190823T183759Z Authorization:
AUTHPARAMS Content-Length: 102 {"Termination": {"CallingRegions": ["US"],
"CidrAllowedList": ["10.24.34.0/23"], "Disabled": false}}

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 0620afeb-9691-4049-b650-22a57c138c69 Content-

Type: application/json Content-Length: 135 Date: Fri, 23 Aug 2019 18:38:00 GMT
Connection: keep-alive {"Termination":{"CallingRegions":["US"],"CidrAllowedList":
["10.24.34.0/23"],"CpsLimit":0,"DefaultPhoneNumber":null,"Disabled":false}}

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

470
 Amazon Chime SDK API Reference
PutVoiceConnectorTerminationCredentials

PutVoiceConnectorTerminationCredentials
Service: Amazon Chime

Adds termination SIP credentials for the specified Amazon Chime Voice Connector.

Request Syntax
POST /voice-connectors/voiceConnectorId/termination/credentials?operation=put HTTP/1.1
Content-type: application/json

{
"Credentials": [
{
"Password": "string",
"Username": "string"
}
]
}

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId (p. 471)

The Amazon Chime Voice Connector ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

Credentials (p. 471)

The termination SIP credentials.

Type: Array of Credential (p. 1141) objects

Required: No

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

471
 Amazon Chime SDK API Reference
PutVoiceConnectorTerminationCredentials

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example adds termination SIP credentials for the specified Amazon Chime Voice Connector.

Sample Request

POST /voice-connectors/abcdef1ghij2klmno3pqr4/termination/credentials?operation=put
HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-
cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-Date: 20190823T184245Z
Authorization: AUTHPARAMS Content-Length: 70 {"Credentials": [{"Username": "jdoe",
"Password": "XXXXXXXX"}]}

472
 Amazon Chime SDK API Reference
PutVoiceConnectorTerminationCredentials

Sample Response

HTTP/1.1 204 No Content x-amzn-RequestId: c3db83bc-2ecf-4442-93c5-b68d8c0c7fcc Content-

Type: application/json Date: Fri, 23 Aug 2019 18:42:45 GMT Connection: keep-alive

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

473
 Amazon Chime SDK API Reference
RedactChannelMessage

RedactChannelMessage
Service: Amazon Chime

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.
Note
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.

Request Syntax
POST /channels/channelArn/messages/{messageId}?operation=redact HTTP/1.1
x-amz-chime-bearer: ChimeBearer

URI Request Parameters

The request uses the following URI parameters.

channelArn (p. 474)

The ARN of the channel containing the messages that you want to redact.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 474)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}
messageId (p. 474)

The ID of the message being redacted.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [-_a-zA-Z0-9]*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

474
 Amazon Chime SDK API Reference
RedactChannelMessage

{
"ChannelArn": "string",
"MessageId": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ChannelArn (p. 474)

The ARN of the channel containing the messages that you want to redact.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}
MessageId (p. 474)

The ID of the message being redacted.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [-_a-zA-Z0-9]*

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

475
 Amazon Chime SDK API Reference
RedactChannelMessage

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

476
 Amazon Chime SDK API Reference
RedactConversationMessage

RedactConversationMessage
Service: Amazon Chime

Redacts the specified message from the specified Amazon Chime conversation.

Request Syntax
POST /accounts/accountId/conversations/conversationId/messages/{messageId}?operation=redact
HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

accountId (p. 477)

The Amazon Chime account ID.

Pattern: .*\S.*

Required: Yes
conversationId (p. 477)

The conversation ID.

Pattern: .*\S.*

Required: Yes
messageId (p. 477)

The message ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200

Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

477
 Amazon Chime SDK API Reference
RedactConversationMessage

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

478
 Amazon Chime SDK API Reference
RedactRoomMessage

RedactRoomMessage
Service: Amazon Chime

Redacts the specified message from the specified Amazon Chime channel.

Request Syntax
POST /accounts/accountId/rooms/roomId/messages/{messageId}?operation=redact HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

accountId (p. 479)

The Amazon Chime account ID.

Pattern: .*\S.*

Required: Yes
messageId (p. 479)

The message ID.

Pattern: .*\S.*

Required: Yes
roomId (p. 479)

The room ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200

Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

479
 Amazon Chime SDK API Reference
RedactRoomMessage

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

480
 Amazon Chime SDK API Reference
RegenerateSecurityToken

RegenerateSecurityToken
Service: Amazon Chime

Regenerates the security token for a bot.

Request Syntax
POST /accounts/accountId/bots/{botId}?operation=regenerate-security-token HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

accountId (p. 481)

The Amazon Chime account ID.

Pattern: .*\S.*

Required: Yes
botId (p. 481)

The bot ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"Bot": {
"BotEmail": "string",
"BotId": "string",
"BotType": "string",
"CreatedTimestamp": number,
"Disabled": boolean,
"DisplayName": "string",
"SecurityToken": "string",
"UpdatedTimestamp": number,
"UserId": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

481
 Amazon Chime SDK API Reference
RegenerateSecurityToken

Bot (p. 481)

A resource that allows Enterprise account administrators to configure an interface that receives
events from Amazon Chime.

Type: Bot (p. 1113) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

482
 Amazon Chime SDK API Reference
RegenerateSecurityToken

Example
This example regenerates the security token for the specified bot.

Sample Request

POST /accounts/12a3456b-7c89-012d-3456-78901e23fg45/
bots/123abcd4-5ef6-789g-0h12-34j56789012k?operation=regenerate-security-token HTTP/1.1
Host: service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.170
Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-Date: 20190918T173015Z Authorization:
AUTHPARAMS Content-Length: 0

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 0c755efb-46f9-4d5a-84b0-55f7b254ed7d

Content-Type: application/json Content-Length: 374 Date:
Wed, 18 Sep 2019 17:30:16 GMT Connection: keep-alive {"Bot":
{"BotEmail":"[email protected]","BotId":"123abcd4-5ef6-789g-0h12-34j56789012k","BotType":"ChatBot","Cre
(Bot)","SecurityToken":"je7MtGbClwBF/2Zp9Utk/
h3yCo8nvbEXAMPLEKEY","UpdatedTimestamp":"2019-09-18T17:24:39.534Z","UserId":"123abcd4-5ef6-789g-0h12-34

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

483
 Amazon Chime SDK API Reference
ResetPersonalPIN

ResetPersonalPIN
Service: Amazon Chime

Resets the personal meeting PIN for the specified user on an Amazon Chime account. Returns the
User (p. 1211) object with the updated personal meeting PIN.

Request Syntax
POST /accounts/accountId/users/{userId}?operation=reset-personal-pin HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

accountId (p. 484)

The Amazon Chime account ID.

Pattern: .*\S.*

Required: Yes
userId (p. 484)

The user ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"User": {
"AccountId": "string",
"AlexaForBusinessMetadata": {
"AlexaForBusinessRoomArn": "string",
"IsAlexaForBusinessEnabled": boolean
},
"DisplayName": "string",
"InvitedOn": number,
"LicenseType": "string",
"PersonalPIN": "string",
"PrimaryEmail": "string",
"PrimaryProvisionedNumber": "string",
"RegisteredOn": number,
"UserId": "string",
"UserInvitationStatus": "string",
"UserRegistrationStatus": "string",
"UserType": "string"
}
}

484
 Amazon Chime SDK API Reference
ResetPersonalPIN

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

User (p. 484)

The user details and new personal meeting PIN.

Type: User (p. 1211) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

485
 Amazon Chime SDK API Reference
ResetPersonalPIN

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example resets the personal meeting PIN for the specified user.

Sample Request

POST /console/accounts/12a3456b-7c89-012d-3456-78901e23fg45/users/1ab2345c-67de-8901-
f23g-45h678901j2k?operation=reset-personal-pin HTTP/1.1 Host: service.chime.aws.amazon.com
Accept-Encoding: identity User-Agent: aws-cli/1.16.83 Python/3.6.6 Windows/10
botocore/1.12.73 X-Amz-Date: 20190108T181048Z Authorization: AUTHPARAMS Content-Length: 0

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: a0033e1d-41aa-4030-8f52-ded7ebcf34bd Content-Type:

application/json Content-Length: 558 Date: Tue, 08 Jan 2019 18:10:48 GMT Connection:
keep-alive {"User": {"AccountId": "12a3456b-7c89-012d-3456-78901e23fg45","Delegates":
null,"Devices": null,"DisplayName": "user1 user1","EmailAlias": [],"FullName":
"user1 user1","InvitedOn": null,"IsProTrial": false,"LastActiveOn":
null,"LicenseType": "Pro","PersonalPIN": "XXXXXXXXXX","PresenceVisibility":
null,"PrimaryEmail": "[email protected]","PrimaryProvisionedNumber":
null,"RegisteredOn": "2018-12-20T18:45:25.231Z","UserId": "1ab2345c-67de-8901-
f23g-45h678901j2k","UserInvitationStatus": null,"UserLocale":
null,"UserRegistrationStatus": "Registered","Vanity": null} }

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

486
 Amazon Chime SDK API Reference
RestorePhoneNumber

RestorePhoneNumber
Service: Amazon Chime

Moves a phone number from the Deletion queue back into the phone number Inventory.

Request Syntax
POST /phone-numbers/{phoneNumberId}?operation=restore HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

phoneNumberId (p. 487)

The phone number.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"PhoneNumber": {
"Associations": [
{
"AssociatedTimestamp": number,
"Name": "string",
"Value": "string"
}
],
"CallingName": "string",
"CallingNameStatus": "string",
"Capabilities": {
"InboundCall": boolean,
"InboundMMS": boolean,
"InboundSMS": boolean,
"OutboundCall": boolean,
"OutboundMMS": boolean,
"OutboundSMS": boolean
},
"Country": "string",
"CreatedTimestamp": number,
"DeletionTimestamp": number,
"E164PhoneNumber": "string",
"PhoneNumberId": "string",
"ProductType": "string",
"Status": "string",
"Type": "string",
"UpdatedTimestamp": number

487
 Amazon Chime SDK API Reference
RestorePhoneNumber

}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

PhoneNumber (p. 487)

The phone number details.

Type: PhoneNumber (p. 1170) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

488
 Amazon Chime SDK API Reference
RestorePhoneNumber

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example moves the specified phone number from the Deletion queue back into the phone number
Inventory.

Sample Request

POST /phone-numbers/%2B12065550100?operation=restore HTTP/1.1 Host:

service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.170
Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-Date: 20190918T182510Z Authorization:
AUTHPARAMS Content-Length: 0

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 3fb42323-1231-4034-8fbb-4a6f89d189ea

Content-Type: application/json Content-Length: 460 Date: Wed, 18 Sep
2019 18:25:10 GMT Connection: keep-alive {"PhoneNumber":{"Associations":
[],"CallingName":myBusiness,"CallingNameStatus":UpdateSucceeded,"Capabilities":
{"InboundCall":true,"InboundMMS":true,"InboundSMS":true,"OutboundCall":true,"OutboundMMS":true,"Outboun
Connector","Status":"Unassigned","Type":"Local","UpdatedTimestamp":"2019-09-18T18:25:10.866Z"}}

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

489
 Amazon Chime SDK API Reference
SearchAvailablePhoneNumbers

SearchAvailablePhoneNumbers
Service: Amazon Chime

Searches for phone numbers that can be ordered. For US numbers, provide at least one of the following
search filters: AreaCode, City, State, or TollFreePrefix. If you provide City, you must also provide
State. Numbers outside the US only support the PhoneNumberType filter, which you must use.

Request Syntax
GET /search?type=phone-numbers&area-code=AreaCode&city=City&country=Country&max-
results=MaxResults&next-token=NextToken&phone-number-type=PhoneNumberType&state=State&toll-
free-prefix=TollFreePrefix HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

AreaCode (p. 490)

The area code used to filter results. Only applies to the US.
City (p. 490)

The city used to filter results. Only applies to the US.

Country (p. 490)

The country used to filter results. Defaults to the US Format: ISO 3166-1 alpha-2.

Pattern: [A-Z]{2}
MaxResults (p. 490)

The maximum number of results to return in a single call.

Valid Range: Minimum value of 1. Maximum value of 500.

NextToken (p. 490)

The token used to retrieve the next page of results.

PhoneNumberType (p. 490)

The phone number type used to filter results. Required for non-US numbers.

Valid Values: Local | TollFree

State (p. 490)

The state used to filter results. Required only if you provide City. Only applies to the US.
TollFreePrefix (p. 490)

The toll-free prefix that you use to filter results. Only applies to the US.

Length Constraints: Fixed length of 3.

Pattern: ^8(00|33|44|55|66|77|88)$

Request Body
The request does not have a request body.

490
 Amazon Chime SDK API Reference
SearchAvailablePhoneNumbers

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"E164PhoneNumbers": [ "string" ],
"NextToken": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

E164PhoneNumbers (p. 491)

List of phone numbers, in E.164 format.

Type: Array of strings

Pattern: ^\+?[1-9]\d{1,14}$
NextToken (p. 491)

The token used to retrieve the next page of search results.

Type: String

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

AccessDeniedException

You don't have permissions to perform the requested operation.

HTTP Status Code: 403

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

491
 Amazon Chime SDK API Reference
SearchAvailablePhoneNumbers

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following examples, the Authorization header contents (AUTHPARAMS) must be replaced with an
AWS Signature Version 4 signature. For more information about creating these signatures, see Signature
Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example searches for phone numbers with an area code of 206.

Sample Request

GET /search?type=phone-numbers&area-code=206 HTTP/1.1 Host: service.chime.aws.amazon.com

Accept-Encoding: identity User-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10
botocore/1.12.160 X-Amz-Date: 20190918T180157Z Authorization: AUTHPARAMS

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 98bb7b5b-0f5b-48c3-a959-ab0d7fd42b97 Content-Type:

application/json Content-Length: 1522 Date: Wed, 18 Sep 2019 18:01:57 GMT Connection:
keep-alive {"E164PhoneNumbers":["+12065550100","+12065550101","+12065550102"],
"NextToken": null}

Example
This example searches local phone numbers in the United Kingdom.

Sample Request

GET /search?type=phone-numbers&country=GB&phone-number-type=Local HTTP/1.1 Host:

service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.170
Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-Date: 20210224T201356Z Authorization:
AUTHPARAMS

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 86b1ec89-b95b-47de-bd67-92c6d778bbd5 Content-Type:

application/json Content-Length: 1522 Date: Wed, 24 Feb 2021 20:13:56 GMT Connection:

492
 Amazon Chime SDK API Reference
SearchAvailablePhoneNumbers

keep-alive {"E164PhoneNumbers":["+442012345677","+442012345678","+442012345679"],
"NextToken": null}

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

493
 Amazon Chime SDK API Reference
SendChannelMessage

SendChannelMessage
Service: Amazon Chime

Sends a message to a particular channel that the member is a part of.

Note
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.
Also, STANDARD messages can contain 4KB of data and the 1KB of metadata. CONTROL
messages can contain 30 bytes of data and no metadata.

Request Syntax
POST /channels/channelArn/messages HTTP/1.1
x-amz-chime-bearer: ChimeBearer
Content-type: application/json

{
"ClientRequestToken": "string",
"Content": "string",
"Metadata": "string",
"Persistence": "string",
"Type": "string"
}

URI Request Parameters

The request uses the following URI parameters.

channelArn (p. 494)

The ARN of the channel.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 494)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Request Body
The request accepts the following data in JSON format.

ClientRequestToken (p. 494)

The Idempotency token for each client request.

Type: String

494
 Amazon Chime SDK API Reference
SendChannelMessage

Length Constraints: Minimum length of 2. Maximum length of 64.

Pattern: [-_a-zA-Z0-9]*

Required: Yes
Content (p. 494)

The content of the message.

Type: String

Length Constraints: Minimum length of 1.

Pattern: [\s\S]*

Required: Yes
Metadata (p. 494)

The optional metadata for each message.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: .*

Required: No
Persistence (p. 494)

Boolean that controls whether the message is persisted on the back end. Required.

Type: String

Valid Values: PERSISTENT | NON_PERSISTENT

Required: Yes
Type (p. 494)

The type of message, STANDARD or CONTROL.

Type: String

Valid Values: STANDARD | CONTROL

Required: Yes

Response Syntax
HTTP/1.1 201
Content-type: application/json

{
"ChannelArn": "string",
"MessageId": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

495
 Amazon Chime SDK API Reference
SendChannelMessage

The following data is returned in JSON format by the service.

ChannelArn (p. 495)

The ARN of the channel.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}
MessageId (p. 495)

The ID string assigned to each message.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [-_a-zA-Z0-9]*

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

496
 Amazon Chime SDK API Reference
SendChannelMessage

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

497
 Amazon Chime SDK API Reference
StartMeetingTranscription

StartMeetingTranscription
Service: Amazon Chime

Starts transcription for the specified meetingId.

Request Syntax
POST /meetings/meetingId/transcription?operation=start HTTP/1.1
Content-type: application/json

{
"TranscriptionConfiguration": {
"EngineTranscribeMedicalSettings": {
"ContentIdentificationType": "string",
"LanguageCode": "string",
"Region": "string",
"Specialty": "string",
"Type": "string",
"VocabularyName": "string"
},
"EngineTranscribeSettings": {
"ContentIdentificationType": "string",
"ContentRedactionType": "string",
"EnablePartialResultsStabilization": boolean,
"LanguageCode": "string",
"LanguageModelName": "string",
"PartialResultsStability": "string",
"PiiEntityTypes": "string",
"Region": "string",
"VocabularyFilterMethod": "string",
"VocabularyFilterName": "string",
"VocabularyName": "string"
}
}
}

URI Request Parameters

The request uses the following URI parameters.

meetingId (p. 498)

The unique ID of the meeting being transcribed.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: Yes

Request Body
The request accepts the following data in JSON format.

TranscriptionConfiguration (p. 498)

The configuration for the current transcription operation. Must contain

EngineTranscribeSettings or EngineTranscribeMedicalSettings.

Type: TranscriptionConfiguration (p. 1208) object

498
 Amazon Chime SDK API Reference
StartMeetingTranscription

Required: Yes

Response Syntax
HTTP/1.1 200

Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

UnprocessableEntityException

The request was well-formed but was unable to be followed due to semantic errors.

499
 Amazon Chime SDK API Reference
StartMeetingTranscription

HTTP Status Code: 422

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

500
 Amazon Chime SDK API Reference
StopMeetingTranscription

StopMeetingTranscription
Service: Amazon Chime

Stops transcription for the specified meetingId.

Request Syntax
POST /meetings/meetingId/transcription?operation=stop HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

meetingId (p. 501)

The unique ID of the meeting for which you stop transcription.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200

Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

501
 Amazon Chime SDK API Reference
StopMeetingTranscription

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

UnprocessableEntityException

The request was well-formed but was unable to be followed due to semantic errors.

HTTP Status Code: 422

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

502
 Amazon Chime SDK API Reference
TagAttendee

TagAttendee
Service: Amazon Chime

Applies the specified tags to the specified Amazon Chime SDK attendee.

Request Syntax
POST /meetings/meetingId/attendees/attendeeId/tags?operation=add HTTP/1.1
Content-type: application/json

{
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}

URI Request Parameters

The request uses the following URI parameters.

attendeeId (p. 503)

The Amazon Chime SDK attendee ID.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: Yes
meetingId (p. 503)

The Amazon Chime SDK meeting ID.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: Yes

Request Body
The request accepts the following data in JSON format.

Tags (p. 503)

The tag key-value pairs.

Type: Array of Tag (p. 1203) objects

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Required: Yes

Response Syntax
HTTP/1.1 204

503
 Amazon Chime SDK API Reference
TagAttendee

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++

504
 Amazon Chime SDK API Reference
TagAttendee

• AWS SDK for Go

• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

505
 Amazon Chime SDK API Reference
TagMeeting

TagMeeting
Service: Amazon Chime

Applies the specified tags to the specified Amazon Chime SDK meeting.

Request Syntax
POST /meetings/meetingId/tags?operation=add HTTP/1.1
Content-type: application/json

{
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}

URI Request Parameters

The request uses the following URI parameters.

meetingId (p. 506)

The Amazon Chime SDK meeting ID.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: Yes

Request Body
The request accepts the following data in JSON format.

Tags (p. 506)

The tag key-value pairs.

Type: Array of Tag (p. 1203) objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Required: Yes

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

506
 Amazon Chime SDK API Reference
TagMeeting

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

507
 Amazon Chime SDK API Reference
TagResource

TagResource
Service: Amazon Chime

Applies the specified tags to the specified Amazon Chime SDK meeting resource.

Request Syntax
POST /tags?operation=tag-resource HTTP/1.1
Content-type: application/json

{
"ResourceARN": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

ResourceARN (p. 508)

The resource ARN.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^arn[\/\:\-\_\.a-zA-Z0-9]+$

Required: Yes
Tags (p. 508)

The tag key-value pairs.

Type: Array of Tag (p. 1203) objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Required: Yes

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

508
 Amazon Chime SDK API Reference
TagResource

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

509
 Amazon Chime SDK API Reference
UntagAttendee

UntagAttendee
Service: Amazon Chime

Untags the specified tags from the specified Amazon Chime SDK attendee.

Request Syntax
POST /meetings/meetingId/attendees/attendeeId/tags?operation=delete HTTP/1.1
Content-type: application/json

{
"TagKeys": [ "string" ]
}

URI Request Parameters

The request uses the following URI parameters.

attendeeId (p. 510)

The Amazon Chime SDK attendee ID.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: Yes
meetingId (p. 510)

The Amazon Chime SDK meeting ID.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: Yes

Request Body
The request accepts the following data in JSON format.

TagKeys (p. 510)

The tag keys.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: Yes

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

510
 Amazon Chime SDK API Reference
UntagAttendee

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

511
 Amazon Chime SDK API Reference
UntagMeeting

UntagMeeting
Service: Amazon Chime

Untags the specified tags from the specified Amazon Chime SDK meeting.

Request Syntax
POST /meetings/meetingId/tags?operation=delete HTTP/1.1
Content-type: application/json

{
"TagKeys": [ "string" ]
}

URI Request Parameters

The request uses the following URI parameters.

meetingId (p. 512)

The Amazon Chime SDK meeting ID.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: Yes

Request Body
The request accepts the following data in JSON format.

TagKeys (p. 512)

The tag keys.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: Yes

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

512
 Amazon Chime SDK API Reference
UntagMeeting

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

513
 Amazon Chime SDK API Reference
UntagResource

UntagResource
Service: Amazon Chime

Untags the specified tags from the specified Amazon Chime SDK meeting resource.

Request Syntax
POST /tags?operation=untag-resource HTTP/1.1
Content-type: application/json

{
"ResourceARN": "string",
"TagKeys": [ "string" ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

ResourceARN (p. 514)

The resource ARN.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^arn[\/\:\-\_\.a-zA-Z0-9]+$

Required: Yes
TagKeys (p. 514)

The tag keys.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: Yes

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

514
 Amazon Chime SDK API Reference
UntagResource

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

515
 Amazon Chime SDK API Reference
UpdateAccount

UpdateAccount
Service: Amazon Chime

Updates account details for the specified Amazon Chime account. Currently, only account name and
default license updates are supported for this action.

Request Syntax
POST /accounts/accountId HTTP/1.1
Content-type: application/json

{
"DefaultLicense": "string",
"Name": "string"
}

URI Request Parameters

The request uses the following URI parameters.

accountId (p. 516)

The Amazon Chime account ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

DefaultLicense (p. 516)

The default license applied when you add users to an Amazon Chime account.

Type: String

Valid Values: Basic | Plus | Pro | ProTrial

Required: No
Name (p. 516)

The new name for the specified Amazon Chime account.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: .*\S.*

Required: No

Response Syntax
HTTP/1.1 200

516
 Amazon Chime SDK API Reference
UpdateAccount

Content-type: application/json

{
"Account": {
"AccountId": "string",
"AccountStatus": "string",
"AccountType": "string",
"AwsAccountId": "string",
"CreatedTimestamp": number,
"DefaultLicense": "string",
"Name": "string",
"SigninDelegateGroups": [
{
"GroupName": "string"
}
],
"SupportedLicenses": [ "string" ]
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Account (p. 516)

The updated Amazon Chime account details.

Type: Account (p. 1091) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

517
 Amazon Chime SDK API Reference
UpdateAccount

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example updates the specified account name.

Sample Request

POST /console/accounts/12a3456b-7c89-012d-3456-78901e23fg45 HTTP/1.1 Host:

service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.83
Python/3.6.6 Windows/10 botocore/1.12.73 X-Amz-Date: 20190108T182558Z Authorization:
AUTHPARAMS Content-Length: 19 {"Name": "Example3"}

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 1cbd30b4-ee17-400a-ab81-4d1eb65783dc

Content-Type: application/json Content-Length: 424 Date: Tue, 08 Jan
2019 18:25:58 GMT Connection: keep-alive {"Account": {"AccountId":
"12a3456b-7c89-012d-3456-78901e23fg45","AccountStatus": "Active","AccountType":
"Team","Admins": null,"AwsAccountId": "111122223333","BillingType":
"SeatBilling","CreatedTimestamp": "2018-09-04T21:44:22.292Z","DefaultLicense":
"Pro","DelegationStatus": "NoDelegation","DirectoryId": null,"Domains":
null,"Groups": [],"Name": "Example3","Owner": null,"SupportedLicenses": ["Basic",
"Pro"],"UseProTrialLicense": false} }

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2

518
 Amazon Chime SDK API Reference
UpdateAccount

• AWS SDK for JavaScript

• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

519
 Amazon Chime SDK API Reference
UpdateAccountSettings

UpdateAccountSettings
Service: Amazon Chime

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 Use
the Policies Page in the Amazon Chime Administration Guide.

Request Syntax
PUT /accounts/accountId/settings HTTP/1.1
Content-type: application/json

{
"AccountSettings": {
"DisableRemoteControl": boolean,
"EnableDialOut": boolean
}
}

URI Request Parameters

The request uses the following URI parameters.

accountId (p. 520)

The Amazon Chime account ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

AccountSettings (p. 520)

The Amazon Chime account settings to update.

Type: AccountSettings (p. 1093) object

Required: Yes

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

520
 Amazon Chime SDK API Reference
UpdateAccountSettings

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example disables the remote control of shared screens for the specified Amazon Chime account.

521
 Amazon Chime SDK API Reference
UpdateAccountSettings

Sample Request

PUT /console/accounts/12a3456b-7c89-012d-3456-78901e23fg45/settings HTTP/1.1 Host:

service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.83
Python/3.6.6 Windows/10 botocore/1.12.73 X-Amz-Date: 20190108T182719Z Authorization:
AUTHPARAMS Content-Length: 51 {"AccountSettings": {"DisableRemoteControl": true}}

Sample Response

HTTP/1.1 204 No Content x-amzn-RequestId: f539839f-c426-4179-906d-28e297261d84 Content-

Type: application/json Date: Tue, 08 Jan 2019 18:27:20 GMT Connection: keep-alive

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

522
 Amazon Chime SDK API Reference
UpdateAppInstance

UpdateAppInstance
Service: Amazon Chime

Updates AppInstance metadata.

Request Syntax
PUT /app-instances/appInstanceArn HTTP/1.1
Content-type: application/json

{
"Metadata": "string",
"Name": "string"
}

URI Request Parameters

The request uses the following URI parameters.

appInstanceArn (p. 523)

The ARN of the AppInstance.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Request Body
The request accepts the following data in JSON format.

Metadata (p. 523)

The metadata that you want to change.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: .*

Required: No
Name (p. 523)

The name that you want to change.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD
\u10000-\u10FFFF]*

Required: Yes

523
 Amazon Chime SDK API Reference
UpdateAppInstance

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"AppInstanceArn": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AppInstanceArn (p. 524)

The ARN of the AppInstance.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

524
 Amazon Chime SDK API Reference
UpdateAppInstance

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

525
 Amazon Chime SDK API Reference
UpdateAppInstanceUser

UpdateAppInstanceUser
Service: Amazon Chime

Updates the details of an AppInstanceUser. You can update names and metadata.

Request Syntax
PUT /app-instance-users/appInstanceUserArn HTTP/1.1
Content-type: application/json

{
"Metadata": "string",
"Name": "string"
}

URI Request Parameters

The request uses the following URI parameters.

appInstanceUserArn (p. 526)

The ARN of the AppInstanceUser.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Request Body
The request accepts the following data in JSON format.

Metadata (p. 526)

The metadata of the AppInstanceUser.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: .*

Required: No
Name (p. 526)

The name of the AppInstanceUser.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: .*\S.*

Required: Yes

526
 Amazon Chime SDK API Reference
UpdateAppInstanceUser

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"AppInstanceUserArn": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AppInstanceUserArn (p. 527)

The ARN of the AppInstanceUser.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

527
 Amazon Chime SDK API Reference
UpdateAppInstanceUser

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

528
 Amazon Chime SDK API Reference
UpdateBot

UpdateBot
Service: Amazon Chime

Updates the status of the specified bot, such as starting or stopping the bot from running in your
Amazon Chime Enterprise account.

Request Syntax
POST /accounts/accountId/bots/botId HTTP/1.1
Content-type: application/json

{
"Disabled": boolean
}

URI Request Parameters

The request uses the following URI parameters.

accountId (p. 529)

The Amazon Chime account ID.

Pattern: .*\S.*

Required: Yes
botId (p. 529)

The bot ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

Disabled (p. 529)

When true, stops the specified bot from running in your account.

Type: Boolean

Required: No

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"Bot": {
"BotEmail": "string",
"BotId": "string",
"BotType": "string",

529
 Amazon Chime SDK API Reference
UpdateBot

"CreatedTimestamp": number,
"Disabled": boolean,
"DisplayName": "string",
"SecurityToken": "string",
"UpdatedTimestamp": number,
"UserId": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Bot (p. 529)

The updated bot details.

Type: Bot (p. 1113) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

530
 Amazon Chime SDK API Reference
UpdateBot

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example updates the status of the specified bot to stop it from running.

Sample Request

Update Bot API POST /accounts/12a3456b-7c89-012d-3456-78901e23fg45/

bots/123abcd4-5ef6-789g-0h12-34j56789012k HTTP/1.1 Host: service.chime.aws.amazon.com
Accept-Encoding: identity User-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10
botocore/1.12.160 X-Amz-Date: 20190918T173150Z Authorization: AUTHPARAMS Content-Length:
18 {"Disabled": true}

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 7848d673-79fd-4d76-b723-846eb238aeb6

Content-Type: application/json Content-Length: 373 Date:
Wed, 18 Sep 2019 17:31:51 GMT Connection: keep-alive {"Bot":
{"BotEmail":"[email protected]","BotId":"123abcd4-5ef6-789g-0h12-34j56789012k","BotType":"ChatBot","Cre
(Bot)","SecurityToken":"je7MtGbClwBF/2Zp9Utk/
h3yCo8nvbEXAMPLEKEY","UpdatedTimestamp":"2019-09-18T17:31:51.516Z","UserId":"123abcd4-5ef6-789g-0h12-34

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

531
 Amazon Chime SDK API Reference
UpdateChannel

UpdateChannel
Service: Amazon Chime

Update a channel's attributes.

Restriction: You can't change a channel's privacy.

Note
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.

Request Syntax
PUT /channels/channelArn HTTP/1.1
x-amz-chime-bearer: ChimeBearer
Content-type: application/json

{
"Metadata": "string",
"Mode": "string",
"Name": "string"
}

URI Request Parameters

The request uses the following URI parameters.

channelArn (p. 532)

The ARN of the channel.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 532)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Request Body
The request accepts the following data in JSON format.

Metadata (p. 532)

The metadata for the update request.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

532
 Amazon Chime SDK API Reference
UpdateChannel

Pattern: .*

Required: No
Mode (p. 532)

The mode of the update request.

Type: String

Valid Values: UNRESTRICTED | RESTRICTED

Required: Yes
Name (p. 532)

The name of the channel.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD
\u10000-\u10FFFF]*

Required: Yes

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"ChannelArn": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ChannelArn (p. 533)

The ARN of the channel.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

533
 Amazon Chime SDK API Reference
UpdateChannel

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

534
 Amazon Chime SDK API Reference
UpdateChannelMessage

UpdateChannelMessage
Service: Amazon Chime

Updates the content of a message.

Note
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.

Request Syntax
PUT /channels/channelArn/messages/messageId HTTP/1.1
x-amz-chime-bearer: ChimeBearer
Content-type: application/json

{
"Content": "string",
"Metadata": "string"
}

URI Request Parameters

The request uses the following URI parameters.

channelArn (p. 535)

The ARN of the channel.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 535)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}
messageId (p. 535)

The ID string of the message being updated.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [-_a-zA-Z0-9]*

Required: Yes

Request Body
The request accepts the following data in JSON format.

535
 Amazon Chime SDK API Reference
UpdateChannelMessage

Content (p. 535)

The content of the message being updated.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 4096.

Pattern: [\s\S]*

Required: No
Metadata (p. 535)

The metadata of the message being updated.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: .*

Required: No

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"ChannelArn": "string",
"MessageId": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ChannelArn (p. 536)

The ARN of the channel.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}
MessageId (p. 536)

The ID string of the message being updated.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [-_a-zA-Z0-9]*

536
 Amazon Chime SDK API Reference
UpdateChannelMessage

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

537
 Amazon Chime SDK API Reference
UpdateChannelReadMarker

UpdateChannelReadMarker
Service: Amazon Chime

The details of the time when a user last read messages in a channel.
Note
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.

Request Syntax
PUT /channels/channelArn/readMarker HTTP/1.1
x-amz-chime-bearer: ChimeBearer

URI Request Parameters

The request uses the following URI parameters.

channelArn (p. 538)

The ARN of the channel.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 538)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"ChannelArn": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

538
 Amazon Chime SDK API Reference
UpdateChannelReadMarker

ChannelArn (p. 538)

The ARN of the channel.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

539
 Amazon Chime SDK API Reference
UpdateChannelReadMarker

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

540
 Amazon Chime SDK API Reference
UpdateGlobalSettings

UpdateGlobalSettings
Service: Amazon Chime

Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling
and Amazon Chime Voice Connector settings.

Request Syntax
PUT /settings HTTP/1.1
Content-type: application/json

{
"BusinessCalling": {
"CdrBucket": "string"
},
"VoiceConnector": {
"CdrBucket": "string"
}
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

BusinessCalling (p. 541)

The Amazon Chime Business Calling settings.

Type: BusinessCallingSettings (p. 1115) object

Required: No
VoiceConnector (p. 541)

The Amazon Chime Voice Connector settings.

Type: VoiceConnectorSettings (p. 1222) object

Required: No

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

541
 Amazon Chime SDK API Reference
UpdateGlobalSettings

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents (AUTHPARAMS) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example updates the global settings for the administrator's AWS account.

Sample Request

PUT /settings HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding: identity

User-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-Date:
20190918T194726Z Authorization: AUTHPARAMS Content-Length: 109 {"BusinessCalling":
{"CdrBucket": "s3bucket"}, "Voice Connector": {"CdrBucket": "s3bucket"}}

Sample Response

HTTP/1.1 204 No Content x-amzn-RequestId: f77805ac-5d09-4ee2-aeb0-867540b4641c Content-

Type: application/json Date: Wed, 18 Sep 2019 19:47:26 GMT Connection: keep-alive

542
 Amazon Chime SDK API Reference
UpdateGlobalSettings

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

543
 Amazon Chime SDK API Reference
UpdatePhoneNumber

UpdatePhoneNumber
Service: Amazon Chime

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.

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 72 hours to complete. Pending updates to outbound calling
names must be complete before you can request another update.

Request Syntax
POST /phone-numbers/phoneNumberId HTTP/1.1
Content-type: application/json

{
"CallingName": "string",
"ProductType": "string"
}

URI Request Parameters

The request uses the following URI parameters.

phoneNumberId (p. 544)

The phone number ID.

Required: Yes

Request Body
The request accepts the following data in JSON format.

CallingName (p. 544)

The outbound calling name associated with the phone number.

Type: String

Pattern: ^$|^[a-zA-Z0-9 ]{2,15}$

Required: No
ProductType (p. 544)

The product type.

Type: String

Valid Values: BusinessCalling | VoiceConnector | SipMediaApplicationDialIn

Required: No

544
 Amazon Chime SDK API Reference
UpdatePhoneNumber

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"PhoneNumber": {
"Associations": [
{
"AssociatedTimestamp": number,
"Name": "string",
"Value": "string"
}
],
"CallingName": "string",
"CallingNameStatus": "string",
"Capabilities": {
"InboundCall": boolean,
"InboundMMS": boolean,
"InboundSMS": boolean,
"OutboundCall": boolean,
"OutboundMMS": boolean,
"OutboundSMS": boolean
},
"Country": "string",
"CreatedTimestamp": number,
"DeletionTimestamp": number,
"E164PhoneNumber": "string",
"PhoneNumberId": "string",
"ProductType": "string",
"Status": "string",
"Type": "string",
"UpdatedTimestamp": number
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

PhoneNumber (p. 545)

The updated phone number details.

Type: PhoneNumber (p. 1170) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

545
 Amazon Chime SDK API Reference
UpdatePhoneNumber

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example: Update Product Type

This example updates the product type for the specified phone number.

Sample Request

POST /phone-numbers/%2B12065550100 HTTP/1.1 Host: service.chime.aws.amazon.com Accept-

Encoding: identity User-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160
X-Amz-Date: 20191029T182530Z Authorization: AUTHPARAMS Content-Length: 34 {"ProductType":
"BusinessCalling"}

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 885b5970-6640-46e9-8b59-3d77be15a4f5

Content-Type: application/json Content-Length: 484 Date: Tue, 29 Oct

546
 Amazon Chime SDK API Reference
UpdatePhoneNumber

2019 18:25:29 GMT Connection: keep-alive {"PhoneNumber":{"Associations":

[],"CallingName":"phonenumber1","CallingNameStatus":"UpdateSucceeded","Capabilities":
{"InboundCall":true,"InboundMMS":true,"InboundSMS":true,"OutboundCall":true,"OutboundMMS":true,"Outboun

Example: Update Outbound Calling Name

This example updates the outbound calling name for the specified phone number.

Sample Request

POST /phone-numbers/%2B12065550100 HTTP/1.1 Host: service.chime.aws.amazon.com Accept-

Encoding: identity User-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160
X-Amz-Date: 20191029T182817Z Authorization: AUTHPARAMS Content-Length: 28 {"CallingName":
"phonenumber2"}

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: d25cff84-0a51-4126-b4e9-9460535fcd68

Content-Type: application/json Content-Length: 478 Date: Tue, 29 Oct
2019 18:28:17 GMT Connection: keep-alive {"PhoneNumber":{"Associations":
[],"CallingName":"phonenumber2","CallingNameStatus":"UpdateSucceeded","Capabilities":
{"InboundCall":true,"InboundMMS":true,"InboundSMS":true,"OutboundCall":true,"OutboundMMS":true,"Outboun

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

547
 Amazon Chime SDK API Reference
UpdatePhoneNumberSettings

UpdatePhoneNumberSettings
Service: Amazon Chime

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.

Request Syntax
PUT /settings/phone-number HTTP/1.1
Content-type: application/json

{
"CallingName": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

CallingName (p. 548)

The default outbound calling name for the account.

Type: String

Pattern: ^$|^[a-zA-Z0-9 ]{2,15}$

Required: Yes

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

548
 Amazon Chime SDK API Reference
UpdatePhoneNumberSettings

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example updates the default outbound calling name for the administrator's AWS account.

Sample Request

PUT /settings/phone-number HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding:

identity User-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-
Date: 20191028T185642Z Authorization: AUTHPARAMS Content-Length: 25 {"CallingName":
"myName"}

Sample Response

HTTP/1.1 204 No Content x-amzn-RequestId: 2bbca1c8-cf1e-438a-a3b1-b4a8f7db7227 Content-

Type: application/json Date: Mon, 28 Oct 2019 18:56:42 GMT Connection: keep-alive

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

549
 Amazon Chime SDK API Reference
UpdatePhoneNumberSettings

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

550
 Amazon Chime SDK API Reference
UpdateProxySession

UpdateProxySession
Service: Amazon Chime

Updates the specified proxy session details, such as voice or SMS capabilities.

Request Syntax
POST /voice-connectors/voiceConnectorId/proxy-sessions/proxySessionId HTTP/1.1
Content-type: application/json

{
"Capabilities": [ "string" ],
"ExpiryMinutes": number
}

URI Request Parameters

The request uses the following URI parameters.

proxySessionId (p. 551)

The proxy session ID.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: .*\S.*

Required: Yes
voiceConnectorId (p. 551)

The Amazon Chime voice connector ID.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

Capabilities (p. 551)

The proxy session capabilities.

Type: Array of strings

Valid Values: Voice | SMS

Required: Yes
ExpiryMinutes (p. 551)

The number of minutes allowed for the proxy session.

Type: Integer

Valid Range: Minimum value of 1.

551
 Amazon Chime SDK API Reference
UpdateProxySession

Required: No

Response Syntax
HTTP/1.1 201
Content-type: application/json

{
"ProxySession": {
"Capabilities": [ "string" ],
"CreatedTimestamp": number,
"EndedTimestamp": number,
"ExpiryMinutes": number,
"GeoMatchLevel": "string",
"GeoMatchParams": {
"AreaCode": "string",
"Country": "string"
},
"Name": "string",
"NumberSelectionBehavior": "string",
"Participants": [
{
"PhoneNumber": "string",
"ProxyPhoneNumber": "string"
}
],
"ProxySessionId": "string",
"Status": "string",
"UpdatedTimestamp": number,
"VoiceConnectorId": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

ProxySession (p. 552)

The proxy session details.

Type: ProxySession (p. 1181) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

552
 Amazon Chime SDK API Reference
UpdateProxySession

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example updates the proxy session capabilities.

Sample Request

POST /voice-connectors/abcdef1ghij2klmno3pqr4/proxy-sessions/123a4bc5-67d8-901e-2f3g-
h4ghjk56789l HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding: identity
User-Agent: aws-cli/1.18.39 Python/3.8.0 Windows/10 botocore/1.15.39 X-Amz-Date:
20200415T161517Z Authorization: AUTHPARAMS Content-Length: 27 {"Capabilities": ["Voice"]}

Sample Response

HTTP/1.1 201 Created x-amzn-RequestId: 3fea90c8-0c57-42cd-80ed-a628704eef17

Content-Type: application/json Content-Length: 525 Date: Wed, 15 Apr
2020 16:15:17 GMT Connection: keep-alive {"ProxySession":{"Capabilities":
["Voice"],"CreatedTimestamp":"2020-04-15T16:10:10.288Z","EndedTimestamp":null,"ExpiryMinutes":60,"GeoMa
[{"PhoneNumber":"+12065550100","ProxyPhoneNumber":"+19135550199"},
{"PhoneNumber":"+14015550101","ProxyPhoneNumber":"+19135550199"}],"ProxySessionId":"123a4bc5-67d8-901e-
h4ghjk56789l","Status":"Open","UpdatedTimestamp":"2020-04-15T16:15:17.560Z","VoiceConnectorId":"abcdef1

553
 Amazon Chime SDK API Reference
UpdateProxySession

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

554
 Amazon Chime SDK API Reference
UpdateRoom

UpdateRoom
Service: Amazon Chime

Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account.

Request Syntax
POST /accounts/accountId/rooms/roomId HTTP/1.1
Content-type: application/json

{
"Name": "string"
}

URI Request Parameters

The request uses the following URI parameters.

accountId (p. 555)

The Amazon Chime account ID.

Pattern: .*\S.*

Required: Yes
roomId (p. 555)

The room ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

Name (p. 555)

The room name.

Type: String

Required: No

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"Room": {
"AccountId": "string",
"CreatedBy": "string",
"CreatedTimestamp": number,

555
 Amazon Chime SDK API Reference
UpdateRoom

"Name": "string",
"RoomId": "string",
"UpdatedTimestamp": number
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Room (p. 555)

The room details.

Type: Room (p. 1185) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

556
 Amazon Chime SDK API Reference
UpdateRoom

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example updates the specified chat room name to teamRoom .

Sample Request

POST /accounts/12a3456b-7c89-012d-3456-78901e23fg45/rooms/
abcd1e2d-3e45-6789-01f2-3g45h67i890j HTTP/1.1 Host: service.chime.aws.amazon.com Accept-
Encoding: identity User-Agent: aws-cli/1.16.293 Python/3.8.0 Windows/10 botocore/1.13.29 X-
Amz-Date: 20191202T223318Z Authorization: AUTHPARAMS Content-Length: 21

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: e48fe3de-9a18-4ea2-b656-

a00690a91f46 Content-Type: application/json Content-Length: 274
Date: Mon, 02 Dec 2019 22:33:19 GMT Connection: keep-alive {"Room":
{"AccountId":"12a3456b-7c89-012d-3456-78901e23fg45","CreatedBy":"arn:aws:iam::111122223333:user/
alejandro","CreatedTimestamp":"2019-12-02T22:29:31.549Z","Name":"teamRoom","RoomId":"abcd1e2d-3e45-6789

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

557
 Amazon Chime SDK API Reference
UpdateRoomMembership

UpdateRoomMembership
Service: Amazon Chime

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.

Request Syntax
POST /accounts/accountId/rooms/roomId/memberships/memberId HTTP/1.1
Content-type: application/json

{
"Role": "string"
}

URI Request Parameters

The request uses the following URI parameters.

accountId (p. 558)

The Amazon Chime account ID.

Pattern: .*\S.*

Required: Yes
memberId (p. 558)

The member ID.

Pattern: .*\S.*

Required: Yes
roomId (p. 558)

The room ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

Role (p. 558)

The role of the member.

Type: String

Valid Values: Administrator | Member

Required: No

558
 Amazon Chime SDK API Reference
UpdateRoomMembership

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"RoomMembership": {
"InvitedBy": "string",
"Member": {
"AccountId": "string",
"Email": "string",
"FullName": "string",
"MemberId": "string",
"MemberType": "string"
},
"Role": "string",
"RoomId": "string",
"UpdatedTimestamp": number
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

RoomMembership (p. 559)

The room membership details.

Type: RoomMembership (p. 1187) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

559
 Amazon Chime SDK API Reference
UpdateRoomMembership

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example updates the specified chat room member role to administrator.

Sample Request

POST /accounts/12a3456b-7c89-012d-3456-78901e23fg45/rooms/
abcd1e2d-3e45-6789-01f2-3g45h67i890j/memberships/1ab2345c-67de-8901-f23g-45h678901j2k
HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding: identity User-Agent:
aws-cli/1.16.293 Python/3.8.0 Windows/10 botocore/1.13.29 X-Amz-Date: 20191202T224022Z
Authorization: AUTHPARAMS Content-Length: 25 {"Role": "Administrator"}

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: afe39bf2-b34c-40d3-8b0d-fd402971bc1c Content-Type:

application/json Content-Length: 388 Date: Mon, 02 Dec 2019 22:40:22 GMT Connection: keep-
alive {"RoomMembership":{"InvitedBy":"arn:aws:iam::111122223333:user/alejandro","Member":
{"AccountId":"12a3456b-7c89-012d-3456-78901e23fg45","Email":"[email protected]","FullName":"Jane
Doe","MemberId":"1ab2345c-67de-8901-
f23g-45h678901j2k","MemberType":"User"},"Role":"Administrator","RoomId":"abcd1e2d-3e45-6789-01f2-3g45h6

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go

560
 Amazon Chime SDK API Reference
UpdateRoomMembership

• AWS SDK for Java V2

• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

561
 Amazon Chime SDK API Reference
UpdateSipMediaApplication

UpdateSipMediaApplication
Service: Amazon Chime

Updates the details of the specified SIP media application.

Request Syntax
PUT /sip-media-applications/sipMediaApplicationId HTTP/1.1
Content-type: application/json

{
"Endpoints": [
{
"LambdaArn": "string"
}
],
"Name": "string"
}

URI Request Parameters

The request uses the following URI parameters.

sipMediaApplicationId (p. 562)

The SIP media application ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

Endpoints (p. 562)

The new set of endpoints for the specified SIP media application.

Type: Array of SipMediaApplicationEndpoint (p. 1195) objects

Array Members: Fixed number of 1 item.

Required: No
Name (p. 562)

The new name for the specified SIP media application.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: No

Response Syntax
HTTP/1.1 200

562
 Amazon Chime SDK API Reference
UpdateSipMediaApplication

Content-type: application/json

{
"SipMediaApplication": {
"AwsRegion": "string",
"CreatedTimestamp": number,
"Endpoints": [
{
"LambdaArn": "string"
}
],
"Name": "string",
"SipMediaApplicationId": "string",
"UpdatedTimestamp": number
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

SipMediaApplication (p. 562)

The updated SIP media application details.

Type: SipMediaApplication (p. 1192) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

563
 Amazon Chime SDK API Reference
UpdateSipMediaApplication

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

564
 Amazon Chime SDK API Reference
UpdateSipMediaApplicationCall

UpdateSipMediaApplicationCall
Service: Amazon Chime

Invokes the AWS Lambda function associated with the SIP media application and transaction ID in an
update request. The Lambda function can then return a new set of actions.

Request Syntax
POST /sip-media-applications/sipMediaApplicationId/calls/transactionId HTTP/1.1
Content-type: application/json

{
"Arguments": {
"string" : "string"
}
}

URI Request Parameters

The request uses the following URI parameters.

sipMediaApplicationId (p. 565)

The ID of the SIP media application handling the call.

Pattern: .*\S.*

Required: Yes
transactionId (p. 565)

The ID of the call transaction.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

Arguments (p. 565)

Arguments made available to the Lambda function as part of the CALL_UPDATE_REQUESTED event.
Can contain 0-20 key-value pairs.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 20 items.

Required: Yes

Response Syntax
HTTP/1.1 202
Content-type: application/json

565
 Amazon Chime SDK API Reference
UpdateSipMediaApplicationCall

{
"SipMediaApplicationCall": {
"TransactionId": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

SipMediaApplicationCall (p. 565)

A Call instance for a SIP media application.

Type: SipMediaApplicationCall (p. 1194) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

566
 Amazon Chime SDK API Reference
UpdateSipMediaApplicationCall

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

567
 Amazon Chime SDK API Reference
UpdateSipRule

UpdateSipRule
Service: Amazon Chime

Updates the details of the specified SIP rule.

Request Syntax
PUT /sip-rules/sipRuleId HTTP/1.1
Content-type: application/json

{
"Disabled": boolean,
"Name": "string",
"TargetApplications": [
{
"AwsRegion": "string",
"Priority": number,
"SipMediaApplicationId": "string"
}
]
}

URI Request Parameters

The request uses the following URI parameters.

sipRuleId (p. 568)

The SIP rule ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

Disabled (p. 568)

The new value specified to indicate whether the rule is disabled.

Type: Boolean

Required: No
Name (p. 568)

The new name for the specified SIP rule.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes
TargetApplications (p. 568)

The new value of the list of target applications.

568
 Amazon Chime SDK API Reference
UpdateSipRule

Type: Array of SipRuleTargetApplication (p. 1199) objects

Array Members: Minimum number of 1 item. Maximum number of 25 items.

Required: No

Response Syntax
HTTP/1.1 202
Content-type: application/json

{
"SipRule": {
"CreatedTimestamp": number,
"Disabled": boolean,
"Name": "string",
"SipRuleId": "string",
"TargetApplications": [
{
"AwsRegion": "string",
"Priority": number,
"SipMediaApplicationId": "string"
}
],
"TriggerType": "string",
"TriggerValue": "string",
"UpdatedTimestamp": number
}
}

Response Elements
If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

SipRule (p. 569)

Updated SIP rule details.

Type: SipRule (p. 1197) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

569
 Amazon Chime SDK API Reference
UpdateSipRule

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

570
 Amazon Chime SDK API Reference
UpdateUser

UpdateUser
Service: Amazon Chime

Updates user details for a specified user ID. Currently, only LicenseType updates are supported for this
action.

Request Syntax
POST /accounts/accountId/users/userId HTTP/1.1
Content-type: application/json

{
"AlexaForBusinessMetadata": {
"AlexaForBusinessRoomArn": "string",
"IsAlexaForBusinessEnabled": boolean
},
"LicenseType": "string",
"UserType": "string"
}

URI Request Parameters

The request uses the following URI parameters.

accountId (p. 571)

The Amazon Chime account ID.

Pattern: .*\S.*

Required: Yes
userId (p. 571)

The user ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

AlexaForBusinessMetadata (p. 571)

The Alexa for Business metadata.

Type: AlexaForBusinessMetadata (p. 1096) object

Required: No
LicenseType (p. 571)

The user license type to update. This must be a supported license type for the Amazon Chime
account that the user belongs to.

Type: String

Valid Values: Basic | Plus | Pro | ProTrial

571
 Amazon Chime SDK API Reference
UpdateUser

Required: No
UserType (p. 571)

The user type.

Type: String

Valid Values: PrivateUser | SharedDevice

Required: No

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"User": {
"AccountId": "string",
"AlexaForBusinessMetadata": {
"AlexaForBusinessRoomArn": "string",
"IsAlexaForBusinessEnabled": boolean
},
"DisplayName": "string",
"InvitedOn": number,
"LicenseType": "string",
"PersonalPIN": "string",
"PrimaryEmail": "string",
"PrimaryProvisionedNumber": "string",
"RegisteredOn": number,
"UserId": "string",
"UserInvitationStatus": "string",
"UserRegistrationStatus": "string",
"UserType": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

User (p. 572)

The updated user details.

Type: User (p. 1211) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

572
 Amazon Chime SDK API Reference
UpdateUser

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example updates the specified details for the specified user.

Sample Request

POST /console/accounts/12a3456b-7c89-012d-3456-78901e23fg45/users/1ab2345c-67de-8901-
f23g-45h678901j2k HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding: identity
User-Agent: aws-cli/1.16.83 Python/3.6.6 Windows/10 botocore/1.12.73 X-Amz-Date:
20190108T215020Z Authorization: AUTHPARAMS Content-Length: 24 {"LicenseType": "Basic"}

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 3a63e2de-eb6c-41cf-8b08-2b05a29ee461 Content-Type:

application/json Content-Length: 441 Date: Tue, 08 Jan 2019 21:50:20 GMT Connection:

573
 Amazon Chime SDK API Reference
UpdateUser

keep-alive {"User": {"AccountId": null,"Delegates": null,"Devices": null,"DisplayName":

null,"EmailAlias": null,"FullName": null,"InvitedOn": null,"IsProTrial":
null,"LastActiveOn": null,"LicenseType": null,"PersonalPIN": null,"PresenceVisibility":
null,"PrimaryEmail": null,"PrimaryProvisionedNumber": null,"RegisteredOn": null,"UserId":
"1ab2345c-67de-8901-f23g-45h678901j2k","UserInvitationStatus": null,"UserLocale":
null,"UserRegistrationStatus": null,"Vanity": null} }

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

574
 Amazon Chime SDK API Reference
UpdateUserSettings

UpdateUserSettings
Service: Amazon Chime

Updates the settings for the specified user, such as phone number settings.

Request Syntax
PUT /accounts/accountId/users/userId/settings HTTP/1.1
Content-type: application/json

{
"UserSettings": {
"Telephony": {
"InboundCalling": boolean,
"OutboundCalling": boolean,
"SMS": boolean
}
}
}

URI Request Parameters

The request uses the following URI parameters.

accountId (p. 575)

The Amazon Chime account ID.

Required: Yes
userId (p. 575)

The user ID.

Required: Yes

Request Body
The request accepts the following data in JSON format.

UserSettings (p. 575)

The user settings to update.

Type: UserSettings (p. 1215) object

Required: Yes

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

575
 Amazon Chime SDK API Reference
UpdateUserSettings

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example updates the settings for the specified user.

Sample Request

PUT /accounts/12a3456b-7c89-012d-3456-78901e23fg45/users/1ab2345c-67de-8901-
f23g-45h678901j2k/settings HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding:

576
 Amazon Chime SDK API Reference
UpdateUserSettings

identity User-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-

Date: 20190918T181826Z Authorization: AUTHPARAMS Content-Length: 95 {"UserSettings":
{"Telephony": {"InboundCalling": true, "OutboundCalling": true, "SMS": true}}}

Sample Response

HTTP/1.1 204 No Content x-amzn-RequestId: 72ab9592-8aa8-4de1-9dd7-a8f84011261b Content-

Type: application/json Date: Wed, 18 Sep 2019 18:18:27 GMT Connection: keep-alive

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

577
 Amazon Chime SDK API Reference
UpdateVoiceConnector

UpdateVoiceConnector
Service: Amazon Chime

Updates details for the specified Amazon Chime Voice Connector.

Request Syntax
PUT /voice-connectors/voiceConnectorId HTTP/1.1
Content-type: application/json

{
"Name": "string",
"RequireEncryption": boolean
}

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId (p. 578)

The Amazon Chime Voice Connector ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

Name (p. 578)

The name of the Amazon Chime Voice Connector.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes
RequireEncryption (p. 578)

When enabled, requires encryption for the Amazon Chime Voice Connector.

Type: Boolean

Required: Yes

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"VoiceConnector": {
"AwsRegion": "string",

578
 Amazon Chime SDK API Reference
UpdateVoiceConnector

"CreatedTimestamp": number,
"Name": "string",
"OutboundHostName": "string",
"RequireEncryption": boolean,
"UpdatedTimestamp": number,
"VoiceConnectorArn": "string",
"VoiceConnectorId": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

VoiceConnector (p. 578)

The updated Amazon Chime Voice Connector details.

Type: VoiceConnector (p. 1217) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

579
 Amazon Chime SDK API Reference
UpdateVoiceConnector

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example updates details for the specified Amazon Chime Voice Connector.

Sample Request

PUT /voice-connectors/abcdef1ghij2klmno3pqr4 HTTP/1.1 Host: service.chime.aws.amazon.com

Accept-Encoding: identity User-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10
botocore/1.12.160 X-Amz-Date: 20190918T204052Z Authorization: AUTHPARAMS Content-Length:
46 {"Name": "newName", "RequireEncryption": true}

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 975d78e7-1752-4b4f-9da7-5c1d025cd970

Content-Type: application/json Content-Length: 291 Date: Wed, 18 Sep 2019
20:40:52 GMT Connection: keep-alive {"Voice Connector":{"AwsRegion":"us-
west-2","CreatedTimestamp":"2019-09-18T20:34:01.352Z","Name":"newName","OutboundHostName":"abcdef1ghij2

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

580
 Amazon Chime SDK API Reference
UpdateVoiceConnectorGroup

UpdateVoiceConnectorGroup
Service: Amazon Chime

Updates details of the specified Amazon Chime Voice Connector group, such as the name and Amazon
Chime Voice Connector priority ranking.

Request Syntax
PUT /voice-connector-groups/voiceConnectorGroupId HTTP/1.1
Content-type: application/json

{
"Name": "string",
"VoiceConnectorItems": [
{
"Priority": number,
"VoiceConnectorId": "string"
}
]
}

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorGroupId (p. 581)

The Amazon Chime Voice Connector group ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

Name (p. 581)

The name of the Amazon Chime Voice Connector group.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes
VoiceConnectorItems (p. 581)

The VoiceConnectorItems to associate with the group.

Type: Array of VoiceConnectorItem (p. 1221) objects

Required: Yes

Response Syntax
HTTP/1.1 202

581
 Amazon Chime SDK API Reference
UpdateVoiceConnectorGroup

Content-type: application/json

{
"VoiceConnectorGroup": {
"CreatedTimestamp": number,
"Name": "string",
"UpdatedTimestamp": number,
"VoiceConnectorGroupArn": "string",
"VoiceConnectorGroupId": "string",
"VoiceConnectorItems": [
{
"Priority": number,
"VoiceConnectorId": "string"
}
]
}
}

Response Elements
If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

VoiceConnectorGroup (p. 581)

The updated Amazon Chime Voice Connector group details.

Type: VoiceConnectorGroup (p. 1219) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

582
 Amazon Chime SDK API Reference
UpdateVoiceConnectorGroup

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example updates the name of the specified Amazon Chime Voice Connector group.

Sample Request

PUT /voice-connector-groups/123a456b-c7d8-90e1-fg23-4h567jkl8901 HTTP/1.1 Host:

service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.170
Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-Date: 20191028T190056Z Authorization:
AUTHPARAMS Content-Length: 112 {"Name": "newGroupName", "VoiceConnectorItems":
[{"VoiceConnectorId": "abcdef1ghij2klmno3pqr4", "Priority": 1}]}

Sample Response

HTTP/1.1 202 Accepted x-amzn-RequestId: a19ab97e-a397-4e33-b23f-6df54a2089f6

Content-Type: application/json Content-Length: 307 Date: Mon, 28
Oct 2019 19:00:57 GMT Connection: keep-alive {"VoiceConnectorGroup":
{"CreatedTimestamp":"2019-09-18T16:38:34.734Z","Name":"newGroupName","UpdatedTimestamp":"2019-10-28T19:
c7d8-90e1-fg23-4h567jkl8901","VoiceConnectorItems":[{"Priority":1,"Voice
Connector":null,"VoiceConnectorId":"abcdef1ghij2klmno3pqr4"}]}}

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go

583
 Amazon Chime SDK API Reference
UpdateVoiceConnectorGroup

• AWS SDK for Java V2

• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

584
 Amazon Chime SDK API Reference
ValidateE911Address

ValidateE911Address
Service: Amazon Chime

Validates an address to be used for 911 calls made with Amazon Chime Voice Connectors. You can use
validated addresses in a Presence Information Data Format Location Object file that you include in SIP
requests. That helps ensure that addresses are routed to the appropriate Public Safety Answering Point.

Request Syntax
POST /emergency-calling/address HTTP/1.1
Content-type: application/json

{
"AwsAccountId": "string",
"City": "string",
"Country": "string",
"PostalCode": "string",
"State": "string",
"StreetInfo": "string",
"StreetNumber": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

AwsAccountId (p. 585)

The AWS account ID.

Type: String

Pattern: .*\S.*

Required: Yes
City (p. 585)

The address city, such as Portland.

Type: String

Pattern: .*\S.*

Required: Yes
Country (p. 585)

The address country, such as US.

Type: String

Pattern: .*\S.*

Required: Yes

585
 Amazon Chime SDK API Reference
ValidateE911Address

PostalCode (p. 585)

The address postal code, such as 04352.

Type: String

Pattern: .*\S.*

Required: Yes
State (p. 585)

The address state, such as ME.

Type: String

Pattern: .*\S.*

Required: Yes
StreetInfo (p. 585)

The address street information, such as 8th Avenue.

Type: String

Pattern: .*\S.*

Required: Yes
StreetNumber (p. 585)

The address street number, such as 200 or 2121.

Type: String

Pattern: .*\S.*

Required: Yes

Response Syntax
HTTP/1.1 202
Content-type: application/json

{
"Address": {
"city": "string",
"country": "string",
"postalCode": "string",
"postalCodePlus4": "string",
"postDirectional": "string",
"preDirectional": "string",
"state": "string",
"streetName": "string",
"streetNumber": "string",
"streetSuffix": "string"
},
"AddressExternalId": "string",
"CandidateAddressList": [
{
"city": "string",
"country": "string",

586
 Amazon Chime SDK API Reference
ValidateE911Address

"postalCode": "string",
"postalCodePlus4": "string",
"state": "string",
"streetInfo": "string",
"streetNumber": "string"
}
],
"ValidationResult": number
}

Response Elements
If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

Address (p. 586)

The validated address.

Type: Address (p. 1094) object

AddressExternalId (p. 586)

The ID that represents the address.

Type: String
CandidateAddressList (p. 586)

The list of address suggestions.

Type: Array of CandidateAddress (p. 1116) objects

ValidationResult (p. 586)

Number indicating the result of address validation. 0 means the address was perfect as is and
successfully validated. 1 means the address was corrected. 2 means the address sent was not close
enough and was not validated.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 2.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

587
 Amazon Chime SDK API Reference
Amazon Chime SDK Identity

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

Amazon Chime SDK Identity

The following actions are supported by Amazon Chime SDK Identity:

• CreateAppInstance (p. 590)

• CreateAppInstanceAdmin (p. 593)
• CreateAppInstanceUser (p. 596)
• DeleteAppInstance (p. 600)
• DeleteAppInstanceAdmin (p. 602)
• DeleteAppInstanceUser (p. 604)
• DeregisterAppInstanceUserEndpoint (p. 606)
• DescribeAppInstance (p. 608)
• DescribeAppInstanceAdmin (p. 610)
• DescribeAppInstanceUser (p. 613)

588
 Amazon Chime SDK API Reference
Amazon Chime SDK Identity

• DescribeAppInstanceUserEndpoint (p. 615)

• GetAppInstanceRetentionSettings (p. 618)
• ListAppInstanceAdmins (p. 620)
• ListAppInstances (p. 623)
• ListAppInstanceUserEndpoints (p. 626)
• ListAppInstanceUsers (p. 629)
• ListTagsForResource (p. 632)
• PutAppInstanceRetentionSettings (p. 634)
• RegisterAppInstanceUserEndpoint (p. 637)
• TagResource (p. 641)
• UntagResource (p. 643)
• UpdateAppInstance (p. 645)
• UpdateAppInstanceUser (p. 648)
• UpdateAppInstanceUserEndpoint (p. 651)

589
 Amazon Chime SDK API Reference
CreateAppInstance

CreateAppInstance
Service: Amazon Chime SDK Identity

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.

identity

Request Syntax
POST /app-instances HTTP/1.1
Content-type: application/json

{
"ClientRequestToken": "string",
"Metadata": "string",
"Name": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

ClientRequestToken (p. 590)

The ClientRequestToken of the AppInstance.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

Pattern: [-_a-zA-Z0-9]*

Required: Yes
Metadata (p. 590)

The metadata of the AppInstance. Limited to a 1KB string in UTF-8.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: .*

Required: No
Name (p. 590)

The name of the AppInstance.

590
 Amazon Chime SDK API Reference
CreateAppInstance

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD
\u10000-\u10FFFF]*

Required: Yes
Tags (p. 590)

Tags assigned to the AppInstance.

Type: Array of Tag (p. 1241) objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Required: No

Response Syntax
HTTP/1.1 201
Content-type: application/json

{
"AppInstanceArn": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

AppInstanceArn (p. 591)

The Amazon Resource Number (ARN) of the AppInstance.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

591
 Amazon Chime SDK API Reference
CreateAppInstance

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

592
 Amazon Chime SDK API Reference
CreateAppInstanceAdmin

CreateAppInstanceAdmin
Service: Amazon Chime SDK Identity

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.

Request Syntax
POST /app-instances/appInstanceArn/admins HTTP/1.1
Content-type: application/json

{
"AppInstanceAdminArn": "string"
}

URI Request Parameters

The request uses the following URI parameters.

appInstanceArn (p. 593)

The ARN of the AppInstance.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Request Body
The request accepts the following data in JSON format.

AppInstanceAdminArn (p. 593)

The ARN of the administrator of the current AppInstance.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Response Syntax
HTTP/1.1 201

593
 Amazon Chime SDK API Reference
CreateAppInstanceAdmin

Content-type: application/json

{
"AppInstanceAdmin": {
"Arn": "string",
"Name": "string"
},
"AppInstanceArn": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

AppInstanceAdmin (p. 593)

The name and ARN of the admin for the AppInstance.

Type: Identity (p. 1240) object

AppInstanceArn (p. 593)

The ARN of the of the admin for the AppInstance.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

594
 Amazon Chime SDK API Reference
CreateAppInstanceAdmin

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

595
 Amazon Chime SDK API Reference
CreateAppInstanceUser

CreateAppInstanceUser
Service: Amazon Chime SDK Identity

Creates a user under an Amazon Chime AppInstance. The request consists of a unique
appInstanceUserId and Name for that user.

Request Syntax
POST /app-instance-users HTTP/1.1
Content-type: application/json

{
"AppInstanceArn": "string",
"AppInstanceUserId": "string",
"ClientRequestToken": "string",
"Metadata": "string",
"Name": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

AppInstanceArn (p. 596)

The ARN of the AppInstance request.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
AppInstanceUserId (p. 596)

The user ID of the AppInstance.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [A-Za-z0-9]([A-Za-z0-9\:\-\_\.\@]{0,62}[A-Za-z0-9])?

Required: Yes
ClientRequestToken (p. 596)

The token assigned to the user requesting an AppInstance.

596
 Amazon Chime SDK API Reference
CreateAppInstanceUser

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

Pattern: [-_a-zA-Z0-9]*

Required: Yes
Metadata (p. 596)

The request's metadata. Limited to a 1KB string in UTF-8.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: .*

Required: No
Name (p. 596)

The user's name.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: .*\S.*

Required: Yes
Tags (p. 596)

Tags assigned to the AppInstanceUser.

Type: Array of Tag (p. 1241) objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Required: No

Response Syntax
HTTP/1.1 201
Content-type: application/json

{
"AppInstanceUserArn": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

AppInstanceUserArn (p. 597)

The user's ARN.

Type: String

597
 Amazon Chime SDK API Reference
CreateAppInstanceUser

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

598
 Amazon Chime SDK API Reference
CreateAppInstanceUser

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

599
 Amazon Chime SDK API Reference
DeleteAppInstance

DeleteAppInstance
Service: Amazon Chime SDK Identity

Deletes an AppInstance and all associated data asynchronously.

Request Syntax
DELETE /app-instances/appInstanceArn HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

appInstanceArn (p. 600)

The ARN of the AppInstance.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ResourceLimitExceededException

The request exceeds the resource limit.

600
 Amazon Chime SDK API Reference
DeleteAppInstance

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

601
 Amazon Chime SDK API Reference
DeleteAppInstanceAdmin

DeleteAppInstanceAdmin
Service: Amazon Chime SDK Identity

Demotes an AppInstanceAdmin to an AppInstanceUser. This action does not delete the user.

Request Syntax
DELETE /app-instances/appInstanceArn/admins/appInstanceAdminArn HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

appInstanceAdminArn (p. 602)

The ARN of the AppInstance's administrator.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
appInstanceArn (p. 602)

The ARN of the AppInstance.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

602
 Amazon Chime SDK API Reference
DeleteAppInstanceAdmin

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

603
 Amazon Chime SDK API Reference
DeleteAppInstanceUser

DeleteAppInstanceUser
Service: Amazon Chime SDK Identity

Deletes an AppInstanceUser.

Request Syntax
DELETE /app-instance-users/appInstanceUserArn HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

appInstanceUserArn (p. 604)

The ARN of the user request being deleted.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

604
 Amazon Chime SDK API Reference
DeleteAppInstanceUser

HTTP Status Code: 403

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

605
 Amazon Chime SDK API Reference
DeregisterAppInstanceUserEndpoint

DeregisterAppInstanceUserEndpoint
Service: Amazon Chime SDK Identity

Deregisters an AppInstanceUserEndpoint.

Request Syntax
DELETE /app-instance-users/appInstanceUserArn/endpoints/endpointId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

appInstanceUserArn (p. 606)

The ARN of the AppInstanceUser.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
endpointId (p. 606)

The unique identifier of the AppInstanceUserEndpoint.

Length Constraints: Minimum length of 0. Maximum length of 64.

Pattern: .*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

606
 Amazon Chime SDK API Reference
DeregisterAppInstanceUserEndpoint

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

607
 Amazon Chime SDK API Reference
DescribeAppInstance

DescribeAppInstance
Service: Amazon Chime SDK Identity

Returns the full details of an AppInstance.

Request Syntax
GET /app-instances/appInstanceArn HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

appInstanceArn (p. 608)

The ARN of the AppInstance.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"AppInstance": {
"AppInstanceArn": "string",
"CreatedTimestamp": number,
"LastUpdatedTimestamp": number,
"Metadata": "string",
"Name": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AppInstance (p. 608)

The ARN, metadata, created and last-updated timestamps, and the name of the AppInstance. All
timestamps use epoch milliseconds.

Type: AppInstance (p. 1223) object

608
 Amazon Chime SDK API Reference
DescribeAppInstance

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

609
 Amazon Chime SDK API Reference
DescribeAppInstanceAdmin

DescribeAppInstanceAdmin
Service: Amazon Chime SDK Identity

Returns the full details of an AppInstanceAdmin.

Request Syntax
GET /app-instances/appInstanceArn/admins/appInstanceAdminArn HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

appInstanceAdminArn (p. 610)

The ARN of the AppInstanceAdmin.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
appInstanceArn (p. 610)

The ARN of the AppInstance.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"AppInstanceAdmin": {
"Admin": {
"Arn": "string",
"Name": "string"
},
"AppInstanceArn": "string",
"CreatedTimestamp": number
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

610
 Amazon Chime SDK API Reference
DescribeAppInstanceAdmin

The following data is returned in JSON format by the service.

AppInstanceAdmin (p. 610)

The ARN and name of the AppInstanceUser, the ARN of the AppInstance, and the created and
last-updated timestamps. All timestamps use epoch milliseconds.

Type: AppInstanceAdmin (p. 1225) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3

611
 Amazon Chime SDK API Reference
DescribeAppInstanceAdmin

• AWS SDK for Python

• AWS SDK for Ruby V3

612
 Amazon Chime SDK API Reference
DescribeAppInstanceUser

DescribeAppInstanceUser
Service: Amazon Chime SDK Identity

Returns the full details of an AppInstanceUser.

Request Syntax
GET /app-instance-users/appInstanceUserArn HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

appInstanceUserArn (p. 613)

The ARN of the AppInstanceUser.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"AppInstanceUser": {
"AppInstanceUserArn": "string",
"CreatedTimestamp": number,
"LastUpdatedTimestamp": number,
"Metadata": "string",
"Name": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AppInstanceUser (p. 613)

The name of the AppInstanceUser.

Type: AppInstanceUser (p. 1229) object

613
 Amazon Chime SDK API Reference
DescribeAppInstanceUser

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

614
 Amazon Chime SDK API Reference
DescribeAppInstanceUserEndpoint

DescribeAppInstanceUserEndpoint
Service: Amazon Chime SDK Identity

Returns the full details of an AppInstanceUserEndpoint.

Request Syntax
GET /app-instance-users/appInstanceUserArn/endpoints/endpointId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

appInstanceUserArn (p. 615)

The ARN of the AppInstanceUser.

Length Constraints: Minimum length of 0. Maximum length of 1600.

Pattern: .*

Required: Yes
endpointId (p. 615)

The unique identifier of the AppInstanceUserEndpoint.

Length Constraints: Minimum length of 0. Maximum length of 64.

Pattern: .*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"AppInstanceUserEndpoint": {
"AllowMessages": "string",
"AppInstanceUserArn": "string",
"CreatedTimestamp": number,
"EndpointAttributes": {
"DeviceToken": "string",
"VoipDeviceToken": "string"
},
"EndpointId": "string",
"EndpointState": {
"Status": "string",
"StatusReason": "string"
},
"LastUpdatedTimestamp": number,
"Name": "string",

615
 Amazon Chime SDK API Reference
DescribeAppInstanceUserEndpoint

"ResourceArn": "string",
"Type": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AppInstanceUserEndpoint (p. 615)

The full details of an AppInstanceUserEndpoint: the AppInstanceUserArn, ID, name, type,

resource ARN, attributes, allow messages, state, and created and last updated timestamps. All
timestamps use epoch milliseconds.

Type: AppInstanceUserEndpoint (p. 1231) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

616
 Amazon Chime SDK API Reference
DescribeAppInstanceUserEndpoint

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

617
 Amazon Chime SDK API Reference
GetAppInstanceRetentionSettings

GetAppInstanceRetentionSettings
Service: Amazon Chime SDK Identity

Gets the retention settings for an AppInstance.

Request Syntax
GET /app-instances/appInstanceArn/retention-settings HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

appInstanceArn (p. 618)

The ARN of the AppInstance.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"AppInstanceRetentionSettings": {
"ChannelRetentionSettings": {
"RetentionDays": number
}
},
"InitiateDeletionTimestamp": number
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AppInstanceRetentionSettings (p. 618)

The retention settings for the AppInstance.

Type: AppInstanceRetentionSettings (p. 1227) object

InitiateDeletionTimestamp (p. 618)

The timestamp representing the time at which the specified items are retained, in Epoch Seconds.

618
 Amazon Chime SDK API Reference
GetAppInstanceRetentionSettings

Type: Timestamp

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

619
 Amazon Chime SDK API Reference
ListAppInstanceAdmins

ListAppInstanceAdmins
Service: Amazon Chime SDK Identity

Returns a list of the administrators in the AppInstance.

Request Syntax
GET /app-instances/appInstanceArn/admins?max-results=MaxResults&next-token=NextToken
HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

appInstanceArn (p. 620)

The ARN of the AppInstance.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
MaxResults (p. 620)

The maximum number of administrators that you want to return.

Valid Range: Minimum value of 1. Maximum value of 50.

NextToken (p. 620)

The token returned from previous API requests until the number of administrators is reached.

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"AppInstanceAdmins": [
{
"Admin": {
"Arn": "string",
"Name": "string"
}
}
],
"AppInstanceArn": "string",

620
 Amazon Chime SDK API Reference
ListAppInstanceAdmins

"NextToken": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AppInstanceAdmins (p. 620)

The information for each administrator.

Type: Array of AppInstanceAdminSummary (p. 1226) objects

AppInstanceArn (p. 620)

The ARN of the AppInstance.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}
NextToken (p. 620)

The token returned from previous API requests until the number of administrators is reached.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

621
 Amazon Chime SDK API Reference
ListAppInstanceAdmins

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

622
 Amazon Chime SDK API Reference
ListAppInstances

ListAppInstances
Service: Amazon Chime SDK Identity

Lists all Amazon Chime AppInstances created under a single AWS account.

Request Syntax
GET /app-instances?max-results=MaxResults&next-token=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MaxResults (p. 623)

The maximum number of AppInstances that you want to return.

Valid Range: Minimum value of 1. Maximum value of 50.

NextToken (p. 623)

The token passed by previous API requests until you reach the maximum number of AppInstances.

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"AppInstances": [
{
"AppInstanceArn": "string",
"Metadata": "string",
"Name": "string"
}
],
"NextToken": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AppInstances (p. 623)

The information for each AppInstance.

623
 Amazon Chime SDK API Reference
ListAppInstances

Type: Array of AppInstanceSummary (p. 1228) objects

NextToken (p. 623)

The token passed by previous API requests until the maximum number of AppInstances is reached.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2

624
 Amazon Chime SDK API Reference
ListAppInstances

• AWS SDK for JavaScript

• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

625
 Amazon Chime SDK API Reference
ListAppInstanceUserEndpoints

ListAppInstanceUserEndpoints
Service: Amazon Chime SDK Identity

Lists all the AppInstanceUserEndpoints created under a single AppInstanceUser.

Request Syntax
GET /app-instance-users/appInstanceUserArn/endpoints?max-results=MaxResults&next-
token=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

appInstanceUserArn (p. 626)

The ARN of the AppInstanceUser.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
MaxResults (p. 626)

The maximum number of endpoints that you want to return.

Valid Range: Minimum value of 1. Maximum value of 50.

NextToken (p. 626)

The token passed by previous API calls until all requested endpoints are returned.

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"AppInstanceUserEndpoints": [
{
"AllowMessages": "string",
"AppInstanceUserArn": "string",
"EndpointId": "string",
"EndpointState": {
"Status": "string",
"StatusReason": "string"
},

626
 Amazon Chime SDK API Reference
ListAppInstanceUserEndpoints

"Name": "string",
"Type": "string"
}
],
"NextToken": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AppInstanceUserEndpoints (p. 626)

The information for each requested AppInstanceUserEndpoint.

Type: Array of AppInstanceUserEndpointSummary (p. 1234) objects

NextToken (p. 626)

The token passed by previous API calls until all requested endpoints are returned.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

627
 Amazon Chime SDK API Reference
ListAppInstanceUserEndpoints

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

628
 Amazon Chime SDK API Reference
ListAppInstanceUsers

ListAppInstanceUsers
Service: Amazon Chime SDK Identity

List all AppInstanceUsers created under a single AppInstance.

Request Syntax
GET /app-instance-users?app-instance-arn=AppInstanceArn&max-results=MaxResults&next-
token=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

AppInstanceArn (p. 629)

The ARN of the AppInstance.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
MaxResults (p. 629)

The maximum number of requests that you want returned.

Valid Range: Minimum value of 1. Maximum value of 50.

NextToken (p. 629)

The token passed by previous API calls until all requested users are returned.

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"AppInstanceArn": "string",
"AppInstanceUsers": [
{
"AppInstanceUserArn": "string",
"Metadata": "string",
"Name": "string"
}
],
"NextToken": "string"

629
 Amazon Chime SDK API Reference
ListAppInstanceUsers

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AppInstanceArn (p. 629)

The ARN of the AppInstance.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}
AppInstanceUsers (p. 629)

The information for each requested AppInstanceUser.

Type: Array of AppInstanceUserSummary (p. 1236) objects

NextToken (p. 629)

The token passed by previous API calls until all requested users are returned.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

630
 Amazon Chime SDK API Reference
ListAppInstanceUsers

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

631
 Amazon Chime SDK API Reference
ListTagsForResource

ListTagsForResource
Service: Amazon Chime SDK Identity

Lists the tags applied to an Amazon Chime SDK identity resource.

Request Syntax
GET /tags?arn=ResourceARN HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

ResourceARN (p. 632)

The ARN of the resource.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Tags (p. 632)

The tag key-value pairs.

Type: Array of Tag (p. 1241) objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

632
 Amazon Chime SDK API Reference
ListTagsForResource

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

633
 Amazon Chime SDK API Reference
PutAppInstanceRetentionSettings

PutAppInstanceRetentionSettings
Service: Amazon Chime SDK Identity

Sets the amount of time in days that a given AppInstance retains data.

Request Syntax
PUT /app-instances/appInstanceArn/retention-settings HTTP/1.1
Content-type: application/json

{
"AppInstanceRetentionSettings": {
"ChannelRetentionSettings": {
"RetentionDays": number
}
}
}

URI Request Parameters

The request uses the following URI parameters.

appInstanceArn (p. 634)

The ARN of the AppInstance.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Request Body
The request accepts the following data in JSON format.

AppInstanceRetentionSettings (p. 634)

The time in days to retain data. Data type: number.

Type: AppInstanceRetentionSettings (p. 1227) object

Required: Yes

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"AppInstanceRetentionSettings": {
"ChannelRetentionSettings": {
"RetentionDays": number
}
},
"InitiateDeletionTimestamp": number

634
 Amazon Chime SDK API Reference
PutAppInstanceRetentionSettings

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AppInstanceRetentionSettings (p. 634)

The time in days to retain data. Data type: number.

Type: AppInstanceRetentionSettings (p. 1227) object

InitiateDeletionTimestamp (p. 634)

The time at which the API deletes data.

Type: Timestamp

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

635
 Amazon Chime SDK API Reference
PutAppInstanceRetentionSettings

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

636
 Amazon Chime SDK API Reference
RegisterAppInstanceUserEndpoint

RegisterAppInstanceUserEndpoint
Service: Amazon Chime SDK Identity

Registers an endpoint under an Amazon Chime AppInstanceUser. The endpoint receives messages for
a user. For push notifications, the endpoint is a mobile device used to receive mobile push notifications
for a user.

Request Syntax
POST /app-instance-users/appInstanceUserArn/endpoints HTTP/1.1
Content-type: application/json

{
"AllowMessages": "string",
"ClientRequestToken": "string",
"EndpointAttributes": {
"DeviceToken": "string",
"VoipDeviceToken": "string"
},
"Name": "string",
"ResourceArn": "string",
"Type": "string"
}

URI Request Parameters

The request uses the following URI parameters.

appInstanceUserArn (p. 637)

The ARN of the AppInstanceUser.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Request Body
The request accepts the following data in JSON format.

AllowMessages (p. 637)

Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL
indicates the endpoint receives all messages. NONE indicates the endpoint receives no messages.

Type: String

Valid Values: ALL | NONE

Required: No
ClientRequestToken (p. 637)

The idempotency token for each client request.

Type: String

637
 Amazon Chime SDK API Reference
RegisterAppInstanceUserEndpoint

Length Constraints: Minimum length of 2. Maximum length of 64.

Pattern: [-_a-zA-Z0-9]*

Required: Yes
EndpointAttributes (p. 637)

The attributes of an Endpoint.

Type: EndpointAttributes (p. 1238) object

Required: Yes
Name (p. 637)

The name of the AppInstanceUserEndpoint.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1600.

Pattern: .*

Required: No
ResourceArn (p. 637)

The ARN of the resource to which the endpoint belongs.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
Type (p. 637)

The type of the AppInstanceUserEndpoint. Supported types:

• APNS: The mobile notification service for an Apple device.
• APNS_SANDBOX: The sandbox environment of the mobile notification service for an Apple device.
• GCM: The mobile notification service for an Android device.

Populate the ResourceArn value of each type as PinpointAppArn.

Type: String

Valid Values: APNS | APNS_SANDBOX | GCM

Required: Yes

Response Syntax
HTTP/1.1 201
Content-type: application/json

{
"AppInstanceUserArn": "string",
"EndpointId": "string"

638
 Amazon Chime SDK API Reference
RegisterAppInstanceUserEndpoint

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

AppInstanceUserArn (p. 638)

The ARN of the AppInstanceUser.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}
EndpointId (p. 638)

The unique identifier of the AppInstanceUserEndpoint.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 64.

Pattern: .*

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

639
 Amazon Chime SDK API Reference
RegisterAppInstanceUserEndpoint

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

640
 Amazon Chime SDK API Reference
TagResource

TagResource
Service: Amazon Chime SDK Identity

Applies the specified tags to the specified Amazon Chime SDK identity resource.

Request Syntax
POST /tags?operation=tag-resource HTTP/1.1
Content-type: application/json

{
"ResourceARN": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

ResourceARN (p. 641)

The resource ARN.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
Tags (p. 641)

The tag key-value pairs.

Type: Array of Tag (p. 1241) objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Required: Yes

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

641
 Amazon Chime SDK API Reference
TagResource

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

642
 Amazon Chime SDK API Reference
UntagResource

UntagResource
Service: Amazon Chime SDK Identity

Removes the specified tags from the specified Amazon Chime SDK identity resource.

Request Syntax
POST /tags?operation=untag-resource HTTP/1.1
Content-type: application/json

{
"ResourceARN": "string",
"TagKeys": [ "string" ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

ResourceARN (p. 643)

The resource ARN.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
TagKeys (p. 643)

The tag keys.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: Yes

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

643
 Amazon Chime SDK API Reference
UntagResource

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

644
 Amazon Chime SDK API Reference
UpdateAppInstance

UpdateAppInstance
Service: Amazon Chime SDK Identity

Updates AppInstance metadata.

Request Syntax
PUT /app-instances/appInstanceArn HTTP/1.1
Content-type: application/json

{
"Metadata": "string",
"Name": "string"
}

URI Request Parameters

The request uses the following URI parameters.

appInstanceArn (p. 645)

The ARN of the AppInstance.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Request Body
The request accepts the following data in JSON format.

Metadata (p. 645)

The metadata that you want to change.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: .*

Required: Yes
Name (p. 645)

The name that you want to change.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD
\u10000-\u10FFFF]*

Required: Yes

645
 Amazon Chime SDK API Reference
UpdateAppInstance

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"AppInstanceArn": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AppInstanceArn (p. 646)

The ARN of the AppInstance.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

646
 Amazon Chime SDK API Reference
UpdateAppInstance

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

647
 Amazon Chime SDK API Reference
UpdateAppInstanceUser

UpdateAppInstanceUser
Service: Amazon Chime SDK Identity

Updates the details of an AppInstanceUser. You can update names and metadata.

Request Syntax
PUT /app-instance-users/appInstanceUserArn HTTP/1.1
Content-type: application/json

{
"Metadata": "string",
"Name": "string"
}

URI Request Parameters

The request uses the following URI parameters.

appInstanceUserArn (p. 648)

The ARN of the AppInstanceUser.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Request Body
The request accepts the following data in JSON format.

Metadata (p. 648)

The metadata of the AppInstanceUser.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: .*

Required: Yes
Name (p. 648)

The name of the AppInstanceUser.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: .*\S.*

Required: Yes

648
 Amazon Chime SDK API Reference
UpdateAppInstanceUser

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"AppInstanceUserArn": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AppInstanceUserArn (p. 649)

The ARN of the AppInstanceUser.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

649
 Amazon Chime SDK API Reference
UpdateAppInstanceUser

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

650
 Amazon Chime SDK API Reference
UpdateAppInstanceUserEndpoint

UpdateAppInstanceUserEndpoint
Service: Amazon Chime SDK Identity

Updates the details of an AppInstanceUserEndpoint. You can update the name and AllowMessage
values.

Request Syntax
PUT /app-instance-users/appInstanceUserArn/endpoints/endpointId HTTP/1.1
Content-type: application/json

{
"AllowMessages": "string",
"Name": "string"
}

URI Request Parameters

The request uses the following URI parameters.

appInstanceUserArn (p. 651)

The ARN of the AppInstanceUser.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
endpointId (p. 651)

The unique identifier of the AppInstanceUserEndpoint.

Length Constraints: Minimum length of 0. Maximum length of 64.

Pattern: .*

Required: Yes

Request Body
The request accepts the following data in JSON format.

AllowMessages (p. 651)

Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages.

ALL indicates the endpoint will receive all messages. NONE indicates the endpoint will receive no
messages.

Type: String

Valid Values: ALL | NONE

Required: No
Name (p. 651)

The name of the AppInstanceUserEndpoint.

651
 Amazon Chime SDK API Reference
UpdateAppInstanceUserEndpoint

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1600.

Pattern: .*

Required: No

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"AppInstanceUserArn": "string",
"EndpointId": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AppInstanceUserArn (p. 652)

The ARN of the AppInstanceUser.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}
EndpointId (p. 652)

The unique identifier of the AppInstanceUserEndpoint.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 64.

Pattern: .*

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

652
 Amazon Chime SDK API Reference
Amazon Chime SDK Media Pipelines

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

Amazon Chime SDK Media Pipelines

The following actions are supported by Amazon Chime SDK Media Pipelines:

• CreateMediaCapturePipeline (p. 655)

• CreateMediaConcatenationPipeline (p. 660)
• CreateMediaLiveConnectorPipeline (p. 664)
• DeleteMediaCapturePipeline (p. 668)
• DeleteMediaPipeline (p. 670)
• GetMediaCapturePipeline (p. 672)

653
 Amazon Chime SDK API Reference
Amazon Chime SDK Media Pipelines

• GetMediaPipeline (p. 675)

• ListMediaCapturePipelines (p. 679)
• ListMediaPipelines (p. 682)
• ListTagsForResource (p. 685)
• TagResource (p. 687)
• UntagResource (p. 690)

654
 Amazon Chime SDK API Reference
CreateMediaCapturePipeline

CreateMediaCapturePipeline
Service: Amazon Chime SDK Media Pipelines

Creates a media pipeline.

Request Syntax
POST /sdk-media-capture-pipelines HTTP/1.1
Content-type: application/json

{
"ChimeSdkMeetingConfiguration": {
"ArtifactsConfiguration": {
"Audio": {
"MuxType": "string"
},
"CompositedVideo": {
"GridViewConfiguration": {
"ContentShareLayout": "string",
"PresenterOnlyConfiguration": {
"PresenterPosition": "string"
}
},
"Layout": "string",
"Resolution": "string"
},
"Content": {
"MuxType": "string",
"State": "string"
},
"Video": {
"MuxType": "string",
"State": "string"
}
},
"SourceConfiguration": {
"SelectedVideoStreams": {
"AttendeeIds": [ "string" ],
"ExternalUserIds": [ "string" ]
}
}
},
"ClientRequestToken": "string",
"SinkArn": "string",
"SinkType": "string",
"SourceArn": "string",
"SourceType": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}

URI Request Parameters

The request does not use any URI parameters.

655
 Amazon Chime SDK API Reference
CreateMediaCapturePipeline

Request Body
The request accepts the following data in JSON format.

ChimeSdkMeetingConfiguration (p. 655)

The configuration for a specified media pipeline. SourceType must be ChimeSdkMeeting.

Type: ChimeSdkMeetingConfiguration (p. 1249) object

Required: No
ClientRequestToken (p. 655)

The unique identifier for the client request. The token makes the API request idempotent. Use a
unique token for each media pipeline request.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

Pattern: [-_a-zA-Z0-9]*

Required: No
SinkArn (p. 655)

The ARN of the sink type.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^arn[\/\:\-\_\.a-zA-Z0-9]+$

Required: Yes
SinkType (p. 655)

Destination type to which the media artifacts are saved. You must use an S3 bucket.

Type: String

Valid Values: S3Bucket

Required: Yes
SourceArn (p. 655)

ARN of the source from which the media artifacts are captured.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^arn[\/\:\-\_\.a-zA-Z0-9]+$

Required: Yes
SourceType (p. 655)

Source type from which the media artifacts are captured. A Chime SDK Meeting is the only
supported source.

Type: String

656
 Amazon Chime SDK API Reference
CreateMediaCapturePipeline

Valid Values: ChimeSdkMeeting

Required: Yes
Tags (p. 655)

The tag key-value pairs.

Type: Array of Tag (p. 1277) objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Required: No

Response Syntax
HTTP/1.1 201
Content-type: application/json

{
"MediaCapturePipeline": {
"ChimeSdkMeetingConfiguration": {
"ArtifactsConfiguration": {
"Audio": {
"MuxType": "string"
},
"CompositedVideo": {
"GridViewConfiguration": {
"ContentShareLayout": "string",
"PresenterOnlyConfiguration": {
"PresenterPosition": "string"
}
},
"Layout": "string",
"Resolution": "string"
},
"Content": {
"MuxType": "string",
"State": "string"
},
"Video": {
"MuxType": "string",
"State": "string"
}
},
"SourceConfiguration": {
"SelectedVideoStreams": {
"AttendeeIds": [ "string" ],
"ExternalUserIds": [ "string" ]
}
}
},
"CreatedTimestamp": number,
"MediaPipelineArn": "string",
"MediaPipelineId": "string",
"SinkArn": "string",
"SinkType": "string",
"SourceArn": "string",
"SourceType": "string",
"Status": "string",
"UpdatedTimestamp": number
}
}

657
 Amazon Chime SDK API Reference
CreateMediaCapturePipeline

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

MediaCapturePipeline (p. 657)

A media pipeline object, the ID, source type, source ARN, sink type, and sink ARN of a media pipeline
object.

Type: MediaCapturePipeline (p. 1262) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

658
 Amazon Chime SDK API Reference
CreateMediaCapturePipeline

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

659
 Amazon Chime SDK API Reference
CreateMediaConcatenationPipeline

CreateMediaConcatenationPipeline
Service: Amazon Chime SDK Media Pipelines

Creates a media concatenation pipeline.

Request Syntax
POST /sdk-media-concatenation-pipelines HTTP/1.1
Content-type: application/json

{
"ClientRequestToken": "string",
"Sinks": [
{
"S3BucketSinkConfiguration": {
"Destination": "string"
},
"Type": "string"
}
],
"Sources": [
{
"MediaCapturePipelineSourceConfiguration": {
"ChimeSdkMeetingConfiguration": {
"ArtifactsConfiguration": {
"Audio": {
"State": "string"
},
"CompositedVideo": {
"State": "string"
},
"Content": {
"State": "string"
},
"DataChannel": {
"State": "string"
},
"MeetingEvents": {
"State": "string"
},
"TranscriptionMessages": {
"State": "string"
},
"Video": {
"State": "string"
}
}
},
"MediaPipelineArn": "string"
},
"Type": "string"
}
],
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}

660
 Amazon Chime SDK API Reference
CreateMediaConcatenationPipeline

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

ClientRequestToken (p. 660)

The unique identifier for the client request. The token makes the API request idempotent. Use a
unique token for each media concatenation pipeline request.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

Pattern: [-_a-zA-Z0-9]*

Required: No
Sinks (p. 660)

An object that specifies the data sinks for the media concatenation pipeline.

Type: Array of ConcatenationSink (p. 1253) objects

Array Members: Fixed number of 1 item.

Required: Yes
Sources (p. 660)

An object that specifies the sources for the media concatenation pipeline.

Type: Array of ConcatenationSource (p. 1254) objects

Array Members: Fixed number of 1 item.

Required: Yes
Tags (p. 660)

The tags associated with the media concatenation pipeline.

Type: Array of Tag (p. 1277) objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Required: No

Response Syntax
HTTP/1.1 201
Content-type: application/json

{
"MediaConcatenationPipeline": {
"CreatedTimestamp": number,
"MediaPipelineArn": "string",
"MediaPipelineId": "string",

661
 Amazon Chime SDK API Reference
CreateMediaConcatenationPipeline

"Sinks": [
{
"S3BucketSinkConfiguration": {
"Destination": "string"
},
"Type": "string"
}
],
"Sources": [
{
"MediaCapturePipelineSourceConfiguration": {
"ChimeSdkMeetingConfiguration": {
"ArtifactsConfiguration": {
"Audio": {
"State": "string"
},
"CompositedVideo": {
"State": "string"
},
"Content": {
"State": "string"
},
"DataChannel": {
"State": "string"
},
"MeetingEvents": {
"State": "string"
},
"TranscriptionMessages": {
"State": "string"
},
"Video": {
"State": "string"
}
}
},
"MediaPipelineArn": "string"
},
"Type": "string"
}
],
"Status": "string",
"UpdatedTimestamp": number
}
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

MediaConcatenationPipeline (p. 661)

A media concatenation pipeline object, the ID, source type, MediaPipelineARN, and sink of a
media concatenation pipeline object.

Type: MediaConcatenationPipeline (p. 1266) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

662
 Amazon Chime SDK API Reference
CreateMediaConcatenationPipeline

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

663
 Amazon Chime SDK API Reference
CreateMediaLiveConnectorPipeline

CreateMediaLiveConnectorPipeline
Service: Amazon Chime SDK Media Pipelines

Creates a media live connector pipeline in an Amazon Chime SDK meeting.

Request Syntax
POST /sdk-media-live-connector-pipelines HTTP/1.1
Content-type: application/json

{
"ClientRequestToken": "string",
"Sinks": [
{
"RTMPConfiguration": {
"AudioChannels": "string",
"AudioSampleRate": "string",
"Url": "string"
},
"SinkType": "string"
}
],
"Sources": [
{
"ChimeSdkMeetingLiveConnectorConfiguration": {
"Arn": "string",
"CompositedVideo": {
"GridViewConfiguration": {
"ContentShareLayout": "string",
"PresenterOnlyConfiguration": {
"PresenterPosition": "string"
}
},
"Layout": "string",
"Resolution": "string"
},
"MuxType": "string",
"SourceConfiguration": {
"SelectedVideoStreams": {
"AttendeeIds": [ "string" ],
"ExternalUserIds": [ "string" ]
}
}
},
"SourceType": "string"
}
],
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}

URI Request Parameters

The request does not use any URI parameters.

664
 Amazon Chime SDK API Reference
CreateMediaLiveConnectorPipeline

Request Body
The request accepts the following data in JSON format.

ClientRequestToken (p. 664)

The token assigned to the client making the request.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

Pattern: [-_a-zA-Z0-9]*

Required: No
Sinks (p. 664)

The media live connector pipeline's data sinks.

Type: Array of LiveConnectorSinkConfiguration (p. 1260) objects

Array Members: Fixed number of 1 item.

Required: Yes
Sources (p. 664)

The media live connector pipeline's data sources.

Type: Array of LiveConnectorSourceConfiguration (p. 1261) objects

Array Members: Fixed number of 1 item.

Required: Yes
Tags (p. 664)

The tags associated with the media live connector pipeline.

Type: Array of Tag (p. 1277) objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Required: No

Response Syntax
HTTP/1.1 201
Content-type: application/json

{
"MediaLiveConnectorPipeline": {
"CreatedTimestamp": number,
"MediaPipelineArn": "string",
"MediaPipelineId": "string",
"Sinks": [
{
"RTMPConfiguration": {
"AudioChannels": "string",
"AudioSampleRate": "string",

665
 Amazon Chime SDK API Reference
CreateMediaLiveConnectorPipeline

"Url": "string"
},
"SinkType": "string"
}
],
"Sources": [
{
"ChimeSdkMeetingLiveConnectorConfiguration": {
"Arn": "string",
"CompositedVideo": {
"GridViewConfiguration": {
"ContentShareLayout": "string",
"PresenterOnlyConfiguration": {
"PresenterPosition": "string"
}
},
"Layout": "string",
"Resolution": "string"
},
"MuxType": "string",
"SourceConfiguration": {
"SelectedVideoStreams": {
"AttendeeIds": [ "string" ],
"ExternalUserIds": [ "string" ]
}
}
},
"SourceType": "string"
}
],
"Status": "string",
"UpdatedTimestamp": number
}
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

MediaLiveConnectorPipeline (p. 665)

The new media live connector pipeline.

Type: MediaLiveConnectorPipeline (p. 1268) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

666
 Amazon Chime SDK API Reference
CreateMediaLiveConnectorPipeline

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

667
 Amazon Chime SDK API Reference
DeleteMediaCapturePipeline

DeleteMediaCapturePipeline
Service: Amazon Chime SDK Media Pipelines

Deletes the media pipeline.

Request Syntax
DELETE /sdk-media-capture-pipelines/mediaPipelineId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

mediaPipelineId (p. 668)

The ID of the media pipeline being deleted.

Length Constraints: Fixed length of 36.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

668
 Amazon Chime SDK API Reference
DeleteMediaCapturePipeline

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

669
 Amazon Chime SDK API Reference
DeleteMediaPipeline

DeleteMediaPipeline
Service: Amazon Chime SDK Media Pipelines

Deletes the media pipeline.

Request Syntax
DELETE /sdk-media-pipelines/mediaPipelineId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

mediaPipelineId (p. 670)

The ID of the media pipeline to delete.

Length Constraints: Fixed length of 36.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

670
 Amazon Chime SDK API Reference
DeleteMediaPipeline

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

671
 Amazon Chime SDK API Reference
GetMediaCapturePipeline

GetMediaCapturePipeline
Service: Amazon Chime SDK Media Pipelines

Gets an existing media pipeline.

Request Syntax
GET /sdk-media-capture-pipelines/mediaPipelineId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

mediaPipelineId (p. 672)

The ID of the pipeline that you want to get.

Length Constraints: Fixed length of 36.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"MediaCapturePipeline": {
"ChimeSdkMeetingConfiguration": {
"ArtifactsConfiguration": {
"Audio": {
"MuxType": "string"
},
"CompositedVideo": {
"GridViewConfiguration": {
"ContentShareLayout": "string",
"PresenterOnlyConfiguration": {
"PresenterPosition": "string"
}
},
"Layout": "string",
"Resolution": "string"
},
"Content": {
"MuxType": "string",
"State": "string"
},
"Video": {
"MuxType": "string",
"State": "string"
}
},

672
 Amazon Chime SDK API Reference
GetMediaCapturePipeline

"SourceConfiguration": {
"SelectedVideoStreams": {
"AttendeeIds": [ "string" ],
"ExternalUserIds": [ "string" ]
}
}
},
"CreatedTimestamp": number,
"MediaPipelineArn": "string",
"MediaPipelineId": "string",
"SinkArn": "string",
"SinkType": "string",
"SourceArn": "string",
"SourceType": "string",
"Status": "string",
"UpdatedTimestamp": number
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

MediaCapturePipeline (p. 672)

The media pipeline object.

Type: MediaCapturePipeline (p. 1262) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

673
 Amazon Chime SDK API Reference
GetMediaCapturePipeline

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

674
 Amazon Chime SDK API Reference
GetMediaPipeline

GetMediaPipeline
Service: Amazon Chime SDK Media Pipelines

Gets an existing media pipeline.

Request Syntax
GET /sdk-media-pipelines/mediaPipelineId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

mediaPipelineId (p. 675)

The ID of the pipeline that you want to get.

Length Constraints: Fixed length of 36.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"MediaPipeline": {
"MediaCapturePipeline": {
"ChimeSdkMeetingConfiguration": {
"ArtifactsConfiguration": {
"Audio": {
"MuxType": "string"
},
"CompositedVideo": {
"GridViewConfiguration": {
"ContentShareLayout": "string",
"PresenterOnlyConfiguration": {
"PresenterPosition": "string"
}
},
"Layout": "string",
"Resolution": "string"
},
"Content": {
"MuxType": "string",
"State": "string"
},
"Video": {
"MuxType": "string",

675
 Amazon Chime SDK API Reference
GetMediaPipeline

"State": "string"
}
},
"SourceConfiguration": {
"SelectedVideoStreams": {
"AttendeeIds": [ "string" ],
"ExternalUserIds": [ "string" ]
}
}
},
"CreatedTimestamp": number,
"MediaPipelineArn": "string",
"MediaPipelineId": "string",
"SinkArn": "string",
"SinkType": "string",
"SourceArn": "string",
"SourceType": "string",
"Status": "string",
"UpdatedTimestamp": number
},
"MediaConcatenationPipeline": {
"CreatedTimestamp": number,
"MediaPipelineArn": "string",
"MediaPipelineId": "string",
"Sinks": [
{
"S3BucketSinkConfiguration": {
"Destination": "string"
},
"Type": "string"
}
],
"Sources": [
{
"MediaCapturePipelineSourceConfiguration": {
"ChimeSdkMeetingConfiguration": {
"ArtifactsConfiguration": {
"Audio": {
"State": "string"
},
"CompositedVideo": {
"State": "string"
},
"Content": {
"State": "string"
},
"DataChannel": {
"State": "string"
},
"MeetingEvents": {
"State": "string"
},
"TranscriptionMessages": {
"State": "string"
},
"Video": {
"State": "string"
}
}
},
"MediaPipelineArn": "string"
},
"Type": "string"
}
],
"Status": "string",

676
 Amazon Chime SDK API Reference
GetMediaPipeline

"UpdatedTimestamp": number
},
"MediaLiveConnectorPipeline": {
"CreatedTimestamp": number,
"MediaPipelineArn": "string",
"MediaPipelineId": "string",
"Sinks": [
{
"RTMPConfiguration": {
"AudioChannels": "string",
"AudioSampleRate": "string",
"Url": "string"
},
"SinkType": "string"
}
],
"Sources": [
{
"ChimeSdkMeetingLiveConnectorConfiguration": {
"Arn": "string",
"CompositedVideo": {
"GridViewConfiguration": {
"ContentShareLayout": "string",
"PresenterOnlyConfiguration": {
"PresenterPosition": "string"
}
},
"Layout": "string",
"Resolution": "string"
},
"MuxType": "string",
"SourceConfiguration": {
"SelectedVideoStreams": {
"AttendeeIds": [ "string" ],
"ExternalUserIds": [ "string" ]
}
}
},
"SourceType": "string"
}
],
"Status": "string",
"UpdatedTimestamp": number
}
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

MediaPipeline (p. 675)

The media pipeline object.

Type: MediaPipeline (p. 1270) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

677
 Amazon Chime SDK API Reference
GetMediaPipeline

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

678
 Amazon Chime SDK API Reference
ListMediaCapturePipelines

ListMediaCapturePipelines
Service: Amazon Chime SDK Media Pipelines

Returns a list of media pipelines.

Request Syntax
GET /sdk-media-capture-pipelines?max-results=MaxResults&next-token=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MaxResults (p. 679)

The maximum number of results to return in a single call. Valid Range: 1 - 99.

Valid Range: Minimum value of 1. Maximum value of 100.

NextToken (p. 679)

The token used to retrieve the next page of results.

Length Constraints: Maximum length of 4096.

Pattern: .*

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"MediaCapturePipelines": [
{
"MediaPipelineArn": "string",
"MediaPipelineId": "string"
}
],
"NextToken": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

MediaCapturePipelines (p. 679)

The media pipeline objects in the list.

Type: Array of MediaCapturePipelineSummary (p. 1265) objects

679
 Amazon Chime SDK API Reference
ListMediaCapturePipelines

NextToken (p. 679)

The token used to retrieve the next page of results.

Type: String

Length Constraints: Maximum length of 4096.

Pattern: .*

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

680
 Amazon Chime SDK API Reference
ListMediaCapturePipelines

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

681
 Amazon Chime SDK API Reference
ListMediaPipelines

ListMediaPipelines
Service: Amazon Chime SDK Media Pipelines

Returns a list of media pipelines.

Request Syntax
GET /sdk-media-pipelines?max-results=MaxResults&next-token=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MaxResults (p. 682)

The maximum number of results to return in a single call. Valid Range: 1 - 99.

Valid Range: Minimum value of 1. Maximum value of 100.

NextToken (p. 682)

The token used to retrieve the next page of results.

Length Constraints: Maximum length of 4096.

Pattern: .*

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"MediaPipelines": [
{
"MediaPipelineArn": "string",
"MediaPipelineId": "string"
}
],
"NextToken": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

MediaPipelines (p. 682)

The media pipeline objects in the list.

Type: Array of MediaPipelineSummary (p. 1271) objects

682
 Amazon Chime SDK API Reference
ListMediaPipelines

NextToken (p. 682)

The token used to retrieve the next page of results.

Type: String

Length Constraints: Maximum length of 4096.

Pattern: .*

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

683
 Amazon Chime SDK API Reference
ListMediaPipelines

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

684
 Amazon Chime SDK API Reference
ListTagsForResource

ListTagsForResource
Service: Amazon Chime SDK Media Pipelines

Lists the tags available for a media pipeline.

Request Syntax
GET /tags?arn=ResourceARN HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

ResourceARN (p. 685)

The ARN of the media pipeline associated with any tags. The ARN consists of the pipeline's region,
resource ID, and pipeline ID.

Length Constraints: Minimum length of 1. Maximum length of 1011.

Pattern: ^arn[\/\:\-\_\.a-zA-Z0-9]+$

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Tags (p. 685)

The tags associated with the specified media pipeline.

Type: Array of Tag (p. 1277) objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

685
 Amazon Chime SDK API Reference
ListTagsForResource

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

686
 Amazon Chime SDK API Reference
TagResource

TagResource
Service: Amazon Chime SDK Media Pipelines

The ARN of the media pipeline that you want to tag. Consists of he pipeline's endpoint region, resource
ID, and pipeline ID.

Request Syntax
POST /tags?operation=tag-resource HTTP/1.1
Content-type: application/json

{
"ResourceARN": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

ResourceARN (p. 687)

The ARN of the media pipeline associated with any tags. The ARN consists of the pipeline's endpoint
region, resource ID, and pipeline ID.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1011.

Pattern: ^arn[\/\:\-\_\.a-zA-Z0-9]+$

Required: Yes
Tags (p. 687)

The tags associated with the specified media pipeline.

Type: Array of Tag (p. 1277) objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Required: Yes

Response Syntax
HTTP/1.1 204

687
 Amazon Chime SDK API Reference
TagResource

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3

688
 Amazon Chime SDK API Reference
TagResource

• AWS SDK for Python

• AWS SDK for Ruby V3

689
 Amazon Chime SDK API Reference
UntagResource

UntagResource
Service: Amazon Chime SDK Media Pipelines

Removes any tags from a media pipeline.

Request Syntax
POST /tags?operation=untag-resource HTTP/1.1
Content-type: application/json

{
"ResourceARN": "string",
"TagKeys": [ "string" ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

ResourceARN (p. 690)

The ARN of the pipeline that you want to untag.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1011.

Pattern: ^arn[\/\:\-\_\.a-zA-Z0-9]+$

Required: Yes
TagKeys (p. 690)

The key/value pairs in the tag that you want to remove.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: Yes

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

690
 Amazon Chime SDK API Reference
UntagResource

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

691
 Amazon Chime SDK API Reference
Amazon Chime SDK Meetings

Amazon Chime SDK Meetings

The following actions are supported by Amazon Chime SDK Meetings:

• BatchCreateAttendee (p. 693)

• BatchUpdateAttendeeCapabilitiesExcept (p. 696)
• CreateAttendee (p. 699)
• CreateMeeting (p. 703)
• CreateMeetingWithAttendees (p. 708)
• DeleteAttendee (p. 713)
• DeleteMeeting (p. 715)
• GetAttendee (p. 717)
• GetMeeting (p. 720)
• ListAttendees (p. 723)
• ListTagsForResource (p. 726)
• StartMeetingTranscription (p. 728)
• StopMeetingTranscription (p. 731)
• TagResource (p. 733)
• UntagResource (p. 735)
• UpdateAttendeeCapabilities (p. 737)

692
 Amazon Chime SDK API Reference
BatchCreateAttendee

BatchCreateAttendee
Service: Amazon Chime SDK Meetings

Creates up to 100 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 Developer Guide.

Request Syntax
POST /meetings/MeetingId/attendees?operation=batch-create HTTP/1.1
Content-type: application/json

{
"Attendees": [
{
"Capabilities": {
"Audio": "string",
"Content": "string",
"Video": "string"
},
"ExternalUserId": "string"
}
]
}

URI Request Parameters

The request uses the following URI parameters.

MeetingId (p. 693)

The Amazon Chime SDK ID of the meeting to which you're adding attendees.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: Yes

Request Body
The request accepts the following data in JSON format.

Attendees (p. 693)

The attendee information, including attendees' IDs and join tokens.

Type: Array of CreateAttendeeRequestItem (p. 1288) objects

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Required: Yes

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"Attendees": [

693
 Amazon Chime SDK API Reference
BatchCreateAttendee

{
"AttendeeId": "string",
"Capabilities": {
"Audio": "string",
"Content": "string",
"Video": "string"
},
"ExternalUserId": "string",
"JoinToken": "string"
}
],
"Errors": [
{
"ErrorCode": "string",
"ErrorMessage": "string",
"ExternalUserId": "string"
}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Attendees (p. 693)

The attendee information, including attendees' IDs and join tokens.

Type: Array of Attendee (p. 1281) objects

Errors (p. 693)

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.

Type: Array of CreateAttendeeError (p. 1287) objects

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

LimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

NotFoundException

One or more of the resources in the request does not exist in the system.

694
 Amazon Chime SDK API Reference
BatchCreateAttendee

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottlingException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedException

The user isn't authorized to request a resource.

HTTP Status Code: 401

UnprocessableEntityException

The request was well-formed but was unable to be followed due to semantic errors.

HTTP Status Code: 422

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

695
 Amazon Chime SDK API Reference
BatchUpdateAttendeeCapabilitiesExcept

BatchUpdateAttendeeCapabilitiesExcept
Service: Amazon Chime SDK Meetings

Updates AttendeeCapabilities except the capabilities listed in an ExcludedAttendeeIds table.

Note
You use the capabilities with a set of values that control what the capabilities can
do, such as SendReceive data. For more information about those values, see
AttendeeCapabilities (p. 1283).

When using capabilities, be aware of these corner cases:

• You can't set content capabilities to SendReceive or Receive unless you also set video
capabilities to SendReceive or Receive. If you don't set the video capability to receive, the
response will contain an HTTP 400 Bad Request status code. However, you can set your video
capability to receive and you set your content capability to not receive.
• When you change an audio capability from None or Receive to Send or SendReceive , and if the
attendee left their microphone unmuted, audio will flow from the attendee to the other meeting
participants.
• When you change a video or content capability from None or Receive to Send or SendReceive
, and if the attendee turned on their video or content streams, remote attendess can receive those
streams, but only after media renegotiation between the client and the Amazon Chime back-end
server.

Request Syntax
PUT /meetings/MeetingId/attendees/capabilities?operation=batch-update-except HTTP/1.1
Content-type: application/json

{
"Capabilities": {
"Audio": "string",
"Content": "string",
"Video": "string"
},
"ExcludedAttendeeIds": [
{
"AttendeeId": "string"
}
]
}

URI Request Parameters

The request uses the following URI parameters.

MeetingId (p. 696)

The ID of the meeting associated with the update request.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: Yes

Request Body
The request accepts the following data in JSON format.

696
 Amazon Chime SDK API Reference
BatchUpdateAttendeeCapabilitiesExcept

Capabilities (p. 696)

The capabilities (audio, video, or content) that you want to update.

Type: AttendeeCapabilities (p. 1283) object

Required: Yes
ExcludedAttendeeIds (p. 696)

The AttendeeIDs that you want to exclude from one or more capabilities.

Type: Array of AttendeeIdItem (p. 1285) objects

Array Members: Minimum number of 1 item. Maximum number of 250 items.

Required: Yes

Response Syntax
HTTP/1.1 200

Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

Multiple instances of the same request have been made simultaneously.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

UnauthorizedException

The user isn't authorized to request a resource.

697
 Amazon Chime SDK API Reference
BatchUpdateAttendeeCapabilitiesExcept

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

698
 Amazon Chime SDK API Reference
CreateAttendee

CreateAttendee
Service: Amazon Chime SDK Meetings

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 Developer Guide.

Request Syntax
POST /meetings/MeetingId/attendees HTTP/1.1
Content-type: application/json

{
"Capabilities": {
"Audio": "string",
"Content": "string",
"Video": "string"
},
"ExternalUserId": "string"
}

URI Request Parameters

The request uses the following URI parameters.

MeetingId (p. 699)

The unique ID of the meeting.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: Yes

Request Body
The request accepts the following data in JSON format.

Capabilities (p. 699)

The capabilities (audio, video, or content) that you want to grant an attendee. If you don't
specify capabilities, all users have send and receive capabilities on all media channels by default.
Note
You use the capabilities with a set of values that control what the capabilities can
do, such as SendReceive data. For more information about those values, see
AttendeeCapabilities (p. 1283).

When using capabilities, be aware of these corner cases:

• You can't set content capabilities to SendReceive or Receive unless you also set video
capabilities to SendReceive or Receive. If you don't set the video capability to receive, the
response will contain an HTTP 400 Bad Request status code. However, you can set your video
capability to receive and you set your content capability to not receive.
• When you change an audio capability from None or Receive to Send or SendReceive , and
if the attendee left their microphone unmuted, audio will flow from the attendee to the other
meeting participants.
• When you change a video or content capability from None or Receive to Send or
SendReceive , and if the attendee turned on their video or content streams, remote attendess

699
 Amazon Chime SDK API Reference
CreateAttendee

can receive those streams, but only after media renegotiation between the client and the Amazon
Chime back-end server.

Type: AttendeeCapabilities (p. 1283) object

Required: No
ExternalUserId (p. 699)

The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity
managed by a builder application.

Pattern: [-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*

Values that begin with aws: are reserved. You can't configure a value that uses this prefix.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

Required: Yes

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"Attendee": {
"AttendeeId": "string",
"Capabilities": {
"Audio": "string",
"Content": "string",
"Video": "string"
},
"ExternalUserId": "string",
"JoinToken": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Attendee (p. 700)

The attendee information, including attendee ID and join token.

Type: Attendee (p. 1281) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

700
 Amazon Chime SDK API Reference
CreateAttendee

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

LimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottlingException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedException

The user isn't authorized to request a resource.

HTTP Status Code: 401

UnprocessableEntityException

The request was well-formed but was unable to be followed due to semantic errors.

HTTP Status Code: 422

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

701
Amazon Chime SDK API Reference
CreateAttendee

702
 Amazon Chime SDK API Reference
CreateMeeting

CreateMeeting
Service: Amazon Chime SDK Meetings

Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees. For
more information about specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon
Chime Developer Guide. For more information about the Amazon Chime SDK, see Using the Amazon
Chime SDK in the Amazon Chime Developer Guide.

Request Syntax
POST /meetings HTTP/1.1
Content-type: application/json

{
"ClientRequestToken": "string",
"ExternalMeetingId": "string",
"MediaRegion": "string",
"MeetingFeatures": {
"Audio": {
"EchoReduction": "string"
}
},
"MeetingHostId": "string",
"NotificationsConfiguration": {
"LambdaFunctionArn": "string",
"SnsTopicArn": "string",
"SqsQueueArn": "string"
},
"PrimaryMeetingId": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"TenantIds": [ "string" ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

ClientRequestToken (p. 703)

The unique identifier for the client request. Use a different token for different meetings.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

Pattern: [-_a-zA-Z0-9]*

Required: Yes
ExternalMeetingId (p. 703)

The external meeting ID.

703
 Amazon Chime SDK API Reference
CreateMeeting

Pattern: [-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*

Values that begin with aws: are reserved. You can't configure a value that uses this prefix. Case
insensitive.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

Required: Yes
MediaRegion (p. 703)

The Region in which to create the meeting.

Available values: af-south-1, ap-northeast-1, ap-northeast-2, ap-south-1, ap-

southeast-1, ap-southeast-2, ca-central-1, eu-central-1, eu-north-1, eu-south-1,
eu-west-1, eu-west-2, eu-west-3, sa-east-1, us-east-1, us-east-2, us-west-1, us-
west-2.

Available values in AWS GovCloud (US) Regions: us-gov-east-1, us-gov-west-1.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

Required: Yes
MeetingFeatures (p. 703)

Lists the audio and video features enabled for a meeting, such as echo reduction.

Type: MeetingFeaturesConfiguration (p. 1298) object

Required: No
MeetingHostId (p. 703)

Reserved.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

Required: No
NotificationsConfiguration (p. 703)

The configuration for resource targets to receive notifications when meeting and attendee events
occur.

Type: NotificationsConfiguration (p. 1299) object

Required: No
PrimaryMeetingId (p. 703)

When specified, replicates the media from the primary meeting to the new meeting.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

Required: No

704
 Amazon Chime SDK API Reference
CreateMeeting

Tags (p. 703)

Applies one or more tags to an Amazon Chime SDK meeting. Note the following:
• Not all resources have tags. For a list of services with resources that support tagging using this
operation, see Services that support the Resource Groups Tagging API. If the resource doesn't yet
support this operation, the resource's service might support tagging using its own API operations.
For more information, refer to the documentation for that service.
• Each resource can have up to 50 tags. For other limits, see Tag Naming and Usage Conventions in
the AWS General Reference.
• You can only tag resources that are located in the specified AWS Region for the AWS account.
• To add tags to a resource, you need the necessary permissions for the service that the resource
belongs to as well as permissions for adding tags. For more information, see the documentation
for each service.
Important
Do not store personally identifiable information (PII) or other confidential or sensitive
information in tags. We use tags to provide you with billing and administration services.
Tags are not intended to be used for private or sensitive data.

Minimum permissions

In addition to the tag:TagResources permission required by this operation, you must also have
the tagging permission defined by the service that created the resource. For example, to tag a
ChimeSDKMeetings instance using the TagResources operation, you must have both of the
following permissions:

tag:TagResources

ChimeSDKMeetings:CreateTags
Note
Some services might have specific requirements for tagging some resources. For example, to
tag an Amazon S3 bucket, you must also have the s3:GetBucketTagging permission. If
the expected minimum permissions don't work, check the documentation for that service's
tagging APIs for more information.

Type: Array of Tag (p. 1300) objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Required: No
TenantIds (p. 703)

A consistent and opaque identifier, created and maintained by the builder to represent a segment of
their users.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 5 items.

Length Constraints: Minimum length of 2. Maximum length of 256.

Pattern: ^(?!.*?(.)\1{3})[-_!@#$a-zA-Z0-9]*$

Required: No

Response Syntax
HTTP/1.1 200

705
 Amazon Chime SDK API Reference
CreateMeeting

Content-type: application/json

{
"Meeting": {
"ExternalMeetingId": "string",
"MediaPlacement": {
"AudioFallbackUrl": "string",
"AudioHostUrl": "string",
"EventIngestionUrl": "string",
"ScreenDataUrl": "string",
"ScreenSharingUrl": "string",
"ScreenViewingUrl": "string",
"SignalingUrl": "string",
"TurnControlUrl": "string"
},
"MediaRegion": "string",
"MeetingArn": "string",
"MeetingFeatures": {
"Audio": {
"EchoReduction": "string"
}
},
"MeetingHostId": "string",
"MeetingId": "string",
"PrimaryMeetingId": "string",
"TenantIds": [ "string" ]
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Meeting (p. 705)

The meeting information, including the meeting ID and MediaPlacement.

Type: Meeting (p. 1296) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

LimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

706
 Amazon Chime SDK API Reference
CreateMeeting

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottlingException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedException

The user isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

707
 Amazon Chime SDK API Reference
CreateMeetingWithAttendees

CreateMeetingWithAttendees
Service: Amazon Chime SDK Meetings

Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees. For more
information about specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon
Chime Developer Guide. For more information about the Amazon Chime SDK, see Using the Amazon
Chime SDK in the Amazon Chime Developer Guide.

Request Syntax
POST /meetings?operation=create-attendees HTTP/1.1
Content-type: application/json

{
"Attendees": [
{
"Capabilities": {
"Audio": "string",
"Content": "string",
"Video": "string"
},
"ExternalUserId": "string"
}
],
"ClientRequestToken": "string",
"ExternalMeetingId": "string",
"MediaRegion": "string",
"MeetingFeatures": {
"Audio": {
"EchoReduction": "string"
}
},
"MeetingHostId": "string",
"NotificationsConfiguration": {
"LambdaFunctionArn": "string",
"SnsTopicArn": "string",
"SqsQueueArn": "string"
},
"PrimaryMeetingId": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"TenantIds": [ "string" ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

Attendees (p. 708)

The attendee information, including attendees' IDs and join tokens.

708
 Amazon Chime SDK API Reference
CreateMeetingWithAttendees

Type: Array of CreateAttendeeRequestItem (p. 1288) objects

Array Members: Minimum number of 1 item. Maximum number of 20 items.

Required: Yes
ClientRequestToken (p. 708)

The unique identifier for the client request. Use a different token for different meetings.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

Pattern: [-_a-zA-Z0-9]*

Required: Yes
ExternalMeetingId (p. 708)

The external meeting ID.

Pattern: [-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*

Values that begin with aws: are reserved. You can't configure a value that uses this prefix. Case
insensitive.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

Required: Yes
MediaRegion (p. 708)

The Region in which to create the meeting.

Available values: af-south-1, ap-northeast-1, ap-northeast-2, ap-south-1, ap-

southeast-1, ap-southeast-2, ca-central-1, eu-central-1, eu-north-1, eu-south-1,
eu-west-1, eu-west-2, eu-west-3, sa-east-1, us-east-1, us-east-2, us-west-1, us-
west-2.

Available values in AWS GovCloud (US) Regions: us-gov-east-1, us-gov-west-1.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

Required: Yes
MeetingFeatures (p. 708)

Lists the audio and video features enabled for a meeting, such as echo reduction.

Type: MeetingFeaturesConfiguration (p. 1298) object

Required: No
MeetingHostId (p. 708)

Reserved.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

709
 Amazon Chime SDK API Reference
CreateMeetingWithAttendees

Required: No
NotificationsConfiguration (p. 708)

The configuration for resource targets to receive notifications when meeting and attendee events
occur.

Type: NotificationsConfiguration (p. 1299) object

Required: No
PrimaryMeetingId (p. 708)

When specified, replicates the media from the primary meeting to the new meeting.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

Required: No
Tags (p. 708)

The tags in the request.

Type: Array of Tag (p. 1300) objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Required: No
TenantIds (p. 708)

A consistent and opaque identifier, created and maintained by the builder to represent a segment of
their users.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 5 items.

Length Constraints: Minimum length of 2. Maximum length of 256.

Pattern: ^(?!.*?(.)\1{3})[-_!@#$a-zA-Z0-9]*$

Required: No

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"Attendees": [
{
"AttendeeId": "string",
"Capabilities": {
"Audio": "string",
"Content": "string",
"Video": "string"
},
"ExternalUserId": "string",
"JoinToken": "string"
}

710
 Amazon Chime SDK API Reference
CreateMeetingWithAttendees

],
"Errors": [
{
"ErrorCode": "string",
"ErrorMessage": "string",
"ExternalUserId": "string"
}
],
"Meeting": {
"ExternalMeetingId": "string",
"MediaPlacement": {
"AudioFallbackUrl": "string",
"AudioHostUrl": "string",
"EventIngestionUrl": "string",
"ScreenDataUrl": "string",
"ScreenSharingUrl": "string",
"ScreenViewingUrl": "string",
"SignalingUrl": "string",
"TurnControlUrl": "string"
},
"MediaRegion": "string",
"MeetingArn": "string",
"MeetingFeatures": {
"Audio": {
"EchoReduction": "string"
}
},
"MeetingHostId": "string",
"MeetingId": "string",
"PrimaryMeetingId": "string",
"TenantIds": [ "string" ]
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Attendees (p. 710)

The attendee information, including attendees' IDs and join tokens.

Type: Array of Attendee (p. 1281) objects

Errors (p. 710)

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.

Type: Array of CreateAttendeeError (p. 1287) objects

Meeting (p. 710)

The meeting information, including the meeting ID and MediaPlacement.

Type: Meeting (p. 1296) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

711
 Amazon Chime SDK API Reference
CreateMeetingWithAttendees

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

LimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottlingException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedException

The user isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

712
 Amazon Chime SDK API Reference
DeleteAttendee

DeleteAttendee
Service: Amazon Chime SDK Meetings

Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their JoinToken.
Attendees are automatically deleted when a Amazon Chime SDK meeting is deleted. For more
information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime
Developer Guide.

Request Syntax
DELETE /meetings/MeetingId/attendees/AttendeeId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

AttendeeId (p. 713)

The Amazon Chime SDK attendee ID.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: Yes
MeetingId (p. 713)

The Amazon Chime SDK meeting ID.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

713
 Amazon Chime SDK API Reference
DeleteAttendee

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottlingException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedException

The user isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

714
 Amazon Chime SDK API Reference
DeleteMeeting

DeleteMeeting
Service: Amazon Chime SDK Meetings

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 Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

Request Syntax
DELETE /meetings/MeetingId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MeetingId (p. 715)

The Amazon Chime SDK meeting ID.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

715
 Amazon Chime SDK API Reference
DeleteMeeting

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottlingException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedException

The user isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

716
 Amazon Chime SDK API Reference
GetAttendee

GetAttendee
Service: Amazon Chime SDK Meetings

Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID. For more
information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime
Developer Guide.

Request Syntax
GET /meetings/MeetingId/attendees/AttendeeId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

AttendeeId (p. 717)

The Amazon Chime SDK attendee ID.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: Yes
MeetingId (p. 717)

The Amazon Chime SDK meeting ID.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"Attendee": {
"AttendeeId": "string",
"Capabilities": {
"Audio": "string",
"Content": "string",
"Video": "string"
},
"ExternalUserId": "string",
"JoinToken": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

717
 Amazon Chime SDK API Reference
GetAttendee

The following data is returned in JSON format by the service.

Attendee (p. 717)

The Amazon Chime SDK attendee information.

Type: Attendee (p. 1281) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottlingException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedException

The user isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go

718
 Amazon Chime SDK API Reference
GetAttendee

• AWS SDK for Java V2

• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

719
 Amazon Chime SDK API Reference
GetMeeting

GetMeeting
Service: Amazon Chime SDK Meetings

Gets the Amazon Chime SDK meeting details for the specified meeting ID. For more information about
the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

Request Syntax
GET /meetings/MeetingId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MeetingId (p. 720)

The Amazon Chime SDK meeting ID.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"Meeting": {
"ExternalMeetingId": "string",
"MediaPlacement": {
"AudioFallbackUrl": "string",
"AudioHostUrl": "string",
"EventIngestionUrl": "string",
"ScreenDataUrl": "string",
"ScreenSharingUrl": "string",
"ScreenViewingUrl": "string",
"SignalingUrl": "string",
"TurnControlUrl": "string"
},
"MediaRegion": "string",
"MeetingArn": "string",
"MeetingFeatures": {
"Audio": {
"EchoReduction": "string"
}
},
"MeetingHostId": "string",
"MeetingId": "string",
"PrimaryMeetingId": "string",
"TenantIds": [ "string" ]
}
}

720
 Amazon Chime SDK API Reference
GetMeeting

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Meeting (p. 720)

The Amazon Chime SDK meeting information.

Type: Meeting (p. 1296) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottlingException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedException

The user isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

721
 Amazon Chime SDK API Reference
GetMeeting

• AWS SDK for .NET

• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

722
 Amazon Chime SDK API Reference
ListAttendees

ListAttendees
Service: Amazon Chime SDK Meetings

Lists the attendees for the specified Amazon Chime SDK meeting. For more information about the
Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

Request Syntax
GET /meetings/MeetingId/attendees?max-results=MaxResults&next-token=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MaxResults (p. 723)

The maximum number of results to return in a single call.

Valid Range: Minimum value of 1. Maximum value of 100.

MeetingId (p. 723)

The Amazon Chime SDK meeting ID.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: Yes
NextToken (p. 723)

The token to use to retrieve the next page of results.

Length Constraints: Maximum length of 4096.

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"Attendees": [
{
"AttendeeId": "string",
"Capabilities": {
"Audio": "string",
"Content": "string",
"Video": "string"
},
"ExternalUserId": "string",
"JoinToken": "string"
}
],
"NextToken": "string"
}

723
 Amazon Chime SDK API Reference
ListAttendees

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Attendees (p. 723)

The Amazon Chime SDK attendee information.

Type: Array of Attendee (p. 1281) objects

NextToken (p. 723)

The token to use to retrieve the next page of results.

Type: String

Length Constraints: Maximum length of 4096.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottlingException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedException

The user isn't authorized to request a resource.

HTTP Status Code: 401

724
 Amazon Chime SDK API Reference
ListAttendees

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

725
 Amazon Chime SDK API Reference
ListTagsForResource

ListTagsForResource
Service: Amazon Chime SDK Meetings

Returns a list of the tags available for the specified resource.

Request Syntax
GET /tags?arn=ResourceARN HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

ResourceARN (p. 726)

The ARN of the resource.

Length Constraints: Minimum length of 1. Maximum length of 1011.

Pattern: ^arn:.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Tags (p. 726)

The tags requested for the specified resource.

Type: Array of Tag (p. 1300) objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

726
 Amazon Chime SDK API Reference
ListTagsForResource

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

ResourceNotFoundException

The resource that you want to tag couldn't be found.

HTTP Status Code: 404

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

727
 Amazon Chime SDK API Reference
StartMeetingTranscription

StartMeetingTranscription
Service: Amazon Chime SDK Meetings

Starts transcription for the specified meetingId. For more information, refer to Using Amazon Chime
SDK live transcription in the Amazon Chime SDK Developer Guide.
Important
Amazon Chime SDK live transcription is powered by Amazon Transcribe. Use of Amazon
Transcribe is subject to the AWS Service Terms, including the terms specific to the AWS Machine
Learning and Artificial Intelligence Services.

Request Syntax
POST /meetings/MeetingId/transcription?operation=start HTTP/1.1
Content-type: application/json

{
"TranscriptionConfiguration": {
"EngineTranscribeMedicalSettings": {
"ContentIdentificationType": "string",
"LanguageCode": "string",
"Region": "string",
"Specialty": "string",
"Type": "string",
"VocabularyName": "string"
},
"EngineTranscribeSettings": {
"ContentIdentificationType": "string",
"ContentRedactionType": "string",
"EnablePartialResultsStabilization": boolean,
"IdentifyLanguage": boolean,
"LanguageCode": "string",
"LanguageModelName": "string",
"LanguageOptions": "string",
"PartialResultsStability": "string",
"PiiEntityTypes": "string",
"PreferredLanguage": "string",
"Region": "string",
"VocabularyFilterMethod": "string",
"VocabularyFilterName": "string",
"VocabularyName": "string"
}
}
}

URI Request Parameters

The request uses the following URI parameters.

MeetingId (p. 728)

The unique ID of the meeting being transcribed.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: Yes

Request Body
The request accepts the following data in JSON format.

728
 Amazon Chime SDK API Reference
StartMeetingTranscription

TranscriptionConfiguration (p. 728)

The configuration for the current transcription operation. Must contain

EngineTranscribeSettings or EngineTranscribeMedicalSettings.

Type: TranscriptionConfiguration (p. 1301) object

Required: Yes

Response Syntax
HTTP/1.1 200

Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

LimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottlingException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

729
 Amazon Chime SDK API Reference
StartMeetingTranscription

UnauthorizedException

The user isn't authorized to request a resource.

HTTP Status Code: 401

UnprocessableEntityException

The request was well-formed but was unable to be followed due to semantic errors.

HTTP Status Code: 422

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

730
 Amazon Chime SDK API Reference
StopMeetingTranscription

StopMeetingTranscription
Service: Amazon Chime SDK Meetings

Stops transcription for the specified meetingId. For more information, refer to Using Amazon Chime
SDK live transcription in the Amazon Chime SDK Developer Guide.
Important
Amazon Chime SDK live transcription is powered by Amazon Transcribe. Use of Amazon
Transcribe is subject to the AWS Service Terms, including the terms specific to the AWS Machine
Learning and Artificial Intelligence Services.

Request Syntax
POST /meetings/MeetingId/transcription?operation=stop HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MeetingId (p. 731)

The unique ID of the meeting for which you stop transcription.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200

Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

731
 Amazon Chime SDK API Reference
StopMeetingTranscription

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottlingException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedException

The user isn't authorized to request a resource.

HTTP Status Code: 401

UnprocessableEntityException

The request was well-formed but was unable to be followed due to semantic errors.

HTTP Status Code: 422

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

732
 Amazon Chime SDK API Reference
TagResource

TagResource
Service: Amazon Chime SDK Meetings

The resource that supports tags.

Request Syntax
POST /tags?operation=tag-resource HTTP/1.1
Content-type: application/json

{
"ResourceARN": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

ResourceARN (p. 733)

The ARN of the resource.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1011.

Pattern: ^arn:.*

Required: Yes
Tags (p. 733)

Lists the requested tags.

Type: Array of Tag (p. 1300) objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Required: Yes

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

733
 Amazon Chime SDK API Reference
TagResource

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ResourceNotFoundException

The resource that you want to tag couldn't be found.

HTTP Status Code: 404

TooManyTagsException

Too many tags were added to the specified resource.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

734
 Amazon Chime SDK API Reference
UntagResource

UntagResource
Service: Amazon Chime SDK Meetings

Removes the specified tags from the specified resources. When you specify a tag key, the action removes
both that key and its associated value. The operation succeeds even if you attempt to remove tags from
a resource that were already removed. Note the following:

• To remove tags from a resource, you need the necessary permissions for the service that the resource
belongs to as well as permissions for removing tags. For more information, see the documentation for
the service whose resource you want to untag.
• You can only tag resources that are located in the specified AWS Region for the calling AWS account.

Minimum permissions

In addition to the tag:UntagResources permission required by this operation, you must also have the
remove tags permission defined by the service that created the resource. For example, to remove the
tags from an Amazon EC2 instance using the UntagResources operation, you must have both of the
following permissions:

tag:UntagResource

ChimeSDKMeetings:DeleteTags

Request Syntax
POST /tags?operation=untag-resource HTTP/1.1
Content-type: application/json

{
"ResourceARN": "string",
"TagKeys": [ "string" ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

ResourceARN (p. 735)

The ARN of the resource that you're removing tags from.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1011.

Pattern: ^arn:.*

Required: Yes
TagKeys (p. 735)

The tag keys being removed from the resources.

Type: Array of strings

735
 Amazon Chime SDK API Reference
UntagResource

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z+-=._:/]+$

Required: Yes

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ResourceNotFoundException

The resource that you want to tag couldn't be found.

HTTP Status Code: 404

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

736
 Amazon Chime SDK API Reference
UpdateAttendeeCapabilities

UpdateAttendeeCapabilities
Service: Amazon Chime SDK Meetings

The capabilties that you want to update.

Note
You use the capabilities with a set of values that control what the capabilities can
do, such as SendReceive data. For more information about those values, see
AttendeeCapabilities (p. 1283).

When using capabilities, be aware of these corner cases:

• You can't set content capabilities to SendReceive or Receive unless you also set video
capabilities to SendReceive or Receive. If you don't set the video capability to receive, the
response will contain an HTTP 400 Bad Request status code. However, you can set your video
capability to receive and you set your content capability to not receive.
• When you change an audio capability from None or Receive to Send or SendReceive , and if the
attendee left their microphone unmuted, audio will flow from the attendee to the other meeting
participants.
• When you change a video or content capability from None or Receive to Send or SendReceive
, and if the attendee turned on their video or content streams, remote attendess can receive those
streams, but only after media renegotiation between the client and the Amazon Chime back-end
server.

Request Syntax
PUT /meetings/MeetingId/attendees/AttendeeId/capabilities HTTP/1.1
Content-type: application/json

{
"Capabilities": {
"Audio": "string",
"Content": "string",
"Video": "string"
}
}

URI Request Parameters

The request uses the following URI parameters.

AttendeeId (p. 737)

The ID of the attendee associated with the update request.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: Yes
MeetingId (p. 737)

The ID of the meeting associated with the update request.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: Yes

737
 Amazon Chime SDK API Reference
UpdateAttendeeCapabilities

Request Body
The request accepts the following data in JSON format.

Capabilities (p. 737)

The capabilties that you want to update.

Type: AttendeeCapabilities (p. 1283) object

Required: Yes

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"Attendee": {
"AttendeeId": "string",
"Capabilities": {
"Audio": "string",
"Content": "string",
"Video": "string"
},
"ExternalUserId": "string",
"JoinToken": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Attendee (p. 738)

The updated attendee data.

Type: Attendee (p. 1281) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

Multiple instances of the same request have been made simultaneously.

HTTP Status Code: 409

738
 Amazon Chime SDK API Reference
Amazon Chime SDK Messaging

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

UnauthorizedException

The user isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

Amazon Chime SDK Messaging

The following actions are supported by Amazon Chime SDK Messaging:

• AssociateChannelFlow (p. 741)

• BatchCreateChannelMembership (p. 744)
• ChannelFlowCallback (p. 748)
• CreateChannel (p. 751)
• CreateChannelBan (p. 756)
• CreateChannelFlow (p. 759)
• CreateChannelMembership (p. 763)
• CreateChannelModerator (p. 767)
• DeleteChannel (p. 770)
• DeleteChannelBan (p. 772)
• DeleteChannelFlow (p. 774)

739
 Amazon Chime SDK API Reference
Amazon Chime SDK Messaging

• DeleteChannelMembership (p. 776)

• DeleteChannelMessage (p. 779)
• DeleteChannelModerator (p. 782)
• DescribeChannel (p. 784)
• DescribeChannelBan (p. 787)
• DescribeChannelFlow (p. 790)
• DescribeChannelMembership (p. 793)
• DescribeChannelMembershipForAppInstanceUser (p. 796)
• DescribeChannelModeratedByAppInstanceUser (p. 799)
• DescribeChannelModerator (p. 802)
• DisassociateChannelFlow (p. 805)
• GetChannelMembershipPreferences (p. 808)
• GetChannelMessage (p. 811)
• GetChannelMessageStatus (p. 814)
• GetMessagingSessionEndpoint (p. 817)
• ListChannelBans (p. 819)
• ListChannelFlows (p. 822)
• ListChannelMemberships (p. 825)
• ListChannelMembershipsForAppInstanceUser (p. 829)
• ListChannelMessages (p. 832)
• ListChannelModerators (p. 836)
• ListChannels (p. 839)
• ListChannelsAssociatedWithChannelFlow (p. 842)
• ListChannelsModeratedByAppInstanceUser (p. 845)
• ListSubChannels (p. 848)
• ListTagsForResource (p. 851)
• PutChannelMembershipPreferences (p. 853)
• RedactChannelMessage (p. 856)
• SearchChannels (p. 860)
• SendChannelMessage (p. 863)
• TagResource (p. 868)
• UntagResource (p. 870)
• UpdateChannel (p. 872)
• UpdateChannelFlow (p. 875)
• UpdateChannelMessage (p. 878)
• UpdateChannelReadMarker (p. 882)

740
 Amazon Chime SDK API Reference
AssociateChannelFlow

AssociateChannelFlow
Service: Amazon Chime SDK Messaging

Associates a channel flow with a channel. Once associated, all messages to that channel go through
channel flow processors. To stop processing, use the DisassociateChannelFlow API.
Note
Only administrators or channel moderators can associate a channel flow. 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.

Request Syntax
PUT /channels/channelArn/channel-flow HTTP/1.1
x-amz-chime-bearer: ChimeBearer
Content-type: application/json

{
"ChannelFlowArn": "string"
}

URI Request Parameters

The request uses the following URI parameters.

channelArn (p. 741)

The ARN of the channel.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 741)

The AppInstanceUserArn of the user making the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Request Body
The request accepts the following data in JSON format.

ChannelFlowArn (p. 741)

The ARN of the channel flow.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

741
 Amazon Chime SDK API Reference
AssociateChannelFlow

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Response Syntax
HTTP/1.1 200

Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

742
 Amazon Chime SDK API Reference
AssociateChannelFlow

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

743
 Amazon Chime SDK API Reference
BatchCreateChannelMembership

BatchCreateChannelMembership
Service: Amazon Chime SDK Messaging

Adds a specified number of users to a channel.

Request Syntax
POST /channels/channelArn/memberships?operation=batch-create HTTP/1.1
x-amz-chime-bearer: ChimeBearer
Content-type: application/json

{
"MemberArns": [ "string" ],
"SubChannelId": "string",
"Type": "string"
}

URI Request Parameters

The request uses the following URI parameters.

channelArn (p. 744)

The ARN of the channel to which you're adding users.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 744)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Request Body
The request accepts the following data in JSON format.

MemberArns (p. 744)

The AppInstanceUserArns of the members you want to add to the channel.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Length Constraints: Minimum length of 5. Maximum length of 1600.

744
 Amazon Chime SDK API Reference
BatchCreateChannelMembership

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
SubChannelId (p. 744)

The ID of the SubChannel in the request.

Note
Only required when creating membership in a SubChannel for a moderator in an elastic
channel.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [-_a-zA-Z0-9]*

Required: No
Type (p. 744)

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.

Type: String

Valid Values: DEFAULT | HIDDEN

Required: No

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"BatchChannelMemberships": {
"ChannelArn": "string",
"InvitedBy": {
"Arn": "string",
"Name": "string"
},
"Members": [
{
"Arn": "string",
"Name": "string"
}
],
"SubChannelId": "string",
"Type": "string"
},
"Errors": [
{
"ErrorCode": "string",
"ErrorMessage": "string",
"MemberArn": "string"
}
]

745
 Amazon Chime SDK API Reference
BatchCreateChannelMembership

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

BatchChannelMemberships (p. 745)

The list of channel memberships in the response.

Type: BatchChannelMemberships (p. 1304) object

Errors (p. 745)

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.

Type: Array of BatchCreateChannelMembershipError (p. 1306) objects

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

746
 Amazon Chime SDK API Reference
BatchCreateChannelMembership

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

747
 Amazon Chime SDK API Reference
ChannelFlowCallback

ChannelFlowCallback
Service: Amazon Chime SDK Messaging

Calls back Chime SDK Messaging with a processing response message. This should be invoked from the
processor Lambda. This is a developer API.

You can return one of the following processing responses:

• Update message content or metadata

• Deny a message
• Make no changes to the message

Request Syntax
POST /channels/{channelArn}?operation=channel-flow-callback HTTP/1.1
Content-type: application/json

{
"CallbackId": "string",
"ChannelMessage": {
"Content": "string",
"MessageAttributes": {
"string" : {
"StringValues": [ "string" ]
}
},
"MessageId": "string",
"Metadata": "string",
"PushNotification": {
"Body": "string",
"Title": "string",
"Type": "string"
},
"SubChannelId": "string"
},
"DeleteResource": boolean
}

URI Request Parameters

The request uses the following URI parameters.

channelArn (p. 748)

The ARN of the channel.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Request Body
The request accepts the following data in JSON format.

748
 Amazon Chime SDK API Reference
ChannelFlowCallback

CallbackId (p. 748)

The identifier passed to the processor by the service when invoked. Use the identifier to call back the
service.

Type: String

Length Constraints: Minimum length of 32. Maximum length of 64.

Required: Yes
ChannelMessage (p. 748)

Stores information about the processed message.

Type: ChannelMessageCallback (p. 1325) object

Required: Yes
DeleteResource (p. 748)

When a processor determines that a message needs to be DENIED, pass this parameter with a value
of true.

Type: Boolean

Required: No

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"CallbackId": "string",
"ChannelArn": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

CallbackId (p. 749)

The call back ID passed in the request.

Type: String

Length Constraints: Minimum length of 32. Maximum length of 64.

ChannelArn (p. 749)

The ARN of the channel.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

749
 Amazon Chime SDK API Reference
ChannelFlowCallback

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

750
 Amazon Chime SDK API Reference
CreateChannel

CreateChannel
Service: Amazon Chime SDK Messaging

Creates a channel to which you can add users and send messages.

Restriction: You can't change a channel's privacy.

Note
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.

Request Syntax
POST /channels HTTP/1.1
x-amz-chime-bearer: ChimeBearer
Content-type: application/json

{
"AppInstanceArn": "string",
"ChannelId": "string",
"ClientRequestToken": "string",
"ElasticChannelConfiguration": {
"MaximumSubChannels": number,
"MinimumMembershipPercentage": number,
"TargetMembershipsPerSubChannel": number
},
"MemberArns": [ "string" ],
"Metadata": "string",
"Mode": "string",
"ModeratorArns": [ "string" ],
"Name": "string",
"Privacy": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}

URI Request Parameters

The request uses the following URI parameters.

ChimeBearer (p. 751)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Request Body
The request accepts the following data in JSON format.

751
 Amazon Chime SDK API Reference
CreateChannel

AppInstanceArn (p. 751)

The ARN of the channel request.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChannelId (p. 751)

The ID of the channel in the request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [A-Za-z0-9]([A-Za-z0-9\:\-\_\.\@]{0,62}[A-Za-z0-9])?

Required: No
ClientRequestToken (p. 751)

The client token for the request. An Idempotency token.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

Pattern: [-_a-zA-Z0-9]*

Required: Yes
ElasticChannelConfiguration (p. 751)

The attributes required to configure and create an elastic channel. An elastic channel can support a
maximum of 1-million users, excluding moderators.

Type: ElasticChannelConfiguration (p. 1335) object

Required: No
MemberArns (p. 751)

The ARNs of the channel members in the request.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: No
Metadata (p. 751)

The metadata of the creation request. Limited to 1KB and UTF-8.

Type: String

752
 Amazon Chime SDK API Reference
CreateChannel

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: .*

Required: No
Mode (p. 751)

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.

Type: String

Valid Values: UNRESTRICTED | RESTRICTED

Required: No
ModeratorArns (p. 751)

The ARNs of the channel moderators in the request.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: No
Name (p. 751)

The name of the channel.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD
\u10000-\u10FFFF]*

Required: Yes
Privacy (p. 751)

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.

Type: String

Valid Values: PUBLIC | PRIVATE

Required: No
Tags (p. 751)

The tags for the creation request.

Type: Array of Tag (p. 1348) objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

753
 Amazon Chime SDK API Reference
CreateChannel

Required: No

Response Syntax
HTTP/1.1 201
Content-type: application/json

{
"ChannelArn": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

ChannelArn (p. 754)

The ARN of the channel.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

754
 Amazon Chime SDK API Reference
CreateChannel

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

755
 Amazon Chime SDK API Reference
CreateChannelBan

CreateChannelBan
Service: Amazon Chime SDK Messaging

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.
Note
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.

Request Syntax
POST /channels/channelArn/bans HTTP/1.1
x-amz-chime-bearer: ChimeBearer
Content-type: application/json

{
"MemberArn": "string"
}

URI Request Parameters

The request uses the following URI parameters.

channelArn (p. 756)

The ARN of the ban request.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 756)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Request Body
The request accepts the following data in JSON format.

MemberArn (p. 756)

The AppInstanceUserArn of the member being banned.

Type: String

756
 Amazon Chime SDK API Reference
CreateChannelBan

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Response Syntax
HTTP/1.1 201
Content-type: application/json

{
"ChannelArn": "string",
"Member": {
"Arn": "string",
"Name": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

ChannelArn (p. 757)

The ARN of the response to the ban request.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}
Member (p. 757)

The ChannelArn and BannedIdentity of the member in the ban response.

Type: Identity (p. 1336) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

757
 Amazon Chime SDK API Reference
CreateChannelBan

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

758
 Amazon Chime SDK API Reference
CreateChannelFlow

CreateChannelFlow
Service: Amazon Chime SDK Messaging

Creates a channel flow, a container for processors. Processors are AWS Lambda functions that perform
actions on chat messages, such as stripping out profanity. You can associate channel flows with channels,
and the processors in the channel flow then take action on all messages sent to that channel. This is a
developer API.

Channel flows process the following items:

1. New and updated messages

2. Persistent and non-persistent messages
3. The Standard message type

Note
Channel flows don't process Control or System messages. For more information about the
message types provided by Chime SDK Messaging, refer to Message types in the Amazon Chime
developer guide.

Request Syntax
POST /channel-flows HTTP/1.1
Content-type: application/json

{
"AppInstanceArn": "string",
"ClientRequestToken": "string",
"Name": "string",
"Processors": [
{
"Configuration": {
"Lambda": {
"InvocationType": "string",
"ResourceArn": "string"
}
},
"ExecutionOrder": number,
"FallbackAction": "string",
"Name": "string"
}
],
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

759
 Amazon Chime SDK API Reference
CreateChannelFlow

AppInstanceArn (p. 759)

The ARN of the channel flow request.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ClientRequestToken (p. 759)

The client token for the request. An Idempotency token.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

Pattern: [-_a-zA-Z0-9]*

Required: Yes
Name (p. 759)

The name of the channel flow.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD
\u10000-\u10FFFF]*

Required: Yes
Processors (p. 759)

Information about the processor Lambda functions.

Type: Array of Processor (p. 1340) objects

Array Members: Minimum number of 1 item. Maximum number of 3 items.

Required: Yes
Tags (p. 759)

The tags for the creation request.

Type: Array of Tag (p. 1348) objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Required: No

Response Syntax
HTTP/1.1 201
Content-type: application/json

760
 Amazon Chime SDK API Reference
CreateChannelFlow

{
"ChannelFlowArn": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

ChannelFlowArn (p. 760)

The ARN of the channel flow.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

761
 Amazon Chime SDK API Reference
CreateChannelFlow

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

762
 Amazon Chime SDK API Reference
CreateChannelMembership

CreateChannelMembership
Service: Amazon Chime SDK Messaging

Adds a user to a channel. The InvitedBy field in ChannelMembership 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.

Note
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.

Request Syntax
POST /channels/channelArn/memberships HTTP/1.1
x-amz-chime-bearer: ChimeBearer
Content-type: application/json

{
"MemberArn": "string",
"SubChannelId": "string",
"Type": "string"
}

URI Request Parameters

The request uses the following URI parameters.

channelArn (p. 763)

The ARN of the channel to which you're adding users.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 763)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

763
 Amazon Chime SDK API Reference
CreateChannelMembership

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Request Body
The request accepts the following data in JSON format.

MemberArn (p. 763)

The AppInstanceUserArn of the member you want to add to the channel.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
SubChannelId (p. 763)

The ID of the SubChannel in the request.

Note
Only required when creating membership in a SubChannel for a moderator in an elastic
channel.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [-_a-zA-Z0-9]*

Required: No
Type (p. 763)

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.

Type: String

Valid Values: DEFAULT | HIDDEN

Required: Yes

Response Syntax
HTTP/1.1 201
Content-type: application/json

{
"ChannelArn": "string",
"Member": {
"Arn": "string",

764
 Amazon Chime SDK API Reference
CreateChannelMembership

"Name": "string"
},
"SubChannelId": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

ChannelArn (p. 764)

The ARN of the channel.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}
Member (p. 764)

The ARN and metadata of the member being added.

Type: Identity (p. 1336) object

SubChannelId (p. 764)

The ID of the SubChannel in the response.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [-_a-zA-Z0-9]*

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

765
 Amazon Chime SDK API Reference
CreateChannelMembership

HTTP Status Code: 404

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

766
 Amazon Chime SDK API Reference
CreateChannelModerator

CreateChannelModerator
Service: Amazon Chime SDK Messaging

Creates a new ChannelModerator. A channel moderator can:

• Add and remove other members of the channel.

• Add and remove other moderators of the channel.
• Add and remove user bans for the channel.
• Redact messages in the channel.
• List messages in the channel.

Note
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.

Request Syntax
POST /channels/channelArn/moderators HTTP/1.1
x-amz-chime-bearer: ChimeBearer
Content-type: application/json

{
"ChannelModeratorArn": "string"
}

URI Request Parameters

The request uses the following URI parameters.

channelArn (p. 767)

The ARN of the channel.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 767)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Request Body
The request accepts the following data in JSON format.

767
 Amazon Chime SDK API Reference
CreateChannelModerator

ChannelModeratorArn (p. 767)

The AppInstanceUserArn of the moderator.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Response Syntax
HTTP/1.1 201
Content-type: application/json

{
"ChannelArn": "string",
"ChannelModerator": {
"Arn": "string",
"Name": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

ChannelArn (p. 768)

The ARN of the channel.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}
ChannelModerator (p. 768)

The ARNs of the channel and the moderator.

Type: Identity (p. 1336) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

768
 Amazon Chime SDK API Reference
CreateChannelModerator

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

769
 Amazon Chime SDK API Reference
DeleteChannel

DeleteChannel
Service: Amazon Chime SDK Messaging

Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an
irreversible process.
Note
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.

Request Syntax
DELETE /channels/channelArn?sub-channel-id=SubChannelId HTTP/1.1
x-amz-chime-bearer: ChimeBearer

URI Request Parameters

The request uses the following URI parameters.

channelArn (p. 770)

The ARN of the channel being deleted.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 770)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
SubChannelId (p. 770)

The ID of the SubChannel in the request.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [-_a-zA-Z0-9]*

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

770
 Amazon Chime SDK API Reference
DeleteChannel

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

771
 Amazon Chime SDK API Reference
DeleteChannelBan

DeleteChannelBan
Service: Amazon Chime SDK Messaging

Removes a user from a channel's ban list.

Note
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.

Request Syntax
DELETE /channels/channelArn/bans/memberArn HTTP/1.1
x-amz-chime-bearer: ChimeBearer

URI Request Parameters

The request uses the following URI parameters.

channelArn (p. 772)

The ARN of the channel from which the AppInstanceUser was banned.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 772)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
memberArn (p. 772)

The ARN of the AppInstanceUser that you want to reinstate.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

772
 Amazon Chime SDK API Reference
DeleteChannelBan

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

773
 Amazon Chime SDK API Reference
DeleteChannelFlow

DeleteChannelFlow
Service: Amazon Chime SDK Messaging

Deletes a channel flow, an irreversible process. This is a developer API.

Note
This API works only when the channel flow is not associated with any channel.
To get a list of all channels that a channel flow is associated with, use the
ListChannelsAssociatedWithChannelFlow API. Use the DisassociateChannelFlow
API to disassociate a channel flow from all channels.

Request Syntax
DELETE /channel-flows/channelFlowArn HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

channelFlowArn (p. 774)

The ARN of the channel flow.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

774
 Amazon Chime SDK API Reference
DeleteChannelFlow

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

775
 Amazon Chime SDK API Reference
DeleteChannelMembership

DeleteChannelMembership
Service: Amazon Chime SDK Messaging

Removes a member from a channel.

Note
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.

Request Syntax
DELETE /channels/channelArn/memberships/memberArn?sub-channel-id=SubChannelId HTTP/1.1
x-amz-chime-bearer: ChimeBearer

URI Request Parameters

The request uses the following URI parameters.

channelArn (p. 776)

The ARN of the channel from which you want to remove the user.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 776)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
memberArn (p. 776)

The AppInstanceUserArn of the member that you're removing from the channel.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
SubChannelId (p. 776)

The ID of the SubChannel in the request.

Note
Only for use by moderators.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [-_a-zA-Z0-9]*

776
 Amazon Chime SDK API Reference
DeleteChannelMembership

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

777
 Amazon Chime SDK API Reference
DeleteChannelMembership

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

778
 Amazon Chime SDK API Reference
DeleteChannelMessage

DeleteChannelMessage
Service: Amazon Chime SDK Messaging

Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible
immediately. A background process deletes any revisions created by UpdateChannelMessage.
Note
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.

Request Syntax
DELETE /channels/channelArn/messages/messageId?sub-channel-id=SubChannelId HTTP/1.1
x-amz-chime-bearer: ChimeBearer

URI Request Parameters

The request uses the following URI parameters.

channelArn (p. 779)

The ARN of the channel.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 779)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
messageId (p. 779)

The ID of the message being deleted.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [-_a-zA-Z0-9]*

Required: Yes
SubChannelId (p. 779)

The ID of the SubChannel in the request.

Note
Only required when deleting messages in a SubChannel that the user belongs to.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [-_a-zA-Z0-9]*

779
 Amazon Chime SDK API Reference
DeleteChannelMessage

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++

780
 Amazon Chime SDK API Reference
DeleteChannelMessage

• AWS SDK for Go

• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

781
 Amazon Chime SDK API Reference
DeleteChannelModerator

DeleteChannelModerator
Service: Amazon Chime SDK Messaging

Deletes a channel moderator.

Note
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.

Request Syntax
DELETE /channels/channelArn/moderators/channelModeratorArn HTTP/1.1
x-amz-chime-bearer: ChimeBearer

URI Request Parameters

The request uses the following URI parameters.

channelArn (p. 782)

The ARN of the channel.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
channelModeratorArn (p. 782)

The AppInstanceUserArn of the moderator being deleted.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 782)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

782
 Amazon Chime SDK API Reference
DeleteChannelModerator

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

783
 Amazon Chime SDK API Reference
DescribeChannel

DescribeChannel
Service: Amazon Chime SDK Messaging

Returns the full details of a channel in an Amazon Chime AppInstance.

Note
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.

Request Syntax
GET /channels/channelArn HTTP/1.1
x-amz-chime-bearer: ChimeBearer

URI Request Parameters

The request uses the following URI parameters.

channelArn (p. 784)

The ARN of the channel.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 784)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"Channel": {
"ChannelArn": "string",
"ChannelFlowArn": "string",
"CreatedBy": {
"Arn": "string",
"Name": "string"
},

784
 Amazon Chime SDK API Reference
DescribeChannel

"CreatedTimestamp": number,
"ElasticChannelConfiguration": {
"MaximumSubChannels": number,
"MinimumMembershipPercentage": number,
"TargetMembershipsPerSubChannel": number
},
"LastMessageTimestamp": number,
"LastUpdatedTimestamp": number,
"Metadata": "string",
"Mode": "string",
"Name": "string",
"Privacy": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Channel (p. 784)

The channel details.

Type: Channel (p. 1307) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

785
 Amazon Chime SDK API Reference
DescribeChannel

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

786
 Amazon Chime SDK API Reference
DescribeChannelBan

DescribeChannelBan
Service: Amazon Chime SDK Messaging

Returns the full details of a channel ban.

Note
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.

Request Syntax
GET /channels/channelArn/bans/memberArn HTTP/1.1
x-amz-chime-bearer: ChimeBearer

URI Request Parameters

The request uses the following URI parameters.

channelArn (p. 787)

The ARN of the channel from which the user is banned.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 787)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
memberArn (p. 787)

The AppInstanceUserArn of the member being banned.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200

787
 Amazon Chime SDK API Reference
DescribeChannelBan

Content-type: application/json

{
"ChannelBan": {
"ChannelArn": "string",
"CreatedBy": {
"Arn": "string",
"Name": "string"
},
"CreatedTimestamp": number,
"Member": {
"Arn": "string",
"Name": "string"
}
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ChannelBan (p. 787)

The details of the ban.

Type: ChannelBan (p. 1312) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

788
 Amazon Chime SDK API Reference
DescribeChannelBan

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

789
 Amazon Chime SDK API Reference
DescribeChannelFlow

DescribeChannelFlow
Service: Amazon Chime SDK Messaging

Returns the full details of a channel flow in an Amazon Chime AppInstance. This is a developer API.

Request Syntax
GET /channel-flows/channelFlowArn HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

channelFlowArn (p. 790)

The ARN of the channel flow.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"ChannelFlow": {
"ChannelFlowArn": "string",
"CreatedTimestamp": number,
"LastUpdatedTimestamp": number,
"Name": "string",
"Processors": [
{
"Configuration": {
"Lambda": {
"InvocationType": "string",
"ResourceArn": "string"
}
},
"ExecutionOrder": number,
"FallbackAction": "string",
"Name": "string"
}
]
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

790
 Amazon Chime SDK API Reference
DescribeChannelFlow

The following data is returned in JSON format by the service.

ChannelFlow (p. 790)

The channel flow details.

Type: ChannelFlow (p. 1314) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python

791
 Amazon Chime SDK API Reference
DescribeChannelFlow

• AWS SDK for Ruby V3

792
 Amazon Chime SDK API Reference
DescribeChannelMembership

DescribeChannelMembership
Service: Amazon Chime SDK Messaging

Returns the full details of a user's channel membership.

Note
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.

Request Syntax
GET /channels/channelArn/memberships/memberArn?sub-channel-id=SubChannelId HTTP/1.1
x-amz-chime-bearer: ChimeBearer

URI Request Parameters

The request uses the following URI parameters.

channelArn (p. 793)

The ARN of the channel.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 793)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
memberArn (p. 793)

The AppInstanceUserArn of the member.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
SubChannelId (p. 793)

The ID of the SubChannel in the request. The response contains an

ElasticChannelConfiguration object.
Note
Only required to get a user’s SubChannel membership details.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [-_a-zA-Z0-9]*

793
 Amazon Chime SDK API Reference
DescribeChannelMembership

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"ChannelMembership": {
"ChannelArn": "string",
"CreatedTimestamp": number,
"InvitedBy": {
"Arn": "string",
"Name": "string"
},
"LastUpdatedTimestamp": number,
"Member": {
"Arn": "string",
"Name": "string"
},
"SubChannelId": "string",
"Type": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ChannelMembership (p. 794)

The details of the membership.

Type: ChannelMembership (p. 1317) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

794
 Amazon Chime SDK API Reference
DescribeChannelMembership

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

795
 Amazon Chime SDK API Reference
DescribeChannelMembershipForAppInstanceUser

DescribeChannelMembershipForAppInstanceUser
Service: Amazon Chime SDK Messaging

Returns the details of a channel based on the membership of the specified AppInstanceUser.
Note
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.

Request Syntax
GET /channels/{channelArn}?scope=app-instance-user-membership&app-instance-user-
arn=AppInstanceUserArn HTTP/1.1
x-amz-chime-bearer: ChimeBearer

URI Request Parameters

The request uses the following URI parameters.

AppInstanceUserArn (p. 796)

The ARN of the user in a channel.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
channelArn (p. 796)

The ARN of the channel to which the user belongs.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 796)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200

796
 Amazon Chime SDK API Reference
DescribeChannelMembershipForAppInstanceUser

Content-type: application/json

{
"ChannelMembership": {
"AppInstanceUserMembershipSummary": {
"ReadMarkerTimestamp": number,
"SubChannelId": "string",
"Type": "string"
},
"ChannelSummary": {
"ChannelArn": "string",
"LastMessageTimestamp": number,
"Metadata": "string",
"Mode": "string",
"Name": "string",
"Privacy": "string"
}
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ChannelMembership (p. 796)

The channel to which a user belongs.

Type: ChannelMembershipForAppInstanceUserSummary (p. 1319) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

797
 Amazon Chime SDK API Reference
DescribeChannelMembershipForAppInstanceUser

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

798
 Amazon Chime SDK API Reference
DescribeChannelModeratedByAppInstanceUser

DescribeChannelModeratedByAppInstanceUser
Service: Amazon Chime SDK Messaging

Returns the full details of a channel moderated by the specified AppInstanceUser.

Note
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.

Request Syntax
GET /channels/{channelArn}?scope=app-instance-user-moderated-channel&app-instance-user-
arn=AppInstanceUserArn HTTP/1.1
x-amz-chime-bearer: ChimeBearer

URI Request Parameters

The request uses the following URI parameters.

AppInstanceUserArn (p. 799)

The ARN of the AppInstanceUser in the moderated channel.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
channelArn (p. 799)

The ARN of the moderated channel.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 799)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200

799
 Amazon Chime SDK API Reference
DescribeChannelModeratedByAppInstanceUser

Content-type: application/json

{
"Channel": {
"ChannelSummary": {
"ChannelArn": "string",
"LastMessageTimestamp": number,
"Metadata": "string",
"Mode": "string",
"Name": "string",
"Privacy": "string"
}
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Channel (p. 799)

The moderated channel.

Type: ChannelModeratedByAppInstanceUserSummary (p. 1330) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

800
 Amazon Chime SDK API Reference
DescribeChannelModeratedByAppInstanceUser

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

801
 Amazon Chime SDK API Reference
DescribeChannelModerator

DescribeChannelModerator
Service: Amazon Chime SDK Messaging

Returns the full details of a single ChannelModerator.

Note
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.

Request Syntax
GET /channels/channelArn/moderators/channelModeratorArn HTTP/1.1
x-amz-chime-bearer: ChimeBearer

URI Request Parameters

The request uses the following URI parameters.

channelArn (p. 802)

The ARN of the channel.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
channelModeratorArn (p. 802)

The AppInstanceUserArn of the channel moderator.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 802)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200

802
 Amazon Chime SDK API Reference
DescribeChannelModerator

Content-type: application/json

{
"ChannelModerator": {
"ChannelArn": "string",
"CreatedBy": {
"Arn": "string",
"Name": "string"
},
"CreatedTimestamp": number,
"Moderator": {
"Arn": "string",
"Name": "string"
}
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ChannelModerator (p. 802)

The details of the channel moderator.

Type: ChannelModerator (p. 1331) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

803
 Amazon Chime SDK API Reference
DescribeChannelModerator

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

804
 Amazon Chime SDK API Reference
DisassociateChannelFlow

DisassociateChannelFlow
Service: Amazon Chime SDK Messaging

Disassociates a channel flow from all its channels. Once disassociated, all messages to that channel stop
going through the channel flow processor.
Note
Only administrators or channel moderators can disassociate a channel flow. 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.

Request Syntax
DELETE /channels/channelArn/channel-flow/channelFlowArn HTTP/1.1
x-amz-chime-bearer: ChimeBearer

URI Request Parameters

The request uses the following URI parameters.

channelArn (p. 805)

The ARN of the channel.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
channelFlowArn (p. 805)

The ARN of the channel flow.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 805)

The AppInstanceUserArn of the user making the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Request Body
The request does not have a request body.

805
 Amazon Chime SDK API Reference
DisassociateChannelFlow

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

806
 Amazon Chime SDK API Reference
DisassociateChannelFlow

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

807
 Amazon Chime SDK API Reference
GetChannelMembershipPreferences

GetChannelMembershipPreferences
Service: Amazon Chime SDK Messaging

Gets the membership preferences of an AppInstanceUser for the specified channel. The
AppInstanceUser must be a member of the channel. Only the AppInstanceUser who owns the
membership can retrieve preferences. Users in the AppInstanceAdmin and channel moderator roles
can't retrieve preferences for other users. Banned users can't retrieve membership preferences for the
channel from which they are banned.

Request Syntax
GET /channels/channelArn/memberships/memberArn/preferences HTTP/1.1
x-amz-chime-bearer: ChimeBearer

URI Request Parameters

The request uses the following URI parameters.

channelArn (p. 808)

The ARN of the channel.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 808)

The AppInstanceUserARN of the user making the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
memberArn (p. 808)

The AppInstanceUserArn of the member retrieving the preferences.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200

808
 Amazon Chime SDK API Reference
GetChannelMembershipPreferences

Content-type: application/json

{
"ChannelArn": "string",
"Member": {
"Arn": "string",
"Name": "string"
},
"Preferences": {
"PushNotifications": {
"AllowNotifications": "string",
"FilterRule": "string"
}
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ChannelArn (p. 808)

The ARN of the channel.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}
Member (p. 808)

The details of a user.

Type: Identity (p. 1336) object

Preferences (p. 808)

The channel membership preferences for an AppInstanceUser .

Type: ChannelMembershipPreferences (p. 1320) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

809
 Amazon Chime SDK API Reference
GetChannelMembershipPreferences

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

810
 Amazon Chime SDK API Reference
GetChannelMessage

GetChannelMessage
Service: Amazon Chime SDK Messaging

Gets the full details of a channel message.

Note
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.

Request Syntax
GET /channels/channelArn/messages/messageId?sub-channel-id=SubChannelId HTTP/1.1
x-amz-chime-bearer: ChimeBearer

URI Request Parameters

The request uses the following URI parameters.

channelArn (p. 811)

The ARN of the channel.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 811)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
messageId (p. 811)

The ID of the message.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [-_a-zA-Z0-9]*

Required: Yes
SubChannelId (p. 811)

The ID of the SubChannel in the request.

Note
Only required when getting messages in a SubChannel that the user belongs to.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [-_a-zA-Z0-9]*

811
 Amazon Chime SDK API Reference
GetChannelMessage

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"ChannelMessage": {
"ChannelArn": "string",
"Content": "string",
"CreatedTimestamp": number,
"LastEditedTimestamp": number,
"LastUpdatedTimestamp": number,
"MessageAttributes": {
"string" : {
"StringValues": [ "string" ]
}
},
"MessageId": "string",
"Metadata": "string",
"Persistence": "string",
"Redacted": boolean,
"Sender": {
"Arn": "string",
"Name": "string"
},
"Status": {
"Detail": "string",
"Value": "string"
},
"SubChannelId": "string",
"Type": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ChannelMessage (p. 812)

The details of and content in the message.

Type: ChannelMessage (p. 1322) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

812
 Amazon Chime SDK API Reference
GetChannelMessage

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

813
 Amazon Chime SDK API Reference
GetChannelMessageStatus

GetChannelMessageStatus
Service: Amazon Chime SDK Messaging

Gets message status for a specified messageId. Use this API to determine the intermediate status of
messages going through channel flow processing. The API provides an alternative to retrieving message
status if the event was not received because a client wasn't connected to a websocket.

Messages can have any one of these statuses.

SENT

Message processed successfully

PENDING

Ongoing processing
FAILED

Processing failed
DENIED

Messasge denied by the processor

Note

• This API does not return statuses for denied messages, because we don't store them once the
processor denies them.
• Only the message sender can invoke this API.
• 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

Request Syntax
GET /channels/channelArn/messages/{messageId}?scope=message-status&sub-channel-
id=SubChannelId HTTP/1.1
x-amz-chime-bearer: ChimeBearer

URI Request Parameters

The request uses the following URI parameters.

channelArn (p. 814)

The ARN of the channel

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 814)

The AppInstanceUserArn of the user making the API call.

814
 Amazon Chime SDK API Reference
GetChannelMessageStatus

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
messageId (p. 814)

The ID of the message.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [-_a-zA-Z0-9]*

Required: Yes
SubChannelId (p. 814)

The ID of the SubChannel in the request.

Note
Only required when getting message status in a SubChannel that the user belongs to.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [-_a-zA-Z0-9]*

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"Status": {
"Detail": "string",
"Value": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Status (p. 815)

The message status and details.

Type: ChannelMessageStatusStructure (p. 1327) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

815
 Amazon Chime SDK API Reference
GetChannelMessageStatus

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

816
 Amazon Chime SDK API Reference
GetMessagingSessionEndpoint

GetMessagingSessionEndpoint
Service: Amazon Chime SDK Messaging

The details of the endpoint for the messaging session.

Request Syntax
GET /endpoints/messaging-session HTTP/1.1

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"Endpoint": {
"Url": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Endpoint (p. 817)

The endpoint returned in the response.

Type: MessagingSessionEndpoint (p. 1339) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

817
 Amazon Chime SDK API Reference
GetMessagingSessionEndpoint

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

818
 Amazon Chime SDK API Reference
ListChannelBans

ListChannelBans
Service: Amazon Chime SDK Messaging

Lists all the users banned from a particular channel.

Note
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.

Request Syntax
GET /channels/channelArn/bans?max-results=MaxResults&next-token=NextToken HTTP/1.1
x-amz-chime-bearer: ChimeBearer

URI Request Parameters

The request uses the following URI parameters.

channelArn (p. 819)

The ARN of the channel.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 819)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
MaxResults (p. 819)

The maximum number of bans that you want returned.

Valid Range: Minimum value of 1. Maximum value of 50.

NextToken (p. 819)

The token passed by previous API calls until all requested bans are returned.

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

Request Body
The request does not have a request body.

819
 Amazon Chime SDK API Reference
ListChannelBans

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"ChannelArn": "string",
"ChannelBans": [
{
"Member": {
"Arn": "string",
"Name": "string"
}
}
],
"NextToken": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ChannelArn (p. 820)

The ARN of the channel.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}
ChannelBans (p. 820)

The information for each requested ban.

Type: Array of ChannelBanSummary (p. 1313) objects

NextToken (p. 820)

The token passed by previous API calls until all requested bans are returned.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

820
 Amazon Chime SDK API Reference
ListChannelBans

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

821
 Amazon Chime SDK API Reference
ListChannelFlows

ListChannelFlows
Service: Amazon Chime SDK Messaging

Returns a paginated lists of all the channel flows created under a single Chime. This is a developer API.

Request Syntax
GET /channel-flows?app-instance-arn=AppInstanceArn&max-results=MaxResults&next-
token=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

AppInstanceArn (p. 822)

The ARN of the app instance.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
MaxResults (p. 822)

The maximum number of channel flows that you want to return.

Valid Range: Minimum value of 1. Maximum value of 50.

NextToken (p. 822)

The token passed by previous API calls until all requested channel flows are returned.

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"ChannelFlows": [
{
"ChannelFlowArn": "string",
"Name": "string",
"Processors": [
{
"Configuration": {
"Lambda": {
"InvocationType": "string",

822
 Amazon Chime SDK API Reference
ListChannelFlows

"ResourceArn": "string"
}
},
"ExecutionOrder": number,
"FallbackAction": "string",
"Name": "string"
}
]
}
],
"NextToken": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ChannelFlows (p. 822)

The information about each channel flow.

Type: Array of ChannelFlowSummary (p. 1316) objects

NextToken (p. 822)

The token passed by previous API calls until all requested channels are returned.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

823
 Amazon Chime SDK API Reference
ListChannelFlows

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

824
 Amazon Chime SDK API Reference
ListChannelMemberships

ListChannelMemberships
Service: Amazon Chime SDK Messaging

Lists all channel memberships in a channel.

Note
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.

If you want to list the channels to which a specific app instance user belongs, see the
ListChannelMembershipsForAppInstanceUser API.

Request Syntax
GET /channels/channelArn/memberships?max-results=MaxResults&next-token=NextToken&sub-
channel-id=SubChannelId&type=Type HTTP/1.1
x-amz-chime-bearer: ChimeBearer

URI Request Parameters

The request uses the following URI parameters.

channelArn (p. 825)

The maximum number of channel memberships that you want returned.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 825)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
MaxResults (p. 825)

The maximum number of channel memberships that you want returned.

Valid Range: Minimum value of 1. Maximum value of 50.

NextToken (p. 825)

The token passed by previous API calls until all requested channel memberships are returned.

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*
SubChannelId (p. 825)

The ID of the SubChannel in the request.

825
 Amazon Chime SDK API Reference
ListChannelMemberships

Note
Only required when listing a user's memberships in a particular sub-channel of an elastic
channel.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [-_a-zA-Z0-9]*
Type (p. 825)

The membership type of a user, DEFAULT or HIDDEN. Default members are returned as part of
ListChannelMemberships if no type is specified. Hidden members are only returned if the type
filter in ListChannelMemberships equals HIDDEN.

Valid Values: DEFAULT | HIDDEN

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"ChannelArn": "string",
"ChannelMemberships": [
{
"Member": {
"Arn": "string",
"Name": "string"
}
}
],
"NextToken": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ChannelArn (p. 826)

The ARN of the channel.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}
ChannelMemberships (p. 826)

The information for the requested channel memberships.

Type: Array of ChannelMembershipSummary (p. 1321) objects

826
 Amazon Chime SDK API Reference
ListChannelMemberships

NextToken (p. 826)

The token passed by previous API calls until all requested channel memberships are returned.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript

827
 Amazon Chime SDK API Reference
ListChannelMemberships

• AWS SDK for PHP V3

• AWS SDK for Python
• AWS SDK for Ruby V3

828
 Amazon Chime SDK API Reference
ListChannelMembershipsForAppInstanceUser

ListChannelMembershipsForAppInstanceUser
Service: Amazon Chime SDK Messaging

Lists all channels that a particular AppInstanceUser is a part of. Only an AppInstanceAdmin can call
the API with a user ARN that is not their own.
Note
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.

Request Syntax
GET /channels?scope=app-instance-user-memberships&app-instance-user-
arn=AppInstanceUserArn&max-results=MaxResults&next-token=NextToken HTTP/1.1
x-amz-chime-bearer: ChimeBearer

URI Request Parameters

The request uses the following URI parameters.

AppInstanceUserArn (p. 829)

The ARN of the AppInstanceUsers

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}
ChimeBearer (p. 829)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
MaxResults (p. 829)

The maximum number of users that you want returned.

Valid Range: Minimum value of 1. Maximum value of 50.

NextToken (p. 829)

The token returned from previous API requests until the number of channel memberships is reached.

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

Request Body
The request does not have a request body.

829
 Amazon Chime SDK API Reference
ListChannelMembershipsForAppInstanceUser

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"ChannelMemberships": [
{
"AppInstanceUserMembershipSummary": {
"ReadMarkerTimestamp": number,
"SubChannelId": "string",
"Type": "string"
},
"ChannelSummary": {
"ChannelArn": "string",
"LastMessageTimestamp": number,
"Metadata": "string",
"Mode": "string",
"Name": "string",
"Privacy": "string"
}
}
],
"NextToken": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ChannelMemberships (p. 830)

The information for the requested channel memberships.

Type: Array of ChannelMembershipForAppInstanceUserSummary (p. 1319) objects

NextToken (p. 830)

The token passed by previous API calls until all requested users are returned.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

830
 Amazon Chime SDK API Reference
ListChannelMembershipsForAppInstanceUser

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

831
 Amazon Chime SDK API Reference
ListChannelMessages

ListChannelMessages
Service: Amazon Chime SDK Messaging

List all the messages in a channel. Returns a paginated list of ChannelMessages. By default, sorted by
creation timestamp in descending order.
Note
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.
Also, 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.

Request Syntax
GET /channels/channelArn/messages?max-results=MaxResults&next-token=NextToken&not-
after=NotAfter&not-before=NotBefore&sort-order=SortOrder&sub-channel-id=SubChannelId
HTTP/1.1
x-amz-chime-bearer: ChimeBearer

URI Request Parameters

The request uses the following URI parameters.

channelArn (p. 832)

The ARN of the channel.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 832)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
MaxResults (p. 832)

The maximum number of messages that you want returned.

Valid Range: Minimum value of 1. Maximum value of 50.

NextToken (p. 832)

The token passed by previous API calls until all requested messages are returned.

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

832
 Amazon Chime SDK API Reference
ListChannelMessages

NotAfter (p. 832)

The final or ending time stamp for your requested messages.

NotBefore (p. 832)

The initial or starting time stamp for your requested messages.

SortOrder (p. 832)

The order in which you want messages sorted. Default is Descending, based on time created.

Valid Values: ASCENDING | DESCENDING

SubChannelId (p. 832)

The ID of the SubChannel in the request.

Note
Only required when listing the messages in a SubChannel that the user belongs to.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [-_a-zA-Z0-9]*

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"ChannelArn": "string",
"ChannelMessages": [
{
"Content": "string",
"CreatedTimestamp": number,
"LastEditedTimestamp": number,
"LastUpdatedTimestamp": number,
"MessageAttributes": {
"string" : {
"StringValues": [ "string" ]
}
},
"MessageId": "string",
"Metadata": "string",
"Redacted": boolean,
"Sender": {
"Arn": "string",
"Name": "string"
},
"Status": {
"Detail": "string",
"Value": "string"
},
"Type": "string"
}
],
"NextToken": "string",
"SubChannelId": "string"

833
 Amazon Chime SDK API Reference
ListChannelMessages

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ChannelArn (p. 833)

The ARN of the channel containing the requested messages.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}
ChannelMessages (p. 833)

The information about, and content of, each requested message.

Type: Array of ChannelMessageSummary (p. 1328) objects

NextToken (p. 833)

The token passed by previous API calls until all requested messages are returned.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*
SubChannelId (p. 833)

The ID of the SubChannel in the response.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [-_a-zA-Z0-9]*

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

834
 Amazon Chime SDK API Reference
ListChannelMessages

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

835
 Amazon Chime SDK API Reference
ListChannelModerators

ListChannelModerators
Service: Amazon Chime SDK Messaging

Lists all the moderators for a channel.

Note
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.

Request Syntax
GET /channels/channelArn/moderators?max-results=MaxResults&next-token=NextToken HTTP/1.1
x-amz-chime-bearer: ChimeBearer

URI Request Parameters

The request uses the following URI parameters.

channelArn (p. 836)

The ARN of the channel.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 836)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
MaxResults (p. 836)

The maximum number of moderators that you want returned.

Valid Range: Minimum value of 1. Maximum value of 50.

NextToken (p. 836)

The token passed by previous API calls until all requested moderators are returned.

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

Request Body
The request does not have a request body.

836
 Amazon Chime SDK API Reference
ListChannelModerators

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"ChannelArn": "string",
"ChannelModerators": [
{
"Moderator": {
"Arn": "string",
"Name": "string"
}
}
],
"NextToken": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ChannelArn (p. 837)

The ARN of the channel.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}
ChannelModerators (p. 837)

The information about and names of each moderator.

Type: Array of ChannelModeratorSummary (p. 1332) objects

NextToken (p. 837)

The token passed by previous API calls until all requested moderators are returned.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

837
 Amazon Chime SDK API Reference
ListChannelModerators

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

838
 Amazon Chime SDK API Reference
ListChannels

ListChannels
Service: Amazon Chime SDK Messaging

Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow
results.

Functionality & restrictions

• Use privacy = PUBLIC to retrieve all public channels in the account.

• Only an AppInstanceAdmin can set privacy = PRIVATE to list the private channels in an account.

Note
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.

Request Syntax
GET /channels?app-instance-arn=AppInstanceArn&max-results=MaxResults&next-
token=NextToken&privacy=Privacy HTTP/1.1
x-amz-chime-bearer: ChimeBearer

URI Request Parameters

The request uses the following URI parameters.

AppInstanceArn (p. 839)

The ARN of the AppInstance.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 839)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
MaxResults (p. 839)

The maximum number of channels that you want to return.

Valid Range: Minimum value of 1. Maximum value of 50.

NextToken (p. 839)

The token passed by previous API calls until all requested channels are returned.

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

839
 Amazon Chime SDK API Reference
ListChannels

Privacy (p. 839)

The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves private channels.
Only an AppInstanceAdmin can retrieve private channels.

Valid Values: PUBLIC | PRIVATE

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"Channels": [
{
"ChannelArn": "string",
"LastMessageTimestamp": number,
"Metadata": "string",
"Mode": "string",
"Name": "string",
"Privacy": "string"
}
],
"NextToken": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Channels (p. 840)

The information about each channel.

Type: Array of ChannelSummary (p. 1333) objects

NextToken (p. 840)

The token returned from previous API requests until the number of channels is reached.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

840
 Amazon Chime SDK API Reference
ListChannels

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

841
 Amazon Chime SDK API Reference
ListChannelsAssociatedWithChannelFlow

ListChannelsAssociatedWithChannelFlow
Service: Amazon Chime SDK Messaging

Lists all channels associated with a specified channel flow. You can associate a channel flow with multiple
channels, but you can only associate a channel with one channel flow. This is a developer API.

Request Syntax
GET /channels?scope=channel-flow-associations&channel-flow-arn=ChannelFlowArn&max-
results=MaxResults&next-token=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

ChannelFlowArn (p. 842)

The ARN of the channel flow.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
MaxResults (p. 842)

The maximum number of channels that you want to return.

Valid Range: Minimum value of 1. Maximum value of 50.

NextToken (p. 842)

The token passed by previous API calls until all requested channels are returned.

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"Channels": [
{
"ChannelArn": "string",
"Metadata": "string",
"Mode": "string",
"Name": "string",
"Privacy": "string"
}

842
 Amazon Chime SDK API Reference
ListChannelsAssociatedWithChannelFlow

],
"NextToken": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Channels (p. 842)

The information about each channel.

Type: Array of ChannelAssociatedWithFlowSummary (p. 1310) objects

NextToken (p. 842)

The token passed by previous API calls until all requested channels are returned.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

843
 Amazon Chime SDK API Reference
ListChannelsAssociatedWithChannelFlow

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

844
 Amazon Chime SDK API Reference
ListChannelsModeratedByAppInstanceUser

ListChannelsModeratedByAppInstanceUser
Service: Amazon Chime SDK Messaging

A list of the channels moderated by an AppInstanceUser.

Note
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.

Request Syntax
GET /channels?scope=app-instance-user-moderated-channels&app-instance-user-
arn=AppInstanceUserArn&max-results=MaxResults&next-token=NextToken HTTP/1.1
x-amz-chime-bearer: ChimeBearer

URI Request Parameters

The request uses the following URI parameters.

AppInstanceUserArn (p. 845)

The ARN of the user in the moderated channel.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}
ChimeBearer (p. 845)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
MaxResults (p. 845)

The maximum number of channels in the request.

Valid Range: Minimum value of 1. Maximum value of 50.

NextToken (p. 845)

The token returned from previous API requests until the number of channels moderated by the user
is reached.

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

Request Body
The request does not have a request body.

845
 Amazon Chime SDK API Reference
ListChannelsModeratedByAppInstanceUser

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"Channels": [
{
"ChannelSummary": {
"ChannelArn": "string",
"LastMessageTimestamp": number,
"Metadata": "string",
"Mode": "string",
"Name": "string",
"Privacy": "string"
}
}
],
"NextToken": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Channels (p. 846)

The moderated channels in the request.

Type: Array of ChannelModeratedByAppInstanceUserSummary (p. 1330) objects

NextToken (p. 846)

The token returned from previous API requests until the number of channels moderated by the user
is reached.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

846
 Amazon Chime SDK API Reference
ListChannelsModeratedByAppInstanceUser

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

847
 Amazon Chime SDK API Reference
ListSubChannels

ListSubChannels
Service: Amazon Chime SDK Messaging

Lists all the SubChannels in an elastic channel when given a channel ID. Available only to the app
instance admins and channel moderators of elastic channels.

Request Syntax
GET /channels/channelArn/subchannels?max-results=MaxResults&next-token=NextToken HTTP/1.1
x-amz-chime-bearer: ChimeBearer

URI Request Parameters

The request uses the following URI parameters.

channelArn (p. 848)

The ARN of elastic channel.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 848)

The AppInstanceUserArn of the user making the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
MaxResults (p. 848)

The maximum number of sub-channels that you want to return.

Valid Range: Minimum value of 1. Maximum value of 50.

NextToken (p. 848)

The token passed by previous API calls until all requested sub-channels are returned.

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200

848
 Amazon Chime SDK API Reference
ListSubChannels

Content-type: application/json

{
"ChannelArn": "string",
"NextToken": "string",
"SubChannels": [
{
"MembershipCount": number,
"SubChannelId": "string"
}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ChannelArn (p. 848)

The ARN of elastic channel.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}
NextToken (p. 848)

The token passed by previous API calls until all requested sub-channels are returned.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*
SubChannels (p. 848)

The information about each sub-channel.

Type: Array of SubChannelSummary (p. 1347) objects

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

849
 Amazon Chime SDK API Reference
ListSubChannels

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

850
 Amazon Chime SDK API Reference
ListTagsForResource

ListTagsForResource
Service: Amazon Chime SDK Messaging

Lists the tags applied to an Amazon Chime SDK messaging resource.

Request Syntax
GET /tags?arn=ResourceARN HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

ResourceARN (p. 851)

The ARN of the resource.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Tags (p. 851)

The tag key-value pairs.

Type: Array of Tag (p. 1348) objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

851
 Amazon Chime SDK API Reference
ListTagsForResource

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

852
 Amazon Chime SDK API Reference
PutChannelMembershipPreferences

PutChannelMembershipPreferences
Service: Amazon Chime SDK Messaging

Sets the membership preferences of an AppInstanceUser for the specified channel. The
AppInstanceUser must be a member of the channel. Only the AppInstanceUser who owns the
membership can set preferences. Users in the AppInstanceAdmin and channel moderator roles can't
set preferences for other users. Banned users can't set membership preferences for the channel from
which they are banned.

Request Syntax
PUT /channels/channelArn/memberships/memberArn/preferences HTTP/1.1
x-amz-chime-bearer: ChimeBearer
Content-type: application/json

{
"Preferences": {
"PushNotifications": {
"AllowNotifications": "string",
"FilterRule": "string"
}
}
}

URI Request Parameters

The request uses the following URI parameters.

channelArn (p. 853)

The ARN of the channel.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 853)

The AppInstanceUserARN of the user making the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
memberArn (p. 853)

The AppInstanceUserArn of the member setting the preferences.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

853
 Amazon Chime SDK API Reference
PutChannelMembershipPreferences

Request Body
The request accepts the following data in JSON format.

Preferences (p. 853)

The channel membership preferences of an AppInstanceUser .

Type: ChannelMembershipPreferences (p. 1320) object

Required: Yes

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"ChannelArn": "string",
"Member": {
"Arn": "string",
"Name": "string"
},
"Preferences": {
"PushNotifications": {
"AllowNotifications": "string",
"FilterRule": "string"
}
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ChannelArn (p. 854)

The ARN of the channel.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}
Member (p. 854)

The details of a user.

Type: Identity (p. 1336) object

Preferences (p. 854)

The ARN and metadata of the member being added.

Type: ChannelMembershipPreferences (p. 1320) object

854
 Amazon Chime SDK API Reference
PutChannelMembershipPreferences

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

855
 Amazon Chime SDK API Reference
RedactChannelMessage

RedactChannelMessage
Service: Amazon Chime SDK Messaging

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.
Note
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.

Request Syntax
POST /channels/channelArn/messages/{messageId}?operation=redact HTTP/1.1
x-amz-chime-bearer: ChimeBearer
Content-type: application/json

{
"SubChannelId": "string"
}

URI Request Parameters

The request uses the following URI parameters.

channelArn (p. 856)

The ARN of the channel containing the messages that you want to redact.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 856)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
messageId (p. 856)

The ID of the message being redacted.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [-_a-zA-Z0-9]*

Required: Yes

Request Body
The request accepts the following data in JSON format.

856
 Amazon Chime SDK API Reference
RedactChannelMessage

SubChannelId (p. 856)

The ID of the SubChannel in the request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [-_a-zA-Z0-9]*

Required: No

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"ChannelArn": "string",
"MessageId": "string",
"SubChannelId": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ChannelArn (p. 857)

The ARN of the channel containing the messages that you want to redact.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}
MessageId (p. 857)

The ID of the message being redacted.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [-_a-zA-Z0-9]*
SubChannelId (p. 857)

The ID of the SubChannel in the response.

Note
Only required when redacting messages in a SubChannel that the user belongs to.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

857
 Amazon Chime SDK API Reference
RedactChannelMessage

Pattern: [-_a-zA-Z0-9]*

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python

858
 Amazon Chime SDK API Reference
RedactChannelMessage

• AWS SDK for Ruby V3

859
 Amazon Chime SDK API Reference
SearchChannels

SearchChannels
Service: Amazon Chime SDK Messaging

Allows ChimeBearer to search channels by channel members. AppInstanceUsers can search across the
channels that they belong to. AppInstanceAdmins can search across all channels.

Request Syntax
POST /channels?operation=search&max-results=MaxResults&next-token=NextToken HTTP/1.1
x-amz-chime-bearer: ChimeBearer
Content-type: application/json

{
"Fields": [
{
"Key": "string",
"Operator": "string",
"Values": [ "string" ]
}
]
}

URI Request Parameters

The request uses the following URI parameters.

ChimeBearer (p. 860)

The AppInstanceUserArn of the user making the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}
MaxResults (p. 860)

The maximum number of channels that you want returned.

Valid Range: Minimum value of 1. Maximum value of 50.

NextToken (p. 860)

The token returned from previous API requests until the number of channels is reached.

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

Request Body
The request accepts the following data in JSON format.

Fields (p. 860)

A list of the Field objects in the channel being searched.

Type: Array of SearchField (p. 1345) objects

860
 Amazon Chime SDK API Reference
SearchChannels

Array Members: Minimum number of 1 item. Maximum number of 20 items.

Required: Yes

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"Channels": [
{
"ChannelArn": "string",
"LastMessageTimestamp": number,
"Metadata": "string",
"Mode": "string",
"Name": "string",
"Privacy": "string"
}
],
"NextToken": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Channels (p. 861)

A list of the channels in the request.

Type: Array of ChannelSummary (p. 1333) objects

NextToken (p. 861)

The token returned from previous API responses until the number of channels is reached.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

861
 Amazon Chime SDK API Reference
SearchChannels

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

862
 Amazon Chime SDK API Reference
SendChannelMessage

SendChannelMessage
Service: Amazon Chime SDK Messaging

Sends a message to a particular channel that the member is a part of.

Note
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.
Also, STANDARD messages can contain 4KB of data and the 1KB of metadata. CONTROL
messages can contain 30 bytes of data and no metadata.

Request Syntax
POST /channels/channelArn/messages HTTP/1.1
x-amz-chime-bearer: ChimeBearer
Content-type: application/json

{
"ClientRequestToken": "string",
"Content": "string",
"MessageAttributes": {
"string" : {
"StringValues": [ "string" ]
}
},
"Metadata": "string",
"Persistence": "string",
"PushNotification": {
"Body": "string",
"Title": "string",
"Type": "string"
},
"SubChannelId": "string",
"Type": "string"
}

URI Request Parameters

The request uses the following URI parameters.

channelArn (p. 863)

The ARN of the channel.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 863)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

863
 Amazon Chime SDK API Reference
SendChannelMessage

Request Body
The request accepts the following data in JSON format.

ClientRequestToken (p. 863)

The Idempotency token for each client request.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

Pattern: [-_a-zA-Z0-9]*

Required: Yes
Content (p. 863)

The content of the message.

Type: String

Length Constraints: Minimum length of 1.

Pattern: [\s\S]*

Required: Yes
MessageAttributes (p. 863)

The attributes for the message, used for message filtering along with a FilterRule defined in the
PushNotificationPreferences.

Type: String to MessageAttributeValue (p. 1338) object map

Key Length Constraints: Minimum length of 1. Maximum length of 64.

Key Pattern: [\s\S]*

Required: No
Metadata (p. 863)

The optional metadata for each message.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: .*

Required: No
Persistence (p. 863)

Boolean that controls whether the message is persisted on the back end. Required.

Type: String

Valid Values: PERSISTENT | NON_PERSISTENT

Required: Yes
PushNotification (p. 863)

The push notification configuration of the message.

864
 Amazon Chime SDK API Reference
SendChannelMessage

Type: PushNotificationConfiguration (p. 1343) object

Required: No
SubChannelId (p. 863)

The ID of the SubChannel in the request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [-_a-zA-Z0-9]*

Required: No
Type (p. 863)

The type of message, STANDARD or CONTROL.

Type: String

Valid Values: STANDARD | CONTROL

Required: Yes

Response Syntax
HTTP/1.1 201
Content-type: application/json

{
"ChannelArn": "string",
"MessageId": "string",
"Status": {
"Detail": "string",
"Value": "string"
},
"SubChannelId": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

ChannelArn (p. 865)

The ARN of the channel.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}
MessageId (p. 865)

The ID string assigned to each message.

865
 Amazon Chime SDK API Reference
SendChannelMessage

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [-_a-zA-Z0-9]*
Status (p. 865)

The status of the channel message.

Type: ChannelMessageStatusStructure (p. 1327) object

SubChannelId (p. 865)

The ID of the SubChannel in the response.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [-_a-zA-Z0-9]*

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

866
 Amazon Chime SDK API Reference
SendChannelMessage

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

867
 Amazon Chime SDK API Reference
TagResource

TagResource
Service: Amazon Chime SDK Messaging

Applies the specified tags to the specified Amazon Chime SDK messaging resource.

Request Syntax
POST /tags?operation=tag-resource HTTP/1.1
Content-type: application/json

{
"ResourceARN": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

ResourceARN (p. 868)

The resource ARN.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
Tags (p. 868)

The tag key-value pairs.

Type: Array of Tag (p. 1348) objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Required: Yes

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

868
 Amazon Chime SDK API Reference
TagResource

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

869
 Amazon Chime SDK API Reference
UntagResource

UntagResource
Service: Amazon Chime SDK Messaging

Removes the specified tags from the specified Amazon Chime SDK messaging resource.

Request Syntax
POST /tags?operation=untag-resource HTTP/1.1
Content-type: application/json

{
"ResourceARN": "string",
"TagKeys": [ "string" ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

ResourceARN (p. 870)

The resource ARN.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
TagKeys (p. 870)

The tag keys.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: Yes

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

870
 Amazon Chime SDK API Reference
UntagResource

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

871
 Amazon Chime SDK API Reference
UpdateChannel

UpdateChannel
Service: Amazon Chime SDK Messaging

Update a channel's attributes.

Restriction: You can't change a channel's privacy.

Note
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.

Request Syntax
PUT /channels/channelArn HTTP/1.1
x-amz-chime-bearer: ChimeBearer
Content-type: application/json

{
"Metadata": "string",
"Mode": "string",
"Name": "string"
}

URI Request Parameters

The request uses the following URI parameters.

channelArn (p. 872)

The ARN of the channel.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 872)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Request Body
The request accepts the following data in JSON format.

Metadata (p. 872)

The metadata for the update request.

Type: String

872
 Amazon Chime SDK API Reference
UpdateChannel

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: .*

Required: No
Mode (p. 872)

The mode of the update request.

Type: String

Valid Values: UNRESTRICTED | RESTRICTED

Required: No
Name (p. 872)

The name of the channel.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD
\u10000-\u10FFFF]*

Required: No

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"ChannelArn": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ChannelArn (p. 873)

The ARN of the channel.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

873
 Amazon Chime SDK API Reference
UpdateChannel

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

874
 Amazon Chime SDK API Reference
UpdateChannelFlow

UpdateChannelFlow
Service: Amazon Chime SDK Messaging

Updates channel flow attributes. This is a developer API.

Request Syntax
PUT /channel-flows/channelFlowArn HTTP/1.1
Content-type: application/json

{
"Name": "string",
"Processors": [
{
"Configuration": {
"Lambda": {
"InvocationType": "string",
"ResourceArn": "string"
}
},
"ExecutionOrder": number,
"FallbackAction": "string",
"Name": "string"
}
]
}

URI Request Parameters

The request uses the following URI parameters.

channelFlowArn (p. 875)

The ARN of the channel flow.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Request Body
The request accepts the following data in JSON format.

Name (p. 875)

The name of the channel flow.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD
\u10000-\u10FFFF]*

Required: Yes

875
 Amazon Chime SDK API Reference
UpdateChannelFlow

Processors (p. 875)

Information about the processor Lambda functions

Type: Array of Processor (p. 1340) objects

Array Members: Minimum number of 1 item. Maximum number of 3 items.

Required: Yes

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"ChannelFlowArn": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ChannelFlowArn (p. 876)

The ARN of the channel flow.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

876
 Amazon Chime SDK API Reference
UpdateChannelFlow

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

877
 Amazon Chime SDK API Reference
UpdateChannelMessage

UpdateChannelMessage
Service: Amazon Chime SDK Messaging

Updates the content of a message.

Note
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.

Request Syntax
PUT /channels/channelArn/messages/messageId HTTP/1.1
x-amz-chime-bearer: ChimeBearer
Content-type: application/json

{
"Content": "string",
"Metadata": "string",
"SubChannelId": "string"
}

URI Request Parameters

The request uses the following URI parameters.

channelArn (p. 878)

The ARN of the channel.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 878)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
messageId (p. 878)

The ID string of the message being updated.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [-_a-zA-Z0-9]*

Required: Yes

Request Body
The request accepts the following data in JSON format.

878
 Amazon Chime SDK API Reference
UpdateChannelMessage

Content (p. 878)

The content of the message being updated.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 4096.

Pattern: [\s\S]*

Required: No
Metadata (p. 878)

The metadata of the message being updated.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: .*

Required: No
SubChannelId (p. 878)

The ID of the SubChannel in the request.

Note
Only required when updating messages in a SubChannel that the user belongs to.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [-_a-zA-Z0-9]*

Required: No

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"ChannelArn": "string",
"MessageId": "string",
"Status": {
"Detail": "string",
"Value": "string"
},
"SubChannelId": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ChannelArn (p. 879)

The ARN of the channel.

879
 Amazon Chime SDK API Reference
UpdateChannelMessage

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}
MessageId (p. 879)

The ID string of the message being updated.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [-_a-zA-Z0-9]*
Status (p. 879)

The status of the message update.

Type: ChannelMessageStatusStructure (p. 1327) object

SubChannelId (p. 879)

The ID of the SubChannel in the response.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [-_a-zA-Z0-9]*

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

880
 Amazon Chime SDK API Reference
UpdateChannelMessage

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

881
 Amazon Chime SDK API Reference
UpdateChannelReadMarker

UpdateChannelReadMarker
Service: Amazon Chime SDK Messaging

The details of the time when a user last read messages in a channel.
Note
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.

Request Syntax
PUT /channels/channelArn/readMarker HTTP/1.1
x-amz-chime-bearer: ChimeBearer
Content-type: application/json

{
"SubChannelId": "string"
}

URI Request Parameters

The request uses the following URI parameters.

channelArn (p. 882)

The ARN of the channel.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes
ChimeBearer (p. 882)

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: Yes

Request Body
The request accepts the following data in JSON format.

SubChannelId (p. 882)

The ID of the SubChannel in the request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [-_a-zA-Z0-9]*

882
 Amazon Chime SDK API Reference
UpdateChannelReadMarker

Required: No

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"ChannelArn": "string",
"SubChannelId": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ChannelArn (p. 883)

The ARN of the channel.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}
SubChannelId (p. 883)

The ID of the SubChannel in the response.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [-_a-zA-Z0-9]*

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

883
 Amazon Chime SDK API Reference
Amazon Chime SDK Voice

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

Amazon Chime SDK Voice

The following actions are supported by Amazon Chime SDK Voice:

• AssociatePhoneNumbersWithVoiceConnector (p. 887)

• AssociatePhoneNumbersWithVoiceConnectorGroup (p. 891)
• BatchDeletePhoneNumber (p. 895)
• BatchUpdatePhoneNumber (p. 898)
• CreatePhoneNumberOrder (p. 901)
• CreateProxySession (p. 904)
• CreateSipMediaApplication (p. 908)
• CreateSipMediaApplicationCall (p. 911)
• CreateSipRule (p. 914)
• CreateVoiceConnector (p. 918)
• CreateVoiceConnectorGroup (p. 921)

884
 Amazon Chime SDK API Reference
Amazon Chime SDK Voice

• DeletePhoneNumber (p. 924)

• DeleteProxySession (p. 926)
• DeleteSipMediaApplication (p. 928)
• DeleteSipRule (p. 930)
• DeleteVoiceConnector (p. 932)
• DeleteVoiceConnectorEmergencyCallingConfiguration (p. 934)
• DeleteVoiceConnectorGroup (p. 936)
• DeleteVoiceConnectorOrigination (p. 938)
• DeleteVoiceConnectorProxy (p. 940)
• DeleteVoiceConnectorStreamingConfiguration (p. 942)
• DeleteVoiceConnectorTermination (p. 944)
• DeleteVoiceConnectorTerminationCredentials (p. 946)
• DisassociatePhoneNumbersFromVoiceConnector (p. 948)
• DisassociatePhoneNumbersFromVoiceConnectorGroup (p. 951)
• GetGlobalSettings (p. 954)
• GetPhoneNumber (p. 956)
• GetPhoneNumberOrder (p. 959)
• GetPhoneNumberSettings (p. 962)
• GetProxySession (p. 964)
• GetSipMediaApplication (p. 967)
• GetSipMediaApplicationAlexaSkillConfiguration (p. 969)
• GetSipMediaApplicationLoggingConfiguration (p. 971)
• GetSipRule (p. 973)
• GetVoiceConnector (p. 976)
• GetVoiceConnectorEmergencyCallingConfiguration (p. 978)
• GetVoiceConnectorGroup (p. 980)
• GetVoiceConnectorLoggingConfiguration (p. 983)
• GetVoiceConnectorOrigination (p. 985)
• GetVoiceConnectorProxy (p. 987)
• GetVoiceConnectorStreamingConfiguration (p. 989)
• GetVoiceConnectorTermination (p. 991)
• GetVoiceConnectorTerminationHealth (p. 993)
• ListAvailableVoiceConnectorRegions (p. 995)
• ListPhoneNumberOrders (p. 997)
• ListPhoneNumbers (p. 1000)
• ListProxySessions (p. 1003)
• ListSipMediaApplications (p. 1006)
• ListSipRules (p. 1009)
• ListSupportedPhoneNumberCountries (p. 1012)
• ListVoiceConnectorGroups (p. 1014)
• ListVoiceConnectors (p. 1017)
• ListVoiceConnectorTerminationCredentials (p. 1020)
• PutSipMediaApplicationAlexaSkillConfiguration (p. 1022)
• PutSipMediaApplicationLoggingConfiguration (p. 1025)
• PutVoiceConnectorEmergencyCallingConfiguration (p. 1028)
• PutVoiceConnectorLoggingConfiguration (p. 1031)

885
 Amazon Chime SDK API Reference
Amazon Chime SDK Voice

• PutVoiceConnectorOrigination (p. 1034)

• PutVoiceConnectorProxy (p. 1037)
• PutVoiceConnectorStreamingConfiguration (p. 1040)
• PutVoiceConnectorTermination (p. 1043)
• PutVoiceConnectorTerminationCredentials (p. 1046)
• RestorePhoneNumber (p. 1048)
• SearchAvailablePhoneNumbers (p. 1051)
• UpdateGlobalSettings (p. 1054)
• UpdatePhoneNumber (p. 1056)
• UpdatePhoneNumberSettings (p. 1059)
• UpdateProxySession (p. 1061)
• UpdateSipMediaApplication (p. 1064)
• UpdateSipMediaApplicationCall (p. 1067)
• UpdateSipRule (p. 1070)
• UpdateVoiceConnector (p. 1073)
• UpdateVoiceConnectorGroup (p. 1076)
• ValidateE911Address (p. 1079)

886
 Amazon Chime SDK API Reference
AssociatePhoneNumbersWithVoiceConnector

AssociatePhoneNumbersWithVoiceConnector
Service: Amazon Chime SDK Voice

Associates phone numbers with the specified Amazon Chime SDK Voice Connector.

Request Syntax
POST /voice-connectors/{voiceConnectorId}?operation=associate-phone-numbers HTTP/1.1
Content-type: application/json

{
"E164PhoneNumbers": [ "string" ],
"ForceAssociate": boolean
}

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId (p. 887)

The Voice Connector ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

E164PhoneNumbers (p. 887)

List of phone numbers, in E.164 format.

Type: Array of strings

Pattern: ^\+?[1-9]\d{1,14}$

Required: Yes
ForceAssociate (p. 887)

If true, associates the provided phone numbers with the provided Amazon Chime SDK Voice
Connector and removes any previously existing associations. If false, does not associate any phone
numbers that have previously existing associations.

Type: Boolean

Required: No

Response Syntax
HTTP/1.1 200
Content-type: application/json

887
 Amazon Chime SDK API Reference
AssociatePhoneNumbersWithVoiceConnector

{
"PhoneNumberErrors": [
{
"ErrorCode": "string",
"ErrorMessage": "string",
"PhoneNumberId": "string"
}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

PhoneNumberErrors (p. 887)

If the action fails for one or more of the phone numbers in the request, a list of the phone numbers
is returned, along with error codes and error messages.

Type: Array of PhoneNumberError (p. 1371) objects

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

AccessDeniedException

You don't have the permissions needed to run this action.

HTTP Status Code: 403

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

888
 Amazon Chime SDK API Reference
AssociatePhoneNumbersWithVoiceConnector

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents(AUTHPARAMS) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example associates the specified phone number with the specified Amazon Chime SDK Voice
Connector.

Sample Request

POST /voice-connectors/abcdef1ghij2klmno3pqr4?operation=associate-phone-numbers HTTP/1.1

Host: service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.170
Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-Date: 20191028T184037Z Authorization:
AUTHPARAMS Content-Length: 78 {"E164PhoneNumbers": ["+12065550100", "+12065550101"],
"ForceAssociate": true}

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: ac266ffd-3732-4a4a-b8dd-4b64399dde0c Content-Type:

application/json Content-Length: 24 Date: Mon, 28 Oct 2019 18:40:37 GMT Connection: keep-
alive {"PhoneNumberErrors":[]}

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

889
 Amazon Chime SDK API Reference
AssociatePhoneNumbersWithVoiceConnector

890
 Amazon Chime SDK API Reference
AssociatePhoneNumbersWithVoiceConnectorGroup

AssociatePhoneNumbersWithVoiceConnectorGroup
Service: Amazon Chime SDK Voice

Associates phone numbers with the specified Amazon Chime SDK Voice Connector group.

Request Syntax
POST /voice-connector-groups/{voiceConnectorGroupId}?operation=associate-phone-numbers
HTTP/1.1
Content-type: application/json

{
"E164PhoneNumbers": [ "string" ],
"ForceAssociate": boolean
}

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorGroupId (p. 891)

The Amazon Chime SDK Voice Connector group ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

E164PhoneNumbers (p. 891)

List of phone numbers, in E.164 format.

Type: Array of strings

Pattern: ^\+?[1-9]\d{1,14}$

Required: Yes
ForceAssociate (p. 891)

If true, associates the provided phone numbers with the provided Amazon Chime SDK Voice
Connector Group and removes any previously existing associations. If false, does not associate any
phone numbers that have previously existing associations.

Type: Boolean

Required: No

Response Syntax
HTTP/1.1 200
Content-type: application/json

891
 Amazon Chime SDK API Reference
AssociatePhoneNumbersWithVoiceConnectorGroup

{
"PhoneNumberErrors": [
{
"ErrorCode": "string",
"ErrorMessage": "string",
"PhoneNumberId": "string"
}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

PhoneNumberErrors (p. 891)

If the action fails for one or more of the phone numbers in the request, a list of the phone numbers
is returned, along with error codes and error messages.

Type: Array of PhoneNumberError (p. 1371) objects

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

AccessDeniedException

You don't have the permissions needed to run this action.

HTTP Status Code: 403

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

892
 Amazon Chime SDK API Reference
AssociatePhoneNumbersWithVoiceConnectorGroup

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example associates the specified phone numbers with the specified Amazon Chime SDK Voice
Connector group.

Sample Request

POST /voice-connector-groups/123a456b-c7d8-90e1-fg23-4h567jkl8901?operation=associate-
phone-numbers HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding: identity
User-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-Date:
20191028T185326Z Authorization: AUTHPARAMS Content-Length: 78 {"E164PhoneNumbers":
["+12065550100", "+12065550101"], "ForceAssociate": true}

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 96f64ec4-db6a-41c9-9315-2517fb130c80 Content-Type:

application/json Content-Length: 24 Date: Mon, 28 Oct 2019 18:53:27 GMT Connection: keep-
alive {"PhoneNumberErrors":[]}

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

893
 Amazon Chime SDK API Reference
AssociatePhoneNumbersWithVoiceConnectorGroup

894
 Amazon Chime SDK API Reference
BatchDeletePhoneNumber

BatchDeletePhoneNumber
Service: Amazon Chime SDK Voice

Moves phone numbers into the Deletion queue. Phone numbers must be disassociated from any users or
Amazon Chime SDK Voice Connectors before they can be deleted.

Phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.

Request Syntax
POST /phone-numbers?operation=batch-delete HTTP/1.1
Content-type: application/json

{
"PhoneNumberIds": [ "string" ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

PhoneNumberIds (p. 895)

List of phone number IDs.

Type: Array of strings

Array Members: Minimum number of 1 item.

Required: Yes

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"PhoneNumberErrors": [
{
"ErrorCode": "string",
"ErrorMessage": "string",
"PhoneNumberId": "string"
}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

895
 Amazon Chime SDK API Reference
BatchDeletePhoneNumber

PhoneNumberErrors (p. 895)

If the action fails for one or more of the phone numbers in the request, a list of the phone numbers
is returned, along with error codes and error messages.

Type: Array of PhoneNumberError (p. 1371) objects

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

896
 Amazon Chime SDK API Reference
BatchDeletePhoneNumber

Example
This example moves multiple phone numbers into the Deletion queue .

Sample Request

POST /phone-numbers?operation=batch-delete HTTP/1.1 Host: service.chime.aws.amazon.com

Accept-Encoding: identity User-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10
botocore/1.12.160 X-Amz-Date: 20190918T195348Z Authorization: AUTHPARAMS Content-Length:
56 {"PhoneNumberIds": ["%2B12065550100", "%2B12065550101"]}

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: f6ac5632-e71a-4755-997b-971c4dbff22c Content-Type:

application/json Content-Length: 24 Date: Wed, 18 Sep 2019 19:53:49 GMT Connection: keep-
alive {"PhoneNumberErrors":[]}

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

897
 Amazon Chime SDK API Reference
BatchUpdatePhoneNumber

BatchUpdatePhoneNumber
Service: Amazon Chime SDK Voice

Updates one or more phone numbers.

Request Syntax
POST /phone-numbers?operation=batch-update HTTP/1.1
Content-type: application/json

{
"UpdatePhoneNumberRequestItems": [
{
"CallingName": "string",
"PhoneNumberId": "string",
"ProductType": "string"
}
]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

UpdatePhoneNumberRequestItems (p. 898)

Lists the phone numbers in the update request.

Type: Array of UpdatePhoneNumberRequestItem (p. 1392) objects

Required: Yes

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"PhoneNumberErrors": [
{
"ErrorCode": "string",
"ErrorMessage": "string",
"PhoneNumberId": "string"
}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

898
 Amazon Chime SDK API Reference
BatchUpdatePhoneNumber

PhoneNumberErrors (p. 898)

A list of failed phone numbers and their error messages.

Type: Array of PhoneNumberError (p. 1371) objects

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2

899
 Amazon Chime SDK API Reference
BatchUpdatePhoneNumber

• AWS SDK for JavaScript

• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

900
 Amazon Chime SDK API Reference
CreatePhoneNumberOrder

CreatePhoneNumberOrder
Service: Amazon Chime SDK Voice

Creates an order for phone numbers to be provisioned. For numbers outside the U.S., you must use the
Amazon Chime SDK SIP media application dial-in product type.

Request Syntax
POST /phone-number-orders HTTP/1.1
Content-type: application/json

{
"E164PhoneNumbers": [ "string" ],
"ProductType": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

E164PhoneNumbers (p. 901)

List of phone numbers, in E.164 format.

Type: Array of strings

Pattern: ^\+?[1-9]\d{1,14}$

Required: Yes
ProductType (p. 901)

The phone number product type.

Type: String

Valid Values: VoiceConnector | SipMediaApplicationDialIn

Required: Yes

Response Syntax
HTTP/1.1 201
Content-type: application/json

{
"PhoneNumberOrder": {
"CreatedTimestamp": number,
"OrderedPhoneNumbers": [
{
"E164PhoneNumber": "string",
"Status": "string"
}
],

901
 Amazon Chime SDK API Reference
CreatePhoneNumberOrder

"OrderType": "string",
"PhoneNumberOrderId": "string",
"ProductType": "string",
"Status": "string",
"UpdatedTimestamp": number
}
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

PhoneNumberOrder (p. 901)

The phone number order details.

Type: PhoneNumberOrder (p. 1372) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

AccessDeniedException

You don't have the permissions needed to run this action.

HTTP Status Code: 403

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

902
 Amazon Chime SDK API Reference
CreatePhoneNumberOrder

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

Examples
In the following example or examples, the Authorization header contents( AUTHPARAMS) must be
replaced with an AWS Signature Version 4 signature. For more information about creating these
signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use
the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
tools automatically sign the requests for you with the access key that you specify when you configure the
tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example
This example creates an order for phone numbers to be provisioned.

Sample Request

POST /phone-number-orders HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding:

identity User-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-
Date: 20190918T175735Z Authorization: AUTHPARAMS Content-Length: 88 {"ProductType":
"BusinessCalling", "E164PhoneNumbers": ["+12065550100", "+12065550101"]}

Sample Response

HTTP/1.1 201 Created x-amzn-RequestId: 7ac7b213-6e5d-4b2a-a142-ce9a7bb7e455

Content-Type: application/json Content-Length: 366 Date: Wed, 18
Sep 2019 17:57:43 GMT Connection: keep-alive {"PhoneNumberOrder":
{"CreatedTimestamp":"2019-09-18T17:57:36.280Z","OrderedPhoneNumbers":
[{"E164PhoneNumber":"+12065550100","Status":"Processing"},
{"E164PhoneNumber":"+12065550101","Status":"Processing"}],"PhoneNumberOrderId":"abc12345-
de67-89f0-123g-
h45i678j9012","ProductType":"BusinessCalling","Status":"Processing","UpdatedTimestamp":"2019-09-18T17:5

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

903
 Amazon Chime SDK API Reference
CreateProxySession

CreateProxySession
Service: Amazon Chime SDK Voice

Creates a proxy session for the specified Amazon Chime SDK Voice Connector for the specified
participant phone numbers.

Request Syntax
POST /voice-connectors/voiceConnectorId/proxy-sessions HTTP/1.1
Content-type: application/json

{
"Capabilities": [ "string" ],
"ExpiryMinutes": number,
"GeoMatchLevel": "string",
"GeoMatchParams": {
"AreaCode": "string",
"Country": "string"
},
"Name": "string",
"NumberSelectionBehavior": "string",
"ParticipantPhoneNumbers": [ "string" ]
}

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId (p. 904)

The Voice Connector ID.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

Capabilities (p. 904)

The proxy session's capabilities.

Type: Array of strings

Valid Values: Voice | SMS

Required: Yes
ExpiryMinutes (p. 904)

The number of minutes allowed for the proxy session.

Type: Integer

Valid Range: Minimum value of 1.

904
 Amazon Chime SDK API Reference
CreateProxySession

Required: No
GeoMatchLevel (p. 904)

The preference for matching the country or area code of the proxy phone number with that of the
first participant.

Type: String

Valid Values: Country | AreaCode

Required: No
GeoMatchParams (p. 904)

The country and area code for the proxy phone number.

Type: GeoMatchParams (p. 1357) object

Required: No
Name (p. 904)

The name of the proxy session.

Type: String

Pattern: ^$|^[a-zA-Z0-9 ]{0,30}$

Required: No
NumberSelectionBehavior (p. 904)

The preference for proxy phone number reuse, or stickiness, between the same participants across
sessions.

Type: String

Valid Values: PreferSticky | AvoidSticky

Required: No
ParticipantPhoneNumbers (p. 904)

The participant phone numbers.

Type: Array of strings

Array Members: Fixed number of 2 items.

Pattern: ^\+?[1-9]\d{1,14}$

Required: Yes

Response Syntax
HTTP/1.1 201
Content-type: application/json

{
"ProxySession": {
"Capabilities": [ "string" ],
"CreatedTimestamp": number,
"EndedTimestamp": number,

905
 Amazon Chime SDK API Reference
CreateProxySession

"ExpiryMinutes": number,
"GeoMatchLevel": "string",
"GeoMatchParams": {
"AreaCode": "string",
"Country": "string"
},
"Name": "string",
"NumberSelectionBehavior": "string",
"Participants": [
{
"PhoneNumber": "string",
"ProxyPhoneNumber": "string"
}
],
"ProxySessionId": "string",
"Status": "string",
"UpdatedTimestamp": number,
"VoiceConnectorId": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

ProxySession (p. 905)

The proxy session details.

Type: ProxySession (p. 1375) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

906
 Amazon Chime SDK API Reference
CreateProxySession

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

907
 Amazon Chime SDK API Reference
CreateSipMediaApplication

CreateSipMediaApplication
Service: Amazon Chime SDK Voice

Creates a SIP media application. For more information about SIP media applications, see Managing SIP
media applications and rules in the Amazon Chime SDK Administrator Guide.

Request Syntax
POST /sip-media-applications HTTP/1.1
Content-type: application/json

{
"AwsRegion": "string",
"Endpoints": [
{
"LambdaArn": "string"
}
],
"Name": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

AwsRegion (p. 908)

The AWS Region assigned to the SIP media application.

Type: String

Required: Yes
Endpoints (p. 908)

List of endpoints (Lambda ARNs) specified for the SIP media application.

Type: Array of SipMediaApplicationEndpoint (p. 1382) objects

Array Members: Fixed number of 1 item.

Required: Yes
Name (p. 908)

The SIP media application's name.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

Response Syntax
HTTP/1.1 201

908
 Amazon Chime SDK API Reference
CreateSipMediaApplication

Content-type: application/json

{
"SipMediaApplication": {
"AwsRegion": "string",
"CreatedTimestamp": number,
"Endpoints": [
{
"LambdaArn": "string"
}
],
"Name": "string",
"SipMediaApplicationId": "string",
"UpdatedTimestamp": number
}
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

SipMediaApplication (p. 908)

The SIP media application details.

Type: SipMediaApplication (p. 1378) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

AccessDeniedException

You don't have the permissions needed to run this action.

HTTP Status Code: 403

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

Multiple instances of the same request were made simultaneously.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

909
 Amazon Chime SDK API Reference
CreateSipMediaApplication

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

910
 Amazon Chime SDK API Reference
CreateSipMediaApplicationCall

CreateSipMediaApplicationCall
Service: Amazon Chime SDK Voice

Creates an outbound call to a phone number from the phone number specified in the request, and it
invokes the endpoint of the specified sipMediaApplicationId.

Request Syntax
POST /sip-media-applications/sipMediaApplicationId/calls HTTP/1.1
Content-type: application/json

{
"ArgumentsMap": {
"string" : "string"
},
"FromPhoneNumber": "string",
"SipHeaders": {
"string" : "string"
},
"ToPhoneNumber": "string"
}

URI Request Parameters

The request uses the following URI parameters.

sipMediaApplicationId (p. 911)

The ID of the SIP media application.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

ArgumentsMap (p. 911)

Context passed to a CreateSipMediaApplication API call. For example, you could pass key-value pairs
such as: "FirstName": "John", "LastName": "Doe"

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 20 items.

Required: No
FromPhoneNumber (p. 911)

The phone number that a user calls from. This is a phone number in your Amazon Chime SDK phone
number inventory.

Type: String

Pattern: ^\+?[1-9]\d{1,14}$

Required: Yes

911
 Amazon Chime SDK API Reference
CreateSipMediaApplicationCall

SipHeaders (p. 911)

The SIP headers added to an outbound call leg.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 20 items.

Required: No
ToPhoneNumber (p. 911)

The phone number that the service should call.

Type: String

Pattern: ^\+?[1-9]\d{1,14}$

Required: Yes

Response Syntax
HTTP/1.1 201
Content-type: application/json

{
"SipMediaApplicationCall": {
"TransactionId": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

SipMediaApplicationCall (p. 912)

The actual call.

Type: SipMediaApplicationCall (p. 1381) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

AccessDeniedException

You don't have the permissions needed to run this action.

HTTP Status Code: 403

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

912
 Amazon Chime SDK API Reference
CreateSipMediaApplicationCall

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

913
 Amazon Chime SDK API Reference
CreateSipRule

CreateSipRule
Service: Amazon Chime SDK Voice

Creates a SIP rule, which can be used to run a SIP media application as a target for a specific trigger type.
For more information about SIP rules, see Managing SIP media applications and rules in the Amazon
Chime SDK Administrator Guide.

Request Syntax
POST /sip-rules HTTP/1.1
Content-type: application/json

{
"Disabled": boolean,
"Name": "string",
"TargetApplications": [
{
"AwsRegion": "string",
"Priority": number,
"SipMediaApplicationId": "string"
}
],
"TriggerType": "string",
"TriggerValue": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

Disabled (p. 914)

Disables or enables a SIP rule. You must disable SIP rules before you can delete them.

Type: Boolean

Required: No
Name (p. 914)

The name of the SIP rule.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes
TargetApplications (p. 914)

List of SIP media applications, with priority and AWS Region. Only one SIP application per AWS
Region can be used.

Type: Array of SipRuleTargetApplication (p. 1386) objects

Array Members: Minimum number of 1 item. Maximum number of 25 items.

914
 Amazon Chime SDK API Reference
CreateSipRule

Required: No
TriggerType (p. 914)

The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname or
ToPhoneNumber.

Type: String

Valid Values: ToPhoneNumber | RequestUriHostname

Required: Yes
TriggerValue (p. 914)

If TriggerType is RequestUriHostname, the value can be the outbound host name of a Voice
Connector. If TriggerType is ToPhoneNumber, the value can be a customer-owned phone number
in the E164 format. The SipMediaApplication specified in the SipRule is triggered if the
request URI in an incoming SIP request matches the RequestUriHostname, or if the To header in
the incoming SIP request matches the ToPhoneNumber value.

Type: String

Pattern: .*\S.*

Required: Yes

Response Syntax
HTTP/1.1 201
Content-type: application/json

{
"SipRule": {
"CreatedTimestamp": number,
"Disabled": boolean,
"Name": "string",
"SipRuleId": "string",
"TargetApplications": [
{
"AwsRegion": "string",
"Priority": number,
"SipMediaApplicationId": "string"
}
],
"TriggerType": "string",
"TriggerValue": "string",
"UpdatedTimestamp": number
}
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

SipRule (p. 915)

The SIP rule information, including the rule ID, triggers, and target applications.

915
 Amazon Chime SDK API Reference
CreateSipRule

Type: SipRule (p. 1384) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

AccessDeniedException

You don't have the permissions needed to run this action.

HTTP Status Code: 403

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

Multiple instances of the same request were made simultaneously.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

916
 Amazon Chime SDK API Reference
CreateSipRule

• AWS SDK for .NET

• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

917
 Amazon Chime SDK API Reference
CreateVoiceConnector

CreateVoiceConnector
Service: Amazon Chime SDK Voice

Creates an Amazon Chime SDK Voice Connector. For more information about Voice Connectors, see
Managing Amazon Chime SDK Voice Connector groups in the Amazon Chime SDK Administrator Guide.

Request Syntax
POST /voice-connectors HTTP/1.1
Content-type: application/json

{
"AwsRegion": "string",
"Name": "string",
"RequireEncryption": boolean
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

AwsRegion (p. 918)

The AWS Region in which the Amazon Chime SDK Voice Connector is created. Default value: us-
east-1 .

Type: String

Valid Values: us-east-1 | us-west-2 | ca-central-1 | eu-central-1 | eu-west-1

| eu-west-2 | ap-northeast-2 | ap-northeast-1 | ap-southeast-1 | ap-
southeast-2

Required: No
Name (p. 918)

The name of the Voice Connector.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes
RequireEncryption (p. 918)

Enables or disables encryption for the Voice Connector.

Type: Boolean

Required: Yes

Response Syntax
HTTP/1.1 201

918
 Amazon Chime SDK API Reference
CreateVoiceConnector

Content-type: application/json

{
"VoiceConnector": {
"AwsRegion": "string",
"CreatedTimestamp": number,
"Name": "string",
"OutboundHostName": "string",
"RequireEncryption": boolean,
"UpdatedTimestamp": number,
"VoiceConnectorArn": "string",
"VoiceConnectorId": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

VoiceConnector (p. 918)

The details of the Voice Connector.

Type: VoiceConnector (p. 1393) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

AccessDeniedException

You don't have the permissions needed to run this action.

HTTP Status Code: 403

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

919
 Amazon Chime SDK API Reference
CreateVoiceConnector

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

920
 Amazon Chime SDK API Reference
CreateVoiceConnectorGroup

CreateVoiceConnectorGroup
Service: Amazon Chime SDK Voice

Creates an Amazon Chime SDK Voice Connector group under the administrator's AWS account. You
can associate Amazon Chime SDK Voice Connectors with the Voice Connector group by including
VoiceConnectorItems in the request.

You can include Voice Connectors from different AWS Regions in your group. This creates a fault tolerant
mechanism for fallback in case of availability events.

Request Syntax
POST /voice-connector-groups HTTP/1.1
Content-type: application/json

{
"Name": "string",
"VoiceConnectorItems": [
{
"Priority": number,
"VoiceConnectorId": "string"
}
]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

Name (p. 921)

The name of the Voice Connector group.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes
VoiceConnectorItems (p. 921)

Lists the Voice Connectors that inbound calls are routed to.

Type: Array of VoiceConnectorItem (p. 1397) objects

Required: No

Response Syntax
HTTP/1.1 201
Content-type: application/json

921
 Amazon Chime SDK API Reference
CreateVoiceConnectorGroup

"VoiceConnectorGroup": {
"CreatedTimestamp": number,
"Name": "string",
"UpdatedTimestamp": number,
"VoiceConnectorGroupArn": "string",
"VoiceConnectorGroupId": "string",
"VoiceConnectorItems": [
{
"Priority": number,
"VoiceConnectorId": "string"
}
]
}
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

VoiceConnectorGroup (p. 921)

The details of the Voice Connector group.

Type: VoiceConnectorGroup (p. 1395) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

AccessDeniedException

You don't have the permissions needed to run this action.

HTTP Status Code: 403

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

922
 Amazon Chime SDK API Reference
CreateVoiceConnectorGroup

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

923
 Amazon Chime SDK API Reference
DeletePhoneNumber

DeletePhoneNumber
Service: Amazon Chime SDK Voice

Moves the specified phone number into the Deletion queue. A phone number must be disassociated
from any users or Amazon Chime SDK Voice Connectors before it can be deleted.

Deleted phone numbers remain in the Deletion queue queue for 7 days before they are deleted
permanently.

Request Syntax
DELETE /phone-numbers/phoneNumberId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

phoneNumberId (p. 924)

The phone number ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

924
 Amazon Chime SDK API Reference
DeletePhoneNumber

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

925
 Amazon Chime SDK API Reference
DeleteProxySession

DeleteProxySession
Service: Amazon Chime SDK Voice

Delets the specified proxy session from the specified Amazon Chime SDK Voice Connector.

Request Syntax
DELETE /voice-connectors/voiceConnectorId/proxy-sessions/proxySessionId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

proxySessionId (p. 926)

The proxy session ID.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: .*\S.*

Required: Yes
voiceConnectorId (p. 926)

The Voice Connector ID.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

926
 Amazon Chime SDK API Reference
DeleteProxySession

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

927
 Amazon Chime SDK API Reference
DeleteSipMediaApplication

DeleteSipMediaApplication
Service: Amazon Chime SDK Voice

Deletes a SIP media application.

Request Syntax
DELETE /sip-media-applications/sipMediaApplicationId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

sipMediaApplicationId (p. 928)

The SIP media application ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

Multiple instances of the same request were made simultaneously.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

928
 Amazon Chime SDK API Reference
DeleteSipMediaApplication

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

929
 Amazon Chime SDK API Reference
DeleteSipRule

DeleteSipRule
Service: Amazon Chime SDK Voice

Deletes a SIP rule.

Request Syntax
DELETE /sip-rules/sipRuleId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

sipRuleId (p. 930)

The SIP rule ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

Multiple instances of the same request were made simultaneously.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

930
 Amazon Chime SDK API Reference
DeleteSipRule

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

931
 Amazon Chime SDK API Reference
DeleteVoiceConnector

DeleteVoiceConnector
Service: Amazon Chime SDK Voice

Deletes an Amazon Chime SDK Voice Connector. Any phone numbers associated with the Amazon Chime
SDK Voice Connector must be disassociated from it before it can be deleted.

Request Syntax
DELETE /voice-connectors/voiceConnectorId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId (p. 932)

The Voice Connector ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

Multiple instances of the same request were made simultaneously.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

932
 Amazon Chime SDK API Reference
DeleteVoiceConnector

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

933
 Amazon Chime SDK API Reference
DeleteVoiceConnectorEmergencyCallingConfiguration

DeleteVoiceConnectorEmergencyCallingConfiguration
Service: Amazon Chime SDK Voice

Deletes the emergency calling details from the specified Amazon Chime SDK Voice Connector.

Request Syntax
DELETE /voice-connectors/voiceConnectorId/emergency-calling-configuration HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId (p. 934)

The Voice Connector ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

934
 Amazon Chime SDK API Reference
DeleteVoiceConnectorEmergencyCallingConfiguration

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

935
 Amazon Chime SDK API Reference
DeleteVoiceConnectorGroup

DeleteVoiceConnectorGroup
Service: Amazon Chime SDK Voice

Deletes an Amazon Chime SDK Voice Connector group. Any VoiceConnectorItems and phone
numbers associated with the group must be removed before it can be deleted.

Request Syntax
DELETE /voice-connector-groups/voiceConnectorGroupId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorGroupId (p. 936)

The Voice Connector Group ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

Multiple instances of the same request were made simultaneously.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

936
 Amazon Chime SDK API Reference
DeleteVoiceConnectorGroup

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

937
 Amazon Chime SDK API Reference
DeleteVoiceConnectorOrigination

DeleteVoiceConnectorOrigination
Service: Amazon Chime SDK Voice

Deletes the origination settings for the specified Amazon Chime SDK Voice Connector.
Note
If emergency calling is configured for the Voice Connector, it must be deleted prior to deleting
the origination settings.

Request Syntax
DELETE /voice-connectors/voiceConnectorId/origination HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId (p. 938)

The Voice Connector ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

938
 Amazon Chime SDK API Reference
DeleteVoiceConnectorOrigination

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

939
 Amazon Chime SDK API Reference
DeleteVoiceConnectorProxy

DeleteVoiceConnectorProxy
Service: Amazon Chime SDK Voice

Deletes the proxy configuration from the specified Amazon Chime SDK Voice Connector.

Request Syntax
DELETE /voice-connectors/voiceConnectorId/programmable-numbers/proxy HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId (p. 940)

The Voice Connector ID.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

940
 Amazon Chime SDK API Reference
DeleteVoiceConnectorProxy

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

941
 Amazon Chime SDK API Reference
DeleteVoiceConnectorStreamingConfiguration

DeleteVoiceConnectorStreamingConfiguration
Service: Amazon Chime SDK Voice

Deletes a Voice Connector's streaming configuration.

Request Syntax
DELETE /voice-connectors/voiceConnectorId/streaming-configuration HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId (p. 942)

The Voice Connector ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

942
 Amazon Chime SDK API Reference
DeleteVoiceConnectorStreamingConfiguration

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

943
 Amazon Chime SDK API Reference
DeleteVoiceConnectorTermination

DeleteVoiceConnectorTermination
Service: Amazon Chime SDK Voice

Deletes the termination settings for the specified Amazon Chime SDK Voice Connector.
Note
If emergency calling is configured for the Voice Connector, it must be deleted prior to deleting
the termination settings.

Request Syntax
DELETE /voice-connectors/voiceConnectorId/termination HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId (p. 944)

The Voice Connector ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

944
 Amazon Chime SDK API Reference
DeleteVoiceConnectorTermination

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

945
 Amazon Chime SDK API Reference
DeleteVoiceConnectorTerminationCredentials

DeleteVoiceConnectorTerminationCredentials
Service: Amazon Chime SDK Voice

Deletes the specified SIP credentials used by your equipment to authenticate during call termination.

Request Syntax
POST /voice-connectors/voiceConnectorId/termination/credentials?operation=delete HTTP/1.1
Content-type: application/json

{
"Usernames": [ "string" ]
}

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId (p. 946)

The Voice Connector ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

Usernames (p. 946)

The RFC2617 compliant username associated with the SIP credentials, in US-ASCII format.

Type: Array of strings

Required: Yes

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

946
 Amazon Chime SDK API Reference
DeleteVoiceConnectorTerminationCredentials

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

947
 Amazon Chime SDK API Reference
DisassociatePhoneNumbersFromVoiceConnector

DisassociatePhoneNumbersFromVoiceConnector
Service: Amazon Chime SDK Voice

Disassociates the specified phone numbers from the specified Amazon Chime SDK Voice Connector.

Request Syntax
POST /voice-connectors/{voiceConnectorId}?operation=disassociate-phone-numbers HTTP/1.1
Content-type: application/json

{
"E164PhoneNumbers": [ "string" ]
}

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId (p. 948)

The Voice Connector ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

E164PhoneNumbers (p. 948)

List of phone numbers, in E.164 format.

Type: Array of strings

Pattern: ^\+?[1-9]\d{1,14}$

Required: Yes

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"PhoneNumberErrors": [
{
"ErrorCode": "string",
"ErrorMessage": "string",
"PhoneNumberId": "string"
}
]
}

948
 Amazon Chime SDK API Reference
DisassociatePhoneNumbersFromVoiceConnector

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

PhoneNumberErrors (p. 948)

If the action fails for one or more of the phone numbers in the request, a list of the phone numbers
is returned, along with error codes and error messages.

Type: Array of PhoneNumberError (p. 1371) objects

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

949
 Amazon Chime SDK API Reference
DisassociatePhoneNumbersFromVoiceConnector

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

950
 Amazon Chime SDK API Reference
DisassociatePhoneNumbersFromVoiceConnectorGroup

DisassociatePhoneNumbersFromVoiceConnectorGroup
Service: Amazon Chime SDK Voice

Disassociates the specified phone numbers from the specified Amazon Chime SDK Voice Connector
group.

Request Syntax
POST /voice-connector-groups/{voiceConnectorGroupId}?operation=disassociate-phone-numbers
HTTP/1.1
Content-type: application/json

{
"E164PhoneNumbers": [ "string" ]
}

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorGroupId (p. 951)

The Voice Connector group ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

E164PhoneNumbers (p. 951)

The list of phone numbers, in E.164 format.

Type: Array of strings

Pattern: ^\+?[1-9]\d{1,14}$

Required: Yes

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"PhoneNumberErrors": [
{
"ErrorCode": "string",
"ErrorMessage": "string",
"PhoneNumberId": "string"
}
]
}

951
 Amazon Chime SDK API Reference
DisassociatePhoneNumbersFromVoiceConnectorGroup

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

PhoneNumberErrors (p. 951)

If the action fails for one or more of the phone numbers in the request, a list of the phone numbers
is returned, along with error codes and error messages.

Type: Array of PhoneNumberError (p. 1371) objects

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

952
 Amazon Chime SDK API Reference
DisassociatePhoneNumbersFromVoiceConnectorGroup

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

953
 Amazon Chime SDK API Reference
GetGlobalSettings

GetGlobalSettings
Service: Amazon Chime SDK Voice

Retrieves the global settings for the Amazon Chime SDK Voice Connectors in an AWS account.

Request Syntax
GET /settings HTTP/1.1

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"VoiceConnector": {
"CdrBucket": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

VoiceConnector (p. 954)

The Voice Connector settings.

Type: VoiceConnectorSettings (p. 1398) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

954
 Amazon Chime SDK API Reference
GetGlobalSettings

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

955
 Amazon Chime SDK API Reference
GetPhoneNumber

GetPhoneNumber
Service: Amazon Chime SDK Voice

Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.

Request Syntax
GET /phone-numbers/phoneNumberId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

phoneNumberId (p. 956)

The phone number ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"PhoneNumber": {
"Associations": [
{
"AssociatedTimestamp": number,
"Name": "string",
"Value": "string"
}
],
"CallingName": "string",
"CallingNameStatus": "string",
"Capabilities": {
"InboundCall": boolean,
"InboundMMS": boolean,
"InboundSMS": boolean,
"OutboundCall": boolean,
"OutboundMMS": boolean,
"OutboundSMS": boolean
},
"Country": "string",
"CreatedTimestamp": number,
"DeletionTimestamp": number,
"E164PhoneNumber": "string",
"OrderId": "string",
"PhoneNumberId": "string",
"ProductType": "string",
"Status": "string",

956
 Amazon Chime SDK API Reference
GetPhoneNumber

"Type": "string",
"UpdatedTimestamp": number
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

PhoneNumber (p. 956)

The phone number details.

Type: PhoneNumber (p. 1364) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

957
 Amazon Chime SDK API Reference
GetPhoneNumber

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

958
 Amazon Chime SDK API Reference
GetPhoneNumberOrder

GetPhoneNumberOrder
Service: Amazon Chime SDK Voice

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.

Request Syntax
GET /phone-number-orders/phoneNumberOrderId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

phoneNumberOrderId (p. 959)

The ID of the phone number order .

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"PhoneNumberOrder": {
"CreatedTimestamp": number,
"OrderedPhoneNumbers": [
{
"E164PhoneNumber": "string",
"Status": "string"
}
],
"OrderType": "string",
"PhoneNumberOrderId": "string",
"ProductType": "string",
"Status": "string",
"UpdatedTimestamp": number
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

PhoneNumberOrder (p. 959)

The phone number order details.

959
 Amazon Chime SDK API Reference
GetPhoneNumberOrder

Type: PhoneNumberOrder (p. 1372) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python

960
 Amazon Chime SDK API Reference
GetPhoneNumberOrder

• AWS SDK for Ruby V3

961
 Amazon Chime SDK API Reference
GetPhoneNumberSettings

GetPhoneNumberSettings
Service: Amazon Chime SDK Voice

Retrieves the phone number settings for the administrator's AWS account, such as the default outbound
calling name.

Request Syntax
GET /settings/phone-number HTTP/1.1

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"CallingName": "string",
"CallingNameUpdatedTimestamp": number
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

CallingName (p. 962)

The default outbound calling name for the account.

Type: String

Pattern: ^$|^[a-zA-Z0-9 ]{2,15}$

CallingNameUpdatedTimestamp (p. 962)

The updated outbound calling name timestamp, in ISO 8601 format.

Type: Timestamp

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

962
 Amazon Chime SDK API Reference
GetPhoneNumberSettings

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

963
 Amazon Chime SDK API Reference
GetProxySession

GetProxySession
Service: Amazon Chime SDK Voice

Retrieves the specified proxy session details for the specified Amazon Chime SDK Voice Connector.

Request Syntax
GET /voice-connectors/voiceConnectorId/proxy-sessions/proxySessionId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

proxySessionId (p. 964)

The proxy session ID.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: .*\S.*

Required: Yes
voiceConnectorId (p. 964)

The Voice Connector ID.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"ProxySession": {
"Capabilities": [ "string" ],
"CreatedTimestamp": number,
"EndedTimestamp": number,
"ExpiryMinutes": number,
"GeoMatchLevel": "string",
"GeoMatchParams": {
"AreaCode": "string",
"Country": "string"
},
"Name": "string",
"NumberSelectionBehavior": "string",
"Participants": [
{
"PhoneNumber": "string",

964
 Amazon Chime SDK API Reference
GetProxySession

"ProxyPhoneNumber": "string"
}
],
"ProxySessionId": "string",
"Status": "string",
"UpdatedTimestamp": number,
"VoiceConnectorId": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ProxySession (p. 964)

The proxy session details.

Type: ProxySession (p. 1375) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

965
 Amazon Chime SDK API Reference
GetProxySession

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

966
 Amazon Chime SDK API Reference
GetSipMediaApplication

GetSipMediaApplication
Service: Amazon Chime SDK Voice

Retrieves the information for a SIP media application, including name, AWS Region, and endpoints.

Request Syntax
GET /sip-media-applications/sipMediaApplicationId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

sipMediaApplicationId (p. 967)

The SIP media application ID .

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"SipMediaApplication": {
"AwsRegion": "string",
"CreatedTimestamp": number,
"Endpoints": [
{
"LambdaArn": "string"
}
],
"Name": "string",
"SipMediaApplicationId": "string",
"UpdatedTimestamp": number
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

SipMediaApplication (p. 967)

The details of the SIP media application.

Type: SipMediaApplication (p. 1378) object

967
 Amazon Chime SDK API Reference
GetSipMediaApplication

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

968
 Amazon Chime SDK API Reference
GetSipMediaApplicationAlexaSkillConfiguration

GetSipMediaApplicationAlexaSkillConfiguration
Service: Amazon Chime SDK Voice

Gets the Alexa Skill configuration for the SIP media application.

Request Syntax
GET /sip-media-applications/sipMediaApplicationId/alexa-skill-configuration HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

sipMediaApplicationId (p. 969)

The SIP media application ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"SipMediaApplicationAlexaSkillConfiguration": {
"AlexaSkillIds": [ "string" ],
"AlexaSkillStatus": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

SipMediaApplicationAlexaSkillConfiguration (p. 969)

Returns the Alexa Skill configuration.

Type: SipMediaApplicationAlexaSkillConfiguration (p. 1380) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

969
 Amazon Chime SDK API Reference
GetSipMediaApplicationAlexaSkillConfiguration

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

970
 Amazon Chime SDK API Reference
GetSipMediaApplicationLoggingConfiguration

GetSipMediaApplicationLoggingConfiguration
Service: Amazon Chime SDK Voice

Retrieves the logging configuration for the specified SIP media application.

Request Syntax
GET /sip-media-applications/sipMediaApplicationId/logging-configuration HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

sipMediaApplicationId (p. 971)

The SIP media application ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"SipMediaApplicationLoggingConfiguration": {
"EnableSipMediaApplicationMessageLogs": boolean
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

SipMediaApplicationLoggingConfiguration (p. 971)

The actual logging configuration.

Type: SipMediaApplicationLoggingConfiguration (p. 1383) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

971
 Amazon Chime SDK API Reference
GetSipMediaApplicationLoggingConfiguration

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

972
 Amazon Chime SDK API Reference
GetSipRule

GetSipRule
Service: Amazon Chime SDK Voice

Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.

Request Syntax
GET /sip-rules/sipRuleId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

sipRuleId (p. 973)

The SIP rule ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"SipRule": {
"CreatedTimestamp": number,
"Disabled": boolean,
"Name": "string",
"SipRuleId": "string",
"TargetApplications": [
{
"AwsRegion": "string",
"Priority": number,
"SipMediaApplicationId": "string"
}
],
"TriggerType": "string",
"TriggerValue": "string",
"UpdatedTimestamp": number
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

SipRule (p. 973)

The SIP rule details.

973
 Amazon Chime SDK API Reference
GetSipRule

Type: SipRule (p. 1384) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python

974
 Amazon Chime SDK API Reference
GetSipRule

• AWS SDK for Ruby V3

975
 Amazon Chime SDK API Reference
GetVoiceConnector

GetVoiceConnector
Service: Amazon Chime SDK Voice

Retrieves details for the specified Amazon Chime SDK Voice Connector, such as timestamps,name,
outbound host, and encryption requirements.

Request Syntax
GET /voice-connectors/voiceConnectorId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId (p. 976)

The Voice Connector ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"VoiceConnector": {
"AwsRegion": "string",
"CreatedTimestamp": number,
"Name": "string",
"OutboundHostName": "string",
"RequireEncryption": boolean,
"UpdatedTimestamp": number,
"VoiceConnectorArn": "string",
"VoiceConnectorId": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

VoiceConnector (p. 976)

The Voice Connector details.

Type: VoiceConnector (p. 1393) object

976
 Amazon Chime SDK API Reference
GetVoiceConnector

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

977
 Amazon Chime SDK API Reference
GetVoiceConnectorEmergencyCallingConfiguration

GetVoiceConnectorEmergencyCallingConfiguration
Service: Amazon Chime SDK Voice

Retrieves the emergency calling configuration details for the specified Voice Connector.

Request Syntax
GET /voice-connectors/voiceConnectorId/emergency-calling-configuration HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId (p. 978)

The Voice Connector ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"EmergencyCallingConfiguration": {
"DNIS": [
{
"CallingCountry": "string",
"EmergencyPhoneNumber": "string",
"TestPhoneNumber": "string"
}
]
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

EmergencyCallingConfiguration (p. 978)

The details of the emergency calling configuration.

Type: EmergencyCallingConfiguration (p. 1356) object

978
 Amazon Chime SDK API Reference
GetVoiceConnectorEmergencyCallingConfiguration

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

979
 Amazon Chime SDK API Reference
GetVoiceConnectorGroup

GetVoiceConnectorGroup
Service: Amazon Chime SDK Voice

Retrieves details for the specified Amazon Chime SDK Voice Connector group, such as timestamps,name,
and associated VoiceConnectorItems.

Request Syntax
GET /voice-connector-groups/voiceConnectorGroupId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorGroupId (p. 980)

The Voice Connector group ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"VoiceConnectorGroup": {
"CreatedTimestamp": number,
"Name": "string",
"UpdatedTimestamp": number,
"VoiceConnectorGroupArn": "string",
"VoiceConnectorGroupId": "string",
"VoiceConnectorItems": [
{
"Priority": number,
"VoiceConnectorId": "string"
}
]
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

VoiceConnectorGroup (p. 980)

The details of the Voice Connector group.

980
 Amazon Chime SDK API Reference
GetVoiceConnectorGroup

Type: VoiceConnectorGroup (p. 1395) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python

981
 Amazon Chime SDK API Reference
GetVoiceConnectorGroup

• AWS SDK for Ruby V3

982
 Amazon Chime SDK API Reference
GetVoiceConnectorLoggingConfiguration

GetVoiceConnectorLoggingConfiguration
Service: Amazon Chime SDK Voice

Retrieves the logging configuration settings for the specified Voice Connector. Shows whether SIP
message logs are enabled for sending to Amazon CloudWatch Logs.

Request Syntax
GET /voice-connectors/voiceConnectorId/logging-configuration HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId (p. 983)

The Voice Connector ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"LoggingConfiguration": {
"EnableMediaMetricLogs": boolean,
"EnableSIPLogs": boolean
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

LoggingConfiguration (p. 983)

The logging configuration details .

Type: LoggingConfiguration (p. 1358) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

983
 Amazon Chime SDK API Reference
GetVoiceConnectorLoggingConfiguration

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

984
 Amazon Chime SDK API Reference
GetVoiceConnectorOrigination

GetVoiceConnectorOrigination
Service: Amazon Chime SDK Voice

Retrieves the origination settings for the specified Voice Connector.

Request Syntax
GET /voice-connectors/voiceConnectorId/origination HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId (p. 985)

The Voice Connector ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"Origination": {
"Disabled": boolean,
"Routes": [
{
"Host": "string",
"Port": number,
"Priority": number,
"Protocol": "string",
"Weight": number
}
]
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Origination (p. 985)

The origination setting details.

Type: Origination (p. 1360) object

985
 Amazon Chime SDK API Reference
GetVoiceConnectorOrigination

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

986
 Amazon Chime SDK API Reference
GetVoiceConnectorProxy

GetVoiceConnectorProxy
Service: Amazon Chime SDK Voice

Retrieves the proxy configuration details for the specified Amazon Chime SDK Voice Connector.

Request Syntax
GET /voice-connectors/voiceConnectorId/programmable-numbers/proxy HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId (p. 987)

The Voice Connector ID.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"Proxy": {
"DefaultSessionExpiryMinutes": number,
"Disabled": boolean,
"FallBackPhoneNumber": "string",
"PhoneNumberCountries": [ "string" ]
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Proxy (p. 987)

The proxy configuration details.

Type: Proxy (p. 1374) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

987
 Amazon Chime SDK API Reference
GetVoiceConnectorProxy

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

988
 Amazon Chime SDK API Reference
GetVoiceConnectorStreamingConfiguration

GetVoiceConnectorStreamingConfiguration
Service: Amazon Chime SDK Voice

Retrieves the streaming configuration details for the specified Amazon Chime SDK 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.

Request Syntax
GET /voice-connectors/voiceConnectorId/streaming-configuration HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId (p. 989)

The Voice Connector ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"StreamingConfiguration": {
"DataRetentionInHours": number,
"Disabled": boolean,
"StreamingNotificationTargets": [
{
"NotificationTarget": "string"
}
]
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

StreamingConfiguration (p. 989)

The details of the streaming configuration.

Type: StreamingConfiguration (p. 1387) object

989
 Amazon Chime SDK API Reference
GetVoiceConnectorStreamingConfiguration

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

990
 Amazon Chime SDK API Reference
GetVoiceConnectorTermination

GetVoiceConnectorTermination
Service: Amazon Chime SDK Voice

Retrieves the termination setting details for the specified Voice Connector.

Request Syntax
GET /voice-connectors/voiceConnectorId/termination HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId (p. 991)

The Voice Connector ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"Termination": {
"CallingRegions": [ "string" ],
"CidrAllowedList": [ "string" ],
"CpsLimit": number,
"DefaultPhoneNumber": "string",
"Disabled": boolean
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Termination (p. 991)

The termination setting details.

Type: Termination (p. 1389) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

991
 Amazon Chime SDK API Reference
GetVoiceConnectorTermination

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

992
 Amazon Chime SDK API Reference
GetVoiceConnectorTerminationHealth

GetVoiceConnectorTerminationHealth
Service: Amazon Chime SDK Voice

Retrieves information about the last time a SIP OPTIONS ping was received from your SIP infrastructure
for the specified Amazon Chime SDK Voice Connector.

Request Syntax
GET /voice-connectors/voiceConnectorId/termination/health HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId (p. 993)

The Voice Connector ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"TerminationHealth": {
"Source": "string",
"Timestamp": number
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

TerminationHealth (p. 993)

The termination health details.

Type: TerminationHealth (p. 1391) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

993
 Amazon Chime SDK API Reference
GetVoiceConnectorTerminationHealth

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

994
 Amazon Chime SDK API Reference
ListAvailableVoiceConnectorRegions

ListAvailableVoiceConnectorRegions
Service: Amazon Chime SDK Voice

Lists the available AWS Regions in which you can create an Amazon Chime SDK Voice Connector.

Request Syntax
GET /voice-connector-regions HTTP/1.1

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"VoiceConnectorRegions": [ "string" ]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

VoiceConnectorRegions (p. 995)

The list of AWS Regions.

Type: Array of strings

Valid Values: us-east-1 | us-west-2 | ca-central-1 | eu-central-1 | eu-west-1

| eu-west-2 | ap-northeast-2 | ap-northeast-1 | ap-southeast-1 | ap-
southeast-2

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

995
 Amazon Chime SDK API Reference
ListAvailableVoiceConnectorRegions

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

996
 Amazon Chime SDK API Reference
ListPhoneNumberOrders

ListPhoneNumberOrders
Service: Amazon Chime SDK Voice

Lists the phone numbers for an administrator's Amazon Chime SDK account.

Request Syntax
GET /phone-number-orders?max-results=MaxResults&next-token=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MaxResults (p. 997)

The maximum number of results to return in a single call.

Valid Range: Minimum value of 1. Maximum value of 100.

NextToken (p. 997)

The token used to retrieve the next page of results.

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"NextToken": "string",
"PhoneNumberOrders": [
{
"CreatedTimestamp": number,
"OrderedPhoneNumbers": [
{
"E164PhoneNumber": "string",
"Status": "string"
}
],
"OrderType": "string",
"PhoneNumberOrderId": "string",
"ProductType": "string",
"Status": "string",
"UpdatedTimestamp": number
}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

997
 Amazon Chime SDK API Reference
ListPhoneNumberOrders

NextToken (p. 997)

The token used to retrieve the next page of results.

Type: String
PhoneNumberOrders (p. 997)

The phone number order details.

Type: Array of PhoneNumberOrder (p. 1372) objects

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2

998
 Amazon Chime SDK API Reference
ListPhoneNumberOrders

• AWS SDK for JavaScript

• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

999
 Amazon Chime SDK API Reference
ListPhoneNumbers

ListPhoneNumbers
Service: Amazon Chime SDK Voice

Lists the phone numbers for the specified Amazon Chime SDK account, Amazon Chime SDK user,
Amazon Chime SDK Voice Connector, or Amazon Chime SDK Voice Connector group.

Request Syntax
GET /phone-numbers?filter-name=FilterName&filter-value=FilterValue&max-
results=MaxResults&next-token=NextToken&product-type=ProductType&status=Status HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

FilterName (p. 1000)

The filter to limit the number of results.

Valid Values: VoiceConnectorId | VoiceConnectorGroupId | SipRuleId

FilterValue (p. 1000)

The filter value.

MaxResults (p. 1000)

The maximum number of results to return in a single call.

Valid Range: Minimum value of 1. Maximum value of 100.

NextToken (p. 1000)

The token used to return the next page of results.

ProductType (p. 1000)

The phone number product types.

Valid Values: VoiceConnector | SipMediaApplicationDialIn

Status (p. 1000)

The status of your organization's phone numbers.

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"NextToken": "string",
"PhoneNumbers": [
{
"Associations": [
{

1000
 Amazon Chime SDK API Reference
ListPhoneNumbers

"AssociatedTimestamp": number,
"Name": "string",
"Value": "string"
}
],
"CallingName": "string",
"CallingNameStatus": "string",
"Capabilities": {
"InboundCall": boolean,
"InboundMMS": boolean,
"InboundSMS": boolean,
"OutboundCall": boolean,
"OutboundMMS": boolean,
"OutboundSMS": boolean
},
"Country": "string",
"CreatedTimestamp": number,
"DeletionTimestamp": number,
"E164PhoneNumber": "string",
"OrderId": "string",
"PhoneNumberId": "string",
"ProductType": "string",
"Status": "string",
"Type": "string",
"UpdatedTimestamp": number
}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken (p. 1000)

The token used to return the next page of results.

Type: String
PhoneNumbers (p. 1000)

The phone number details.

Type: Array of PhoneNumber (p. 1364) objects

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

1001
 Amazon Chime SDK API Reference
ListPhoneNumbers

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

1002
 Amazon Chime SDK API Reference
ListProxySessions

ListProxySessions
Service: Amazon Chime SDK Voice

Lists the proxy sessions for the specified Amazon Chime SDK Voice Connector.

Request Syntax
GET /voice-connectors/voiceConnectorId/proxy-sessions?max-results=MaxResults&next-
token=NextToken&status=Status HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MaxResults (p. 1003)

The maximum number of results to return in a single call.

Valid Range: Minimum value of 1. Maximum value of 100.

NextToken (p. 1003)

The token used to retrieve the next page of results.

Length Constraints: Maximum length of 65535.

Status (p. 1003)

The proxy session status.

Valid Values: Open | InProgress | Closed

voiceConnectorId (p. 1003)

The Voice Connector ID.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"NextToken": "string",
"ProxySessions": [
{
"Capabilities": [ "string" ],
"CreatedTimestamp": number,
"EndedTimestamp": number,
"ExpiryMinutes": number,

1003
 Amazon Chime SDK API Reference
ListProxySessions

"GeoMatchLevel": "string",
"GeoMatchParams": {
"AreaCode": "string",
"Country": "string"
},
"Name": "string",
"NumberSelectionBehavior": "string",
"Participants": [
{
"PhoneNumber": "string",
"ProxyPhoneNumber": "string"
}
],
"ProxySessionId": "string",
"Status": "string",
"UpdatedTimestamp": number,
"VoiceConnectorId": "string"
}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken (p. 1003)

The token used to retrieve the next page of results.

Type: String

Length Constraints: Maximum length of 65535.

ProxySessions (p. 1003)

The proxy sessions' details.

Type: Array of ProxySession (p. 1375) objects

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

1004
 Amazon Chime SDK API Reference
ListProxySessions

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

1005
 Amazon Chime SDK API Reference
ListSipMediaApplications

ListSipMediaApplications
Service: Amazon Chime SDK Voice

Lists the SIP media applications under the administrator's AWS account.

Request Syntax
GET /sip-media-applications?max-results=MaxResults&next-token=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MaxResults (p. 1006)

The maximum number of results to return in a single call. Defaults to 100.

Valid Range: Minimum value of 1. Maximum value of 100.

NextToken (p. 1006)

The token used to return the next page of results.

Length Constraints: Maximum length of 65535.

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"NextToken": "string",
"SipMediaApplications": [
{
"AwsRegion": "string",
"CreatedTimestamp": number,
"Endpoints": [
{
"LambdaArn": "string"
}
],
"Name": "string",
"SipMediaApplicationId": "string",
"UpdatedTimestamp": number
}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

1006
 Amazon Chime SDK API Reference
ListSipMediaApplications

NextToken (p. 1006)

The token used to return the next page of results.

Type: String

Length Constraints: Maximum length of 65535.

SipMediaApplications (p. 1006)

The list of SIP media applications and application details.

Type: Array of SipMediaApplication (p. 1378) objects

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go

1007
 Amazon Chime SDK API Reference
ListSipMediaApplications

• AWS SDK for Java V2

• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

1008
 Amazon Chime SDK API Reference
ListSipRules

ListSipRules
Service: Amazon Chime SDK Voice

Lists the SIP rules under the administrator's AWS account.

Request Syntax
GET /sip-rules?max-results=MaxResults&next-token=NextToken&sip-media-
application=SipMediaApplicationId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MaxResults (p. 1009)

The maximum number of results to return in a single call. Defaults to 100.

Valid Range: Minimum value of 1. Maximum value of 100.

NextToken (p. 1009)

The token used to return the next page of results.

Length Constraints: Maximum length of 65535.

SipMediaApplicationId (p. 1009)

The SIP media application ID.

Pattern: .*\S.*

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"NextToken": "string",
"SipRules": [
{
"CreatedTimestamp": number,
"Disabled": boolean,
"Name": "string",
"SipRuleId": "string",
"TargetApplications": [
{
"AwsRegion": "string",
"Priority": number,
"SipMediaApplicationId": "string"
}
],
"TriggerType": "string",
"TriggerValue": "string",
"UpdatedTimestamp": number

1009
 Amazon Chime SDK API Reference
ListSipRules

}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken (p. 1009)

The token used to return the next page of results.

Type: String

Length Constraints: Maximum length of 65535.

SipRules (p. 1009)

The list of SIP rules and details.

Type: Array of SipRule (p. 1384) objects

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

1010
 Amazon Chime SDK API Reference
ListSipRules

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

1011
 Amazon Chime SDK API Reference
ListSupportedPhoneNumberCountries

ListSupportedPhoneNumberCountries
Service: Amazon Chime SDK Voice

Lists the countries that you can order phone numbers from.

Request Syntax
GET /phone-number-countries?product-type=ProductType HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

ProductType (p. 1012)

The phone number product type.

Valid Values: VoiceConnector | SipMediaApplicationDialIn

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"PhoneNumberCountries": [
{
"CountryCode": "string",
"SupportedPhoneNumberTypes": [ "string" ]
}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

PhoneNumberCountries (p. 1012)

The supported phone number countries.

Type: Array of PhoneNumberCountry (p. 1370) objects

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

1012
 Amazon Chime SDK API Reference
ListSupportedPhoneNumberCountries

AccessDeniedException

You don't have the permissions needed to run this action.

HTTP Status Code: 403

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

1013
 Amazon Chime SDK API Reference
ListVoiceConnectorGroups

ListVoiceConnectorGroups
Service: Amazon Chime SDK Voice

Lists the Amazon Chime SDK Voice Connector groups in the administrator's AWS account.

Request Syntax
GET /voice-connector-groups?max-results=MaxResults&next-token=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MaxResults (p. 1014)

The maximum number of results to return in a single call.

Valid Range: Minimum value of 1. Maximum value of 100.

NextToken (p. 1014)

The token used to return the next page of results.

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"NextToken": "string",
"VoiceConnectorGroups": [
{
"CreatedTimestamp": number,
"Name": "string",
"UpdatedTimestamp": number,
"VoiceConnectorGroupArn": "string",
"VoiceConnectorGroupId": "string",
"VoiceConnectorItems": [
{
"Priority": number,
"VoiceConnectorId": "string"
}
]
}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

1014
 Amazon Chime SDK API Reference
ListVoiceConnectorGroups

NextToken (p. 1014)

The token used to return the next page of results.

Type: String
VoiceConnectorGroups (p. 1014)

The details of the Voice Connector groups.

Type: Array of VoiceConnectorGroup (p. 1395) objects

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2

1015
 Amazon Chime SDK API Reference
ListVoiceConnectorGroups

• AWS SDK for JavaScript

• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

1016
 Amazon Chime SDK API Reference
ListVoiceConnectors

ListVoiceConnectors
Service: Amazon Chime SDK Voice

Lists the Amazon Chime SDK Voice Connectors in the administrators AWS account.

Request Syntax
GET /voice-connectors?max-results=MaxResults&next-token=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MaxResults (p. 1017)

The maximum number of results to return in a single call.

Valid Range: Minimum value of 1. Maximum value of 100.

NextToken (p. 1017)

The token used to return the next page of results.

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"NextToken": "string",
"VoiceConnectors": [
{
"AwsRegion": "string",
"CreatedTimestamp": number,
"Name": "string",
"OutboundHostName": "string",
"RequireEncryption": boolean,
"UpdatedTimestamp": number,
"VoiceConnectorArn": "string",
"VoiceConnectorId": "string"
}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken (p. 1017)

The token used to return the next page of results.

1017
 Amazon Chime SDK API Reference
ListVoiceConnectors

Type: String
VoiceConnectors (p. 1017)

The details of the Voice Connectors.

Type: Array of VoiceConnector (p. 1393) objects

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python

1018
 Amazon Chime SDK API Reference
ListVoiceConnectors

• AWS SDK for Ruby V3

1019
 Amazon Chime SDK API Reference
ListVoiceConnectorTerminationCredentials

ListVoiceConnectorTerminationCredentials
Service: Amazon Chime SDK Voice

Lists the SIP credentials for the specified Amazon Chime SDK Voice Connector.

Request Syntax
GET /voice-connectors/voiceConnectorId/termination/credentials HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId (p. 1020)

The Voice Connector ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"Usernames": [ "string" ]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Usernames (p. 1020)

A list of user names.

Type: Array of strings

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

1020
 Amazon Chime SDK API Reference
ListVoiceConnectorTerminationCredentials

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

1021
 Amazon Chime SDK API Reference
PutSipMediaApplicationAlexaSkillConfiguration

PutSipMediaApplicationAlexaSkillConfiguration
Service: Amazon Chime SDK Voice

Updates the Alexa Skill configuration for the SIP media application.

Request Syntax
PUT /sip-media-applications/sipMediaApplicationId/alexa-skill-configuration HTTP/1.1
Content-type: application/json

{
"SipMediaApplicationAlexaSkillConfiguration": {
"AlexaSkillIds": [ "string" ],
"AlexaSkillStatus": "string"
}
}

URI Request Parameters

The request uses the following URI parameters.

sipMediaApplicationId (p. 1022)

The SIP media application ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

SipMediaApplicationAlexaSkillConfiguration (p. 1022)

The Alexa Skill configuration.

Type: SipMediaApplicationAlexaSkillConfiguration (p. 1380) object

Required: No

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"SipMediaApplicationAlexaSkillConfiguration": {
"AlexaSkillIds": [ "string" ],
"AlexaSkillStatus": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

1022
 Amazon Chime SDK API Reference
PutSipMediaApplicationAlexaSkillConfiguration

The following data is returned in JSON format by the service.

SipMediaApplicationAlexaSkillConfiguration (p. 1022)

Returns the Alexa Skill configuration.

Type: SipMediaApplicationAlexaSkillConfiguration (p. 1380) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go

1023
 Amazon Chime SDK API Reference
PutSipMediaApplicationAlexaSkillConfiguration

• AWS SDK for Java V2

• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

1024
 Amazon Chime SDK API Reference
PutSipMediaApplicationLoggingConfiguration

PutSipMediaApplicationLoggingConfiguration
Service: Amazon Chime SDK Voice

Updates the logging configuration for the specified SIP media application.

Request Syntax
PUT /sip-media-applications/sipMediaApplicationId/logging-configuration HTTP/1.1
Content-type: application/json

{
"SipMediaApplicationLoggingConfiguration": {
"EnableSipMediaApplicationMessageLogs": boolean
}
}

URI Request Parameters

The request uses the following URI parameters.

sipMediaApplicationId (p. 1025)

The SIP media application ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

SipMediaApplicationLoggingConfiguration (p. 1025)

The logging configuration for the specified SIP media application.

Type: SipMediaApplicationLoggingConfiguration (p. 1383) object

Required: No

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"SipMediaApplicationLoggingConfiguration": {
"EnableSipMediaApplicationMessageLogs": boolean
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

1025
 Amazon Chime SDK API Reference
PutSipMediaApplicationLoggingConfiguration

The following data is returned in JSON format by the service.

SipMediaApplicationLoggingConfiguration (p. 1025)

The updated logging configuration for the specified SIP media application.

Type: SipMediaApplicationLoggingConfiguration (p. 1383) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go

1026
 Amazon Chime SDK API Reference
PutSipMediaApplicationLoggingConfiguration

• AWS SDK for Java V2

• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

1027
 Amazon Chime SDK API Reference
PutVoiceConnectorEmergencyCallingConfiguration

PutVoiceConnectorEmergencyCallingConfiguration
Service: Amazon Chime SDK Voice

Updates a Voice Connector's emergency calling configuration.

Request Syntax
PUT /voice-connectors/voiceConnectorId/emergency-calling-configuration HTTP/1.1
Content-type: application/json

{
"EmergencyCallingConfiguration": {
"DNIS": [
{
"CallingCountry": "string",
"EmergencyPhoneNumber": "string",
"TestPhoneNumber": "string"
}
]
}
}

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId (p. 1028)

The Voice Connector ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

EmergencyCallingConfiguration (p. 1028)

The configuration being updated.

Type: EmergencyCallingConfiguration (p. 1356) object

Required: Yes

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"EmergencyCallingConfiguration": {
"DNIS": [
{
"CallingCountry": "string",

1028
 Amazon Chime SDK API Reference
PutVoiceConnectorEmergencyCallingConfiguration

"EmergencyPhoneNumber": "string",
"TestPhoneNumber": "string"
}
]
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

EmergencyCallingConfiguration (p. 1028)

The updated configuration.

Type: EmergencyCallingConfiguration (p. 1356) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

1029
 Amazon Chime SDK API Reference
PutVoiceConnectorEmergencyCallingConfiguration

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

1030
 Amazon Chime SDK API Reference
PutVoiceConnectorLoggingConfiguration

PutVoiceConnectorLoggingConfiguration
Service: Amazon Chime SDK Voice

Updates a Voice Connector's logging configuration.

Request Syntax
PUT /voice-connectors/voiceConnectorId/logging-configuration HTTP/1.1
Content-type: application/json

{
"LoggingConfiguration": {
"EnableMediaMetricLogs": boolean,
"EnableSIPLogs": boolean
}
}

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId (p. 1031)

The Voice Connector ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

LoggingConfiguration (p. 1031)

The logging configuration being updated.

Type: LoggingConfiguration (p. 1358) object

Required: Yes

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"LoggingConfiguration": {
"EnableMediaMetricLogs": boolean,
"EnableSIPLogs": boolean
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

1031
 Amazon Chime SDK API Reference
PutVoiceConnectorLoggingConfiguration

The following data is returned in JSON format by the service.

LoggingConfiguration (p. 1031)

The updated logging configuration.

Type: LoggingConfiguration (p. 1358) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go

1032
 Amazon Chime SDK API Reference
PutVoiceConnectorLoggingConfiguration

• AWS SDK for Java V2

• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

1033
 Amazon Chime SDK API Reference
PutVoiceConnectorOrigination

PutVoiceConnectorOrigination
Service: Amazon Chime SDK Voice

Updates a Voice Connector's origination settings.

Request Syntax
PUT /voice-connectors/voiceConnectorId/origination HTTP/1.1
Content-type: application/json

{
"Origination": {
"Disabled": boolean,
"Routes": [
{
"Host": "string",
"Port": number,
"Priority": number,
"Protocol": "string",
"Weight": number
}
]
}
}

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId (p. 1034)

The Voice Connector ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

Origination (p. 1034)

The origination settings being updated.

Type: Origination (p. 1360) object

Required: Yes

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"Origination": {

1034
 Amazon Chime SDK API Reference
PutVoiceConnectorOrigination

"Disabled": boolean,
"Routes": [
{
"Host": "string",
"Port": number,
"Priority": number,
"Protocol": "string",
"Weight": number
}
]
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Origination (p. 1034)

The updated origination settings.

Type: Origination (p. 1360) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

1035
 Amazon Chime SDK API Reference
PutVoiceConnectorOrigination

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

1036
 Amazon Chime SDK API Reference
PutVoiceConnectorProxy

PutVoiceConnectorProxy
Service: Amazon Chime SDK Voice

Puts the specified proxy configuration to the specified Amazon Chime SDK Voice Connector.

Request Syntax
PUT /voice-connectors/voiceConnectorId/programmable-numbers/proxy HTTP/1.1
Content-type: application/json

{
"DefaultSessionExpiryMinutes": number,
"Disabled": boolean,
"FallBackPhoneNumber": "string",
"PhoneNumberPoolCountries": [ "string" ]
}

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId (p. 1037)

The Voice Connector ID.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

DefaultSessionExpiryMinutes (p. 1037)

The default number of minutes allowed for proxy session.

Type: Integer

Required: Yes
Disabled (p. 1037)

When true, stops proxy sessions from being created on the specified Amazon Chime SDK Voice
Connector.

Type: Boolean

Required: No
FallBackPhoneNumber (p. 1037)

The phone number to route calls to after a proxy session expires.

Type: String

Pattern: ^\+?[1-9]\d{1,14}$

1037
 Amazon Chime SDK API Reference
PutVoiceConnectorProxy

Required: No
PhoneNumberPoolCountries (p. 1037)

The countries for proxy phone numbers to be selected from.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Pattern: ^$|^[A-Z]{2,2}$

Required: Yes

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"Proxy": {
"DefaultSessionExpiryMinutes": number,
"Disabled": boolean,
"FallBackPhoneNumber": "string",
"PhoneNumberCountries": [ "string" ]
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Proxy (p. 1038)

The proxy configuration details.

Type: Proxy (p. 1374) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

AccessDeniedException

You don't have the permissions needed to run this action.

HTTP Status Code: 403

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

1038
 Amazon Chime SDK API Reference
PutVoiceConnectorProxy

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

1039
 Amazon Chime SDK API Reference
PutVoiceConnectorStreamingConfiguration

PutVoiceConnectorStreamingConfiguration
Service: Amazon Chime SDK Voice

Updates a Voice Connector's streaming configuration settings.

Request Syntax
PUT /voice-connectors/voiceConnectorId/streaming-configuration HTTP/1.1
Content-type: application/json

{
"StreamingConfiguration": {
"DataRetentionInHours": number,
"Disabled": boolean,
"StreamingNotificationTargets": [
{
"NotificationTarget": "string"
}
]
}
}

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId (p. 1040)

The Voice Connector ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

StreamingConfiguration (p. 1040)

The streaming settings being updated.

Type: StreamingConfiguration (p. 1387) object

Required: Yes

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"StreamingConfiguration": {
"DataRetentionInHours": number,
"Disabled": boolean,
"StreamingNotificationTargets": [

1040
 Amazon Chime SDK API Reference
PutVoiceConnectorStreamingConfiguration

{
"NotificationTarget": "string"
}
]
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

StreamingConfiguration (p. 1040)

The updated streaming settings.

Type: StreamingConfiguration (p. 1387) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

1041
 Amazon Chime SDK API Reference
PutVoiceConnectorStreamingConfiguration

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

1042
 Amazon Chime SDK API Reference
PutVoiceConnectorTermination

PutVoiceConnectorTermination
Service: Amazon Chime SDK Voice

Updates a Voice Connector's termination settings.

Request Syntax
PUT /voice-connectors/voiceConnectorId/termination HTTP/1.1
Content-type: application/json

{
"Termination": {
"CallingRegions": [ "string" ],
"CidrAllowedList": [ "string" ],
"CpsLimit": number,
"DefaultPhoneNumber": "string",
"Disabled": boolean
}
}

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId (p. 1043)

The Voice Connector ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

Termination (p. 1043)

The termination settings to be updated.

Type: Termination (p. 1389) object

Required: Yes

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"Termination": {
"CallingRegions": [ "string" ],
"CidrAllowedList": [ "string" ],
"CpsLimit": number,
"DefaultPhoneNumber": "string",
"Disabled": boolean

1043
 Amazon Chime SDK API Reference
PutVoiceConnectorTermination

}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Termination (p. 1043)

The updated termination settings.

Type: Termination (p. 1389) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

AccessDeniedException

You don't have the permissions needed to run this action.

HTTP Status Code: 403

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

1044
 Amazon Chime SDK API Reference
PutVoiceConnectorTermination

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

1045
 Amazon Chime SDK API Reference
PutVoiceConnectorTerminationCredentials

PutVoiceConnectorTerminationCredentials
Service: Amazon Chime SDK Voice

Updates a Voice Connector's termination credentials.

Request Syntax
POST /voice-connectors/voiceConnectorId/termination/credentials?operation=put HTTP/1.1
Content-type: application/json

{
"Credentials": [
{
"Password": "string",
"Username": "string"
}
]
}

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId (p. 1046)

The Voice Connector ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

Credentials (p. 1046)

The termination credentials being updated.

Type: Array of Credential (p. 1354) objects

Required: No

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

1046
 Amazon Chime SDK API Reference
PutVoiceConnectorTerminationCredentials

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

1047
 Amazon Chime SDK API Reference
RestorePhoneNumber

RestorePhoneNumber
Service: Amazon Chime SDK Voice

Restores a deleted phone number.

Request Syntax
POST /phone-numbers/{phoneNumberId}?operation=restore HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

phoneNumberId (p. 1048)

The ID of the phone number being restored.

Pattern: .*\S.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"PhoneNumber": {
"Associations": [
{
"AssociatedTimestamp": number,
"Name": "string",
"Value": "string"
}
],
"CallingName": "string",
"CallingNameStatus": "string",
"Capabilities": {
"InboundCall": boolean,
"InboundMMS": boolean,
"InboundSMS": boolean,
"OutboundCall": boolean,
"OutboundMMS": boolean,
"OutboundSMS": boolean
},
"Country": "string",
"CreatedTimestamp": number,
"DeletionTimestamp": number,
"E164PhoneNumber": "string",
"OrderId": "string",
"PhoneNumberId": "string",
"ProductType": "string",
"Status": "string",
"Type": "string",

1048
 Amazon Chime SDK API Reference
RestorePhoneNumber

"UpdatedTimestamp": number
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

PhoneNumber (p. 1048)

The restored phone number.

Type: PhoneNumber (p. 1364) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

1049
 Amazon Chime SDK API Reference
RestorePhoneNumber

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

1050
 Amazon Chime SDK API Reference
SearchAvailablePhoneNumbers

SearchAvailablePhoneNumbers
Service: Amazon Chime SDK Voice

Searches the provisioned phone numbers in an organization.

Request Syntax
GET /search?type=phone-numbers&area-code=AreaCode&city=City&country=Country&max-
results=MaxResults&next-token=NextToken&phone-number-type=PhoneNumberType&state=State&toll-
free-prefix=TollFreePrefix HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

AreaCode (p. 1051)

Confines a search to just the phone numbers associated with the specified area code.
City (p. 1051)

Confines a search to just the phone numbers associated with the specified city.
Country (p. 1051)

Confines a search to just the phone numbers associated with the specified country.

Pattern: [A-Z]{2}
MaxResults (p. 1051)

The maximum number of results to return.

Valid Range: Minimum value of 1. Maximum value of 500.

NextToken (p. 1051)

The token used to return the next page of results.

PhoneNumberType (p. 1051)

Confines a search to just the phone numbers associated with the specified phone number type,
either local or toll-free.

Valid Values: Local | TollFree

State (p. 1051)

Confines a search to just the phone numbers associated with the specified state.
TollFreePrefix (p. 1051)

Confines a search to just the phone numbers associated with the specified toll-free prefix.

Length Constraints: Fixed length of 3.

Pattern: ^8(00|33|44|55|66|77|88)$

Request Body
The request does not have a request body.

1051
 Amazon Chime SDK API Reference
SearchAvailablePhoneNumbers

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"E164PhoneNumbers": [ "string" ],
"NextToken": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

E164PhoneNumbers (p. 1052)

Confines a search to just the phone numbers in the E.164 format.

Type: Array of strings

Pattern: ^\+?[1-9]\d{1,14}$
NextToken (p. 1052)

The token used to return the next page of results.

Type: String

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

AccessDeniedException

You don't have the permissions needed to run this action.

HTTP Status Code: 403

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

1052
 Amazon Chime SDK API Reference
SearchAvailablePhoneNumbers

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

1053
 Amazon Chime SDK API Reference
UpdateGlobalSettings

UpdateGlobalSettings
Service: Amazon Chime SDK Voice

Updates global settings for the Amazon Chime SDK Voice Connectors in an AWS account.

Request Syntax
PUT /settings HTTP/1.1
Content-type: application/json

{
"VoiceConnector": {
"CdrBucket": "string"
}
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

VoiceConnector (p. 1054)

The Voice Connector settings.

Type: VoiceConnectorSettings (p. 1398) object

Required: No

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

1054
 Amazon Chime SDK API Reference
UpdateGlobalSettings

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

1055
 Amazon Chime SDK API Reference
UpdatePhoneNumber

UpdatePhoneNumber
Service: Amazon Chime SDK Voice

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.

For numbers outside the U.S., you must use the Amazon Chime SDK SIP Media Application Dial-In
product type.

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.

Request Syntax
POST /phone-numbers/phoneNumberId HTTP/1.1
Content-type: application/json

{
"CallingName": "string",
"ProductType": "string"
}

URI Request Parameters

The request uses the following URI parameters.

phoneNumberId (p. 1056)

The phone number ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

CallingName (p. 1056)

The outbound calling name associated with the phone number.

Type: String

Pattern: ^$|^[a-zA-Z0-9 ]{2,15}$

Required: No
ProductType (p. 1056)

The product type.

Type: String

Valid Values: VoiceConnector | SipMediaApplicationDialIn

1056
 Amazon Chime SDK API Reference
UpdatePhoneNumber

Required: No

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"PhoneNumber": {
"Associations": [
{
"AssociatedTimestamp": number,
"Name": "string",
"Value": "string"
}
],
"CallingName": "string",
"CallingNameStatus": "string",
"Capabilities": {
"InboundCall": boolean,
"InboundMMS": boolean,
"InboundSMS": boolean,
"OutboundCall": boolean,
"OutboundMMS": boolean,
"OutboundSMS": boolean
},
"Country": "string",
"CreatedTimestamp": number,
"DeletionTimestamp": number,
"E164PhoneNumber": "string",
"OrderId": "string",
"PhoneNumberId": "string",
"ProductType": "string",
"Status": "string",
"Type": "string",
"UpdatedTimestamp": number
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

PhoneNumber (p. 1057)

The updated phone number details.

Type: PhoneNumber (p. 1364) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

1057
 Amazon Chime SDK API Reference
UpdatePhoneNumber

ConflictException

Multiple instances of the same request were made simultaneously.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

1058
 Amazon Chime SDK API Reference
UpdatePhoneNumberSettings

UpdatePhoneNumberSettings
Service: Amazon Chime SDK Voice

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.

Request Syntax
PUT /settings/phone-number HTTP/1.1
Content-type: application/json

{
"CallingName": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

CallingName (p. 1059)

The default outbound calling name for the account.

Type: String

Pattern: ^$|^[a-zA-Z0-9 ]{2,15}$

Required: Yes

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

1059
 Amazon Chime SDK API Reference
UpdatePhoneNumberSettings

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

1060
 Amazon Chime SDK API Reference
UpdateProxySession

UpdateProxySession
Service: Amazon Chime SDK Voice

Updates the specified proxy session details, such as voice or SMS capabilities.

Request Syntax
POST /voice-connectors/voiceConnectorId/proxy-sessions/proxySessionId HTTP/1.1
Content-type: application/json

{
"Capabilities": [ "string" ],
"ExpiryMinutes": number
}

URI Request Parameters

The request uses the following URI parameters.

proxySessionId (p. 1061)

The proxy session ID.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: .*\S.*

Required: Yes
voiceConnectorId (p. 1061)

The Voice Connector ID.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

Capabilities (p. 1061)

The proxy session capabilities.

Type: Array of strings

Valid Values: Voice | SMS

Required: Yes
ExpiryMinutes (p. 1061)

The number of minutes allowed for the proxy session.

Type: Integer

1061
 Amazon Chime SDK API Reference
UpdateProxySession

Valid Range: Minimum value of 1.

Required: No

Response Syntax
HTTP/1.1 201
Content-type: application/json

{
"ProxySession": {
"Capabilities": [ "string" ],
"CreatedTimestamp": number,
"EndedTimestamp": number,
"ExpiryMinutes": number,
"GeoMatchLevel": "string",
"GeoMatchParams": {
"AreaCode": "string",
"Country": "string"
},
"Name": "string",
"NumberSelectionBehavior": "string",
"Participants": [
{
"PhoneNumber": "string",
"ProxyPhoneNumber": "string"
}
],
"ProxySessionId": "string",
"Status": "string",
"UpdatedTimestamp": number,
"VoiceConnectorId": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

ProxySession (p. 1062)

The updated proxy session details.

Type: ProxySession (p. 1375) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

1062
 Amazon Chime SDK API Reference
UpdateProxySession

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

1063
 Amazon Chime SDK API Reference
UpdateSipMediaApplication

UpdateSipMediaApplication
Service: Amazon Chime SDK Voice

Updates the details of the specified SIP media application.

Request Syntax
PUT /sip-media-applications/sipMediaApplicationId HTTP/1.1
Content-type: application/json

{
"Endpoints": [
{
"LambdaArn": "string"
}
],
"Name": "string"
}

URI Request Parameters

The request uses the following URI parameters.

sipMediaApplicationId (p. 1064)

The SIP media application ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

Endpoints (p. 1064)

The new set of endpoints for the specified SIP media application.

Type: Array of SipMediaApplicationEndpoint (p. 1382) objects

Array Members: Fixed number of 1 item.

Required: No
Name (p. 1064)

The new name for the specified SIP media application.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: No

Response Syntax
HTTP/1.1 200

1064
 Amazon Chime SDK API Reference
UpdateSipMediaApplication

Content-type: application/json

{
"SipMediaApplication": {
"AwsRegion": "string",
"CreatedTimestamp": number,
"Endpoints": [
{
"LambdaArn": "string"
}
],
"Name": "string",
"SipMediaApplicationId": "string",
"UpdatedTimestamp": number
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

SipMediaApplication (p. 1064)

The updated SIP media appliction's details.

Type: SipMediaApplication (p. 1378) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

Multiple instances of the same request were made simultaneously.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

1065
 Amazon Chime SDK API Reference
UpdateSipMediaApplication

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

1066
 Amazon Chime SDK API Reference
UpdateSipMediaApplicationCall

UpdateSipMediaApplicationCall
Service: Amazon Chime SDK Voice

Invokes the AWS Lambda function associated with the SIP media application and transaction ID in an
update request. The Lambda function can then return a new set of actions.

Request Syntax
POST /sip-media-applications/sipMediaApplicationId/calls/transactionId HTTP/1.1
Content-type: application/json

{
"Arguments": {
"string" : "string"
}
}

URI Request Parameters

The request uses the following URI parameters.

sipMediaApplicationId (p. 1067)

The ID of the SIP media application handling the call.

Pattern: .*\S.*

Required: Yes
transactionId (p. 1067)

The ID of the call transaction.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

Arguments (p. 1067)

Arguments made available to the Lambda function as part of the CALL_UPDATE_REQUESTED event.
Can contain 0-20 key-value pairs.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 20 items.

Required: Yes

Response Syntax
HTTP/1.1 202
Content-type: application/json

1067
 Amazon Chime SDK API Reference
UpdateSipMediaApplicationCall

{
"SipMediaApplicationCall": {
"TransactionId": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

SipMediaApplicationCall (p. 1067)

A Call instance for a SIP media application.

Type: SipMediaApplicationCall (p. 1381) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

1068
 Amazon Chime SDK API Reference
UpdateSipMediaApplicationCall

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

1069
 Amazon Chime SDK API Reference
UpdateSipRule

UpdateSipRule
Service: Amazon Chime SDK Voice

Updates the details of the specified SIP rule.

Request Syntax
PUT /sip-rules/sipRuleId HTTP/1.1
Content-type: application/json

{
"Disabled": boolean,
"Name": "string",
"TargetApplications": [
{
"AwsRegion": "string",
"Priority": number,
"SipMediaApplicationId": "string"
}
]
}

URI Request Parameters

The request uses the following URI parameters.

sipRuleId (p. 1070)

The SIP rule ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

Disabled (p. 1070)

The new value that indicates whether the rule is disabled.

Type: Boolean

Required: No
Name (p. 1070)

The new name for the specified SIP rule.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes
TargetApplications (p. 1070)

The new list of target applications.

1070
 Amazon Chime SDK API Reference
UpdateSipRule

Type: Array of SipRuleTargetApplication (p. 1386) objects

Array Members: Minimum number of 1 item. Maximum number of 25 items.

Required: No

Response Syntax
HTTP/1.1 202
Content-type: application/json

{
"SipRule": {
"CreatedTimestamp": number,
"Disabled": boolean,
"Name": "string",
"SipRuleId": "string",
"TargetApplications": [
{
"AwsRegion": "string",
"Priority": number,
"SipMediaApplicationId": "string"
}
],
"TriggerType": "string",
"TriggerValue": "string",
"UpdatedTimestamp": number
}
}

Response Elements
If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

SipRule (p. 1071)

The updated SIP rule details.

Type: SipRule (p. 1384) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

Multiple instances of the same request were made simultaneously.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

1071
 Amazon Chime SDK API Reference
UpdateSipRule

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

1072
 Amazon Chime SDK API Reference
UpdateVoiceConnector

UpdateVoiceConnector
Service: Amazon Chime SDK Voice

Updates the details for the specified Amazon Chime SDK Voice Connector.

Request Syntax
PUT /voice-connectors/voiceConnectorId HTTP/1.1
Content-type: application/json

{
"Name": "string",
"RequireEncryption": boolean
}

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId (p. 1073)

The Voice Connector ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

Name (p. 1073)

The name of the Voice Connector.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes
RequireEncryption (p. 1073)

When enabled, requires encryption for the Voice Connector.

Type: Boolean

Required: Yes

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"VoiceConnector": {
"AwsRegion": "string",

1073
 Amazon Chime SDK API Reference
UpdateVoiceConnector

"CreatedTimestamp": number,
"Name": "string",
"OutboundHostName": "string",
"RequireEncryption": boolean,
"UpdatedTimestamp": number,
"VoiceConnectorArn": "string",
"VoiceConnectorId": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

VoiceConnector (p. 1073)

The updated Voice Connector detials.

Type: VoiceConnector (p. 1393) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

1074
 Amazon Chime SDK API Reference
UpdateVoiceConnector

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

1075
 Amazon Chime SDK API Reference
UpdateVoiceConnectorGroup

UpdateVoiceConnectorGroup
Service: Amazon Chime SDK Voice

Updates the settings for the specified Amazon Chime SDK Voice Connector group.

Request Syntax
PUT /voice-connector-groups/voiceConnectorGroupId HTTP/1.1
Content-type: application/json

{
"Name": "string",
"VoiceConnectorItems": [
{
"Priority": number,
"VoiceConnectorId": "string"
}
]
}

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorGroupId (p. 1076)

The Voice Connector ID.

Pattern: .*\S.*

Required: Yes

Request Body
The request accepts the following data in JSON format.

Name (p. 1076)

The name of the Voice Connector group.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes
VoiceConnectorItems (p. 1076)

The VoiceConnectorItems to assoicate with the Voice Connector group.

Type: Array of VoiceConnectorItem (p. 1397) objects

Required: Yes

Response Syntax
HTTP/1.1 202

1076
 Amazon Chime SDK API Reference
UpdateVoiceConnectorGroup

Content-type: application/json

{
"VoiceConnectorGroup": {
"CreatedTimestamp": number,
"Name": "string",
"UpdatedTimestamp": number,
"VoiceConnectorGroupArn": "string",
"VoiceConnectorGroupId": "string",
"VoiceConnectorItems": [
{
"Priority": number,
"VoiceConnectorId": "string"
}
]
}
}

Response Elements
If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

VoiceConnectorGroup (p. 1076)

The updated Voice Connector group.

Type: VoiceConnectorGroup (p. 1395) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

Multiple instances of the same request were made simultaneously.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

1077
 Amazon Chime SDK API Reference
UpdateVoiceConnectorGroup

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

1078
 Amazon Chime SDK API Reference
ValidateE911Address

ValidateE911Address
Service: Amazon Chime SDK Voice

Validates an address to be used for 911 calls made with Amazon Chime SDK Voice Connectors. You can
use validated addresses in a Presence Information Data Format Location Object file that you include in
SIP requests. That helps ensure that addresses are routed to the appropriate Public Safety Answering
Point.

Request Syntax
POST /emergency-calling/address HTTP/1.1
Content-type: application/json

{
"AwsAccountId": "string",
"City": "string",
"Country": "string",
"PostalCode": "string",
"State": "string",
"StreetInfo": "string",
"StreetNumber": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

AwsAccountId (p. 1079)

The AWS account ID.

Type: String

Pattern: .*\S.*

Required: Yes
City (p. 1079)

The address city, such as Portland.

Type: String

Pattern: .*\S.*

Required: Yes
Country (p. 1079)

The country in the address being validated.

Type: String

Pattern: .*\S.*

Required: Yes

1079
 Amazon Chime SDK API Reference
ValidateE911Address

PostalCode (p. 1079)

The adress postal code, such 04352.

Type: String

Pattern: .*\S.*

Required: Yes
State (p. 1079)

The address state, such as ME.

Type: String

Pattern: .*\S.*

Required: Yes
StreetInfo (p. 1079)

The address street information, such as 8th Avenue.

Type: String

Pattern: .*\S.*

Required: Yes
StreetNumber (p. 1079)

The address street number, such as 200 or 2121.

Type: String

Pattern: .*\S.*

Required: Yes

Response Syntax
HTTP/1.1 202
Content-type: application/json

{
"Address": {
"city": "string",
"country": "string",
"postalCode": "string",
"postalCodePlus4": "string",
"postDirectional": "string",
"preDirectional": "string",
"state": "string",
"streetName": "string",
"streetNumber": "string",
"streetSuffix": "string"
},
"AddressExternalId": "string",
"CandidateAddressList": [
{
"city": "string",
"country": "string",

1080
 Amazon Chime SDK API Reference
ValidateE911Address

"postalCode": "string",
"postalCodePlus4": "string",
"state": "string",
"streetInfo": "string",
"streetNumber": "string"
}
],
"ValidationResult": number
}

Response Elements
If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

Address (p. 1080)

The validated address.

Type: Address (p. 1350) object

AddressExternalId (p. 1080)

The ID that represents the address.

Type: String
CandidateAddressList (p. 1080)

The list of address suggestions..

Type: Array of CandidateAddress (p. 1352) objects

ValidationResult (p. 1080)

Number indicating the result of address validation. 0 means the address was perfect as-is and
successfully validated. 1 means the address was corrected. 2 means the address sent was not close
enough and was not validated.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 2.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 1399).

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

1081
 Amazon Chime SDK API Reference
ValidateE911Address

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

1082
 Amazon Chime SDK API Reference

Data Types
The following data types are supported by Amazon Chime:

• Account (p. 1091)

• AccountSettings (p. 1093)
• Address (p. 1094)
• AlexaForBusinessMetadata (p. 1096)
• AppInstance (p. 1097)
• AppInstanceAdmin (p. 1099)
• AppInstanceAdminSummary (p. 1100)
• AppInstanceRetentionSettings (p. 1101)
• AppInstanceStreamingConfiguration (p. 1102)
• AppInstanceSummary (p. 1103)
• AppInstanceUser (p. 1104)
• AppInstanceUserMembershipSummary (p. 1106)
• AppInstanceUserSummary (p. 1107)
• ArtifactsConfiguration (p. 1108)
• Attendee (p. 1109)
• AudioArtifactsConfiguration (p. 1110)
• BatchChannelMemberships (p. 1111)
• BatchCreateChannelMembershipError (p. 1112)
• Bot (p. 1113)
• BusinessCallingSettings (p. 1115)
• CandidateAddress (p. 1116)
• Channel (p. 1118)
• ChannelBan (p. 1120)
• ChannelBanSummary (p. 1121)
• ChannelMembership (p. 1122)
• ChannelMembershipForAppInstanceUserSummary (p. 1124)
• ChannelMembershipSummary (p. 1125)
• ChannelMessage (p. 1126)
• ChannelMessageSummary (p. 1128)
• ChannelModeratedByAppInstanceUserSummary (p. 1130)
• ChannelModerator (p. 1131)
• ChannelModeratorSummary (p. 1132)
• ChannelRetentionSettings (p. 1133)
• ChannelSummary (p. 1134)
• ChimeSdkMeetingConfiguration (p. 1136)
• ContentArtifactsConfiguration (p. 1137)
• ConversationRetentionSettings (p. 1138)
• CreateAttendeeError (p. 1139)
• CreateAttendeeRequestItem (p. 1140)
• Credential (p. 1141)

1083
 Amazon Chime SDK API Reference

• DNISEmergencyCallingConfiguration (p. 1142)

• EmergencyCallingConfiguration (p. 1143)
• EngineTranscribeMedicalSettings (p. 1144)
• EngineTranscribeSettings (p. 1146)
• EventsConfiguration (p. 1149)
• GeoMatchParams (p. 1150)
• Identity (p. 1151)
• Invite (p. 1152)
• LoggingConfiguration (p. 1153)
• MediaCapturePipeline (p. 1154)
• MediaPlacement (p. 1156)
• Meeting (p. 1158)
• MeetingNotificationConfiguration (p. 1159)
• Member (p. 1160)
• MemberError (p. 1162)
• MembershipItem (p. 1163)
• MessagingSessionEndpoint (p. 1164)
• OrderedPhoneNumber (p. 1165)
• Origination (p. 1166)
• OriginationRoute (p. 1167)
• Participant (p. 1169)
• PhoneNumber (p. 1170)
• PhoneNumberAssociation (p. 1173)
• PhoneNumberCapabilities (p. 1174)
• PhoneNumberCountry (p. 1176)
• PhoneNumberError (p. 1177)
• PhoneNumberOrder (p. 1178)
• Proxy (p. 1180)
• ProxySession (p. 1181)
• RetentionSettings (p. 1184)
• Room (p. 1185)
• RoomMembership (p. 1187)
• RoomRetentionSettings (p. 1189)
• SelectedVideoStreams (p. 1190)
• SigninDelegateGroup (p. 1191)
• SipMediaApplication (p. 1192)
• SipMediaApplicationCall (p. 1194)
• SipMediaApplicationEndpoint (p. 1195)
• SipMediaApplicationLoggingConfiguration (p. 1196)
• SipRule (p. 1197)
• SipRuleTargetApplication (p. 1199)
• SourceConfiguration (p. 1200)
• StreamingConfiguration (p. 1201)
• StreamingNotificationTarget (p. 1202)
• Tag (p. 1203)
• TelephonySettings (p. 1204)

1084
 Amazon Chime SDK API Reference

• Termination (p. 1205)

• TerminationHealth (p. 1207)
• TranscriptionConfiguration (p. 1208)
• UpdatePhoneNumberRequestItem (p. 1209)
• UpdateUserRequestItem (p. 1210)
• User (p. 1211)
• UserError (p. 1214)
• UserSettings (p. 1215)
• VideoArtifactsConfiguration (p. 1216)
• VoiceConnector (p. 1217)
• VoiceConnectorGroup (p. 1219)
• VoiceConnectorItem (p. 1221)
• VoiceConnectorSettings (p. 1222)

The following data types are supported by Amazon Chime SDK Identity:

• AppInstance (p. 1223)

• AppInstanceAdmin (p. 1225)
• AppInstanceAdminSummary (p. 1226)
• AppInstanceRetentionSettings (p. 1227)
• AppInstanceSummary (p. 1228)
• AppInstanceUser (p. 1229)
• AppInstanceUserEndpoint (p. 1231)
• AppInstanceUserEndpointSummary (p. 1234)
• AppInstanceUserSummary (p. 1236)
• ChannelRetentionSettings (p. 1237)
• EndpointAttributes (p. 1238)
• EndpointState (p. 1239)
• Identity (p. 1240)
• Tag (p. 1241)

The following data types are supported by Amazon Chime SDK Media Pipelines:

• ArtifactsConcatenationConfiguration (p. 1243)

• ArtifactsConfiguration (p. 1245)
• AudioArtifactsConfiguration (p. 1246)
• AudioConcatenationConfiguration (p. 1247)
• ChimeSdkMeetingConcatenationConfiguration (p. 1248)
• ChimeSdkMeetingConfiguration (p. 1249)
• ChimeSdkMeetingLiveConnectorConfiguration (p. 1250)
• CompositedVideoArtifactsConfiguration (p. 1251)
• CompositedVideoConcatenationConfiguration (p. 1252)
• ConcatenationSink (p. 1253)
• ConcatenationSource (p. 1254)
• ContentArtifactsConfiguration (p. 1255)
• ContentConcatenationConfiguration (p. 1256)

1085
 Amazon Chime SDK API Reference

• DataChannelConcatenationConfiguration (p. 1257)

• GridViewConfiguration (p. 1258)
• LiveConnectorRTMPConfiguration (p. 1259)
• LiveConnectorSinkConfiguration (p. 1260)
• LiveConnectorSourceConfiguration (p. 1261)
• MediaCapturePipeline (p. 1262)
• MediaCapturePipelineSourceConfiguration (p. 1264)
• MediaCapturePipelineSummary (p. 1265)
• MediaConcatenationPipeline (p. 1266)
• MediaLiveConnectorPipeline (p. 1268)
• MediaPipeline (p. 1270)
• MediaPipelineSummary (p. 1271)
• MeetingEventsConcatenationConfiguration (p. 1272)
• PresenterOnlyConfiguration (p. 1273)
• S3BucketSinkConfiguration (p. 1274)
• SelectedVideoStreams (p. 1275)
• SourceConfiguration (p. 1276)
• Tag (p. 1277)
• TranscriptionMessagesConcatenationConfiguration (p. 1278)
• VideoArtifactsConfiguration (p. 1279)
• VideoConcatenationConfiguration (p. 1280)

The following data types are supported by Amazon Chime SDK Meetings:

• Attendee (p. 1281)

• AttendeeCapabilities (p. 1283)
• AttendeeIdItem (p. 1285)
• AudioFeatures (p. 1286)
• CreateAttendeeError (p. 1287)
• CreateAttendeeRequestItem (p. 1288)
• EngineTranscribeMedicalSettings (p. 1289)
• EngineTranscribeSettings (p. 1291)
• MediaPlacement (p. 1294)
• Meeting (p. 1296)
• MeetingFeaturesConfiguration (p. 1298)
• NotificationsConfiguration (p. 1299)
• Tag (p. 1300)
• TranscriptionConfiguration (p. 1301)

The following data types are supported by Amazon Chime SDK Messaging:

• AppInstanceUserMembershipSummary (p. 1303)

• BatchChannelMemberships (p. 1304)
• BatchCreateChannelMembershipError (p. 1306)
• Channel (p. 1307)
• ChannelAssociatedWithFlowSummary (p. 1310)

1086
 Amazon Chime SDK API Reference

• ChannelBan (p. 1312)

• ChannelBanSummary (p. 1313)
• ChannelFlow (p. 1314)
• ChannelFlowSummary (p. 1316)
• ChannelMembership (p. 1317)
• ChannelMembershipForAppInstanceUserSummary (p. 1319)
• ChannelMembershipPreferences (p. 1320)
• ChannelMembershipSummary (p. 1321)
• ChannelMessage (p. 1322)
• ChannelMessageCallback (p. 1325)
• ChannelMessageStatusStructure (p. 1327)
• ChannelMessageSummary (p. 1328)
• ChannelModeratedByAppInstanceUserSummary (p. 1330)
• ChannelModerator (p. 1331)
• ChannelModeratorSummary (p. 1332)
• ChannelSummary (p. 1333)
• ElasticChannelConfiguration (p. 1335)
• Identity (p. 1336)
• LambdaConfiguration (p. 1337)
• MessageAttributeValue (p. 1338)
• MessagingSessionEndpoint (p. 1339)
• Processor (p. 1340)
• ProcessorConfiguration (p. 1342)
• PushNotificationConfiguration (p. 1343)
• PushNotificationPreferences (p. 1344)
• SearchField (p. 1345)
• SubChannelSummary (p. 1347)
• Tag (p. 1348)

The following data types are supported by Amazon Chime SDK Voice:

• Address (p. 1350)

• CandidateAddress (p. 1352)
• Credential (p. 1354)
• DNISEmergencyCallingConfiguration (p. 1355)
• EmergencyCallingConfiguration (p. 1356)
• GeoMatchParams (p. 1357)
• LoggingConfiguration (p. 1358)
• OrderedPhoneNumber (p. 1359)
• Origination (p. 1360)
• OriginationRoute (p. 1361)
• Participant (p. 1363)
• PhoneNumber (p. 1364)
• PhoneNumberAssociation (p. 1367)
• PhoneNumberCapabilities (p. 1368)
• PhoneNumberCountry (p. 1370)

1087
 Amazon Chime SDK API Reference
Amazon Chime

• PhoneNumberError (p. 1371)

• PhoneNumberOrder (p. 1372)
• Proxy (p. 1374)
• ProxySession (p. 1375)
• SipMediaApplication (p. 1378)
• SipMediaApplicationAlexaSkillConfiguration (p. 1380)
• SipMediaApplicationCall (p. 1381)
• SipMediaApplicationEndpoint (p. 1382)
• SipMediaApplicationLoggingConfiguration (p. 1383)
• SipRule (p. 1384)
• SipRuleTargetApplication (p. 1386)
• StreamingConfiguration (p. 1387)
• StreamingNotificationTarget (p. 1388)
• Termination (p. 1389)
• TerminationHealth (p. 1391)
• UpdatePhoneNumberRequestItem (p. 1392)
• VoiceConnector (p. 1393)
• VoiceConnectorGroup (p. 1395)
• VoiceConnectorItem (p. 1397)
• VoiceConnectorSettings (p. 1398)

Amazon Chime
The following data types are supported by Amazon Chime:

• Account (p. 1091)

• AccountSettings (p. 1093)
• Address (p. 1094)
• AlexaForBusinessMetadata (p. 1096)
• AppInstance (p. 1097)
• AppInstanceAdmin (p. 1099)
• AppInstanceAdminSummary (p. 1100)
• AppInstanceRetentionSettings (p. 1101)
• AppInstanceStreamingConfiguration (p. 1102)
• AppInstanceSummary (p. 1103)
• AppInstanceUser (p. 1104)
• AppInstanceUserMembershipSummary (p. 1106)
• AppInstanceUserSummary (p. 1107)
• ArtifactsConfiguration (p. 1108)
• Attendee (p. 1109)
• AudioArtifactsConfiguration (p. 1110)
• BatchChannelMemberships (p. 1111)
• BatchCreateChannelMembershipError (p. 1112)
• Bot (p. 1113)
• BusinessCallingSettings (p. 1115)

1088
 Amazon Chime SDK API Reference
Amazon Chime

• CandidateAddress (p. 1116)

• Channel (p. 1118)
• ChannelBan (p. 1120)
• ChannelBanSummary (p. 1121)
• ChannelMembership (p. 1122)
• ChannelMembershipForAppInstanceUserSummary (p. 1124)
• ChannelMembershipSummary (p. 1125)
• ChannelMessage (p. 1126)
• ChannelMessageSummary (p. 1128)
• ChannelModeratedByAppInstanceUserSummary (p. 1130)
• ChannelModerator (p. 1131)
• ChannelModeratorSummary (p. 1132)
• ChannelRetentionSettings (p. 1133)
• ChannelSummary (p. 1134)
• ChimeSdkMeetingConfiguration (p. 1136)
• ContentArtifactsConfiguration (p. 1137)
• ConversationRetentionSettings (p. 1138)
• CreateAttendeeError (p. 1139)
• CreateAttendeeRequestItem (p. 1140)
• Credential (p. 1141)
• DNISEmergencyCallingConfiguration (p. 1142)
• EmergencyCallingConfiguration (p. 1143)
• EngineTranscribeMedicalSettings (p. 1144)
• EngineTranscribeSettings (p. 1146)
• EventsConfiguration (p. 1149)
• GeoMatchParams (p. 1150)
• Identity (p. 1151)
• Invite (p. 1152)
• LoggingConfiguration (p. 1153)
• MediaCapturePipeline (p. 1154)
• MediaPlacement (p. 1156)
• Meeting (p. 1158)
• MeetingNotificationConfiguration (p. 1159)
• Member (p. 1160)
• MemberError (p. 1162)
• MembershipItem (p. 1163)
• MessagingSessionEndpoint (p. 1164)
• OrderedPhoneNumber (p. 1165)
• Origination (p. 1166)
• OriginationRoute (p. 1167)
• Participant (p. 1169)
• PhoneNumber (p. 1170)
• PhoneNumberAssociation (p. 1173)
• PhoneNumberCapabilities (p. 1174)
• PhoneNumberCountry (p. 1176)
• PhoneNumberError (p. 1177)

1089
 Amazon Chime SDK API Reference
Amazon Chime

• PhoneNumberOrder (p. 1178)

• Proxy (p. 1180)
• ProxySession (p. 1181)
• RetentionSettings (p. 1184)
• Room (p. 1185)
• RoomMembership (p. 1187)
• RoomRetentionSettings (p. 1189)
• SelectedVideoStreams (p. 1190)
• SigninDelegateGroup (p. 1191)
• SipMediaApplication (p. 1192)
• SipMediaApplicationCall (p. 1194)
• SipMediaApplicationEndpoint (p. 1195)
• SipMediaApplicationLoggingConfiguration (p. 1196)
• SipRule (p. 1197)
• SipRuleTargetApplication (p. 1199)
• SourceConfiguration (p. 1200)
• StreamingConfiguration (p. 1201)
• StreamingNotificationTarget (p. 1202)
• Tag (p. 1203)
• TelephonySettings (p. 1204)
• Termination (p. 1205)
• TerminationHealth (p. 1207)
• TranscriptionConfiguration (p. 1208)
• UpdatePhoneNumberRequestItem (p. 1209)
• UpdateUserRequestItem (p. 1210)
• User (p. 1211)
• UserError (p. 1214)
• UserSettings (p. 1215)
• VideoArtifactsConfiguration (p. 1216)
• VoiceConnector (p. 1217)
• VoiceConnectorGroup (p. 1219)
• VoiceConnectorItem (p. 1221)
• VoiceConnectorSettings (p. 1222)

1090
 Amazon Chime SDK API Reference
Account

Account
Service: Amazon Chime

The Amazon Chime account details. An AWS account can have multiple Amazon Chime accounts.

Contents
AccountId

The Amazon Chime account ID.

Type: String

Required: Yes
AccountStatus

The status of the account.

Type: String

Valid Values: Suspended | Active

Required: No
AccountType

The Amazon Chime account type. For more information about different account types, see Managing
Your Amazon Chime Accounts in the Amazon Chime Administration Guide.

Type: String

Valid Values: Team | EnterpriseDirectory | EnterpriseLWA | EnterpriseOIDC

Required: No
AwsAccountId

The AWS account ID.

Type: String

Required: Yes
CreatedTimestamp

The Amazon Chime account creation timestamp, in ISO 8601 format.

Type: Timestamp

Required: No
DefaultLicense

The default license for the Amazon Chime account.

Type: String

Valid Values: Basic | Plus | Pro | ProTrial

Required: No
Name

The Amazon Chime account name.

1091
 Amazon Chime SDK API Reference
Account

Type: String

Required: Yes
SigninDelegateGroups

The sign-in delegate groups associated with the account.

Type: Array of SigninDelegateGroup (p. 1191) objects

Required: No
SupportedLicenses

Supported licenses for the Amazon Chime account.

Type: Array of strings

Valid Values: Basic | Plus | Pro | ProTrial

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1092
 Amazon Chime SDK API Reference
AccountSettings

AccountSettings
Service: Amazon Chime

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 Use the Policies Page in the Amazon Chime Administration Guide.

Contents
DisableRemoteControl

Setting that stops or starts remote control of shared screens during meetings.

Type: Boolean

Required: No
EnableDialOut

Setting that allows meeting participants to choose the Call me at a phone number option. For more
information, see Join a Meeting without the Amazon Chime App.

Type: Boolean

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1093
 Amazon Chime SDK API Reference
Address

Address
Service: Amazon Chime

A validated address.

Contents
city

The city of an address.

Type: String

Pattern: .*\S.*

Required: No
country

The country of an address.

Type: String

Pattern: .*\S.*

Required: No
postalCode

The postal code of an address.

Type: String

Pattern: .*\S.*

Required: No
postalCodePlus4

The Zip + 4 or postal code + 4 of an address.

Type: String

Pattern: .*\S.*

Required: No
postDirectional

An address suffix location, such as the S. Unit A in Central Park S. Unit A.

Type: String

Pattern: .*\S.*

Required: No
preDirectional

An address prefix location, such as the N in N. Third St..

Type: String

Pattern: .*\S.*

1094
 Amazon Chime SDK API Reference
Address

Required: No
state

The state of an address.

Type: String

Pattern: .*\S.*

Required: No
streetName

The address street, such as 8th Avenue.

Type: String

Pattern: .*\S.*

Required: No
streetNumber

The numeric portion of an address.

Type: String

Pattern: .*\S.*

Required: No
streetSuffix

The address suffix, such as the N in 8th Avenue N.

Type: String

Pattern: .*\S.*

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1095
 Amazon Chime SDK API Reference
AlexaForBusinessMetadata

AlexaForBusinessMetadata
Service: Amazon Chime

The Alexa for Business metadata associated with an Amazon Chime user, used to integrate Alexa for
Business with a device.

Contents
AlexaForBusinessRoomArn

The ARN of the room resource.

Type: String

Required: No
IsAlexaForBusinessEnabled

Starts or stops Alexa for Business.

Type: Boolean

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1096
 Amazon Chime SDK API Reference
AppInstance

AppInstance
Service: Amazon Chime

The details of an AppInstance, an instance of an Amazon Chime SDK messaging application.

Contents
AppInstanceArn

The ARN of the messaging instance.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: No
CreatedTimestamp

The time at which an AppInstance was created. In epoch milliseconds.

Type: Timestamp

Required: No
LastUpdatedTimestamp

The time an AppInstance was last updated. In epoch milliseconds.

Type: Timestamp

Required: No
Metadata

The metadata of an AppInstance.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: .*

Required: No
Name

The name of an AppInstance.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD
\u10000-\u10FFFF]*

Required: No

1097
 Amazon Chime SDK API Reference
AppInstance

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1098
 Amazon Chime SDK API Reference
AppInstanceAdmin

AppInstanceAdmin
Service: Amazon Chime

The details of an AppInstanceAdmin.

Contents
Admin

The AppInstanceAdmin data.

Type: Identity (p. 1151) object

Required: No
AppInstanceArn

The ARN of the AppInstance for which the user is an administrator.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: No
CreatedTimestamp

The time at which an administrator was created.

Type: Timestamp

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1099
 Amazon Chime SDK API Reference
AppInstanceAdminSummary

AppInstanceAdminSummary
Service: Amazon Chime

Summary of the details of an AppInstanceAdmin.

Contents
Admin

The details of the AppInstanceAdmin.

Type: Identity (p. 1151) object

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1100
 Amazon Chime SDK API Reference
AppInstanceRetentionSettings

AppInstanceRetentionSettings
Service: Amazon Chime

The details of the data-retention settings for an AppInstance.

Contents
ChannelRetentionSettings

The length of time in days to retain the messages in a channel.

Type: ChannelRetentionSettings (p. 1133) object

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1101
 Amazon Chime SDK API Reference
AppInstanceStreamingConfiguration

AppInstanceStreamingConfiguration
Service: Amazon Chime

The details of the streaming configuration of an AppInstance.

Contents
AppInstanceDataType

The type of data to be streamed.

Type: String

Valid Values: Channel | ChannelMessage

Required: Yes
ResourceArn

The resource ARN.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^arn[\/\:\-\_\.a-zA-Z0-9]+$

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1102
 Amazon Chime SDK API Reference
AppInstanceSummary

AppInstanceSummary
Service: Amazon Chime

Summary of the data for an AppInstance.

Contents
AppInstanceArn

The AppInstance ARN.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: No
Metadata

The metadata of the AppInstance.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: .*

Required: No
Name

The name of the AppInstance.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD
\u10000-\u10FFFF]*

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1103
 Amazon Chime SDK API Reference
AppInstanceUser

AppInstanceUser
Service: Amazon Chime

The details of an AppInstanceUser.

Contents
AppInstanceUserArn

The ARN of the AppInstanceUser.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: No
CreatedTimestamp

The time at which the AppInstanceUser was created.

Type: Timestamp

Required: No
LastUpdatedTimestamp

The time at which the AppInstanceUser was last updated.

Type: Timestamp

Required: No
Metadata

The metadata of the AppInstanceUser.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: .*

Required: No
Name

The name of the AppInstanceUser.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: .*\S.*

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

1104
 Amazon Chime SDK API Reference
AppInstanceUser

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1105
 Amazon Chime SDK API Reference
AppInstanceUserMembershipSummary

AppInstanceUserMembershipSummary
Service: Amazon Chime

Summary of the membership details of an AppInstanceUser.

Contents
ReadMarkerTimestamp

The time at which a message was last read.

Type: Timestamp

Required: No
Type

The type of ChannelMembership.

Type: String

Valid Values: DEFAULT | HIDDEN

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1106
 Amazon Chime SDK API Reference
AppInstanceUserSummary

AppInstanceUserSummary
Service: Amazon Chime

Summary of the details of an AppInstanceUser.

Contents
AppInstanceUserArn

The ARN of the AppInstanceUser.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: No
Metadata

The metadata of the AppInstanceUser.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: .*

Required: No
Name

The name of an AppInstanceUser.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: .*\S.*

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1107
 Amazon Chime SDK API Reference
ArtifactsConfiguration

ArtifactsConfiguration
Service: Amazon Chime

The configuration for the artifacts.

Contents
Audio

The configuration for the audio artifacts.

Type: AudioArtifactsConfiguration (p. 1110) object

Required: Yes
Content

The configuration for the content artifacts.

Type: ContentArtifactsConfiguration (p. 1137) object

Required: Yes
Video

The configuration for the video artifacts.

Type: VideoArtifactsConfiguration (p. 1216) object

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1108
 Amazon Chime SDK API Reference
Attendee

Attendee
Service: Amazon Chime

An Amazon Chime SDK meeting attendee. Includes a unique AttendeeId and JoinToken . The
JoinToken allows a client to authenticate and join as the specified attendee. The JoinToken expires
when the meeting ends or when DeleteAttendee (p. 151) is called. After that, the attendee is unable to
join the meeting.

We recommend securely transferring each JoinToken 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.

Contents
AttendeeId

The Amazon Chime SDK attendee ID.

Type: String

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: No
ExternalUserId

The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity
managed by a builder application.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

Required: No
JoinToken

The join token used by the Amazon Chime SDK attendee.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 2048.

Pattern: ^[a-zA-Z0-9+/]+$

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1109
 Amazon Chime SDK API Reference
AudioArtifactsConfiguration

AudioArtifactsConfiguration
Service: Amazon Chime

The audio artifact configuration object.

Contents
MuxType

The MUX type of the audio artifact configuration object.

Type: String

Valid Values: AudioOnly | AudioWithActiveSpeakerVideo

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1110
 Amazon Chime SDK API Reference
BatchChannelMemberships

BatchChannelMemberships
Service: Amazon Chime

The membership information, including member ARNs, the channel ARN, and membership types.

Contents
ChannelArn

The ARN of the channel to which you're adding users.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: No
InvitedBy

The identifier of the member who invited another member.

Type: Identity (p. 1151) object

Required: No
Members

The users successfully added to the request.

Type: Array of Identity (p. 1151) objects

Required: No
Type

The membership types set for the channel users.

Type: String

Valid Values: DEFAULT | HIDDEN

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1111
 Amazon Chime SDK API Reference
BatchCreateChannelMembershipError

BatchCreateChannelMembershipError
Service: Amazon Chime

A list of failed member ARNs, error codes, and error messages.

Contents
ErrorCode

The error code.

Type: String

Valid Values: BadRequest | Conflict | Forbidden | NotFound | PreconditionFailed

| ResourceLimitExceeded | ServiceFailure | AccessDenied |
ServiceUnavailable | Throttled | Throttling | Unauthorized | Unprocessable |
VoiceConnectorGroupAssociationsExist | PhoneNumberAssociationsExist

Required: No
ErrorMessage

The error message.

Type: String

Required: No
MemberArn

The ARN of the member that the service couldn't add.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1112
 Amazon Chime SDK API Reference
Bot

Bot
Service: Amazon Chime

A resource that allows Enterprise account administrators to configure an interface to receive events from
Amazon Chime.

Contents
BotEmail

The bot email address.

Type: String

Required: No
BotId

The bot ID.

Type: String

Required: No
BotType

The bot type.

Type: String

Valid Values: ChatBot

Required: No
CreatedTimestamp

The bot creation timestamp, in ISO 8601 format.

Type: Timestamp

Required: No
Disabled

When true, the bot is stopped from running in your account.

Type: Boolean

Required: No
DisplayName

The bot display name.

Type: String

Required: No
SecurityToken

The security token used to authenticate Amazon Chime with the outgoing event endpoint.

Type: String

Required: No

1113
 Amazon Chime SDK API Reference
Bot

UpdatedTimestamp

The updated bot timestamp, in ISO 8601 format.

Type: Timestamp

Required: No
UserId

The unique ID for the bot user.

Type: String

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1114
 Amazon Chime SDK API Reference
BusinessCallingSettings

BusinessCallingSettings
Service: Amazon Chime

The Amazon Chime Business Calling settings for the administrator's AWS account. Includes any Amazon
S3 buckets designated for storing call detail records.

Contents
CdrBucket

The Amazon S3 bucket designated for call detail record storage.

Type: String

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1115
 Amazon Chime SDK API Reference
CandidateAddress

CandidateAddress
Service: Amazon Chime

A suggested address.

Contents
city

The city of a candidate address.

Type: String

Pattern: .*\S.*

Required: No
country

The country of a candidate address.

Type: String

Pattern: .*\S.*

Required: No
postalCode

The postal code of a candidate address.

Type: String

Pattern: .*\S.*

Required: No
postalCodePlus4

The Zip + 4 or postal code + 4 of a candidate address.

Type: String

Pattern: .*\S.*

Required: No
state

The state of a candidate address.

Type: String

Pattern: .*\S.*

Required: No
streetInfo

The street information of a candidate address

Type: String

Pattern: .*\S.*

1116
 Amazon Chime SDK API Reference
CandidateAddress

Required: No
streetNumber

The numeric portion of a candidate address.

Type: String

Pattern: .*\S.*

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1117
 Amazon Chime SDK API Reference
Channel

Channel
Service: Amazon Chime

The details of a channel.

Contents
ChannelArn

The ARN of the channel.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: No
CreatedBy

The AppInstanceUser who created the channel.

Type: Identity (p. 1151) object

Required: No
CreatedTimestamp

The time at which the AppInstanceUser created the channel.

Type: Timestamp

Required: No
LastMessageTimestamp

The time at which a member sent the last message in the channel.

Type: Timestamp

Required: No
LastUpdatedTimestamp

The time at which a channel was last updated.

Type: Timestamp

Required: No
Metadata

The channel's metadata.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: .*

Required: No

1118
 Amazon Chime SDK API Reference
Channel

Mode

The mode of the channel.

Type: String

Valid Values: UNRESTRICTED | RESTRICTED

Required: No
Name

The name of the channel.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD
\u10000-\u10FFFF]*

Required: No
Privacy

The channel's privacy setting.

Type: String

Valid Values: PUBLIC | PRIVATE

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1119
 Amazon Chime SDK API Reference
ChannelBan

ChannelBan
Service: Amazon Chime

The details of a channel ban.

Contents
ChannelArn

The ARN of the channel from which a member is being banned.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: No
CreatedBy

The AppInstanceUser who created the ban.

Type: Identity (p. 1151) object

Required: No
CreatedTimestamp

The time at which the ban was created.

Type: Timestamp

Required: No
Member

The member being banned from the channel.

Type: Identity (p. 1151) object

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1120
 Amazon Chime SDK API Reference
ChannelBanSummary

ChannelBanSummary
Service: Amazon Chime

Summary of the details of a ChannelBan.

Contents
Member

The member being banned from a channel.

Type: Identity (p. 1151) object

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1121
 Amazon Chime SDK API Reference
ChannelMembership

ChannelMembership
Service: Amazon Chime

The details of a channel member.

Contents
ChannelArn

The ARN of the member's channel.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: No
CreatedTimestamp

The time at which the channel membership was created.

Type: Timestamp

Required: No
InvitedBy

The identifier of the member who invited another member.

Type: Identity (p. 1151) object

Required: No
LastUpdatedTimestamp

The time at which a channel membership was last updated.

Type: Timestamp

Required: No
Member

The data of the channel member.

Type: Identity (p. 1151) object

Required: No
Type

The membership type set for the channel member.

Type: String

Valid Values: DEFAULT | HIDDEN

Required: No

1122
 Amazon Chime SDK API Reference
ChannelMembership

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1123
 Amazon Chime SDK API Reference
ChannelMembershipForAppInstanceUserSummary

ChannelMembershipForAppInstanceUserSummary
Service: Amazon Chime

Summary of the channel membership details of an AppInstanceUser.

Contents
AppInstanceUserMembershipSummary

Summary of the membership details of an AppInstanceUser.

Type: AppInstanceUserMembershipSummary (p. 1106) object

Required: No
ChannelSummary

Summary of the details of a Channel.

Type: ChannelSummary (p. 1134) object

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1124
 Amazon Chime SDK API Reference
ChannelMembershipSummary

ChannelMembershipSummary
Service: Amazon Chime

Summary of the details of a ChannelMembership.

Contents
Member

A member's summary data.

Type: Identity (p. 1151) object

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1125
 Amazon Chime SDK API Reference
ChannelMessage

ChannelMessage
Service: Amazon Chime

The details of a message in a channel.

Contents
ChannelArn

The ARN of the channel.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: No
Content

The message content.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 4096.

Pattern: [\s\S]*

Required: No
CreatedTimestamp

The time at which the message was created.

Type: Timestamp

Required: No
LastEditedTimestamp

The time at which a message was edited.

Type: Timestamp

Required: No
LastUpdatedTimestamp

The time at which a message was updated.

Type: Timestamp

Required: No
MessageId

The ID of a message.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

1126
 Amazon Chime SDK API Reference
ChannelMessage

Pattern: [-_a-zA-Z0-9]*

Required: No
Metadata

The message metadata.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: .*

Required: No
Persistence

The persistence setting for a channel message.

Type: String

Valid Values: PERSISTENT | NON_PERSISTENT

Required: No
Redacted

Hides the content of a message.

Type: Boolean

Required: No
Sender

The message sender.

Type: Identity (p. 1151) object

Required: No
Type

The message type.

Type: String

Valid Values: STANDARD | CONTROL

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1127
 Amazon Chime SDK API Reference
ChannelMessageSummary

ChannelMessageSummary
Service: Amazon Chime

Summary of the messages in a Channel.

Contents
Content

The content of the message.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 4096.

Pattern: [\s\S]*

Required: No
CreatedTimestamp

The time at which the message summary was created.

Type: Timestamp

Required: No
LastEditedTimestamp

The time at which a message was last edited.

Type: Timestamp

Required: No
LastUpdatedTimestamp

The time at which a message was last updated.

Type: Timestamp

Required: No
MessageId

The ID of the message.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [-_a-zA-Z0-9]*

Required: No
Metadata

The metadata of the message.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: .*

1128
 Amazon Chime SDK API Reference
ChannelMessageSummary

Required: No
Redacted

Indicates whether a message was redacted.

Type: Boolean

Required: No
Sender

The message sender.

Type: Identity (p. 1151) object

Required: No
Type

The type of message.

Type: String

Valid Values: STANDARD | CONTROL

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1129
 Amazon Chime SDK API Reference
ChannelModeratedByAppInstanceUserSummary

ChannelModeratedByAppInstanceUserSummary
Service: Amazon Chime

Summary of the details of a moderated channel.

Contents
ChannelSummary

Summary of the details of a Channel.

Type: ChannelSummary (p. 1134) object

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1130
 Amazon Chime SDK API Reference
ChannelModerator

ChannelModerator
Service: Amazon Chime

The details of a channel moderator.

Contents
ChannelArn

The ARN of the moderator's channel.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: No
CreatedBy

The AppInstanceUser who created the moderator.

Type: Identity (p. 1151) object

Required: No
CreatedTimestamp

The time at which the moderator was created.

Type: Timestamp

Required: No
Moderator

The moderator's data.

Type: Identity (p. 1151) object

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1131
 Amazon Chime SDK API Reference
ChannelModeratorSummary

ChannelModeratorSummary
Service: Amazon Chime

Summary of the details of a ChannelModerator.

Contents
Moderator

The data for a moderator.

Type: Identity (p. 1151) object

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1132
 Amazon Chime SDK API Reference
ChannelRetentionSettings

ChannelRetentionSettings
Service: Amazon Chime

The details of the retention settings for a channel.

Contents
RetentionDays

The time in days to retain the messages in a channel.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 5475.

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1133
 Amazon Chime SDK API Reference
ChannelSummary

ChannelSummary
Service: Amazon Chime

Summary of the details of a Channel.

Contents
ChannelArn

The ARN of the channel.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: No
LastMessageTimestamp

The time at which the last message in a channel was sent.

Type: Timestamp

Required: No
Metadata

The metadata of the channel.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: .*

Required: No
Mode

The mode of the channel.

Type: String

Valid Values: UNRESTRICTED | RESTRICTED

Required: No
Name

The name of the channel.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD
\u10000-\u10FFFF]*

Required: No

1134
 Amazon Chime SDK API Reference
ChannelSummary

Privacy

The privacy setting of the channel.

Type: String

Valid Values: PUBLIC | PRIVATE

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1135
 Amazon Chime SDK API Reference
ChimeSdkMeetingConfiguration

ChimeSdkMeetingConfiguration
Service: Amazon Chime

The configuration object of the Amazon Chime SDK meeting for a specified media capture pipeline.
SourceType must be ChimeSdkMeeting.

Contents
ArtifactsConfiguration

The configuration for the artifacts in an Amazon Chime SDK meeting.

Type: ArtifactsConfiguration (p. 1108) object

Required: No
SourceConfiguration

The source configuration for a specified media capture pipline.

Type: SourceConfiguration (p. 1200) object

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1136
 Amazon Chime SDK API Reference
ContentArtifactsConfiguration

ContentArtifactsConfiguration
Service: Amazon Chime

The content artifact object.

Contents
MuxType

The MUX type of the artifact configuration.

Type: String

Valid Values: ContentOnly

Required: No
State

Indicates whether the content artifact is enabled or disabled.

Type: String

Valid Values: Enabled | Disabled

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1137
 Amazon Chime SDK API Reference
ConversationRetentionSettings

ConversationRetentionSettings
Service: Amazon Chime

The retention settings that determine how long to retain conversation messages for an Amazon Chime
Enterprise account.

Contents
RetentionDays

The number of days for which to retain conversation messages.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 5475.

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1138
 Amazon Chime SDK API Reference
CreateAttendeeError

CreateAttendeeError
Service: Amazon Chime

The list of errors returned when errors are encountered during the BatchCreateAttendee and
CreateAttendee actions. This includes external user IDs, error codes, and error messages.

Contents
ErrorCode

The error code.

Type: String

Required: No
ErrorMessage

The error message.

Type: String

Required: No
ExternalUserId

The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity
managed by a builder application.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1139
 Amazon Chime SDK API Reference
CreateAttendeeRequestItem

CreateAttendeeRequestItem
Service: Amazon Chime

The Amazon Chime SDK attendee fields to create, used with the BatchCreateAttendee action.

Contents
ExternalUserId

The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity
managed by a builder application.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

Required: Yes
Tags

The tag key-value pairs.

Type: Array of Tag (p. 1203) objects

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1140
 Amazon Chime SDK API Reference
Credential

Credential
Service: Amazon Chime

The SIP credentials used to authenticate requests to your Amazon Chime Voice Connector.

Contents
Password

The RFC2617 compliant password associated with the SIP credentials, in US-ASCII format.

Type: String

Required: No
Username

The RFC2617 compliant user name associated with the SIP credentials, in US-ASCII format.

Type: String

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1141
 Amazon Chime SDK API Reference
DNISEmergencyCallingConfiguration

DNISEmergencyCallingConfiguration
Service: Amazon Chime

The Dialed Number Identification Service (DNIS) emergency calling configuration details associated with
an Amazon Chime Voice Connector's emergency calling configuration.

Contents
CallingCountry

The country from which emergency calls are allowed, in ISO 3166-1 alpha-2 format.

Type: String

Pattern: [A-Z]{2}

Required: Yes
EmergencyPhoneNumber

The DNIS phone number to route emergency calls to, in E.164 format.

Type: String

Pattern: ^\+?[1-9]\d{1,14}$

Required: Yes
TestPhoneNumber

The DNIS phone number to route test emergency calls to, in E.164 format.

Type: String

Pattern: ^\+?[1-9]\d{1,14}$

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1142
 Amazon Chime SDK API Reference
EmergencyCallingConfiguration

EmergencyCallingConfiguration
Service: Amazon Chime

The emergency calling configuration details associated with an Amazon Chime Voice Connector.

Contents
DNIS

The Dialed Number Identification Service (DNIS) emergency calling configuration details.

Type: Array of DNISEmergencyCallingConfiguration (p. 1142) objects

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1143
 Amazon Chime SDK API Reference
EngineTranscribeMedicalSettings

EngineTranscribeMedicalSettings
Service: Amazon Chime

Settings specific to the Amazon Transcribe Medical engine.

Contents
ContentIdentificationType

Set this field to PHI to identify personal health information in the transcription output.

Type: String

Valid Values: PHI

Required: No
LanguageCode

The language code specified for the Amazon Transcribe Medical engine.

Type: String

Valid Values: en-US

Required: Yes
Region

The AWS Region passed to Amazon Transcribe Medical. If you don't specify a Region, Amazon Chime
uses the meeting's Region.

Type: String

Valid Values: us-east-1 | us-east-2 | us-west-2 | ap-southeast-2 | ca-central-1

| eu-west-1 | auto

Required: No
Specialty

The specialty specified for the Amazon Transcribe Medical engine.

Type: String

Valid Values: PRIMARYCARE | CARDIOLOGY | NEUROLOGY | ONCOLOGY | RADIOLOGY |

UROLOGY

Required: Yes
Type

The type of transcription.

Type: String

Valid Values: CONVERSATION | DICTATION

Required: Yes
VocabularyName

The name of the vocabulary passed to Amazon Transcribe Medical.

1144
 Amazon Chime SDK API Reference
EngineTranscribeMedicalSettings

Type: String

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1145
 Amazon Chime SDK API Reference
EngineTranscribeSettings

EngineTranscribeSettings
Service: Amazon Chime

Settings specific to the Amazon Transcribe engine.

Contents
ContentIdentificationType

Set this field to PII to identify personally identifiable information in the transcription output.

Type: String

Valid Values: PII

Required: No
ContentRedactionType

Set this field to PII to redact personally identifiable information in the transcription output.
Content redaction is performed only upon complete transcription of the audio segments.

Type: String

Valid Values: PII

Required: No
EnablePartialResultsStabilization

Generates partial transcription results that are less likely to change as meeting attendees speak. It
does so by only allowing the last few words from the partial results to change.

Type: Boolean

Required: No
LanguageCode

The language code specified for the Amazon Transcribe engine.

Type: String

Valid Values: en-US | en-GB | es-US | fr-CA | fr-FR | en-AU | it-IT | de-DE |
pt-BR | ja-JP | ko-KR | zh-CN

Required: Yes
LanguageModelName

The name of the language model used during transcription.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Pattern: ^[0-9a-zA-Z._-]+

Required: No
PartialResultsStability

The stabity level of a partial results transcription. Determines how stable you want the transcription
results to be. A higher level means the transcription results are less likely to change.

1146
 Amazon Chime SDK API Reference
EngineTranscribeSettings

Type: String

Valid Values: low | medium | high

Required: No
PiiEntityTypes

Lists the PII entity types you want to identify or redact. To specify entity types, you must enable
ContentIdentificationType or ContentRedactionType.

PIIEntityTypes must be comma-separated. The available values are: BANK_ACCOUNT_NUMBER,

BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN,
EMAIL, ADDRESS, NAME, PHONE, SSN, and ALL.

PiiEntityTypes is an optional parameter with a default value of ALL.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 300.

Pattern: ^[A-Z_, ]+

Required: No
Region

The AWS Region passed to Amazon Transcribe. If you don't specify a Region, Amazon Chime uses the
meeting's Region.

Type: String

Valid Values: us-east-2 | us-east-1 | us-west-2 | ap-northeast-2 | ap-

southeast-2 | ap-northeast-1 | ca-central-1 | eu-central-1 | eu-west-1 | eu-
west-2 | sa-east-1 | auto

Required: No
VocabularyFilterMethod

The filtering method passed to Amazon Transcribe.

Type: String

Valid Values: remove | mask | tag

Required: No
VocabularyFilterName

The name of the vocabulary filter passed to Amazon Transcribe.

Type: String

Required: No
VocabularyName

The name of the vocabulary passed to Amazon Transcribe.

Type: String

Required: No

1147
 Amazon Chime SDK API Reference
EngineTranscribeSettings

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1148
 Amazon Chime SDK API Reference
EventsConfiguration

EventsConfiguration
Service: Amazon Chime

The configuration that allows a bot to receive outgoing events. Can be either an HTTPS endpoint or a
Lambda function ARN.

Contents
BotId

The bot ID.

Type: String

Required: No
LambdaFunctionArn

Lambda function ARN that allows a bot to receive outgoing events.

Type: String

Required: No
OutboundEventsHTTPSEndpoint

HTTPS endpoint that allows a bot to receive outgoing events.

Type: String

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1149
 Amazon Chime SDK API Reference
GeoMatchParams

GeoMatchParams
Service: Amazon Chime

The country and area code for a proxy phone number in a proxy phone session.

Contents
AreaCode

The area code.

Type: String

Pattern: ^$|^[0-9]{3,3}$

Required: Yes
Country

The country.

Type: String

Pattern: ^$|^[A-Z]{2,2}$

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1150
 Amazon Chime SDK API Reference
Identity

Identity
Service: Amazon Chime

The details of a user.

Contents
Arn

The ARN in an Identity.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: No
Name

The name in an Identity.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD
\u10000-\u10FFFF]*

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1151
 Amazon Chime SDK API Reference
Invite

Invite
Service: Amazon Chime

Invitation object returned after emailing users to invite them to join the Amazon Chime Team account.

Contents
EmailAddress

The email address to which the invite is sent.

Type: String

Pattern: .+@.+\..+

Required: No
EmailStatus

The status of the invite email.

Type: String

Valid Values: NotSent | Sent | Failed

Required: No
InviteId

The invite ID.

Type: String

Required: No
Status

The status of the invite.

Type: String

Valid Values: Pending | Accepted | Failed

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1152
 Amazon Chime SDK API Reference
LoggingConfiguration

LoggingConfiguration
Service: Amazon Chime

The logging configuration associated with an Amazon Chime Voice Connector. Specifies whether SIP
message logs are enabled for sending to Amazon CloudWatch Logs.

Contents
EnableMediaMetricLogs

Boolean that enables logging of detailed media metrics for Voice Connectors to Amazon
CloudWatch logs.

Type: Boolean

Required: No
EnableSIPLogs

Boolean that enables SIP message logs to Amazon CloudWatch logs.

Type: Boolean

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1153
 Amazon Chime SDK API Reference
MediaCapturePipeline

MediaCapturePipeline
Service: Amazon Chime

A media capture pipeline object consisting of an ID, source type, source ARN, a sink type, a sink ARN, and
a configuration object.

Contents
ChimeSdkMeetingConfiguration

The configuration for a specified media capture pipeline. SourceType must be ChimeSdkMeeting.

Type: ChimeSdkMeetingConfiguration (p. 1136) object

Required: No
CreatedTimestamp

The time at which the capture pipeline was created, in ISO 8601 format.

Type: Timestamp

Required: No
MediaPipelineId

The ID of a media capture pipeline.

Type: String

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: No
SinkArn

ARN of the destination to which the media artifacts are saved.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^arn[\/\:\-\_\.a-zA-Z0-9]+$

Required: No
SinkType

Destination type to which the media artifacts are saved. You must use an S3 Bucket.

Type: String

Valid Values: S3Bucket

Required: No
SourceArn

ARN of the source from which the media artifacts will be saved.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

1154
 Amazon Chime SDK API Reference
MediaCapturePipeline

Pattern: ^arn[\/\:\-\_\.a-zA-Z0-9]+$

Required: No
SourceType

Source type from which media artifacts are saved. You must use ChimeMeeting.

Type: String

Valid Values: ChimeSdkMeeting

Required: No
Status

The status of the media capture pipeline.

Type: String

Valid Values: Initializing | InProgress | Failed | Stopping | Stopped

Required: No
UpdatedTimestamp

The time at which the capture pipeline was updated, in ISO 8601 format.

Type: Timestamp

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1155
 Amazon Chime SDK API Reference
MediaPlacement

MediaPlacement
Service: Amazon Chime

A set of endpoints used by clients to connect to the media service group for an Amazon Chime SDK
meeting.

Contents
AudioFallbackUrl

The audio fallback URL.

Type: String

Length Constraints: Maximum length of 4096.

Required: No
AudioHostUrl

The audio host URL.

Type: String

Length Constraints: Maximum length of 4096.

Required: No
EventIngestionUrl

The event ingestion URL to which you send client meeting events.

Type: String

Length Constraints: Maximum length of 4096.

Required: No
ScreenDataUrl

The screen data URL.

Type: String

Length Constraints: Maximum length of 4096.

Required: No
ScreenSharingUrl

The screen sharing URL.

Type: String

Length Constraints: Maximum length of 4096.

Required: No
ScreenViewingUrl

The screen viewing URL.

Type: String

1156
 Amazon Chime SDK API Reference
MediaPlacement

Length Constraints: Maximum length of 4096.

Required: No
SignalingUrl

The signaling URL.

Type: String

Length Constraints: Maximum length of 4096.

Required: No
TurnControlUrl

The turn control URL.

Type: String

Length Constraints: Maximum length of 4096.

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1157
 Amazon Chime SDK API Reference
Meeting

Meeting
Service: Amazon Chime

A meeting created using the Amazon Chime SDK.

Contents
ExternalMeetingId

The external meeting ID.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

Required: No
MediaPlacement

The media placement for the meeting.

Type: MediaPlacement (p. 1156) object

Required: No
MediaRegion

The Region in which you create the meeting. Available values: af-south-1, ap-northeast-1,
ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2, ca-central-1, eu-
central-1, eu-north-1, eu-south-1, eu-west-1, eu-west-2, eu-west-3, sa-east-1, us-
east-1, us-east-2, us-west-1, us-west-2.

Type: String

Required: No
MeetingId

The Amazon Chime SDK meeting ID.

Type: String

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1158
 Amazon Chime SDK API Reference
MeetingNotificationConfiguration

MeetingNotificationConfiguration
Service: Amazon Chime

The resource target configurations for receiving Amazon Chime SDK meeting and attendee event
notifications. The Amazon Chime SDK supports resource targets located in the US East (N. Virginia) AWS
Region (us-east-1).

Contents
SnsTopicArn

The SNS topic ARN.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^arn[\/\:\-\_\.a-zA-Z0-9]+$

Required: No
SqsQueueArn

The SQS queue ARN.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^arn[\/\:\-\_\.a-zA-Z0-9]+$

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1159
 Amazon Chime SDK API Reference
Member

Member
Service: Amazon Chime

The member details, such as email address, name, member ID, and member type.

Contents
AccountId

The Amazon Chime account ID.

Type: String

Pattern: .*\S.*

Required: No
Email

The member email address.

Type: String

Required: No
FullName

The member name.

Type: String

Required: No
MemberId

The member ID (user ID or bot ID).

Type: String

Pattern: .*\S.*

Required: No
MemberType

The member type.

Type: String

Valid Values: User | Bot | Webhook

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1160
Amazon Chime SDK API Reference
Member

1161
 Amazon Chime SDK API Reference
MemberError

MemberError
Service: Amazon Chime

The list of errors returned when a member action results in an error.

Contents
ErrorCode

The error code.

Type: String

Valid Values: BadRequest | Conflict | Forbidden | NotFound | PreconditionFailed

| ResourceLimitExceeded | ServiceFailure | AccessDenied |
ServiceUnavailable | Throttled | Throttling | Unauthorized | Unprocessable |
VoiceConnectorGroupAssociationsExist | PhoneNumberAssociationsExist

Required: No
ErrorMessage

The error message.

Type: String

Required: No
MemberId

The member ID.

Type: String

Pattern: .*\S.*

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1162
 Amazon Chime SDK API Reference
MembershipItem

MembershipItem
Service: Amazon Chime

Membership details, such as member ID and member role.

Contents
MemberId

The member ID.

Type: String

Pattern: .*\S.*

Required: No
Role

The member role.

Type: String

Valid Values: Administrator | Member

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1163
 Amazon Chime SDK API Reference
MessagingSessionEndpoint

MessagingSessionEndpoint
Service: Amazon Chime

The websocket endpoint used to connect to Amazon Chime SDK messaging.

Contents
Url

The endpoint to which you establish a websocket connection.

Type: String

Length Constraints: Maximum length of 4096.

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1164
 Amazon Chime SDK API Reference
OrderedPhoneNumber

OrderedPhoneNumber
Service: Amazon Chime

A phone number for which an order has been placed.

Contents
E164PhoneNumber

The phone number, in E.164 format.

Type: String

Pattern: ^\+?[1-9]\d{1,14}$

Required: No
Status

The phone number status.

Type: String

Valid Values: Processing | Acquired | Failed

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1165
 Amazon Chime SDK API Reference
Origination

Origination
Service: Amazon Chime

Origination settings enable your SIP hosts to receive inbound calls using your Amazon Chime Voice
Connector.
Note
The parameters listed below are not required, but you must use at least one.

Contents
Disabled

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 Routes.

Type: Boolean

Required: No
Routes

The call distribution properties defined for your SIP hosts. Valid range: Minimum value of 1.
Maximum value of 20. This parameter is not required, but you must specify this parameter or
Disabled.

Type: Array of OriginationRoute (p. 1167) objects

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1166
 Amazon Chime SDK API Reference
OriginationRoute

OriginationRoute
Service: Amazon Chime

Origination routes define call distribution properties for your SIP hosts to receive inbound calls using
your Amazon Chime Voice Connector. Limit: Ten origination routes for each Amazon Chime Voice
Connector.
Note
The parameters listed below are not required, but you must use at least one.

Contents
Host

The FQDN or IP address to contact for origination traffic.

Type: String

Required: No
Port

The designated origination route port. Defaults to 5060.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 65535.

Required: No
Priority

The priority associated with the host, with 1 being the highest priority. Higher priority hosts are
attempted first.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No
Protocol

The protocol to use for the origination route. Encryption-enabled Amazon Chime Voice Connectors
use TCP protocol by default.

Type: String

Valid Values: TCP | UDP

Required: No
Weight

The weight associated with the host. If hosts are equal in priority, calls are redistributed among them
based on their relative weight.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

1167
 Amazon Chime SDK API Reference
OriginationRoute

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1168
 Amazon Chime SDK API Reference
Participant

Participant
Service: Amazon Chime

The phone number and proxy phone number for a participant in an Amazon Chime Voice Connector
proxy session.

Contents
PhoneNumber

The participant's phone number.

Type: String

Pattern: ^\+?[1-9]\d{1,14}$

Required: No
ProxyPhoneNumber

The participant's proxy phone number.

Type: String

Pattern: ^\+?[1-9]\d{1,14}$

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1169
 Amazon Chime SDK API Reference
PhoneNumber

PhoneNumber
Service: Amazon Chime

A phone number used for Amazon Chime Business Calling or an Amazon Chime Voice Connector.

Contents
Associations

The phone number associations.

Type: Array of PhoneNumberAssociation (p. 1173) objects

Required: No
CallingName

The outbound calling name associated with the phone number.

Type: String

Pattern: ^$|^[a-zA-Z0-9 ]{2,15}$

Required: No
CallingNameStatus

The outbound calling name status.

Type: String

Valid Values: Unassigned | UpdateInProgress | UpdateSucceeded | UpdateFailed

Required: No
Capabilities

The phone number capabilities.

Type: PhoneNumberCapabilities (p. 1174) object

Required: No
Country

The phone number country. Format: ISO 3166-1 alpha-2.

Type: String

Pattern: [A-Z]{2}

Required: No
CreatedTimestamp

The phone number creation timestamp, in ISO 8601 format.

Type: Timestamp

Required: No
DeletionTimestamp

The deleted phone number timestamp, in ISO 8601 format.

1170
 Amazon Chime SDK API Reference
PhoneNumber

Type: Timestamp

Required: No
E164PhoneNumber

The phone number, in E.164 format.

Type: String

Pattern: ^\+?[1-9]\d{1,14}$

Required: No
PhoneNumberId

The phone number ID.

Type: String

Required: No
ProductType

The phone number product type.

Type: String

Valid Values: BusinessCalling | VoiceConnector | SipMediaApplicationDialIn

Required: No
Status

The phone number status.

Type: String

Valid Values: AcquireInProgress | AcquireFailed | Unassigned | Assigned |

ReleaseInProgress | DeleteInProgress | ReleaseFailed | DeleteFailed

Required: No
Type

The phone number type.

Type: String

Valid Values: Local | TollFree

Required: No
UpdatedTimestamp

The updated phone number timestamp, in ISO 8601 format.

Type: Timestamp

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

1171
 Amazon Chime SDK API Reference
PhoneNumber

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1172
 Amazon Chime SDK API Reference
PhoneNumberAssociation

PhoneNumberAssociation
Service: Amazon Chime

The phone number associations, such as Amazon Chime account ID, Amazon Chime user ID, Amazon
Chime Voice Connector ID, or Amazon Chime Voice Connector group ID.

Contents
AssociatedTimestamp

The timestamp of the phone number association, in ISO 8601 format.

Type: Timestamp

Required: No
Name

Defines the association with an Amazon Chime account ID, user ID, Amazon Chime Voice Connector
ID, or Amazon Chime Voice Connector group ID.

Type: String

Valid Values: AccountId | UserId | VoiceConnectorId | VoiceConnectorGroupId |

SipRuleId

Required: No
Value

Contains the ID for the entity specified in Name.

Type: String

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1173
 Amazon Chime SDK API Reference
PhoneNumberCapabilities

PhoneNumberCapabilities
Service: Amazon Chime

The phone number capabilities for Amazon Chime Business Calling phone numbers, such as enabled
inbound and outbound calling and text messaging.

Contents
InboundCall

Allows or denies inbound calling for the specified phone number.

Type: Boolean

Required: No
InboundMMS

Allows or denies inbound MMS messaging for the specified phone number.

Type: Boolean

Required: No
InboundSMS

Allows or denies inbound SMS messaging for the specified phone number.

Type: Boolean

Required: No
OutboundCall

Allows or denies outbound calling for the specified phone number.

Type: Boolean

Required: No
OutboundMMS

Allows or denies outbound MMS messaging for the specified phone number.

Type: Boolean

Required: No
OutboundSMS

Allows or denies outbound SMS messaging for the specified phone number.

Type: Boolean

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go

1174
 Amazon Chime SDK API Reference
PhoneNumberCapabilities

• AWS SDK for Java V2

• AWS SDK for Ruby V3

1175
 Amazon Chime SDK API Reference
PhoneNumberCountry

PhoneNumberCountry
Service: Amazon Chime

The phone number country.

Contents
CountryCode

The phone number country code. Format: ISO 3166-1 alpha-2.

Type: String

Pattern: [A-Z]{2}

Required: No
SupportedPhoneNumberTypes

The supported phone number types.

Type: Array of strings

Valid Values: Local | TollFree

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1176
 Amazon Chime SDK API Reference
PhoneNumberError

PhoneNumberError
Service: Amazon Chime

If the phone number action fails for one or more of the phone numbers in the request, a list of the phone
numbers is returned, along with error codes and error messages.

Contents
ErrorCode

The error code.

Type: String

Valid Values: BadRequest | Conflict | Forbidden | NotFound | PreconditionFailed

| ResourceLimitExceeded | ServiceFailure | AccessDenied |
ServiceUnavailable | Throttled | Throttling | Unauthorized | Unprocessable |
VoiceConnectorGroupAssociationsExist | PhoneNumberAssociationsExist

Required: No
ErrorMessage

The error message.

Type: String

Required: No
PhoneNumberId

The phone number ID for which the action failed.

Type: String

Pattern: .*\S.*

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1177
 Amazon Chime SDK API Reference
PhoneNumberOrder

PhoneNumberOrder
Service: Amazon Chime

The details of a phone number order created for Amazon Chime.

Contents
CreatedTimestamp

The phone number order creation time stamp, in ISO 8601 format.

Type: Timestamp

Required: No
OrderedPhoneNumbers

The ordered phone number details, such as the phone number in E.164 format and the phone
number status.

Type: Array of OrderedPhoneNumber (p. 1165) objects

Required: No
PhoneNumberOrderId

The phone number order ID.

Type: String

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: No
ProductType

The phone number order product type.

Type: String

Valid Values: BusinessCalling | VoiceConnector | SipMediaApplicationDialIn

Required: No
Status

The status of the phone number order.

Type: String

Valid Values: Processing | Successful | Failed | Partial

Required: No
UpdatedTimestamp

The updated phone number order time stamp, in ISO 8601 format.

Type: Timestamp

Required: No

1178
 Amazon Chime SDK API Reference
PhoneNumberOrder

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1179
 Amazon Chime SDK API Reference
Proxy

Proxy
Service: Amazon Chime

The proxy configuration for an Amazon Chime Voice Connector.

Contents
DefaultSessionExpiryMinutes

The default number of minutes allowed for proxy sessions.

Type: Integer

Required: No
Disabled

When true, stops proxy sessions from being created on the specified Amazon Chime Voice
Connector.

Type: Boolean

Required: No
FallBackPhoneNumber

The phone number to route calls to after a proxy session expires.

Type: String

Pattern: ^\+?[1-9]\d{1,14}$

Required: No
PhoneNumberCountries

The countries for proxy phone numbers to be selected from.

Type: Array of strings

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1180
 Amazon Chime SDK API Reference
ProxySession

ProxySession
Service: Amazon Chime

The proxy session for an Amazon Chime Voice Connector.

Contents
Capabilities

The proxy session capabilities.

Type: Array of strings

Valid Values: Voice | SMS

Required: No
CreatedTimestamp

The created time stamp, in ISO 8601 format.

Type: Timestamp

Required: No
EndedTimestamp

The ended time stamp, in ISO 8601 format.

Type: Timestamp

Required: No
ExpiryMinutes

The number of minutes allowed for the proxy session.

Type: Integer

Valid Range: Minimum value of 1.

Required: No
GeoMatchLevel

The preference for matching the country or area code of the proxy phone number with that of the
first participant.

Type: String

Valid Values: Country | AreaCode

Required: No
GeoMatchParams

The country and area code for the proxy phone number.

Type: GeoMatchParams (p. 1150) object

Required: No
Name

The name of the proxy session.

1181
 Amazon Chime SDK API Reference
ProxySession

Type: String

Length Constraints: Maximum length of 128.

Required: No
NumberSelectionBehavior

The preference for proxy phone number reuse, or stickiness, between the same participants across
sessions.

Type: String

Valid Values: PreferSticky | AvoidSticky

Required: No
Participants

The proxy session participants.

Type: Array of Participant (p. 1169) objects

Required: No
ProxySessionId

The proxy session ID.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: .*\S.*

Required: No
Status

The status of the proxy session.

Type: String

Valid Values: Open | InProgress | Closed

Required: No
UpdatedTimestamp

The updated time stamp, in ISO 8601 format.

Type: Timestamp

Required: No
VoiceConnectorId

The Amazon Chime voice connector ID.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: .*\S.*

Required: No

1182
 Amazon Chime SDK API Reference
ProxySession

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1183
 Amazon Chime SDK API Reference
RetentionSettings

RetentionSettings
Service: Amazon Chime

The retention settings for an Amazon Chime Enterprise account that determine how long to retain items
such as chat-room messages and chat-conversation messages.

Contents
ConversationRetentionSettings

The chat conversation retention settings.

Type: ConversationRetentionSettings (p. 1138) object

Required: No
RoomRetentionSettings

The chat room retention settings.

Type: RoomRetentionSettings (p. 1189) object

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1184
 Amazon Chime SDK API Reference
Room

Room
Service: Amazon Chime

The Amazon Chime chat room details.

Contents
AccountId

The Amazon Chime account ID.

Type: String

Pattern: .*\S.*

Required: No
CreatedBy

The identifier of the room creator.

Type: String

Pattern: .*\S.*

Required: No
CreatedTimestamp

The room creation timestamp, in ISO 8601 format.

Type: Timestamp

Required: No
Name

The room name.

Type: String

Required: No
RoomId

The room ID.

Type: String

Pattern: .*\S.*

Required: No
UpdatedTimestamp

The room update timestamp, in ISO 8601 format.

Type: Timestamp

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

1185
 Amazon Chime SDK API Reference
Room

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1186
 Amazon Chime SDK API Reference
RoomMembership

RoomMembership
Service: Amazon Chime

The room membership details.

Contents
InvitedBy

The identifier of the user that invited the room member.

Type: String

Pattern: .*\S.*

Required: No
Member

The member details, such as email address, name, member ID, and member type.

Type: Member (p. 1160) object

Required: No
Role

The membership role.

Type: String

Valid Values: Administrator | Member

Required: No
RoomId

The room ID.

Type: String

Pattern: .*\S.*

Required: No
UpdatedTimestamp

The room membership update timestamp, in ISO 8601 format.

Type: Timestamp

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1187
Amazon Chime SDK API Reference
RoomMembership

1188
 Amazon Chime SDK API Reference
RoomRetentionSettings

RoomRetentionSettings
Service: Amazon Chime

The retention settings that determine how long to retain chat-room messages for an Amazon Chime
Enterprise account.

Contents
RetentionDays

The number of days for which to retain chat-room messages.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 5475.

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1189
 Amazon Chime SDK API Reference
SelectedVideoStreams

SelectedVideoStreams
Service: Amazon Chime

The video streams to capture for a specified media capture pipeline. The total number of video streams
can't exceed 25.

Contents
AttendeeIds

The attendee IDs of the streams selected for a media capture pipeline.

Type: Array of strings

Array Members: Minimum number of 1 item.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: No
ExternalUserIds

The external user IDs of the streams selected for a media capture pipeline.

Type: Array of strings

Array Members: Minimum number of 1 item.

Length Constraints: Minimum length of 2. Maximum length of 64.

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1190
 Amazon Chime SDK API Reference
SigninDelegateGroup

SigninDelegateGroup
Service: Amazon Chime

An Active Directory (AD) group whose members are granted permission to act as delegates.

Contents
GroupName

The group name.

Type: String

Pattern: .*\S.*

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1191
 Amazon Chime SDK API Reference
SipMediaApplication

SipMediaApplication
Service: Amazon Chime

The details of the SIP media application, including name and endpoints. An AWS account can have
multiple SIP media applications.

Contents
AwsRegion

The AWS Region in which the SIP media application is created.

Type: String

Required: No
CreatedTimestamp

The SIP media application creation timestamp, in ISO 8601 format.

Type: Timestamp

Required: No
Endpoints

List of endpoints for SIP media application. Currently, only one endpoint per SIP media application is
permitted.

Type: Array of SipMediaApplicationEndpoint (p. 1195) objects

Array Members: Fixed number of 1 item.

Required: No
Name

The name of the SIP media application.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: No
SipMediaApplicationId

The SIP media application ID.

Type: String

Pattern: .*\S.*

Required: No
UpdatedTimestamp

The SIP media application updated timestamp, in ISO 8601 format.

Type: Timestamp

Required: No

1192
 Amazon Chime SDK API Reference
SipMediaApplication

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1193
 Amazon Chime SDK API Reference
SipMediaApplicationCall

SipMediaApplicationCall
Service: Amazon Chime

A Call instance for a SIP media application.

Contents
TransactionId

The transaction ID of a call.

Type: String

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1194
 Amazon Chime SDK API Reference
SipMediaApplicationEndpoint

SipMediaApplicationEndpoint
Service: Amazon Chime

The endpoint assigned to the SIP media application.

Contents
LambdaArn

Valid Amazon Resource Name (ARN) of the Lambda function, version, or alias. The function must be
created in the same AWS Region as the SIP media application.

Type: String

Length Constraints: Maximum length of 10000.

Pattern: arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-
\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(:(\$LATEST|[a-zA-Z0-9-_]+))?

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1195
 Amazon Chime SDK API Reference
SipMediaApplicationLoggingConfiguration

SipMediaApplicationLoggingConfiguration
Service: Amazon Chime

Logging configuration of the SIP media application.

Contents
EnableSipMediaApplicationMessageLogs

Enables application message logs for the SIP media application.

Type: Boolean

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1196
 Amazon Chime SDK API Reference
SipRule

SipRule
Service: Amazon Chime

The SIP rule details, including name, triggers, and target applications. An AWS account can have multiple
SIP rules.

Contents
CreatedTimestamp

The time at which the SIP rule was created, in ISO 8601 format.

Type: Timestamp

Required: No
Disabled

Indicates whether the SIP rule is enabled or disabled. You must disable a rule before you can delete
it.

Type: Boolean

Required: No
Name

The name of the SIP rule.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: No
SipRuleId

The SIP rule ID.

Type: String

Pattern: .*\S.*

Required: No
TargetApplications

Target SIP media application and other details, such as priority and AWS Region, to be specified in
the SIP rule. Only one SIP rule per AWS Region can be provided.

Type: Array of SipRuleTargetApplication (p. 1199) objects

Array Members: Minimum number of 1 item. Maximum number of 25 items.

Required: No
TriggerType

The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname or
ToPhoneNumber.

Type: String

Valid Values: ToPhoneNumber | RequestUriHostname

1197
 Amazon Chime SDK API Reference
SipRule

Required: No
TriggerValue

If TriggerType is RequestUriHostname, then the value can be the outbound host name of
the Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber, then the value can be a
customer-owned phone number in E164 format. SipRule is triggered when a SIP rule requests host
name or ToPhoneNumber matches in the incoming SIP request.

Type: String

Pattern: .*\S.*

Required: No
UpdatedTimestamp

The time at which the SIP rule was last updated, in ISO 8601 format.

Type: Timestamp

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1198
 Amazon Chime SDK API Reference
SipRuleTargetApplication

SipRuleTargetApplication
Service: Amazon Chime

Target SIP media application and other details, such as priority and AWS Region, to be specified in the
SIP rule. Only one SIP rule per AWS Region can be provided.

Contents
AwsRegion

The AWS Region of the target application.

Type: String

Required: No
Priority

Priority of the SIP media application in the target list.

Type: Integer

Valid Range: Minimum value of 1.

Required: No
SipMediaApplicationId

The SIP media application ID.

Type: String

Pattern: .*\S.*

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1199
 Amazon Chime SDK API Reference
SourceConfiguration

SourceConfiguration
Service: Amazon Chime

Source configuration for a specified media capture pipeline.

Contents
SelectedVideoStreams

The selected video streams to capture for a specified media capture pipeline. The number of video
streams can't exceed 25.

Type: SelectedVideoStreams (p. 1190) object

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1200
 Amazon Chime SDK API Reference
StreamingConfiguration

StreamingConfiguration
Service: Amazon Chime

The streaming configuration associated with an Amazon Chime Voice Connector. Specifies whether
media streaming is enabled for sending to Amazon Kinesis, and shows the retention period for the
Amazon Kinesis data, in hours.

Contents
DataRetentionInHours

The retention period, in hours, for the Amazon Kinesis data.

Type: Integer

Valid Range: Minimum value of 0.

Required: Yes
Disabled

When true, media streaming to Amazon Kinesis is turned off.

Type: Boolean

Required: No
StreamingNotificationTargets

The streaming notification targets.

Type: Array of StreamingNotificationTarget (p. 1202) objects

Array Members: Minimum number of 1 item. Maximum number of 3 items.

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1201
 Amazon Chime SDK API Reference
StreamingNotificationTarget

StreamingNotificationTarget
Service: Amazon Chime

The targeted recipient for a streaming configuration notification.

Contents
NotificationTarget

The streaming notification target.

Type: String

Valid Values: EventBridge | SNS | SQS

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1202
 Amazon Chime SDK API Reference
Tag

Tag
Service: Amazon Chime

Describes a tag applied to a resource.

Contents
Key

The key of the tag.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: Yes
Value

The value of the tag.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1203
 Amazon Chime SDK API Reference
TelephonySettings

TelephonySettings
Service: Amazon Chime

Settings that allow management of telephony permissions for an Amazon Chime user, such as inbound
and outbound calling and text messaging.

Contents
InboundCalling

Allows or denies inbound calling.

Type: Boolean

Required: Yes
OutboundCalling

Allows or denies outbound calling.

Type: Boolean

Required: Yes
SMS

Allows or denies SMS messaging.

Type: Boolean

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1204
 Amazon Chime SDK API Reference
Termination

Termination
Service: Amazon Chime

Termination settings enable your SIP hosts to make outbound calls using your Amazon Chime Voice
Connector.

Contents
CallingRegions

The countries to which calls are allowed, in ISO 3166-1 alpha-2 format. Required.

Type: Array of strings

Required: No
CidrAllowedList

The IP addresses allowed to make calls, in CIDR format. Required.

Type: Array of strings

Required: No
CpsLimit

The limit on calls per second. Max value based on account service quota. Default value of 1.

Type: Integer

Valid Range: Minimum value of 1.

Required: No
DefaultPhoneNumber

The default caller ID phone number.

Type: String

Pattern: ^\+?[1-9]\d{1,14}$

Required: No
Disabled

When termination settings are disabled, outbound calls can not be made.

Type: Boolean

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1205
Amazon Chime SDK API Reference
Termination

1206
 Amazon Chime SDK API Reference
TerminationHealth

TerminationHealth
Service: Amazon Chime

The termination health details, including the source IP address and timestamp of the last successful SIP
OPTIONS message from your SIP infrastructure.

Contents
Source

The source IP address.

Type: String

Required: No
Timestamp

The timestamp, in ISO 8601 format.

Type: Timestamp

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1207
 Amazon Chime SDK API Reference
TranscriptionConfiguration

TranscriptionConfiguration
Service: Amazon Chime

The configuration for the current transcription operation. Must contain EngineTranscribeSettings
or EngineTranscribeMedicalSettings.

Contents
EngineTranscribeMedicalSettings

The transcription configuration settings passed to Amazon Transcribe Medical.

Type: EngineTranscribeMedicalSettings (p. 1144) object

Required: No
EngineTranscribeSettings

The transcription configuration settings passed to Amazon Transcribe.

Type: EngineTranscribeSettings (p. 1146) object

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1208
 Amazon Chime SDK API Reference
UpdatePhoneNumberRequestItem

UpdatePhoneNumberRequestItem
Service: Amazon Chime

The phone number ID, product type, or calling name fields to update, used with the
BatchUpdatePhoneNumber (p. 47) and UpdatePhoneNumber (p. 544) actions.

Contents
CallingName

The outbound calling name to update.

Type: String

Pattern: ^$|^[a-zA-Z0-9 ]{2,15}$

Required: No
PhoneNumberId

The phone number ID to update.

Type: String

Pattern: .*\S.*

Required: Yes
ProductType

The product type to update.

Type: String

Valid Values: BusinessCalling | VoiceConnector | SipMediaApplicationDialIn

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1209
 Amazon Chime SDK API Reference
UpdateUserRequestItem

UpdateUserRequestItem
Service: Amazon Chime

The user ID and user fields to update, used with the BatchUpdateUser (p. 51) action.

Contents
AlexaForBusinessMetadata

The Alexa for Business metadata.

Type: AlexaForBusinessMetadata (p. 1096) object

Required: No
LicenseType

The user license type.

Type: String

Valid Values: Basic | Plus | Pro | ProTrial

Required: No
UserId

The user ID.

Type: String

Pattern: .*\S.*

Required: Yes
UserType

The user type.

Type: String

Valid Values: PrivateUser | SharedDevice

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1210
 Amazon Chime SDK API Reference
User

User
Service: Amazon Chime

The user on the Amazon Chime account.

Contents
AccountId

The Amazon Chime account ID.

Type: String

Required: No
AlexaForBusinessMetadata

The Alexa for Business metadata.

Type: AlexaForBusinessMetadata (p. 1096) object

Required: No
DisplayName

The display name of the user.

Type: String

Required: No
InvitedOn

Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.

Type: Timestamp

Required: No
LicenseType

The license type for the user.

Type: String

Valid Values: Basic | Plus | Pro | ProTrial

Required: No
PersonalPIN

The user's personal meeting PIN.

Type: String

Required: No
PrimaryEmail

The primary email address of the user.

Type: String

Pattern: .+@.+\..+

1211
 Amazon Chime SDK API Reference
User

Required: No
PrimaryProvisionedNumber

The primary phone number associated with the user.

Type: String

Required: No
RegisteredOn

Date and time when the user is registered, in ISO 8601 format.

Type: Timestamp

Required: No
UserId

The user ID.

Type: String

Required: Yes
UserInvitationStatus

The user invite status.

Type: String

Valid Values: Pending | Accepted | Failed

Required: No
UserRegistrationStatus

The user registration status.

Type: String

Valid Values: Unregistered | Registered | Suspended

Required: No
UserType

The user type.

Type: String

Valid Values: PrivateUser | SharedDevice

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1212
Amazon Chime SDK API Reference
User

1213
 Amazon Chime SDK API Reference
UserError

UserError
Service: Amazon Chime

The list of errors returned when errors are encountered during the BatchSuspendUser (p. 41),
BatchUnsuspendUser (p. 44), or BatchUpdateUser (p. 51) actions. This includes user IDs, error codes, and
error messages.

Contents
ErrorCode

The error code.

Type: String

Valid Values: BadRequest | Conflict | Forbidden | NotFound | PreconditionFailed

| ResourceLimitExceeded | ServiceFailure | AccessDenied |
ServiceUnavailable | Throttled | Throttling | Unauthorized | Unprocessable |
VoiceConnectorGroupAssociationsExist | PhoneNumberAssociationsExist

Required: No
ErrorMessage

The error message.

Type: String

Required: No
UserId

The user ID for which the action failed.

Type: String

Pattern: .*\S.*

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1214
 Amazon Chime SDK API Reference
UserSettings

UserSettings
Service: Amazon Chime

Settings associated with an Amazon Chime user, including inbound and outbound calling and text
messaging.

Contents
Telephony

The telephony settings associated with the user.

Type: TelephonySettings (p. 1204) object

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1215
 Amazon Chime SDK API Reference
VideoArtifactsConfiguration

VideoArtifactsConfiguration
Service: Amazon Chime

The video artifact configuration object.

Contents
MuxType

The MUX type of the video artifact configuration object.

Type: String

Valid Values: VideoOnly

Required: No
State

Indicates whether the video artifact is enabled or disabled.

Type: String

Valid Values: Enabled | Disabled

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1216
 Amazon Chime SDK API Reference
VoiceConnector

VoiceConnector
Service: Amazon Chime

The Amazon Chime Voice Connector configuration, including outbound host name and encryption
settings.

Contents
AwsRegion

The AWS Region in which the Amazon Chime Voice Connector is created. Default: us-east-1.

Type: String

Valid Values: us-east-1 | us-west-2

Required: No
CreatedTimestamp

The Amazon Chime Voice Connector creation timestamp, in ISO 8601 format.

Type: Timestamp

Required: No
Name

The name of the Amazon Chime Voice Connector.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: No
OutboundHostName

The outbound host name for the Amazon Chime Voice Connector.

Type: String

Required: No
RequireEncryption

Designates whether encryption is required for the Amazon Chime Voice Connector.

Type: Boolean

Required: No
UpdatedTimestamp

The updated Amazon Chime Voice Connector timestamp, in ISO 8601 format.

Type: Timestamp

Required: No
VoiceConnectorArn

The ARN of the specified Amazon Chime Voice Connector.

Type: String

1217
 Amazon Chime SDK API Reference
VoiceConnector

Pattern: .*\S.*

Required: No
VoiceConnectorId

The Amazon Chime Voice Connector ID.

Type: String

Pattern: .*\S.*

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1218
 Amazon Chime SDK API Reference
VoiceConnectorGroup

VoiceConnectorGroup
Service: Amazon Chime

The Amazon Chime Voice Connector group configuration, including associated Amazon Chime Voice
Connectors. 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.

Contents
CreatedTimestamp

The Amazon Chime Voice Connector group creation time stamp, in ISO 8601 format.

Type: Timestamp

Required: No
Name

The name of the Amazon Chime Voice Connector group.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: No
UpdatedTimestamp

The updated Amazon Chime Voice Connector group time stamp, in ISO 8601 format.

Type: Timestamp

Required: No
VoiceConnectorGroupArn

The ARN of the specified Amazon Chime Voice Connector group.

Type: String

Pattern: .*\S.*

Required: No
VoiceConnectorGroupId

The Amazon Chime Voice Connector group ID.

Type: String

Pattern: .*\S.*

Required: No
VoiceConnectorItems

The Amazon Chime Voice Connectors to which to route inbound calls.

Type: Array of VoiceConnectorItem (p. 1221) objects

Required: No

1219
 Amazon Chime SDK API Reference
VoiceConnectorGroup

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1220
 Amazon Chime SDK API Reference
VoiceConnectorItem

VoiceConnectorItem
Service: Amazon Chime

For Amazon Chime Voice Connector groups, the Amazon Chime Voice Connectors to which to route
inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per Amazon
Chime Voice Connector group.

Contents
Priority

The priority associated with the Amazon Chime Voice Connector, with 1 being the highest priority.
Higher priority Amazon Chime Voice Connectors are attempted first.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 99.

Required: Yes
VoiceConnectorId

The Amazon Chime Voice Connector ID.

Type: String

Pattern: .*\S.*

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1221
 Amazon Chime SDK API Reference
VoiceConnectorSettings

VoiceConnectorSettings
Service: Amazon Chime

The Amazon Chime Voice Connector settings. Includes any Amazon S3 buckets designated for storing
call detail records.

Contents
CdrBucket

The Amazon S3 bucket designated for call detail record storage.

Type: String

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

Amazon Chime SDK Identity

The following data types are supported by Amazon Chime SDK Identity:

• AppInstance (p. 1223)

• AppInstanceAdmin (p. 1225)
• AppInstanceAdminSummary (p. 1226)
• AppInstanceRetentionSettings (p. 1227)
• AppInstanceSummary (p. 1228)
• AppInstanceUser (p. 1229)
• AppInstanceUserEndpoint (p. 1231)
• AppInstanceUserEndpointSummary (p. 1234)
• AppInstanceUserSummary (p. 1236)
• ChannelRetentionSettings (p. 1237)
• EndpointAttributes (p. 1238)
• EndpointState (p. 1239)
• Identity (p. 1240)
• Tag (p. 1241)

1222
 Amazon Chime SDK API Reference
AppInstance

AppInstance
Service: Amazon Chime SDK Identity

The details of an AppInstance, an instance of an Amazon Chime SDK messaging application.

Contents
AppInstanceArn

The ARN of the messaging instance.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: No
CreatedTimestamp

The time at which an AppInstance was created. In epoch milliseconds.

Type: Timestamp

Required: No
LastUpdatedTimestamp

The time an AppInstance was last updated. In epoch milliseconds.

Type: Timestamp

Required: No
Metadata

The metadata of an AppInstance.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: .*

Required: No
Name

The name of an AppInstance.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD
\u10000-\u10FFFF]*

Required: No

1223
 Amazon Chime SDK API Reference
AppInstance

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1224
 Amazon Chime SDK API Reference
AppInstanceAdmin

AppInstanceAdmin
Service: Amazon Chime SDK Identity

The details of an AppInstanceAdmin.

Contents
Admin

The AppInstanceAdmin data.

Type: Identity (p. 1240) object

Required: No
AppInstanceArn

The ARN of the AppInstance for which the user is an administrator.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: No
CreatedTimestamp

The time at which an administrator was created.

Type: Timestamp

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1225
 Amazon Chime SDK API Reference
AppInstanceAdminSummary

AppInstanceAdminSummary
Service: Amazon Chime SDK Identity

Summary of the details of an AppInstanceAdmin.

Contents
Admin

The details of the AppInstanceAdmin.

Type: Identity (p. 1240) object

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1226
 Amazon Chime SDK API Reference
AppInstanceRetentionSettings

AppInstanceRetentionSettings
Service: Amazon Chime SDK Identity

The details of the data-retention settings for an AppInstance.

Contents
ChannelRetentionSettings

The length of time in days to retain the messages in a channel.

Type: ChannelRetentionSettings (p. 1237) object

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1227
 Amazon Chime SDK API Reference
AppInstanceSummary

AppInstanceSummary
Service: Amazon Chime SDK Identity

Summary of the data for an AppInstance.

Contents
AppInstanceArn

The AppInstance ARN.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: No
Metadata

The metadata of the AppInstance.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: .*

Required: No
Name

The name of the AppInstance.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD
\u10000-\u10FFFF]*

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1228
 Amazon Chime SDK API Reference
AppInstanceUser

AppInstanceUser
Service: Amazon Chime SDK Identity

The details of an AppInstanceUser.

Contents
AppInstanceUserArn

The ARN of the AppInstanceUser.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: No
CreatedTimestamp

The time at which the AppInstanceUser was created.

Type: Timestamp

Required: No
LastUpdatedTimestamp

The time at which the AppInstanceUser was last updated.

Type: Timestamp

Required: No
Metadata

The metadata of the AppInstanceUser.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: .*

Required: No
Name

The name of the AppInstanceUser.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: .*\S.*

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

1229
 Amazon Chime SDK API Reference
AppInstanceUser

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1230
 Amazon Chime SDK API Reference
AppInstanceUserEndpoint

AppInstanceUserEndpoint
Service: Amazon Chime SDK Identity

An endpoint under an Amazon Chime AppInstanceUser that receives messages for a user. For push
notifications, the endpoint is a mobile device used to receive mobile push notifications for a user.

Contents
AllowMessages

Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages.

ALL indicates the endpoint will receive all messages. NONE indicates the endpoint will receive no
messages.

Type: String

Valid Values: ALL | NONE

Required: No
AppInstanceUserArn

The ARN of the AppInstanceUser.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: No
CreatedTimestamp

The time at which an AppInstanceUserEndpoint was created.

Type: Timestamp

Required: No
EndpointAttributes

The attributes of an Endpoint.

Type: EndpointAttributes (p. 1238) object

Required: No
EndpointId

The unique identifier of the AppInstanceUserEndpoint.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 64.

Pattern: .*

Required: No
EndpointState

A read-only field that represents the state of an AppInstanceUserEndpoint. Supported values:

1231
 Amazon Chime SDK API Reference
AppInstanceUserEndpoint

• ACTIVE: The AppInstanceUserEndpoint is active and able to receive messages. When ACTIVE,
the EndpointStatusReason remains empty.
• INACTIVE: The AppInstanceUserEndpoint is inactive and can't receive message. When
INACTIVE, the corresponding reason will be conveyed through EndpointStatusReason.
• INVALID_DEVICE_TOKEN indicates that an AppInstanceUserEndpoint is INACTIVE due to
invalid device token
• INVALID_PINPOINT_ARN indicates that an AppInstanceUserEndpoint is INACTIVE due to an
invalid pinpoint ARN that was input through the ResourceArn field.

Type: EndpointState (p. 1239) object

Required: No
LastUpdatedTimestamp

The time at which an AppInstanceUserEndpoint was last updated.

Type: Timestamp

Required: No
Name

The name of the AppInstanceUserEndpoint.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1600.

Pattern: .*

Required: No
ResourceArn

The ARN of the resource to which the endpoint belongs.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: No
Type

The type of the AppInstanceUserEndpoint.

Type: String

Valid Values: APNS | APNS_SANDBOX | GCM

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

1232
 Amazon Chime SDK API Reference
AppInstanceUserEndpoint

• AWS SDK for Go

• AWS SDK for Java V2
• AWS SDK for Ruby V3

1233
 Amazon Chime SDK API Reference
AppInstanceUserEndpointSummary

AppInstanceUserEndpointSummary
Service: Amazon Chime SDK Identity

Summary of the details of an AppInstanceUserEndpoint.

Contents
AllowMessages

BBoolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages.

ALL indicates the endpoint will receive all messages. NONE indicates the endpoint will receive no
messages.

Type: String

Valid Values: ALL | NONE

Required: No
AppInstanceUserArn

The ARN of the AppInstanceUser.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: No
EndpointId

The unique identifier of the AppInstanceUserEndpoint.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 64.

Pattern: .*

Required: No
EndpointState

A read-only field that represent the state of an AppInstanceUserEndpoint.

Type: EndpointState (p. 1239) object

Required: No
Name

The name of the AppInstanceUserEndpoint.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1600.

Pattern: .*

Required: No

1234
 Amazon Chime SDK API Reference
AppInstanceUserEndpointSummary

Type

The type of the AppInstanceUserEndpoint.

Type: String

Valid Values: APNS | APNS_SANDBOX | GCM

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1235
 Amazon Chime SDK API Reference
AppInstanceUserSummary

AppInstanceUserSummary
Service: Amazon Chime SDK Identity

Summary of the details of an AppInstanceUser.

Contents
AppInstanceUserArn

The ARN of the AppInstanceUser.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: No
Metadata

The metadata of the AppInstanceUser.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: .*

Required: No
Name

The name of an AppInstanceUser.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: .*\S.*

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1236
 Amazon Chime SDK API Reference
ChannelRetentionSettings

ChannelRetentionSettings
Service: Amazon Chime SDK Identity

The details of the retention settings for a channel.

Contents
RetentionDays

The time in days to retain the messages in a channel.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 5475.

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1237
 Amazon Chime SDK API Reference
EndpointAttributes

EndpointAttributes
Service: Amazon Chime SDK Identity

The attributes of an Endpoint.

Contents
DeviceToken

The device token for the GCM, APNS, and APNS_SANDBOX endpoint types.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: .*

Required: Yes
VoipDeviceToken

The VOIP device token for the APNS and APNS_SANDBOX endpoint types.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: .*

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1238
 Amazon Chime SDK API Reference
EndpointState

EndpointState
Service: Amazon Chime SDK Identity

A read-only field that represents the state of an AppInstanceUserEndpoint. Supported values:

• ACTIVE: The AppInstanceUserEndpoint is active and able to receive messages. When ACTIVE, the
EndpointStatusReason remains empty.
• INACTIVE: The AppInstanceUserEndpoint is inactive and can't receive message. When INACTIVE,
the corresponding reason will be conveyed through EndpointStatusReason.
• INVALID_DEVICE_TOKEN indicates that an AppInstanceUserEndpoint is INACTIVE due to invalid
device token
• INVALID_PINPOINT_ARN indicates that an AppInstanceUserEndpoint is INACTIVE due to an
invalid pinpoint ARN that was input through the ResourceArn field.

Contents
Status

Enum that indicates the Status of an AppInstanceUserEndpoint.

Type: String

Valid Values: ACTIVE | INACTIVE

Required: Yes
StatusReason

The reason for the EndpointStatus.

Type: String

Valid Values: INVALID_DEVICE_TOKEN | INVALID_PINPOINT_ARN

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1239
 Amazon Chime SDK API Reference
Identity

Identity
Service: Amazon Chime SDK Identity

The details of a user.

Contents
Arn

The ARN in an Identity.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: No
Name

The name in an Identity.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD
\u10000-\u10FFFF]*

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1240
 Amazon Chime SDK API Reference
Tag

Tag
Service: Amazon Chime SDK Identity

A tag object containing a key-value pair.

Contents
Key

The key in a tag.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: Yes
Value

The value in a tag.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

Amazon Chime SDK Media Pipelines

The following data types are supported by Amazon Chime SDK Media Pipelines:

• ArtifactsConcatenationConfiguration (p. 1243)

• ArtifactsConfiguration (p. 1245)
• AudioArtifactsConfiguration (p. 1246)
• AudioConcatenationConfiguration (p. 1247)
• ChimeSdkMeetingConcatenationConfiguration (p. 1248)
• ChimeSdkMeetingConfiguration (p. 1249)
• ChimeSdkMeetingLiveConnectorConfiguration (p. 1250)
• CompositedVideoArtifactsConfiguration (p. 1251)
• CompositedVideoConcatenationConfiguration (p. 1252)
• ConcatenationSink (p. 1253)
• ConcatenationSource (p. 1254)
• ContentArtifactsConfiguration (p. 1255)

1241
 Amazon Chime SDK API Reference
Amazon Chime SDK Media Pipelines

• ContentConcatenationConfiguration (p. 1256)

• DataChannelConcatenationConfiguration (p. 1257)
• GridViewConfiguration (p. 1258)
• LiveConnectorRTMPConfiguration (p. 1259)
• LiveConnectorSinkConfiguration (p. 1260)
• LiveConnectorSourceConfiguration (p. 1261)
• MediaCapturePipeline (p. 1262)
• MediaCapturePipelineSourceConfiguration (p. 1264)
• MediaCapturePipelineSummary (p. 1265)
• MediaConcatenationPipeline (p. 1266)
• MediaLiveConnectorPipeline (p. 1268)
• MediaPipeline (p. 1270)
• MediaPipelineSummary (p. 1271)
• MeetingEventsConcatenationConfiguration (p. 1272)
• PresenterOnlyConfiguration (p. 1273)
• S3BucketSinkConfiguration (p. 1274)
• SelectedVideoStreams (p. 1275)
• SourceConfiguration (p. 1276)
• Tag (p. 1277)
• TranscriptionMessagesConcatenationConfiguration (p. 1278)
• VideoArtifactsConfiguration (p. 1279)
• VideoConcatenationConfiguration (p. 1280)

1242
 Amazon Chime SDK API Reference
ArtifactsConcatenationConfiguration

ArtifactsConcatenationConfiguration
Service: Amazon Chime SDK Media Pipelines

The configuration for the artifacts concatenation.

Contents
Audio

The configuration for the audio artifacts concatenation.

Type: AudioConcatenationConfiguration (p. 1247) object

Required: Yes
CompositedVideo

The configuration for the composited video artifacts concatenation.

Type: CompositedVideoConcatenationConfiguration (p. 1252) object

Required: Yes
Content

The configuration for the content artifacts concatenation.

Type: ContentConcatenationConfiguration (p. 1256) object

Required: Yes
DataChannel

The configuration for the data channel artifacts concatenation.

Type: DataChannelConcatenationConfiguration (p. 1257) object

Required: Yes
MeetingEvents

The configuration for the meeting events artifacts concatenation.

Type: MeetingEventsConcatenationConfiguration (p. 1272) object

Required: Yes
TranscriptionMessages

The configuration for the transcription messages artifacts concatenation.

Type: TranscriptionMessagesConcatenationConfiguration (p. 1278) object

Required: Yes
Video

The configuration for the video artifacts concatenation.

Type: VideoConcatenationConfiguration (p. 1280) object

Required: Yes

1243
 Amazon Chime SDK API Reference
ArtifactsConcatenationConfiguration

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1244
 Amazon Chime SDK API Reference
ArtifactsConfiguration

ArtifactsConfiguration
Service: Amazon Chime SDK Media Pipelines

The configuration for the artifacts.

Contents
Audio

The configuration for the audio artifacts.

Type: AudioArtifactsConfiguration (p. 1246) object

Required: Yes
CompositedVideo

Enables video compositing.

Type: CompositedVideoArtifactsConfiguration (p. 1251) object

Required: No
Content

The configuration for the content artifacts.

Type: ContentArtifactsConfiguration (p. 1255) object

Required: Yes
Video

The configuration for the video artifacts.

Type: VideoArtifactsConfiguration (p. 1279) object

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1245
 Amazon Chime SDK API Reference
AudioArtifactsConfiguration

AudioArtifactsConfiguration
Service: Amazon Chime SDK Media Pipelines

The audio artifact configuration object.

Contents
MuxType

The MUX type of the audio artifact configuration object.

Type: String

Valid Values: AudioOnly | AudioWithActiveSpeakerVideo |

AudioWithCompositedVideo

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1246
 Amazon Chime SDK API Reference
AudioConcatenationConfiguration

AudioConcatenationConfiguration
Service: Amazon Chime SDK Media Pipelines

The audio artifact concatenation configuration object.

Contents
State

Enables or disables the configuration object.

Type: String

Valid Values: Enabled

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1247
 Amazon Chime SDK API Reference
ChimeSdkMeetingConcatenationConfiguration

ChimeSdkMeetingConcatenationConfiguration
Service: Amazon Chime SDK Media Pipelines

The configuration object of the Amazon Chime SDK meeting concatenation for a specified media
pipeline.

Contents
ArtifactsConfiguration

The configuration for the artifacts in an Amazon Chime SDK meeting concatenation.

Type: ArtifactsConcatenationConfiguration (p. 1243) object

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1248
 Amazon Chime SDK API Reference
ChimeSdkMeetingConfiguration

ChimeSdkMeetingConfiguration
Service: Amazon Chime SDK Media Pipelines

The configuration object of the Amazon Chime SDK meeting for a specified media pipeline. SourceType
must be ChimeSdkMeeting.

Contents
ArtifactsConfiguration

The configuration for the artifacts in an Amazon Chime SDK meeting.

Type: ArtifactsConfiguration (p. 1245) object

Required: No
SourceConfiguration

The source configuration for a specified media pipline.

Type: SourceConfiguration (p. 1276) object

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1249
 Amazon Chime SDK API Reference
ChimeSdkMeetingLiveConnectorConfiguration

ChimeSdkMeetingLiveConnectorConfiguration
Service: Amazon Chime SDK Media Pipelines

The media pipeline's configuration object.

Contents
Arn

The configuration object's Chime SDK meeting ARN.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^arn[\/\:\-\_\.a-zA-Z0-9]+$

Required: Yes
CompositedVideo

The media pipeline's composited video.

Type: CompositedVideoArtifactsConfiguration (p. 1251) object

Required: No
MuxType

The configuration object's multiplex type.

Type: String

Valid Values: AudioWithCompositedVideo | AudioWithActiveSpeakerVideo

Required: Yes
SourceConfiguration

The source configuration settings of the media pipeline's configuration object.

Type: SourceConfiguration (p. 1276) object

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1250
 Amazon Chime SDK API Reference
CompositedVideoArtifactsConfiguration

CompositedVideoArtifactsConfiguration
Service: Amazon Chime SDK Media Pipelines

Describes the configuration for the composited video artifacts.

Contents
GridViewConfiguration

The GridView configuration setting.

Type: GridViewConfiguration (p. 1258) object

Required: Yes
Layout

The layout setting, such as GridView in the configuration object.

Type: String

Valid Values: GridView

Required: No
Resolution

The video resolution setting in the configuration object. Default: HD at 1280 x 720. FHD resolution:
1920 x 1080.

Type: String

Valid Values: HD | FHD

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1251
 Amazon Chime SDK API Reference
CompositedVideoConcatenationConfiguration

CompositedVideoConcatenationConfiguration
Service: Amazon Chime SDK Media Pipelines

The composited video configuration object for a specified media pipeline. SourceType must be
ChimeSdkMeeting.

Contents
State

Enables or disables the configuration object.

Type: String

Valid Values: Enabled | Disabled

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1252
 Amazon Chime SDK API Reference
ConcatenationSink

ConcatenationSink
Service: Amazon Chime SDK Media Pipelines

The data sink of the configuration object.

Contents
S3BucketSinkConfiguration

The configuration settings for an Amazon S3 bucket sink.

Type: S3BucketSinkConfiguration (p. 1274) object

Required: Yes
Type

The type of data sink in the configuration object.

Type: String

Valid Values: S3Bucket

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1253
 Amazon Chime SDK API Reference
ConcatenationSource

ConcatenationSource
Service: Amazon Chime SDK Media Pipelines

The source type and media pipeline configuration settings in a configuration object.

Contents
MediaCapturePipelineSourceConfiguration

The concatenation settings for the media pipeline in a configuration object.

Type: MediaCapturePipelineSourceConfiguration (p. 1264) object

Required: Yes
Type

The type of concatenation source in a configuration object.

Type: String

Valid Values: MediaCapturePipeline

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1254
 Amazon Chime SDK API Reference
ContentArtifactsConfiguration

ContentArtifactsConfiguration
Service: Amazon Chime SDK Media Pipelines

The content artifact object.

Contents
MuxType

The MUX type of the artifact configuration.

Type: String

Valid Values: ContentOnly

Required: No
State

Indicates whether the content artifact is enabled or disabled.

Type: String

Valid Values: Enabled | Disabled

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1255
 Amazon Chime SDK API Reference
ContentConcatenationConfiguration

ContentConcatenationConfiguration
Service: Amazon Chime SDK Media Pipelines

The composited content configuration object for a specified media pipeline.

Contents
State

Enables or disables the configuration object.

Type: String

Valid Values: Enabled | Disabled

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1256
 Amazon Chime SDK API Reference
DataChannelConcatenationConfiguration

DataChannelConcatenationConfiguration
Service: Amazon Chime SDK Media Pipelines

The content configuration object's data channel.

Contents
State

Enables or disables the configuration object.

Type: String

Valid Values: Enabled | Disabled

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1257
 Amazon Chime SDK API Reference
GridViewConfiguration

GridViewConfiguration
Service: Amazon Chime SDK Media Pipelines

Specifies the type of grid layout.

Contents
ContentShareLayout

Defines the layout of the video tiles when content sharing is enabled.

Type: String

Valid Values: PresenterOnly | Horizontal | Vertical

Required: Yes
PresenterOnlyConfiguration

Defines the configuration options for a presenter only video tile.

Type: PresenterOnlyConfiguration (p. 1273) object

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1258
 Amazon Chime SDK API Reference
LiveConnectorRTMPConfiguration

LiveConnectorRTMPConfiguration
Service: Amazon Chime SDK Media Pipelines

The media pipeline's RTMP configuration object.

Contents
AudioChannels

The audio channels set for the RTMP configuration

Type: String

Valid Values: Stereo | Mono

Required: No
AudioSampleRate

The audio sample rate set for the RTMP configuration. Default: 48000.

Type: String

Pattern: 44100|48000

Required: No
Url

The URL of the RTMP configuration.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1259
 Amazon Chime SDK API Reference
LiveConnectorSinkConfiguration

LiveConnectorSinkConfiguration
Service: Amazon Chime SDK Media Pipelines

The media pipeline's sink configuration settings.

Contents
RTMPConfiguration

The sink configuration's RTMP configuration setttings.

Type: LiveConnectorRTMPConfiguration (p. 1259) object

Required: Yes
SinkType

The sink configuration's sink type.

Type: String

Valid Values: RTMP

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1260
 Amazon Chime SDK API Reference
LiveConnectorSourceConfiguration

LiveConnectorSourceConfiguration
Service: Amazon Chime SDK Media Pipelines

The data source configuration object of a streaming media pipeline.

Contents
ChimeSdkMeetingLiveConnectorConfiguration

The configuration settings of the connector pipeline.

Type: ChimeSdkMeetingLiveConnectorConfiguration (p. 1250) object

Required: Yes
SourceType

The source configuration's media source type.

Type: String

Valid Values: ChimeSdkMeeting

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1261
 Amazon Chime SDK API Reference
MediaCapturePipeline

MediaCapturePipeline
Service: Amazon Chime SDK Media Pipelines

A media pipeline object consisting of an ID, source type, source ARN, a sink type, a sink ARN, and a
configuration object.

Contents
ChimeSdkMeetingConfiguration

The configuration for a specified media pipeline. SourceType must be ChimeSdkMeeting.

Type: ChimeSdkMeetingConfiguration (p. 1249) object

Required: No
CreatedTimestamp

The time at which the pipeline was created, in ISO 8601 format.

Type: Timestamp

Required: No
MediaPipelineArn

The ARN of the media capture pipeline

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1011.

Pattern: ^arn[\/\:\-\_\.a-zA-Z0-9]+$

Required: No
MediaPipelineId

The ID of a media pipeline.

Type: String

Length Constraints: Fixed length of 36.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: No
SinkArn

ARN of the destination to which the media artifacts are saved.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^arn[\/\:\-\_\.a-zA-Z0-9]+$

Required: No
SinkType

Destination type to which the media artifacts are saved. You must use an S3 Bucket.

1262
 Amazon Chime SDK API Reference
MediaCapturePipeline

Type: String

Valid Values: S3Bucket

Required: No
SourceArn

ARN of the source from which the media artifacts are saved.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^arn[\/\:\-\_\.a-zA-Z0-9]+$

Required: No
SourceType

Source type from which media artifacts are saved. You must use ChimeMeeting.

Type: String

Valid Values: ChimeSdkMeeting

Required: No
Status

The status of the media pipeline.

Type: String

Valid Values: Initializing | InProgress | Failed | Stopping | Stopped

Required: No
UpdatedTimestamp

The time at which the pipeline was updated, in ISO 8601 format.

Type: Timestamp

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1263
 Amazon Chime SDK API Reference
MediaCapturePipelineSourceConfiguration

MediaCapturePipelineSourceConfiguration
Service: Amazon Chime SDK Media Pipelines

The source configuration object of a media capture pipeline.

Contents
ChimeSdkMeetingConfiguration

The meeting configuration settings in a media capture pipeline configuration object.

Type: ChimeSdkMeetingConcatenationConfiguration (p. 1248) object

Required: Yes
MediaPipelineArn

The media pipeline ARN in the configuration object of a media capture pipeline.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^arn[\/\:\-\_\.a-zA-Z0-9]+$

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1264
 Amazon Chime SDK API Reference
MediaCapturePipelineSummary

MediaCapturePipelineSummary
Service: Amazon Chime SDK Media Pipelines

The summary data of a media capture pipeline.

Contents
MediaPipelineArn

The ARN of the media pipeline in the summary.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1011.

Pattern: ^arn[\/\:\-\_\.a-zA-Z0-9]+$

Required: No
MediaPipelineId

The ID of the media pipeline in the summary.

Type: String

Length Constraints: Fixed length of 36.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1265
 Amazon Chime SDK API Reference
MediaConcatenationPipeline

MediaConcatenationPipeline
Service: Amazon Chime SDK Media Pipelines

Concatenates audio and video data from one or more data streams.

Contents
CreatedTimestamp

The time at which the concatenation pipeline was created.

Type: Timestamp

Required: No
MediaPipelineArn

The ARN of the media pipeline that you specify in the SourceConfiguration object.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1011.

Pattern: ^arn[\/\:\-\_\.a-zA-Z0-9]+$

Required: No
MediaPipelineId

The ID of the media pipeline being concatenated.

Type: String

Length Constraints: Fixed length of 36.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: No
Sinks

The data sinks of the concatenation pipeline.

Type: Array of ConcatenationSink (p. 1253) objects

Array Members: Fixed number of 1 item.

Required: No
Sources

The data sources being concatnated.

Type: Array of ConcatenationSource (p. 1254) objects

Array Members: Fixed number of 1 item.

Required: No
Status

The status of the concatenation pipeline.

Type: String

1266
 Amazon Chime SDK API Reference
MediaConcatenationPipeline

Valid Values: Initializing | InProgress | Failed | Stopping | Stopped

Required: No
UpdatedTimestamp

The time at which the concatenation pipeline was last updated.

Type: Timestamp

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1267
 Amazon Chime SDK API Reference
MediaLiveConnectorPipeline

MediaLiveConnectorPipeline
Service: Amazon Chime SDK Media Pipelines

The connector pipeline.

Contents
CreatedTimestamp

Thetime at which the connector pipeline was created.

Type: Timestamp

Required: No
MediaPipelineArn

The connector pipeline's ARN.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1011.

Pattern: ^arn[\/\:\-\_\.a-zA-Z0-9]+$

Required: No
MediaPipelineId

The connector pipeline's ID.

Type: String

Length Constraints: Fixed length of 36.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: No
Sinks

The connector pipeline's data sinks.

Type: Array of LiveConnectorSinkConfiguration (p. 1260) objects

Array Members: Fixed number of 1 item.

Required: No
Sources

The connector pipeline's data sources.

Type: Array of LiveConnectorSourceConfiguration (p. 1261) objects

Array Members: Fixed number of 1 item.

Required: No
Status

The connector pipeline's status.

Type: String

1268
 Amazon Chime SDK API Reference
MediaLiveConnectorPipeline

Valid Values: Initializing | InProgress | Failed | Stopping | Stopped

Required: No
UpdatedTimestamp

The time at which the connector pipeline was last updated.

Type: Timestamp

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1269
 Amazon Chime SDK API Reference
MediaPipeline

MediaPipeline
Service: Amazon Chime SDK Media Pipelines

A pipeline consisting of a media capture, media concatenation, or live-streaming pipeline.

Contents
MediaCapturePipeline

A pipeline that enables users to capture audio and video.

Type: MediaCapturePipeline (p. 1262) object

Required: No
MediaConcatenationPipeline

The media concatenation pipeline in a media pipeline.

Type: MediaConcatenationPipeline (p. 1266) object

Required: No
MediaLiveConnectorPipeline

The connector pipeline of the media pipeline.

Type: MediaLiveConnectorPipeline (p. 1268) object

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1270
 Amazon Chime SDK API Reference
MediaPipelineSummary

MediaPipelineSummary
Service: Amazon Chime SDK Media Pipelines

The summary of the media pipeline.

Contents
MediaPipelineArn

The ARN of the media pipeline in the summary.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1011.

Pattern: ^arn[\/\:\-\_\.a-zA-Z0-9]+$

Required: No
MediaPipelineId

The ID of the media pipeline in the summary.

Type: String

Length Constraints: Fixed length of 36.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1271
 Amazon Chime SDK API Reference
MeetingEventsConcatenationConfiguration

MeetingEventsConcatenationConfiguration
Service: Amazon Chime SDK Media Pipelines

The configuration object for an event concatenation pipeline.

Contents
State

Enables or disables the configuration object.

Type: String

Valid Values: Enabled | Disabled

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1272
 Amazon Chime SDK API Reference
PresenterOnlyConfiguration

PresenterOnlyConfiguration
Service: Amazon Chime SDK Media Pipelines

Defines the configuration for a presenter only video tile.

Contents
PresenterPosition

Defines the position of the presenter video tile. Default: TopRight.

Type: String

Valid Values: TopLeft | TopRight | BottomLeft | BottomRight

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1273
 Amazon Chime SDK API Reference
S3BucketSinkConfiguration

S3BucketSinkConfiguration
Service: Amazon Chime SDK Media Pipelines

The configuration settings for the S3 bucket.

Contents
Destination

The destination URL of the S3 bucket.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^arn[\/\:\-\_\.a-zA-Z0-9]+$

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1274
 Amazon Chime SDK API Reference
SelectedVideoStreams

SelectedVideoStreams
Service: Amazon Chime SDK Media Pipelines

The video streams for a specified media pipeline. The total number of video streams can't exceed 25.

Contents
AttendeeIds

The attendee IDs of the streams selected for a media pipeline.

Type: Array of strings

Array Members: Minimum number of 1 item.

Length Constraints: Fixed length of 36.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: No
ExternalUserIds

The external user IDs of the streams selected for a media pipeline.

Type: Array of strings

Array Members: Minimum number of 1 item.

Length Constraints: Minimum length of 2. Maximum length of 64.

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1275
 Amazon Chime SDK API Reference
SourceConfiguration

SourceConfiguration
Service: Amazon Chime SDK Media Pipelines

Source configuration for a specified media pipeline.

Contents
SelectedVideoStreams

The selected video streams for a specified media pipeline. The number of video streams can't exceed
25.

Type: SelectedVideoStreams (p. 1275) object

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1276
 Amazon Chime SDK API Reference
Tag

Tag
Service: Amazon Chime SDK Media Pipelines

A key/value pair that grants users access to meeting resources.

Contents
Key

The key half of a tag.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: Yes
Value

The value half of a tag.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1277
 Amazon Chime SDK API Reference
TranscriptionMessagesConcatenationConfiguration

TranscriptionMessagesConcatenationConfiguration
Service: Amazon Chime SDK Media Pipelines

The configuration object for concatenating transcription messages.

Contents
State

Enables or disables the configuration object.

Type: String

Valid Values: Enabled | Disabled

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1278
 Amazon Chime SDK API Reference
VideoArtifactsConfiguration

VideoArtifactsConfiguration
Service: Amazon Chime SDK Media Pipelines

The video artifact configuration object.

Contents
MuxType

The MUX type of the video artifact configuration object.

Type: String

Valid Values: VideoOnly

Required: No
State

Indicates whether the video artifact is enabled or disabled.

Type: String

Valid Values: Enabled | Disabled

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1279
 Amazon Chime SDK API Reference
VideoConcatenationConfiguration

VideoConcatenationConfiguration
Service: Amazon Chime SDK Media Pipelines

The configuration object of a video contacatentation pipeline.

Contents
State

Enables or disables the configuration object.

Type: String

Valid Values: Enabled | Disabled

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

Amazon Chime SDK Meetings

The following data types are supported by Amazon Chime SDK Meetings:

• Attendee (p. 1281)

• AttendeeCapabilities (p. 1283)
• AttendeeIdItem (p. 1285)
• AudioFeatures (p. 1286)
• CreateAttendeeError (p. 1287)
• CreateAttendeeRequestItem (p. 1288)
• EngineTranscribeMedicalSettings (p. 1289)
• EngineTranscribeSettings (p. 1291)
• MediaPlacement (p. 1294)
• Meeting (p. 1296)
• MeetingFeaturesConfiguration (p. 1298)
• NotificationsConfiguration (p. 1299)
• Tag (p. 1300)
• TranscriptionConfiguration (p. 1301)

1280
 Amazon Chime SDK API Reference
Attendee

Attendee
Service: Amazon Chime SDK Meetings

An Amazon Chime SDK meeting attendee. Includes a unique AttendeeId and JoinToken. The
JoinToken allows a client to authenticate and join as the specified attendee. The JoinToken expires
when the meeting ends, or when DeleteAttendee (p. 713) is called. After that, the attendee is unable to
join the meeting.

We recommend securely transferring each JoinToken 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.

Contents
AttendeeId

The Amazon Chime SDK attendee ID.

Type: String

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: No
Capabilities

The capabilities assigned to an attendee: audio, video, or content.

Note
You use the capabilities with a set of values that control what the capabilities can
do, such as SendReceive data. For more information about those values, see
AttendeeCapabilities (p. 1283).

When using capabilities, be aware of these corner cases:

• You can't set content capabilities to SendReceive or Receive unless you also set video
capabilities to SendReceive or Receive. If you don't set the video capability to receive, the
response will contain an HTTP 400 Bad Request status code. However, you can set your video
capability to receive and you set your content capability to not receive.
• When you change an audio capability from None or Receive to Send or SendReceive , and
if the attendee left their microphone unmuted, audio will flow from the attendee to the other
meeting participants.
• When you change a video or content capability from None or Receive to Send or
SendReceive , and if the attendee turned on their video or content streams, remote attendess
can receive those streams, but only after media renegotiation between the client and the Amazon
Chime back-end server.

Type: AttendeeCapabilities (p. 1283) object

Required: No
ExternalUserId

The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity
managed by a builder application.

Pattern: [-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*

Values that begin with aws: are reserved. You can't configure a value that uses this prefix. Case
insensitive.

Type: String

1281
 Amazon Chime SDK API Reference
Attendee

Length Constraints: Minimum length of 2. Maximum length of 64.

Required: No
JoinToken

The join token used by the Amazon Chime SDK attendee.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 2048.

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1282
 Amazon Chime SDK API Reference
AttendeeCapabilities

AttendeeCapabilities
Service: Amazon Chime SDK Meetings

The media capabilities of an attendee: audio, video, or content.

Note
You use the capabilities with a set of values that control what the capabilities can
do, such as SendReceive data. For more information about those values, see
AttendeeCapabilities (p. 1283).

When using capabilities, be aware of these corner cases:

• You can't set content capabilities to SendReceive or Receive unless you also set video
capabilities to SendReceive or Receive. If you don't set the video capability to receive, the
response will contain an HTTP 400 Bad Request status code. However, you can set your video
capability to receive and you set your content capability to not receive.
• When you change an audio capability from None or Receive to Send or SendReceive , and if the
attendee left their microphone unmuted, audio will flow from the attendee to the other meeting
participants.
• When you change a video or content capability from None or Receive to Send or SendReceive
, and if the attendee turned on their video or content streams, remote attendess can receive those
streams, but only after media renegotiation between the client and the Amazon Chime back-end
server.

Contents
Audio

The audio capability assigned to an attendee.

Type: String

Valid Values: SendReceive | Send | Receive | None

Required: Yes
Content

The content capability assigned to an attendee.

Type: String

Valid Values: SendReceive | Send | Receive | None

Required: Yes
Video

The video capability assigned to an attendee.

Type: String

Valid Values: SendReceive | Send | Receive | None

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

1283
 Amazon Chime SDK API Reference
AttendeeCapabilities

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1284
 Amazon Chime SDK API Reference
AttendeeIdItem

AttendeeIdItem
Service: Amazon Chime SDK Meetings

A structure that contains one or more attendee IDs.

Contents
AttendeeId

A list of one or more attendee IDs.

Type: String

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1285
 Amazon Chime SDK API Reference
AudioFeatures

AudioFeatures
Service: Amazon Chime SDK Meetings

An optional category of meeting features that contains audio-specific configurations, such as operating
parameters for Amazon Voice Focus.

Contents
EchoReduction

Makes echo reduction available to clients who connect to the meeting.

Type: String

Valid Values: AVAILABLE | UNAVAILABLE

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1286
 Amazon Chime SDK API Reference
CreateAttendeeError

CreateAttendeeError
Service: Amazon Chime SDK Meetings

The list of errors returned when errors are encountered during the BatchCreateAttendee and
CreateAttendee actions. This includes external user IDs, error codes, and error messages.

Contents
ErrorCode

The error code.

Type: String

Length Constraints: Maximum length of 4096.

Required: No
ErrorMessage

The error message.

Type: String

Length Constraints: Maximum length of 4096.

Required: No
ExternalUserId

The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity
managed by a builder application.

Pattern: [-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*

Values that begin with aws: are reserved. You can't configure a value that uses this prefix. Case
insensitive.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1287
 Amazon Chime SDK API Reference
CreateAttendeeRequestItem

CreateAttendeeRequestItem
Service: Amazon Chime SDK Meetings

The Amazon Chime SDK attendee fields to create, used with the BatchCreateAttendee action.

Contents
Capabilities

A list of one or more capabilities.

Type: AttendeeCapabilities (p. 1283) object

Required: No
ExternalUserId

The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity
managed by a builder application.

Pattern: [-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*

Values that begin with aws: are reserved. You can't configure a value that uses this prefix. Case
insensitive.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1288
 Amazon Chime SDK API Reference
EngineTranscribeMedicalSettings

EngineTranscribeMedicalSettings
Service: Amazon Chime SDK Meetings

Settings specific to the Amazon Transcribe Medical engine.

Contents
ContentIdentificationType

Set this field to PHI to identify personal health information in the transcription output.

Type: String

Valid Values: PHI

Required: No
LanguageCode

The language code specified for the Amazon Transcribe Medical engine.

Type: String

Valid Values: en-US

Required: Yes
Region

The AWS Region passed to Amazon Transcribe Medical. If you don't specify a Region, Amazon Chime
uses the meeting's Region.

Type: String

Valid Values: us-east-1 | us-east-2 | us-west-2 | ap-southeast-2 | ca-central-1

| eu-west-1 | auto

Required: No
Specialty

The specialty specified for the Amazon Transcribe Medical engine.

Type: String

Valid Values: PRIMARYCARE | CARDIOLOGY | NEUROLOGY | ONCOLOGY | RADIOLOGY |

UROLOGY

Required: Yes
Type

The type of transcription.

Type: String

Valid Values: CONVERSATION | DICTATION

Required: Yes
VocabularyName

The name of the vocabulary passed to Amazon Transcribe Medical.

1289
 Amazon Chime SDK API Reference
EngineTranscribeMedicalSettings

Type: String

Length Constraints: Maximum length of 4096.

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1290
 Amazon Chime SDK API Reference
EngineTranscribeSettings

EngineTranscribeSettings
Service: Amazon Chime SDK Meetings

Settings specific to the Amazon Transcribe engine.

Contents
ContentIdentificationType

Set this field to PII to identify personally identifiable information in the transcription output.

Type: String

Valid Values: PII

Required: No
ContentRedactionType

Set this field to PII to redact personally identifiable information in the transcription output.
Content redaction is performed only upon complete transcription of the audio segments.

You can’t set ContentRedactionType and ContentIdentificationType in the same request. If

you set both, your request returns a BadRequestException.

Type: String

Valid Values: PII

Required: No
EnablePartialResultsStabilization

Generates partial transcription results that are less likely to change as meeting attendees speak. It
does so by only allowing the last few words from the partial results to change.

Type: Boolean

Required: No
IdentifyLanguage

Automatically identifies the language spoken in media files.

Type: Boolean

Required: No
LanguageCode

The language code specified for the Amazon Transcribe engine.

Type: String

Valid Values: en-US | en-GB | es-US | fr-CA | fr-FR | en-AU | it-IT | de-DE |
pt-BR | ja-JP | ko-KR | zh-CN

Required: No
LanguageModelName

The name of the language model used during transcription.

Type: String

1291
 Amazon Chime SDK API Reference
EngineTranscribeSettings

Length Constraints: Minimum length of 1. Maximum length of 200.

Pattern: ^[0-9a-zA-Z._-]+

Required: No
LanguageOptions

Language codes for the languages that you want to identify. You must provide at least 2 codes.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Pattern: ^[a-zA-Z-,]+

Required: No
PartialResultsStability

The stabity level of a partial results transcription. Determines how stable you want the transcription
results to be. A higher level means the transcription results are less likely to change.

Type: String

Valid Values: low | medium | high

Required: No
PiiEntityTypes

Lists the PII entity types you want to identify or redact. To specify entity types, you must enable
ContentIdentificationType or ContentRedactionType.

PIIEntityTypes must be comma-separated. The available values are: BANK_ACCOUNT_NUMBER,

BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN,
EMAIL, ADDRESS, NAME, PHONE, SSN, and ALL.

PiiEntityTypes is an optional parameter with a default value of ALL.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 300.

Pattern: ^[A-Z_, ]+

Required: No
PreferredLanguage

Language code for the preferred language.

Type: String

Valid Values: en-US | en-GB | es-US | fr-CA | fr-FR | en-AU | it-IT | de-DE |
pt-BR | ja-JP | ko-KR | zh-CN

Required: No
Region

The AWS Region passed to Amazon Transcribe. If you don't specify a Region, Amazon Chime uses the
meeting's Region.

Type: String

1292
 Amazon Chime SDK API Reference
EngineTranscribeSettings

Valid Values: us-east-2 | us-east-1 | us-west-2 | ap-northeast-2 | ap-

southeast-2 | ap-northeast-1 | ca-central-1 | eu-central-1 | eu-west-1 | eu-
west-2 | sa-east-1 | auto | us-gov-west-1

Required: No
VocabularyFilterMethod

The filtering method passed to Amazon Transcribe.

Type: String

Valid Values: remove | mask | tag

Required: No
VocabularyFilterName

The name of the vocabulary filter passed to Amazon Transcribe.

Type: String

Length Constraints: Maximum length of 4096.

Required: No
VocabularyName

The name of the vocabulary passed to Amazon Transcribe.

Type: String

Length Constraints: Maximum length of 4096.

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1293
 Amazon Chime SDK API Reference
MediaPlacement

MediaPlacement
Service: Amazon Chime SDK Meetings

A set of endpoints used by clients to connect to the media service group for an Amazon Chime SDK
meeting.

Contents
AudioFallbackUrl

The audio fallback URL.

Type: String

Length Constraints: Maximum length of 4096.

Required: No
AudioHostUrl

The audio host URL.

Type: String

Length Constraints: Maximum length of 4096.

Required: No
EventIngestionUrl

The event ingestion URL.

Type: String

Length Constraints: Maximum length of 4096.

Required: No
ScreenDataUrl

The screen data URL.

Type: String

Length Constraints: Maximum length of 4096.

Required: No
ScreenSharingUrl

The screen sharing URL.

Type: String

Length Constraints: Maximum length of 4096.

Required: No
ScreenViewingUrl

The screen viewing URL.

Type: String

1294
 Amazon Chime SDK API Reference
MediaPlacement

Length Constraints: Maximum length of 4096.

Required: No
SignalingUrl

The signaling URL.

Type: String

Length Constraints: Maximum length of 4096.

Required: No
TurnControlUrl

The turn control URL.

Type: String

Length Constraints: Maximum length of 4096.

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1295
 Amazon Chime SDK API Reference
Meeting

Meeting
Service: Amazon Chime SDK Meetings

A meeting created using the Amazon Chime SDK.

Contents
ExternalMeetingId

The external meeting ID.

Pattern: [-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*

Values that begin with aws: are reserved. You can't configure a value that uses this prefix. Case
insensitive.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

Required: No
MediaPlacement

The media placement for the meeting.

Type: MediaPlacement (p. 1294) object

Required: No
MediaRegion

The Region in which you create the meeting. Available values: af-south-1, ap-northeast-1,
ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2, ca-central-1, eu-
central-1, eu-north-1, eu-south-1, eu-west-1, eu-west-2, eu-west-3, sa-east-1, us-
east-1, us-east-2, us-west-1, us-west-2.

Available values in AWS GovCloud (US) Regions: us-gov-east-1, us-gov-west-1.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

Required: No
MeetingArn

The ARN of the meeting.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1011.

Pattern: ^arn:.*

Required: No
MeetingFeatures

The features available to a meeting, such as echo reduction.

Type: MeetingFeaturesConfiguration (p. 1298) object

1296
 Amazon Chime SDK API Reference
Meeting

Required: No
MeetingHostId

Reserved.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

Required: No
MeetingId

The Amazon Chime SDK meeting ID.

Type: String

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: No
PrimaryMeetingId

When specified, replicates the media from the primary meeting to this meeting.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

Required: No
TenantIds

Array of strings.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 5 items.

Length Constraints: Minimum length of 2. Maximum length of 256.

Pattern: ^(?!.*?(.)\1{3})[-_!@#$a-zA-Z0-9]*$

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1297
 Amazon Chime SDK API Reference
MeetingFeaturesConfiguration

MeetingFeaturesConfiguration
Service: Amazon Chime SDK Meetings

The configuration settings of the features available to a meeting.

Contents
Audio

The configuration settings for the audio features available to a meeting.

Type: AudioFeatures (p. 1286) object

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1298
 Amazon Chime SDK API Reference
NotificationsConfiguration

NotificationsConfiguration
Service: Amazon Chime SDK Meetings

The configuration for resource targets to receive notifications when meeting and attendee events occur.

Contents
LambdaFunctionArn

The ARN of the AWS Lambda function in the notifications configuration.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^arn[\/\:\-\_\.a-zA-Z0-9]+$

Required: No
SnsTopicArn

The ARN of the SNS topic.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^arn[\/\:\-\_\.a-zA-Z0-9]+$

Required: No
SqsQueueArn

The ARN of the SQS queue.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^arn[\/\:\-\_\.a-zA-Z0-9]+$

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1299
 Amazon Chime SDK API Reference
Tag

Tag
Service: Amazon Chime SDK Meetings

A key-value pair that you define.

Contents
Key

The tag's key.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z+-=._:/]+$

Required: Yes
Value

The tag's value.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: [\s\w+-=\.:/@]*

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1300
 Amazon Chime SDK API Reference
TranscriptionConfiguration

TranscriptionConfiguration
Service: Amazon Chime SDK Meetings

The configuration for the current transcription operation. Must contain EngineTranscribeSettings
or EngineTranscribeMedicalSettings.

Contents
EngineTranscribeMedicalSettings

The transcription configuration settings passed to Amazon Transcribe Medical.

Type: EngineTranscribeMedicalSettings (p. 1289) object

Required: No
EngineTranscribeSettings

The transcription configuration settings passed to Amazon Transcribe.

Type: EngineTranscribeSettings (p. 1291) object

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

Amazon Chime SDK Messaging

The following data types are supported by Amazon Chime SDK Messaging:

• AppInstanceUserMembershipSummary (p. 1303)

• BatchChannelMemberships (p. 1304)
• BatchCreateChannelMembershipError (p. 1306)
• Channel (p. 1307)
• ChannelAssociatedWithFlowSummary (p. 1310)
• ChannelBan (p. 1312)
• ChannelBanSummary (p. 1313)
• ChannelFlow (p. 1314)
• ChannelFlowSummary (p. 1316)
• ChannelMembership (p. 1317)
• ChannelMembershipForAppInstanceUserSummary (p. 1319)
• ChannelMembershipPreferences (p. 1320)
• ChannelMembershipSummary (p. 1321)
• ChannelMessage (p. 1322)

1301
 Amazon Chime SDK API Reference
Amazon Chime SDK Messaging

• ChannelMessageCallback (p. 1325)

• ChannelMessageStatusStructure (p. 1327)
• ChannelMessageSummary (p. 1328)
• ChannelModeratedByAppInstanceUserSummary (p. 1330)
• ChannelModerator (p. 1331)
• ChannelModeratorSummary (p. 1332)
• ChannelSummary (p. 1333)
• ElasticChannelConfiguration (p. 1335)
• Identity (p. 1336)
• LambdaConfiguration (p. 1337)
• MessageAttributeValue (p. 1338)
• MessagingSessionEndpoint (p. 1339)
• Processor (p. 1340)
• ProcessorConfiguration (p. 1342)
• PushNotificationConfiguration (p. 1343)
• PushNotificationPreferences (p. 1344)
• SearchField (p. 1345)
• SubChannelSummary (p. 1347)
• Tag (p. 1348)

1302
 Amazon Chime SDK API Reference
AppInstanceUserMembershipSummary

AppInstanceUserMembershipSummary
Service: Amazon Chime SDK Messaging

Summary of the membership details of an AppInstanceUser.

Contents
ReadMarkerTimestamp

The time at which an AppInstanceUser last marked a channel as read.

Type: Timestamp

Required: No
SubChannelId

The ID of the SubChannel that the AppInstanceUser is a member of.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [-_a-zA-Z0-9]*

Required: No
Type

The type of ChannelMembership.

Type: String

Valid Values: DEFAULT | HIDDEN

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1303
 Amazon Chime SDK API Reference
BatchChannelMemberships

BatchChannelMemberships
Service: Amazon Chime SDK Messaging

The membership information, including member ARNs, the channel ARN, and membership types.

Contents
ChannelArn

The ARN of the channel to which you're adding users.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: No
InvitedBy

The identifier of the member who invited another member.

Type: Identity (p. 1336) object

Required: No
Members

The users successfully added to the request.

Type: Array of Identity (p. 1336) objects

Required: No
SubChannelId

The ID of the SubChannel.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [-_a-zA-Z0-9]*

Required: No
Type

The membership types set for the channel users.

Type: String

Valid Values: DEFAULT | HIDDEN

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

1304
 Amazon Chime SDK API Reference
BatchChannelMemberships

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1305
 Amazon Chime SDK API Reference
BatchCreateChannelMembershipError

BatchCreateChannelMembershipError
Service: Amazon Chime SDK Messaging

A list of failed member ARNs, error codes, and error messages.

Contents
ErrorCode

The error code.

Type: String

Valid Values: BadRequest | Conflict | Forbidden | NotFound | PreconditionFailed

| ResourceLimitExceeded | ServiceFailure | AccessDenied |
ServiceUnavailable | Throttled | Throttling | Unauthorized | Unprocessable |
VoiceConnectorGroupAssociationsExist | PhoneNumberAssociationsExist

Required: No
ErrorMessage

The error message.

Type: String

Required: No
MemberArn

The AppInstanceUserArn of the member that the service couldn't add.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1306
 Amazon Chime SDK API Reference
Channel

Channel
Service: Amazon Chime SDK Messaging

The details of a channel.

Contents
ChannelArn

The ARN of a channel.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: No
ChannelFlowArn

The ARN of the channel flow.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: No
CreatedBy

The AppInstanceUser who created the channel.

Type: Identity (p. 1336) object

Required: No
CreatedTimestamp

The time at which the AppInstanceUser created the channel.

Type: Timestamp

Required: No
ElasticChannelConfiguration

The attributes required to configure and create an elastic channel. An elastic channel can support a
maximum of 1-million members.

Type: ElasticChannelConfiguration (p. 1335) object

Required: No
LastMessageTimestamp

The time at which a member sent the last message in the channel.

Type: Timestamp

1307
 Amazon Chime SDK API Reference
Channel

Required: No
LastUpdatedTimestamp

The time at which a channel was last updated.

Type: Timestamp

Required: No
Metadata

The channel's metadata.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: .*

Required: No
Mode

The mode of the channel.

Type: String

Valid Values: UNRESTRICTED | RESTRICTED

Required: No
Name

The name of a channel.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD
\u10000-\u10FFFF]*

Required: No
Privacy

The channel's privacy setting.

Type: String

Valid Values: PUBLIC | PRIVATE

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1308
Amazon Chime SDK API Reference
Channel

1309
 Amazon Chime SDK API Reference
ChannelAssociatedWithFlowSummary

ChannelAssociatedWithFlowSummary
Service: Amazon Chime SDK Messaging

Summary of details of a channel associated with channel flow.

Contents
ChannelArn

The ARN of the channel.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: No
Metadata

The channel's metadata.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: .*

Required: No
Mode

The mode of the channel.

Type: String

Valid Values: UNRESTRICTED | RESTRICTED

Required: No
Name

The name of the channel flow.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD
\u10000-\u10FFFF]*

Required: No
Privacy

The channel's privacy setting.

Type: String

Valid Values: PUBLIC | PRIVATE

1310
 Amazon Chime SDK API Reference
ChannelAssociatedWithFlowSummary

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1311
 Amazon Chime SDK API Reference
ChannelBan

ChannelBan
Service: Amazon Chime SDK Messaging

The details of a channel ban.

Contents
ChannelArn

The ARN of the channel from which a member is being banned.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: No
CreatedBy

The AppInstanceUser who created the ban.

Type: Identity (p. 1336) object

Required: No
CreatedTimestamp

The time at which the ban was created.

Type: Timestamp

Required: No
Member

The member being banned from the channel.

Type: Identity (p. 1336) object

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1312
 Amazon Chime SDK API Reference
ChannelBanSummary

ChannelBanSummary
Service: Amazon Chime SDK Messaging

Summary of the details of a ChannelBan.

Contents
Member

The member being banned from a channel.

Type: Identity (p. 1336) object

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1313
 Amazon Chime SDK API Reference
ChannelFlow

ChannelFlow
Service: Amazon Chime SDK Messaging

The details of a channel flow.

Contents
ChannelFlowArn

The ARN of the channel flow.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: No
CreatedTimestamp

The time at which the channel flow was created.

Type: Timestamp

Required: No
LastUpdatedTimestamp

The time at which a channel flow was updated.

Type: Timestamp

Required: No
Name

The name of the channel flow.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD
\u10000-\u10FFFF]*

Required: No
Processors

Information about the processor Lambda functions.

Type: Array of Processor (p. 1340) objects

Array Members: Minimum number of 1 item. Maximum number of 3 items.

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

1314
 Amazon Chime SDK API Reference
ChannelFlow

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1315
 Amazon Chime SDK API Reference
ChannelFlowSummary

ChannelFlowSummary
Service: Amazon Chime SDK Messaging

Summary of details of a channel flow.

Contents
ChannelFlowArn

The ARN of the channel flow.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: No
Name

The name of the channel flow.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD
\u10000-\u10FFFF]*

Required: No
Processors

Information about the processor Lambda functions.

Type: Array of Processor (p. 1340) objects

Array Members: Minimum number of 1 item. Maximum number of 3 items.

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1316
 Amazon Chime SDK API Reference
ChannelMembership

ChannelMembership
Service: Amazon Chime SDK Messaging

The details of a channel member.

Contents
ChannelArn

The ARN of the member's channel.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: No
CreatedTimestamp

The time at which the channel membership was created.

Type: Timestamp

Required: No
InvitedBy

The identifier of the member who invited another member.

Type: Identity (p. 1336) object

Required: No
LastUpdatedTimestamp

The time at which a channel membership was last updated.

Type: Timestamp

Required: No
Member

The data of the channel member.

Type: Identity (p. 1336) object

Required: No
SubChannelId

The ID of the SubChannel that a user belongs to.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [-_a-zA-Z0-9]*

Required: No

1317
 Amazon Chime SDK API Reference
ChannelMembership

Type

The membership type set for the channel member.

Type: String

Valid Values: DEFAULT | HIDDEN

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1318
 Amazon Chime SDK API Reference
ChannelMembershipForAppInstanceUserSummary

ChannelMembershipForAppInstanceUserSummary
Service: Amazon Chime SDK Messaging

Summary of the channel membership details of an AppInstanceUser.

Contents
AppInstanceUserMembershipSummary

Returns the channel membership data for an AppInstance.

Type: AppInstanceUserMembershipSummary (p. 1303) object

Required: No
ChannelSummary

Returns the channel data for an AppInstance.

Type: ChannelSummary (p. 1333) object

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1319
 Amazon Chime SDK API Reference
ChannelMembershipPreferences

ChannelMembershipPreferences
Service: Amazon Chime SDK Messaging

The channel membership preferences for an AppInstanceUser.

Contents
PushNotifications

The push notification configuration of a message.

Type: PushNotificationPreferences (p. 1344) object

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1320
 Amazon Chime SDK API Reference
ChannelMembershipSummary

ChannelMembershipSummary
Service: Amazon Chime SDK Messaging

Summary of the details of a ChannelMembership.

Contents
Member

A member's summary data.

Type: Identity (p. 1336) object

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1321
 Amazon Chime SDK API Reference
ChannelMessage

ChannelMessage
Service: Amazon Chime SDK Messaging

The details of a message in a channel.

Contents
ChannelArn

The ARN of the channel.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: No
Content

The message content.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 4096.

Pattern: [\s\S]*

Required: No
CreatedTimestamp

The time at which the message was created.

Type: Timestamp

Required: No
LastEditedTimestamp

The time at which a message was edited.

Type: Timestamp

Required: No
LastUpdatedTimestamp

The time at which a message was updated.

Type: Timestamp

Required: No
MessageAttributes

The attributes for the message, used for message filtering along with a FilterRule defined in the
PushNotificationPreferences.

Type: String to MessageAttributeValue (p. 1338) object map

Key Length Constraints: Minimum length of 1. Maximum length of 64.

1322
 Amazon Chime SDK API Reference
ChannelMessage

Key Pattern: [\s\S]*

Required: No
MessageId

The ID of a message.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [-_a-zA-Z0-9]*

Required: No
Metadata

The message metadata.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: .*

Required: No
Persistence

The persistence setting for a channel message.

Type: String

Valid Values: PERSISTENT | NON_PERSISTENT

Required: No
Redacted

Hides the content of a message.

Type: Boolean

Required: No
Sender

The message sender.

Type: Identity (p. 1336) object

Required: No
Status

The status of the channel message.

Type: ChannelMessageStatusStructure (p. 1327) object

Required: No
SubChannelId

The ID of the SubChannel.

Type: String

1323
 Amazon Chime SDK API Reference
ChannelMessage

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [-_a-zA-Z0-9]*

Required: No
Type

The message type.

Type: String

Valid Values: STANDARD | CONTROL

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1324
 Amazon Chime SDK API Reference
ChannelMessageCallback

ChannelMessageCallback
Service: Amazon Chime SDK Messaging

Stores information about a callback.

Contents
Content

The message content.

Type: String

Length Constraints: Minimum length of 1.

Pattern: [\s\S]*

Required: No
MessageAttributes

The attributes for the message, used for message filtering along with a FilterRule defined in the
PushNotificationPreferences.

Type: String to MessageAttributeValue (p. 1338) object map

Key Length Constraints: Minimum length of 1. Maximum length of 64.

Key Pattern: [\s\S]*

Required: No
MessageId

The message ID.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [-_a-zA-Z0-9]*

Required: Yes
Metadata

The message metadata.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: .*

Required: No
PushNotification

The push notification configuration of the message.

Type: PushNotificationConfiguration (p. 1343) object

Required: No

1325
 Amazon Chime SDK API Reference
ChannelMessageCallback

SubChannelId

The ID of the SubChannel.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [-_a-zA-Z0-9]*

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1326
 Amazon Chime SDK API Reference
ChannelMessageStatusStructure

ChannelMessageStatusStructure
Service: Amazon Chime SDK Messaging

Stores information about a message status.

Contents
Detail

Contains more details about the messasge status.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: [\s\S]*

Required: No
Value

The message status value.

Type: String

Valid Values: SENT | PENDING | FAILED | DENIED

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1327
 Amazon Chime SDK API Reference
ChannelMessageSummary

ChannelMessageSummary
Service: Amazon Chime SDK Messaging

Summary of the messages in a Channel.

Contents
Content

The content of the message.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 4096.

Pattern: [\s\S]*

Required: No
CreatedTimestamp

The time at which the message summary was created.

Type: Timestamp

Required: No
LastEditedTimestamp

The time at which a message was last edited.

Type: Timestamp

Required: No
LastUpdatedTimestamp

The time at which a message was last updated.

Type: Timestamp

Required: No
MessageAttributes

The message attribues listed in a the summary of a channel message.

Type: String to MessageAttributeValue (p. 1338) object map

Key Length Constraints: Minimum length of 1. Maximum length of 64.

Key Pattern: [\s\S]*

Required: No
MessageId

The ID of the message.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [-_a-zA-Z0-9]*

1328
 Amazon Chime SDK API Reference
ChannelMessageSummary

Required: No
Metadata

The metadata of the message.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: .*

Required: No
Redacted

Indicates whether a message was redacted.

Type: Boolean

Required: No
Sender

The message sender.

Type: Identity (p. 1336) object

Required: No
Status

The message status. The status value is SENT for messages sent to a channel without a channel flow.
For channels associated with channel flow, the value determines the processing stage.

Type: ChannelMessageStatusStructure (p. 1327) object

Required: No
Type

The type of message.

Type: String

Valid Values: STANDARD | CONTROL

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1329
 Amazon Chime SDK API Reference
ChannelModeratedByAppInstanceUserSummary

ChannelModeratedByAppInstanceUserSummary
Service: Amazon Chime SDK Messaging

Summary of the details of a moderated channel.

Contents
ChannelSummary

Summary of the details of a Channel.

Type: ChannelSummary (p. 1333) object

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1330
 Amazon Chime SDK API Reference
ChannelModerator

ChannelModerator
Service: Amazon Chime SDK Messaging

The details of a channel moderator.

Contents
ChannelArn

The ARN of the moderator's channel.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: No
CreatedBy

The AppInstanceUser who created the moderator.

Type: Identity (p. 1336) object

Required: No
CreatedTimestamp

The time at which the moderator was created.

Type: Timestamp

Required: No
Moderator

The moderator's data.

Type: Identity (p. 1336) object

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1331
 Amazon Chime SDK API Reference
ChannelModeratorSummary

ChannelModeratorSummary
Service: Amazon Chime SDK Messaging

Summary of the details of a ChannelModerator.

Contents
Moderator

The data for a moderator.

Type: Identity (p. 1336) object

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1332
 Amazon Chime SDK API Reference
ChannelSummary

ChannelSummary
Service: Amazon Chime SDK Messaging

Summary of the details of a Channel.

Contents
ChannelArn

The ARN of the channel.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: No
LastMessageTimestamp

The time at which the last persistent message in a channel was sent.

Type: Timestamp

Required: No
Metadata

The metadata of the channel.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: .*

Required: No
Mode

The mode of the channel.

Type: String

Valid Values: UNRESTRICTED | RESTRICTED

Required: No
Name

The name of the channel.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD
\u10000-\u10FFFF]*

Required: No

1333
 Amazon Chime SDK API Reference
ChannelSummary

Privacy

The privacy setting of the channel.

Type: String

Valid Values: PUBLIC | PRIVATE

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1334
 Amazon Chime SDK API Reference
ElasticChannelConfiguration

ElasticChannelConfiguration
Service: Amazon Chime SDK Messaging

The attributes required to configure and create an elastic channel. An elastic channel can support a
maximum of 1-million members.

Contents
MaximumSubChannels

The maximum number of SubChannels that you want to allow in the elastic channel.

Type: Integer

Valid Range: Minimum value of 2.

Required: Yes
MinimumMembershipPercentage

The minimum allowed percentage of TargetMembershipsPerSubChannel users. Ceil of the calculated

value is used in balancing members among SubChannels of the elastic channel.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 40.

Required: Yes
TargetMembershipsPerSubChannel

The maximum number of members allowed in a SubChannel.

Type: Integer

Valid Range: Minimum value of 2.

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1335
 Amazon Chime SDK API Reference
Identity

Identity
Service: Amazon Chime SDK Messaging

The details of a user.

Contents
Arn

The ARN in an Identity.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]
{0,63}:[^/].{0,1023}

Required: No
Name

The name in an Identity.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD
\u10000-\u10FFFF]*

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1336
 Amazon Chime SDK API Reference
LambdaConfiguration

LambdaConfiguration
Service: Amazon Chime SDK Messaging

Stores metadata about a Lambda processor.

Contents
InvocationType

Controls how the Lambda function is invoked.

Type: String

Valid Values: ASYNC

Required: Yes
ResourceArn

The ARN of the Lambda message processing function.

Type: String

Length Constraints: Minimum length of 15. Maximum length of 2048.

Pattern: arn:aws:lambda:[a-z]{2}-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9\-_
\.]+(:(\$LATEST|[a-zA-Z0-9\-_]+))?

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1337
 Amazon Chime SDK API Reference
MessageAttributeValue

MessageAttributeValue
Service: Amazon Chime SDK Messaging

A list of message attribute values.

Contents
StringValues

The strings in a message attribute value.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: [\s\S]*

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1338
 Amazon Chime SDK API Reference
MessagingSessionEndpoint

MessagingSessionEndpoint
Service: Amazon Chime SDK Messaging

The websocket endpoint used to connect to Amazon Chime SDK messaging.

Contents
Url

The endpoint to which you establish a websocket connection.

Type: String

Length Constraints: Maximum length of 4096.

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1339
 Amazon Chime SDK API Reference
Processor

Processor
Service: Amazon Chime SDK Messaging

The information about a processor in a channel flow.

Contents
Configuration

The information about the type of processor and its identifier.

Type: ProcessorConfiguration (p. 1342) object

Required: Yes
ExecutionOrder

The sequence in which processors run. If you have multiple processors in a channel flow, message
processing goes through each processor in the sequence. The value determines the sequence. At this
point, we support only 1 processor within a flow.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 3.

Required: Yes
FallbackAction

Determines whether to continue with message processing or stop it in cases where communication
with a processor fails. If a processor has a fallback action of ABORT and communication with it fails,
the processor sets the message status to FAILED and does not send the message to any recipients.
Note that if the last processor in the channel flow sequence has a fallback action of CONTINUE
and communication with the processor fails, then the message is considered processed and sent to
recipients of the channel.

Type: String

Valid Values: CONTINUE | ABORT

Required: Yes
Name

The name of the channel flow.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD
\u10000-\u10FFFF]*

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

1340
 Amazon Chime SDK API Reference
Processor

• AWS SDK for Go

• AWS SDK for Java V2
• AWS SDK for Ruby V3

1341
 Amazon Chime SDK API Reference
ProcessorConfiguration

ProcessorConfiguration
Service: Amazon Chime SDK Messaging

A processor's metadata.

Contents
Lambda

Indicates that the processor is of type Lambda.

Type: LambdaConfiguration (p. 1337) object

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1342
 Amazon Chime SDK API Reference
PushNotificationConfiguration

PushNotificationConfiguration
Service: Amazon Chime SDK Messaging

The push notification configuration of the message.

Contents
Body

The body of the push notification.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 150.

Pattern: [\s\S]*

Required: No
Title

The title of the push notification.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 50.

Pattern: .*

Required: No
Type

Enum value that indicates the type of the push notification for a message. DEFAULT: Normal mobile
push notification. VOIP: VOIP mobile push notification.

Type: String

Valid Values: DEFAULT | VOIP

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1343
 Amazon Chime SDK API Reference
PushNotificationPreferences

PushNotificationPreferences
Service: Amazon Chime SDK Messaging

The channel membership preferences for push notification.

Contents
AllowNotifications

Enum value that indicates which push notifications to send to the requested member of a channel.
ALL sends all push notifications, NONE sends no push notifications, FILTERED sends only filtered
push notifications.

Type: String

Valid Values: ALL | NONE | FILTERED

Required: Yes
FilterRule

The simple JSON object used to send a subset of a push notification to the requested member.

Type: String

Length Constraints: Minimum length of 1.

Pattern: [\s\S]*

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1344
 Amazon Chime SDK API Reference
SearchField

SearchField
Service: Amazon Chime SDK Messaging

A Field of the channel that you want to search.

Contents
Key

An enum value that indicates the key to search the channel on. MEMBERS allows you to search
channels based on memberships. You can use it with the EQUALS operator to get channels whose
memberships are equal to the specified values, and with the INCLUDES operator to get channels
whose memberships include the specified values.

Type: String

Valid Values: MEMBERS

Required: Yes
Operator

The operator used to compare field values, currently EQUALS or INCLUDES. Use the EQUALS
operator to find channels whose memberships equal the specified values. Use the INCLUDES
operator to find channels whose memberships include the specified values.

Type: String

Valid Values: EQUALS | INCLUDES

Required: Yes
Values

The values that you want to search for, a list of strings. The values must be AppInstanceUserArns
specified as a list of strings.
Note
This operation isn't supported for AppInstanceUsers with large number of memberships.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 20 items.

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: [\s\S]*

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1345
Amazon Chime SDK API Reference
SearchField

1346
 Amazon Chime SDK API Reference
SubChannelSummary

SubChannelSummary
Service: Amazon Chime SDK Messaging

Summary of the sub-channels associated with the elastic channel.

Contents
MembershipCount

The number of members in a SubChannel.

Type: Integer

Required: No
SubChannelId

The unique ID of a SubChannel.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [-_a-zA-Z0-9]*

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1347
 Amazon Chime SDK API Reference
Tag

Tag
Service: Amazon Chime SDK Messaging

A tag object containing a key-value pair.

Contents
Key

The key in a tag.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: Yes
Value

The value in a tag.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

Amazon Chime SDK Voice

The following data types are supported by Amazon Chime SDK Voice:

• Address (p. 1350)

• CandidateAddress (p. 1352)
• Credential (p. 1354)
• DNISEmergencyCallingConfiguration (p. 1355)
• EmergencyCallingConfiguration (p. 1356)
• GeoMatchParams (p. 1357)
• LoggingConfiguration (p. 1358)
• OrderedPhoneNumber (p. 1359)
• Origination (p. 1360)
• OriginationRoute (p. 1361)
• Participant (p. 1363)
• PhoneNumber (p. 1364)

1348
 Amazon Chime SDK API Reference
Amazon Chime SDK Voice

• PhoneNumberAssociation (p. 1367)

• PhoneNumberCapabilities (p. 1368)
• PhoneNumberCountry (p. 1370)
• PhoneNumberError (p. 1371)
• PhoneNumberOrder (p. 1372)
• Proxy (p. 1374)
• ProxySession (p. 1375)
• SipMediaApplication (p. 1378)
• SipMediaApplicationAlexaSkillConfiguration (p. 1380)
• SipMediaApplicationCall (p. 1381)
• SipMediaApplicationEndpoint (p. 1382)
• SipMediaApplicationLoggingConfiguration (p. 1383)
• SipRule (p. 1384)
• SipRuleTargetApplication (p. 1386)
• StreamingConfiguration (p. 1387)
• StreamingNotificationTarget (p. 1388)
• Termination (p. 1389)
• TerminationHealth (p. 1391)
• UpdatePhoneNumberRequestItem (p. 1392)
• VoiceConnector (p. 1393)
• VoiceConnectorGroup (p. 1395)
• VoiceConnectorItem (p. 1397)
• VoiceConnectorSettings (p. 1398)

1349
 Amazon Chime SDK API Reference
Address

Address
Service: Amazon Chime SDK Voice

A validated address.

Contents
city

The city of an address.

Type: String

Pattern: .*\S.*

Required: No
country

The country of an address.

Type: String

Pattern: .*\S.*

Required: No
postalCode

The postal code of an address.

Type: String

Pattern: .*\S.*

Required: No
postalCodePlus4

The zip + 4 or postal code + 4 of an address.

Type: String

Pattern: .*\S.*

Required: No
postDirectional

An address suffix location, such as the S. Unit A in Central Park S. Unit A.

Type: String

Pattern: .*\S.*

Required: No
preDirectional

An address prefix location, such as the N in N. Third St.

Type: String

Pattern: .*\S.*

1350
 Amazon Chime SDK API Reference
Address

Required: No
state

The state of an address.

Type: String

Pattern: .*\S.*

Required: No
streetName

The address street, such as 8th Avenue.

Type: String

Pattern: .*\S.*

Required: No
streetNumber

The numeric portion of an address.

Type: String

Pattern: .*\S.*

Required: No
streetSuffix

The address suffix, such as the N in 8th Avenue N.

Type: String

Pattern: .*\S.*

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1351
 Amazon Chime SDK API Reference
CandidateAddress

CandidateAddress
Service: Amazon Chime SDK Voice

A suggested address.

Contents
city

The city of the candidate address.

Type: String

Pattern: .*\S.*

Required: No
country

The country of the candidate address.

Type: String

Pattern: .*\S.*

Required: No
postalCode

The postal code of the candidate address.

Type: String

Pattern: .*\S.*

Required: No
postalCodePlus4

The zip + 4 or postal code +4 of the candidate address.

Type: String

Pattern: .*\S.*

Required: No
state

The state of the candidate address.

Type: String

Pattern: .*\S.*

Required: No
streetInfo

The street information of the candidate address.

Type: String

Pattern: .*\S.*

1352
 Amazon Chime SDK API Reference
CandidateAddress

Required: No
streetNumber

The numeric portion of the candidate address.

Type: String

Pattern: .*\S.*

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1353
 Amazon Chime SDK API Reference
Credential

Credential
Service: Amazon Chime SDK Voice

The SIP credentials used to authenticate requests to an Amazon Chime SDK Voice Connector.

Contents
Password

The RFC2617 compliant password associated with the SIP credentials, in US-ASCII format.

Type: String

Required: No
Username

The RFC2617 compliant user name associated with the SIP credentials, in US-ASCII format.

Type: String

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1354
 Amazon Chime SDK API Reference
DNISEmergencyCallingConfiguration

DNISEmergencyCallingConfiguration
Service: Amazon Chime SDK Voice

The Dialed Number Identification Service (DNIS) emergency calling configuration details associated with
an Amazon Chime SDK Voice Connector's emergency calling configuration.

Contents
CallingCountry

The country from which emergency calls are allowed, in ISO 3166-1 alpha-2 format.

Type: String

Pattern: [A-Z]{2}

Required: Yes
EmergencyPhoneNumber

The DNIS phone number that you route emergency calls to, in E.164 format.

Type: String

Pattern: ^\+?[1-9]\d{1,14}$

Required: Yes
TestPhoneNumber

The DNIS phone number for routing test emergency calls to, in E.164 format.

Type: String

Pattern: ^\+?[1-9]\d{1,14}$

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1355
 Amazon Chime SDK API Reference
EmergencyCallingConfiguration

EmergencyCallingConfiguration
Service: Amazon Chime SDK Voice

The emergency calling configuration details associated with an Amazon Chime SDK Voice Connector.

Contents
DNIS

The Dialed Number Identification Service (DNIS) emergency calling configuration details.

Type: Array of DNISEmergencyCallingConfiguration (p. 1355) objects

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1356
 Amazon Chime SDK API Reference
GeoMatchParams

GeoMatchParams
Service: Amazon Chime SDK Voice

The country and area code for a proxy phone number in a proxy phone session.

Contents
AreaCode

The area code.

Type: String

Pattern: ^$|^[0-9]{3,3}$

Required: Yes
Country

The country.

Type: String

Pattern: ^$|^[A-Z]{2,2}$

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1357
 Amazon Chime SDK API Reference
LoggingConfiguration

LoggingConfiguration
Service: Amazon Chime SDK Voice

The logging configuration associated with an Amazon Chime SDK Voice Connector. Specifies whether SIP
message logs can be sent to Amazon CloudWatch Logs.

Contents
EnableMediaMetricLogs

Enables the streaming of Amazon Chime SDK Voice Connector events to Amazon CloudWatch.

Type: Boolean

Required: No
EnableSIPLogs

Boolean that enables sending SIP message logs to Amazon CloudWatch logs.

Type: Boolean

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1358
 Amazon Chime SDK API Reference
OrderedPhoneNumber

OrderedPhoneNumber
Service: Amazon Chime SDK Voice

A phone number for which an order has been placed.

Contents
E164PhoneNumber

The phone number, in E.164 format.

Type: String

Pattern: ^\+?[1-9]\d{1,14}$

Required: No
Status

The phone number status.

Type: String

Valid Values: Processing | Acquired | Failed

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1359
 Amazon Chime SDK API Reference
Origination

Origination
Service: Amazon Chime SDK Voice

Origination settings enable your SIP hosts to receive inbound calls using your Amazon Chime SDK Voice
Connector.
Note
The parameters listed below are not required, but you must use at least one.

Contents
Disabled

When origination settings are disabled, inbound calls are not enabled for your Amazon Chime SDK
Voice Connector. This parameter is not required, but you must specify this parameter or Routes.

Type: Boolean

Required: No
Routes

The call distribution properties defined for your SIP hosts. Valid range: Minimum value of 1.
Maximum value of 20. This parameter is not required, but you must specify this parameter or
Disabled.

Type: Array of OriginationRoute (p. 1361) objects

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1360
 Amazon Chime SDK API Reference
OriginationRoute

OriginationRoute
Service: Amazon Chime SDK Voice

Origination routes define call distribution properties for your SIP hosts to receive inbound calls using an
Amazon Chime SDK Voice Connector. Limit: Ten origination routes for each Voice Connector.
Note
The parameters listed below are not required, but you must use at least one.

Contents
Host

The FQDN or IP address to contact for origination traffic.

Type: String

Required: No
Port

The designated origination route port. Defaults to 5060.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 65535.

Required: No
Priority

The priority associated with the host, with 1 being the highest priority. Higher priority hosts are
attempted first.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No
Protocol

The protocol to use for the origination route. Encryption-enabled Amazon Chime SDK Voice
Connectors use TCP protocol by default.

Type: String

Valid Values: TCP | UDP

Required: No
Weight

The weight assigned to an origination route. When hosts have equal priority, calls are distributed
between them based on their relative weights.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

1361
 Amazon Chime SDK API Reference
OriginationRoute

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1362
 Amazon Chime SDK API Reference
Participant

Participant
Service: Amazon Chime SDK Voice

The phone number and proxy phone number for a participant in an Amazon Chime SDK Voice Connector
proxy session.

Contents
PhoneNumber

The participant's phone number.

Type: String

Pattern: ^\+?[1-9]\d{1,14}$

Required: No
ProxyPhoneNumber

The participant's proxy phone number.

Type: String

Pattern: ^\+?[1-9]\d{1,14}$

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1363
 Amazon Chime SDK API Reference
PhoneNumber

PhoneNumber
Service: Amazon Chime SDK Voice

A phone number used to call an Amazon Chime SDK Voice Connector.

Contents
Associations

The phone number's associations.

Type: Array of PhoneNumberAssociation (p. 1367) objects

Required: No
CallingName

The outbound calling name associated with the phone number.

Type: String

Pattern: ^$|^[a-zA-Z0-9 ]{2,15}$

Required: No
CallingNameStatus

The outbound calling name status.

Type: String

Valid Values: Unassigned | UpdateInProgress | UpdateSucceeded | UpdateFailed

Required: No
Capabilities

The phone number's capabilities.

Type: PhoneNumberCapabilities (p. 1368) object

Required: No
Country

The phone number's country. Format: ISO 3166-1 alpha-2.

Type: String

Pattern: [A-Z]{2}

Required: No
CreatedTimestamp

The phone number creation timestamp, in ISO 8601 format.

Type: Timestamp

Required: No
DeletionTimestamp

The deleted phone number timestamp, in ISO 8601 format.

1364
 Amazon Chime SDK API Reference
PhoneNumber

Type: Timestamp

Required: No
E164PhoneNumber

The phone number, in E.164 format.

Type: String

Pattern: ^\+?[1-9]\d{1,14}$

Required: No
OrderId

The phone number's order ID.

Type: String

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: No
PhoneNumberId

The phone number's ID.

Type: String

Pattern: .*\S.*

Required: No
ProductType

The phone number's product type.

Type: String

Valid Values: VoiceConnector | SipMediaApplicationDialIn

Required: No
Status

The phone number's status.

Type: String

Valid Values: Cancelled | PortinCancelRequested | PortinInProgress

| AcquireInProgress | AcquireFailed | Unassigned | Assigned |
ReleaseInProgress | DeleteInProgress | ReleaseFailed | DeleteFailed

Required: No
Type

The phone number's type.

Type: String

Valid Values: Local | TollFree

Required: No

1365
 Amazon Chime SDK API Reference
PhoneNumber

UpdatedTimestamp

The updated phone number timestamp, in ISO 8601 format.

Type: Timestamp

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1366
 Amazon Chime SDK API Reference
PhoneNumberAssociation

PhoneNumberAssociation
Service: Amazon Chime SDK Voice

The phone number associations, such as an Amazon Chime SDK account ID, user ID, Voice Connector ID,
or Voice Connector group ID.

Contents
AssociatedTimestamp

The timestamp of the phone number association, in ISO 8601 format.

Type: Timestamp

Required: No
Name

Defines the association with an Amazon Chime SDK account ID, user ID, Voice Connector ID, or Voice
Connector group ID.

Type: String

Valid Values: VoiceConnectorId | VoiceConnectorGroupId | SipRuleId

Required: No
Value

Contains the ID for the entity specified in Name.

Type: String

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1367
 Amazon Chime SDK API Reference
PhoneNumberCapabilities

PhoneNumberCapabilities
Service: Amazon Chime SDK Voice

The phone number capabilities for Amazon Chime SDK phone numbers, such as enabled inbound and
outbound calling, and text messaging.

Contents
InboundCall

Allows or denies inbound calling for the specified phone number.

Type: Boolean

Required: No
InboundMMS

Allows or denies inbound MMS messaging for the specified phone number.

Type: Boolean

Required: No
InboundSMS

Allows or denies inbound SMS messaging for the specified phone number.

Type: Boolean

Required: No
OutboundCall

Allows or denies outbound calling for the specified phone number.

Type: Boolean

Required: No
OutboundMMS

Allows or denies inbound MMS messaging for the specified phone number.

Type: Boolean

Required: No
OutboundSMS

Allows or denies outbound SMS messaging for the specified phone number.

Type: Boolean

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go

1368
 Amazon Chime SDK API Reference
PhoneNumberCapabilities

• AWS SDK for Java V2

• AWS SDK for Ruby V3

1369
 Amazon Chime SDK API Reference
PhoneNumberCountry

PhoneNumberCountry
Service: Amazon Chime SDK Voice

The phone number's country.

Contents
CountryCode

The phone number country code. Format: ISO 3166-1 alpha-2.

Type: String

Pattern: [A-Z]{2}

Required: No
SupportedPhoneNumberTypes

The supported phone number types.

Type: Array of strings

Valid Values: Local | TollFree

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1370
 Amazon Chime SDK API Reference
PhoneNumberError

PhoneNumberError
Service: Amazon Chime SDK Voice

If a phone number action fails for one or more of the phone numbers in a request, a list of the failed
phone numbers is returned, along with error codes and error messages.

Contents
ErrorCode

The error code.

Type: String

Valid Values: BadRequest | Conflict | Forbidden | NotFound | PreconditionFailed

| ResourceLimitExceeded | ServiceFailure | AccessDenied |
ServiceUnavailable | Throttled | Throttling | Unauthorized | Unprocessable |
VoiceConnectorGroupAssociationsExist | PhoneNumberAssociationsExist | Gone

Required: No
ErrorMessage

The error message.

Type: String

Required: No
PhoneNumberId

The phone number ID for which the action failed.

Type: String

Pattern: .*\S.*

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1371
 Amazon Chime SDK API Reference
PhoneNumberOrder

PhoneNumberOrder
Service: Amazon Chime SDK Voice

The details of an Amazon Chime SDK phone number order.

Contents
CreatedTimestamp

The phone number order creation time stamp, in ISO 8601 format.

Type: Timestamp

Required: No
OrderedPhoneNumbers

The ordered phone number details, such as the phone number in E.164 format and the phone
number status.

Type: Array of OrderedPhoneNumber (p. 1359) objects

Required: No
OrderType

The type of phone number being ordered, local or toll-free.

Type: String

Valid Values: New | Porting

Required: No
PhoneNumberOrderId

The ID of the phone order.

Type: String

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: No
ProductType

The phone number order product type.

Type: String

Valid Values: VoiceConnector | SipMediaApplicationDialIn

Required: No
Status

The status of the phone number order.

Type: String

Valid Values: Processing | Successful | Failed | Partial | PendingDocuments |

Submitted | FOC | ChangeRequested | Exception | CancelRequested | Cancelled

Required: No

1372
 Amazon Chime SDK API Reference
PhoneNumberOrder

UpdatedTimestamp

The updated phone number order time stamp, in ISO 8601 format.

Type: Timestamp

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1373
 Amazon Chime SDK API Reference
Proxy

Proxy
Service: Amazon Chime SDK Voice

The proxy configuration for an Amazon Chime SDK Voice Connector.

Contents
DefaultSessionExpiryMinutes

The default number of minutes allowed for proxy sessions.

Type: Integer

Required: No
Disabled

When true, stops proxy sessions from being created on the specified Amazon Chime SDK Voice
Connector.

Type: Boolean

Required: No
FallBackPhoneNumber

The phone number to route calls to after a proxy session expires.

Type: String

Pattern: ^\+?[1-9]\d{1,14}$

Required: No
PhoneNumberCountries

The countries for proxy phone numbers to be selected from.

Type: Array of strings

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1374
 Amazon Chime SDK API Reference
ProxySession

ProxySession
Service: Amazon Chime SDK Voice

The proxy session for an Amazon Chime SDK Voice Connector.

Contents
Capabilities

The proxy session capabilities.

Type: Array of strings

Valid Values: Voice | SMS

Required: No
CreatedTimestamp

The created time stamp, in ISO 8601 format.

Type: Timestamp

Required: No
EndedTimestamp

The ended time stamp, in ISO 8601 format.

Type: Timestamp

Required: No
ExpiryMinutes

The number of minutes allowed for the proxy session.

Type: Integer

Valid Range: Minimum value of 1.

Required: No
GeoMatchLevel

The preference for matching the country or area code of the proxy phone number with that of the
first participant.

Type: String

Valid Values: Country | AreaCode

Required: No
GeoMatchParams

The country and area code for the proxy phone number.

Type: GeoMatchParams (p. 1357) object

Required: No
Name

The proxy session name.

1375
 Amazon Chime SDK API Reference
ProxySession

Type: String

Length Constraints: Maximum length of 128.

Required: No
NumberSelectionBehavior

The preference for proxy phone number reuse, or stickiness, between the same participants across
sessions.

Type: String

Valid Values: PreferSticky | AvoidSticky

Required: No
Participants

The proxy session participants.

Type: Array of Participant (p. 1363) objects

Required: No
ProxySessionId

The proxy session ID.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: .*\S.*

Required: No
Status

The proxy session status.

Type: String

Valid Values: Open | InProgress | Closed

Required: No
UpdatedTimestamp

The updated time stamp, in ISO 8601 format.

Type: Timestamp

Required: No
VoiceConnectorId

The Voice Connector ID.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: .*\S.*

Required: No

1376
 Amazon Chime SDK API Reference
ProxySession

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1377
 Amazon Chime SDK API Reference
SipMediaApplication

SipMediaApplication
Service: Amazon Chime SDK Voice

The details of the SIP media application, including name and endpoints. An AWS account can have
multiple SIP media applications.

Contents
AwsRegion

The AWS Region in which the SIP media application is created.

Type: String

Required: No
CreatedTimestamp

The SIP media application creation timestamp, in ISO 8601 format.

Type: Timestamp

Required: No
Endpoints

List of endpoints for SIP media application. Currently, only one endpoint per SIP media application is
permitted.

Type: Array of SipMediaApplicationEndpoint (p. 1382) objects

Array Members: Fixed number of 1 item.

Required: No
Name

The SIP media application's name.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: No
SipMediaApplicationId

A SIP media application's ID.

Type: String

Pattern: .*\S.*

Required: No
UpdatedTimestamp

The time at which the SIP media application was updated.

Type: Timestamp

Required: No

1378
 Amazon Chime SDK API Reference
SipMediaApplication

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1379
 Amazon Chime SDK API Reference
SipMediaApplicationAlexaSkillConfiguration

SipMediaApplicationAlexaSkillConfiguration
Service: Amazon Chime SDK Voice

The Alexa Skill configuration of a SIP media application.

Contents
AlexaSkillIds

The ID of the Alexa Skill configuration.

Type: Array of strings

Array Members: Fixed number of 1 item.

Length Constraints: Maximum length of 64.

Pattern: amzn1\.application-oa2-client\.[0-9a-fA-F]{32}

Required: Yes
AlexaSkillStatus

The status of the Alexa Skill configuration.

Type: String

Valid Values: ACTIVE | INACTIVE

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1380
 Amazon Chime SDK API Reference
SipMediaApplicationCall

SipMediaApplicationCall
Service: Amazon Chime SDK Voice

A Call instance for a SIP media application.

Contents
TransactionId

The call's transaction ID.

Type: String

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1381
 Amazon Chime SDK API Reference
SipMediaApplicationEndpoint

SipMediaApplicationEndpoint
Service: Amazon Chime SDK Voice

The endpoint assigned to a SIP media application.

Contents
LambdaArn

Valid Amazon Resource Name (ARN) of the Lambda function, version, or alias. The function must be
created in the same AWS Region as the SIP media application.

Type: String

Length Constraints: Maximum length of 10000.

Pattern: arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-
\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(:(\$LATEST|[a-zA-Z0-9-_]+))?

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1382
 Amazon Chime SDK API Reference
SipMediaApplicationLoggingConfiguration

SipMediaApplicationLoggingConfiguration
Service: Amazon Chime SDK Voice

The logging configuration of a SIP media application.

Contents
EnableSipMediaApplicationMessageLogs

Enables message logging for the specified SIP media application.

Type: Boolean

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1383
 Amazon Chime SDK API Reference
SipRule

SipRule
Service: Amazon Chime SDK Voice

The details of a SIP rule, including name, triggers, and target applications. An AWS account can have
multiple SIP rules.

Contents
CreatedTimestamp

The time at which the SIP rule was created, in ISO 8601 format.

Type: Timestamp

Required: No
Disabled

Indicates whether the SIP rule is enabled or disabled. You must disable a rule before you can delete
it.

Type: Boolean

Required: No
Name

A SIP rule's name.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: No
SipRuleId

A SIP rule's ID.

Type: String

Pattern: .*\S.*

Required: No
TargetApplications

The target SIP media application and other details, such as priority and AWS Region, to be specified
in the SIP rule. Only one SIP rule per AWS Region can be provided.

Type: Array of SipRuleTargetApplication (p. 1386) objects

Array Members: Minimum number of 1 item. Maximum number of 25 items.

Required: No
TriggerType

The type of trigger set for a SIP rule, either a phone number or a URI request host name.

Type: String

Valid Values: ToPhoneNumber | RequestUriHostname

1384
 Amazon Chime SDK API Reference
SipRule

Required: No
TriggerValue

The value set for a SIP rule's trigger type. Either a phone number or a URI hostname.

Type: String

Pattern: .*\S.*

Required: No
UpdatedTimestamp

The time at which the SIP rule was updated, in ISO 8601 format.

Type: Timestamp

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1385
 Amazon Chime SDK API Reference
SipRuleTargetApplication

SipRuleTargetApplication
Service: Amazon Chime SDK Voice

A target SIP media application and other details, such as priority and AWS Region, to be specified in the
SIP rule. Only one SIP rule per AWS Region can be provided.

Contents
AwsRegion

The AWS Region of a rule's target SIP media application.

Type: String

Required: No
Priority

The priority setting of a rule's target SIP media applicaton.

Type: Integer

Valid Range: Minimum value of 1.

Required: No
SipMediaApplicationId

The ID of a rule's target SIP media application.

Type: String

Pattern: .*\S.*

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1386
 Amazon Chime SDK API Reference
StreamingConfiguration

StreamingConfiguration
Service: Amazon Chime SDK Voice

The streaming configuration associated with an Amazon Chime SDK Voice Connector. Specifies whether
media streaming is enabled for sending to Amazon Kinesis, and shows the retention period for the
Amazon Kinesis data, in hours.

Contents
DataRetentionInHours

The amount of time, in hours, to the Kinesis data.

Type: Integer

Valid Range: Minimum value of 0.

Required: Yes
Disabled

When true, streaming to Kinesis is off.

Type: Boolean

Required: Yes
StreamingNotificationTargets

The streaming notification targets.

Type: Array of StreamingNotificationTarget (p. 1388) objects

Array Members: Minimum number of 1 item. Maximum number of 3 items.

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1387
 Amazon Chime SDK API Reference
StreamingNotificationTarget

StreamingNotificationTarget
Service: Amazon Chime SDK Voice

The target recipient for a streaming configuration notification.

Contents
NotificationTarget

The streaming notification target.

Type: String

Valid Values: EventBridge | SNS | SQS

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1388
 Amazon Chime SDK API Reference
Termination

Termination
Service: Amazon Chime SDK Voice

Termination settings enable SIP hosts to make outbound calls using an Amazon Chime SDK Voice
Connector.

Contents
CallingRegions

The countries to which calls are allowed, in ISO 3166-1 alpha-2 format. Required.

Type: Array of strings

Required: No
CidrAllowedList

The IP addresses allowed to make calls, in CIDR format.

Type: Array of strings

Required: No
CpsLimit

The limit on calls per second. Max value based on account service quota. Default value of 1.

Type: Integer

Valid Range: Minimum value of 1.

Required: No
DefaultPhoneNumber

The default outbound calling number.

Type: String

Pattern: ^\+?[1-9]\d{1,14}$

Required: No
Disabled

When termination is disabled, outbound calls cannot be made.

Type: Boolean

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1389
Amazon Chime SDK API Reference
Termination

1390
 Amazon Chime SDK API Reference
TerminationHealth

TerminationHealth
Service: Amazon Chime SDK Voice

The termination health details, including the source IP address and timestamp of the last successful SIP
OPTIONS message from your SIP infrastructure.

Contents
Source

The source IP address.

Type: String

Required: No
Timestamp

The timestamp, in ISO 8601 format.

Type: Timestamp

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1391
 Amazon Chime SDK API Reference
UpdatePhoneNumberRequestItem

UpdatePhoneNumberRequestItem
Service: Amazon Chime SDK Voice

The phone number ID, product type, or calling name fields to update, used with the
BatchUpdatePhoneNumber (p. 898) and UpdatePhoneNumber (p. 1056) actions.

Contents
CallingName

The outbound calling name to update.

Type: String

Pattern: ^$|^[a-zA-Z0-9 ]{2,15}$

Required: No
PhoneNumberId

The phone number ID to update.

Type: String

Pattern: .*\S.*

Required: Yes
ProductType

The product type to update.

Type: String

Valid Values: VoiceConnector | SipMediaApplicationDialIn

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1392
 Amazon Chime SDK API Reference
VoiceConnector

VoiceConnector
Service: Amazon Chime SDK Voice

The Amazon Chime SDK Voice Connector configuration, including outbound host name and encryption
settings.

Contents
AwsRegion

The AWS Region in which the Voice Connector is created. Default: us-east-1.

Type: String

Valid Values: us-east-1 | us-west-2 | ca-central-1 | eu-central-1 | eu-west-1

| eu-west-2 | ap-northeast-2 | ap-northeast-1 | ap-southeast-1 | ap-
southeast-2

Required: No
CreatedTimestamp

The Voice Connector's creation timestamp, in ISO 8601 format.

Type: Timestamp

Required: No
Name

The Voice Connector's name.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: No
OutboundHostName

The outbound host name for the Voice Connector.

Type: String

Required: No
RequireEncryption

Enables or disables encryption for the Voice Connector.

Type: Boolean

Required: No
UpdatedTimestamp

The Voice Connector's updated timestamp, in ISO 8601 format.

Type: Timestamp

Required: No
VoiceConnectorArn

The ARN of the Voice Connector.

1393
 Amazon Chime SDK API Reference
VoiceConnector

Type: String

Pattern: .*\S.*

Required: No
VoiceConnectorId

The Voice Connector's ID.

Type: String

Pattern: .*\S.*

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1394
 Amazon Chime SDK API Reference
VoiceConnectorGroup

VoiceConnectorGroup
Service: Amazon Chime SDK Voice

The Amazon Chime SDK Voice Connector group configuration, including associated Voice Connectors.
You can include Voice Connectors from different AWS Regions in a group. This creates a fault tolerant
mechanism for fallback in case of availability events.

Contents
CreatedTimestamp

The Voice Connector group's creation time stamp, in ISO 8601 format.

Type: Timestamp

Required: No
Name

The name of a Voice Connector group.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: No
UpdatedTimestamp

The Voice Connector group's creation time stamp, in ISO 8601 format.

Type: Timestamp

Required: No
VoiceConnectorGroupArn

The ARN of the Voice Connector group.

Type: String

Pattern: .*\S.*

Required: No
VoiceConnectorGroupId

The ID of a Voice Connector group.

Type: String

Pattern: .*\S.*

Required: No
VoiceConnectorItems

The Voice Connectors to which you route inbound calls.

Type: Array of VoiceConnectorItem (p. 1397) objects

Required: No

1395
 Amazon Chime SDK API Reference
VoiceConnectorGroup

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1396
 Amazon Chime SDK API Reference
VoiceConnectorItem

VoiceConnectorItem
Service: Amazon Chime SDK Voice

For Amazon Chime SDK Voice Connector groups, the Amazon Chime SDK Voice Connectors to which
you route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per Voice
Connector group.

Contents
Priority

The priority setting of a Voice Connector item. Calls are routed to hosts in priority order, with 1 as
the highest priority. When hosts have equal priority, the system distributes calls among them based
on their relative weight.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 99.

Required: Yes
VoiceConnectorId

The Voice Connector ID.

Type: String

Pattern: .*\S.*

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1397
 Amazon Chime SDK API Reference
VoiceConnectorSettings

VoiceConnectorSettings
Service: Amazon Chime SDK Voice

The Amazon Chime SDK Voice Connector settings. Includes any Amazon S3 buckets designated for
storing call detail records.

Contents
CdrBucket

The S3 bucket that stores the Voice Connector's call detail records.

Type: String

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

1398
 Amazon Chime SDK API Reference

Common Errors
This section lists the errors common to the API actions of all AWS services. For errors specific to an API
action for this service, see the topic for that API action.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 400

IncompleteSignature

The request signature does not conform to AWS standards.

HTTP Status Code: 400

InternalFailure

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

InvalidAction

The action or operation requested is invalid. Verify that the action is typed correctly.

HTTP Status Code: 400

InvalidClientTokenId

The X.509 certificate or AWS access key ID provided does not exist in our records.

HTTP Status Code: 403

InvalidParameterCombination

Parameters that must not be used together were used together.

HTTP Status Code: 400

InvalidParameterValue

An invalid or out-of-range value was supplied for the input parameter.

HTTP Status Code: 400

InvalidQueryParameter

The AWS query string is malformed or does not adhere to AWS standards.

HTTP Status Code: 400

MalformedQueryString

The query string contains a syntax error.

HTTP Status Code: 404

MissingAction

The request is missing an action or a required parameter.

HTTP Status Code: 400

1399
 Amazon Chime SDK API Reference

MissingAuthenticationToken

The request must contain either a valid (registered) AWS access key ID or X.509 certificate.

HTTP Status Code: 403

MissingParameter

A required parameter for the specified action is not supplied.

HTTP Status Code: 400

NotAuthorized

You do not have permission to perform this action.

HTTP Status Code: 400

OptInRequired

The AWS access key ID needs a subscription for the service.

HTTP Status Code: 403

RequestExpired

The request reached the service more than 15 minutes after the date stamp on the request or more
than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp
on the request is more than 15 minutes in the future.

HTTP Status Code: 400

ServiceUnavailable

The request has failed due to a temporary failure of the server.

HTTP Status Code: 503

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

ValidationError

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400

1400