Amazon ChimeAPI Reference
API Version 2018-05-01
Amazon Chime API Reference
Amazon Chime: API ReferenceCopyright © 2020 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 notAmazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages ordiscredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who mayor may not be affiliated with, connected to, or sponsored by Amazon.
Amazon Chime API Reference
Table of ContentsWelcome .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Actions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
AssociatePhoneNumbersWithVoiceConnector ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
AssociatePhoneNumbersWithVoiceConnectorGroup .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
AssociatePhoneNumberWithUser .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
AssociateSigninDelegateGroupsWithAccount .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
BatchCreateAttendee .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
BatchCreateRoomMembership .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
API Version 2018-05-01iii
Amazon Chime API Reference
See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24BatchDeletePhoneNumber .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
BatchSuspendUser .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
BatchUnsuspendUser .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
BatchUpdatePhoneNumber .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Examples .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
BatchUpdateUser .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
CreateAccount .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
CreateAttendee .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
API Version 2018-05-01iv
Amazon Chime API Reference
URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
CreateBot .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
CreateMeeting .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
CreatePhoneNumberOrder .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
CreateProxySession .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
CreateRoom ..... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
CreateRoomMembership .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
API Version 2018-05-01v
Amazon Chime API Reference
Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
CreateUser .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
CreateVoiceConnector ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
CreateVoiceConnectorGroup .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
DeleteAccount .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
DeleteAttendee .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
DeleteEventsConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
DeleteMeeting .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
API Version 2018-05-01vi
Amazon Chime API Reference
Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
DeletePhoneNumber .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
DeleteProxySession .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
DeleteRoom ..... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
DeleteRoomMembership .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
DeleteVoiceConnector ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
DeleteVoiceConnectorGroup .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
API Version 2018-05-01vii
Amazon Chime API Reference
Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
DeleteVoiceConnectorOrigination .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
DeleteVoiceConnectorProxy .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
DeleteVoiceConnectorStreamingConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
DeleteVoiceConnectorTermination .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
DeleteVoiceConnectorTerminationCredentials ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
DisassociatePhoneNumberFromUser .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
DisassociatePhoneNumbersFromVoiceConnector ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
API Version 2018-05-01viii
Amazon Chime API Reference
Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
DisassociatePhoneNumbersFromVoiceConnectorGroup .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
DisassociateSigninDelegateGroupsFromAccount .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
GetAccount .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
GetAccountSettings .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
GetAttendee .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
GetBot .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
API Version 2018-05-01ix
Amazon Chime API Reference
Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
GetEventsConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
GetGlobalSettings .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
GetMeeting .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
GetPhoneNumber .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
GetPhoneNumberOrder .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
GetPhoneNumberSettings .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
GetProxySession .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
API Version 2018-05-01x
Amazon Chime API Reference
Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
GetRetentionSettings .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
GetRoom ..... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
GetUser .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
GetUserSettings .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
GetVoiceConnector ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
GetVoiceConnectorGroup .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
API Version 2018-05-01xi
Amazon Chime API Reference
Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
GetVoiceConnectorLoggingConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
GetVoiceConnectorOrigination .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
GetVoiceConnectorProxy .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
GetVoiceConnectorStreamingConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
GetVoiceConnectorTermination .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
GetVoiceConnectorTerminationHealth .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
API Version 2018-05-01xii
Amazon Chime API Reference
See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214InviteUsers ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
ListAccounts .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
ListAttendees .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
ListAttendeeTags .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
ListBots .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
ListMeetings .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
ListMeetingTags .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
API Version 2018-05-01xiii
Amazon Chime API Reference
Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
ListPhoneNumberOrders ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
ListPhoneNumbers .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
ListProxySessions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
ListRoomMemberships .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
ListRooms .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
ListTagsForResource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
ListUsers ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
API Version 2018-05-01xiv
Amazon Chime API Reference
Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
ListVoiceConnectorGroups .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
ListVoiceConnectors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
ListVoiceConnectorTerminationCredentials ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
LogoutUser .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
PutEventsConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
PutRetentionSettings .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
API Version 2018-05-01xv
Amazon Chime API Reference
Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
PutVoiceConnectorLoggingConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
PutVoiceConnectorOrigination .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
PutVoiceConnectorProxy .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
PutVoiceConnectorStreamingConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
PutVoiceConnectorTermination .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
PutVoiceConnectorTerminationCredentials ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
API Version 2018-05-01xvi
Amazon Chime API Reference
RedactConversationMessage .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
RedactRoomMessage .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308
RegenerateSecurityToken .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311
ResetPersonalPIN .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315
RestorePhoneNumber .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
SearchAvailablePhoneNumbers .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322
TagAttendee .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
API Version 2018-05-01xvii
Amazon Chime API Reference
Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324
TagMeeting .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327
TagResource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330
UntagAttendee .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332
UntagMeeting .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335
UntagResource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337
UpdateAccount .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341
UpdateAccountSettings .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342
API Version 2018-05-01xviii
Amazon Chime API Reference
Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344
UpdateBot .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347
UpdateGlobalSettings .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351
UpdatePhoneNumber .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353Examples .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355
UpdatePhoneNumberSettings .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358
UpdateProxySession .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362
UpdateRoom ..... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365
API Version 2018-05-01xix
Amazon Chime API Reference
See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365UpdateRoomMembership .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367
Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370
UpdateUser .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 373See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374
UpdateUserSettings .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377
UpdateVoiceConnector ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380
UpdateVoiceConnectorGroup .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 383Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 383Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 384See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385
Data Types .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386Account .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388
Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389
AccountSettings .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390
AlexaForBusinessMetadata .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391
Attendee .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392
API Version 2018-05-01xx
Amazon Chime API Reference
Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392
Bot .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 394
BusinessCallingSettings .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395
ConversationRetentionSettings .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396
CreateAttendeeError ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397
CreateAttendeeRequestItem ..... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398
Credential ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399
EventsConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400
GeoMatchParams .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 401Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 401See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 401
Invite .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402
LoggingConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403
MediaPlacement .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405
Meeting .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406
MeetingNotificationConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407
Member .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408
MemberError ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410
MembershipItem ..... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411
OrderedPhoneNumber .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412
Origination .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413
OriginationRoute .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414
API Version 2018-05-01xxi
Amazon Chime API Reference
Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414
Participant .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416
PhoneNumber .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418
PhoneNumberAssociation .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419
PhoneNumberCapabilities ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420
PhoneNumberError ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422
PhoneNumberOrder .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 424
Proxy .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425
ProxySession .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428
RetentionSettings .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429
Room ..... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430
RoomMembership .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432
RoomRetentionSettings .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434
SigninDelegateGroup .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435
StreamingConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436
StreamingNotificationTarget .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437
Tag .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438
TelephonySettings .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439
Termination .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440
TerminationHealth .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442
API Version 2018-05-01xxii
Amazon Chime API Reference
Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442
UpdatePhoneNumberRequestItem ..... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443
UpdateUserRequestItem ..... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444
User .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 445Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 445See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 446
UserError ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448
UserSettings .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449
VoiceConnector ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451
VoiceConnectorGroup .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452
VoiceConnectorItem ..... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454
VoiceConnectorSettings .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455
Common Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456Common Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458
API Version 2018-05-01xxiii
Amazon Chime API Reference
WelcomeThe Amazon Chime API (application programming interface) is designed for developers to perform keytasks, such as creating and managing Amazon Chime accounts, users, and Voice Connectors. This guideprovides detailed information about the Amazon Chime API, including operations, types, inputs andoutputs, and error codes. It also includes some server-side API actions to use with the Amazon ChimeSDK. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in theAmazon Chime Developer Guide.
You can use an AWS SDK, the AWS Command Line Interface (AWS CLI), or the REST API to make API calls.We recommend using an AWS SDK or the AWS CLI. Each API operation includes links to informationabout using it 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 clientsauthenticate your requests by using access keys that you provide. For more information about AWSSDKs, 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 AWSCLI, see Installing the AWS Command Line Interface in the AWS Command Line Interface User Guide.For a list of available Amazon Chime commands, see the Amazon Chime commands in the AWS CLICommand Reference.
Using REST API
If you use REST to make API calls, you must authenticate your request by providing a signature.Amazon Chime supports signature version 4. For more information, see Signature Version 4 SigningProcess in the Amazon Web Services 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). Formore information, see Identity and Access Management for Amazon Chime in the Amazon ChimeAdministration Guide.
This document was last published on June 8, 2020.
API Version 2018-05-011
Amazon Chime API Reference
ActionsThe following actions are supported:
• AssociatePhoneNumbersWithVoiceConnector (p. 5)• AssociatePhoneNumbersWithVoiceConnectorGroup (p. 9)• AssociatePhoneNumberWithUser (p. 13)• AssociateSigninDelegateGroupsWithAccount (p. 16)• BatchCreateAttendee (p. 19)• BatchCreateRoomMembership (p. 22)• BatchDeletePhoneNumber (p. 26)• BatchSuspendUser (p. 29)• BatchUnsuspendUser (p. 33)• BatchUpdatePhoneNumber (p. 37)• BatchUpdateUser (p. 41)• CreateAccount (p. 45)• CreateAttendee (p. 49)• CreateBot (p. 52)• CreateMeeting (p. 56)• CreatePhoneNumberOrder (p. 60)• CreateProxySession (p. 64)• CreateRoom (p. 69)• CreateRoomMembership (p. 73)• CreateUser (p. 77)• CreateVoiceConnector (p. 81)• CreateVoiceConnectorGroup (p. 85)• DeleteAccount (p. 89)• DeleteAttendee (p. 92)• DeleteEventsConfiguration (p. 94)• DeleteMeeting (p. 96)• DeletePhoneNumber (p. 98)• DeleteProxySession (p. 101)• DeleteRoom (p. 104)• DeleteRoomMembership (p. 107)• DeleteVoiceConnector (p. 110)• DeleteVoiceConnectorGroup (p. 113)• DeleteVoiceConnectorOrigination (p. 116)• DeleteVoiceConnectorProxy (p. 119)• DeleteVoiceConnectorStreamingConfiguration (p. 122)• DeleteVoiceConnectorTermination (p. 125)• DeleteVoiceConnectorTerminationCredentials (p. 128)• DisassociatePhoneNumberFromUser (p. 131)• DisassociatePhoneNumbersFromVoiceConnector (p. 134)• DisassociatePhoneNumbersFromVoiceConnectorGroup (p. 137)
API Version 2018-05-012
Amazon Chime API Reference
• DisassociateSigninDelegateGroupsFromAccount (p. 140)• GetAccount (p. 143)• GetAccountSettings (p. 147)• GetAttendee (p. 150)• GetBot (p. 153)• GetEventsConfiguration (p. 156)• GetGlobalSettings (p. 159)• GetMeeting (p. 162)• GetPhoneNumber (p. 165)• GetPhoneNumberOrder (p. 168)• GetPhoneNumberSettings (p. 171)• GetProxySession (p. 174)• GetRetentionSettings (p. 178)• GetRoom (p. 181)• GetUser (p. 184)• GetUserSettings (p. 188)• GetVoiceConnector (p. 191)• GetVoiceConnectorGroup (p. 194)• GetVoiceConnectorLoggingConfiguration (p. 197)• GetVoiceConnectorOrigination (p. 200)• GetVoiceConnectorProxy (p. 203)• GetVoiceConnectorStreamingConfiguration (p. 206)• GetVoiceConnectorTermination (p. 209)• GetVoiceConnectorTerminationHealth (p. 212)• InviteUsers (p. 215)• ListAccounts (p. 219)• ListAttendees (p. 223)• ListAttendeeTags (p. 226)• ListBots (p. 229)• ListMeetings (p. 233)• ListMeetingTags (p. 236)• ListPhoneNumberOrders (p. 239)• ListPhoneNumbers (p. 242)• ListProxySessions (p. 246)• ListRoomMemberships (p. 250)• ListRooms (p. 254)• ListTagsForResource (p. 258)• ListUsers (p. 260)• ListVoiceConnectorGroups (p. 265)• ListVoiceConnectors (p. 268)• ListVoiceConnectorTerminationCredentials (p. 271)• LogoutUser (p. 274)• PutEventsConfiguration (p. 277)• PutRetentionSettings (p. 280)• PutVoiceConnectorLoggingConfiguration (p. 283)• PutVoiceConnectorOrigination (p. 286)
API Version 2018-05-013
Amazon Chime API Reference
• PutVoiceConnectorProxy (p. 290)• PutVoiceConnectorStreamingConfiguration (p. 294)• PutVoiceConnectorTermination (p. 298)• PutVoiceConnectorTerminationCredentials (p. 302)• RedactConversationMessage (p. 305)• RedactRoomMessage (p. 307)• RegenerateSecurityToken (p. 309)• ResetPersonalPIN (p. 312)• RestorePhoneNumber (p. 316)• SearchAvailablePhoneNumbers (p. 320)• TagAttendee (p. 323)• TagMeeting (p. 326)• TagResource (p. 329)• UntagAttendee (p. 331)• UntagMeeting (p. 334)• UntagResource (p. 336)• UpdateAccount (p. 338)• UpdateAccountSettings (p. 342)• UpdateBot (p. 345)• UpdateGlobalSettings (p. 349)• UpdatePhoneNumber (p. 352)• UpdatePhoneNumberSettings (p. 356)• UpdateProxySession (p. 359)• UpdateRoom (p. 363)• UpdateRoomMembership (p. 367)• UpdateUser (p. 371)• UpdateUserSettings (p. 375)• UpdateVoiceConnector (p. 378)• UpdateVoiceConnectorGroup (p. 382)
API Version 2018-05-014
Amazon Chime API ReferenceAssociatePhoneNumbersWithVoiceConnector
AssociatePhoneNumbersWithVoiceConnectorAssociates phone numbers with the specified Amazon Chime Voice Connector.
Request SyntaxPOST /voice-connectors/{voiceConnectorId}?operation=associate-phone-numbers HTTP/1.1Content-type: application/json
{ "E164PhoneNumbers": [ "string" ], "ForceAssociate": boolean}
URI Request ParametersThe request uses the following URI parameters.
voiceConnectorId (p. 5)
The Amazon Chime Voice Connector ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request accepts the following data in JSON format.
E164PhoneNumbers (p. 5)
List of phone numbers, in E.164 format.
Type: Array of strings
Pattern: ^\+?[1-9]\d{1,14}$
Required: NoForceAssociate (p. 5)
If true, associates the provided phone numbers with the provided Amazon Chime Voice Connectorand removes any previously existing associations. If false, does not associate any phone numbersthat have previously existing associations.
Type: Boolean
Required: No
Response SyntaxHTTP/1.1 200Content-type: application/json
API Version 2018-05-015
Amazon Chime API ReferenceResponse Elements
{ "PhoneNumberErrors": [ { "ErrorCode": "string", "ErrorMessage": "string", "PhoneNumberId": "string" } ]}
Response ElementsIf 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. 5)
If the action fails for one or more of the phone numbers in the request, a list of the phone numbersis returned, along with error codes and error messages.
Type: Array of PhoneNumberError (p. 422) objects
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
AccessDeniedException
You don't have permissions to perform the requested operation.
HTTP Status Code: 403BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
API Version 2018-05-016
Amazon Chime API ReferenceExample
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis 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.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20191028T184037ZAuthorization: AUTHPARAMSContent-Length: 78
{"E164PhoneNumbers": ["+12065550100", "+12065550101"], "ForceAssociate": true}
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: ac266ffd-3732-4a4a-b8dd-4b64399dde0cContent-Type: application/jsonContent-Length: 24Date: Mon, 28 Oct 2019 18:40:37 GMTConnection: keep-alive
{"PhoneNumberErrors":[]}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
API Version 2018-05-017
Amazon Chime API ReferenceSee Also
• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-018
Amazon Chime API ReferenceAssociatePhoneNumbersWithVoiceConnectorGroup
AssociatePhoneNumbersWithVoiceConnectorGroupAssociates phone numbers with the specified Amazon Chime Voice Connector group.
Request SyntaxPOST /voice-connector-groups/{voiceConnectorGroupId}?operation=associate-phone-numbers HTTP/1.1Content-type: application/json
{ "E164PhoneNumbers": [ "string" ], "ForceAssociate": boolean}
URI Request ParametersThe request uses the following URI parameters.
voiceConnectorGroupId (p. 9)
The Amazon Chime Voice Connector group ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request accepts the following data in JSON format.
E164PhoneNumbers (p. 9)
List of phone numbers, in E.164 format.
Type: Array of strings
Pattern: ^\+?[1-9]\d{1,14}$
Required: NoForceAssociate (p. 9)
If true, associates the provided phone numbers with the provided Amazon Chime Voice ConnectorGroup and removes any previously existing associations. If false, does not associate any phonenumbers that have previously existing associations.
Type: Boolean
Required: No
Response SyntaxHTTP/1.1 200Content-type: application/json
API Version 2018-05-019
Amazon Chime API ReferenceResponse Elements
{ "PhoneNumberErrors": [ { "ErrorCode": "string", "ErrorMessage": "string", "PhoneNumberId": "string" } ]}
Response ElementsIf 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. 9)
If the action fails for one or more of the phone numbers in the request, a list of the phone numbersis returned, along with error codes and error messages.
Type: Array of PhoneNumberError (p. 422) objects
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
AccessDeniedException
You don't have permissions to perform the requested operation.
HTTP Status Code: 403BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
API Version 2018-05-0110
Amazon Chime API ReferenceExample
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example associates the specified phone numbers with the specified Amazon Chime Voice Connectorgroup.
Sample Request
POST /voice-connector-groups/123a456b-c7d8-90e1-fg23-4h567jkl8901?operation=associate-phone-numbers HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20191028T185326ZAuthorization: AUTHPARAMSContent-Length: 78
{"E164PhoneNumbers": ["+12065550100", "+12065550101"], "ForceAssociate": true}
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: 96f64ec4-db6a-41c9-9315-2517fb130c80Content-Type: application/jsonContent-Length: 24Date: Mon, 28 Oct 2019 18:53:27 GMTConnection: keep-alive
{"PhoneNumberErrors":[]}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
API Version 2018-05-0111
Amazon Chime API ReferenceSee Also
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-0112
Amazon Chime API ReferenceAssociatePhoneNumberWithUser
AssociatePhoneNumberWithUserAssociates a phone number with the specified Amazon Chime user.
Request SyntaxPOST /accounts/accountId/users/{userId}?operation=associate-phone-number HTTP/1.1Content-type: application/json
{ "E164PhoneNumber": "string"}
URI Request ParametersThe request uses the following URI parameters.
accountId (p. 13)
The Amazon Chime account ID.
Required: YesuserId (p. 13)
The user ID.
Required: Yes
Request BodyThe request accepts the following data in JSON format.
E164PhoneNumber (p. 13)
The phone number, in E.164 format.
Type: String
Pattern: ^\+?[1-9]\d{1,14}$
Required: Yes
Response SyntaxHTTP/1.1 200
Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
API Version 2018-05-0113
Amazon Chime API ReferenceExample
AccessDeniedException
You don't have permissions to perform the requested operation.
HTTP Status Code: 403BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example associates the specified phone number with the specified Amazon Chime user.
API Version 2018-05-0114
Amazon Chime API ReferenceSee Also
Sample Request
POST /accounts/12a3456b-7c89-012d-3456-78901e23fg45/users/1ab2345c-67de-8901-f23g-45h678901j2k?operation=associate-phone-number HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20190918T181244ZAuthorization: AUTHPARAMSContent-Length: 35
{"E164PhoneNumber": "+12065550100"}
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: d70a1eae-c35a-4607-ac37-6e9a62f7c163Content-Type: application/jsonContent-Length: 2Date: Wed, 18 Sep 2019 18:12:45 GMTConnection: keep-alive
{}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-0115
Amazon Chime API ReferenceAssociateSigninDelegateGroupsWithAccount
AssociateSigninDelegateGroupsWithAccountAssociates the specified sign-in delegate groups with the specified Amazon Chime account.
Request SyntaxPOST /accounts/{accountId}?operation=associate-signin-delegate-groups HTTP/1.1Content-type: application/json
{ "SigninDelegateGroups": [ { "GroupName": "string" } ]}
URI Request ParametersThe request uses the following URI parameters.
accountId (p. 16)
The Amazon Chime account ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request accepts the following data in JSON format.
SigninDelegateGroups (p. 16)
The sign-in delegate groups.
Type: Array of SigninDelegateGroup (p. 435) objects
Required: Yes
Response SyntaxHTTP/1.1 200
Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
API Version 2018-05-0116
Amazon Chime API ReferenceExample
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis 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
API Version 2018-05-0117
Amazon Chime API ReferenceSee Also
Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.17.0 Python/3.8.0 Windows/10 botocore/1.14.0X-Amz-Date: 20200113T173245ZAUTHPARAMS
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: 7cf3751e-9371-47b2-8972-6d1dbbd9554bContent-Type: application/jsonContent-Length: 2Date: Mon, 13 Jan 2020 17:32:45 GMTConnection: keep-alive
{}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-0118
Amazon Chime API ReferenceBatchCreateAttendee
BatchCreateAttendeeCreates up to 100 new attendees for an active Amazon Chime SDK meeting. For more information aboutthe Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
Request SyntaxPOST /meetings/meetingId/attendees?operation=batch-create HTTP/1.1Content-type: application/json
{ "Attendees": [ { "ExternalUserId": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ]}
URI Request ParametersThe request uses the following URI parameters.
meetingId (p. 19)
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 BodyThe request accepts the following data in JSON format.
Attendees (p. 19)
The request containing the attendees to create.
Type: Array of CreateAttendeeRequestItem (p. 398) objects
Required: Yes
Response SyntaxHTTP/1.1 201Content-type: application/json
{ "Attendees": [
API Version 2018-05-0119
Amazon Chime API ReferenceResponse Elements
{ "AttendeeId": "string", "ExternalUserId": "string", "JoinToken": "string" } ], "Errors": [ { "ErrorCode": "string", "ErrorMessage": "string", "ExternalUserId": "string" } ]}
Response ElementsIf 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. 19)
The attendee information, including attendees IDs and join tokens.
Type: Array of Attendee (p. 392) objectsErrors (p. 19)
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. 397) objects
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ResourceLimitExceededException
The request exceeds the resource limit.
HTTP Status Code: 400
API Version 2018-05-0120
Amazon Chime API ReferenceSee Also
ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-0121
Amazon Chime API ReferenceBatchCreateRoomMembership
BatchCreateRoomMembershipAdds up to 50 members to a chat room in an Amazon Chime Enterprise account. Members can be eitherusers or bots. The member role designates whether the member is a chat room administrator or ageneral chat room member.
Request SyntaxPOST /accounts/accountId/rooms/roomId/memberships?operation=batch-create HTTP/1.1Content-type: application/json
{ "MembershipItemList": [ { "MemberId": "string", "Role": "string" } ]}
URI Request ParametersThe request uses the following URI parameters.
accountId (p. 22)
The Amazon Chime account ID.
Pattern: .*\S.*
Required: YesroomId (p. 22)
The room ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request accepts the following data in JSON format.
MembershipItemList (p. 22)
The list of membership items.
Type: Array of MembershipItem (p. 411) objects
Array Members: Maximum number of 50 items.
Required: Yes
Response SyntaxHTTP/1.1 201
API Version 2018-05-0122
Amazon Chime API ReferenceResponse Elements
Content-type: application/json
{ "Errors": [ { "ErrorCode": "string", "ErrorMessage": "string", "MemberId": "string" } ]}
Response ElementsIf 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. 22)
If the action fails for one or more of the member IDs in the request, a list of the member IDs isreturned, along with error codes and error messages.
Type: Array of MemberError (p. 410) objects
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
API Version 2018-05-0123
Amazon Chime API ReferenceExample
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example adds multiple users to the chat room as chat room members. It also assigns administratorand 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.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.293 Python/3.8.0 Windows/10 botocore/1.13.29X-Amz-Date: 20191202T224658ZAuthorization: AUTHPARAMSContent-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 Createdx-amzn-RequestId: 169ba401-d886-475f-8b3f-e01eac6fadfbContent-Type: application/jsonContent-Length: 13Date: Mon, 02 Dec 2019 22:46:58 GMTConnection: keep-alive
{"Errors":[]}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++
API Version 2018-05-0124
Amazon Chime API ReferenceSee Also
• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-0125
Amazon Chime API ReferenceBatchDeletePhoneNumber
BatchDeletePhoneNumberMoves phone numbers into the Deletion queue. Phone numbers must be disassociated from any users orAmazon Chime Voice Connectors before they can be deleted.
Phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.
Request SyntaxPOST /phone-numbers?operation=batch-delete HTTP/1.1Content-type: application/json
{ "PhoneNumberIds": [ "string" ]}
URI Request ParametersThe request does not use any URI parameters.
Request BodyThe request accepts the following data in JSON format.
PhoneNumberIds (p. 26)
List of phone number IDs.
Type: Array of strings
Array Members: Minimum number of 1 item.
Required: Yes
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "PhoneNumberErrors": [ { "ErrorCode": "string", "ErrorMessage": "string", "PhoneNumberId": "string" } ]}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
API Version 2018-05-0126
Amazon Chime API ReferenceErrors
PhoneNumberErrors (p. 26)
If the action fails for one or more of the phone numbers in the request, a list of the phone numbersis returned, along with error codes and error messages.
Type: Array of PhoneNumberError (p. 422) objects
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
API Version 2018-05-0127
Amazon Chime API ReferenceSee Also
tools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example moves multiple phone numbers into the Deletion queue.
Sample Request
POST /phone-numbers?operation=batch-delete HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20190918T195348ZAuthorization: AUTHPARAMSContent-Length: 56
{"PhoneNumberIds": ["%2B12065550100", "%2B12065550101"]}
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: f6ac5632-e71a-4755-997b-971c4dbff22cContent-Type: application/jsonContent-Length: 24Date: Wed, 18 Sep 2019 19:53:49 GMTConnection: keep-alive
{"PhoneNumberErrors":[]}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-0128
Amazon Chime API ReferenceBatchSuspendUser
BatchSuspendUserSuspends up to 50 users from a Team or EnterpriseLWA Amazon Chime account. For more informationabout different account types, see Managing Your Amazon Chime Accounts in the Amazon ChimeAdministration Guide.
Users suspended from a Team account are disassociated from the account, but they can continue to useAmazon Chime as free users. To remove the suspension from suspended Team account users, invite themto the Team account again. You can use the InviteUsers (p. 215) action to do so.
Users suspended from an EnterpriseLWA account are immediately signed out of Amazon Chime andcan no longer sign in. To remove the suspension from suspended EnterpriseLWA account users, use theBatchUnsuspendUser (p. 33) action.
To sign out users without suspending them, use the LogoutUser (p. 274) action.
Request SyntaxPOST /accounts/accountId/users?operation=suspend HTTP/1.1Content-type: application/json
{ "UserIdList": [ "string" ]}
URI Request ParametersThe request uses the following URI parameters.
accountId (p. 29)
The Amazon Chime account ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request accepts the following data in JSON format.
UserIdList (p. 29)
The request containing the user IDs to suspend.
Type: Array of strings
Array Members: Maximum number of 50 items.
Pattern: .*\S.*
Required: Yes
Response SyntaxHTTP/1.1 200
API Version 2018-05-0129
Amazon Chime API ReferenceResponse Elements
Content-type: application/json
{ "UserErrors": [ { "ErrorCode": "string", "ErrorMessage": "string", "UserId": "string" } ]}
Response ElementsIf 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. 29)
If the BatchSuspendUser (p. 29) action fails for one or more of the user IDs in the request, a list ofthe user IDs is returned, along with error codes and error messages.
Type: Array of UserError (p. 448) objects
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
API Version 2018-05-0130
Amazon Chime API ReferenceExample
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis 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.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.83 Python/3.6.6 Windows/10 botocore/1.12.73X-Amz-Date: 20190108T183005ZAuthorization: AUTHPARAMSContent-Length: 56
{"UserIdList": ["4ab2345c-67de-8901-f23g-45h678901j2k"]}
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: 5343c54a-eedf-487a-8178-38afb05c33efContent-Type: application/jsonContent-Length: 146Date: Tue, 08 Jan 2019 18:30:05 GMTConnection: keep-alive
{ "UserErrors": []}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++
API Version 2018-05-0131
Amazon Chime API ReferenceSee Also
• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-0132
Amazon Chime API ReferenceBatchUnsuspendUser
BatchUnsuspendUserRemoves the suspension from up to 50 previously suspended users for the specified Amazon ChimeEnterpriseLWA account. Only users on EnterpriseLWA accounts can be unsuspended using thisaction. For more information about different account types, see Managing Your Amazon Chime Accountsin 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 SyntaxPOST /accounts/accountId/users?operation=unsuspend HTTP/1.1Content-type: application/json
{ "UserIdList": [ "string" ]}
URI Request ParametersThe request uses the following URI parameters.
accountId (p. 33)
The Amazon Chime account ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request accepts the following data in JSON format.
UserIdList (p. 33)
The request containing the user IDs to unsuspend.
Type: Array of strings
Array Members: Maximum number of 50 items.
Pattern: .*\S.*
Required: Yes
Response SyntaxHTTP/1.1 200Content-type: application/json
{
API Version 2018-05-0133
Amazon Chime API ReferenceResponse Elements
"UserErrors": [ { "ErrorCode": "string", "ErrorMessage": "string", "UserId": "string" } ]}
Response ElementsIf 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. 33)
If the BatchUnsuspendUser (p. 33) action fails for one or more of the user IDs in the request, a listof the user IDs is returned, along with error codes and error messages.
Type: Array of UserError (p. 448) objects
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429
API Version 2018-05-0134
Amazon Chime API ReferenceExample
UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example removes the previous suspension for the listed users on the specified Amazon Chimeaccount.
Sample Request
POST /console/accounts/12a3456b-7c89-012d-3456-78901e23fg45/users?operation=unsuspend HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.83 Python/3.6.6 Windows/10 botocore/1.12.73X-Amz-Date: 20190108T220526ZAuthorization: AUTHPARAMSContent-Length: 96
{"UserIdList": ["1ab2345c-67de-8901-f23g-45h678901j2k", "2ab2345c-67de-8901-f23g-45h678901j2k", "3ab2345c-67de-8901-f23g-45h678901j2k"]}
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: d97c7380-cb87-40ce-b4c3-c250999a92dcContent-Type: application/jsonContent-Length: 17Date: Tue, 08 Jan 2019 22:05:26 GMTConnection: keep-alive
{ "UserErrors": []}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++
API Version 2018-05-0135
Amazon Chime API ReferenceSee Also
• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-0136
Amazon Chime API ReferenceBatchUpdatePhoneNumber
BatchUpdatePhoneNumberUpdates phone number product types or calling names. You can update one attribute at a time for eachUpdatePhoneNumberRequestItem. For example, you can update either the product type or the callingname.
For product types, choose from Amazon Chime Business Calling and Amazon Chime Voice Connector. Fortoll-free numbers, you must use the Amazon Chime Voice Connector product type.
Updates to outbound calling names can take up to 72 hours to complete. Pending updates to outboundcalling names must be complete before you can request another update.
Request SyntaxPOST /phone-numbers?operation=batch-update HTTP/1.1Content-type: application/json
{ "UpdatePhoneNumberRequestItems": [ { "CallingName": "string", "PhoneNumberId": "string", "ProductType": "string" } ]}
URI Request ParametersThe request does not use any URI parameters.
Request BodyThe request accepts the following data in JSON format.
UpdatePhoneNumberRequestItems (p. 37)
The request containing the phone number IDs and product types or calling names to update.
Type: Array of UpdatePhoneNumberRequestItem (p. 443) objects
Required: Yes
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "PhoneNumberErrors": [ { "ErrorCode": "string", "ErrorMessage": "string", "PhoneNumberId": "string"
API Version 2018-05-0137
Amazon Chime API ReferenceResponse Elements
} ]}
Response ElementsIf 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. 37)
If the action fails for one or more of the phone numbers in the request, a list of the phone numbersis returned, along with error codes and error messages.
Type: Array of PhoneNumberError (p. 422) objects
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400
ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
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.
API Version 2018-05-0138
Amazon Chime API ReferenceExamples
HTTP Status Code: 401
ExamplesIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
Example: Update Product TypesThis example updates the product type for multiple phone numbers.
Sample Request
POST /phone-numbers?operation=batch-update HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20190918T195200ZAuthorization: AUTHPARAMSContent-Length: 177
{"UpdatePhoneNumberRequestItems": [{"PhoneNumberId": "%2B12065550100", "ProductType": "BusinessCalling"}, {"PhoneNumberId": "%2B12065550101", "ProductType": "VoiceConnector"}]}
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: 78f4ee00-d8e0-4a13-b24e-147557576368Content-Type: application/jsonContent-Length: 24Date: Wed, 18 Sep 2019 19:52:01 GMTConnection: keep-alive
{"PhoneNumberErrors":[]}
Example: Update Outbound Calling NamesThis example updates the outbound calling name for multiple phone numbers.
Sample Request
POST /phone-numbers?operation=batch-update HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20191028T183405ZAuthorization: AUTHPARAMSContent-Length: 171
{"UpdatePhoneNumberRequestItems": [{"PhoneNumberId": "%2B12065550100", "CallingName": "phonenumber1"}, {"PhoneNumberId": "%2B12065550101", "CallingName": "phonenumber2"}]}
API Version 2018-05-0139
Amazon Chime API ReferenceSee Also
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: 32f678c1-21d2-43ab-ac8f-cd922c1ab42eContent-Type: application/jsonContent-Length: 24Date: Mon, 28 Oct 2019 18:34:05 GMTConnection: keep-alive
{"PhoneNumberErrors":[]}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-0140
Amazon Chime API ReferenceBatchUpdateUser
BatchUpdateUserUpdates user details within the UpdateUserRequestItem (p. 444) object for up to 20 users for thespecified Amazon Chime account. Currently, only LicenseType updates are supported for this action.
Request SyntaxPOST /accounts/accountId/users HTTP/1.1Content-type: application/json
{ "UpdateUserRequestItems": [ { "AlexaForBusinessMetadata": { "AlexaForBusinessRoomArn": "string", "IsAlexaForBusinessEnabled": boolean }, "LicenseType": "string", "UserId": "string", "UserType": "string" } ]}
URI Request ParametersThe request uses the following URI parameters.
accountId (p. 41)
The Amazon Chime account ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request accepts the following data in JSON format.
UpdateUserRequestItems (p. 41)
The request containing the user IDs and details to update.
Type: Array of UpdateUserRequestItem (p. 444) objects
Array Members: Maximum number of 20 items.
Required: Yes
Response SyntaxHTTP/1.1 200Content-type: application/json
API Version 2018-05-0141
Amazon Chime API ReferenceResponse Elements
{ "UserErrors": [ { "ErrorCode": "string", "ErrorMessage": "string", "UserId": "string" } ]}
Response ElementsIf 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 BatchUpdateUser (p. 41) action fails for one or more of the user IDs in the request, a list ofthe user IDs is returned, along with error codes and error messages.
Type: Array of UserError (p. 448) objects
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
API Version 2018-05-0142
Amazon Chime API ReferenceExample
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis 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.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.83 Python/3.6.6 Windows/10 botocore/1.12.73X-Amz-Date: 20190108T215856ZAuthorization: AUTHPARAMSContent-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 OKx-amzn-RequestId: 035a3bcd-1a1f-4ccc-bf7f-d2c9027637d2Content-Type: application/jsonContent-Length: 17Date: Tue, 08 Jan 2019 21:58:56 GMTConnection: keep-alive
{ "UserErrors": []}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++
API Version 2018-05-0143
Amazon Chime API ReferenceSee Also
• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-0144
Amazon Chime API ReferenceCreateAccount
CreateAccountCreates an Amazon Chime account under the administrator's AWS account. Only Team account types arecurrently supported for this action. For more information about different account types, see ManagingYour Amazon Chime Accounts in the Amazon Chime Administration Guide.
Request SyntaxPOST /accounts HTTP/1.1Content-type: application/json
{ "Name": "string"}
URI Request ParametersThe request does not use any URI parameters.
Request BodyThe request accepts the following data in JSON format.
Name (p. 45)
The name of the Amazon Chime account.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: .*\S.*
Required: Yes
Response SyntaxHTTP/1.1 201Content-type: application/json
{ "Account": { "AccountId": "string", "AccountType": "string", "AwsAccountId": "string", "CreatedTimestamp": number, "DefaultLicense": "string", "Name": "string", "SigninDelegateGroups": [ { "GroupName": "string" } ], "SupportedLicenses": [ "string" ] }}
API Version 2018-05-0145
Amazon Chime API ReferenceResponse Elements
Response ElementsIf 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. 45)
The Amazon Chime account details.
Type: Account (p. 388) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, see Signature Version 4 Signing Process in the AWS General Reference.
API Version 2018-05-0146
Amazon Chime API ReferenceSee Also
You only need to learn how to sign HTTP requests if you intend to manually create them. When you usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example creates a new Amazon Chime account under the administrator's AWS account.
Sample Request
POST /console/accounts HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.83 Python/3.6.6 Windows/10 botocore/1.12.73X-Amz-Date: 20190108T175917ZAuthorization: AUTHPARAMSContent-Length: 17
{"Name": "example"}
Sample Response
HTTP/1.1 201 Createdx-amzn-RequestId: d4f09103-9543-4ff9-b0a0-f1d4c6e2aec7Content-Type: application/jsonContent-Length: 422Date: Tue, 08 Jan 2019 17:59:18 GMTConnection: 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 AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go
API Version 2018-05-0147
Amazon Chime API ReferenceSee Also
• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-0148
Amazon Chime API ReferenceCreateAttendee
CreateAttendeeCreates a new attendee for an active Amazon Chime SDK meeting. For more information about theAmazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
Request SyntaxPOST /meetings/meetingId/attendees HTTP/1.1Content-type: application/json
{ "ExternalUserId": "string", "Tags": [ { "Key": "string", "Value": "string" } ]}
URI Request ParametersThe request uses the following URI parameters.
meetingId (p. 49)
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 BodyThe request accepts the following data in JSON format.
ExternalUserId (p. 49)
The Amazon Chime SDK external user ID. Links the attendee to an identity managed by a builderapplication.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 64.
Required: YesTags (p. 49)
The tag key-value pairs.
Type: Array of Tag (p. 438) objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: No
API Version 2018-05-0149
Amazon Chime API ReferenceResponse Syntax
Response SyntaxHTTP/1.1 201Content-type: application/json
{ "Attendee": { "AttendeeId": "string", "ExternalUserId": "string", "JoinToken": "string" }}
Response ElementsIf 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. 50)
The attendee information, including attendee ID and join token.
Type: Attendee (p. 392) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400
ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
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
API Version 2018-05-0150
Amazon Chime API ReferenceSee Also
ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-0151
Amazon Chime API ReferenceCreateBot
CreateBotCreates a bot for an Amazon Chime Enterprise account.
Request SyntaxPOST /accounts/accountId/bots HTTP/1.1Content-type: application/json
{ "DisplayName": "string", "Domain": "string"}
URI Request ParametersThe request uses the following URI parameters.
accountId (p. 52)
The Amazon Chime account ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request accepts the following data in JSON format.
DisplayName (p. 52)
The bot display name.
Type: String
Required: YesDomain (p. 52)
The domain of the Amazon Chime Enterprise account.
Type: String
Pattern: .*\S.*
Required: No
Response SyntaxHTTP/1.1 201Content-type: application/json
{ "Bot": {
API Version 2018-05-0152
Amazon Chime API ReferenceResponse Elements
"BotEmail": "string", "BotId": "string", "BotType": "string", "CreatedTimestamp": number, "Disabled": boolean, "DisplayName": "string", "SecurityToken": "string", "UpdatedTimestamp": number, "UserId": "string" }}
Response ElementsIf 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. 52)
The bot details.
Type: Bot (p. 393) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ResourceLimitExceededException
The request exceeds the resource limit.
HTTP Status Code: 400ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
API Version 2018-05-0153
Amazon Chime API ReferenceExample
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example creates a bot.
Sample Request
POST /accounts/12a3456b-7c89-012d-3456-78901e23fg45/bots HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20190918T172439ZAuthorization: AUTHPARAMSContent-Length: 60
{"DisplayName": "myBot", "Domain": "example.com"}
Sample Response
HTTP/1.1 201 Createdx-amzn-RequestId: 4c54e5bc-4ff5-4828-a222-59996acbc6eeContent-Type: application/jsonContent-Length: 374Date: Wed, 18 Sep 2019 17:24:39 GMTConnection: keep-alive
{"Bot":{"BotEmail":"[email protected]","BotId":"123abcd4-5ef6-789g-0h12-34j56789012k","BotType":"ChatBot","CreatedTimestamp":"2019-09-18T17:24:39.534Z","Disabled":false,"DisplayName":"myBot (Bot)","SecurityToken":"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY","UpdatedTimestamp":"2019-09-18T17:24:39.534Z","UserId":"123abcd4-5ef6-789g-0h12-34j56789012k"}}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
API Version 2018-05-0154
Amazon Chime API ReferenceSee Also
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-0155
Amazon Chime API ReferenceCreateMeeting
CreateMeetingCreates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees. Formore information about specifying media Regions, see Amazon Chime SDK Media Regions in the AmazonChime Developer Guide. For more information about the Amazon Chime SDK, see Using the AmazonChime SDK in the Amazon Chime Developer Guide.
Request SyntaxPOST /meetings HTTP/1.1Content-type: application/json
{ "ClientRequestToken": "string", "ExternalMeetingId": "string", "MediaRegion": "string", "MeetingHostId": "string", "NotificationsConfiguration": { "SnsTopicArn": "string", "SqsQueueArn": "string" }, "Tags": [ { "Key": "string", "Value": "string" } ]}
URI Request ParametersThe request does not use any URI parameters.
Request BodyThe request accepts the following data in JSON format.
ClientRequestToken (p. 56)
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: YesExternalMeetingId (p. 56)
The external meeting ID.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 64.
Required: No
API Version 2018-05-0156
Amazon Chime API ReferenceResponse Syntax
MediaRegion (p. 56)
The Region in which to create the meeting. Default: us-east-1.
Available values: ap-northeast-1, ap-southeast-1, ap-southeast-2, ca-central-1, eu-central-1, eu-north-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: NoMeetingHostId (p. 56)
Reserved.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 64.
Required: NoNotificationsConfiguration (p. 56)
The configuration for resource targets to receive notifications when meeting and attendee eventsoccur.
Type: MeetingNotificationConfiguration (p. 407) object
Required: NoTags (p. 56)
The tag key-value pairs.
Type: Array of Tag (p. 438) objects
Array Members: Minimum number of 1 item. Maximum number of 50 items.
Required: No
Response SyntaxHTTP/1.1 201Content-type: application/json
{ "Meeting": { "ExternalMeetingId": "string", "MediaPlacement": { "AudioFallbackUrl": "string", "AudioHostUrl": "string", "ScreenDataUrl": "string", "ScreenSharingUrl": "string", "ScreenViewingUrl": "string", "SignalingUrl": "string", "TurnControlUrl": "string" }, "MediaRegion": "string", "MeetingId": "string" }}
API Version 2018-05-0157
Amazon Chime API ReferenceResponse Elements
Response ElementsIf 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. 57)
The meeting information, including the meeting ID and MediaPlacement.
Type: Meeting (p. 406) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403ResourceLimitExceededException
The request exceeds the resource limit.
HTTP Status Code: 400ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
API Version 2018-05-0158
Amazon Chime API ReferenceSee Also
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-0159
Amazon Chime API ReferenceCreatePhoneNumberOrder
CreatePhoneNumberOrderCreates an order for phone numbers to be provisioned. Choose from Amazon Chime Business Calling andAmazon Chime Voice Connector product types. For toll-free numbers, you must use the Amazon ChimeVoice Connector product type.
Request SyntaxPOST /phone-number-orders HTTP/1.1Content-type: application/json
{ "E164PhoneNumbers": [ "string" ], "ProductType": "string"}
URI Request ParametersThe request does not use any URI parameters.
Request BodyThe request accepts the following data in JSON format.
E164PhoneNumbers (p. 60)
List of phone numbers, in E.164 format.
Type: Array of strings
Pattern: ^\+?[1-9]\d{1,14}$
Required: YesProductType (p. 60)
The phone number product type.
Type: String
Valid Values: BusinessCalling | VoiceConnector
Required: Yes
Response SyntaxHTTP/1.1 201Content-type: application/json
{ "PhoneNumberOrder": { "CreatedTimestamp": number, "OrderedPhoneNumbers": [ { "E164PhoneNumber": "string",
API Version 2018-05-0160
Amazon Chime API ReferenceResponse Elements
"Status": "string" } ], "PhoneNumberOrderId": "string", "ProductType": "string", "Status": "string", "UpdatedTimestamp": number }}
Response ElementsIf 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. 60)
The phone number order details.
Type: PhoneNumberOrder (p. 423) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
AccessDeniedException
You don't have permissions to perform the requested operation.
HTTP Status Code: 403BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403ResourceLimitExceededException
The request exceeds the resource limit.
HTTP Status Code: 400ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503
API Version 2018-05-0161
Amazon Chime API ReferenceExample
ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example creates an order for phone numbers to be provisioned.
Sample Request
POST /phone-number-orders HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20190918T175735ZAuthorization: AUTHPARAMSContent-Length: 88
{"ProductType": "BusinessCalling", "E164PhoneNumbers": ["+12065550100", "+12065550101"]}
Sample Response
HTTP/1.1 201 Createdx-amzn-RequestId: 7ac7b213-6e5d-4b2a-a142-ce9a7bb7e455Content-Type: application/jsonContent-Length: 366Date: Wed, 18 Sep 2019 17:57:43 GMTConnection: 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:57:43.110Z"}}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
API Version 2018-05-0162
Amazon Chime API ReferenceSee Also
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-0163
Amazon Chime API ReferenceCreateProxySession
CreateProxySessionCreates a proxy session on the specified Amazon Chime Voice Connector for the specified participantphone numbers.
Request SyntaxPOST /voice-connectors/voiceConnectorId/proxy-sessions HTTP/1.1Content-type: application/json
{ "Capabilities": [ "string" ], "ExpiryMinutes": number, "GeoMatchLevel": "string", "GeoMatchParams": { "AreaCode": "string", "Country": "string" }, "Name": "string", "NumberSelectionBehavior": "string", "ParticipantPhoneNumbers": [ "string" ]}
URI Request ParametersThe request uses the following URI parameters.
voiceConnectorId (p. 64)
The Amazon Chime voice connector ID.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: .*\S.*
Required: Yes
Request BodyThe request accepts the following data in JSON format.
Capabilities (p. 64)
The proxy session capabilities.
Type: Array of strings
Valid Values: Voice | SMS
Required: YesExpiryMinutes (p. 64)
The number of minutes allowed for the proxy session.
Type: Integer
Valid Range: Minimum value of 1.
API Version 2018-05-0164
Amazon Chime API ReferenceResponse Syntax
Required: NoGeoMatchLevel (p. 64)
The preference for matching the country or area code of the proxy phone number with that of thefirst participant.
Type: String
Valid Values: Country | AreaCode
Required: NoGeoMatchParams (p. 64)
The country and area code for the proxy phone number.
Type: GeoMatchParams (p. 401) object
Required: NoName (p. 64)
The name of the proxy session.
Type: String
Pattern: ^$|^[a-zA-Z0-9 ]{0,30}$
Required: NoNumberSelectionBehavior (p. 64)
The preference for proxy phone number reuse, or stickiness, between the same participants acrosssessions.
Type: String
Valid Values: PreferSticky | AvoidSticky
Required: NoParticipantPhoneNumbers (p. 64)
The participant phone numbers.
Type: Array of strings
Array Members: Fixed number of 2 items.
Pattern: ^\+?[1-9]\d{1,14}$
Required: Yes
Response SyntaxHTTP/1.1 201Content-type: application/json
{ "ProxySession": { "Capabilities": [ "string" ],
API Version 2018-05-0165
Amazon Chime API ReferenceResponse Elements
"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 ElementsIf 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. 65)
The proxy session details.
Type: ProxySession (p. 426) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
API Version 2018-05-0166
Amazon Chime API ReferenceExample
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example creates a proxy session on your Amazon Chime Voice Connector.
Sample Request
POST /voice-connectors/abcdef1ghij2klmno3pqr4/proxy-sessions HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.18.39 Python/3.8.0 Windows/10 botocore/1.15.39X-Amz-Date: 20200415T161009ZAuthorization: AUTHPARAMSContent-Length: 95
{"ParticipantPhoneNumbers": ["+14015550101", "+12065550100"], "Capabilities": ["Voice", "SMS"]}
Sample Response
HTTP/1.1 201 Createdx-amzn-RequestId: f40fe3fd-06fb-45e8-9d85-51833d44e651Content-Type: application/jsonContent-Length: 531Date: Wed, 15 Apr 2020 16:10:09 GMTConnection: keep-alive
{"ProxySession":{"Capabilities":["SMS","Voice"],"CreatedTimestamp":"2020-04-15T16:10:10.288Z","EndedTimestamp":null,"ExpiryMinutes":60,"GeoMatchLevel":null,"GeoMatchParams":null,"Name":null,"NumberSelectionBehavior":null,"Participants":[{"PhoneNumber":"+12065550100","ProxyPhoneNumber":"+19135550199"},
API Version 2018-05-0167
Amazon Chime API ReferenceSee Also
{"PhoneNumber":"+14015550101","ProxyPhoneNumber":"+19135550199"}],"ProxySessionId":"123a4bc5-67d8-901e-2f3g-h4ghjk56789l","Status":"Open","UpdatedTimestamp":"2020-04-15T16:10:10.288Z","VoiceConnectorId":"abcdef1ghij2klmno3pqr4"}}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-0168
Amazon Chime API ReferenceCreateRoom
CreateRoomCreates a chat room for the specified Amazon Chime Enterprise account.
Request SyntaxPOST /accounts/accountId/rooms HTTP/1.1Content-type: application/json
{ "ClientRequestToken": "string", "Name": "string"}
URI Request ParametersThe request uses the following URI parameters.
accountId (p. 69)
The Amazon Chime account ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request accepts the following data in JSON format.
ClientRequestToken (p. 69)
The idempotency token for the request.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 64.
Pattern: [-_a-zA-Z0-9]*
Required: NoName (p. 69)
The room name.
Type: String
Required: Yes
Response SyntaxHTTP/1.1 201Content-type: application/json
API Version 2018-05-0169
Amazon Chime API ReferenceResponse Elements
{ "Room": { "AccountId": "string", "CreatedBy": "string", "CreatedTimestamp": number, "Name": "string", "RoomId": "string", "UpdatedTimestamp": number }}
Response ElementsIf 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. 69)
The room details.
Type: Room (p. 430) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ResourceLimitExceededException
The request exceeds the resource limit.
HTTP Status Code: 400ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503
API Version 2018-05-0170
Amazon Chime API ReferenceExample
ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example creates a chat room for the specified Amazon Chime account with the name, chatRoom.
Sample Request
POST /accounts/12a3456b-7c89-012d-3456-78901e23fg45/rooms HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.293 Python/3.8.0 Windows/10 botocore/1.13.29X-Amz-Date: 20191202T222931ZAuthorization: AUTHPARAMSContent-Length: 82
{"Name": "chatRoom", "ClientRequestToken": "ab1234cd-56ef-7890-g1h2-34i56jkl789m"}
Sample Response
HTTP/1.1 201 Createdx-amzn-RequestId: 1f4415d8-2d40-4028-8088-72361d8bc4a9Content-Type: application/jsonContent-Length: 273Date: Mon, 02 Dec 2019 22:29:31 GMTConnection: 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-01f2-3g45h67i890j","UpdatedTimestamp":"2019-12-02T22:29:31.549Z"}}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
API Version 2018-05-0171
Amazon Chime API ReferenceSee Also
• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-0172
Amazon Chime API ReferenceCreateRoomMembership
CreateRoomMembershipAdds a member to a chat room in an Amazon Chime Enterprise account. A member can be either a useror a bot. The member role designates whether the member is a chat room administrator or a generalchat room member.
Request SyntaxPOST /accounts/accountId/rooms/roomId/memberships HTTP/1.1Content-type: application/json
{ "MemberId": "string", "Role": "string"}
URI Request ParametersThe request uses the following URI parameters.
accountId (p. 73)
The Amazon Chime account ID.
Pattern: .*\S.*
Required: YesroomId (p. 73)
The room ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request accepts the following data in JSON format.
MemberId (p. 73)
The Amazon Chime member ID (user ID or bot ID).
Type: String
Pattern: .*\S.*
Required: YesRole (p. 73)
The role of the member.
Type: String
Valid Values: Administrator | Member
Required: No
API Version 2018-05-0173
Amazon Chime API ReferenceResponse Syntax
Response SyntaxHTTP/1.1 201Content-type: application/json
{ "RoomMembership": { "InvitedBy": "string", "Member": { "AccountId": "string", "Email": "string", "FullName": "string", "MemberId": "string", "MemberType": "string" }, "Role": "string", "RoomId": "string", "UpdatedTimestamp": number }}
Response ElementsIf 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. 74)
The room membership details.
Type: RoomMembership (p. 432) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ConflictException
The request could not be processed because of conflict in the current state of the resource.
HTTP Status Code: 409ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404
API Version 2018-05-0174
Amazon Chime API ReferenceExample
ResourceLimitExceededException
The request exceeds the resource limit.
HTTP Status Code: 400ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis 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.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.293 Python/3.8.0 Windows/10 botocore/1.13.29X-Amz-Date: 20191202T223641ZAuthorization: AUTHPARAMSContent-Length: 52
{"MemberId": "1ab2345c-67de-8901-f23g-45h678901j2k"}
Sample Response
HTTP/1.1 201 Created
API Version 2018-05-0175
Amazon Chime API ReferenceSee Also
x-amzn-RequestId: 899d868f-767e-45f7-b516-7066985c96ffContent-Type: application/jsonContent-Length: 381Date: Mon, 02 Dec 2019 22:36:42 GMTConnection: 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":"Member","RoomId":"abcd1e2d-3e45-6789-01f2-3g45h67i890j","UpdatedTimestamp":"2019-12-02T22:36:41.969Z"}}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-0176
Amazon Chime API ReferenceCreateUser
CreateUserCreates a user under the specified Amazon Chime account.
Request SyntaxPOST /accounts/accountId/users?operation=create HTTP/1.1Content-type: application/json
{ "Email": "string", "Username": "string", "UserType": "string"}
URI Request ParametersThe request uses the following URI parameters.
accountId (p. 77)
The Amazon Chime account ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request accepts the following data in JSON format.
Email (p. 77)
The user's email address.
Type: String
Pattern: .+@.+\..+
Required: NoUsername (p. 77)
The user name.
Type: String
Required: NoUserType (p. 77)
The user type.
Type: String
Valid Values: PrivateUser | SharedDevice
Required: No
API Version 2018-05-0177
Amazon Chime API ReferenceResponse Syntax
Response SyntaxHTTP/1.1 201Content-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 ElementsIf 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. 78)
The user on the Amazon Chime account.
Type: User (p. 445) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ConflictException
The request could not be processed because of conflict in the current state of the resource.
HTTP Status Code: 409ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403
API Version 2018-05-0178
Amazon Chime API ReferenceExample
NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis 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.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.17.3 Python/3.8.0 Windows/10 botocore/1.14.3X-Amz-Date: 20200115T223809ZAUTHPARAMS
{"Email": "[email protected]", "UserType": "SharedDevice"}
Sample Response
HTTP/1.1 201 Createdx-amzn-RequestId: 4225c49a-307a-413b-bc8f-37bb145c1483
API Version 2018-05-0179
Amazon Chime API ReferenceSee Also
Content-Type: application/jsonContent-Length: 664Date: Wed, 15 Jan 2020 22:38:09 GMTConnection: keep-alive
{"User":{"AccountId":"12a3456b-7c89-012d-3456-78901e23fg45","AlexaForBusinessMetadata":{"AlexaForBusinessRoomArn":null,"IsAlexaForBusinessEnabled":false},"Delegates":null,"Devices":null,"DisplayName":"room device","EmailAlias":[],"FullName":"Room Device","InvitedOn":null,"IsProTrial":false,"LastActiveOn":null,"LicenseType":"Pro","PersonalPIN":null,"PresenceVisibility":null,"PrimaryEmail":"[email protected]","PrimaryProvisionedNumber":null,"RegisteredOn":"2020-01-15T22:38:09.806Z","UserId":"1ab2345c-67de-8901-f23g-45h678901j2k","UserInvitationStatus":null,"UserLocale":null,"UserRegistrationStatus":"Registered","UserType":"SharedDevice","Vanity":null}}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-0180
Amazon Chime API ReferenceCreateVoiceConnector
CreateVoiceConnectorCreates an Amazon Chime Voice Connector under the administrator's AWS account. You can choose tocreate an Amazon Chime Voice Connector in a specific AWS Region.
Enabling CreateVoiceConnector:RequireEncryption (p. 81) configures your Amazon Chime VoiceConnector to use TLS transport for SIP signaling and Secure RTP (SRTP) for media. Inbound calls use TLStransport, and unencrypted outbound calls are blocked.
Request SyntaxPOST /voice-connectors HTTP/1.1Content-type: application/json
{ "AwsRegion": "string", "Name": "string", "RequireEncryption": boolean}
URI Request ParametersThe request does not use any URI parameters.
Request BodyThe request accepts the following data in JSON format.
AwsRegion (p. 81)
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: NoName (p. 81)
The name of the Amazon Chime Voice Connector.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: YesRequireEncryption (p. 81)
When enabled, requires encryption for the Amazon Chime Voice Connector.
Type: Boolean
Required: Yes
Response SyntaxHTTP/1.1 201
API Version 2018-05-0181
Amazon Chime API ReferenceResponse Elements
Content-type: application/json
{ "VoiceConnector": { "AwsRegion": "string", "CreatedTimestamp": number, "Name": "string", "OutboundHostName": "string", "RequireEncryption": boolean, "UpdatedTimestamp": number, "VoiceConnectorId": "string" }}
Response ElementsIf 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. 81)
The Amazon Chime Voice Connector details.
Type: VoiceConnector (p. 450) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
AccessDeniedException
You don't have permissions to perform the requested operation.
HTTP Status Code: 403BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403ResourceLimitExceededException
The request exceeds the resource limit.
HTTP Status Code: 400ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
API Version 2018-05-0182
Amazon Chime API ReferenceExample
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example creates an Amazon Chime Voice Connector.
Sample Request
POST /voice-connectors HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20190918T203400ZAuthorization: AUTHPARAMSContent-Length: 82
{"Name": "newVoiceConnector", "AwsRegion": "us-west-2", "RequireEncryption": true}
Sample Response
HTTP/1.1 201 Createdx-amzn-RequestId: 3f08f447-316c-45a8-b3ad-12dec6231828Content-Type: application/jsonContent-Length: 301Date: Wed, 18 Sep 2019 20:34:01 GMTConnection: keep-alive
{"VoiceConnector":{"AwsRegion":"us-west-2","CreatedTimestamp":"2019-09-18T20:34:01.352Z","Name":"newVoiceConnector","OutboundHostName":"abcdef1ghij2klmno3pqr4.voiceconnector.chime.aws","RequireEncryption":true,"UpdatedTimestamp":"2019-09-18T20:34:01.352Z","VoiceConnectorId":"abcdef1ghij2klmno3pqr4"}}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
API Version 2018-05-0183
Amazon Chime API ReferenceSee Also
• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-0184
Amazon Chime API ReferenceCreateVoiceConnectorGroup
CreateVoiceConnectorGroupCreates an Amazon Chime Voice Connector group under the administrator's AWS account. You canassociate Amazon Chime Voice Connectors with the Amazon Chime Voice Connector group by includingVoiceConnectorItems in the request.
You can include Amazon Chime Voice Connectors from different AWS Regions in your group. This createsa fault tolerant mechanism for fallback in case of availability events.
Request SyntaxPOST /voice-connector-groups HTTP/1.1Content-type: application/json
{ "Name": "string", "VoiceConnectorItems": [ { "Priority": number, "VoiceConnectorId": "string" } ]}
URI Request ParametersThe request does not use any URI parameters.
Request BodyThe request accepts the following data in JSON format.
Name (p. 85)
The name of the Amazon Chime Voice Connector group.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: YesVoiceConnectorItems (p. 85)
The Amazon Chime Voice Connectors to route inbound calls to.
Type: Array of VoiceConnectorItem (p. 454) objects
Required: No
Response SyntaxHTTP/1.1 201Content-type: application/json
API Version 2018-05-0185
Amazon Chime API ReferenceResponse Elements
{ "VoiceConnectorGroup": { "CreatedTimestamp": number, "Name": "string", "UpdatedTimestamp": number, "VoiceConnectorGroupId": "string", "VoiceConnectorItems": [ { "Priority": number, "VoiceConnectorId": "string" } ] }}
Response ElementsIf 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. 85)
The Amazon Chime Voice Connector group details.
Type: VoiceConnectorGroup (p. 452) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
AccessDeniedException
You don't have permissions to perform the requested operation.
HTTP Status Code: 403BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403ResourceLimitExceededException
The request exceeds the resource limit.
HTTP Status Code: 400ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500
API Version 2018-05-0186
Amazon Chime API ReferenceExample
ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example creates an Amazon Chime Voice Connector group.
Sample Request
POST /voice-connector-groups HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20190918T163834ZAuthorization: AUTHPARAMSContent-Length: 107
{"Name": "myGroup", "VoiceConnectorItems": [{"VoiceConnectorId": "abcdef1ghij2klmno3pqr4", "Priority": 2}]}
Sample Response
HTTP/1.1 201 Createdx-amzn-RequestId: bb6c861a-bfb6-42d2-9655-898780f6e7f8Content-Type: application/jsonContent-Length: 222Date: Wed, 18 Sep 2019 16:38:33 GMTConnection: keep-alive
{"VoiceConnectorGroup":{"CreatedTimestamp":"2019-09-18T16:38:34.734Z","Name":"myGroup","UpdatedTimestamp":"2019-09-18T16:38:34.734Z","VoiceConnectorGroupId":"123a456b-c7d8-90e1-fg23-4h567jkl8901","VoiceConnectorItems":[]}}
API Version 2018-05-0187
Amazon Chime API ReferenceSee Also
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-0188
Amazon Chime API ReferenceDeleteAccount
DeleteAccountDeletes the specified Amazon Chime account. You must suspend all users before deleting a Teamaccount. You can use the BatchSuspendUser (p. 29) action to do so.
For EnterpriseLWA and EnterpriseAD accounts, you must release the claimed domains for yourAmazon Chime account before deletion. As soon as you release the domain, all users under that accountare suspended.
Deleted accounts appear in your Disabled accounts list for 90 days. To restore a deleted account fromyour Disabled accounts list, you must contact AWS Support.
After 90 days, deleted accounts are permanently removed from your Disabled accounts list.
Request SyntaxDELETE /accounts/accountId HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
accountId (p. 89)
The Amazon Chime account ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 204
Response ElementsIf the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400
API Version 2018-05-0189
Amazon Chime API ReferenceExample
ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401UnprocessableEntityException
The request was well-formed but was unable to be followed due to semantic errors.
HTTP Status Code: 422
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example deletes the specified account.
Sample Request
DELETE /console/accounts/12a3456b-7c89-012d-3456-78901e23fg45 HTTP/1.1Host: service.chime.aws.amazon.com
API Version 2018-05-0190
Amazon Chime API ReferenceSee Also
Accept-Encoding: identityUser-Agent: aws-cli/1.16.83 Python/3.6.6 Windows/10 botocore/1.12.73X-Amz-Date: 20190108T180112ZAuthorization: AUTHPARAMSContent-Length: 0
Sample Response
HTTP/1.1 204 No Contentx-amzn-RequestId: ac41c46f-e26f-4cc1-a9cf-c6056e743647Content-Type: application/jsonDate: Tue, 08 Jan 2019 18:01:13 GMTConnection: keep-alive
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-0191
Amazon Chime API ReferenceDeleteAttendee
DeleteAttendeeDeletes 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 moreinformation about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon ChimeDeveloper Guide.
Request SyntaxDELETE /meetings/meetingId/attendees/attendeeId HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
attendeeId (p. 92)
The Amazon Chime SDK attendee ID.
Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}
Required: YesmeetingId (p. 92)
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 BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 204
Response ElementsIf the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400
API Version 2018-05-0192
Amazon Chime API ReferenceSee Also
ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-0193
Amazon Chime API ReferenceDeleteEventsConfiguration
DeleteEventsConfigurationDeletes the events configuration that allows a bot to receive outgoing events.
Request SyntaxDELETE /accounts/accountId/bots/botId/events-configuration HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
accountId (p. 94)
The Amazon Chime account ID.
Pattern: .*\S.*
Required: YesbotId (p. 94)
The bot ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 204
Response ElementsIf the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
API Version 2018-05-0194
Amazon Chime API ReferenceSee Also
HTTP Status Code: 403ResourceLimitExceededException
The request exceeds the resource limit.
HTTP Status Code: 400ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-0195
Amazon Chime API ReferenceDeleteMeeting
DeleteMeetingDeletes the specified Amazon Chime SDK meeting. When a meeting is deleted, its attendees are alsodeleted and clients can no longer join it. For more information about the Amazon Chime SDK, see Usingthe Amazon Chime SDK in the Amazon Chime Developer Guide.
Request SyntaxDELETE /meetings/meetingId HTTP/1.1
URI Request ParametersThe 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 BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 204
Response ElementsIf the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
API Version 2018-05-0196
Amazon Chime API ReferenceSee Also
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-0197
Amazon Chime API ReferenceDeletePhoneNumber
DeletePhoneNumberMoves the specified phone number into the Deletion queue. A phone number must be disassociatedfrom 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 SyntaxDELETE /phone-numbers/phoneNumberId HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
phoneNumberId (p. 98)
The phone number ID.
Required: Yes
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 204
Response ElementsIf the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
API Version 2018-05-0198
Amazon Chime API ReferenceExample
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
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example moves the specified phone number into the Deletion queue.
Sample Request
DELETE /phone-numbers/%2B12065550100 HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20190918T182415ZAuthorization: AUTHPARAMSContent-Length: 0
Sample Response
HTTP/1.1 204 No Contentx-amzn-RequestId: 9b914fc0-4d11-4194-81be-17601c896259Content-Type: application/jsonDate: Wed, 18 Sep 2019 18:24:16 GMTConnection: keep-alive
API Version 2018-05-0199
Amazon Chime API ReferenceSee Also
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01100
Amazon Chime API ReferenceDeleteProxySession
DeleteProxySessionDeletes the specified proxy session from the specified Amazon Chime Voice Connector.
Request SyntaxDELETE /voice-connectors/voiceConnectorId/proxy-sessions/proxySessionId HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
proxySessionId (p. 101)
The proxy session ID.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: .*\S.*
Required: YesvoiceConnectorId (p. 101)
The Amazon Chime voice connector ID.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: .*\S.*
Required: Yes
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 204
Response ElementsIf the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400
API Version 2018-05-01101
Amazon Chime API ReferenceExample
ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis 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.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.18.39 Python/3.8.0 Windows/10 botocore/1.15.39X-Amz-Date: 20200415T161710ZAuthorization: AUTHPARAMSContent-Length: 0
API Version 2018-05-01102
Amazon Chime API ReferenceSee Also
Sample Response
HTTP/1.1 204 No Contentx-amzn-RequestId: 05a30cbd-828d-4913-8c26-0d1d3252a406Content-Type: application/jsonDate: Wed, 15 Apr 2020 16:17:10 GMTConnection: keep-alive
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01103
Amazon Chime API ReferenceDeleteRoom
DeleteRoomDeletes a chat room in an Amazon Chime Enterprise account.
Request SyntaxDELETE /accounts/accountId/rooms/roomId HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
accountId (p. 104)
The Amazon Chime account ID.
Pattern: .*\S.*
Required: YesroomId (p. 104)
The chat room ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 204
Response ElementsIf the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
API Version 2018-05-01104
Amazon Chime API ReferenceExample
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis 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.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.293 Python/3.8.0 Windows/10 botocore/1.13.29X-Amz-Date: 20191202T225016ZAuthorization: AUTHPARAMSContent-Length: 0
Sample Response
HTTP/1.1 204 No Content
API Version 2018-05-01105
Amazon Chime API ReferenceSee Also
x-amzn-RequestId: bb7b039d-e94d-4390-803a-da3ef32c85c5Content-Type: application/jsonDate: Mon, 02 Dec 2019 22:50:16 GMTConnection: keep-alive
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01106
Amazon Chime API ReferenceDeleteRoomMembership
DeleteRoomMembershipRemoves a member from a chat room in an Amazon Chime Enterprise account.
Request SyntaxDELETE /accounts/accountId/rooms/roomId/memberships/memberId HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
accountId (p. 107)
The Amazon Chime account ID.
Pattern: .*\S.*
Required: YesmemberId (p. 107)
The member ID (user ID or bot ID).
Pattern: .*\S.*
Required: YesroomId (p. 107)
The room ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 204
Response ElementsIf the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
API Version 2018-05-01107
Amazon Chime API ReferenceExample
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis 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.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.293 Python/3.8.0 Windows/10 botocore/1.13.29X-Amz-Date: 20191202T224215Z
API Version 2018-05-01108
Amazon Chime API ReferenceSee Also
Authorization: AUTHPARAMSContent-Length: 0
Sample Response
HTTP/1.1 204 No Contentx-amzn-RequestId: ef9a1046-4fe3-4014-b27b-eef82fb23878Content-Type: application/jsonDate: Mon, 02 Dec 2019 22:42:15 GMTConnection: keep-alive
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01109
Amazon Chime API ReferenceDeleteVoiceConnector
DeleteVoiceConnectorDeletes the specified Amazon Chime Voice Connector. Any phone numbers associated with the AmazonChime Voice Connector must be disassociated from it before it can be deleted.
Request SyntaxDELETE /voice-connectors/voiceConnectorId HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
voiceConnectorId (p. 110)
The Amazon Chime Voice Connector ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 204
Response ElementsIf the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ConflictException
The request could not be processed because of conflict in the current state of the resource.
HTTP Status Code: 409ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
API Version 2018-05-01110
Amazon Chime API ReferenceExample
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example deletes the specified Amazon Chime Voice Connector.
Sample Request
DELETE /voice-connectors/abcdef1ghij2klmno3pqr4 HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20190918T204258ZAuthorization: AUTHPARAMSContent-Length: 0
Sample Response
HTTP/1.1 204 No Contentx-amzn-RequestId: eae708a7-2bd5-4248-8c56-12eea3b042cc
API Version 2018-05-01111
Amazon Chime API ReferenceSee Also
Content-Type: application/jsonDate: Wed, 18 Sep 2019 20:42:59 GMTConnection: keep-alive
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01112
Amazon Chime API ReferenceDeleteVoiceConnectorGroup
DeleteVoiceConnectorGroupDeletes the specified Amazon Chime Voice Connector group. Any VoiceConnectorItems and phonenumbers associated with the group must be removed before it can be deleted.
Request SyntaxDELETE /voice-connector-groups/voiceConnectorGroupId HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
voiceConnectorGroupId (p. 113)
The Amazon Chime Voice Connector group ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 204
Response ElementsIf the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ConflictException
The request could not be processed because of conflict in the current state of the resource.
HTTP Status Code: 409ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
API Version 2018-05-01113
Amazon Chime API ReferenceExample
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example deletes the specified Amazon Chime Voice Connector group.
Sample Request
DELETE /voice-connector-groups/123a456b-c7d8-90e1-fg23-4h567jkl8901 HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20191029T182127ZAuthorization: AUTHPARAMSContent-Length: 0
Sample Response
HTTP/1.1 204 No Contentx-amzn-RequestId: eb11efad-b9e3-4353-a839-33e100177e94
API Version 2018-05-01114
Amazon Chime API ReferenceSee Also
Content-Type: application/jsonDate: Tue, 29 Oct 2019 18:21:27 GMTConnection: keep-alive
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01115
Amazon Chime API ReferenceDeleteVoiceConnectorOrigination
DeleteVoiceConnectorOriginationDeletes the origination settings for the specified Amazon Chime Voice Connector.
Request SyntaxDELETE /voice-connectors/voiceConnectorId/origination HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
voiceConnectorId (p. 116)
The Amazon Chime Voice Connector ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 204
Response ElementsIf the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
API Version 2018-05-01116
Amazon Chime API ReferenceExample
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
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example deletes the origination settings for the specified Amazon Chime Voice Connector.
Sample Request
DELETE /voice-connectors/abcdef1ghij2klmno3pqr4/origination HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20190823T183010ZAuthorization: AUTHPARAMSContent-Length: 0
Sample Response
HTTP/1.1 204 No Contentx-amzn-RequestId: 40326e8d-f4e9-454f-9858-032be0b50b49Content-Type: application/jsonDate: Fri, 23 Aug 2019 18:30:10 GMTConnection: keep-alive
API Version 2018-05-01117
Amazon Chime API ReferenceSee Also
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01118
Amazon Chime API ReferenceDeleteVoiceConnectorProxy
DeleteVoiceConnectorProxyDeletes the proxy configuration from the specified Amazon Chime Voice Connector.
Request SyntaxDELETE /voice-connectors/voiceConnectorId/programmable-numbers/proxy HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
voiceConnectorId (p. 119)
The Amazon Chime Voice Connector ID.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: .*\S.*
Required: Yes
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 204
Response ElementsIf the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
API Version 2018-05-01119
Amazon Chime API ReferenceExample
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
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example deletes a proxy configuration from your Amazon Chime Voice Connector.
Sample Request
DELETE /voice-connectors/abcdef1ghij2klmno3pqr4/programmable-numbers/proxy HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.18.39 Python/3.8.0 Windows/10 botocore/1.15.39X-Amz-Date: 20200415T161917ZAuthorization: AUTHPARAMSContent-Length: 0
Sample Response
HTTP/1.1 204 No Contentx-amzn-RequestId: 8c961245-2db3-4e6e-9e54-8b97f517585dContent-Type: application/jsonDate: Wed, 15 Apr 2020 16:19:17 GMTConnection: keep-alive
API Version 2018-05-01120
Amazon Chime API ReferenceSee Also
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01121
Amazon Chime API ReferenceDeleteVoiceConnectorStreamingConfiguration
DeleteVoiceConnectorStreamingConfigurationDeletes the streaming configuration for the specified Amazon Chime Voice Connector.
Request SyntaxDELETE /voice-connectors/voiceConnectorId/streaming-configuration HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
voiceConnectorId (p. 122)
The Amazon Chime Voice Connector ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 204
Response ElementsIf the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
API Version 2018-05-01122
Amazon Chime API ReferenceExample
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
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example deletes the streaming configuration for the specified Amazon Chime Voice Connector.
Sample Request
DELETE /voice-connectors/abcdef1ghij2klmno3pqr4/streaming-configuration HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20190918T163300ZAuthorization: AUTHPARAMSContent-Length: 0
Sample Response
HTTP/1.1 204 No Contentx-amzn-RequestId: 5402d7e9-534e-4db7-9011-56d71ae221beContent-Type: application/jsonDate: Wed, 18 Sep 2019 16:33:00 GMTConnection: keep-alive
API Version 2018-05-01123
Amazon Chime API ReferenceSee Also
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01124
Amazon Chime API ReferenceDeleteVoiceConnectorTermination
DeleteVoiceConnectorTerminationDeletes the termination settings for the specified Amazon Chime Voice Connector.
Request SyntaxDELETE /voice-connectors/voiceConnectorId/termination HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
voiceConnectorId (p. 125)
The Amazon Chime Voice Connector ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 204
Response ElementsIf the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
API Version 2018-05-01125
Amazon Chime API ReferenceExample
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
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example deletes the termination settings for the specified Amazon Chime Voice Connector.
Sample Request
DELETE /voice-connectors/abcdef1ghij2klmno3pqr4/termination HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20190823T183531ZAuthorization: AUTHPARAMSContent-Length: 0
Sample Response
HTTP/1.1 204 No Contentx-amzn-RequestId: 651ab557-2123-42d9-89ad-ba4cd951dbceContent-Type: application/jsonDate: Fri, 23 Aug 2019 18:35:31 GMTConnection: keep-alive
API Version 2018-05-01126
Amazon Chime API ReferenceSee Also
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01127
Amazon Chime API ReferenceDeleteVoiceConnectorTerminationCredentials
DeleteVoiceConnectorTerminationCredentialsDeletes the specified SIP credentials used by your equipment to authenticate during call termination.
Request SyntaxPOST /voice-connectors/voiceConnectorId/termination/credentials?operation=delete HTTP/1.1Content-type: application/json
{ "Usernames": [ "string" ]}
URI Request ParametersThe request uses the following URI parameters.
voiceConnectorId (p. 128)
The Amazon Chime Voice Connector ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request accepts the following data in JSON format.
Usernames (p. 128)
The RFC2617 compliant username associated with the SIP credentials, in US-ASCII format.
Type: Array of strings
Required: No
Response SyntaxHTTP/1.1 204
Response ElementsIf the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
API Version 2018-05-01128
Amazon Chime API ReferenceExample
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example deletes the specified SIP credentials.
Sample Request
POST /voice-connectors/abcdef1ghij2klmno3pqr4/termination/credentials?operation=delete HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20190823T184644ZAuthorization: AUTHPARAMS
API Version 2018-05-01129
Amazon Chime API ReferenceSee Also
Content-Length: 27
{"Usernames": ["jdoe"]}
Sample Response
HTTP/1.1 204 No Contentx-amzn-RequestId: a5b5b585-3bd1-44fe-9adc-e15b8a0ec39aContent-Type: application/jsonDate: Fri, 23 Aug 2019 18:46:44 GMTConnection: keep-alive
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01130
Amazon Chime API ReferenceDisassociatePhoneNumberFromUser
DisassociatePhoneNumberFromUserDisassociates the primary provisioned phone number from the specified Amazon Chime user.
Request SyntaxPOST /accounts/accountId/users/{userId}?operation=disassociate-phone-number HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
accountId (p. 131)
The Amazon Chime account ID.
Required: YesuserId (p. 131)
The user ID.
Required: Yes
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200
Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403
API Version 2018-05-01131
Amazon Chime API ReferenceExample
NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example disassociates the primary provisioned phone number from the specified Amazon Chimeuser.
Sample Request
POST /accounts/12a3456b-7c89-012d-3456-78901e23fg45/users/1ab2345c-67de-8901-f23g-45h678901j2k?operation=disassociate-phone-number HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20190918T181957ZAuthorization: AUTHPARAMSContent-Length: 0
Sample Response
HTTP/1.1 200 OK
API Version 2018-05-01132
Amazon Chime API ReferenceSee Also
x-amzn-RequestId: 91c771a6-5816-4a6a-95aa-2c3ba9d36862Content-Type: application/jsonContent-Length: 2Date: Wed, 18 Sep 2019 18:19:57 GMTConnection: keep-alive
{}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01133
Amazon Chime API ReferenceDisassociatePhoneNumbersFromVoiceConnector
DisassociatePhoneNumbersFromVoiceConnectorDisassociates the specified phone numbers from the specified Amazon Chime Voice Connector.
Request SyntaxPOST /voice-connectors/{voiceConnectorId}?operation=disassociate-phone-numbers HTTP/1.1Content-type: application/json
{ "E164PhoneNumbers": [ "string" ]}
URI Request ParametersThe request uses the following URI parameters.
voiceConnectorId (p. 134)
The Amazon Chime Voice Connector ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request accepts the following data in JSON format.
E164PhoneNumbers (p. 134)
List of phone numbers, in E.164 format.
Type: Array of strings
Pattern: ^\+?[1-9]\d{1,14}$
Required: No
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "PhoneNumberErrors": [ { "ErrorCode": "string", "ErrorMessage": "string", "PhoneNumberId": "string" } ]}
API Version 2018-05-01134
Amazon Chime API ReferenceResponse Elements
Response ElementsIf 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. 134)
If the action fails for one or more of the phone numbers in the request, a list of the phone numbersis returned, along with error codes and error messages.
Type: Array of PhoneNumberError (p. 422) objects
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400
ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
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
API Version 2018-05-01135
Amazon Chime API ReferenceExample
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example disassociates the specified phone numbers from the specified Amazon Chime VoiceConnector.
Sample Request
POST /voice-connectors/abcdef1ghij2klmno3pqr4?operation=disassociate-phone-numbers HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20190918T193932ZAuthorization: AUTHPARAMSContent-Length: 38
{"E164PhoneNumbers": ["+12065550100"]}
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: aad4c082-8338-47e0-959a-f41fd9f2719fContent-Type: application/jsonContent-Length: 24Date: Wed, 18 Sep 2019 19:39:33 GMTConnection: keep-alive
{"PhoneNumberErrors":[]}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01136
Amazon Chime API ReferenceDisassociatePhoneNumbersFromVoiceConnectorGroup
DisassociatePhoneNumbersFromVoiceConnectorGroupDisassociates 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.1Content-type: application/json
{ "E164PhoneNumbers": [ "string" ]}
URI Request ParametersThe request uses the following URI parameters.
voiceConnectorGroupId (p. 137)
The Amazon Chime Voice Connector group ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request accepts the following data in JSON format.
E164PhoneNumbers (p. 137)
List of phone numbers, in E.164 format.
Type: Array of strings
Pattern: ^\+?[1-9]\d{1,14}$
Required: No
Response Syntax
HTTP/1.1 200Content-type: application/json
{ "PhoneNumberErrors": [ { "ErrorCode": "string", "ErrorMessage": "string", "PhoneNumberId": "string" } ]
API Version 2018-05-01137
Amazon Chime API ReferenceResponse Elements
}
Response ElementsIf 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. 137)
If the action fails for one or more of the phone numbers in the request, a list of the phone numbersis returned, along with error codes and error messages.
Type: Array of PhoneNumberError (p. 422) objects
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400
ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
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
API Version 2018-05-01138
Amazon Chime API ReferenceExample
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example disassociates the specified phone numbers from the specified Amazon Chime VoiceConnector group.
Sample Request
POST /voice-connector-groups/123a456b-c7d8-90e1-fg23-4h567jkl8901?operation=disassociate-phone-numbers HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20191028T190806ZAuthorization: AUTHPARAMSContent-Length: 54
{"E164PhoneNumbers": ["+12065550100", "+12065550101"]}
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: 30399d07-5e83-4235-8972-b113b491dd68Content-Type: application/jsonContent-Length: 24Date: Mon, 28 Oct 2019 19:08:06 GMTConnection: keep-alive
{"PhoneNumberErrors":[]}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01139
Amazon Chime API ReferenceDisassociateSigninDelegateGroupsFromAccount
DisassociateSigninDelegateGroupsFromAccountDisassociates the specified sign-in delegate groups from the specified Amazon Chime account.
Request SyntaxPOST /accounts/{accountId}?operation=disassociate-signin-delegate-groups HTTP/1.1Content-type: application/json
{ "GroupNames": [ "string" ]}
URI Request ParametersThe request uses the following URI parameters.
accountId (p. 140)
The Amazon Chime account ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request accepts the following data in JSON format.
GroupNames (p. 140)
The sign-in delegate group names.
Type: Array of strings
Array Members: Minimum number of 1 item.
Required: Yes
Response SyntaxHTTP/1.1 200
Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
API Version 2018-05-01140
Amazon Chime API ReferenceExample
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example disassociates the specified sign-in delegate group from the specified Amazon Chimeaccount.
Sample Request
POST /accounts/12a3456b-7c89-012d-3456-78901e23fg45?operation=disassociate-signin-delegate-groups HTTP/1.1
API Version 2018-05-01141
Amazon Chime API ReferenceSee Also
Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.17.0 Python/3.8.0 Windows/10 botocore/1.14.0X-Amz-Date: 20200113T173832ZAUTHPARAMS
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: 53abc648-2d5a-4e21-b077-39099183a769Content-Type: application/jsonContent-Length: 2Date: Mon, 13 Jan 2020 17:38:32 GMTConnection: keep-alive
{}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01142
Amazon Chime API ReferenceGetAccount
GetAccountRetrieves details for the specified Amazon Chime account, such as account type and supported licenses.
Request SyntaxGET /accounts/accountId HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
accountId (p. 143)
The Amazon Chime account ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "Account": { "AccountId": "string", "AccountType": "string", "AwsAccountId": "string", "CreatedTimestamp": number, "DefaultLicense": "string", "Name": "string", "SigninDelegateGroups": [ { "GroupName": "string" } ], "SupportedLicenses": [ "string" ] }}
Response ElementsIf 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. 143)
The Amazon Chime account details.
API Version 2018-05-01143
Amazon Chime API ReferenceErrors
Type: Account (p. 388) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example retrieves details for the specified Amazon Chime account.
API Version 2018-05-01144
Amazon Chime API ReferenceSee Also
Sample Request
GET /console/accounts/12a3456b-7c89-012d-3456-78901e23fg45 HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.83 Python/3.6.6 Windows/10 botocore/1.12.73X-Amz-Date: 20190108T180420ZAuthorization: AUTHPARAMS
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: bd51dac3-b142-405c-ab02-c9d0373ca476Content-Type: application/jsonContent-Length: 544Date: Tue, 08 Jan 2019 18:04:20 GMTConnection: 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 AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01145
Amazon Chime API ReferenceSee Also
API Version 2018-05-01146
Amazon Chime API ReferenceGetAccountSettings
GetAccountSettingsRetrieves 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 ChimeAdministration Guide.
Request SyntaxGET /accounts/accountId/settings HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
accountId (p. 147)
The Amazon Chime account ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "AccountSettings": { "DisableRemoteControl": boolean, "EnableDialOut": boolean }}
Response ElementsIf 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. 147)
The Amazon Chime account settings.
Type: AccountSettings (p. 390) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
API Version 2018-05-01147
Amazon Chime API ReferenceExample
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example retrieves account settings for the specified account.
Sample Request
GET /console/accounts/12a3456b-7c89-012d-3456-78901e23fg45/settings HTTP/1.1Host: service.chime.aws.amazon.com
API Version 2018-05-01148
Amazon Chime API ReferenceSee Also
Accept-Encoding: identityUser-Agent: aws-cli/1.16.83 Python/3.6.6 Windows/10 botocore/1.12.73X-Amz-Date: 20190108T180532ZAuthorization: AUTHPARAMS
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: 109d8cac-ab8b-4bf2-9254-c078ba2d9534Content-Type: application/jsonContent-Length: 117Date: Tue, 08 Jan 2019 18:05:33 GMTConnection: keep-alive
{ "AccountSettings": { "DisableRemoteControl": false, "EnableDialOut": false }}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01149
Amazon Chime API ReferenceGetAttendee
GetAttendeeGets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID. For moreinformation about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon ChimeDeveloper Guide.
Request SyntaxGET /meetings/meetingId/attendees/attendeeId HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
attendeeId (p. 150)
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. 150)
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 BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "Attendee": { "AttendeeId": "string", "ExternalUserId": "string", "JoinToken": "string" }}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
API Version 2018-05-01150
Amazon Chime API ReferenceErrors
Attendee (p. 150)
The Amazon Chime SDK attendee information.
Type: Attendee (p. 392) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go
API Version 2018-05-01151
Amazon Chime API ReferenceSee Also
• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01152
Amazon Chime API ReferenceGetBot
GetBotRetrieves details for the specified bot, such as bot email address, bot type, status, and display name.
Request SyntaxGET /accounts/accountId/bots/botId HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
accountId (p. 153)
The Amazon Chime account ID.
Pattern: .*\S.*
Required: YesbotId (p. 153)
The bot ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "Bot": { "BotEmail": "string", "BotId": "string", "BotType": "string", "CreatedTimestamp": number, "Disabled": boolean, "DisplayName": "string", "SecurityToken": "string", "UpdatedTimestamp": number, "UserId": "string" }}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
API Version 2018-05-01153
Amazon Chime API ReferenceErrors
The following data is returned in JSON format by the service.
Bot (p. 153)
The chat bot details.
Type: Bot (p. 393) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
API Version 2018-05-01154
Amazon Chime API ReferenceSee Also
tools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example retrieves details for the specified bot.
Sample Request
GET /accounts/12a3456b-7c89-012d-3456-78901e23fg45/bots/123abcd4-5ef6-789g-0h12-34j56789012k HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20190918T172527ZAuthorization: AUTHPARAMS
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: 4231cfc1-ddd0-42a3-bb25-02aef731f367Content-Type: application/jsonContent-Length: 374Date: Wed, 18 Sep 2019 17:25:27 GMTConnection: keep-alive
{"Bot":{"BotEmail":"[email protected]","BotId":"123abcd4-5ef6-789g-0h12-34j56789012k","BotType":"ChatBot","CreatedTimestamp":"2019-09-18T17:24:39.534Z","Disabled":false,"DisplayName":"myBot (Bot)","SecurityToken":"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY","UpdatedTimestamp":"2019-09-18T17:24:39.534Z","UserId":"123abcd4-5ef6-789g-0h12-34j56789012k"}}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01155
Amazon Chime API ReferenceGetEventsConfiguration
GetEventsConfigurationGets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPSendpoint or Lambda function ARN.
Request SyntaxGET /accounts/accountId/bots/botId/events-configuration HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
accountId (p. 156)
The Amazon Chime account ID.
Pattern: .*\S.*
Required: YesbotId (p. 156)
The bot ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "EventsConfiguration": { "BotId": "string", "LambdaFunctionArn": "string", "OutboundEventsHTTPSEndpoint": "string" }}
Response ElementsIf 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. 156)
The events configuration details.
API Version 2018-05-01156
Amazon Chime API ReferenceErrors
Type: EventsConfiguration (p. 400) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ResourceLimitExceededException
The request exceeds the resource limit.
HTTP Status Code: 400ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3
API Version 2018-05-01157
Amazon Chime API ReferenceSee Also
• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01158
Amazon Chime API ReferenceGetGlobalSettings
GetGlobalSettingsRetrieves global settings for the administrator's AWS account, such as Amazon Chime Business Callingand Amazon Chime Voice Connector settings.
Request SyntaxGET /settings HTTP/1.1
URI Request ParametersThe request does not use any URI parameters.
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "BusinessCalling": { "CdrBucket": "string" }, "VoiceConnector": { "CdrBucket": "string" }}
Response ElementsIf 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. 159)
The Amazon Chime Business Calling settings.
Type: BusinessCallingSettings (p. 395) objectVoiceConnector (p. 159)
The Amazon Chime Voice Connector settings.
Type: VoiceConnectorSettings (p. 455) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
API Version 2018-05-01159
Amazon Chime API ReferenceExample
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example retrieves the global settings for the administrator's AWS account.
Sample Request
GET /settings HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20190918T194823ZAuthorization: AUTHPARAMS
API Version 2018-05-01160
Amazon Chime API ReferenceSee Also
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: e92df7ba-fdb6-4125-91cd-b5991558366bContent-Type: application/jsonContent-Length: 104Date: Wed, 18 Sep 2019 19:48:24 GMTConnection: keep-alive
{"BusinessCalling":{"CdrBucket":"s3bucket"},"VoiceConnector":{"CdrBucket":"s3bucket"}}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01161
Amazon Chime API ReferenceGetMeeting
GetMeetingGets the Amazon Chime SDK meeting details for the specified meeting ID. For more information aboutthe 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 ParametersThe request uses the following URI parameters.
meetingId (p. 162)
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 BodyThe request does not have a request body.
Response Syntax
HTTP/1.1 200Content-type: application/json
{ "Meeting": { "ExternalMeetingId": "string", "MediaPlacement": { "AudioFallbackUrl": "string", "AudioHostUrl": "string", "ScreenDataUrl": "string", "ScreenSharingUrl": "string", "ScreenViewingUrl": "string", "SignalingUrl": "string", "TurnControlUrl": "string" }, "MediaRegion": "string", "MeetingId": "string" }}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
API Version 2018-05-01162
Amazon Chime API ReferenceErrors
Meeting (p. 162)
The Amazon Chime SDK meeting information.
Type: Meeting (p. 406) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go
API Version 2018-05-01163
Amazon Chime API ReferenceSee Also
• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01164
Amazon Chime API ReferenceGetPhoneNumber
GetPhoneNumberRetrieves 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 ParametersThe request uses the following URI parameters.
phoneNumberId (p. 165)
The phone number ID.
Required: Yes
Request BodyThe request does not have a request body.
Response Syntax
HTTP/1.1 200Content-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 }, "CreatedTimestamp": number, "DeletionTimestamp": number, "E164PhoneNumber": "string", "PhoneNumberId": "string", "ProductType": "string", "Status": "string", "Type": "string", "UpdatedTimestamp": number }
API Version 2018-05-01165
Amazon Chime API ReferenceResponse Elements
}
Response ElementsIf 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. 165)
The phone number details.
Type: PhoneNumber (p. 417) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400
ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
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
API Version 2018-05-01166
Amazon Chime API ReferenceExample
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example retrieves details for the specified phone number ID.
Sample Request
GET /phone-numbers/%2B12065550100 HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20191028T184310ZAuthorization: AUTHPARAMS
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: 4105c588-140d-4904-a0ed-80be2157ebcfContent-Type: application/jsonContent-Length: 581Date: Mon, 28 Oct 2019 18:43:10 GMTConnection: keep-alive
{"PhoneNumber":{"Associations":[{"AssociatedTimestamp":"2019-10-28T18:40:37.453Z","Name":"VoiceConnectorId","Value":"abcdef1ghij2klmno3pqr4"}],"CallingName":null,"CallingNameStatus":"UpdateInProgress","Capabilities":{"InboundCall":true,"InboundMMS":true,"InboundSMS":true,"OutboundCall":true,"OutboundMMS":true,"OutboundSMS":true},"CreatedTimestamp":"2019-08-12T22:10:20.521Z","DeletionTimestamp":null,"E164PhoneNumber":"+12065550100","PhoneNumberId":"%2B12065550100","ProductType":"VoiceConnector","Status":"Assigned","Type":"Local","UpdatedTimestamp":"2019-10-28T18:42:07.964Z"}}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01167
Amazon Chime API ReferenceGetPhoneNumberOrder
GetPhoneNumberOrderRetrieves details for the specified phone number order, such as order creation timestamp, phonenumbers in E.164 format, product type, and order status.
Request SyntaxGET /phone-number-orders/phoneNumberOrderId HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
phoneNumberOrderId (p. 168)
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 BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "PhoneNumberOrder": { "CreatedTimestamp": number, "OrderedPhoneNumbers": [ { "E164PhoneNumber": "string", "Status": "string" } ], "PhoneNumberOrderId": "string", "ProductType": "string", "Status": "string", "UpdatedTimestamp": number }}
Response ElementsIf 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. 168)
The phone number order details.
API Version 2018-05-01168
Amazon Chime API ReferenceErrors
Type: PhoneNumberOrder (p. 423) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example retrieves details for the specified phone number order.
API Version 2018-05-01169
Amazon Chime API ReferenceSee Also
Sample Request
GET /phone-number-orders/abc12345-de67-89f0-123g-h45i678j9012 HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20190918T175948ZAuthorization: AUTHPARAMS
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: 2cac62a6-cdda-43fe-9053-d11f85cbc7e9Content-Type: application/jsonContent-Length: 362Date: Wed, 18 Sep 2019 17:59:49 GMTConnection: 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:57:47.090Z"}}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01170
Amazon Chime API ReferenceGetPhoneNumberSettings
GetPhoneNumberSettingsRetrieves the phone number settings for the administrator's AWS account, such as the default outboundcalling name.
Request SyntaxGET /settings/phone-number HTTP/1.1
URI Request ParametersThe request does not use any URI parameters.
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "CallingName": "string", "CallingNameUpdatedTimestamp": number}
Response ElementsIf 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. 171)
The default outbound calling name for the account.
Type: String
Pattern: ^$|^[a-zA-Z0-9 ]{2,15}$CallingNameUpdatedTimestamp (p. 171)
The updated outbound calling name timestamp, in ISO 8601 format.
Type: Timestamp
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
API Version 2018-05-01171
Amazon Chime API ReferenceExample
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example retrieves the phone number settings for the administrator's AWS account.
Sample Request
GET /settings/phone-number HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20191028T185743ZAuthorization: AUTHPARAMS
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: 34cb347e-cc3f-440c-a78f-b7e128207e75
API Version 2018-05-01172
Amazon Chime API ReferenceSee Also
Content-Type: application/jsonContent-Length: 81Date: Mon, 28 Oct 2019 18:57:43 GMTConnection: keep-alive
{"CallingName":"myName","CallingNameUpdatedTimestamp":"2019-10-28T18:56:42.911Z"}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01173
Amazon Chime API ReferenceGetProxySession
GetProxySessionGets the specified proxy session details for the specified Amazon Chime Voice Connector.
Request SyntaxGET /voice-connectors/voiceConnectorId/proxy-sessions/proxySessionId HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
proxySessionId (p. 174)
The proxy session ID.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: .*\S.*
Required: YesvoiceConnectorId (p. 174)
The Amazon Chime voice connector ID.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: .*\S.*
Required: Yes
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "ProxySession": { "Capabilities": [ "string" ], "CreatedTimestamp": number, "EndedTimestamp": number, "ExpiryMinutes": number, "GeoMatchLevel": "string", "GeoMatchParams": { "AreaCode": "string", "Country": "string" }, "Name": "string", "NumberSelectionBehavior": "string", "Participants": [ {
API Version 2018-05-01174
Amazon Chime API ReferenceResponse Elements
"PhoneNumber": "string", "ProxyPhoneNumber": "string" } ], "ProxySessionId": "string", "Status": "string", "UpdatedTimestamp": number, "VoiceConnectorId": "string" }}
Response ElementsIf 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. 174)
The proxy session details.
Type: ProxySession (p. 426) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429
API Version 2018-05-01175
Amazon Chime API ReferenceExample
UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example gets the details of a proxy session.
Sample Request
GET /voice-connectors/abcdef1ghij2klmno3pqr4/proxy-sessions/123a4bc5-67d8-901e-2f3g-h4ghjk56789l HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.18.39 Python/3.8.0 Windows/10 botocore/1.15.39X-Amz-Date: 20200415T161150ZAuthorization: AUTHPARAMS
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: ef91ce84-33bb-4bc1-b5bf-fd414bb19621Content-Type: application/jsonContent-Length: 531Date: Wed, 15 Apr 2020 16:11:50 GMTConnection: keep-alive
{"ProxySession":{"Capabilities":["SMS","Voice"],"CreatedTimestamp":"2020-04-15T16:10:10.288Z","EndedTimestamp":null,"ExpiryMinutes":60,"GeoMatchLevel":null,"GeoMatchParams":null,"Name":null,"NumberSelectionBehavior":null,"Participants":[{"PhoneNumber":"+12065550100","ProxyPhoneNumber":"+19135550199"},{"PhoneNumber":"+14015550101","ProxyPhoneNumber":"+19135550199"}],"ProxySessionId":"123a4bc5-67d8-901e-2f3g-h4ghjk56789l","Status":"Open","UpdatedTimestamp":"2020-04-15T16:10:10.288Z","VoiceConnectorId":"abcdef1ghij2klmno3pqr4"}}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java
API Version 2018-05-01176
Amazon Chime API ReferenceSee Also
• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01177
Amazon Chime API ReferenceGetRetentionSettings
GetRetentionSettingsGets the retention settings for the specified Amazon Chime Enterprise account. For more informationabout retention settings, see Managing Chat Retention Policies in the Amazon Chime AdministrationGuide.
Request SyntaxGET /accounts/accountId/retention-settings HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
accountId (p. 178)
The Amazon Chime account ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "InitiateDeletionTimestamp": number, "RetentionSettings": { "ConversationRetentionSettings": { "RetentionDays": number }, "RoomRetentionSettings": { "RetentionDays": number } }}
Response ElementsIf 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. 178)
The timestamp representing the time at which the specified items are permanently deleted, in ISO8601 format.
API Version 2018-05-01178
Amazon Chime API ReferenceErrors
Type: TimestampRetentionSettings (p. 178)
The retention settings.
Type: RetentionSettings (p. 429) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++
API Version 2018-05-01179
Amazon Chime API ReferenceSee Also
• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01180
Amazon Chime API ReferenceGetRoom
GetRoomRetrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.
Request SyntaxGET /accounts/accountId/rooms/roomId HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
accountId (p. 181)
The Amazon Chime account ID.
Pattern: .*\S.*
Required: Yes
roomId (p. 181)
The room ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "Room": { "AccountId": "string", "CreatedBy": "string", "CreatedTimestamp": number, "Name": "string", "RoomId": "string", "UpdatedTimestamp": number }}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
API Version 2018-05-01181
Amazon Chime API ReferenceErrors
Room (p. 181)
The room details.
Type: Room (p. 430) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
API Version 2018-05-01182
Amazon Chime API ReferenceSee Also
tools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example gets the details about the specified chat room, including the name.
Sample Request
GET /accounts/12a3456b-7c89-012d-3456-78901e23fg45/rooms/abcd1e2d-3e45-6789-01f2-3g45h67i890j HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.293 Python/3.8.0 Windows/10 botocore/1.13.29X-Amz-Date: 20191202T223145ZAuthorization: AUTHPARAMS
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: 6b2786c6-e616-4e0d-a991-f635fa827583Content-Type: application/jsonContent-Length: 273Date: Mon, 02 Dec 2019 22:31:45 GMTConnection: 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-01f2-3g45h67i890j","UpdatedTimestamp":"2019-12-02T22:29:31.549Z"}}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01183
Amazon Chime API ReferenceGetUser
GetUserRetrieves details for the specified user ID, such as primary email address, license type, and personalmeeting PIN.
To retrieve user details with an email address instead of a user ID, use the ListUsers (p. 260) action, andthen filter by email address.
Request SyntaxGET /accounts/accountId/users/userId HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
accountId (p. 184)
The Amazon Chime account ID.
Pattern: .*\S.*
Required: YesuserId (p. 184)
The user ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-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",
API Version 2018-05-01184
Amazon Chime API ReferenceResponse Elements
"UserInvitationStatus": "string", "UserRegistrationStatus": "string", "UserType": "string" }}
Response ElementsIf 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. 184)
The user details.
Type: User (p. 445) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
API Version 2018-05-01185
Amazon Chime API ReferenceExample
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis 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.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.83 Python/3.6.6 Windows/10 botocore/1.12.73X-Amz-Date: 20190108T180643ZAuthorization: AUTHPARAMS
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: 6d2ef025-d8a7-42f4-8170-84cb09b70d3dContent-Type: application/jsonContent-Length: 562Date: Tue, 08 Jan 2019 18:06:43 GMTConnection: 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 }
API Version 2018-05-01186
Amazon Chime API ReferenceSee Also
}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01187
Amazon Chime API ReferenceGetUserSettings
GetUserSettingsRetrieves settings for the specified user ID, such as any associated phone number settings.
Request SyntaxGET /accounts/accountId/users/userId/settings HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
accountId (p. 188)
The Amazon Chime account ID.
Required: YesuserId (p. 188)
The user ID.
Required: Yes
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "UserSettings": { "Telephony": { "InboundCalling": boolean, "OutboundCalling": boolean, "SMS": boolean } }}
Response ElementsIf 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. 188)
The user settings.
Type: UserSettings (p. 449) object
API Version 2018-05-01188
Amazon Chime API ReferenceErrors
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example retrieves settings for the specified user ID.
API Version 2018-05-01189
Amazon Chime API ReferenceSee Also
Sample Request
GET /accounts/12a3456b-7c89-012d-3456-78901e23fg45/users/1ab2345c-67de-8901-f23g-45h678901j2k/settings HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20190918T181628ZAuthorization: AUTHPARAMS
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: 5ee5b029-f523-4c32-94bd-20c1cfb03815Content-Type: application/jsonContent-Length: 91Date: Wed, 18 Sep 2019 18:16:28 GMTConnection: keep-alive
{"UserSettings":{"Telephony":{"InboundCalling":true,"OutboundCalling":true,"SMS":true}}}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01190
Amazon Chime API ReferenceGetVoiceConnector
GetVoiceConnectorRetrieves details for the specified Amazon Chime Voice Connector, such as timestamps, name, outboundhost, and encryption requirements.
Request SyntaxGET /voice-connectors/voiceConnectorId HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
voiceConnectorId (p. 191)
The Amazon Chime Voice Connector ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "VoiceConnector": { "AwsRegion": "string", "CreatedTimestamp": number, "Name": "string", "OutboundHostName": "string", "RequireEncryption": boolean, "UpdatedTimestamp": number, "VoiceConnectorId": "string" }}
Response ElementsIf 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. 191)
The Amazon Chime Voice Connector details.
Type: VoiceConnector (p. 450) object
API Version 2018-05-01191
Amazon Chime API ReferenceErrors
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example retrieves details for the specified Amazon Chime Voice Connector.
API Version 2018-05-01192
Amazon Chime API ReferenceSee Also
Sample Request
GET /voice-connectors/abcdef1ghij2klmno3pqr4 HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20190918T203609ZAuthorization: AUTHPARAMS
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: dbeaecf5-60e5-4914-a796-d2e2232d13f3Content-Type: application/jsonContent-Length: 301Date: Wed, 18 Sep 2019 20:36:09 GMTConnection: keep-alive
{"VoiceConnector":{"AwsRegion":"us-west-2","CreatedTimestamp":"2019-09-18T20:34:01.352Z","Name":"newVoiceConnector","OutboundHostName":"abcdef1ghij2klmno3pqr4.voiceconnector.chime.aws","RequireEncryption":true,"UpdatedTimestamp":"2019-09-18T20:34:01.352Z","VoiceConnectorId":"abcdef1ghij2klmno3pqr4"}}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01193
Amazon Chime API ReferenceGetVoiceConnectorGroup
GetVoiceConnectorGroupRetrieves details for the specified Amazon Chime Voice Connector group, such as timestamps, name, andassociated VoiceConnectorItems.
Request SyntaxGET /voice-connector-groups/voiceConnectorGroupId HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
voiceConnectorGroupId (p. 194)
The Amazon Chime Voice Connector group ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "VoiceConnectorGroup": { "CreatedTimestamp": number, "Name": "string", "UpdatedTimestamp": number, "VoiceConnectorGroupId": "string", "VoiceConnectorItems": [ { "Priority": number, "VoiceConnectorId": "string" } ] }}
Response ElementsIf 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. 194)
The Amazon Chime Voice Connector group details.
API Version 2018-05-01194
Amazon Chime API ReferenceErrors
Type: VoiceConnectorGroup (p. 452) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example retrieves details for the specified Amazon Chime Voice Connector group.
API Version 2018-05-01195
Amazon Chime API ReferenceSee Also
Sample Request
GET /voice-connector-groups/123a456b-c7d8-90e1-fg23-4h567jkl8901 HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20190918T164157ZAuthorization: AUTHPARAMS
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: 560af47f-2d8d-45c8-9909-615466073d7cContent-Type: application/jsonContent-Length: 222Date: Wed, 18 Sep 2019 16:41:57 GMTConnection: keep-alive
{"VoiceConnectorGroup":{"CreatedTimestamp":"2019-09-18T16:38:34.734Z","Name":"myGroup","UpdatedTimestamp":"2019-09-18T16:38:34.734Z","VoiceConnectorGroupId":"123a456b-c7d8-90e1-fg23-4h567jkl8901","VoiceConnectorItems":[]}}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01196
Amazon Chime API ReferenceGetVoiceConnectorLoggingConfiguration
GetVoiceConnectorLoggingConfigurationRetrieves the logging configuration details for the specified Amazon Chime Voice Connector. Showswhether SIP message logs are enabled for sending to Amazon CloudWatch Logs.
Request SyntaxGET /voice-connectors/voiceConnectorId/logging-configuration HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
voiceConnectorId (p. 197)
The Amazon Chime Voice Connector ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "LoggingConfiguration": { "EnableSIPLogs": boolean }}
Response ElementsIf 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. 197)
The logging configuration details.
Type: LoggingConfiguration (p. 403) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
API Version 2018-05-01197
Amazon Chime API ReferenceExample
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example retrieves the logging configuration details for the specified Amazon Chime VoiceConnector.
Sample Request
GET /voice-connectors/abcdef1ghij2klmno3pqr4/logging-configuration HTTP/1.1
API Version 2018-05-01198
Amazon Chime API ReferenceSee Also
Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20191028T190458ZAuthorization: AUTHPARAMS
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: 6f51ef1f-1861-4b9d-9b17-aa8dab224ed0Content-Type: application/jsonContent-Length: 47Date: Mon, 28 Oct 2019 19:04:58 GMTConnection: keep-alive
{"LoggingConfiguration":{"EnableSIPLogs":true}}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01199
Amazon Chime API ReferenceGetVoiceConnectorOrigination
GetVoiceConnectorOriginationRetrieves origination setting details for the specified Amazon Chime Voice Connector.
Request SyntaxGET /voice-connectors/voiceConnectorId/origination HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
voiceConnectorId (p. 200)
The Amazon Chime Voice Connector ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "Origination": { "Disabled": boolean, "Routes": [ { "Host": "string", "Port": number, "Priority": number, "Protocol": "string", "Weight": number } ] }}
Response ElementsIf 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. 200)
The origination setting details.
Type: Origination (p. 413) object
API Version 2018-05-01200
Amazon Chime API ReferenceErrors
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example retrieves origination setting details for the specified Amazon Chime Voice Connector.
API Version 2018-05-01201
Amazon Chime API ReferenceSee Also
Sample Request
GET /voice-connectors/abcdef1ghij2klmno3pqr4/origination HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20190823T182831ZAuthorization: AUTHPARAMS
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: bf151a51-1797-4980-8dc0-7cb7b28347e2Content-Type: application/jsonContent-Length: 122Date: Fri, 23 Aug 2019 18:28:31 GMTConnection: keep-alive
{"Origination":{"Disabled":false,"Routes":[{"Host":"10.24.34.0","Port":1234,"Priority":1,"Protocol":"TCP","Weight":5}]}}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01202
Amazon Chime API ReferenceGetVoiceConnectorProxy
GetVoiceConnectorProxyGets 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 ParametersThe request uses the following URI parameters.
voiceConnectorId (p. 203)
The Amazon Chime voice connector ID.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: .*\S.*
Required: Yes
Request BodyThe request does not have a request body.
Response Syntax
HTTP/1.1 200Content-type: application/json
{ "Proxy": { "DefaultSessionExpiryMinutes": number, "Disabled": boolean, "FallBackPhoneNumber": "string", "PhoneNumberCountries": [ "string" ] }}
Response ElementsIf 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. 203)
The proxy configuration details.
Type: Proxy (p. 425) object
API Version 2018-05-01203
Amazon Chime API ReferenceErrors
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example gets the proxy configuration details for your Amazon Chime Voice Connector.
API Version 2018-05-01204
Amazon Chime API ReferenceSee Also
Sample Request
GET /voice-connectors/abcdef1ghij2klmno3pqr4/programmable-numbers/proxy HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.18.39 Python/3.8.0 Windows/10 botocore/1.15.39X-Amz-Date: 20200415T160617ZAuthorization: AUTHPARAMS
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: b88a0151-196f-467b-be69-03d3dc8f8171Content-Type: application/jsonContent-Length: 118Date: Wed, 15 Apr 2020 16:06:17 GMTConnection: keep-alive
{"Proxy":{"DefaultSessionExpiryMinutes":60,"Disabled":false,"FallBackPhoneNumber":null,"PhoneNumberCountries":["US"]}}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01205
Amazon Chime API ReferenceGetVoiceConnectorStreamingConfiguration
GetVoiceConnectorStreamingConfigurationRetrieves the streaming configuration details for the specified Amazon Chime Voice Connector. Showswhether media streaming is enabled for sending to Amazon Kinesis. It also shows the retention period, inhours, for the Amazon Kinesis data.
Request SyntaxGET /voice-connectors/voiceConnectorId/streaming-configuration HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
voiceConnectorId (p. 206)
The Amazon Chime Voice Connector ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "StreamingConfiguration": { "DataRetentionInHours": number, "Disabled": boolean, "StreamingNotificationTargets": [ { "NotificationTarget": "string" } ] }}
Response ElementsIf 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. 206)
The streaming configuration details.
Type: StreamingConfiguration (p. 436) object
API Version 2018-05-01206
Amazon Chime API ReferenceErrors
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example retrieves the streaming configuration details for the specified Amazon Chime VoiceConnector.
API Version 2018-05-01207
Amazon Chime API ReferenceSee Also
Sample Request
GET /voice-connectors/abcdef1ghij2klmno3pqr4/streaming-configuration HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20190918T162749ZAuthorization: AUTHPARAMS
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: 78f8557f-91d7-4083-8b48-80e499d7ecb5Content-Type: application/jsonContent-Length: 71Date: Wed, 18 Sep 2019 16:27:50 GMTConnection: keep-alive
{"StreamingConfiguration":{"DataRetentionInHours":24,"Disabled":false}}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01208
Amazon Chime API ReferenceGetVoiceConnectorTermination
GetVoiceConnectorTerminationRetrieves termination setting details for the specified Amazon Chime Voice Connector.
Request SyntaxGET /voice-connectors/voiceConnectorId/termination HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
voiceConnectorId (p. 209)
The Amazon Chime Voice Connector ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "Termination": { "CallingRegions": [ "string" ], "CidrAllowedList": [ "string" ], "CpsLimit": number, "DefaultPhoneNumber": "string", "Disabled": boolean }}
Response ElementsIf 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. 209)
The termination setting details.
Type: Termination (p. 440) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
API Version 2018-05-01209
Amazon Chime API ReferenceExample
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example retrieves termination setting details for the specified Amazon Chime Voice Connector.
Sample Request
GET /voice-connectors/abcdef1ghij2klmno3pqr4/termination HTTP/1.1Host: service.chime.aws.amazon.com
API Version 2018-05-01210
Amazon Chime API ReferenceSee Also
Accept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20190823T183401ZAuthorization: AUTHPARAMS
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: 6f3ed77c-f44f-45d6-adc3-86337926911dContent-Type: application/jsonContent-Length: 145Date: Fri, 23 Aug 2019 18:34:01 GMTConnection: keep-alive
{"Termination":{"CallingRegions":["US"],"CidrAllowedList":["10.24.34.0/23"],"CpsLimit":1,"DefaultPhoneNumber":"+12065550100","Disabled":false}}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01211
Amazon Chime API ReferenceGetVoiceConnectorTerminationHealth
GetVoiceConnectorTerminationHealthRetrieves information about the last time a SIP OPTIONS ping was received from your SIP infrastructurefor the specified Amazon Chime Voice Connector.
Request SyntaxGET /voice-connectors/voiceConnectorId/termination/health HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
voiceConnectorId (p. 212)
The Amazon Chime Voice Connector ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "TerminationHealth": { "Source": "string", "Timestamp": number }}
Response ElementsIf 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. 212)
The termination health details.
Type: TerminationHealth (p. 442) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
API Version 2018-05-01212
Amazon Chime API ReferenceExample
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example retrieves termination health for the specified Amazon Chime Voice Connector.
Sample Request
GET /voice-connectors/abcdef1ghij2klmno3pqr4/termination/health HTTP/1.1Host: service.chime.aws.amazon.com
API Version 2018-05-01213
Amazon Chime API ReferenceSee Also
Accept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20190918T202903ZAuthorization: AUTHPARAMS
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: 85415f15-3e91-4ecd-8ed1-d4f9c5a36e07Content-Type: application/jsonContent-Length: 90Date: Wed, 18 Sep 2019 20:29:04 GMTConnection: keep-alive
{"TerminationHealth":{"Source":"10.24.34.0","Timestamp":"Wed Sep 18 20:29:00 UTC 2019"}}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01214
Amazon Chime API ReferenceInviteUsers
InviteUsersSends email to a maximum of 50 users, inviting them to the specified Amazon Chime Team account. OnlyTeam account types are currently supported for this action.
Request SyntaxPOST /accounts/accountId/users?operation=add HTTP/1.1Content-type: application/json
{ "UserEmailList": [ "string" ], "UserType": "string"}
URI Request ParametersThe request uses the following URI parameters.
accountId (p. 215)
The Amazon Chime account ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request accepts the following data in JSON format.
UserEmailList (p. 215)
The user email addresses to which to send the email invitation.
Type: Array of strings
Array Members: Maximum number of 50 items.
Pattern: .+@.+\..+
Required: YesUserType (p. 215)
The user type.
Type: String
Valid Values: PrivateUser | SharedDevice
Required: No
Response SyntaxHTTP/1.1 201
API Version 2018-05-01215
Amazon Chime API ReferenceResponse Elements
Content-type: application/json
{ "Invites": [ { "EmailAddress": "string", "EmailStatus": "string", "InviteId": "string", "Status": "string" } ]}
Response ElementsIf 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. 215)
The email invitation details.
Type: Array of Invite (p. 402) objects
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
API Version 2018-05-01216
Amazon Chime API ReferenceExample
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis 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.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.83 Python/3.6.6 Windows/10 botocore/1.12.73X-Amz-Date: 20190108T180827ZAuthorization: AUTHPARAMSContent-Length: 46
{"UserEmailList": ["[email protected]", "[email protected]"]}
Sample Response
HTTP/1.1 201 Createdx-amzn-RequestId: e1b2ea98-2934-400d-a5f1-f68d74658ea6Content-Type: application/jsonContent-Length: 204Date: Tue, 08 Jan 2019 18:08:27 GMTConnection: 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", } ]
API Version 2018-05-01217
Amazon Chime API ReferenceSee Also
}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01218
Amazon Chime API ReferenceListAccounts
ListAccountsLists the Amazon Chime accounts under the administrator's AWS account. You can filter accounts byaccount name prefix. To find out which Amazon Chime account a user belongs to, you can filter by theuser's email address, which returns one account result.
Request SyntaxGET /accounts?max-results=MaxResults&name=Name&next-token=NextToken&user-email=UserEmail HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
MaxResults (p. 219)
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. 219)
Amazon Chime account name prefix with which to filter results.
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: .*\S.*NextToken (p. 219)
The token to use to retrieve the next page of results.UserEmail (p. 219)
User email address with which to filter results.
Pattern: .+@.+\..+
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "Accounts": [ { "AccountId": "string", "AccountType": "string", "AwsAccountId": "string", "CreatedTimestamp": number, "DefaultLicense": "string", "Name": "string",
API Version 2018-05-01219
Amazon Chime API ReferenceResponse Elements
"SigninDelegateGroups": [ { "GroupName": "string" } ], "SupportedLicenses": [ "string" ] } ], "NextToken": "string"}
Response ElementsIf 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. 219)
List of Amazon Chime accounts and account details.
Type: Array of Account (p. 388) objectsNextToken (p. 219)
The token to use to retrieve the next page of results.
Type: String
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503
API Version 2018-05-01220
Amazon Chime API ReferenceExample
ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example lists the Amazon Chime accounts under the administrator's AWS account.
Sample Request
GET /console/accounts HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.83 Python/3.6.6 Windows/10 botocore/1.12.73X-Amz-Date: 20190108T175510ZAuthorization: AUTHPARAMS
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: 304c0ad6-f7cd-4541-a0dd-b82560062979Content-Type: application/jsonContent-Length: 2218Date: Tue, 08 Jan 2019 17:55:10 GMTConnection: 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": [{
API Version 2018-05-01221
Amazon Chime API ReferenceSee Also
"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 AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01222
Amazon Chime API ReferenceListAttendees
ListAttendeesLists the attendees for the specified Amazon Chime SDK meeting. For more information about theAmazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
Request SyntaxGET /meetings/meetingId/attendees?max-results=MaxResults&next-token=NextToken HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
MaxResults (p. 223)
The maximum number of results to return in a single call.
Valid Range: Minimum value of 1. Maximum value of 99.meetingId (p. 223)
The Amazon Chime SDK meeting ID.
Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}
Required: YesNextToken (p. 223)
The token to use to retrieve the next page of results.
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "Attendees": [ { "AttendeeId": "string", "ExternalUserId": "string", "JoinToken": "string" } ], "NextToken": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
API Version 2018-05-01223
Amazon Chime API ReferenceErrors
The following data is returned in JSON format by the service.
Attendees (p. 223)
The Amazon Chime SDK attendee information.
Type: Array of Attendee (p. 392) objectsNextToken (p. 223)
The token to use to retrieve the next page of results.
Type: String
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
API Version 2018-05-01224
Amazon Chime API ReferenceSee Also
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01225
Amazon Chime API ReferenceListAttendeeTags
ListAttendeeTagsLists the tags applied to an Amazon Chime SDK attendee resource.
Request SyntaxGET /meetings/meetingId/attendees/attendeeId/tags HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
attendeeId (p. 226)
The Amazon Chime SDK attendee ID.
Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}
Required: YesmeetingId (p. 226)
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 BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "Tags": [ { "Key": "string", "Value": "string" } ]}
Response ElementsIf 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. 226)
A list of tag key-value pairs.
API Version 2018-05-01226
Amazon Chime API ReferenceErrors
Type: Array of Tag (p. 438) objects
Array Members: Minimum number of 1 item. Maximum number of 50 items.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript
API Version 2018-05-01227
Amazon Chime API ReferenceSee Also
• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01228
Amazon Chime API ReferenceListBots
ListBotsLists the bots associated with the administrator's Amazon Chime Enterprise account ID.
Request SyntaxGET /accounts/accountId/bots?max-results=MaxResults&next-token=NextToken HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
accountId (p. 229)
The Amazon Chime account ID.
Pattern: .*\S.*
Required: Yes
MaxResults (p. 229)
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. 229)
The token to use to retrieve the next page of results.
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "Bots": [ { "BotEmail": "string", "BotId": "string", "BotType": "string", "CreatedTimestamp": number, "Disabled": boolean, "DisplayName": "string", "SecurityToken": "string", "UpdatedTimestamp": number, "UserId": "string" } ], "NextToken": "string"}
API Version 2018-05-01229
Amazon Chime API ReferenceResponse Elements
Response ElementsIf 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. 229)
List of bots and bot details.
Type: Array of Bot (p. 393) objectsNextToken (p. 229)
The token to use to retrieve the next page of results.
Type: String
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
API Version 2018-05-01230
Amazon Chime API ReferenceExample
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis 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.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20190918T172805ZAuthorization: AUTHPARAMS
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: ee577706-63e7-4524-b412-0711eb86e5aeContent-Type: application/jsonContent-Length: 774Date: Wed, 18 Sep 2019 17:28:05 GMTConnection: keep-alive
{"Bots":[{"BotEmail":"[email protected]","BotId":"123abcd4-5ef6-789g-0h12-34j56789012k","BotType":"ChatBot","CreatedTimestamp":"2019-09-18T17:24:39.534Z","Disabled":false,"DisplayName":"myBot (Bot)","SecurityToken":"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY","UpdatedTimestamp":"2019-09-18T17:24:39.534Z","UserId":"123abcd4-5ef6-789g-0h12-34j56789012k"},{"BotEmail":"[email protected]","BotId":"321abcd4-5ef6-789g-0h12-34j56789012k","BotType":"ChatBot","CreatedTimestamp":"2019-09-09T18:05:56.749Z","Disabled":true,"DisplayName":"ChatBot (Bot)","SecurityToken":"je7MtGbClwBF/2Zp9Utk/h3yCo8nvbEXAMPLEKEY","UpdatedTimestamp":"2019-09-09T18:24:25.437Z","UserId":"321abcd4-5ef6-789g-0h12-34j56789012k"}],"NextToken":null}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01231
Amazon Chime API ReferenceSee Also
API Version 2018-05-01232
Amazon Chime API ReferenceListMeetings
ListMeetingsLists up to 100 active Amazon Chime SDK meetings. For more information about the Amazon ChimeSDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
Request SyntaxGET /meetings?max-results=MaxResults&next-token=NextToken HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
MaxResults (p. 233)
The maximum number of results to return in a single call.
Valid Range: Minimum value of 1. Maximum value of 99.NextToken (p. 233)
The token to use to retrieve the next page of results.
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "Meetings": [ { "ExternalMeetingId": "string", "MediaPlacement": { "AudioFallbackUrl": "string", "AudioHostUrl": "string", "ScreenDataUrl": "string", "ScreenSharingUrl": "string", "ScreenViewingUrl": "string", "SignalingUrl": "string", "TurnControlUrl": "string" }, "MediaRegion": "string", "MeetingId": "string" } ], "NextToken": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
API Version 2018-05-01233
Amazon Chime API ReferenceErrors
The following data is returned in JSON format by the service.
Meetings (p. 233)
The Amazon Chime SDK meeting information.
Type: Array of Meeting (p. 406) objectsNextToken (p. 233)
The token to use to retrieve the next page of results.
Type: String
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++
API Version 2018-05-01234
Amazon Chime API ReferenceSee Also
• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01235
Amazon Chime API ReferenceListMeetingTags
ListMeetingTagsLists the tags applied to an Amazon Chime SDK meeting resource.
Request Syntax
GET /meetings/meetingId/tags HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
meetingId (p. 236)
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 BodyThe request does not have a request body.
Response Syntax
HTTP/1.1 200Content-type: application/json
{ "Tags": [ { "Key": "string", "Value": "string" } ]}
Response ElementsIf 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. 236)
A list of tag key-value pairs.
Type: Array of Tag (p. 438) objects
Array Members: Minimum number of 1 item. Maximum number of 50 items.
API Version 2018-05-01236
Amazon Chime API ReferenceErrors
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01237
Amazon Chime API ReferenceSee Also
API Version 2018-05-01238
Amazon Chime API ReferenceListPhoneNumberOrders
ListPhoneNumberOrdersLists the phone number orders for the administrator's Amazon Chime account.
Request SyntaxGET /phone-number-orders?max-results=MaxResults&next-token=NextToken HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
MaxResults (p. 239)
The maximum number of results to return in a single call.
Valid Range: Minimum value of 1. Maximum value of 99.NextToken (p. 239)
The token to use to retrieve the next page of results.
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "NextToken": "string", "PhoneNumberOrders": [ { "CreatedTimestamp": number, "OrderedPhoneNumbers": [ { "E164PhoneNumber": "string", "Status": "string" } ], "PhoneNumberOrderId": "string", "ProductType": "string", "Status": "string", "UpdatedTimestamp": number } ]}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
API Version 2018-05-01239
Amazon Chime API ReferenceErrors
NextToken (p. 239)
The token to use to retrieve the next page of results.
Type: StringPhoneNumberOrders (p. 239)
The phone number order details.
Type: Array of PhoneNumberOrder (p. 423) objects
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
API Version 2018-05-01240
Amazon Chime API ReferenceSee Also
tools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example lists the phone number orders for the administrator's Amazon Chime account.
Sample Request
GET /phone-number-orders HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20190918T175325ZAuthorization: AUTHPARAMS
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: 6e79c3b2-a0e4-443e-a280-9057b0edd4e8Content-Type: application/jsonContent-Length: 770Date: Wed, 18 Sep 2019 17:53:26 GMTConnection: 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":"VoiceConnector","Status":"Successful","UpdatedTimestamp":"2019-08-12T22:10:31.186Z"}]}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01241
Amazon Chime API ReferenceListPhoneNumbers
ListPhoneNumbersLists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon ChimeVoice Connector, or Amazon Chime Voice Connector group.
Request SyntaxGET /phone-numbers?filter-name=FilterName&filter-value=FilterValue&max-results=MaxResults&next-token=NextToken&product-type=ProductType&status=Status HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
FilterName (p. 242)
The filter to use to limit the number of results.
Valid Values: AccountId | UserId | VoiceConnectorId | VoiceConnectorGroupIdFilterValue (p. 242)
The value to use for the filter.MaxResults (p. 242)
The maximum number of results to return in a single call.
Valid Range: Minimum value of 1. Maximum value of 99.NextToken (p. 242)
The token to use to retrieve the next page of results.ProductType (p. 242)
The phone number product type.
Valid Values: BusinessCalling | VoiceConnectorStatus (p. 242)
The phone number status.
Valid Values: AcquireInProgress | AcquireFailed | Unassigned | Assigned |ReleaseInProgress | DeleteInProgress | ReleaseFailed | DeleteFailed
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "NextToken": "string", "PhoneNumbers": [
API Version 2018-05-01242
Amazon Chime API ReferenceResponse Elements
{ "Associations": [ { "AssociatedTimestamp": number, "Name": "string", "Value": "string" } ], "CallingName": "string", "CallingNameStatus": "string", "Capabilities": { "InboundCall": boolean, "InboundMMS": boolean, "InboundSMS": boolean, "OutboundCall": boolean, "OutboundMMS": boolean, "OutboundSMS": boolean }, "CreatedTimestamp": number, "DeletionTimestamp": number, "E164PhoneNumber": "string", "PhoneNumberId": "string", "ProductType": "string", "Status": "string", "Type": "string", "UpdatedTimestamp": number } ]}
Response ElementsIf 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. 242)
The token to use to retrieve the next page of results.
Type: StringPhoneNumbers (p. 242)
The phone number details.
Type: Array of PhoneNumber (p. 417) objects
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
API Version 2018-05-01243
Amazon Chime API ReferenceExample
HTTP Status Code: 403ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example lists the phone numbers for the account.
Sample Request
GET /phone-numbers HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20191028T184455ZAuthorization: AUTHPARAMS
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: c859a1d1-84ce-4cfc-a3ad-4dcde29d9265Content-Type: application/jsonContent-Length: 1620Date: Mon, 28 Oct 2019 18:44:55 GMTConnection: keep-alive
{"NextToken":null,"PhoneNumbers":[{"Associations":[{"AssociatedTimestamp":"2019-10-28T18:40:37.453Z","Name":"VoiceConnectorId","Value":"abcdef1ghij2klmno3pqr4"}],"CallingName":null,"CallingNameStatus":"UpdateInProgress","Capabilities":
API Version 2018-05-01244
Amazon Chime API ReferenceSee Also
{"InboundCall":true,"InboundMMS":true,"InboundSMS":true,"OutboundCall":true,"OutboundMMS":true,"OutboundSMS":true},"CreatedTimestamp":"2019-08-12T22:10:20.521Z","DeletionTimestamp":null,"E164PhoneNumber":"+12065550100","PhoneNumberId":"%2B12065550100","ProductType":"VoiceConnector","Status":"Assigned","Type":"Local","UpdatedTimestamp":"2019-10-28T18:42:07.964Z"},{"Associations":[{"AssociatedTimestamp":"2019-10-28T18:40:37.511Z","Name":"VoiceConnectorId","Value":"abcdef1ghij2klmno3pqr4"}],"CallingName":null,"CallingNameStatus":"UpdateInProgress","Capabilities":{"InboundCall":true,"InboundMMS":true,"InboundSMS":true,"OutboundCall":true,"OutboundMMS":true,"OutboundSMS":true},"CreatedTimestamp":"2019-08-12T22:10:20.521Z","DeletionTimestamp":null,"E164PhoneNumber":"+12065550101","PhoneNumberId":"%2B12065550101","ProductType":"VoiceConnector","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,"OutboundSMS":true},"CreatedTimestamp":"2019-08-09T21:35:21.445Z","DeletionTimestamp":null,"E164PhoneNumber":"+12065550102","PhoneNumberId":"%2B12065550102","ProductType":"VoiceConnector","Status":"Unassigned","Type":"Local","UpdatedTimestamp":"2019-10-28T18:31:55.339Z"}]}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01245
Amazon Chime API ReferenceListProxySessions
ListProxySessionsLists the proxy sessions for the specified Amazon Chime Voice Connector.
Request SyntaxGET /voice-connectors/voiceConnectorId/proxy-sessions?max-results=MaxResults&next-token=NextToken&status=Status HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
MaxResults (p. 246)
The maximum number of results to return in a single call.
Valid Range: Minimum value of 1. Maximum value of 99.NextToken (p. 246)
The token to use to retrieve the next page of results.
Length Constraints: Maximum length of 65535.Status (p. 246)
The proxy session status.
Valid Values: Open | InProgress | ClosedvoiceConnectorId (p. 246)
The Amazon Chime voice connector ID.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: .*\S.*
Required: Yes
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "NextToken": "string", "ProxySessions": [ { "Capabilities": [ "string" ], "CreatedTimestamp": number, "EndedTimestamp": number,
API Version 2018-05-01246
Amazon Chime API ReferenceResponse Elements
"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 ElementsIf 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. 246)
The token to use to retrieve the next page of results.
Type: String
Length Constraints: Maximum length of 65535.ProxySessions (p. 246)
The proxy session details.
Type: Array of ProxySession (p. 426) objects
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
API Version 2018-05-01247
Amazon Chime API ReferenceExample
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example lists the proxy sessions for your Amazon Chime Voice Connector.
Sample Request
GET /voice-connectors/abcdef1ghij2klmno3pqr4/proxy-sessions HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.18.39 Python/3.8.0 Windows/10 botocore/1.15.39X-Amz-Date: 20200415T161309ZAuthorization: AUTHPARAMS
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: 7a6e9cf0-6200-4296-9e50-b6dbb2bbcf76Content-Type: application/jsonContent-Length: 551Date: Wed, 15 Apr 2020 16:13:08 GMTConnection: keep-alive
{"NextToken":null,"ProxySessions":[{"Capabilities":["SMS","Voice"],"CreatedTimestamp":"2020-04-15T16:10:10.288Z","EndedTimestamp":null,"ExpiryMinutes":60,"GeoMatchLevel":null,"GeoMatchParams":null,"Name":null,"NumberSelectionBehavior":null,"Participants":
API Version 2018-05-01248
Amazon Chime API ReferenceSee Also
[{"PhoneNumber":"+12065550100","ProxyPhoneNumber":"+19135550199"},{"PhoneNumber":"+14015550101","ProxyPhoneNumber":"+19135550199"}],"ProxySessionId":"123a4bc5-67d8-901e-2f3g-h4ghjk56789l","Status":"Open","UpdatedTimestamp":"2020-04-15T16:10:10.288Z","VoiceConnectorId":"abcdef1ghij2klmno3pqr4"}]}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01249
Amazon Chime API ReferenceListRoomMemberships
ListRoomMembershipsLists the membership details for the specified room in an Amazon Chime Enterprise account, such as themembers' IDs, email addresses, and names.
Request SyntaxGET /accounts/accountId/rooms/roomId/memberships?max-results=MaxResults&next-token=NextToken HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
accountId (p. 250)
The Amazon Chime account ID.
Pattern: .*\S.*
Required: YesMaxResults (p. 250)
The maximum number of results to return in a single call.
Valid Range: Minimum value of 1. Maximum value of 99.NextToken (p. 250)
The token to use to retrieve the next page of results.roomId (p. 250)
The room ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "NextToken": "string", "RoomMemberships": [ { "InvitedBy": "string", "Member": { "AccountId": "string", "Email": "string",
API Version 2018-05-01250
Amazon Chime API ReferenceResponse Elements
"FullName": "string", "MemberId": "string", "MemberType": "string" }, "Role": "string", "RoomId": "string", "UpdatedTimestamp": number } ]}
Response ElementsIf 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. 250)
The token to use to retrieve the next page of results.
Type: StringRoomMemberships (p. 250)
The room membership details.
Type: Array of RoomMembership (p. 432) objects
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503
API Version 2018-05-01251
Amazon Chime API ReferenceExample
ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis 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.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.293 Python/3.8.0 Windows/10 botocore/1.13.29X-Amz-Date: 20191202T224849ZAuthorization: AUTHPARAMS
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: d8414bdb-5ba9-48ae-9305-f4162ad7062fContent-Type: application/jsonContent-Length: 771Date: Mon, 02 Dec 2019 22:48:49 GMTConnection: 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","UpdatedTimestamp":"2019-12-02T22:46:58.532Z"},{"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-3g45h67i890j","UpdatedTimestamp":"2019-12-02T22:46:58.532Z"}]}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
API Version 2018-05-01252
Amazon Chime API ReferenceSee Also
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01253
Amazon Chime API ReferenceListRooms
ListRoomsLists the room details for the specified Amazon Chime Enterprise account. Optionally, filter the results bya member ID (user ID or bot ID) to see a list of rooms that the member belongs to.
Request SyntaxGET /accounts/accountId/rooms?max-results=MaxResults&member-id=MemberId&next-token=NextToken HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
accountId (p. 254)
The Amazon Chime account ID.
Pattern: .*\S.*
Required: YesMaxResults (p. 254)
The maximum number of results to return in a single call.
Valid Range: Minimum value of 1. Maximum value of 99.MemberId (p. 254)
The member ID (user ID or bot ID).NextToken (p. 254)
The token to use to retrieve the next page of results.
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "NextToken": "string", "Rooms": [ { "AccountId": "string", "CreatedBy": "string", "CreatedTimestamp": number, "Name": "string", "RoomId": "string", "UpdatedTimestamp": number } ]
API Version 2018-05-01254
Amazon Chime API ReferenceResponse Elements
}
Response ElementsIf 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. 254)
The token to use to retrieve the next page of results.
Type: StringRooms (p. 254)
The room details.
Type: Array of Room (p. 430) objects
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
API Version 2018-05-01255
Amazon Chime API ReferenceExample
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example returns a list of chat rooms in the specified account. The list is filtered by the chat roomsthat the specified member belongs to.
Sample Request
GET /accounts/12a3456b-7c89-012d-3456-78901e23fg45/rooms?member-id=1ab2345c-67de-8901-f23g-45h678901j2k HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.293 Python/3.8.0 Windows/10 botocore/1.13.29X-Amz-Date: 20191202T223837ZAuthorization: AUTHPARAMS
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: eb4b1f38-a2fa-4313-99f9-28cdf100c851Content-Type: application/jsonContent-Length: 294Date: Mon, 02 Dec 2019 22:38:36 GMTConnection: 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-01f2-3g45h67i890j","UpdatedTimestamp":"2019-12-02T22:33:19.310Z"}]}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python
API Version 2018-05-01256
Amazon Chime API ReferenceSee Also
• AWS SDK for Ruby V3
API Version 2018-05-01257
Amazon Chime API ReferenceListTagsForResource
ListTagsForResourceLists the tags applied to an Amazon Chime SDK meeting resource.
Request SyntaxGET /tags?arn=ResourceARN HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
ResourceARN (p. 258)
The resource ARN.
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: ^arn[\/\:\-\_\.a-zA-Z0-9]+$
Required: Yes
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "Tags": [ { "Key": "string", "Value": "string" } ]}
Response ElementsIf 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. 258)
A list of tag-key value pairs.
Type: Array of Tag (p. 438) objects
Array Members: Minimum number of 1 item. Maximum number of 50 items.
API Version 2018-05-01258
Amazon Chime API ReferenceErrors
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01259
Amazon Chime API ReferenceListUsers
ListUsersLists the users that belong to the specified Amazon Chime account. You can specify an email address tolist only the user that the email address belongs to.
Request SyntaxGET /accounts/accountId/users?max-results=MaxResults&next-token=NextToken&user-email=UserEmail&user-type=UserType HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
accountId (p. 260)
The Amazon Chime account ID.
Pattern: .*\S.*
Required: YesMaxResults (p. 260)
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. 260)
The token to use to retrieve the next page of results.UserEmail (p. 260)
Optional. The user email address used to filter results. Maximum 1.
Pattern: .+@.+\..+UserType (p. 260)
The user type.
Valid Values: PrivateUser | SharedDevice
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "NextToken": "string", "Users": [ { "AccountId": "string",
API Version 2018-05-01260
Amazon Chime API ReferenceResponse Elements
"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 ElementsIf 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. 260)
The token to use to retrieve the next page of results.
Type: StringUsers (p. 260)
List of users and user details.
Type: Array of User (p. 445) objects
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
API Version 2018-05-01261
Amazon Chime API ReferenceExample
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example lists the users for the specified Amazon Chime account.
Sample Request
GET /console/accounts/12a3456b-7c89-012d-3456-78901e23fg45/users HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.83 Python/3.6.6 Windows/10 botocore/1.12.73X-Amz-Date: 20190108T165935ZAuthorization: AUTHPARAMS
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: 429f487b-6f1d-4a76-8361-9809f6885ee8Content-Type: application/jsonContent-Length: 2200Date: Tue, 08 Jan 2019 16:59:36 GMTConnection: keep-alive
{ "NextToken": null, "Users": [{ "AccountId": "12a3456b-7c89-012d-3456-78901e23fg45", "Delegates": null, "Devices": null, "DisplayName": "user1 user1",
API Version 2018-05-01262
Amazon Chime API ReferenceExample
"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": "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,
API Version 2018-05-01263
Amazon Chime API ReferenceSee Also
"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 AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01264
Amazon Chime API ReferenceListVoiceConnectorGroups
ListVoiceConnectorGroupsLists the Amazon Chime Voice Connector groups for the administrator's AWS account.
Request SyntaxGET /voice-connector-groups?max-results=MaxResults&next-token=NextToken HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
MaxResults (p. 265)
The maximum number of results to return in a single call.
Valid Range: Minimum value of 1. Maximum value of 99.NextToken (p. 265)
The token to use to retrieve the next page of results.
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "NextToken": "string", "VoiceConnectorGroups": [ { "CreatedTimestamp": number, "Name": "string", "UpdatedTimestamp": number, "VoiceConnectorGroupId": "string", "VoiceConnectorItems": [ { "Priority": number, "VoiceConnectorId": "string" } ] } ]}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
API Version 2018-05-01265
Amazon Chime API ReferenceErrors
NextToken (p. 265)
The token to use to retrieve the next page of results.
Type: StringVoiceConnectorGroups (p. 265)
The details of the Amazon Chime Voice Connector groups.
Type: Array of VoiceConnectorGroup (p. 452) objects
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
API Version 2018-05-01266
Amazon Chime API ReferenceSee Also
tools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example lists the Amazon Chime Voice Connector groups for the administrator's AWS account.
Sample Request
GET /voice-connector-groups HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20191028T185101ZAuthorization: AUTHPARAMS
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: f74f1f09-4fd9-4342-836d-b6865c5d0ff7Content-Type: application/jsonContent-Length: 242Date: Mon, 28 Oct 2019 18:51:01 GMTConnection: keep-alive
{"NextToken":null,"VoiceConnectorGroups":[{"CreatedTimestamp":"2019-09-18T16:38:34.734Z","Name":"myGroup","UpdatedTimestamp":"2019-09-18T16:38:34.734Z","VoiceConnectorGroupId":"123a456b-c7d8-90e1-fg23-4h567jkl8901","VoiceConnectorItems":[]}]}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01267
Amazon Chime API ReferenceListVoiceConnectors
ListVoiceConnectorsLists the Amazon Chime Voice Connectors for the administrator's AWS account.
Request SyntaxGET /voice-connectors?max-results=MaxResults&next-token=NextToken HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
MaxResults (p. 268)
The maximum number of results to return in a single call.
Valid Range: Minimum value of 1. Maximum value of 99.NextToken (p. 268)
The token to use to retrieve the next page of results.
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "NextToken": "string", "VoiceConnectors": [ { "AwsRegion": "string", "CreatedTimestamp": number, "Name": "string", "OutboundHostName": "string", "RequireEncryption": boolean, "UpdatedTimestamp": number, "VoiceConnectorId": "string" } ]}
Response ElementsIf 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. 268)
The token to use to retrieve the next page of results.
API Version 2018-05-01268
Amazon Chime API ReferenceErrors
Type: StringVoiceConnectors (p. 268)
The details of the Amazon Chime Voice Connectors.
Type: Array of VoiceConnector (p. 450) objects
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example lists the Amazon Chime Voice Connectors for the administrator's AWS account.
API Version 2018-05-01269
Amazon Chime API ReferenceSee Also
Sample Request
GET /voice-connectors HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20190918T203740ZAuthorization: AUTHPARAMS
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: 47fa6799-3b53-43c7-b80d-00fb064c55d8Content-Type: application/jsonContent-Length: 603Date: Wed, 18 Sep 2019 20:37:41 GMTConnection: keep-alive
{"NextToken":null,"VoiceConnectors":[{"AwsRegion":"us-east-1","CreatedTimestamp":"2019-06-04T18:46:56.508Z","Name":"myVoiceConnector","OutboundHostName":"abcdef1ghij2klmno3pqr5.voiceconnector.chime.aws","RequireEncryption":true,"UpdatedTimestamp":"2019-09-18T16:33:00.806Z","VoiceConnectorId":"abcdef1ghij2klmno3pqr5"},{"AwsRegion":"us-west-2","CreatedTimestamp":"2019-09-18T20:34:01.352Z","Name":"newVoiceConnector","OutboundHostName":"abcdef1ghij2klmno3pqr4.voiceconnector.chime.aws","RequireEncryption":true,"UpdatedTimestamp":"2019-09-18T20:34:01.352Z","VoiceConnectorId":"abcdef1ghij2klmno3pqr4"}]}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01270
Amazon Chime API ReferenceListVoiceConnectorTerminationCredentials
ListVoiceConnectorTerminationCredentialsLists the SIP credentials for the specified Amazon Chime Voice Connector.
Request SyntaxGET /voice-connectors/voiceConnectorId/termination/credentials HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
voiceConnectorId (p. 271)
The Amazon Chime Voice Connector ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "Usernames": [ "string" ]}
Response ElementsIf 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. 271)
A list of user names.
Type: Array of strings
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
API Version 2018-05-01271
Amazon Chime API ReferenceExample
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example lists the SIP credentials for the specified Amazon Chime Voice Connector.
Sample Request
GET /voice-connectors/abcdef1ghij2klmno3pqr4/termination/credentials HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20190823T184433ZAuthorization: AUTHPARAMS
API Version 2018-05-01272
Amazon Chime API ReferenceSee Also
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: fb18412c-4a68-4198-9850-1e44279b8217Content-Type: application/jsonContent-Length: 26Date: Fri, 23 Aug 2019 18:44:34 GMTConnection: keep-alive
{"Usernames":["jdoe"]}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01273
Amazon Chime API ReferenceLogoutUser
LogoutUserLogs out the specified user from all of the devices they are currently logged into.
Request SyntaxPOST /accounts/accountId/users/{userId}?operation=logout HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
accountId (p. 274)
The Amazon Chime account ID.
Pattern: .*\S.*
Required: YesuserId (p. 274)
The user ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 204
Response ElementsIf the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
API Version 2018-05-01274
Amazon Chime API ReferenceExample
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis 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.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.83 Python/3.6.6 Windows/10 botocore/1.12.73X-Amz-Date: 20190108T180307ZAuthorization: AUTHPARAMSContent-Length: 0
Sample Response
HTTP/1.1 204 No Content
API Version 2018-05-01275
Amazon Chime API ReferenceSee Also
x-amzn-RequestId: a67c559a-968a-4791-9e32-9a42c0dace42Content-Type: application/jsonDate: Tue, 08 Jan 2019 18:03:07 GMTConnection: keep-alive
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01276
Amazon Chime API ReferencePutEventsConfiguration
PutEventsConfigurationCreates 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. 393).
Request SyntaxPUT /accounts/accountId/bots/botId/events-configuration HTTP/1.1Content-type: application/json
{ "LambdaFunctionArn": "string", "OutboundEventsHTTPSEndpoint": "string"}
URI Request ParametersThe request uses the following URI parameters.
accountId (p. 277)
The Amazon Chime account ID.
Pattern: .*\S.*
Required: YesbotId (p. 277)
The bot ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request accepts the following data in JSON format.
LambdaFunctionArn (p. 277)
Lambda function ARN that allows the bot to receive outgoing events.
Type: String
Required: NoOutboundEventsHTTPSEndpoint (p. 277)
HTTPS endpoint that allows the bot to receive outgoing events.
Type: String
Required: No
Response SyntaxHTTP/1.1 201
API Version 2018-05-01277
Amazon Chime API ReferenceResponse Elements
Content-type: application/json
{ "EventsConfiguration": { "BotId": "string", "LambdaFunctionArn": "string", "OutboundEventsHTTPSEndpoint": "string" }}
Response ElementsIf 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. 277)
The configuration that allows a bot to receive outgoing events. Can be either an HTTPS endpoint ora Lambda function ARN.
Type: EventsConfiguration (p. 400) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ResourceLimitExceededException
The request exceeds the resource limit.
HTTP Status Code: 400ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503
API Version 2018-05-01278
Amazon Chime API ReferenceSee Also
UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01279
Amazon Chime API ReferencePutRetentionSettings
PutRetentionSettingsPuts retention settings for the specified Amazon Chime Enterprise account. We recommend using AWSCloudTrail to monitor usage of this API for your account. For more information, see Logging AmazonChime API Calls with AWS CloudTrail in the Amazon Chime Administration Guide.
To turn off existing retention settings, remove the number of days from the correspondingRetentionDays field in the RetentionSettings object. For more information about retention settings, seeManaging Chat Retention Policies in the Amazon Chime Administration Guide.
Request SyntaxPUT /accounts/accountId/retention-settings HTTP/1.1Content-type: application/json
{ "RetentionSettings": { "ConversationRetentionSettings": { "RetentionDays": number }, "RoomRetentionSettings": { "RetentionDays": number } }}
URI Request ParametersThe request uses the following URI parameters.
accountId (p. 280)
The Amazon Chime account ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request accepts the following data in JSON format.
RetentionSettings (p. 280)
The retention settings.
Type: RetentionSettings (p. 429) object
Required: Yes
Response SyntaxHTTP/1.1 204Content-type: application/json
API Version 2018-05-01280
Amazon Chime API ReferenceResponse Elements
{ "InitiateDeletionTimestamp": number, "RetentionSettings": { "ConversationRetentionSettings": { "RetentionDays": number }, "RoomRetentionSettings": { "RetentionDays": number } }}
Response ElementsIf 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. 280)
The timestamp representing the time at which the specified items are permanently deleted, in ISO8601 format.
Type: TimestampRetentionSettings (p. 280)
The retention settings.
Type: RetentionSettings (p. 429) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ConflictException
The request could not be processed because of conflict in the current state of the resource.
HTTP Status Code: 409ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
API Version 2018-05-01281
Amazon Chime API ReferenceSee Also
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01282
Amazon Chime API ReferencePutVoiceConnectorLoggingConfiguration
PutVoiceConnectorLoggingConfigurationAdds a logging configuration for the specified Amazon Chime Voice Connector. The loggingconfiguration specifies whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.
Request SyntaxPUT /voice-connectors/voiceConnectorId/logging-configuration HTTP/1.1Content-type: application/json
{ "LoggingConfiguration": { "EnableSIPLogs": boolean }}
URI Request ParametersThe request uses the following URI parameters.
voiceConnectorId (p. 283)
The Amazon Chime Voice Connector ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request accepts the following data in JSON format.
LoggingConfiguration (p. 283)
The logging configuration details to add.
Type: LoggingConfiguration (p. 403) object
Required: Yes
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "LoggingConfiguration": { "EnableSIPLogs": boolean }}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
API Version 2018-05-01283
Amazon Chime API ReferenceErrors
The following data is returned in JSON format by the service.
LoggingConfiguration (p. 283)
The updated logging configuration details.
Type: LoggingConfiguration (p. 403) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these
API Version 2018-05-01284
Amazon Chime API ReferenceSee Also
tools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example turns on the SIP logging configuration for the specified Amazon Chime Voice Connector.
Sample Request
PUT /voice-connectors/abcdef1ghij2klmno3pqr4/logging-configuration HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20191028T190315ZAuthorization: AUTHPARAMSContent-Length: 49
{"LoggingConfiguration": {"EnableSIPLogs": true}}
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: 7e671d10-67f8-44cd-bd32-8154a56ef505Content-Type: application/jsonContent-Length: 47Date: Mon, 28 Oct 2019 19:03:14 GMTConnection: keep-alive
{"LoggingConfiguration":{"EnableSIPLogs":true}}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01285
Amazon Chime API ReferencePutVoiceConnectorOrigination
PutVoiceConnectorOriginationAdds origination settings for the specified Amazon Chime Voice Connector.
Request SyntaxPUT /voice-connectors/voiceConnectorId/origination HTTP/1.1Content-type: application/json
{ "Origination": { "Disabled": boolean, "Routes": [ { "Host": "string", "Port": number, "Priority": number, "Protocol": "string", "Weight": number } ] }}
URI Request ParametersThe request uses the following URI parameters.
voiceConnectorId (p. 286)
The Amazon Chime Voice Connector ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request accepts the following data in JSON format.
Origination (p. 286)
The origination setting details to add.
Type: Origination (p. 413) object
Required: Yes
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "Origination": {
API Version 2018-05-01286
Amazon Chime API ReferenceResponse Elements
"Disabled": boolean, "Routes": [ { "Host": "string", "Port": number, "Priority": number, "Protocol": "string", "Weight": number } ] }}
Response ElementsIf 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. 286)
The updated origination setting details.
Type: Origination (p. 413) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
API Version 2018-05-01287
Amazon Chime API ReferenceExample
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example adds origination settings for the specified Amazon Chime Voice Connector.
Sample Request
PUT /voice-connectors/abcdef1ghij2klmno3pqr4/origination HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20190819T225632ZAuthorization: AUTHPARAMSContent-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 OKx-amzn-RequestId: d3553710-2dee-4b18-afd1-903aa88d53beContent-Type: application/jsonContent-Length: 122Date: Mon, 19 Aug 2019 22:56:33 GMTConnection: keep-alive
{"Origination":{"Disabled":false,"Routes":[{"Host":"10.24.34.0","Port":1234,"Priority":1,"Protocol":"TCP","Weight":5}]}}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++
API Version 2018-05-01288
Amazon Chime API ReferenceSee Also
• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01289
Amazon Chime API ReferencePutVoiceConnectorProxy
PutVoiceConnectorProxyPuts the specified proxy configuration to the specified Amazon Chime Voice Connector.
Request SyntaxPUT /voice-connectors/voiceConnectorId/programmable-numbers/proxy HTTP/1.1Content-type: application/json
{ "DefaultSessionExpiryMinutes": number, "Disabled": boolean, "FallBackPhoneNumber": "string", "PhoneNumberPoolCountries": [ "string" ]}
URI Request ParametersThe request uses the following URI parameters.
voiceConnectorId (p. 290)
The Amazon Chime voice connector ID.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: .*\S.*
Required: Yes
Request BodyThe request accepts the following data in JSON format.
DefaultSessionExpiryMinutes (p. 290)
The default number of minutes allowed for proxy sessions.
Type: Integer
Required: YesDisabled (p. 290)
When true, stops proxy sessions from being created on the specified Amazon Chime VoiceConnector.
Type: Boolean
Required: NoFallBackPhoneNumber (p. 290)
The phone number to route calls to after a proxy session expires.
Type: String
Pattern: ^\+?[1-9]\d{1,14}$
API Version 2018-05-01290
Amazon Chime API ReferenceResponse Syntax
Required: NoPhoneNumberPoolCountries (p. 290)
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 SyntaxHTTP/1.1 200Content-type: application/json
{ "Proxy": { "DefaultSessionExpiryMinutes": number, "Disabled": boolean, "FallBackPhoneNumber": "string", "PhoneNumberCountries": [ "string" ] }}
Response ElementsIf 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. 291)
The proxy configuration details.
Type: Proxy (p. 425) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
AccessDeniedException
You don't have permissions to perform the requested operation.
HTTP Status Code: 403BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
API Version 2018-05-01291
Amazon Chime API ReferenceExample
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example puts a proxy configuration to your Amazon Chime Voice Connector.
Sample Request
PUT /voice-connectors/abcdef1ghij2klmno3pqr4/programmable-numbers/proxy HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.18.39 Python/3.8.0 Windows/10 botocore/1.15.39X-Amz-Date: 20200415T160418ZAuthorization: AUTHPARAMSContent-Length: 71
{"DefaultSessionExpiryMinutes": 60, "PhoneNumberPoolCountries": ["US"]}
Sample Response
HTTP/1.1 200 OK
API Version 2018-05-01292
Amazon Chime API ReferenceSee Also
x-amzn-RequestId: 9f80051f-62b3-43d5-9630-bc28c098255bContent-Type: application/jsonContent-Length: 118Date: Wed, 15 Apr 2020 16:04:19 GMTConnection: keep-alive
{"Proxy":{"DefaultSessionExpiryMinutes":60,"Disabled":false,"FallBackPhoneNumber":null,"PhoneNumberCountries":["US"]}}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01293
Amazon Chime API ReferencePutVoiceConnectorStreamingConfiguration
PutVoiceConnectorStreamingConfigurationAdds a streaming configuration for the specified Amazon Chime Voice Connector. The streamingconfiguration specifies whether media streaming is enabled for sending to Amazon Kinesis. It also setsthe retention period, in hours, for the Amazon Kinesis data.
Request SyntaxPUT /voice-connectors/voiceConnectorId/streaming-configuration HTTP/1.1Content-type: application/json
{ "StreamingConfiguration": { "DataRetentionInHours": number, "Disabled": boolean, "StreamingNotificationTargets": [ { "NotificationTarget": "string" } ] }}
URI Request ParametersThe request uses the following URI parameters.
voiceConnectorId (p. 294)
The Amazon Chime Voice Connector ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request accepts the following data in JSON format.
StreamingConfiguration (p. 294)
The streaming configuration details to add.
Type: StreamingConfiguration (p. 436) object
Required: Yes
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "StreamingConfiguration": {
API Version 2018-05-01294
Amazon Chime API ReferenceResponse Elements
"DataRetentionInHours": number, "Disabled": boolean, "StreamingNotificationTargets": [ { "NotificationTarget": "string" } ] }}
Response ElementsIf 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. 294)
The updated streaming configuration details.
Type: StreamingConfiguration (p. 436) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429
API Version 2018-05-01295
Amazon Chime API ReferenceExample
UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example adds a streaming configuration for the specified Amazon Chime Voice Connector.
Sample Request
PUT /voice-connectors/abcdef1ghij2klmno3pqr4/streaming-configuration HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20190918T161659ZAuthorization: AUTHPARAMSContent-Length: 75
{"StreamingConfiguration": {"DataRetentionInHours": 24, "Disabled": false}}
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: 9ac21e90-1aae-40f2-b4c4-4e7be37b8a97Content-Type: application/jsonContent-Length: 71Date: Wed, 18 Sep 2019 16:16:59 GMTConnection: keep-alive
{"StreamingConfiguration":{"DataRetentionInHours":24,"Disabled":false}}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript
API Version 2018-05-01296
Amazon Chime API ReferenceSee Also
• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01297
Amazon Chime API ReferencePutVoiceConnectorTermination
PutVoiceConnectorTerminationAdds termination settings for the specified Amazon Chime Voice Connector.
Request SyntaxPUT /voice-connectors/voiceConnectorId/termination HTTP/1.1Content-type: application/json
{ "Termination": { "CallingRegions": [ "string" ], "CidrAllowedList": [ "string" ], "CpsLimit": number, "DefaultPhoneNumber": "string", "Disabled": boolean }}
URI Request ParametersThe request uses the following URI parameters.
voiceConnectorId (p. 298)
The Amazon Chime Voice Connector ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request accepts the following data in JSON format.
Termination (p. 298)
The termination setting details to add.
Type: Termination (p. 440) object
Required: Yes
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "Termination": { "CallingRegions": [ "string" ], "CidrAllowedList": [ "string" ], "CpsLimit": number, "DefaultPhoneNumber": "string",
API Version 2018-05-01298
Amazon Chime API ReferenceResponse Elements
"Disabled": boolean }}
Response ElementsIf 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. 298)
The updated termination setting details.
Type: Termination (p. 440) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
AccessDeniedException
You don't have permissions to perform the requested operation.
HTTP Status Code: 403BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429
API Version 2018-05-01299
Amazon Chime API ReferenceExample
UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example adds termination settings for the specified Amazon Chime Voice Connector.
Sample Request
PUT /voice-connectors/abcdef1ghij2klmno3pqr4/termination HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20190823T183759ZAuthorization: AUTHPARAMSContent-Length: 102
{"Termination": {"CallingRegions": ["US"], "CidrAllowedList": ["10.24.34.0/23"], "Disabled": false}}
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: 0620afeb-9691-4049-b650-22a57c138c69Content-Type: application/jsonContent-Length: 135Date: Fri, 23 Aug 2019 18:38:00 GMTConnection: keep-alive
{"Termination":{"CallingRegions":["US"],"CidrAllowedList":["10.24.34.0/23"],"CpsLimit":0,"DefaultPhoneNumber":null,"Disabled":false}}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java
API Version 2018-05-01300
Amazon Chime API ReferenceSee Also
• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01301
Amazon Chime API ReferencePutVoiceConnectorTerminationCredentials
PutVoiceConnectorTerminationCredentialsAdds termination SIP credentials for the specified Amazon Chime Voice Connector.
Request SyntaxPOST /voice-connectors/voiceConnectorId/termination/credentials?operation=put HTTP/1.1Content-type: application/json
{ "Credentials": [ { "Password": "string", "Username": "string" } ]}
URI Request ParametersThe request uses the following URI parameters.
voiceConnectorId (p. 302)
The Amazon Chime Voice Connector ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request accepts the following data in JSON format.
Credentials (p. 302)
The termination SIP credentials.
Type: Array of Credential (p. 399) objects
Required: No
Response SyntaxHTTP/1.1 204
Response ElementsIf the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
API Version 2018-05-01302
Amazon Chime API ReferenceExample
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis 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
API Version 2018-05-01303
Amazon Chime API ReferenceSee Also
Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20190823T184245ZAuthorization: AUTHPARAMSContent-Length: 70
{"Credentials": [{"Username": "jdoe", "Password": "XXXXXXXX"}]}
Sample Response
HTTP/1.1 204 No Contentx-amzn-RequestId: c3db83bc-2ecf-4442-93c5-b68d8c0c7fccContent-Type: application/jsonDate: Fri, 23 Aug 2019 18:42:45 GMTConnection: keep-alive
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01304
Amazon Chime API ReferenceRedactConversationMessage
RedactConversationMessageRedacts the specified message from the specified Amazon Chime conversation.
Request SyntaxPOST /accounts/accountId/conversations/conversationId/messages/{messageId}?operation=redact HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
accountId (p. 305)
The Amazon Chime account ID.
Pattern: .*\S.*
Required: YesconversationId (p. 305)
The conversation ID.
Pattern: .*\S.*
Required: YesmessageId (p. 305)
The message ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200
Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
API Version 2018-05-01305
Amazon Chime API ReferenceSee Also
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01306
Amazon Chime API ReferenceRedactRoomMessage
RedactRoomMessageRedacts the specified message from the specified Amazon Chime chat room.
Request SyntaxPOST /accounts/accountId/rooms/roomId/messages/{messageId}?operation=redact HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
accountId (p. 307)
The Amazon Chime account ID.
Pattern: .*\S.*
Required: YesmessageId (p. 307)
The message ID.
Pattern: .*\S.*
Required: YesroomId (p. 307)
The room ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200
Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
API Version 2018-05-01307
Amazon Chime API ReferenceSee Also
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01308
Amazon Chime API ReferenceRegenerateSecurityToken
RegenerateSecurityTokenRegenerates the security token for a bot.
Request SyntaxPOST /accounts/accountId/bots/{botId}?operation=regenerate-security-token HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
accountId (p. 309)
The Amazon Chime account ID.
Pattern: .*\S.*
Required: YesbotId (p. 309)
The bot ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "Bot": { "BotEmail": "string", "BotId": "string", "BotType": "string", "CreatedTimestamp": number, "Disabled": boolean, "DisplayName": "string", "SecurityToken": "string", "UpdatedTimestamp": number, "UserId": "string" }}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
API Version 2018-05-01309
Amazon Chime API ReferenceErrors
The following data is returned in JSON format by the service.
Bot (p. 309)
A resource that allows Enterprise account administrators to configure an interface to receive eventsfrom Amazon Chime.
Type: Bot (p. 393) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, see Signature Version 4 Signing Process in the AWS General Reference.
API Version 2018-05-01310
Amazon Chime API ReferenceSee Also
You only need to learn how to sign HTTP requests if you intend to manually create them. When you usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis 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.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20190918T173015ZAuthorization: AUTHPARAMSContent-Length: 0
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: 0c755efb-46f9-4d5a-84b0-55f7b254ed7dContent-Type: application/jsonContent-Length: 374Date: Wed, 18 Sep 2019 17:30:16 GMTConnection: keep-alive
{"Bot":{"BotEmail":"[email protected]","BotId":"123abcd4-5ef6-789g-0h12-34j56789012k","BotType":"ChatBot","CreatedTimestamp":"2019-09-18T17:24:39.534Z","Disabled":false,"DisplayName":"myBot (Bot)","SecurityToken":"je7MtGbClwBF/2Zp9Utk/h3yCo8nvbEXAMPLEKEY","UpdatedTimestamp":"2019-09-18T17:24:39.534Z","UserId":"123abcd4-5ef6-789g-0h12-34j56789012k"}}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01311
Amazon Chime API ReferenceResetPersonalPIN
ResetPersonalPINResets the personal meeting PIN for the specified user on an Amazon Chime account. Returns theUser (p. 445) object with the updated personal meeting PIN.
Request SyntaxPOST /accounts/accountId/users/{userId}?operation=reset-personal-pin HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
accountId (p. 312)
The Amazon Chime account ID.
Pattern: .*\S.*
Required: YesuserId (p. 312)
The user ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-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"
API Version 2018-05-01312
Amazon Chime API ReferenceResponse Elements
}}
Response ElementsIf 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. 312)
The user details and new personal meeting PIN.
Type: User (p. 445) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400
ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
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
API Version 2018-05-01313
Amazon Chime API ReferenceExample
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis 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.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.83 Python/3.6.6 Windows/10 botocore/1.12.73X-Amz-Date: 20190108T181048ZAuthorization: AUTHPARAMSContent-Length: 0
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: a0033e1d-41aa-4030-8f52-ded7ebcf34bdContent-Type: application/jsonContent-Length: 558Date: Tue, 08 Jan 2019 18:10:48 GMTConnection: 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 }}
API Version 2018-05-01314
Amazon Chime API ReferenceSee Also
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01315
Amazon Chime API ReferenceRestorePhoneNumber
RestorePhoneNumberMoves a phone number from the Deletion queue back into the phone number Inventory.
Request SyntaxPOST /phone-numbers/{phoneNumberId}?operation=restore HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
phoneNumberId (p. 316)
The phone number.
Pattern: .*\S.*
Required: Yes
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-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 }, "CreatedTimestamp": number, "DeletionTimestamp": number, "E164PhoneNumber": "string", "PhoneNumberId": "string", "ProductType": "string", "Status": "string", "Type": "string", "UpdatedTimestamp": number
API Version 2018-05-01316
Amazon Chime API ReferenceResponse Elements
}}
Response ElementsIf 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. 316)
The phone number details.
Type: PhoneNumber (p. 417) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400
ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
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
API Version 2018-05-01317
Amazon Chime API ReferenceExample
UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example moves the specified phone number from the Deletion queue back into the phone numberInventory.
Sample Request
POST /phone-numbers/%2B12065550100?operation=restore HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20190918T182510ZAuthorization: AUTHPARAMSContent-Length: 0
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: 3fb42323-1231-4034-8fbb-4a6f89d189eaContent-Type: application/jsonContent-Length: 460Date: Wed, 18 Sep 2019 18:25:10 GMTConnection: keep-alive
{"PhoneNumber":{"Associations":[],"CallingName":myBusiness,"CallingNameStatus":UpdateSucceeded,"Capabilities":{"InboundCall":true,"InboundMMS":true,"InboundSMS":true,"OutboundCall":true,"OutboundMMS":true,"OutboundSMS":true},"CreatedTimestamp":"2019-09-18T17:57:36.304Z","DeletionTimestamp":null,"E164PhoneNumber":"+12065550100","PhoneNumberId":"%2B12065550100","ProductType":"VoiceConnector","Status":"Unassigned","Type":"Local","UpdatedTimestamp":"2019-09-18T18:25:10.866Z"}}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript
API Version 2018-05-01318
Amazon Chime API ReferenceSee Also
• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01319
Amazon Chime API ReferenceSearchAvailablePhoneNumbers
SearchAvailablePhoneNumbersSearches phone numbers that can be ordered.
Request SyntaxGET /search?type=phone-numbers&area-code=AreaCode&city=City&country=Country&max-results=MaxResults&next-token=NextToken&state=State&toll-free-prefix=TollFreePrefix HTTP/1.1
URI Request ParametersThe request uses the following URI parameters.
AreaCode (p. 320)
The area code used to filter results.City (p. 320)
The city used to filter results.Country (p. 320)
The country used to filter results.MaxResults (p. 320)
The maximum number of results to return in a single call.
Valid Range: Minimum value of 1. Maximum value of 500.NextToken (p. 320)
The token to use to retrieve the next page of results.State (p. 320)
The state used to filter results.TollFreePrefix (p. 320)
The toll-free prefix that you use to filter results.
Length Constraints: Fixed length of 3.
Pattern: ^8(00|33|44|55|66|77|88)$
Request BodyThe request does not have a request body.
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "E164PhoneNumbers": [ "string" ]
API Version 2018-05-01320
Amazon Chime API ReferenceResponse Elements
}
Response ElementsIf 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. 320)
List of phone numbers, in E.164 format.
Type: Array of strings
Pattern: ^\+?[1-9]\d{1,14}$
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
AccessDeniedException
You don't have permissions to perform the requested operation.
HTTP Status Code: 403BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
API Version 2018-05-01321
Amazon Chime API ReferenceExample
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example searches phone numbers that can be ordered with the area code 206.
Sample Request
GET /search?type=phone-numbers&area-code=206 HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20190918T180157ZAuthorization: AUTHPARAMS
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: 98bb7b5b-0f5b-48c3-a959-ab0d7fd42b97Content-Type: application/jsonContent-Length: 1522Date: Wed, 18 Sep 2019 18:01:57 GMTConnection: keep-alive
{"E164PhoneNumbers":["+12065550100","+12065550101","+12065550102"]}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01322
Amazon Chime API ReferenceTagAttendee
TagAttendeeApplies the specified tags to the specified Amazon Chime SDK attendee.
Request SyntaxPOST /meetings/meetingId/attendees/attendeeId/tags?operation=add HTTP/1.1Content-type: application/json
{ "Tags": [ { "Key": "string", "Value": "string" } ]}
URI Request ParametersThe request uses the following URI parameters.
attendeeId (p. 323)
The Amazon Chime SDK attendee ID.
Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}
Required: YesmeetingId (p. 323)
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 BodyThe request accepts the following data in JSON format.
Tags (p. 323)
The tag key-value pairs.
Type: Array of Tag (p. 438) objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: Yes
Response SyntaxHTTP/1.1 204
API Version 2018-05-01323
Amazon Chime API ReferenceResponse Elements
Response ElementsIf the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ResourceLimitExceededException
The request exceeds the resource limit.
HTTP Status Code: 400ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET
API Version 2018-05-01324
Amazon Chime API ReferenceSee Also
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01325
Amazon Chime API ReferenceTagMeeting
TagMeetingApplies the specified tags to the specified Amazon Chime SDK meeting.
Request SyntaxPOST /meetings/meetingId/tags?operation=add HTTP/1.1Content-type: application/json
{ "Tags": [ { "Key": "string", "Value": "string" } ]}
URI Request ParametersThe request uses the following URI parameters.
meetingId (p. 326)
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 BodyThe request accepts the following data in JSON format.
Tags (p. 326)
The tag key-value pairs.
Type: Array of Tag (p. 438) objects
Array Members: Minimum number of 1 item. Maximum number of 50 items.
Required: Yes
Response SyntaxHTTP/1.1 204
Response ElementsIf the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
API Version 2018-05-01326
Amazon Chime API ReferenceErrors
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ResourceLimitExceededException
The request exceeds the resource limit.
HTTP Status Code: 400ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java
API Version 2018-05-01327
Amazon Chime API ReferenceSee Also
• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01328
Amazon Chime API ReferenceTagResource
TagResourceApplies the specified tags to the specified Amazon Chime SDK meeting resource.
Request SyntaxPOST /tags?operation=tag-resource HTTP/1.1Content-type: application/json
{ "ResourceARN": "string", "Tags": [ { "Key": "string", "Value": "string" } ]}
URI Request ParametersThe request does not use any URI parameters.
Request BodyThe request accepts the following data in JSON format.
ResourceARN (p. 329)
The resource ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: ^arn[\/\:\-\_\.a-zA-Z0-9]+$
Required: YesTags (p. 329)
The tag key-value pairs.
Type: Array of Tag (p. 438) objects
Array Members: Minimum number of 1 item. Maximum number of 50 items.
Required: Yes
Response SyntaxHTTP/1.1 204
Response ElementsIf the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
API Version 2018-05-01329
Amazon Chime API ReferenceErrors
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01330
Amazon Chime API ReferenceUntagAttendee
UntagAttendeeUntags the specified tags from the specified Amazon Chime SDK attendee.
Request SyntaxPOST /meetings/meetingId/attendees/attendeeId/tags?operation=delete HTTP/1.1Content-type: application/json
{ "TagKeys": [ "string" ]}
URI Request ParametersThe request uses the following URI parameters.
attendeeId (p. 331)
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. 331)
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 BodyThe request accepts the following data in JSON format.
TagKeys (p. 331)
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 SyntaxHTTP/1.1 204
API Version 2018-05-01331
Amazon Chime API ReferenceResponse Elements
Response ElementsIf the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java
API Version 2018-05-01332
Amazon Chime API ReferenceSee Also
• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01333
Amazon Chime API ReferenceUntagMeeting
UntagMeetingUntags the specified tags from the specified Amazon Chime SDK meeting.
Request SyntaxPOST /meetings/meetingId/tags?operation=delete HTTP/1.1Content-type: application/json
{ "TagKeys": [ "string" ]}
URI Request ParametersThe request uses the following URI parameters.
meetingId (p. 334)
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 BodyThe request accepts the following data in JSON format.
TagKeys (p. 334)
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 SyntaxHTTP/1.1 204
Response ElementsIf the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
API Version 2018-05-01334
Amazon Chime API ReferenceSee Also
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01335
Amazon Chime API ReferenceUntagResource
UntagResourceUntags the specified tags from the specified Amazon Chime SDK meeting resource.
Request SyntaxPOST /tags?operation=untag-resource HTTP/1.1Content-type: application/json
{ "ResourceARN": "string", "TagKeys": [ "string" ]}
URI Request ParametersThe request does not use any URI parameters.
Request BodyThe request accepts the following data in JSON format.
ResourceARN (p. 336)
The resource ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: ^arn[\/\:\-\_\.a-zA-Z0-9]+$
Required: YesTagKeys (p. 336)
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 SyntaxHTTP/1.1 204
Response ElementsIf the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
API Version 2018-05-01336
Amazon Chime API ReferenceErrors
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01337
Amazon Chime API ReferenceUpdateAccount
UpdateAccountUpdates account details for the specified Amazon Chime account. Currently, only account name updatesare supported for this action.
Request SyntaxPOST /accounts/accountId HTTP/1.1Content-type: application/json
{ "Name": "string"}
URI Request ParametersThe request uses the following URI parameters.
accountId (p. 338)
The Amazon Chime account ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request accepts the following data in JSON format.
Name (p. 338)
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 SyntaxHTTP/1.1 200Content-type: application/json
{ "Account": { "AccountId": "string", "AccountType": "string", "AwsAccountId": "string", "CreatedTimestamp": number, "DefaultLicense": "string",
API Version 2018-05-01338
Amazon Chime API ReferenceResponse Elements
"Name": "string", "SigninDelegateGroups": [ { "GroupName": "string" } ], "SupportedLicenses": [ "string" ] }}
Response ElementsIf 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. 338)
The updated Amazon Chime account details.
Type: Account (p. 388) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429
API Version 2018-05-01339
Amazon Chime API ReferenceExample
UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example updates the specified account name.
Sample Request
POST /console/accounts/12a3456b-7c89-012d-3456-78901e23fg45 HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.83 Python/3.6.6 Windows/10 botocore/1.12.73X-Amz-Date: 20190108T182558ZAuthorization: AUTHPARAMSContent-Length: 19
{"Name": "Example3"}
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: 1cbd30b4-ee17-400a-ab81-4d1eb65783dcContent-Type: application/jsonContent-Length: 424Date: Tue, 08 Jan 2019 18:25:58 GMTConnection: 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"],
API Version 2018-05-01340
Amazon Chime API ReferenceSee Also
"UseProTrialLicense": false }}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01341
Amazon Chime API ReferenceUpdateAccountSettings
UpdateAccountSettingsUpdates the settings for the specified Amazon Chime account. You can update settings for remotecontrol of shared screens, or for the dial-out option. For more information about these settings, see Usethe Policies Page in the Amazon Chime Administration Guide.
Request SyntaxPUT /accounts/accountId/settings HTTP/1.1Content-type: application/json
{ "AccountSettings": { "DisableRemoteControl": boolean, "EnableDialOut": boolean }}
URI Request ParametersThe request uses the following URI parameters.
accountId (p. 342)
The Amazon Chime account ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request accepts the following data in JSON format.
AccountSettings (p. 342)
The Amazon Chime account settings to update.
Type: AccountSettings (p. 390) object
Required: Yes
Response SyntaxHTTP/1.1 204
Response ElementsIf the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
API Version 2018-05-01342
Amazon Chime API ReferenceExample
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ConflictException
The request could not be processed because of conflict in the current state of the resource.
HTTP Status Code: 409ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example disables the remote control of shared screens for the specified Amazon Chime account.
API Version 2018-05-01343
Amazon Chime API ReferenceSee Also
Sample Request
PUT /console/accounts/12a3456b-7c89-012d-3456-78901e23fg45/settings HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.83 Python/3.6.6 Windows/10 botocore/1.12.73X-Amz-Date: 20190108T182719ZAuthorization: AUTHPARAMSContent-Length: 51
{"AccountSettings": {"DisableRemoteControl": true}}
Sample Response
HTTP/1.1 204 No Contentx-amzn-RequestId: f539839f-c426-4179-906d-28e297261d84Content-Type: application/jsonDate: Tue, 08 Jan 2019 18:27:20 GMTConnection: keep-alive
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01344
Amazon Chime API ReferenceUpdateBot
UpdateBotUpdates the status of the specified bot, such as starting or stopping the bot from running in yourAmazon Chime Enterprise account.
Request SyntaxPOST /accounts/accountId/bots/botId HTTP/1.1Content-type: application/json
{ "Disabled": boolean}
URI Request ParametersThe request uses the following URI parameters.
accountId (p. 345)
The Amazon Chime account ID.
Pattern: .*\S.*
Required: YesbotId (p. 345)
The bot ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request accepts the following data in JSON format.
Disabled (p. 345)
When true, stops the specified bot from running in your account.
Type: Boolean
Required: No
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "Bot": { "BotEmail": "string", "BotId": "string",
API Version 2018-05-01345
Amazon Chime API ReferenceResponse Elements
"BotType": "string", "CreatedTimestamp": number, "Disabled": boolean, "DisplayName": "string", "SecurityToken": "string", "UpdatedTimestamp": number, "UserId": "string" }}
Response ElementsIf 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. 345)
The updated bot details.
Type: Bot (p. 393) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429
API Version 2018-05-01346
Amazon Chime API ReferenceExample
UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis 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.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20190918T173150ZAuthorization: AUTHPARAMSContent-Length: 18
{"Disabled": true}
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: 7848d673-79fd-4d76-b723-846eb238aeb6Content-Type: application/jsonContent-Length: 373Date: Wed, 18 Sep 2019 17:31:51 GMTConnection: keep-alive
{"Bot":{"BotEmail":"[email protected]","BotId":"123abcd4-5ef6-789g-0h12-34j56789012k","BotType":"ChatBot","CreatedTimestamp":"2019-09-18T17:24:39.534Z","Disabled":true,"DisplayName":"myBot (Bot)","SecurityToken":"je7MtGbClwBF/2Zp9Utk/h3yCo8nvbEXAMPLEKEY","UpdatedTimestamp":"2019-09-18T17:31:51.516Z","UserId":"123abcd4-5ef6-789g-0h12-34j56789012k"}}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET
API Version 2018-05-01347
Amazon Chime API ReferenceSee Also
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01348
Amazon Chime API ReferenceUpdateGlobalSettings
UpdateGlobalSettingsUpdates global settings for the administrator's AWS account, such as Amazon Chime Business Callingand Amazon Chime Voice Connector settings.
Request SyntaxPUT /settings HTTP/1.1Content-type: application/json
{ "BusinessCalling": { "CdrBucket": "string" }, "VoiceConnector": { "CdrBucket": "string" }}
URI Request ParametersThe request does not use any URI parameters.
Request BodyThe request accepts the following data in JSON format.
BusinessCalling (p. 349)
The Amazon Chime Business Calling settings.
Type: BusinessCallingSettings (p. 395) object
Required: YesVoiceConnector (p. 349)
The Amazon Chime Voice Connector settings.
Type: VoiceConnectorSettings (p. 455) object
Required: Yes
Response SyntaxHTTP/1.1 204
Response ElementsIf the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
API Version 2018-05-01349
Amazon Chime API ReferenceExample
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example updates the global settings for the administrator's AWS account.
Sample Request
PUT /settings HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20190918T194726ZAuthorization: AUTHPARAMSContent-Length: 109
API Version 2018-05-01350
Amazon Chime API ReferenceSee Also
{"BusinessCalling": {"CdrBucket": "s3bucket"}, "VoiceConnector": {"CdrBucket": "s3bucket"}}
Sample Response
HTTP/1.1 204 No Contentx-amzn-RequestId: f77805ac-5d09-4ee2-aeb0-867540b4641cContent-Type: application/jsonDate: Wed, 18 Sep 2019 19:47:26 GMTConnection: keep-alive
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01351
Amazon Chime API ReferenceUpdatePhoneNumber
UpdatePhoneNumberUpdates 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 typeor the calling name in one action.
For toll-free numbers, you must use the Amazon Chime Voice Connector product type.
Updates to outbound calling names can take up to 72 hours to complete. Pending updates to outboundcalling names must be complete before you can request another update.
Request Syntax
POST /phone-numbers/phoneNumberId HTTP/1.1Content-type: application/json
{ "CallingName": "string", "ProductType": "string"}
URI Request ParametersThe request uses the following URI parameters.
phoneNumberId (p. 352)
The phone number ID.
Required: Yes
Request BodyThe request accepts the following data in JSON format.
CallingName (p. 352)
The outbound calling name associated with the phone number.
Type: String
Pattern: ^$|^[a-zA-Z0-9 ]{2,15}$
Required: No
ProductType (p. 352)
The product type.
Type: String
Valid Values: BusinessCalling | VoiceConnector
Required: No
API Version 2018-05-01352
Amazon Chime API ReferenceResponse Syntax
Response SyntaxHTTP/1.1 200Content-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 }, "CreatedTimestamp": number, "DeletionTimestamp": number, "E164PhoneNumber": "string", "PhoneNumberId": "string", "ProductType": "string", "Status": "string", "Type": "string", "UpdatedTimestamp": number }}
Response ElementsIf 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. 353)
The updated phone number details.
Type: PhoneNumber (p. 417) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
API Version 2018-05-01353
Amazon Chime API ReferenceExamples
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExamplesIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
Example: Update Product TypeThis example updates the product type for the specified phone number.
Sample Request
POST /phone-numbers/%2B12065550100 HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20191029T182530ZAuthorization: AUTHPARAMSContent-Length: 34
{"ProductType": "BusinessCalling"}
Sample Response
HTTP/1.1 200 OK
API Version 2018-05-01354
Amazon Chime API ReferenceSee Also
x-amzn-RequestId: 885b5970-6640-46e9-8b59-3d77be15a4f5Content-Type: application/jsonContent-Length: 484Date: Tue, 29 Oct 2019 18:25:29 GMTConnection: keep-alive
{"PhoneNumber":{"Associations":[],"CallingName":"phonenumber1","CallingNameStatus":"UpdateSucceeded","Capabilities":{"InboundCall":true,"InboundMMS":true,"InboundSMS":true,"OutboundCall":true,"OutboundMMS":true,"OutboundSMS":true},"CreatedTimestamp":"2019-08-12T22:10:20.521Z","DeletionTimestamp":null,"E164PhoneNumber":"+12065550100","PhoneNumberId":"%2B12065550100","ProductType":"BusinessCalling","Status":"Unassigned","Type":"Local","UpdatedTimestamp":"2019-10-29T18:25:30.392Z"}}
Example: Update Outbound Calling NameThis example updates the outbound calling name for the specified phone number.
Sample Request
POST /phone-numbers/%2B12065550100 HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20191029T182817ZAuthorization: AUTHPARAMSContent-Length: 28
{"CallingName": "phonenumber2"}
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: d25cff84-0a51-4126-b4e9-9460535fcd68Content-Type: application/jsonContent-Length: 478Date: Tue, 29 Oct 2019 18:28:17 GMTConnection: keep-alive
{"PhoneNumber":{"Associations":[],"CallingName":"phonenumber2","CallingNameStatus":"UpdateSucceeded","Capabilities":{"InboundCall":true,"InboundMMS":true,"InboundSMS":true,"OutboundCall":true,"OutboundMMS":true,"OutboundSMS":true},"CreatedTimestamp":"2019-08-09T21:35:21.445Z","DeletionTimestamp":null,"E164PhoneNumber":"+12065550100","PhoneNumberId":"%2B12065550100","ProductType":"BusinessCalling","Status":"Unassigned","Type":"Local","UpdatedTimestamp":"2019-10-29T02:40:47.748Z"}}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01355
Amazon Chime API ReferenceUpdatePhoneNumberSettings
UpdatePhoneNumberSettingsUpdates the phone number settings for the administrator's AWS account, such as the default outboundcalling name. You can update the default outbound calling name once every seven days. Outboundcalling names can take up to 72 hours to update.
Request Syntax
PUT /settings/phone-number HTTP/1.1Content-type: application/json
{ "CallingName": "string"}
URI Request ParametersThe request does not use any URI parameters.
Request BodyThe request accepts the following data in JSON format.
CallingName (p. 356)
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 ElementsIf the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400
API Version 2018-05-01356
Amazon Chime API ReferenceExample
ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example updates the default outbound calling name for the administrator's AWS account.
Sample Request
PUT /settings/phone-number HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20191028T185642ZAuthorization: AUTHPARAMSContent-Length: 25
{"CallingName": "myName"}
Sample Response
HTTP/1.1 204 No Content
API Version 2018-05-01357
Amazon Chime API ReferenceSee Also
x-amzn-RequestId: 2bbca1c8-cf1e-438a-a3b1-b4a8f7db7227Content-Type: application/jsonDate: Mon, 28 Oct 2019 18:56:42 GMTConnection: keep-alive
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01358
Amazon Chime API ReferenceUpdateProxySession
UpdateProxySessionUpdates the specified proxy session details, such as voice or SMS capabilities.
Request SyntaxPOST /voice-connectors/voiceConnectorId/proxy-sessions/proxySessionId HTTP/1.1Content-type: application/json
{ "Capabilities": [ "string" ], "ExpiryMinutes": number}
URI Request ParametersThe request uses the following URI parameters.
proxySessionId (p. 359)
The proxy session ID.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: .*\S.*
Required: YesvoiceConnectorId (p. 359)
The Amazon Chime voice connector ID.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: .*\S.*
Required: Yes
Request BodyThe request accepts the following data in JSON format.
Capabilities (p. 359)
The proxy session capabilities.
Type: Array of strings
Valid Values: Voice | SMS
Required: YesExpiryMinutes (p. 359)
The number of minutes allowed for the proxy session.
Type: Integer
Valid Range: Minimum value of 1.
API Version 2018-05-01359
Amazon Chime API ReferenceResponse Syntax
Required: No
Response SyntaxHTTP/1.1 201Content-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 ElementsIf 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. 360)
The proxy session details.
Type: ProxySession (p. 426) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
API Version 2018-05-01360
Amazon Chime API ReferenceExample
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example updates the proxy session capabilities.
Sample Request
POST /voice-connectors/abcdef1ghij2klmno3pqr4/proxy-sessions/123a4bc5-67d8-901e-2f3g-h4ghjk56789l HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.18.39 Python/3.8.0 Windows/10 botocore/1.15.39X-Amz-Date: 20200415T161517ZAuthorization: AUTHPARAMSContent-Length: 27
{"Capabilities": ["Voice"]}
Sample Response
HTTP/1.1 201 Created
API Version 2018-05-01361
Amazon Chime API ReferenceSee Also
x-amzn-RequestId: 3fea90c8-0c57-42cd-80ed-a628704eef17Content-Type: application/jsonContent-Length: 525Date: Wed, 15 Apr 2020 16:15:17 GMTConnection: keep-alive
{"ProxySession":{"Capabilities":["Voice"],"CreatedTimestamp":"2020-04-15T16:10:10.288Z","EndedTimestamp":null,"ExpiryMinutes":60,"GeoMatchLevel":null,"GeoMatchParams":null,"Name":null,"NumberSelectionBehavior":null,"Participants":[{"PhoneNumber":"+12065550100","ProxyPhoneNumber":"+19135550199"},{"PhoneNumber":"+14015550101","ProxyPhoneNumber":"+19135550199"}],"ProxySessionId":"123a4bc5-67d8-901e-2f3g-h4ghjk56789l","Status":"Open","UpdatedTimestamp":"2020-04-15T16:15:17.560Z","VoiceConnectorId":"abcdef1ghij2klmno3pqr4"}}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01362
Amazon Chime API ReferenceUpdateRoom
UpdateRoomUpdates room details, such as the room name, for a room in an Amazon Chime Enterprise account.
Request SyntaxPOST /accounts/accountId/rooms/roomId HTTP/1.1Content-type: application/json
{ "Name": "string"}
URI Request ParametersThe request uses the following URI parameters.
accountId (p. 363)
The Amazon Chime account ID.
Pattern: .*\S.*
Required: YesroomId (p. 363)
The room ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request accepts the following data in JSON format.
Name (p. 363)
The room name.
Type: String
Required: No
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "Room": { "AccountId": "string", "CreatedBy": "string", "CreatedTimestamp": number,
API Version 2018-05-01363
Amazon Chime API ReferenceResponse Elements
"Name": "string", "RoomId": "string", "UpdatedTimestamp": number }}
Response ElementsIf 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. 363)
The room details.
Type: Room (p. 430) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
API Version 2018-05-01364
Amazon Chime API ReferenceExample
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis 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.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.293 Python/3.8.0 Windows/10 botocore/1.13.29X-Amz-Date: 20191202T223318ZAuthorization: AUTHPARAMSContent-Length: 21
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: e48fe3de-9a18-4ea2-b656-a00690a91f46Content-Type: application/jsonContent-Length: 274Date: Mon, 02 Dec 2019 22:33:19 GMTConnection: 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-01f2-3g45h67i890j","UpdatedTimestamp":"2019-12-02T22:33:19.310Z"}}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01365
Amazon Chime API ReferenceSee Also
API Version 2018-05-01366
Amazon Chime API ReferenceUpdateRoomMembership
UpdateRoomMembershipUpdates room membership details, such as the member role, for a room in an Amazon Chime Enterpriseaccount. The member role designates whether the member is a chat room administrator or a generalchat room member. The member role can be updated only for user IDs.
Request SyntaxPOST /accounts/accountId/rooms/roomId/memberships/memberId HTTP/1.1Content-type: application/json
{ "Role": "string"}
URI Request ParametersThe request uses the following URI parameters.
accountId (p. 367)
The Amazon Chime account ID.
Pattern: .*\S.*
Required: Yes
memberId (p. 367)
The member ID.
Pattern: .*\S.*
Required: Yes
roomId (p. 367)
The room ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request accepts the following data in JSON format.
Role (p. 367)
The role of the member.
Type: String
Valid Values: Administrator | Member
Required: No
API Version 2018-05-01367
Amazon Chime API ReferenceResponse Syntax
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "RoomMembership": { "InvitedBy": "string", "Member": { "AccountId": "string", "Email": "string", "FullName": "string", "MemberId": "string", "MemberType": "string" }, "Role": "string", "RoomId": "string", "UpdatedTimestamp": number }}
Response ElementsIf 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. 368)
The room membership details.
Type: RoomMembership (p. 432) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400
ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
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.
API Version 2018-05-01368
Amazon Chime API ReferenceExample
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis 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.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.293 Python/3.8.0 Windows/10 botocore/1.13.29X-Amz-Date: 20191202T224022ZAuthorization: AUTHPARAMSContent-Length: 25
{"Role": "Administrator"}
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: afe39bf2-b34c-40d3-8b0d-fd402971bc1cContent-Type: application/jsonContent-Length: 388Date: Mon, 02 Dec 2019 22:40:22 GMTConnection: keep-alive
{"RoomMembership":{"InvitedBy":"arn:aws:iam::111122223333:user/alejandro","Member":{"AccountId":"12a3456b-7c89-012d-3456-78901e23fg45","Email":"[email protected]","FullName":"Jane
API Version 2018-05-01369
Amazon Chime API ReferenceSee Also
Doe","MemberId":"1ab2345c-67de-8901-f23g-45h678901j2k","MemberType":"User"},"Role":"Administrator","RoomId":"abcd1e2d-3e45-6789-01f2-3g45h67i890j","UpdatedTimestamp":"2019-12-02T22:40:22.931Z"}}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01370
Amazon Chime API ReferenceUpdateUser
UpdateUserUpdates user details for a specified user ID. Currently, only LicenseType updates are supported for thisaction.
Request SyntaxPOST /accounts/accountId/users/userId HTTP/1.1Content-type: application/json
{ "AlexaForBusinessMetadata": { "AlexaForBusinessRoomArn": "string", "IsAlexaForBusinessEnabled": boolean }, "LicenseType": "string", "UserType": "string"}
URI Request ParametersThe request uses the following URI parameters.
accountId (p. 371)
The Amazon Chime account ID.
Pattern: .*\S.*
Required: YesuserId (p. 371)
The user ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request accepts the following data in JSON format.
AlexaForBusinessMetadata (p. 371)
The Alexa for Business metadata.
Type: AlexaForBusinessMetadata (p. 391) object
Required: NoLicenseType (p. 371)
The user license type to update. This must be a supported license type for the Amazon Chimeaccount that the user belongs to.
Type: String
API Version 2018-05-01371
Amazon Chime API ReferenceResponse Syntax
Valid Values: Basic | Plus | Pro | ProTrial
Required: NoUserType (p. 371)
The user type.
Type: String
Valid Values: PrivateUser | SharedDevice
Required: No
Response SyntaxHTTP/1.1 200Content-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 ElementsIf 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. 372)
The updated user details.
Type: User (p. 445) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
API Version 2018-05-01372
Amazon Chime API ReferenceExample
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis 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.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.83 Python/3.6.6 Windows/10 botocore/1.12.73X-Amz-Date: 20190108T215020ZAuthorization: AUTHPARAMS
API Version 2018-05-01373
Amazon Chime API ReferenceSee Also
Content-Length: 24
{"LicenseType": "Basic"}
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: 3a63e2de-eb6c-41cf-8b08-2b05a29ee461Content-Type: application/jsonContent-Length: 441Date: Tue, 08 Jan 2019 21:50:20 GMTConnection: 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 AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01374
Amazon Chime API ReferenceUpdateUserSettings
UpdateUserSettingsUpdates the settings for the specified user, such as phone number settings.
Request SyntaxPUT /accounts/accountId/users/userId/settings HTTP/1.1Content-type: application/json
{ "UserSettings": { "Telephony": { "InboundCalling": boolean, "OutboundCalling": boolean, "SMS": boolean } }}
URI Request ParametersThe request uses the following URI parameters.
accountId (p. 375)
The Amazon Chime account ID.
Required: YesuserId (p. 375)
The user ID.
Required: Yes
Request BodyThe request accepts the following data in JSON format.
UserSettings (p. 375)
The user settings to update.
Type: UserSettings (p. 449) object
Required: Yes
Response SyntaxHTTP/1.1 204
Response ElementsIf the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
API Version 2018-05-01375
Amazon Chime API ReferenceErrors
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example updates the settings for the specified user.
API Version 2018-05-01376
Amazon Chime API ReferenceSee Also
Sample Request
PUT /accounts/12a3456b-7c89-012d-3456-78901e23fg45/users/1ab2345c-67de-8901-f23g-45h678901j2k/settings HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20190918T181826ZAuthorization: AUTHPARAMSContent-Length: 95
{"UserSettings": {"Telephony": {"InboundCalling": true, "OutboundCalling": true, "SMS": true}}}
Sample Response
HTTP/1.1 204 No Contentx-amzn-RequestId: 72ab9592-8aa8-4de1-9dd7-a8f84011261bContent-Type: application/jsonDate: Wed, 18 Sep 2019 18:18:27 GMTConnection: keep-alive
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01377
Amazon Chime API ReferenceUpdateVoiceConnector
UpdateVoiceConnectorUpdates details for the specified Amazon Chime Voice Connector.
Request SyntaxPUT /voice-connectors/voiceConnectorId HTTP/1.1Content-type: application/json
{ "Name": "string", "RequireEncryption": boolean}
URI Request ParametersThe request uses the following URI parameters.
voiceConnectorId (p. 378)
The Amazon Chime Voice Connector ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request accepts the following data in JSON format.
Name (p. 378)
The name of the Amazon Chime Voice Connector.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: YesRequireEncryption (p. 378)
When enabled, requires encryption for the Amazon Chime Voice Connector.
Type: Boolean
Required: Yes
Response SyntaxHTTP/1.1 200Content-type: application/json
{ "VoiceConnector": {
API Version 2018-05-01378
Amazon Chime API ReferenceResponse Elements
"AwsRegion": "string", "CreatedTimestamp": number, "Name": "string", "OutboundHostName": "string", "RequireEncryption": boolean, "UpdatedTimestamp": number, "VoiceConnectorId": "string" }}
Response ElementsIf 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. 378)
The updated Amazon Chime Voice Connector details.
Type: VoiceConnector (p. 450) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429
API Version 2018-05-01379
Amazon Chime API ReferenceExample
UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis example updates details for the specified Amazon Chime Voice Connector.
Sample Request
PUT /voice-connectors/abcdef1ghij2klmno3pqr4 HTTP/1.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20190918T204052ZAuthorization: AUTHPARAMSContent-Length: 46
{"Name": "newName", "RequireEncryption": true}
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: 975d78e7-1752-4b4f-9da7-5c1d025cd970Content-Type: application/jsonContent-Length: 291Date: Wed, 18 Sep 2019 20:40:52 GMTConnection: keep-alive
{"VoiceConnector":{"AwsRegion":"us-west-2","CreatedTimestamp":"2019-09-18T20:34:01.352Z","Name":"newName","OutboundHostName":"abcdef1ghij2klmno3pqr4.voiceconnector.chime.aws","RequireEncryption":true,"UpdatedTimestamp":"2019-09-18T20:40:52.895Z","VoiceConnectorId":"abcdef1ghij2klmno3pqr4"}}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript
API Version 2018-05-01380
Amazon Chime API ReferenceSee Also
• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01381
Amazon Chime API ReferenceUpdateVoiceConnectorGroup
UpdateVoiceConnectorGroupUpdates details for the specified Amazon Chime Voice Connector group, such as the name and AmazonChime Voice Connector priority ranking.
Request SyntaxPUT /voice-connector-groups/voiceConnectorGroupId HTTP/1.1Content-type: application/json
{ "Name": "string", "VoiceConnectorItems": [ { "Priority": number, "VoiceConnectorId": "string" } ]}
URI Request ParametersThe request uses the following URI parameters.
voiceConnectorGroupId (p. 382)
The Amazon Chime Voice Connector group ID.
Pattern: .*\S.*
Required: Yes
Request BodyThe request accepts the following data in JSON format.
Name (p. 382)
The name of the Amazon Chime Voice Connector group.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: YesVoiceConnectorItems (p. 382)
The VoiceConnectorItems to associate with the group.
Type: Array of VoiceConnectorItem (p. 454) objects
Required: Yes
Response SyntaxHTTP/1.1 202
API Version 2018-05-01382
Amazon Chime API ReferenceResponse Elements
Content-type: application/json
{ "VoiceConnectorGroup": { "CreatedTimestamp": number, "Name": "string", "UpdatedTimestamp": number, "VoiceConnectorGroupId": "string", "VoiceConnectorItems": [ { "Priority": number, "VoiceConnectorId": "string" } ] }}
Response ElementsIf 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. 382)
The updated Amazon Chime Voice Connector group details.
Type: VoiceConnectorGroup (p. 452) object
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 458).
BadRequestException
The input parameters don't match the service's restrictions.
HTTP Status Code: 400ConflictException
The request could not be processed because of conflict in the current state of the resource.
HTTP Status Code: 409ForbiddenException
The client is permanently forbidden from making the request. For example, when a user tries tocreate an account from an unsupported Region.
HTTP Status Code: 403NotFoundException
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404ServiceFailureException
The service encountered an unexpected error.
HTTP Status Code: 500
API Version 2018-05-01383
Amazon Chime API ReferenceExample
ServiceUnavailableException
The service is currently unavailable.
HTTP Status Code: 503ThrottledClientException
The client exceeded its request rate limit.
HTTP Status Code: 429UnauthorizedClientException
The client is not currently authorized to make the request.
HTTP Status Code: 401
ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature. For more information about creating thesesignatures, 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 usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThis 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.1Host: service.chime.aws.amazon.comAccept-Encoding: identityUser-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160X-Amz-Date: 20191028T190056ZAuthorization: AUTHPARAMSContent-Length: 112
{"Name": "newGroupName", "VoiceConnectorItems": [{"VoiceConnectorId": "abcdef1ghij2klmno3pqr4", "Priority": 1}]}
Sample Response
HTTP/1.1 202 Acceptedx-amzn-RequestId: a19ab97e-a397-4e33-b23f-6df54a2089f6Content-Type: application/jsonContent-Length: 307Date: Mon, 28 Oct 2019 19:00:57 GMTConnection: keep-alive
{"VoiceConnectorGroup":{"CreatedTimestamp":"2019-09-18T16:38:34.734Z","Name":"newGroupName","UpdatedTimestamp":"2019-10-28T19:00:57.081Z","VoiceConnectorGroupId":"123a456b-c7d8-90e1-fg23-4h567jkl8901","VoiceConnectorItems":[{"Priority":1,"VoiceConnector":null,"VoiceConnectorId":"abcdef1ghij2klmno3pqr4"}]}}
API Version 2018-05-01384
Amazon Chime API ReferenceSee Also
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2018-05-01385
Amazon Chime API Reference
Data TypesThe Amazon Chime API contains several data types that various actions use. This section describes eachdata type in detail.
NoteThe order of each element in a data type structure is not guaranteed. Applications should notassume a particular order.
The following data types are supported:
• Account (p. 388)• AccountSettings (p. 390)• AlexaForBusinessMetadata (p. 391)• Attendee (p. 392)• Bot (p. 393)• BusinessCallingSettings (p. 395)• ConversationRetentionSettings (p. 396)• CreateAttendeeError (p. 397)• CreateAttendeeRequestItem (p. 398)• Credential (p. 399)• EventsConfiguration (p. 400)• GeoMatchParams (p. 401)• Invite (p. 402)• LoggingConfiguration (p. 403)• MediaPlacement (p. 404)• Meeting (p. 406)• MeetingNotificationConfiguration (p. 407)• Member (p. 408)• MemberError (p. 410)• MembershipItem (p. 411)• OrderedPhoneNumber (p. 412)• Origination (p. 413)• OriginationRoute (p. 414)• Participant (p. 416)• PhoneNumber (p. 417)• PhoneNumberAssociation (p. 419)• PhoneNumberCapabilities (p. 420)• PhoneNumberError (p. 422)• PhoneNumberOrder (p. 423)• Proxy (p. 425)• ProxySession (p. 426)• RetentionSettings (p. 429)• Room (p. 430)• RoomMembership (p. 432)• RoomRetentionSettings (p. 434)
API Version 2018-05-01386
Amazon Chime API Reference
• SigninDelegateGroup (p. 435)• StreamingConfiguration (p. 436)• StreamingNotificationTarget (p. 437)• Tag (p. 438)• TelephonySettings (p. 439)• Termination (p. 440)• TerminationHealth (p. 442)• UpdatePhoneNumberRequestItem (p. 443)• UpdateUserRequestItem (p. 444)• User (p. 445)• UserError (p. 448)• UserSettings (p. 449)• VoiceConnector (p. 450)• VoiceConnectorGroup (p. 452)• VoiceConnectorItem (p. 454)• VoiceConnectorSettings (p. 455)
API Version 2018-05-01387
Amazon Chime API ReferenceAccount
AccountThe Amazon Chime account details. An AWS account can have multiple Amazon Chime accounts.
ContentsAccountId
The Amazon Chime account ID.
Type: String
Required: YesAccountType
The Amazon Chime account type. For more information about different account types, see ManagingYour Amazon Chime Accounts in the Amazon Chime Administration Guide.
Type: String
Valid Values: Team | EnterpriseDirectory | EnterpriseLWA | EnterpriseOIDC
Required: NoAwsAccountId
The AWS account ID.
Type: String
Required: YesCreatedTimestamp
The Amazon Chime account creation timestamp, in ISO 8601 format.
Type: Timestamp
Required: NoDefaultLicense
The default license for the Amazon Chime account.
Type: String
Valid Values: Basic | Plus | Pro | ProTrial
Required: NoName
The Amazon Chime account name.
Type: String
Required: YesSigninDelegateGroups
The sign-in delegate groups associated with the account.
Type: Array of SigninDelegateGroup (p. 435) objects
API Version 2018-05-01388
Amazon Chime API ReferenceSee Also
Required: NoSupportedLicenses
Supported licenses for the Amazon Chime account.
Type: Array of strings
Valid Values: Basic | Plus | Pro | ProTrial
Required: No
See AlsoFor 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• AWS SDK for Ruby V3
API Version 2018-05-01389
Amazon Chime API ReferenceAccountSettings
AccountSettingsSettings related to the Amazon Chime account. This includes settings that start or stop remote controlof shared screens, or start or stop the dial-out option in the Amazon Chime web application. For moreinformation about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.
ContentsDisableRemoteControl
Setting that stops or starts remote control of shared screens during meetings.
Type: Boolean
Required: NoEnableDialOut
Setting that allows meeting participants to choose the Call me at a phone number option. For moreinformation, see Join a Meeting without the Amazon Chime App.
Type: Boolean
Required: No
See AlsoFor 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• AWS SDK for Ruby V3
API Version 2018-05-01390
Amazon Chime API ReferenceAlexaForBusinessMetadata
AlexaForBusinessMetadataThe Alexa for Business metadata associated with an Amazon Chime user, used to integrate Alexa forBusiness with a device.
ContentsAlexaForBusinessRoomArn
The ARN of the room resource.
Type: String
Required: NoIsAlexaForBusinessEnabled
Starts or stops Alexa for Business.
Type: Boolean
Required: No
See AlsoFor 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• AWS SDK for Ruby V3
API Version 2018-05-01391
Amazon Chime API ReferenceAttendee
AttendeeAn Amazon Chime SDK meeting attendee. Includes a unique AttendeeId and JoinToken. TheJoinToken allows a client to authenticate and join as the specified attendee. The JoinToken expireswhen the meeting ends or when DeleteAttendee (p. 92) is called. After that, the attendee is unable tojoin the meeting.
We recommend securely transferring each JoinToken from your server application to the client so thatno other client has access to the token except for the one authorized to represent the attendee.
ContentsAttendeeId
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: NoExternalUserId
The Amazon Chime SDK external user ID. Links the attendee to an identity managed by a builderapplication.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 64.
Required: NoJoinToken
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 AlsoFor 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• AWS SDK for Ruby V3
API Version 2018-05-01392
Amazon Chime API ReferenceBot
BotA resource that allows Enterprise account administrators to configure an interface to receive events fromAmazon Chime.
ContentsBotEmail
The bot email address.
Type: String
Required: NoBotId
The bot ID.
Type: String
Required: NoBotType
The bot type.
Type: String
Valid Values: ChatBot
Required: NoCreatedTimestamp
The bot creation timestamp, in ISO 8601 format.
Type: Timestamp
Required: NoDisabled
When true, the bot is stopped from running in your account.
Type: Boolean
Required: NoDisplayName
The bot display name.
Type: String
Required: NoSecurityToken
The security token used to authenticate Amazon Chime with the outgoing event endpoint.
Type: String
Required: No
API Version 2018-05-01393
Amazon Chime API ReferenceSee Also
UpdatedTimestamp
The updated bot timestamp, in ISO 8601 format.
Type: Timestamp
Required: NoUserId
The unique ID for the bot user.
Type: String
Required: No
See AlsoFor 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• AWS SDK for Ruby V3
API Version 2018-05-01394
Amazon Chime API ReferenceBusinessCallingSettings
BusinessCallingSettingsThe Amazon Chime Business Calling settings for the administrator's AWS account. Includes any AmazonS3 buckets designated for storing call detail records.
ContentsCdrBucket
The Amazon S3 bucket designated for call detail record storage.
Type: String
Required: No
See AlsoFor 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• AWS SDK for Ruby V3
API Version 2018-05-01395
Amazon Chime API ReferenceConversationRetentionSettings
ConversationRetentionSettingsThe retention settings that determine how long to retain chat conversation messages for an AmazonChime Enterprise account.
ContentsRetentionDays
The number of days for which to retain chat conversation messages.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 5475.
Required: No
See AlsoFor 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• AWS SDK for Ruby V3
API Version 2018-05-01396
Amazon Chime API ReferenceCreateAttendeeError
CreateAttendeeErrorThe list of errors returned when errors are encountered during the BatchCreateAttendee andCreateAttendee actions. This includes external user IDs, error codes, and error messages.
ContentsErrorCode
The error code.
Type: String
Required: NoErrorMessage
The error message.
Type: String
Required: NoExternalUserId
The Amazon Chime SDK external user ID. Links the attendee to an identity managed by a builderapplication.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 64.
Required: No
See AlsoFor 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• AWS SDK for Ruby V3
API Version 2018-05-01397
Amazon Chime API ReferenceCreateAttendeeRequestItem
CreateAttendeeRequestItemThe Amazon Chime SDK attendee fields to create, used with the BatchCreateAttendee action.
ContentsExternalUserId
The Amazon Chime SDK external user ID. Links the attendee to an identity managed by a builderapplication.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 64.
Required: YesTags
The tag key-value pairs.
Type: Array of Tag (p. 438) objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: No
See AlsoFor 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• AWS SDK for Ruby V3
API Version 2018-05-01398
Amazon Chime API ReferenceCredential
CredentialThe SIP credentials used to authenticate requests to your Amazon Chime Voice Connector.
ContentsPassword
The RFC2617 compliant password associated with the SIP credentials, in US-ASCII format.
Type: String
Required: NoUsername
The RFC2617 compliant user name associated with the SIP credentials, in US-ASCII format.
Type: String
Required: No
See AlsoFor 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• AWS SDK for Ruby V3
API Version 2018-05-01399
Amazon Chime API ReferenceEventsConfiguration
EventsConfigurationThe configuration that allows a bot to receive outgoing events. Can be either an HTTPS endpoint or aLambda function ARN.
ContentsBotId
The bot ID.
Type: String
Required: NoLambdaFunctionArn
Lambda function ARN that allows a bot to receive outgoing events.
Type: String
Required: NoOutboundEventsHTTPSEndpoint
HTTPS endpoint that allows a bot to receive outgoing events.
Type: String
Required: No
See AlsoFor 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• AWS SDK for Ruby V3
API Version 2018-05-01400
Amazon Chime API ReferenceGeoMatchParams
GeoMatchParamsThe country and area code for a proxy phone number in a proxy phone session.
ContentsAreaCode
The area code.
Type: String
Pattern: ^$|^[0-9]{3,3}$
Required: YesCountry
The country.
Type: String
Pattern: ^$|^[A-Z]{2,2}$
Required: Yes
See AlsoFor 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• AWS SDK for Ruby V3
API Version 2018-05-01401
Amazon Chime API ReferenceInvite
InviteInvitation object returned after emailing users to invite them to join the Amazon Chime Team account.
ContentsEmailAddress
The email address to which the invite is sent.
Type: String
Pattern: .+@.+\..+
Required: NoEmailStatus
The status of the invite email.
Type: String
Valid Values: NotSent | Sent | Failed
Required: NoInviteId
The invite ID.
Type: String
Required: NoStatus
The status of the invite.
Type: String
Valid Values: Pending | Accepted | Failed
Required: No
See AlsoFor 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• AWS SDK for Ruby V3
API Version 2018-05-01402
Amazon Chime API ReferenceLoggingConfiguration
LoggingConfigurationThe logging configuration associated with an Amazon Chime Voice Connector. Specifies whether SIPmessage logs are enabled for sending to Amazon CloudWatch Logs.
ContentsEnableSIPLogs
When true, enables SIP message logs for sending to Amazon CloudWatch Logs.
Type: Boolean
Required: No
See AlsoFor 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• AWS SDK for Ruby V3
API Version 2018-05-01403
Amazon Chime API ReferenceMediaPlacement
MediaPlacementA set of endpoints used by clients to connect to the media service group for a Amazon Chime SDKmeeting.
ContentsAudioFallbackUrl
The audio fallback URL.
Type: String
Length Constraints: Maximum length of 4096.
Required: NoAudioHostUrl
The audio host URL.
Type: String
Length Constraints: Maximum length of 4096.
Required: NoScreenDataUrl
The screen data URL.
Type: String
Length Constraints: Maximum length of 4096.
Required: NoScreenSharingUrl
The screen sharing URL.
Type: String
Length Constraints: Maximum length of 4096.
Required: NoScreenViewingUrl
The screen viewing URL.
Type: String
Length Constraints: Maximum length of 4096.
Required: NoSignalingUrl
The signaling URL.
Type: String
Length Constraints: Maximum length of 4096.
API Version 2018-05-01404
Amazon Chime API ReferenceSee Also
Required: NoTurnControlUrl
The turn control URL.
Type: String
Length Constraints: Maximum length of 4096.
Required: No
See AlsoFor 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• AWS SDK for Ruby V3
API Version 2018-05-01405
Amazon Chime API ReferenceMeeting
MeetingA meeting created using the Amazon Chime SDK.
ContentsExternalMeetingId
The external meeting ID.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 64.
Required: NoMediaPlacement
The media placement for the meeting.
Type: MediaPlacement (p. 404) object
Required: NoMediaRegion
The Region in which to create the meeting. Available values: ap-northeast-1, ap-southeast-1,ap-southeast-2, ca-central-1, eu-central-1, eu-north-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: NoMeetingId
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 AlsoFor 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• AWS SDK for Ruby V3
API Version 2018-05-01406
Amazon Chime API ReferenceMeetingNotificationConfiguration
MeetingNotificationConfigurationThe configuration for resource targets to receive notifications when Amazon Chime SDK meeting andattendee events occur. The Amazon Chime SDK supports resource targets located in the US East (N.Virginia) AWS Region (us-east-1).
ContentsSnsTopicArn
The SNS topic ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: ^arn[\/\:\-\_\.a-zA-Z0-9]+$
Required: NoSqsQueueArn
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 AlsoFor 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• AWS SDK for Ruby V3
API Version 2018-05-01407
Amazon Chime API ReferenceMember
MemberThe member details, such as email address, name, member ID, and member type.
ContentsAccountId
The Amazon Chime account ID.
Type: String
Pattern: .*\S.*
Required: NoEmail
The member email address.
Type: String
Required: NoFullName
The member name.
Type: String
Required: NoMemberId
The member ID (user ID or bot ID).
Type: String
Pattern: .*\S.*
Required: NoMemberType
The member type.
Type: String
Valid Values: User | Bot | Webhook
Required: No
See AlsoFor 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• AWS SDK for Ruby V3
API Version 2018-05-01408
Amazon Chime API ReferenceSee Also
API Version 2018-05-01409
Amazon Chime API ReferenceMemberError
MemberErrorThe list of errors returned when a member action results in an error.
ContentsErrorCode
The error code.
Type: String
Valid Values: BadRequest | Conflict | Forbidden | NotFound | PreconditionFailed| ResourceLimitExceeded | ServiceFailure | AccessDenied |ServiceUnavailable | Throttled | Unauthorized | Unprocessable |VoiceConnectorGroupAssociationsExist | PhoneNumberAssociationsExist
Required: NoErrorMessage
The error message.
Type: String
Required: NoMemberId
The member ID.
Type: String
Pattern: .*\S.*
Required: No
See AlsoFor 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• AWS SDK for Ruby V3
API Version 2018-05-01410
Amazon Chime API ReferenceMembershipItem
MembershipItemMembership details, such as member ID and member role.
ContentsMemberId
The member ID.
Type: String
Pattern: .*\S.*
Required: NoRole
The member role.
Type: String
Valid Values: Administrator | Member
Required: No
See AlsoFor 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• AWS SDK for Ruby V3
API Version 2018-05-01411
Amazon Chime API ReferenceOrderedPhoneNumber
OrderedPhoneNumberA phone number for which an order has been placed.
ContentsE164PhoneNumber
The phone number, in E.164 format.
Type: String
Pattern: ^\+?[1-9]\d{1,14}$
Required: NoStatus
The phone number status.
Type: String
Valid Values: Processing | Acquired | Failed
Required: No
See AlsoFor 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• AWS SDK for Ruby V3
API Version 2018-05-01412
Amazon Chime API ReferenceOrigination
OriginationOrigination settings enable your SIP hosts to receive inbound calls using your Amazon Chime VoiceConnector.
ContentsDisabled
When origination settings are disabled, inbound calls are not enabled for your Amazon Chime VoiceConnector.
Type: Boolean
Required: NoRoutes
The call distribution properties defined for your SIP hosts. Valid range: Minimum value of 1.Maximum value of 20.
Type: Array of OriginationRoute (p. 414) objects
Required: No
See AlsoFor 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• AWS SDK for Ruby V3
API Version 2018-05-01413
Amazon Chime API ReferenceOriginationRoute
OriginationRouteOrigination routes define call distribution properties for your SIP hosts to receive inbound calls usingyour Amazon Chime Voice Connector. Limit: Ten origination routes for each Amazon Chime VoiceConnector.
ContentsHost
The FQDN or IP address to contact for origination traffic.
Type: String
Required: NoPort
The designated origination route port. Defaults to 5060.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 65535.
Required: NoPriority
The priority associated with the host, with 1 being the highest priority. Higher priority hosts areattempted first.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: NoProtocol
The protocol to use for the origination route. Encryption-enabled Amazon Chime Voice Connectorsuse TCP protocol by default.
Type: String
Valid Values: TCP | UDP
Required: NoWeight
The weight associated with the host. If hosts are equal in priority, calls are distributed among thembased on their relative weight.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
API Version 2018-05-01414
Amazon Chime API ReferenceSee Also
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2018-05-01415
Amazon Chime API ReferenceParticipant
ParticipantThe phone number and proxy phone number for a participant in an Amazon Chime Voice Connectorproxy session.
ContentsPhoneNumber
The participant's phone number.
Type: String
Pattern: ^\+?[1-9]\d{1,14}$
Required: NoProxyPhoneNumber
The participant's proxy phone number.
Type: String
Pattern: ^\+?[1-9]\d{1,14}$
Required: No
See AlsoFor 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• AWS SDK for Ruby V3
API Version 2018-05-01416
Amazon Chime API ReferencePhoneNumber
PhoneNumberA phone number used for Amazon Chime Business Calling or an Amazon Chime Voice Connector.
ContentsAssociations
The phone number associations.
Type: Array of PhoneNumberAssociation (p. 419) objects
Required: NoCallingName
The outbound calling name associated with the phone number.
Type: String
Pattern: ^$|^[a-zA-Z0-9 ]{2,15}$
Required: NoCallingNameStatus
The outbound calling name status.
Type: String
Valid Values: Unassigned | UpdateInProgress | UpdateSucceeded | UpdateFailed
Required: NoCapabilities
The phone number capabilities.
Type: PhoneNumberCapabilities (p. 420) object
Required: NoCreatedTimestamp
The phone number creation timestamp, in ISO 8601 format.
Type: Timestamp
Required: NoDeletionTimestamp
The deleted phone number timestamp, in ISO 8601 format.
Type: Timestamp
Required: NoE164PhoneNumber
The phone number, in E.164 format.
Type: String
API Version 2018-05-01417
Amazon Chime API ReferenceSee Also
Pattern: ^\+?[1-9]\d{1,14}$
Required: NoPhoneNumberId
The phone number ID.
Type: String
Required: NoProductType
The phone number product type.
Type: String
Valid Values: BusinessCalling | VoiceConnector
Required: NoStatus
The phone number status.
Type: String
Valid Values: AcquireInProgress | AcquireFailed | Unassigned | Assigned |ReleaseInProgress | DeleteInProgress | ReleaseFailed | DeleteFailed
Required: NoType
The phone number type.
Type: String
Valid Values: Local | TollFree
Required: NoUpdatedTimestamp
The updated phone number timestamp, in ISO 8601 format.
Type: Timestamp
Required: No
See AlsoFor 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• AWS SDK for Ruby V3
API Version 2018-05-01418
Amazon Chime API ReferencePhoneNumberAssociation
PhoneNumberAssociationThe phone number associations, such as Amazon Chime account ID, Amazon Chime user ID, AmazonChime Voice Connector ID, or Amazon Chime Voice Connector group ID.
ContentsAssociatedTimestamp
The timestamp of the phone number association, in ISO 8601 format.
Type: Timestamp
Required: NoName
Defines the association with an Amazon Chime account ID, user ID, Amazon Chime Voice ConnectorID, or Amazon Chime Voice Connector group ID.
Type: String
Valid Values: AccountId | UserId | VoiceConnectorId | VoiceConnectorGroupId
Required: NoValue
Contains the ID for the entity specified in Name.
Type: String
Required: No
See AlsoFor 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• AWS SDK for Ruby V3
API Version 2018-05-01419
Amazon Chime API ReferencePhoneNumberCapabilities
PhoneNumberCapabilitiesThe phone number capabilities for Amazon Chime Business Calling phone numbers, such as enabledinbound and outbound calling and text messaging.
ContentsInboundCall
Allows or denies inbound calling for the specified phone number.
Type: Boolean
Required: NoInboundMMS
Allows or denies inbound MMS messaging for the specified phone number.
Type: Boolean
Required: NoInboundSMS
Allows or denies inbound SMS messaging for the specified phone number.
Type: Boolean
Required: NoOutboundCall
Allows or denies outbound calling for the specified phone number.
Type: Boolean
Required: NoOutboundMMS
Allows or denies outbound MMS messaging for the specified phone number.
Type: Boolean
Required: NoOutboundSMS
Allows or denies outbound SMS messaging for the specified phone number.
Type: Boolean
Required: No
See AlsoFor 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
API Version 2018-05-01420
Amazon Chime API ReferenceSee Also
• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2018-05-01421
Amazon Chime API ReferencePhoneNumberError
PhoneNumberErrorIf the phone number action fails for one or more of the phone numbers in the request, a list of the phonenumbers is returned, along with error codes and error messages.
ContentsErrorCode
The error code.
Type: String
Valid Values: BadRequest | Conflict | Forbidden | NotFound | PreconditionFailed| ResourceLimitExceeded | ServiceFailure | AccessDenied |ServiceUnavailable | Throttled | Unauthorized | Unprocessable |VoiceConnectorGroupAssociationsExist | PhoneNumberAssociationsExist
Required: NoErrorMessage
The error message.
Type: String
Required: NoPhoneNumberId
The phone number ID for which the action failed.
Type: String
Pattern: .*\S.*
Required: No
See AlsoFor 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• AWS SDK for Ruby V3
API Version 2018-05-01422
Amazon Chime API ReferencePhoneNumberOrder
PhoneNumberOrderThe details of a phone number order created for Amazon Chime.
ContentsCreatedTimestamp
The phone number order creation timestamp, 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 phonenumber status.
Type: Array of OrderedPhoneNumber (p. 412) 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
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 timestamp, in ISO 8601 format.
Type: Timestamp
Required: No
API Version 2018-05-01423
Amazon Chime API ReferenceSee Also
See AlsoFor 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• AWS SDK for Ruby V3
API Version 2018-05-01424
Amazon Chime API ReferenceProxy
ProxyThe proxy configuration for an Amazon Chime Voice Connector.
ContentsDefaultSessionExpiryMinutes
The default number of minutes allowed for proxy sessions.
Type: Integer
Required: NoDisabled
When true, stops proxy sessions from being created on the specified Amazon Chime VoiceConnector.
Type: Boolean
Required: NoFallBackPhoneNumber
The phone number to route calls to after a proxy session expires.
Type: String
Pattern: ^\+?[1-9]\d{1,14}$
Required: NoPhoneNumberCountries
The countries for proxy phone numbers to be selected from.
Type: Array of strings
Required: No
See AlsoFor 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• AWS SDK for Ruby V3
API Version 2018-05-01425
Amazon Chime API ReferenceProxySession
ProxySessionThe proxy session for an Amazon Chime Voice Connector.
ContentsCapabilities
The proxy session capabilities.
Type: Array of strings
Valid Values: Voice | SMS
Required: NoCreatedTimestamp
The created timestamp, in ISO 8601 format.
Type: Timestamp
Required: NoEndedTimestamp
The ended timestamp, in ISO 8601 format.
Type: Timestamp
Required: NoExpiryMinutes
The number of minutes allowed for the proxy session.
Type: Integer
Valid Range: Minimum value of 1.
Required: NoGeoMatchLevel
The preference for matching the country or area code of the proxy phone number with that of thefirst participant.
Type: String
Valid Values: Country | AreaCode
Required: NoGeoMatchParams
The country and area code for the proxy phone number.
Type: GeoMatchParams (p. 401) object
Required: NoName
The name of the proxy session.
API Version 2018-05-01426
Amazon Chime API ReferenceContents
Type: String
Length Constraints: Maximum length of 128.
Required: NoNumberSelectionBehavior
The preference for proxy phone number reuse, or stickiness, between the same participants acrosssessions.
Type: String
Valid Values: PreferSticky | AvoidSticky
Required: NoParticipants
The proxy session participants.
Type: Array of Participant (p. 416) objects
Required: NoProxySessionId
The proxy session ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: .*\S.*
Required: NoStatus
The status of the proxy session.
Type: String
Valid Values: Open | InProgress | Closed
Required: NoUpdatedTimestamp
The updated timestamp, in ISO 8601 format.
Type: Timestamp
Required: NoVoiceConnectorId
The Amazon Chime voice connector ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: .*\S.*
Required: No
API Version 2018-05-01427
Amazon Chime API ReferenceSee Also
See AlsoFor 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• AWS SDK for Ruby V3
API Version 2018-05-01428
Amazon Chime API ReferenceRetentionSettings
RetentionSettingsThe retention settings for an Amazon Chime Enterprise account that determine how long to retain itemssuch as chat room messages and chat conversation messages.
ContentsConversationRetentionSettings
The chat conversation retention settings.
Type: ConversationRetentionSettings (p. 396) object
Required: NoRoomRetentionSettings
The chat room retention settings.
Type: RoomRetentionSettings (p. 434) object
Required: No
See AlsoFor 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• AWS SDK for Ruby V3
API Version 2018-05-01429
Amazon Chime API ReferenceRoom
RoomThe Amazon Chime chat room details.
ContentsAccountId
The Amazon Chime account ID.
Type: String
Pattern: .*\S.*
Required: NoCreatedBy
The identifier of the room creator.
Type: String
Pattern: .*\S.*
Required: NoCreatedTimestamp
The room creation timestamp, in ISO 8601 format.
Type: Timestamp
Required: NoName
The room name.
Type: String
Required: NoRoomId
The room ID.
Type: String
Pattern: .*\S.*
Required: NoUpdatedTimestamp
The room update timestamp, in ISO 8601 format.
Type: Timestamp
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
API Version 2018-05-01430
Amazon Chime API ReferenceSee Also
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2018-05-01431
Amazon Chime API ReferenceRoomMembership
RoomMembershipThe room membership details.
ContentsInvitedBy
The identifier of the user that invited the room member.
Type: String
Pattern: .*\S.*
Required: NoMember
The member details, such as email address, name, member ID, and member type.
Type: Member (p. 408) object
Required: NoRole
The membership role.
Type: String
Valid Values: Administrator | Member
Required: NoRoomId
The room ID.
Type: String
Pattern: .*\S.*
Required: NoUpdatedTimestamp
The room membership update timestamp, in ISO 8601 format.
Type: Timestamp
Required: No
See AlsoFor 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• AWS SDK for Ruby V3
API Version 2018-05-01432
Amazon Chime API ReferenceSee Also
API Version 2018-05-01433
Amazon Chime API ReferenceRoomRetentionSettings
RoomRetentionSettingsThe retention settings that determine how long to retain chat room messages for an Amazon ChimeEnterprise account.
ContentsRetentionDays
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 AlsoFor 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• AWS SDK for Ruby V3
API Version 2018-05-01434
Amazon Chime API ReferenceSigninDelegateGroup
SigninDelegateGroupAn Active Directory (AD) group whose members are granted permission to act as delegates.
ContentsGroupName
The group name.
Type: String
Pattern: .*\S.*
Required: No
See AlsoFor 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• AWS SDK for Ruby V3
API Version 2018-05-01435
Amazon Chime API ReferenceStreamingConfiguration
StreamingConfigurationThe streaming configuration associated with an Amazon Chime Voice Connector. Specifies whethermedia streaming is enabled for sending to Amazon Kinesis, and shows the retention period for theAmazon Kinesis data, in hours.
ContentsDataRetentionInHours
The retention period, in hours, for the Amazon Kinesis data.
Type: Integer
Valid Range: Minimum value of 0.
Required: YesDisabled
When true, media streaming to Amazon Kinesis is turned off.
Type: Boolean
Required: NoStreamingNotificationTargets
The streaming notification targets.
Type: Array of StreamingNotificationTarget (p. 437) objects
Array Members: Minimum number of 1 item. Maximum number of 3 items.
Required: No
See AlsoFor 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• AWS SDK for Ruby V3
API Version 2018-05-01436
Amazon Chime API ReferenceStreamingNotificationTarget
StreamingNotificationTargetThe targeted recipient for a streaming configuration notification.
ContentsNotificationTarget
The streaming notification target.
Type: String
Valid Values: EventBridge | SNS | SQS
Required: Yes
See AlsoFor 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• AWS SDK for Ruby V3
API Version 2018-05-01437
Amazon Chime API ReferenceTag
TagDescribes a tag applied to a resource.
ContentsKey
The key of the tag.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: YesValue
The value of the tag.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: Yes
See AlsoFor 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• AWS SDK for Ruby V3
API Version 2018-05-01438
Amazon Chime API ReferenceTelephonySettings
TelephonySettingsSettings that allow management of telephony permissions for an Amazon Chime user, such as inboundand outbound calling and text messaging.
ContentsInboundCalling
Allows or denies inbound calling.
Type: Boolean
Required: YesOutboundCalling
Allows or denies outbound calling.
Type: Boolean
Required: YesSMS
Allows or denies SMS messaging.
Type: Boolean
Required: Yes
See AlsoFor 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• AWS SDK for Ruby V3
API Version 2018-05-01439
Amazon Chime API ReferenceTermination
TerminationTermination settings enable your SIP hosts to make outbound calls using your Amazon Chime VoiceConnector.
ContentsCallingRegions
The countries to which calls are allowed, in ISO 3166-1 alpha-2 format. Required.
Type: Array of strings
Required: NoCidrAllowedList
The IP addresses allowed to make calls, in CIDR format. Required.
Type: Array of strings
Required: NoCpsLimit
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: NoDefaultPhoneNumber
The default caller ID phone number.
Type: String
Pattern: ^\+?[1-9]\d{1,14}$
Required: NoDisabled
When termination settings are disabled, outbound calls can not be made.
Type: Boolean
Required: No
See AlsoFor 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• AWS SDK for Ruby V3
API Version 2018-05-01440
Amazon Chime API ReferenceSee Also
API Version 2018-05-01441
Amazon Chime API ReferenceTerminationHealth
TerminationHealthThe termination health details, including the source IP address and timestamp of the last successful SIPOPTIONS message from your SIP infrastructure.
ContentsSource
The source IP address.
Type: String
Required: NoTimestamp
The timestamp, in ISO 8601 format.
Type: Timestamp
Required: No
See AlsoFor 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• AWS SDK for Ruby V3
API Version 2018-05-01442
Amazon Chime API ReferenceUpdatePhoneNumberRequestItem
UpdatePhoneNumberRequestItemThe phone number ID, product type, or calling name fields to update, used with theBatchUpdatePhoneNumber (p. 37) and UpdatePhoneNumber (p. 352) actions.
ContentsCallingName
The outbound calling name to update.
Type: String
Pattern: ^$|^[a-zA-Z0-9 ]{2,15}$
Required: NoPhoneNumberId
The phone number ID to update.
Type: String
Pattern: .*\S.*
Required: YesProductType
The product type to update.
Type: String
Valid Values: BusinessCalling | VoiceConnector
Required: No
See AlsoFor 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• AWS SDK for Ruby V3
API Version 2018-05-01443
Amazon Chime API ReferenceUpdateUserRequestItem
UpdateUserRequestItemThe user ID and user fields to update, used with the BatchUpdateUser (p. 41) action.
ContentsAlexaForBusinessMetadata
The Alexa for Business metadata.
Type: AlexaForBusinessMetadata (p. 391) object
Required: NoLicenseType
The user license type.
Type: String
Valid Values: Basic | Plus | Pro | ProTrial
Required: NoUserId
The user ID.
Type: String
Pattern: .*\S.*
Required: YesUserType
The user type.
Type: String
Valid Values: PrivateUser | SharedDevice
Required: No
See AlsoFor 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• AWS SDK for Ruby V3
API Version 2018-05-01444
Amazon Chime API ReferenceUser
UserThe user on the Amazon Chime account.
ContentsAccountId
The Amazon Chime account ID.
Type: String
Required: NoAlexaForBusinessMetadata
The Alexa for Business metadata.
Type: AlexaForBusinessMetadata (p. 391) object
Required: NoDisplayName
The display name of the user.
Type: String
Required: NoInvitedOn
Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.
Type: Timestamp
Required: NoLicenseType
The license type for the user.
Type: String
Valid Values: Basic | Plus | Pro | ProTrial
Required: NoPersonalPIN
The user's personal meeting PIN.
Type: String
Required: NoPrimaryEmail
The primary email address of the user.
Type: String
Pattern: .+@.+\..+
API Version 2018-05-01445
Amazon Chime API ReferenceSee Also
Required: NoPrimaryProvisionedNumber
The primary phone number associated with the user.
Type: String
Required: NoRegisteredOn
Date and time when the user is registered, in ISO 8601 format.
Type: Timestamp
Required: NoUserId
The user ID.
Type: String
Required: YesUserInvitationStatus
The user invite status.
Type: String
Valid Values: Pending | Accepted | Failed
Required: NoUserRegistrationStatus
The user registration status.
Type: String
Valid Values: Unregistered | Registered | Suspended
Required: NoUserType
The user type.
Type: String
Valid Values: PrivateUser | SharedDevice
Required: No
See AlsoFor 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
API Version 2018-05-01446
Amazon Chime API ReferenceSee Also
• AWS SDK for Ruby V3
API Version 2018-05-01447
Amazon Chime API ReferenceUserError
UserErrorThe list of errors returned when errors are encountered during the BatchSuspendUser (p. 29),BatchUnsuspendUser (p. 33), or BatchUpdateUser (p. 41) actions. This includes user IDs, error codes, anderror messages.
ContentsErrorCode
The error code.
Type: String
Valid Values: BadRequest | Conflict | Forbidden | NotFound | PreconditionFailed| ResourceLimitExceeded | ServiceFailure | AccessDenied |ServiceUnavailable | Throttled | Unauthorized | Unprocessable |VoiceConnectorGroupAssociationsExist | PhoneNumberAssociationsExist
Required: NoErrorMessage
The error message.
Type: String
Required: NoUserId
The user ID for which the action failed.
Type: String
Pattern: .*\S.*
Required: No
See AlsoFor 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• AWS SDK for Ruby V3
API Version 2018-05-01448
Amazon Chime API ReferenceUserSettings
UserSettingsSettings associated with an Amazon Chime user, including inbound and outbound calling and textmessaging.
ContentsTelephony
The telephony settings associated with the user.
Type: TelephonySettings (p. 439) object
Required: Yes
See AlsoFor 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• AWS SDK for Ruby V3
API Version 2018-05-01449
Amazon Chime API ReferenceVoiceConnector
VoiceConnectorThe Amazon Chime Voice Connector configuration, including outbound host name and encryptionsettings.
ContentsAwsRegion
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: NoCreatedTimestamp
The Amazon Chime Voice Connector creation timestamp, in ISO 8601 format.
Type: Timestamp
Required: NoName
The name of the Amazon Chime Voice Connector.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: NoOutboundHostName
The outbound host name for the Amazon Chime Voice Connector.
Type: String
Required: NoRequireEncryption
Designates whether encryption is required for the Amazon Chime Voice Connector.
Type: Boolean
Required: NoUpdatedTimestamp
The updated Amazon Chime Voice Connector timestamp, in ISO 8601 format.
Type: Timestamp
Required: NoVoiceConnectorId
The Amazon Chime Voice Connector ID.
Type: String
API Version 2018-05-01450
Amazon Chime API ReferenceSee Also
Pattern: .*\S.*
Required: No
See AlsoFor 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• AWS SDK for Ruby V3
API Version 2018-05-01451
Amazon Chime API ReferenceVoiceConnectorGroup
VoiceConnectorGroupThe Amazon Chime Voice Connector group configuration, including associated Amazon Chime VoiceConnectors. 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.
ContentsCreatedTimestamp
The Amazon Chime Voice Connector group creation timestamp, in ISO 8601 format.
Type: Timestamp
Required: NoName
The name of the Amazon Chime Voice Connector group.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: NoUpdatedTimestamp
The updated Amazon Chime Voice Connector group timestamp, in ISO 8601 format.
Type: Timestamp
Required: NoVoiceConnectorGroupId
The Amazon Chime Voice Connector group ID.
Type: String
Pattern: .*\S.*
Required: NoVoiceConnectorItems
The Amazon Chime Voice Connectors to which to route inbound calls.
Type: Array of VoiceConnectorItem (p. 454) objects
Required: No
See AlsoFor 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
API Version 2018-05-01452
Amazon Chime API ReferenceSee Also
• AWS SDK for Ruby V3
API Version 2018-05-01453
Amazon Chime API ReferenceVoiceConnectorItem
VoiceConnectorItemFor Amazon Chime Voice Connector groups, the Amazon Chime Voice Connectors to which to routeinbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per AmazonChime Voice Connector group.
ContentsPriority
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: YesVoiceConnectorId
The Amazon Chime Voice Connector ID.
Type: String
Pattern: .*\S.*
Required: Yes
See AlsoFor 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• AWS SDK for Ruby V3
API Version 2018-05-01454
Amazon Chime API ReferenceVoiceConnectorSettings
VoiceConnectorSettingsThe Amazon Chime Voice Connector settings. Includes any Amazon S3 buckets designated for storingcall detail records.
ContentsCdrBucket
The Amazon S3 bucket designated for call detail record storage.
Type: String
Required: No
See AlsoFor 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• AWS SDK for Ruby V3
API Version 2018-05-01455
Amazon Chime API Reference
Common ParametersThe following list contains the parameters that all actions use for signing Signature Version 4 requestswith a query string. Any action-specific parameters are listed in the topic for that action. For moreinformation about Signature Version 4, see Signature Version 4 Signing Process in the Amazon WebServices General Reference.
Action
The action to be performed.
Type: string
Required: YesVersion
The API version that the request is written for, expressed in the format YYYY-MM-DD.
Type: string
Required: YesX-Amz-Algorithm
The hash algorithm that you used to create the request signature.
Condition: Specify this parameter when you include authentication information in a query stringinstead of in the HTTP authorization header.
Type: string
Valid Values: AWS4-HMAC-SHA256
Required: ConditionalX-Amz-Credential
The credential scope value, which is a string that includes your access key, the date, the region youare targeting, the service you are requesting, and a termination string ("aws4_request"). The value isexpressed in the following format: access_key/YYYYMMDD/region/service/aws4_request.
For more information, see Task 2: Create a String to Sign for Signature Version 4 in the Amazon WebServices General Reference.
Condition: Specify this parameter when you include authentication information in a query stringinstead of in the HTTP authorization header.
Type: string
Required: ConditionalX-Amz-Date
The date that is used to create the signature. The format must be ISO 8601 basic format(YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value:20120325T120000Z.
Condition: X-Amz-Date is optional for all requests; it can be used to override the date used forsigning requests. If the Date header is specified in the ISO 8601 basic format, X-Amz-Date is
API Version 2018-05-01456
Amazon Chime API Reference
not required. When X-Amz-Date is used, it always overrides the value of the Date header. Formore information, see Handling Dates in Signature Version 4 in the Amazon Web Services GeneralReference.
Type: string
Required: ConditionalX-Amz-Security-Token
The temporary security token that was obtained through a call to AWS Security Token Service (AWSSTS). For a list of services that support temporary security credentials from AWS Security TokenService, go to AWS Services That Work with IAM in the IAM User Guide.
Condition: If you're using temporary security credentials from the AWS Security Token Service, youmust include the security token.
Type: string
Required: ConditionalX-Amz-Signature
Specifies the hex-encoded signature that was calculated from the string to sign and the derivedsigning key.
Condition: Specify this parameter when you include authentication information in a query stringinstead of in the HTTP authorization header.
Type: string
Required: ConditionalX-Amz-SignedHeaders
Specifies all the HTTP headers that were included as part of the canonical request. For moreinformation about specifying signed headers, see Task 1: Create a Canonical Request For SignatureVersion 4 in the Amazon Web Services General Reference.
Condition: Specify this parameter when you include authentication information in a query stringinstead of in the HTTP authorization header.
Type: string
Required: Conditional
API Version 2018-05-01457
Amazon Chime API Reference
Common ErrorsThis section lists the errors common to the API actions of all AWS services. For errors specific to an APIaction for this service, see the topic for that API action.
AccessDeniedException
You do not have sufficient access to perform this action.
HTTP Status Code: 400IncompleteSignature
The request signature does not conform to AWS standards.
HTTP Status Code: 400InternalFailure
The request processing has failed because of an unknown error, exception or failure.
HTTP Status Code: 500InvalidAction
The action or operation requested is invalid. Verify that the action is typed correctly.
HTTP Status Code: 400InvalidClientTokenId
The X.509 certificate or AWS access key ID provided does not exist in our records.
HTTP Status Code: 403InvalidParameterCombination
Parameters that must not be used together were used together.
HTTP Status Code: 400InvalidParameterValue
An invalid or out-of-range value was supplied for the input parameter.
HTTP Status Code: 400InvalidQueryParameter
The AWS query string is malformed or does not adhere to AWS standards.
HTTP Status Code: 400MalformedQueryString
The query string contains a syntax error.
HTTP Status Code: 404MissingAction
The request is missing an action or a required parameter.
HTTP Status Code: 400
API Version 2018-05-01458
Amazon Chime API Reference
MissingAuthenticationToken
The request must contain either a valid (registered) AWS access key ID or X.509 certificate.
HTTP Status Code: 403MissingParameter
A required parameter for the specified action is not supplied.
HTTP Status Code: 400OptInRequired
The AWS access key ID needs a subscription for the service.
HTTP Status Code: 403RequestExpired
The request reached the service more than 15 minutes after the date stamp on the request or morethan 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stampon the request is more than 15 minutes in the future.
HTTP Status Code: 400ServiceUnavailable
The request has failed due to a temporary failure of the server.
HTTP Status Code: 503ThrottlingException
The request was denied due to request throttling.
HTTP Status Code: 400ValidationError
The input fails to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
API Version 2018-05-01459
Top Related