alexa for business - alexa for business api · alexa for business alexa for business api api...

Alexa For BusinessAlexa for Business API

API Version 2017-11-09

Alexa For Business Alexa for Business API

Alexa For Business: Alexa for Business APICopyright © 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.


Table of ContentsWelcome .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Actions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

ApproveSkill .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

AssociateContactWithAddressBook .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

AssociateDeviceWithNetworkProfile .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

AssociateDeviceWithRoom ..... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

AssociateSkillGroupWithRoom ..... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

AssociateSkillWithSkillGroup .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

AssociateSkillWithUsers ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

CreateAddressBook .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

CreateBusinessReportSchedule .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

API Version 2017-11-09iii


Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

CreateConferenceProvider ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

CreateContact ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

CreateGatewayGroup .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

CreateNetworkProfile .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

CreateProfile .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

CreateRoom ..... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

CreateSkillGroup .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

CreateUser .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

API Version 2017-11-09iv


Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

DeleteAddressBook .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

DeleteBusinessReportSchedule .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

DeleteConferenceProvider ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

DeleteContact ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

DeleteDevice .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

DeleteDeviceUsageData .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

DeleteGatewayGroup .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

DeleteNetworkProfile .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

DeleteProfile .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

API Version 2017-11-09v


DeleteRoom ..... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

DeleteRoomSkillParameter ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

DeleteSkillAuthorization .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

DeleteSkillGroup .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

DeleteUser .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

DisassociateContactFromAddressBook .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

DisassociateDeviceFromRoom ..... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

DisassociateSkillFromSkillGroup .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

DisassociateSkillFromUsers .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

DisassociateSkillGroupFromRoom ..... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

API Version 2017-11-09vi


Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

ForgetSmartHomeAppliances .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

GetAddressBook .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

GetConferencePreference .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

GetConferenceProvider ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

GetContact ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

GetDevice .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

GetGateway .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

GetGatewayGroup .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

GetInvitationConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

API Version 2017-11-09vii


Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103

GetNetworkProfile .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

GetProfile .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

GetRoom ..... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

GetRoomSkillParameter ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

GetSkillGroup .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

ListBusinessReportSchedules .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

ListConferenceProviders ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

ListDeviceEvents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

API Version 2017-11-09viii


Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

ListGatewayGroups .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

ListGateways .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124

ListSkills ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

ListSkillsStoreCategories ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

ListSkillsStoreSkillsByCategory .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

ListSmartHomeAppliances .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134

ListTags .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136

PutConferencePreference .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137

API Version 2017-11-09ix


See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137PutInvitationConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140

PutRoomSkillParameter ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

PutSkillAuthorization .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144

RegisterAVSDevice .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

RejectSkill .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

ResolveRoom ..... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

RevokeInvitation .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153

SearchAddressBooks .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156

SearchContacts ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158

API Version 2017-11-09x


Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159

SearchDevices .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162

SearchNetworkProfiles .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165

SearchProfiles .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168

SearchRooms .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171

SearchSkillGroups .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174

SearchUsers ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177

SendAnnouncement .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180

SendInvitation .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182

API Version 2017-11-09xi


StartDeviceSync .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184

StartSmartHomeApplianceDiscovery .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185

TagResource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188

UntagResource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190

UpdateAddressBook .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192

UpdateBusinessReportSchedule .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194

UpdateConferenceProvider ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197

UpdateContact ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200

UpdateDevice .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202

UpdateGateway .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203

API Version 2017-11-09xii


Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204

UpdateGatewayGroup .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206

UpdateNetworkProfile .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209

UpdateProfile .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213

UpdateRoom ..... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215

UpdateSkillGroup .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217

Data Types .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218AddressBook .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220

Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220

AddressBookData .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221

Audio .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222

BusinessReport ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223

BusinessReportContentRange .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224

BusinessReportRecurrence .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225

BusinessReportS3Location .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226

BusinessReportSchedule .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227

API Version 2017-11-09xiii


See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228Category .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229


ConferencePreference .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230

ConferenceProvider ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232

Contact ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234

ContactData .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236

Content .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237

CreateEndOfMeetingReminder .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238

CreateInstantBooking .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239

CreateMeetingRoomConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240

CreateRequireCheckIn .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241

DeveloperInfo .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242

Device .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244

DeviceData .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247

DeviceEvent .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248

DeviceNetworkProfileInfo .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249

DeviceStatusDetail .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250

DeviceStatusInfo .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251

EndOfMeetingReminder .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252

Filter ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253

API Version 2017-11-09xiv


See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253Gateway .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254


GatewayGroup .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256

GatewayGroupSummary .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257

GatewaySummary .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259

InstantBooking .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260

IPDialIn .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261

MeetingRoomConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262

MeetingSetting .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263

NetworkProfile .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266

NetworkProfileData .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268

PhoneNumber .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269

Profile .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272

ProfileData .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274

PSTNDialIn .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275

RequireCheckIn .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277

Room ..... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279

RoomData .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281

RoomSkillParameter ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282

SipAddress .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283

API Version 2017-11-09xv


See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283SkillDetails ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284


SkillGroup .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286

SkillGroupData .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287

SkillsStoreSkill .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289

SkillSummary .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291

SmartHomeAppliance .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292

Sort ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293

Ssml .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294

Tag .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295

Text .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296

UpdateEndOfMeetingReminder .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297

UpdateInstantBooking .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298

UpdateMeetingRoomConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299

UpdateRequireCheckIn .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300

UserData .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302

Common Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303Common Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305

API Version 2017-11-09xvi


WelcomeAlexa for Business helps you use Alexa in your organization. Alexa for Business provides you with thetools to manage Alexa devices, enroll your users, and assign skills, at scale. You can build your owncontext-aware voice skills using the Alexa Skills Kit and the Alexa for Business API operations. You canalso make these available as private skills for your organization. Alexa for Business makes it efficientto voice-enable your products and services, thus providing context-aware voice experiences for yourcustomers. Device makers building with the Alexa Voice Service (AVS) can create fully integratedsolutions, register their products with Alexa for Business, and manage them as shared devices in theirorganization.

This document was last published on August 18, 2020.



ActionsThe following actions are supported:

• ApproveSkill (p. 5)• AssociateContactWithAddressBook (p. 7)• AssociateDeviceWithNetworkProfile (p. 9)• AssociateDeviceWithRoom (p. 11)• AssociateSkillGroupWithRoom (p. 13)• AssociateSkillWithSkillGroup (p. 15)• AssociateSkillWithUsers (p. 17)• CreateAddressBook (p. 19)• CreateBusinessReportSchedule (p. 21)• CreateConferenceProvider (p. 24)• CreateContact (p. 27)• CreateGatewayGroup (p. 30)• CreateNetworkProfile (p. 32)• CreateProfile (p. 36)• CreateRoom (p. 40)• CreateSkillGroup (p. 43)• CreateUser (p. 46)• DeleteAddressBook (p. 49)• DeleteBusinessReportSchedule (p. 51)• DeleteConferenceProvider (p. 53)• DeleteContact (p. 55)• DeleteDevice (p. 57)• DeleteDeviceUsageData (p. 59)• DeleteGatewayGroup (p. 61)• DeleteNetworkProfile (p. 63)• DeleteProfile (p. 65)• DeleteRoom (p. 67)• DeleteRoomSkillParameter (p. 69)• DeleteSkillAuthorization (p. 71)• DeleteSkillGroup (p. 73)• DeleteUser (p. 75)• DisassociateContactFromAddressBook (p. 77)• DisassociateDeviceFromRoom (p. 79)• DisassociateSkillFromSkillGroup (p. 81)• DisassociateSkillFromUsers (p. 83)• DisassociateSkillGroupFromRoom (p. 85)• ForgetSmartHomeAppliances (p. 87)• GetAddressBook (p. 89)• GetConferencePreference (p. 91)• GetConferenceProvider (p. 92)



• GetContact (p. 94)• GetDevice (p. 96)• GetGateway (p. 98)• GetGatewayGroup (p. 100)• GetInvitationConfiguration (p. 102)• GetNetworkProfile (p. 104)• GetProfile (p. 106)• GetRoom (p. 108)• GetRoomSkillParameter (p. 110)• GetSkillGroup (p. 112)• ListBusinessReportSchedules (p. 114)• ListConferenceProviders (p. 116)• ListDeviceEvents (p. 118)• ListGatewayGroups (p. 121)• ListGateways (p. 123)• ListSkills (p. 125)• ListSkillsStoreCategories (p. 128)• ListSkillsStoreSkillsByCategory (p. 130)• ListSmartHomeAppliances (p. 133)• ListTags (p. 135)• PutConferencePreference (p. 137)• PutInvitationConfiguration (p. 139)• PutRoomSkillParameter (p. 141)• PutSkillAuthorization (p. 143)• RegisterAVSDevice (p. 145)• RejectSkill (p. 148)• ResolveRoom (p. 150)• RevokeInvitation (p. 152)• SearchAddressBooks (p. 154)• SearchContacts (p. 157)• SearchDevices (p. 160)• SearchNetworkProfiles (p. 163)• SearchProfiles (p. 166)• SearchRooms (p. 169)• SearchSkillGroups (p. 172)• SearchUsers (p. 175)• SendAnnouncement (p. 178)• SendInvitation (p. 181)• StartDeviceSync (p. 183)• StartSmartHomeApplianceDiscovery (p. 185)• TagResource (p. 187)• UntagResource (p. 189)• UpdateAddressBook (p. 191)• UpdateBusinessReportSchedule (p. 193)• UpdateConferenceProvider (p. 196)• UpdateContact (p. 198)



• UpdateDevice (p. 201)• UpdateGateway (p. 203)• UpdateGatewayGroup (p. 205)• UpdateNetworkProfile (p. 207)• UpdateProfile (p. 210)• UpdateRoom (p. 214)• UpdateSkillGroup (p. 216)


Alexa For Business Alexa for Business APIApproveSkill

ApproveSkillAssociates a skill with the organization under the customer's AWS account. If a skill is private, the userimplicitly accepts access to this skill during enablement.

Request Syntax{ "SkillId": "string"}

Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 303).

The request accepts the following data in JSON format.

SkillId (p. 5)

The unique identifier of the skill.

Type: String

Pattern: (^amzn1\.ask\.skill\.[0-9a-f\-]{1,200})|(^amzn1\.echo-sdk-ams\.app\.[0-9a-f\-]{1,200})

Required: Yes

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. 305).

ConcurrentModificationException

There is a concurrent modification of resources.

HTTP Status Code: 400

LimitExceededException

You are performing an action that would put you beyond your account's limits.


NotFoundException

The resource is not found.



Alexa For Business Alexa for Business APISee 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


https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/ApproveSkill

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/ApproveSkill

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/ApproveSkill

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/ApproveSkill

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/ApproveSkill

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/ApproveSkill

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/ApproveSkill

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/ApproveSkill

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/ApproveSkill

Alexa For Business Alexa for Business APIAssociateContactWithAddressBook

AssociateContactWithAddressBookAssociates a contact with a given address book.

Request Syntax

{ "AddressBookArn": "string", "ContactArn": "string"}



AddressBookArn (p. 7)

The ARN of the address book with which to associate the contact.

Type: String

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

Required: Yes

ContactArn (p. 7)

The ARN of the contact to associate with an address book.

Type: String


Required: Yes











https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/AssociateContactWithAddressBook

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/AssociateContactWithAddressBook

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/AssociateContactWithAddressBook

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/AssociateContactWithAddressBook

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/AssociateContactWithAddressBook

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/AssociateContactWithAddressBook

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/AssociateContactWithAddressBook

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/AssociateContactWithAddressBook

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/AssociateContactWithAddressBook

Alexa For Business Alexa for Business APIAssociateDeviceWithNetworkProfile

AssociateDeviceWithNetworkProfileAssociates a device with the specified network profile.

Request Syntax{ "DeviceArn": "string", "NetworkProfileArn": "string"}



DeviceArn (p. 9)

The device ARN.

Type: String


Required: YesNetworkProfileArn (p. 9)

The ARN of the network profile to associate with a device.

Type: String


Required: Yes





HTTP Status Code: 400DeviceNotRegisteredException

The request failed because this device is no longer registered and therefore no longer managed bythis account.



HTTP Status Code: 400NotFoundException






https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/AssociateDeviceWithNetworkProfile

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/AssociateDeviceWithNetworkProfile

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/AssociateDeviceWithNetworkProfile

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/AssociateDeviceWithNetworkProfile

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/AssociateDeviceWithNetworkProfile

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/AssociateDeviceWithNetworkProfile

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/AssociateDeviceWithNetworkProfile

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/AssociateDeviceWithNetworkProfile

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/AssociateDeviceWithNetworkProfile

Alexa For Business Alexa for Business APIAssociateDeviceWithRoom

AssociateDeviceWithRoomAssociates a device with a given room. This applies all the settings from the room profile to the device,and all the skills in any skill groups added to that room. This operation requires the device to be online,or else a manual sync is required.

Request Syntax{ "DeviceArn": "string", "RoomArn": "string"}



DeviceArn (p. 11)

The ARN of the device to associate to a room. Required.

Type: String


Required: NoRoomArn (p. 11)

The ARN of the room with which to associate the device. Required.

Type: String


Required: No








DeviceNotRegisteredException


HTTP Status Code: 400LimitExceededException






https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/AssociateDeviceWithRoom

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/AssociateDeviceWithRoom

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/AssociateDeviceWithRoom

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/AssociateDeviceWithRoom

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/AssociateDeviceWithRoom

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/AssociateDeviceWithRoom

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/AssociateDeviceWithRoom

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/AssociateDeviceWithRoom

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/AssociateDeviceWithRoom

Alexa For Business Alexa for Business APIAssociateSkillGroupWithRoom

AssociateSkillGroupWithRoomAssociates a skill group with a given room. This enables all skills in the associated skill group on alldevices in the room.

Request Syntax{ "RoomArn": "string", "SkillGroupArn": "string"}



RoomArn (p. 13)

The ARN of the room with which to associate the skill group. Required.

Type: String


Required: No

SkillGroupArn (p. 13)

The ARN of the skill group to associate with a room. Required.

Type: String


Required: No











https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/AssociateSkillGroupWithRoom

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/AssociateSkillGroupWithRoom

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/AssociateSkillGroupWithRoom

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/AssociateSkillGroupWithRoom

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/AssociateSkillGroupWithRoom

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/AssociateSkillGroupWithRoom

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/AssociateSkillGroupWithRoom

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/AssociateSkillGroupWithRoom

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/AssociateSkillGroupWithRoom

Alexa For Business Alexa for Business APIAssociateSkillWithSkillGroup

AssociateSkillWithSkillGroupAssociates a skill with a skill group.

Request Syntax{ "SkillGroupArn": "string", "SkillId": "string"}




The ARN of the skill group to associate the skill to. Required.

Type: String


Required: NoSkillId (p. 15)


Type: String


Required: Yes









HTTP Status Code: 400SkillNotLinkedException

The skill must be linked to a third-party account.





https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/AssociateSkillWithSkillGroup

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/AssociateSkillWithSkillGroup

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/AssociateSkillWithSkillGroup

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/AssociateSkillWithSkillGroup

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/AssociateSkillWithSkillGroup

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/AssociateSkillWithSkillGroup

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/AssociateSkillWithSkillGroup

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/AssociateSkillWithSkillGroup

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/AssociateSkillWithSkillGroup

Alexa For Business Alexa for Business APIAssociateSkillWithUsers

AssociateSkillWithUsersMakes a private skill available for enrolled users to enable on their devices.




SkillId (p. 17)

The private skill ID you want to make available to enrolled users.

Type: String


Required: Yes









• AWS Command Line Interface


https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/AssociateSkillWithUsers


• 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


https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/AssociateSkillWithUsers

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/AssociateSkillWithUsers

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/AssociateSkillWithUsers

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/AssociateSkillWithUsers

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/AssociateSkillWithUsers

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/AssociateSkillWithUsers

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/AssociateSkillWithUsers

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/AssociateSkillWithUsers

Alexa For Business Alexa for Business APICreateAddressBook

CreateAddressBookCreates an address book with the specified details.

Request Syntax

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



ClientRequestToken (p. 19)

A unique, user-specified identifier for the request that ensures idempotency.

Type: String

Length Constraints: Minimum length of 10. Maximum length of 150.

Pattern: [a-zA-Z0-9][a-zA-Z0-9_-]*

Required: No

Description (p. 19)

The description of the address book.

Type: String


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

Required: No

Name (p. 19)

The name of the address book.

Type: String



Required: Yes


Alexa For Business Alexa for Business APIResponse Syntax

Response Syntax{ "AddressBookArn": "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.


The ARN of the newly created address book.

Type: String



AlreadyExistsException

The resource being created already exists.







https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/CreateAddressBook

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/CreateAddressBook

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/CreateAddressBook

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/CreateAddressBook

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/CreateAddressBook

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/CreateAddressBook

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/CreateAddressBook

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/CreateAddressBook

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/CreateAddressBook

Alexa For Business Alexa for Business APICreateBusinessReportSchedule

CreateBusinessReportScheduleCreates a recurring schedule for usage reports to deliver to the specified S3 location with a specifieddaily or weekly interval.

Request Syntax{ "ClientRequestToken": "string", "ContentRange": { "Interval": "string" }, "Format": "string", "Recurrence": { "StartDate": "string" }, "S3BucketName": "string", "S3KeyPrefix": "string", "ScheduleName": "string", "Tags": [ { "Key": "string", "Value": "string" } ]}




The client request token.

Type: String



Required: NoContentRange (p. 21)

The content range of the reports.

Type: BusinessReportContentRange (p. 224) object

Required: YesFormat (p. 21)

The format of the generated report (individual CSV files or zipped files of individual files).

Type: String



Valid Values: CSV | CSV_ZIP

Required: YesRecurrence (p. 21)

The recurrence of the reports. If this isn't specified, the report will only be delivered one time whenthe API is called.

Type: BusinessReportRecurrence (p. 225) object

Required: NoS3BucketName (p. 21)

The S3 bucket name of the output reports. If this isn't specified, the report can be retrieved from adownload link by calling ListBusinessReportSchedule.

Type: String

Pattern: [a-z0-9-\.]{3,63}

Required: NoS3KeyPrefix (p. 21)

The S3 key where the report is delivered.

Type: String


Pattern: [A-Za-z0-9!_\-\.\*'()/]*

Required: NoScheduleName (p. 21)

The name identifier of the schedule.

Type: String



Required: NoTags (p. 21)

The tags for the business report schedule.

Type: Array of Tag (p. 295) objects

Required: No

Response Syntax{ "ScheduleArn": "string"}


Alexa For Business Alexa for Business APIResponse Elements



ScheduleArn (p. 22)

The ARN of the business report schedule.

Type: String









https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/CreateBusinessReportSchedule

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/CreateBusinessReportSchedule

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/CreateBusinessReportSchedule

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/CreateBusinessReportSchedule

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/CreateBusinessReportSchedule

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/CreateBusinessReportSchedule

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/CreateBusinessReportSchedule

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/CreateBusinessReportSchedule

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/CreateBusinessReportSchedule

Alexa For Business Alexa for Business APICreateConferenceProvider

CreateConferenceProviderAdds a new conference provider under the user's AWS account.

Request Syntax{ "ClientRequestToken": "string", "ConferenceProviderName": "string", "ConferenceProviderType": "string", "IPDialIn": { "CommsProtocol": "string", "Endpoint": "string" }, "MeetingSetting": { "RequirePin": "string" }, "PSTNDialIn": { "CountryCode": "string", "OneClickIdDelay": "string", "OneClickPinDelay": "string", "PhoneNumber": "string" }}




The request token of the client.

Type: String



Required: NoConferenceProviderName (p. 24)

The name of the conference provider.

Type: String



Required: YesConferenceProviderType (p. 24)

Represents a type within a list of predefined types.



Type: String

Valid Values: CHIME | BLUEJEANS | FUZE | GOOGLE_HANGOUTS | POLYCOM |RINGCENTRAL | SKYPE_FOR_BUSINESS | WEBEX | ZOOM | CUSTOM

Required: YesIPDialIn (p. 24)

The IP endpoint and protocol for calling.

Type: IPDialIn (p. 261) object

Required: NoMeetingSetting (p. 24)

The meeting settings for the conference provider.

Type: MeetingSetting (p. 263) object

Required: YesPSTNDialIn (p. 24)

The information for PSTN conferencing.

Type: PSTNDialIn (p. 275) object

Required: No

Response Syntax{ "ConferenceProviderArn": "string"}



ConferenceProviderArn (p. 25)

The ARN of the newly-created conference provider.

Type: String











https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/CreateConferenceProvider

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/CreateConferenceProvider

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/CreateConferenceProvider

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/CreateConferenceProvider

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/CreateConferenceProvider

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/CreateConferenceProvider

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/CreateConferenceProvider

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/CreateConferenceProvider

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/CreateConferenceProvider

Alexa For Business Alexa for Business APICreateContact

CreateContactCreates a contact with the specified details.

Request Syntax{ "ClientRequestToken": "string", "DisplayName": "string", "FirstName": "string", "LastName": "string", "PhoneNumber": "string", "PhoneNumbers": [ { "Number": "string", "Type": "string" } ], "SipAddresses": [ { "Type": "string", "Uri": "string" } ]}




A unique, user-specified identifier for this request that ensures idempotency.

Type: String



Required: NoDisplayName (p. 27)

The name of the contact to display on the console.

Type: String



Required: NoFirstName (p. 27)

The first name of the contact that is used to call the contact on the device.



Type: String



Required: YesLastName (p. 27)

The last name of the contact that is used to call the contact on the device.

Type: String



Required: NoPhoneNumber (p. 27)

The phone number of the contact in E.164 format. The phone number type defaults to WORK. Youcan specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, whichlets you specify the phone number type and multiple numbers.

Type: String


Pattern: ^[\+0-9\#\,$][\+0-9\-\.\/\($\,\#\s]+$

Required: NoPhoneNumbers (p. 27)

The list of phone numbers for the contact.

Type: Array of PhoneNumber (p. 269) objects

Array Members: Minimum number of 0 items. Maximum number of 3 items.

Required: NoSipAddresses (p. 27)

The list of SIP addresses for the contact.

Type: Array of SipAddress (p. 283) objects

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

Required: No

Response Syntax{ "ContactArn": "string"}





ContactArn (p. 28)

The ARN of the newly created address book.

Type: String











https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/CreateContact

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/CreateContact

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/CreateContact

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/CreateContact

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/CreateContact

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/CreateContact

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/CreateContact

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/CreateContact

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/CreateContact

Alexa For Business Alexa for Business APICreateGatewayGroup

CreateGatewayGroupCreates a gateway group with the specified details.

Request Syntax{ "ClientRequestToken": "string", "Description": "string", "Name": "string"}





Type: String



Required: YesDescription (p. 30)

The description of the gateway group.

Type: String


Required: NoName (p. 30)

The name of the gateway group.

Type: String



Required: Yes

Response Syntax{



"GatewayGroupArn": "string"}



GatewayGroupArn (p. 30)

The ARN of the created gateway group.

Type: String











https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/CreateGatewayGroup

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/CreateGatewayGroup

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/CreateGatewayGroup

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/CreateGatewayGroup

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/CreateGatewayGroup

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/CreateGatewayGroup

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/CreateGatewayGroup

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/CreateGatewayGroup

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/CreateGatewayGroup

Alexa For Business Alexa for Business APICreateNetworkProfile

CreateNetworkProfileCreates a network profile with the specified details.

Request Syntax{ "CertificateAuthorityArn": "string", "ClientRequestToken": "string", "CurrentPassword": "string", "Description": "string", "EapMethod": "string", "NetworkProfileName": "string", "NextPassword": "string", "SecurityType": "string", "Ssid": "string", "TrustAnchors": [ "string" ]}



CertificateAuthorityArn (p. 32)

The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This isused to issue certificates to the devices.

Type: String


Required: NoClientRequestToken (p. 32)


Type: String



Required: YesCurrentPassword (p. 32)

The current password of the Wi-Fi network.

Type: String


Pattern: [\x00-\x7F]*


Alexa For Business Alexa for Business APIRequest Parameters

Required: NoDescription (p. 32)

Detailed information about a device's network profile.

Type: String



Required: NoEapMethod (p. 32)

The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.

Type: String

Valid Values: EAP_TLS

Required: NoNetworkProfileName (p. 32)

The name of the network profile associated with a device.

Type: String



Required: YesNextPassword (p. 32)

The next, or subsequent, password of the Wi-Fi network. This password is asynchronouslytransmitted to the device and is used when the password of the network changes to NextPassword.

Type: String


Pattern: (^$)|([\x00-\x7F]{5,})

Required: NoSecurityType (p. 32)

The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP,or OPEN.

Type: String

Valid Values: OPEN | WEP | WPA_PSK | WPA2_PSK | WPA2_ENTERPRISE

Required: YesSsid (p. 32)

The SSID of the Wi-Fi network.



Type: String



Required: YesTrustAnchors (p. 32)

The root certificates of your authentication server that is installed on your devices and used to trustyour authentication server during EAP negotiation.

Type: Array of strings

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

Pattern: -{5}BEGIN CERTIFICATE-{5}\u000D?\u000A([A-Za-z0-9/+]{64}\u000D?\u000A)*[A-Za-z0-9/+]{1,64}={0,2}\u000D?\u000A-{5}END CERTIFICATE-{5}(\u000D?\u000A)?

Required: No

Response Syntax{ "NetworkProfileArn": "string"}



NetworkProfileArn (p. 34)

The ARN of the network profile associated with a device.

Type: String





HTTP Status Code: 400ConcurrentModificationException




HTTP Status Code: 400InvalidCertificateAuthorityException

The Certificate Authority can't issue or revoke a certificate.

HTTP Status Code: 400InvalidServiceLinkedRoleStateException

The service linked role is locked for deletion.







https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/CreateNetworkProfile

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/CreateNetworkProfile

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/CreateNetworkProfile

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/CreateNetworkProfile

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/CreateNetworkProfile

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/CreateNetworkProfile

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/CreateNetworkProfile

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/CreateNetworkProfile

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/CreateNetworkProfile

Alexa For Business Alexa for Business APICreateProfile

CreateProfileCreates a new room profile with the specified details.

Request Syntax{ "Address": "string", "ClientRequestToken": "string", "DistanceUnit": "string", "Locale": "string", "MaxVolumeLimit": number, "MeetingRoomConfiguration": { "EndOfMeetingReminder": { "Enabled": boolean, "ReminderAtMinutes": [ number ], "ReminderType": "string" }, "InstantBooking": { "DurationInMinutes": number, "Enabled": boolean }, "RequireCheckIn": { "Enabled": boolean, "ReleaseAfterMinutes": number }, "RoomUtilizationMetricsEnabled": boolean }, "ProfileName": "string", "PSTNEnabled": boolean, "SetupModeDisabled": boolean, "Tags": [ { "Key": "string", "Value": "string" } ], "TemperatureUnit": "string", "Timezone": "string", "WakeWord": "string"}



Address (p. 36)

The valid address for the room.

Type: String


Required: YesClientRequestToken (p. 36)

The user-specified token that is used during the creation of a profile.



Type: String



Required: NoDistanceUnit (p. 36)

The distance unit to be used by devices in the profile.

Type: String

Valid Values: METRIC | IMPERIAL

Required: YesLocale (p. 36)

The locale of the room profile. (This is currently only available to a limited preview audience.)

Type: String


Required: NoMaxVolumeLimit (p. 36)

The maximum volume limit for a room profile.

Type: Integer

Required: NoMeetingRoomConfiguration (p. 36)

The meeting room settings of a room profile.

Type: CreateMeetingRoomConfiguration (p. 240) object

Required: NoProfileName (p. 36)

The name of a room profile.

Type: String



Required: YesPSTNEnabled (p. 36)

Whether PSTN calling is enabled.

Type: Boolean

Required: NoSetupModeDisabled (p. 36)

Whether room profile setup is enabled.



Type: Boolean


The tags for the profile.


Required: NoTemperatureUnit (p. 36)

The temperature unit to be used by devices in the profile.

Type: String

Valid Values: FAHRENHEIT | CELSIUS

Required: YesTimezone (p. 36)

The time zone used by a room profile.

Type: String


Required: YesWakeWord (p. 36)

A wake word for Alexa, Echo, Amazon, or a computer.

Type: String

Valid Values: ALEXA | AMAZON | ECHO | COMPUTER

Required: Yes

Response Syntax{ "ProfileArn": "string"}



ProfileArn (p. 38)

The ARN of the newly created room profile in the response.

Type: String



Alexa For Business Alexa for Business APIErrors












https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/CreateProfile

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/CreateProfile

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/CreateProfile

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/CreateProfile

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/CreateProfile

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/CreateProfile

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/CreateProfile

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/CreateProfile

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/CreateProfile

Alexa For Business Alexa for Business APICreateRoom

CreateRoomCreates a room with the specified details.

Request Syntax{ "ClientRequestToken": "string", "Description": "string", "ProfileArn": "string", "ProviderCalendarId": "string", "RoomName": "string", "Tags": [ { "Key": "string", "Value": "string" } ]}





Type: String




The description for the room.

Type: String



Required: NoProfileArn (p. 40)

The profile ARN for the room. This is required.

Type: String




Required: NoProviderCalendarId (p. 40)

The calendar ARN for the room.

Type: String


Required: NoRoomName (p. 40)

The name for the room.

Type: String



Required: YesTags (p. 40)

The tags for the room.


Required: No

Response Syntax{ "RoomArn": "string"}



RoomArn (p. 41)

The ARN of the newly created room in the response.

Type: String













https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/CreateRoom

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/CreateRoom

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/CreateRoom

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/CreateRoom

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/CreateRoom

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/CreateRoom

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/CreateRoom

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/CreateRoom

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/CreateRoom

Alexa For Business Alexa for Business APICreateSkillGroup

CreateSkillGroupCreates a skill group with a specified name and description.

Request Syntax{ "ClientRequestToken": "string", "Description": "string", "SkillGroupName": "string", "Tags": [ { "Key": "string", "Value": "string" } ]}





Type: String




The description for the skill group.

Type: String



Required: NoSkillGroupName (p. 43)

The name for the skill group.

Type: String






The tags for the skill group.


Required: No

Response Syntax{ "SkillGroupArn": "string"}




The ARN of the newly created skill group in the response.

Type: String















https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/CreateSkillGroup

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/CreateSkillGroup

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/CreateSkillGroup

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/CreateSkillGroup

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/CreateSkillGroup

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/CreateSkillGroup

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/CreateSkillGroup

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/CreateSkillGroup

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/CreateSkillGroup

Alexa For Business Alexa for Business APICreateUser

CreateUserCreates a user.

Request Syntax{ "ClientRequestToken": "string", "Email": "string", "FirstName": "string", "LastName": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "UserId": "string"}





Type: String



Required: NoEmail (p. 46)

The email address for the user.

Type: String


Pattern: ([0-9a-zA-Z]([+-.\w]*[0-9a-zA-Z])*@([0-9a-zA-Z]([-\w]*[0-9a-zA-Z]+)*\.)+[a-zA-Z]{2,9})


The first name for the user.

Type: String


Pattern: ([A-Za-z\-' 0-9._]|\p{IsLetter})*



Required: NoLastName (p. 46)

The last name for the user.

Type: String




The tags for the user.


Required: NoUserId (p. 46)

The ARN for the user.

Type: String


Pattern: [a-zA-Z0-9@_+.-]*

Required: Yes

Response Syntax{ "UserArn": "string"}



UserArn (p. 47)

The ARN of the newly created user in the response.

Type: String









HTTP Status Code: 400ResourceInUseException

The resource in the request is already in use.





https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/CreateUser

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/CreateUser

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/CreateUser

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/CreateUser

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/CreateUser

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/CreateUser

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/CreateUser

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/CreateUser

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/CreateUser

Alexa For Business Alexa for Business APIDeleteAddressBook

DeleteAddressBookDeletes an address book by the address book ARN.

Request Syntax{ "AddressBookArn": "string"}




The ARN of the address book to delete.

Type: String


Required: Yes











https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/DeleteAddressBook




https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/DeleteAddressBook

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/DeleteAddressBook

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/DeleteAddressBook

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/DeleteAddressBook

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/DeleteAddressBook

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/DeleteAddressBook

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/DeleteAddressBook

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/DeleteAddressBook

Alexa For Business Alexa for Business APIDeleteBusinessReportSchedule

DeleteBusinessReportScheduleDeletes the recurring report delivery schedule with the specified schedule ARN.

Request Syntax{ "ScheduleArn": "string"}



ScheduleArn (p. 51)


Type: String


Required: Yes











https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/DeleteBusinessReportSchedule




https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/DeleteBusinessReportSchedule

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/DeleteBusinessReportSchedule

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/DeleteBusinessReportSchedule

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/DeleteBusinessReportSchedule

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/DeleteBusinessReportSchedule

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/DeleteBusinessReportSchedule

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/DeleteBusinessReportSchedule

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/DeleteBusinessReportSchedule

Alexa For Business Alexa for Business APIDeleteConferenceProvider

DeleteConferenceProviderDeletes a conference provider.

Request Syntax{ "ConferenceProviderArn": "string"}




The ARN of the conference provider.

Type: String


Required: Yes



NotFoundException




• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java


https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/DeleteConferenceProvider

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/DeleteConferenceProvider

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/DeleteConferenceProvider

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/DeleteConferenceProvider

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/DeleteConferenceProvider


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


https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/DeleteConferenceProvider

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/DeleteConferenceProvider

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/DeleteConferenceProvider

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/DeleteConferenceProvider

Alexa For Business Alexa for Business APIDeleteContact

DeleteContactDeletes a contact by the contact ARN.

Request Syntax{ "ContactArn": "string"}



ContactArn (p. 55)

The ARN of the contact to delete.

Type: String


Required: Yes











https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/DeleteContact




https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/DeleteContact

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/DeleteContact

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/DeleteContact

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/DeleteContact

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/DeleteContact

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/DeleteContact

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/DeleteContact

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/DeleteContact

Alexa For Business Alexa for Business APIDeleteDevice

DeleteDeviceRemoves a device from Alexa For Business.

Request Syntax{ "DeviceArn": "string"}



DeviceArn (p. 57)

The ARN of the device for which to request details.

Type: String


Required: Yes















https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/DeleteDevice

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/DeleteDevice

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/DeleteDevice

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/DeleteDevice

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/DeleteDevice

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/DeleteDevice

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/DeleteDevice

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/DeleteDevice

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/DeleteDevice

Alexa For Business Alexa for Business APIDeleteDeviceUsageData

DeleteDeviceUsageDataWhen this action is called for a specified shared device, it allows authorized users to delete the device'sentire previous history of voice input data and associated response data. This action can be called onceevery 24 hours for a specific shared device.

Request Syntax{ "DeviceArn": "string", "DeviceUsageType": "string"}



DeviceArn (p. 59)

The ARN of the device.

Type: String


Required: YesDeviceUsageType (p. 59)

The type of usage data to delete.

Type: String

Valid Values: VOICE

Required: Yes
















https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/DeleteDeviceUsageData

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/DeleteDeviceUsageData

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/DeleteDeviceUsageData

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/DeleteDeviceUsageData

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/DeleteDeviceUsageData

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/DeleteDeviceUsageData

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/DeleteDeviceUsageData

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/DeleteDeviceUsageData

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/DeleteDeviceUsageData

Alexa For Business Alexa for Business APIDeleteGatewayGroup

DeleteGatewayGroupDeletes a gateway group.

Request Syntax{ "GatewayGroupArn": "string"}




The ARN of the gateway group to delete.

Type: String


Required: Yes



ResourceAssociatedException

Another resource is associated with the resource in the request.





https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/DeleteGatewayGroup

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/DeleteGatewayGroup

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/DeleteGatewayGroup

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/DeleteGatewayGroup

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/DeleteGatewayGroup




https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/DeleteGatewayGroup

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/DeleteGatewayGroup

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/DeleteGatewayGroup

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/DeleteGatewayGroup

Alexa For Business Alexa for Business APIDeleteNetworkProfile

DeleteNetworkProfileDeletes a network profile by the network profile ARN.

Request Syntax{ "NetworkProfileArn": "string"}





Type: String


Required: Yes







HTTP Status Code: 400ResourceInUseException

The resource in the request is already in use.







https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/DeleteNetworkProfile

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/DeleteNetworkProfile

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/DeleteNetworkProfile

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/DeleteNetworkProfile

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/DeleteNetworkProfile

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/DeleteNetworkProfile

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/DeleteNetworkProfile

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/DeleteNetworkProfile

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/DeleteNetworkProfile

Alexa For Business Alexa for Business APIDeleteProfile

DeleteProfileDeletes a room profile by the profile ARN.

Request Syntax{ "ProfileArn": "string"}



ProfileArn (p. 65)

The ARN of the room profile to delete. Required.

Type: String


Required: No











https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/DeleteProfile




https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/DeleteProfile

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/DeleteProfile

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/DeleteProfile

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/DeleteProfile

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/DeleteProfile

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/DeleteProfile

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/DeleteProfile

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/DeleteProfile

Alexa For Business Alexa for Business APIDeleteRoom

DeleteRoomDeletes a room by the room ARN.

Request Syntax{ "RoomArn": "string"}



RoomArn (p. 67)

The ARN of the room to delete. Required.

Type: String


Required: No











https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/DeleteRoom




https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/DeleteRoom

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/DeleteRoom

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/DeleteRoom

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/DeleteRoom

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/DeleteRoom

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/DeleteRoom

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/DeleteRoom

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/DeleteRoom

Alexa For Business Alexa for Business APIDeleteRoomSkillParameter

DeleteRoomSkillParameterDeletes room skill parameter details by room, skill, and parameter key ID.

Request Syntax{ "ParameterKey": "string", "RoomArn": "string", "SkillId": "string"}



ParameterKey (p. 69)

The room skill parameter key for which to remove details.

Type: String


Required: YesRoomArn (p. 69)

The ARN of the room from which to remove the room skill parameter details.

Type: String



The ID of the skill from which to remove the room skill parameter details.

Type: String


Required: Yes











https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/DeleteRoomSkillParameter

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/DeleteRoomSkillParameter

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/DeleteRoomSkillParameter

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/DeleteRoomSkillParameter

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/DeleteRoomSkillParameter

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/DeleteRoomSkillParameter

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/DeleteRoomSkillParameter

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/DeleteRoomSkillParameter

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/DeleteRoomSkillParameter

Alexa For Business Alexa for Business APIDeleteSkillAuthorization

DeleteSkillAuthorizationUnlinks a third-party account from a skill.

Request Syntax{ "RoomArn": "string", "SkillId": "string"}



RoomArn (p. 71)

The room that the skill is authorized for.

Type: String



The unique identifier of a skill.

Type: String


Required: Yes













https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/DeleteSkillAuthorization

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/DeleteSkillAuthorization

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/DeleteSkillAuthorization

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/DeleteSkillAuthorization

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/DeleteSkillAuthorization

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/DeleteSkillAuthorization

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/DeleteSkillAuthorization

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/DeleteSkillAuthorization

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/DeleteSkillAuthorization

Alexa For Business Alexa for Business APIDeleteSkillGroup

DeleteSkillGroupDeletes a skill group by skill group ARN.

Request Syntax{ "SkillGroupArn": "string"}




The ARN of the skill group to delete. Required.

Type: String


Required: No











https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/DeleteSkillGroup




https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/DeleteSkillGroup

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/DeleteSkillGroup

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/DeleteSkillGroup

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/DeleteSkillGroup

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/DeleteSkillGroup

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/DeleteSkillGroup

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/DeleteSkillGroup

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/DeleteSkillGroup

Alexa For Business Alexa for Business APIDeleteUser

DeleteUserDeletes a specified user by user ARN and enrollment ARN.

Request Syntax{ "EnrollmentId": "string", "UserArn": "string"}



EnrollmentId (p. 75)

The ARN of the user's enrollment in the organization. Required.

Type: String


Required: YesUserArn (p. 75)

The ARN of the user to delete in the organization. Required.

Type: String


Required: No













https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/DeleteUser

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/DeleteUser

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/DeleteUser

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/DeleteUser

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/DeleteUser

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/DeleteUser

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/DeleteUser

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/DeleteUser

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/DeleteUser

Alexa For Business Alexa for Business APIDisassociateContactFromAddressBook

DisassociateContactFromAddressBookDisassociates a contact from a given address book.

Request Syntax{ "AddressBookArn": "string", "ContactArn": "string"}




The ARN of the address from which to disassociate the contact.

Type: String


Required: YesContactArn (p. 77)

The ARN of the contact to disassociate from an address book.

Type: String


Required: Yes




• AWS Command Line Interface• AWS SDK for .NET


https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/DisassociateContactFromAddressBook

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/DisassociateContactFromAddressBook


• 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


https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/DisassociateContactFromAddressBook

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/DisassociateContactFromAddressBook

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/DisassociateContactFromAddressBook

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/DisassociateContactFromAddressBook

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/DisassociateContactFromAddressBook

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/DisassociateContactFromAddressBook

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/DisassociateContactFromAddressBook

Alexa For Business Alexa for Business APIDisassociateDeviceFromRoom

DisassociateDeviceFromRoomDisassociates a device from its current room. The device continues to be connected to the Wi-Fi networkand is still registered to the account. The device settings and skills are removed from the room.




DeviceArn (p. 79)

The ARN of the device to disassociate from a room. Required.

Type: String


Required: No





HTTP Status Code: 400DeviceNotRegisteredException








https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/DisassociateDeviceFromRoom

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/DisassociateDeviceFromRoom

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/DisassociateDeviceFromRoom

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/DisassociateDeviceFromRoom

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/DisassociateDeviceFromRoom

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/DisassociateDeviceFromRoom

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/DisassociateDeviceFromRoom

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/DisassociateDeviceFromRoom

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/DisassociateDeviceFromRoom

Alexa For Business Alexa for Business APIDisassociateSkillFromSkillGroup

DisassociateSkillFromSkillGroupDisassociates a skill from a skill group.

Request Syntax{ "SkillGroupArn": "string", "SkillId": "string"}




The unique identifier of a skill. Required.

Type: String



The ARN of a skill group to associate to a skill.

Type: String


Required: Yes













https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/DisassociateSkillFromSkillGroup

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/DisassociateSkillFromSkillGroup

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/DisassociateSkillFromSkillGroup

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/DisassociateSkillFromSkillGroup

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/DisassociateSkillFromSkillGroup

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/DisassociateSkillFromSkillGroup

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/DisassociateSkillFromSkillGroup

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/DisassociateSkillFromSkillGroup

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/DisassociateSkillFromSkillGroup

Alexa For Business Alexa for Business APIDisassociateSkillFromUsers

DisassociateSkillFromUsersMakes a private skill unavailable for enrolled users and prevents them from enabling it on their devices.




SkillId (p. 83)

The private skill ID you want to make unavailable for enrolled users.

Type: String


Required: Yes











https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/DisassociateSkillFromUsers




https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/DisassociateSkillFromUsers

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/DisassociateSkillFromUsers

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/DisassociateSkillFromUsers

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/DisassociateSkillFromUsers

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/DisassociateSkillFromUsers

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/DisassociateSkillFromUsers

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/DisassociateSkillFromUsers

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/DisassociateSkillFromUsers

Alexa For Business Alexa for Business APIDisassociateSkillGroupFromRoom

DisassociateSkillGroupFromRoomDisassociates a skill group from a specified room. This disables all skills in the skill group on all devices inthe room.

Request Syntax{ "RoomArn": "string", "SkillGroupArn": "string"}



RoomArn (p. 85)

The ARN of the room from which the skill group is to be disassociated. Required.

Type: String


Required: No


The ARN of the skill group to disassociate from a room. Required.

Type: String


Required: No











https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/DisassociateSkillGroupFromRoom

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/DisassociateSkillGroupFromRoom

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/DisassociateSkillGroupFromRoom

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/DisassociateSkillGroupFromRoom

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/DisassociateSkillGroupFromRoom

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/DisassociateSkillGroupFromRoom

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/DisassociateSkillGroupFromRoom

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/DisassociateSkillGroupFromRoom

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/DisassociateSkillGroupFromRoom

Alexa For Business Alexa for Business APIForgetSmartHomeAppliances

ForgetSmartHomeAppliancesForgets smart home appliances associated to a room.




RoomArn (p. 87)

The room that the appliances are associated with.

Type: String


Required: Yes



NotFoundException






https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/ForgetSmartHomeAppliances

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/ForgetSmartHomeAppliances

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/ForgetSmartHomeAppliances

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/ForgetSmartHomeAppliances

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/ForgetSmartHomeAppliances




https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/ForgetSmartHomeAppliances

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/ForgetSmartHomeAppliances

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/ForgetSmartHomeAppliances

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/ForgetSmartHomeAppliances

Alexa For Business Alexa for Business APIGetAddressBook

GetAddressBookGets address the book details by the address book ARN.

Request Syntax{ "AddressBookArn": "string"}




The ARN of the address book for which to request details.

Type: String


Required: Yes

Response Syntax{ "AddressBook": { "AddressBookArn": "string", "Description": "string", "Name": "string" }}



AddressBook (p. 89)

The details of the requested address book.

Type: AddressBook (p. 220) object




NotFoundException






https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/GetAddressBook

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/GetAddressBook

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/GetAddressBook

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/GetAddressBook

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/GetAddressBook

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/GetAddressBook

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/GetAddressBook

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/GetAddressBook

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/GetAddressBook

Alexa For Business Alexa for Business APIGetConferencePreference

GetConferencePreferenceRetrieves the existing conference preferences.

Response Syntax{ "Preference": { "DefaultConferenceProviderArn": "string" }}



Preference (p. 91)

The conference preference.

Type: ConferencePreference (p. 230) object


NotFoundException






https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/GetConferencePreference

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/GetConferencePreference

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/GetConferencePreference

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/GetConferencePreference

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/GetConferencePreference

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/GetConferencePreference

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/GetConferencePreference

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/GetConferencePreference

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/GetConferencePreference

Alexa For Business Alexa for Business APIGetConferenceProvider

GetConferenceProviderGets details about a specific conference provider.

Request Syntax{ "ConferenceProviderArn": "string"}




The ARN of the newly created conference provider.

Type: String


Required: Yes

Response Syntax{ "ConferenceProvider": { "Arn": "string", "IPDialIn": { "CommsProtocol": "string", "Endpoint": "string" }, "MeetingSetting": { "RequirePin": "string" }, "Name": "string", "PSTNDialIn": { "CountryCode": "string", "OneClickIdDelay": "string", "OneClickPinDelay": "string", "PhoneNumber": "string" }, "Type": "string" }}





ConferenceProvider (p. 92)

The conference provider.

Type: ConferenceProvider (p. 231) object


NotFoundException






https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/GetConferenceProvider

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/GetConferenceProvider

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/GetConferenceProvider

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/GetConferenceProvider

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/GetConferenceProvider

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/GetConferenceProvider

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/GetConferenceProvider

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/GetConferenceProvider

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/GetConferenceProvider

Alexa For Business Alexa for Business APIGetContact

GetContactGets the contact details by the contact ARN.

Request Syntax{ "ContactArn": "string"}



ContactArn (p. 94)

The ARN of the contact for which to request details.

Type: String


Required: Yes

Response Syntax{ "Contact": { "ContactArn": "string", "DisplayName": "string", "FirstName": "string", "LastName": "string", "PhoneNumber": "string", "PhoneNumbers": [ { "Number": "string", "Type": "string" } ], "SipAddresses": [ { "Type": "string", "Uri": "string" } ] }}





Contact (p. 94)

The details of the requested contact.

Type: Contact (p. 233) object


NotFoundException






https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/GetContact

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/GetContact

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/GetContact

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/GetContact

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/GetContact

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/GetContact

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/GetContact

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/GetContact

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/GetContact

Alexa For Business Alexa for Business APIGetDevice

GetDeviceGets the details of a device by device ARN.




DeviceArn (p. 96)

The ARN of the device for which to request details. Required.

Type: String


Required: No

Response Syntax{ "Device": { "DeviceArn": "string", "DeviceName": "string", "DeviceSerialNumber": "string", "DeviceStatus": "string", "DeviceStatusInfo": { "ConnectionStatus": "string", "ConnectionStatusUpdatedTime": number, "DeviceStatusDetails": [ { "Code": "string", "Feature": "string" } ] }, "DeviceType": "string", "MacAddress": "string", "NetworkProfileInfo": { "CertificateArn": "string", "CertificateExpirationTime": number, "NetworkProfileArn": "string" }, "RoomArn": "string", "SoftwareVersion": "string" }}





Device (p. 96)

The details of the device requested. Required.

Type: Device (p. 243) object


NotFoundException






https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/GetDevice

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/GetDevice

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/GetDevice

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/GetDevice

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/GetDevice

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/GetDevice

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/GetDevice

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/GetDevice

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/GetDevice

Alexa For Business Alexa for Business APIGetGateway

GetGatewayRetrieves the details of a gateway.

Request Syntax{ "GatewayArn": "string"}



GatewayArn (p. 98)

The ARN of the gateway to get.

Type: String


Required: Yes

Response Syntax{ "Gateway": { "Arn": "string", "Description": "string", "GatewayGroupArn": "string", "Name": "string", "SoftwareVersion": "string" }}



Gateway (p. 98)

The details of the gateway.

Type: Gateway (p. 254) object




NotFoundException






https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/GetGateway

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/GetGateway

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/GetGateway

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/GetGateway

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/GetGateway

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/GetGateway

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/GetGateway

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/GetGateway

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/GetGateway

Alexa For Business Alexa for Business APIGetGatewayGroup

GetGatewayGroupRetrieves the details of a gateway group.

Request Syntax{ "GatewayGroupArn": "string"}




The ARN of the gateway group to get.

Type: String


Required: Yes

Response Syntax{ "GatewayGroup": { "Arn": "string", "Description": "string", "Name": "string" }}



GatewayGroup (p. 100)

The details of the gateway group.

Type: GatewayGroup (p. 256) object




NotFoundException






https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/GetGatewayGroup

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/GetGatewayGroup

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/GetGatewayGroup

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/GetGatewayGroup

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/GetGatewayGroup

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/GetGatewayGroup

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/GetGatewayGroup

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/GetGatewayGroup

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/GetGatewayGroup

Alexa For Business Alexa for Business APIGetInvitationConfiguration

GetInvitationConfigurationRetrieves the configured values for the user enrollment invitation email template.

Response Syntax{ "ContactEmail": "string", "OrganizationName": "string", "PrivateSkillIds": [ "string" ]}



ContactEmail (p. 102)

The email ID of the organization or individual contact that the enrolled user can use.

Type: String



OrganizationName (p. 102)

The name of the organization sending the enrollment invite to a user.

Type: String



PrivateSkillIds (p. 102)

The list of private skill IDs that you want to recommend to the user to enable in the invitation.





NotFoundException








https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/GetInvitationConfiguration

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/GetInvitationConfiguration

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/GetInvitationConfiguration

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/GetInvitationConfiguration

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/GetInvitationConfiguration

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/GetInvitationConfiguration

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/GetInvitationConfiguration

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/GetInvitationConfiguration

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/GetInvitationConfiguration

Alexa For Business Alexa for Business APIGetNetworkProfile

GetNetworkProfileGets the network profile details by the network profile ARN.

Request Syntax{ "NetworkProfileArn": "string"}





Type: String


Required: Yes

Response Syntax{ "NetworkProfile": { "CertificateAuthorityArn": "string", "CurrentPassword": "string", "Description": "string", "EapMethod": "string", "NetworkProfileArn": "string", "NetworkProfileName": "string", "NextPassword": "string", "SecurityType": "string", "Ssid": "string", "TrustAnchors": [ "string" ] }}



NetworkProfile (p. 104)

The network profile associated with a device.



Type: NetworkProfile (p. 264) object


InvalidSecretsManagerResourceException

A password in SecretsManager is in an invalid state.







https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/GetNetworkProfile

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/GetNetworkProfile

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/GetNetworkProfile

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/GetNetworkProfile

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/GetNetworkProfile

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/GetNetworkProfile

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/GetNetworkProfile

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/GetNetworkProfile

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/GetNetworkProfile

Alexa For Business Alexa for Business APIGetProfile

GetProfileGets the details of a room profile by profile ARN.

Request Syntax{ "ProfileArn": "string"}



ProfileArn (p. 106)

The ARN of the room profile for which to request details. Required.

Type: String


Required: No

Response Syntax{ "Profile": { "Address": "string", "AddressBookArn": "string", "DistanceUnit": "string", "IsDefault": boolean, "Locale": "string", "MaxVolumeLimit": number, "MeetingRoomConfiguration": { "EndOfMeetingReminder": { "Enabled": boolean, "ReminderAtMinutes": [ number ], "ReminderType": "string" }, "InstantBooking": { "DurationInMinutes": number, "Enabled": boolean }, "RequireCheckIn": { "Enabled": boolean, "ReleaseAfterMinutes": number }, "RoomUtilizationMetricsEnabled": boolean }, "ProfileArn": "string", "ProfileName": "string", "PSTNEnabled": boolean,



"SetupModeDisabled": boolean, "TemperatureUnit": "string", "Timezone": "string", "WakeWord": "string" }}



Profile (p. 106)

The details of the room profile requested. Required.

Type: Profile (p. 270) object


NotFoundException






https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/GetProfile

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/GetProfile

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/GetProfile

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/GetProfile

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/GetProfile

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/GetProfile

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/GetProfile

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/GetProfile

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/GetProfile

Alexa For Business Alexa for Business APIGetRoom

GetRoomGets room details by room ARN.




RoomArn (p. 108)

The ARN of the room for which to request details. Required.

Type: String


Required: No

Response Syntax{ "Room": { "Description": "string", "ProfileArn": "string", "ProviderCalendarId": "string", "RoomArn": "string", "RoomName": "string" }}



Room (p. 108)

The details of the room requested.

Type: Room (p. 278) object




NotFoundException






https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/GetRoom

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/GetRoom

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/GetRoom

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/GetRoom

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/GetRoom

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/GetRoom

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/GetRoom

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/GetRoom

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/GetRoom

Alexa For Business Alexa for Business APIGetRoomSkillParameter

GetRoomSkillParameterGets room skill parameter details by room, skill, and parameter key ARN.

Request Syntax{ "ParameterKey": "string", "RoomArn": "string", "SkillId": "string"}



ParameterKey (p. 110)

The room skill parameter key for which to get details. Required.

Type: String



The ARN of the room from which to get the room skill parameter details.

Type: String



The ARN of the skill from which to get the room skill parameter details. Required.

Type: String


Required: Yes

Response Syntax{ "RoomSkillParameter": { "ParameterKey": "string", "ParameterValue": "string"



}}



RoomSkillParameter (p. 110)

The details of the room skill parameter requested. Required.

Type: RoomSkillParameter (p. 282) object


NotFoundException






https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/GetRoomSkillParameter

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/GetRoomSkillParameter

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/GetRoomSkillParameter

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/GetRoomSkillParameter

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/GetRoomSkillParameter

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/GetRoomSkillParameter

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/GetRoomSkillParameter

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/GetRoomSkillParameter

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/GetRoomSkillParameter

Alexa For Business Alexa for Business APIGetSkillGroup

GetSkillGroupGets skill group details by skill group ARN.

Request Syntax{ "SkillGroupArn": "string"}




The ARN of the skill group for which to get details. Required.

Type: String


Required: No

Response Syntax{ "SkillGroup": { "Description": "string", "SkillGroupArn": "string", "SkillGroupName": "string" }}



SkillGroup (p. 112)

The details of the skill group requested. Required.

Type: SkillGroup (p. 286) object




NotFoundException






https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/GetSkillGroup

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/GetSkillGroup

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/GetSkillGroup

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/GetSkillGroup

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/GetSkillGroup

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/GetSkillGroup

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/GetSkillGroup

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/GetSkillGroup

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/GetSkillGroup

Alexa For Business Alexa for Business APIListBusinessReportSchedules

ListBusinessReportSchedulesLists the details of the schedules that a user configured. A download URL of the report associated witheach schedule is returned every time this action is called. A new download URL is returned each time,and is valid for 24 hours.

Request Syntax{ "MaxResults": number, "NextToken": "string"}



MaxResults (p. 114)

The maximum number of schedules listed in the call.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 50.

Required: NoNextToken (p. 114)

The token used to list the remaining schedules from the previous API call.

Type: String


Required: No

Response Syntax{ "BusinessReportSchedules": [ { "ContentRange": { "Interval": "string" }, "Format": "string", "LastBusinessReport": { "DeliveryTime": number, "DownloadUrl": "string", "FailureCode": "string", "S3Location": { "BucketName": "string", "Path": "string" },



"Status": "string" }, "Recurrence": { "StartDate": "string" }, "S3BucketName": "string", "S3KeyPrefix": "string", "ScheduleArn": "string", "ScheduleName": "string" } ], "NextToken": "string"}



BusinessReportSchedules (p. 114)

The schedule of the reports.

Type: Array of BusinessReportSchedule (p. 227) objectsNextToken (p. 114)

The token used to list the remaining schedules from the previous API call.

Type: String






https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/ListBusinessReportSchedules

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/ListBusinessReportSchedules

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/ListBusinessReportSchedules

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/ListBusinessReportSchedules

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/ListBusinessReportSchedules

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/ListBusinessReportSchedules

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/ListBusinessReportSchedules

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/ListBusinessReportSchedules

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/ListBusinessReportSchedules

Alexa For Business Alexa for Business APIListConferenceProviders

ListConferenceProvidersLists conference providers under a specific AWS account.




MaxResults (p. 116)

The maximum number of conference providers to be returned, per paginated calls.

Type: Integer



The tokens used for pagination.

Type: String


Required: No

Response Syntax{ "ConferenceProviders": [ { "Arn": "string", "IPDialIn": { "CommsProtocol": "string", "Endpoint": "string" }, "MeetingSetting": { "RequirePin": "string" }, "Name": "string", "PSTNDialIn": { "CountryCode": "string", "OneClickIdDelay": "string", "OneClickPinDelay": "string", "PhoneNumber": "string"



}, "Type": "string" } ], "NextToken": "string"}



ConferenceProviders (p. 116)

The conference providers.

Type: Array of ConferenceProvider (p. 231) objectsNextToken (p. 116)


Type: String






https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/ListConferenceProviders

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/ListConferenceProviders

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/ListConferenceProviders

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/ListConferenceProviders

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/ListConferenceProviders

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/ListConferenceProviders

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/ListConferenceProviders

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/ListConferenceProviders

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/ListConferenceProviders

Alexa For Business Alexa for Business APIListDeviceEvents

ListDeviceEventsLists the device event history, including device connection status, for up to 30 days.

Request Syntax{ "DeviceArn": "string", "EventType": "string", "MaxResults": number, "NextToken": "string"}



DeviceArn (p. 118)

The ARN of a device.

Type: String


Required: YesEventType (p. 118)

The event type to filter device events. If EventType isn't specified, this returns a list of all deviceevents in reverse chronological order. If EventType is specified, this returns a list of device events forthat EventType in reverse chronological order.

Type: String

Valid Values: CONNECTION_STATUS | DEVICE_STATUS

Required: NoMaxResults (p. 118)

The maximum number of results to include in the response. The default value is 50. If more resultsexist than the specified MaxResults value, a token is included in the response so that the remainingresults can be retrieved.

Type: Integer



An optional token returned from a prior request. Use this token for pagination of results from thisaction. If this parameter is specified, the response only includes results beyond the token, up to thevalue specified by MaxResults. When the end of results is reached, the response has a value of null.



Type: String


Required: No

Response Syntax{ "DeviceEvents": [ { "Timestamp": number, "Type": "string", "Value": "string" } ], "NextToken": "string"}



DeviceEvents (p. 119)

The device events requested for the device ARN.

Type: Array of DeviceEvent (p. 248) objectsNextToken (p. 119)

The token returned to indicate that there is more data available.

Type: String



NotFoundException




• AWS Command Line Interface• AWS SDK for .NET


https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/ListDeviceEvents

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/ListDeviceEvents


• 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


https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/ListDeviceEvents

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/ListDeviceEvents

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/ListDeviceEvents

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/ListDeviceEvents

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/ListDeviceEvents

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/ListDeviceEvents

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/ListDeviceEvents

Alexa For Business Alexa for Business APIListGatewayGroups

ListGatewayGroupsRetrieves a list of gateway group summaries. Use GetGatewayGroup to retrieve details of a specificgateway group.




MaxResults (p. 121)

The maximum number of gateway group summaries to return. The default is 50.

Type: Integer



The token used to paginate though multiple pages of gateway group summaries.

Type: String


Required: No

Response Syntax{ "GatewayGroups": [ { "Arn": "string", "Description": "string", "Name": "string" } ], "NextToken": "string"}





GatewayGroups (p. 121)

The gateway groups in the list.

Type: Array of GatewayGroupSummary (p. 257) objectsNextToken (p. 121)

The token used to paginate though multiple pages of gateway group summaries.

Type: String






https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/ListGatewayGroups

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/ListGatewayGroups

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/ListGatewayGroups

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/ListGatewayGroups

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/ListGatewayGroups

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/ListGatewayGroups

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/ListGatewayGroups

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/ListGatewayGroups

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/ListGatewayGroups

Alexa For Business Alexa for Business APIListGateways

ListGatewaysRetrieves a list of gateway summaries. Use GetGateway to retrieve details of a specific gateway. Anoptional gateway group ARN can be provided to only retrieve gateway summaries of gateways that areassociated with that gateway group ARN.

Request Syntax{ "GatewayGroupArn": "string", "MaxResults": number, "NextToken": "string"}




The gateway group ARN for which to list gateways.

Type: String



The maximum number of gateway summaries to return. The default is 50.

Type: Integer



The token used to paginate though multiple pages of gateway summaries.

Type: String


Required: No

Response Syntax{ "Gateways": [ {



"Arn": "string", "Description": "string", "GatewayGroupArn": "string", "Name": "string", "SoftwareVersion": "string" } ], "NextToken": "string"}



Gateways (p. 123)

The gateways in the list.

Type: Array of GatewaySummary (p. 258) objectsNextToken (p. 123)

The token used to paginate though multiple pages of gateway summaries.

Type: String






https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/ListGateways

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/ListGateways

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/ListGateways

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/ListGateways

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/ListGateways

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/ListGateways

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/ListGateways

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/ListGateways

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/ListGateways

Alexa For Business Alexa for Business APIListSkills

ListSkillsLists all enabled skills in a specific skill group.

Request Syntax{ "EnablementType": "string", "MaxResults": number, "NextToken": "string", "SkillGroupArn": "string", "SkillType": "string"}



EnablementType (p. 125)

Whether the skill is enabled under the user's account.

Type: String

Valid Values: ENABLED | PENDING


The maximum number of results to include in the response. If more results exist than the specifiedMaxResults value, a token is included in the response so that the remaining results can beretrieved.

Type: Integer



An optional token returned from a prior request. Use this token for pagination of results from thisaction. If this parameter is specified, the response includes only results beyond the token, up to thevalue specified by MaxResults.

Type: String


Required: NoSkillGroupArn (p. 125)

The ARN of the skill group for which to list enabled skills.

Type: String




Required: NoSkillType (p. 125)

Whether the skill is publicly available or is a private skill.

Type: String

Valid Values: PUBLIC | PRIVATE | ALL

Required: No

Response Syntax{ "NextToken": "string", "SkillSummaries": [ { "EnablementType": "string", "SkillId": "string", "SkillName": "string", "SkillType": "string", "SupportsLinking": boolean } ]}



NextToken (p. 126)


Type: String

Length Constraints: Minimum length of 1. Maximum length of 1100.SkillSummaries (p. 126)

The list of enabled skills requested. Required.

Type: Array of SkillSummary (p. 290) objects







https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/ListSkills

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/ListSkills

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/ListSkills

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/ListSkills

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/ListSkills

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/ListSkills

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/ListSkills

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/ListSkills

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/ListSkills

Alexa For Business Alexa for Business APIListSkillsStoreCategories

ListSkillsStoreCategoriesLists all categories in the Alexa skill store.




MaxResults (p. 128)

The maximum number of categories returned, per paginated calls.

Type: Integer




Type: String


Required: No

Response Syntax{ "CategoryList": [ { "CategoryId": number, "CategoryName": "string" } ], "NextToken": "string"}





CategoryList (p. 128)

The list of categories.

Type: Array of Category (p. 229) objectsNextToken (p. 128)


Type: String






https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/ListSkillsStoreCategories

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/ListSkillsStoreCategories

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/ListSkillsStoreCategories

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/ListSkillsStoreCategories

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/ListSkillsStoreCategories

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/ListSkillsStoreCategories

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/ListSkillsStoreCategories

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/ListSkillsStoreCategories

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/ListSkillsStoreCategories

Alexa For Business Alexa for Business APIListSkillsStoreSkillsByCategory

ListSkillsStoreSkillsByCategoryLists all skills in the Alexa skill store by category.

Request Syntax{ "CategoryId": number, "MaxResults": number, "NextToken": "string"}



CategoryId (p. 130)

The category ID for which the skills are being retrieved from the skill store.

Type: Long

Valid Range: Minimum value of 1.

Required: YesMaxResults (p. 130)

The maximum number of skills returned per paginated calls.

Type: Integer




Type: String


Required: No

Response Syntax{ "NextToken": "string", "SkillsStoreSkills": [ { "IconUrl": "string", "SampleUtterances": [ "string" ],



"ShortDescription": "string", "SkillDetails": { "BulletPoints": [ "string" ], "DeveloperInfo": { "DeveloperName": "string", "Email": "string", "PrivacyPolicy": "string", "Url": "string" }, "EndUserLicenseAgreement": "string", "GenericKeywords": [ "string" ], "InvocationPhrase": "string", "NewInThisVersionBulletPoints": [ "string" ], "ProductDescription": "string", "ReleaseDate": "string", "Reviews": { "string" : "string" }, "SkillTypes": [ "string" ] }, "SkillId": "string", "SkillName": "string", "SupportsLinking": boolean } ]}



NextToken (p. 130)


Type: String

Length Constraints: Minimum length of 1. Maximum length of 1100.SkillsStoreSkills (p. 130)

The skill store skills.

Type: Array of SkillsStoreSkill (p. 288) objects



• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go


https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/ListSkillsStoreSkillsByCategory

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/ListSkillsStoreSkillsByCategory

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/ListSkillsStoreSkillsByCategory

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/ListSkillsStoreSkillsByCategory


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


https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/ListSkillsStoreSkillsByCategory

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/ListSkillsStoreSkillsByCategory

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/ListSkillsStoreSkillsByCategory

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/ListSkillsStoreSkillsByCategory

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/ListSkillsStoreSkillsByCategory

Alexa For Business Alexa for Business APIListSmartHomeAppliances

ListSmartHomeAppliancesLists all of the smart home appliances associated with a room.

Request Syntax{ "MaxResults": number, "NextToken": "string", "RoomArn": "string"}



MaxResults (p. 133)

The maximum number of appliances to be returned, per paginated calls.

Type: Integer




Type: String



The room that the appliances are associated with.

Type: String


Required: Yes

Response Syntax{ "NextToken": "string", "SmartHomeAppliances": [ { "Description": "string",



"FriendlyName": "string", "ManufacturerName": "string" } ]}



NextToken (p. 133)


Type: String

Length Constraints: Minimum length of 1. Maximum length of 1100.SmartHomeAppliances (p. 133)

The smart home appliances.

Type: Array of SmartHomeAppliance (p. 292) objects


NotFoundException






https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/ListSmartHomeAppliances

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/ListSmartHomeAppliances

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/ListSmartHomeAppliances

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/ListSmartHomeAppliances

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/ListSmartHomeAppliances

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/ListSmartHomeAppliances

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/ListSmartHomeAppliances

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/ListSmartHomeAppliances

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/ListSmartHomeAppliances

Alexa For Business Alexa for Business APIListTags

ListTagsLists all tags for the specified resource.

Request Syntax{ "Arn": "string", "MaxResults": number, "NextToken": "string"}



Arn (p. 135)

The ARN of the specified resource for which to list tags.

Type: String


Required: YesMaxResults (p. 135)


Type: Integer




Type: String


Required: No

Response Syntax{



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



NextToken (p. 135)


Type: String

Length Constraints: Minimum length of 1. Maximum length of 1100.Tags (p. 135)

The tags requested for the specified resource.



NotFoundException






https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/ListTags

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/ListTags

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/ListTags

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/ListTags

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/ListTags

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/ListTags

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/ListTags

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/ListTags

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/ListTags

Alexa For Business Alexa for Business APIPutConferencePreference

PutConferencePreferenceSets the conference preferences on a specific conference provider at the account level.

Request Syntax{ "ConferencePreference": { "DefaultConferenceProviderArn": "string" }}



ConferencePreference (p. 137)

The conference preference of a specific conference provider.

Type: ConferencePreference (p. 230) object

Required: Yes



NotFoundException




• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript


https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/PutConferencePreference

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/PutConferencePreference

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/PutConferencePreference

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/PutConferencePreference

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/PutConferencePreference

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/PutConferencePreference


• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/PutConferencePreference

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/PutConferencePreference

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/PutConferencePreference

Alexa For Business Alexa for Business APIPutInvitationConfiguration

PutInvitationConfigurationConfigures the email template for the user enrollment invitation with the specified attributes.

Request Syntax{ "ContactEmail": "string", "OrganizationName": "string", "PrivateSkillIds": [ "string" ]}



ContactEmail (p. 139)

The email ID of the organization or individual contact that the enrolled user can use.

Type: String



Required: No

OrganizationName (p. 139)

The name of the organization sending the enrollment invite to a user.

Type: String



Required: Yes

PrivateSkillIds (p. 139)

The list of private skill IDs that you want to recommend to the user to enable in the invitation.




Required: No













https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/PutInvitationConfiguration

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/PutInvitationConfiguration

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/PutInvitationConfiguration

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/PutInvitationConfiguration

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/PutInvitationConfiguration

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/PutInvitationConfiguration

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/PutInvitationConfiguration

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/PutInvitationConfiguration

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/PutInvitationConfiguration

Alexa For Business Alexa for Business APIPutRoomSkillParameter

PutRoomSkillParameterUpdates room skill parameter details by room, skill, and parameter key ID. Not all skills have a room skillparameter.

Request Syntax{ "RoomArn": "string", "RoomSkillParameter": { "ParameterKey": "string", "ParameterValue": "string" }, "SkillId": "string"}



RoomArn (p. 141)

The ARN of the room associated with the room skill parameter. Required.

Type: String


Required: No

RoomSkillParameter (p. 141)

The updated room skill parameter. Required.

Type: RoomSkillParameter (p. 282) object

Required: Yes

SkillId (p. 141)

The ARN of the skill associated with the room skill parameter. Required.

Type: String


Required: Yes











https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/PutRoomSkillParameter

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/PutRoomSkillParameter

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/PutRoomSkillParameter

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/PutRoomSkillParameter

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/PutRoomSkillParameter

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/PutRoomSkillParameter

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/PutRoomSkillParameter

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/PutRoomSkillParameter

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/PutRoomSkillParameter

Alexa For Business Alexa for Business APIPutSkillAuthorization

PutSkillAuthorizationLinks a user's account to a third-party skill provider. If this API operation is called by an assumed IAMrole, the skill being linked must be a private skill. Also, the skill must be owned by the AWS account thatassumed the IAM role.

Request Syntax{ "AuthorizationResult": { "string" : "string" }, "RoomArn": "string", "SkillId": "string"}



AuthorizationResult (p. 143)

The authorization result specific to OAUTH code grant output. "Code” must be populated in theAuthorizationResult map to establish the authorization.

Type: String to string map

Key Length Constraints: Minimum length of 1.

Value Length Constraints: Minimum length of 1.

Required: Yes

RoomArn (p. 143)

The room that the skill is authorized for.

Type: String


Required: No

SkillId (p. 143)

The unique identifier of a skill.

Type: String


Required: Yes







HTTP Status Code: 400UnauthorizedException

The caller has no permissions to operate on the resource involved in the API call.





https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/PutSkillAuthorization

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/PutSkillAuthorization

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/PutSkillAuthorization

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/PutSkillAuthorization

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/PutSkillAuthorization

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/PutSkillAuthorization

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/PutSkillAuthorization

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/PutSkillAuthorization

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/PutSkillAuthorization

Alexa For Business Alexa for Business APIRegisterAVSDevice

RegisterAVSDeviceRegisters an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa VoiceService (AVS).

Request Syntax{ "AmazonId": "string", "ClientId": "string", "DeviceSerialNumber": "string", "ProductId": "string", "RoomArn": "string", "UserCode": "string"}



AmazonId (p. 145)

The device type ID for your AVS device generated by Amazon when the OEM creates a new producton Amazon's Developer Console.

Type: String

Pattern: [a-zA-Z0-9]{1,18}

Required: YesClientId (p. 145)

The client ID of the OEM used for code-based linking authorization on an AVS device.

Type: String

Pattern: ^\S+{1,256}$

Required: YesDeviceSerialNumber (p. 145)

The key generated by the OEM that uniquely identifies a specified instance of your AVS device.

Type: String

Pattern: ^[a-zA-Z0-9]{1,50}$

Required: NoProductId (p. 145)

The product ID used to identify your AVS device during authorization.

Type: String

Pattern: ^[a-zA-Z0-9_]{1,256}$




The Amazon Resource Name (ARN) of the room with which to associate your AVS device.

Type: String


Required: NoUserCode (p. 145)

The code that is obtained after your AVS device has made a POST request to LWA as a part of theDevice Authorization Request component of the OAuth code-based linking specification.

Type: String


Required: Yes

Response Syntax{ "DeviceArn": "string"}



DeviceArn (p. 146)

The ARN of the device.

Type: String





HTTP Status Code: 400InvalidDeviceException

The device is in an invalid state.











https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/RegisterAVSDevice

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/RegisterAVSDevice

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/RegisterAVSDevice

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/RegisterAVSDevice

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/RegisterAVSDevice

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/RegisterAVSDevice

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/RegisterAVSDevice

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/RegisterAVSDevice

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/RegisterAVSDevice

Alexa For Business Alexa for Business APIRejectSkill

RejectSkillDisassociates a skill from the organization under a user's AWS account. If the skill is a private skill, itmoves to an AcceptStatus of PENDING. Any private or public skill that is rejected can be added later bycalling the ApproveSkill API.




SkillId (p. 148)


Type: String


Required: Yes













https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/RejectSkill

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/RejectSkill

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/RejectSkill

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/RejectSkill

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/RejectSkill

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/RejectSkill

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/RejectSkill

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/RejectSkill

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/RejectSkill

Alexa For Business Alexa for Business APIResolveRoom

ResolveRoomDetermines the details for the room from which a skill request was invoked. This operation is used byskill developers.

Request Syntax{ "SkillId": "string", "UserId": "string"}



SkillId (p. 150)

The ARN of the skill that was requested. Required.

Type: String


Required: YesUserId (p. 150)

The ARN of the user. Required.

Type: String

Pattern: amzn1\.[A-Za-z0-9+-\/=.]{1,300}

Required: Yes

Response Syntax{ "RoomArn": "string", "RoomName": "string", "RoomSkillParameters": [ { "ParameterKey": "string", "ParameterValue": "string" } ]}





RoomArn (p. 150)

The ARN of the room from which the skill request was invoked.

Type: String


RoomName (p. 150)

The name of the room from which the skill request was invoked.

Type: String



RoomSkillParameters (p. 150)

Response to get the room profile request. Required.

Type: Array of RoomSkillParameter (p. 282) objects


NotFoundException






https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/ResolveRoom

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/ResolveRoom

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/ResolveRoom

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/ResolveRoom

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/ResolveRoom

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/ResolveRoom

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/ResolveRoom

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/ResolveRoom

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/ResolveRoom

Alexa For Business Alexa for Business APIRevokeInvitation

RevokeInvitationRevokes an invitation and invalidates the enrollment URL.

Request Syntax{ "EnrollmentId": "string", "UserArn": "string"}



EnrollmentId (p. 152)

The ARN of the enrollment invitation to revoke. Required.

Type: String


Required: NoUserArn (p. 152)

The ARN of the user for whom to revoke an enrollment invitation. Required.

Type: String


Required: No













https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/RevokeInvitation

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/RevokeInvitation

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/RevokeInvitation

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/RevokeInvitation

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/RevokeInvitation

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/RevokeInvitation

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/RevokeInvitation

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/RevokeInvitation

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/RevokeInvitation

Alexa For Business Alexa for Business APISearchAddressBooks

SearchAddressBooksSearches address books and lists the ones that meet a set of filter and sort criteria.

Request Syntax{ "Filters": [ { "Key": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string", "SortCriteria": [ { "Key": "string", "Value": "string" } ]}



Filters (p. 154)

The filters to use to list a specified set of address books. The supported filter key isAddressBookName.

Type: Array of Filter (p. 253) objects

Array Members: Maximum number of 25 items.


The maximum number of results to include in the response. If more results exist than the specifiedMaxResults value, a token is included in the response so that the remaining results can be retrieved.

Type: Integer



An optional token returned from a prior request. Use this token for pagination of results from thisaction. If this parameter is specified, the response only includes results beyond the token, up to thevalue specified by MaxResults.

Type: String




Required: NoSortCriteria (p. 154)

The sort order to use in listing the specified set of address books. The supported sort key isAddressBookName.

Type: Array of Sort (p. 293) objects


Required: No

Response Syntax{ "AddressBooks": [ { "AddressBookArn": "string", "Description": "string", "Name": "string" } ], "NextToken": "string", "TotalCount": number}



AddressBooks (p. 155)

The address books that meet the specified set of filter criteria, in sort order.

Type: Array of AddressBookData (p. 221) objectsNextToken (p. 155)


Type: String

Length Constraints: Minimum length of 1. Maximum length of 1100.TotalCount (p. 155)

The total number of address books returned.

Type: Integer







https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/SearchAddressBooks

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/SearchAddressBooks

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/SearchAddressBooks

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/SearchAddressBooks

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/SearchAddressBooks

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/SearchAddressBooks

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/SearchAddressBooks

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/SearchAddressBooks

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/SearchAddressBooks

Alexa For Business Alexa for Business APISearchContacts

SearchContactsSearches contacts and lists the ones that meet a set of filter and sort criteria.




Filters (p. 157)

The filters to use to list a specified set of address books. The supported filter keys are DisplayName,FirstName, LastName, and AddressBookArns.





Type: Integer



An optional token returned from a prior request. Use this token for pagination of results from thisaction. If this parameter is specified, the response only includes results beyond the token, up to thevalue specified by MaxResults.

Type: String





The sort order to use in listing the specified set of contacts. The supported sort keys areDisplayName, FirstName, and LastName.



Required: No

Response Syntax{ "Contacts": [ { "ContactArn": "string", "DisplayName": "string", "FirstName": "string", "LastName": "string", "PhoneNumber": "string", "PhoneNumbers": [ { "Number": "string", "Type": "string" } ], "SipAddresses": [ { "Type": "string", "Uri": "string" } ] } ], "NextToken": "string", "TotalCount": number}



Contacts (p. 158)

The contacts that meet the specified set of filter criteria, in sort order.

Type: Array of ContactData (p. 235) objectsNextToken (p. 158)


Type: String




The total number of contacts returned.

Type: Integer





https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/SearchContacts

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/SearchContacts

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/SearchContacts

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/SearchContacts

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/SearchContacts

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/SearchContacts

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/SearchContacts

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/SearchContacts

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/SearchContacts

Alexa For Business Alexa for Business APISearchDevices

SearchDevicesSearches devices and lists the ones that meet a set of filter criteria.




Filters (p. 160)

The filters to use to list a specified set of devices. Supported filter keys are DeviceName,DeviceStatus, DeviceStatusDetailCode, RoomName, DeviceType, DeviceSerialNumber,UnassociatedOnly, ConnectionStatus (ONLINE and OFFLINE), NetworkProfileName,NetworkProfileArn, Feature, and FailureCode.





Type: Integer






Type: String



The sort order to use in listing the specified set of devices. Supported sort keys areDeviceName, DeviceStatus, RoomName, DeviceType, DeviceSerialNumber, ConnectionStatus,NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.



Required: No

Response Syntax{ "Devices": [ { "CreatedTime": number, "DeviceArn": "string", "DeviceName": "string", "DeviceSerialNumber": "string", "DeviceStatus": "string", "DeviceStatusInfo": { "ConnectionStatus": "string", "ConnectionStatusUpdatedTime": number, "DeviceStatusDetails": [ { "Code": "string", "Feature": "string" } ] }, "DeviceType": "string", "MacAddress": "string", "NetworkProfileArn": "string", "NetworkProfileName": "string", "RoomArn": "string", "RoomName": "string", "SoftwareVersion": "string" } ], "NextToken": "string", "TotalCount": number}



Devices (p. 161)

The devices that meet the specified set of filter criteria, in sort order.



Type: Array of DeviceData (p. 245) objectsNextToken (p. 161)


Type: String


The total number of devices returned.

Type: Integer





https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/SearchDevices

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/SearchDevices

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/SearchDevices

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/SearchDevices

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/SearchDevices

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/SearchDevices

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/SearchDevices

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/SearchDevices

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/SearchDevices

Alexa For Business Alexa for Business APISearchNetworkProfiles

SearchNetworkProfilesSearches network profiles and lists the ones that meet a set of filter and sort criteria.




Filters (p. 163)

The filters to use to list a specified set of network profiles. Valid filters are NetworkProfileName,Ssid, and SecurityType.





Type: Integer




Type: String





The sort order to use to list the specified set of network profiles. Valid sort criteria includesNetworkProfileName, Ssid, and SecurityType.



Required: No

Response Syntax{ "NetworkProfiles": [ { "CertificateAuthorityArn": "string", "Description": "string", "EapMethod": "string", "NetworkProfileArn": "string", "NetworkProfileName": "string", "SecurityType": "string", "Ssid": "string" } ], "NextToken": "string", "TotalCount": number}



NetworkProfiles (p. 164)

The network profiles that meet the specified set of filter criteria, in sort order. It is a list ofNetworkProfileData objects.

Type: Array of NetworkProfileData (p. 267) objectsNextToken (p. 164)


Type: String


The total number of network profiles returned.

Type: Integer







https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/SearchNetworkProfiles

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/SearchNetworkProfiles

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/SearchNetworkProfiles

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/SearchNetworkProfiles

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/SearchNetworkProfiles

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/SearchNetworkProfiles

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/SearchNetworkProfiles

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/SearchNetworkProfiles

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/SearchNetworkProfiles

Alexa For Business Alexa for Business APISearchProfiles

SearchProfilesSearches room profiles and lists the ones that meet a set of filter criteria.




Filters (p. 166)

The filters to use to list a specified set of room profiles. Supported filter keys are ProfileName andAddress. Required.





Type: Integer




Type: String





The sort order to use in listing the specified set of room profiles. Supported sort keys areProfileName and Address.



Required: No

Response Syntax{ "NextToken": "string", "Profiles": [ { "Address": "string", "DistanceUnit": "string", "IsDefault": boolean, "Locale": "string", "ProfileArn": "string", "ProfileName": "string", "TemperatureUnit": "string", "Timezone": "string", "WakeWord": "string" } ], "TotalCount": number}



NextToken (p. 167)


Type: String

Length Constraints: Minimum length of 1. Maximum length of 1100.Profiles (p. 167)

The profiles that meet the specified set of filter criteria, in sort order.

Type: Array of ProfileData (p. 273) objectsTotalCount (p. 167)

The total number of room profiles returned.

Type: Integer







https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/SearchProfiles

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/SearchProfiles

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/SearchProfiles

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/SearchProfiles

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/SearchProfiles

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/SearchProfiles

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/SearchProfiles

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/SearchProfiles

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/SearchProfiles

Alexa For Business Alexa for Business APISearchRooms

SearchRoomsSearches rooms and lists the ones that meet a set of filter and sort criteria.




Filters (p. 169)

The filters to use to list a specified set of rooms. The supported filter keys are RoomName andProfileName.



Required: No

MaxResults (p. 169)


Type: Integer


Required: No

NextToken (p. 169)




Type: String


Required: No

SortCriteria (p. 169)

The sort order to use in listing the specified set of rooms. The supported sort keys are RoomNameand ProfileName.



Required: No

Response Syntax{ "NextToken": "string", "Rooms": [ { "Description": "string", "ProfileArn": "string", "ProfileName": "string", "ProviderCalendarId": "string", "RoomArn": "string", "RoomName": "string" } ], "TotalCount": number}



NextToken (p. 170)


Type: String


Rooms (p. 170)

The rooms that meet the specified set of filter criteria, in sort order.

Type: Array of RoomData (p. 280) objects

TotalCount (p. 170)

The total number of rooms returned.

Type: Integer







https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/SearchRooms

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/SearchRooms

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/SearchRooms

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/SearchRooms

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/SearchRooms

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/SearchRooms

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/SearchRooms

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/SearchRooms

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/SearchRooms

Alexa For Business Alexa for Business APISearchSkillGroups

SearchSkillGroupsSearches skill groups and lists the ones that meet a set of filter and sort criteria.




Filters (p. 172)

The filters to use to list a specified set of skill groups. The supported filter key is SkillGroupName.





Type: Integer



An optional token returned from a prior request. Use this token for pagination of results from thisaction. If this parameter is specified, the response includes only results beyond the token, up to thevalue specified by MaxResults. Required.

Type: String





The sort order to use in listing the specified set of skill groups. The supported sort key isSkillGroupName.



Required: No

Response Syntax{ "NextToken": "string", "SkillGroups": [ { "Description": "string", "SkillGroupArn": "string", "SkillGroupName": "string" } ], "TotalCount": number}



NextToken (p. 173)


Type: String

Length Constraints: Minimum length of 1. Maximum length of 1100.SkillGroups (p. 173)

The skill groups that meet the filter criteria, in sort order.

Type: Array of SkillGroupData (p. 287) objectsTotalCount (p. 173)

The total number of skill groups returned.

Type: Integer







https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/SearchSkillGroups

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/SearchSkillGroups

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/SearchSkillGroups

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/SearchSkillGroups

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/SearchSkillGroups

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/SearchSkillGroups

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/SearchSkillGroups

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/SearchSkillGroups

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/SearchSkillGroups

Alexa For Business Alexa for Business APISearchUsers

SearchUsersSearches users and lists the ones that meet a set of filter and sort criteria.




Filters (p. 175)

The filters to use for listing a specific set of users. Required. Supported filter keys are UserId,FirstName, LastName, Email, and EnrollmentStatus.



Required: No

MaxResults (p. 175)

The maximum number of results to include in the response. If more results exist than the specifiedMaxResults value, a token is included in the response so that the remaining results can beretrieved. Required.

Type: Integer


Required: No

NextToken (p. 175)

An optional token returned from a prior request. Use this token for pagination of results from thisaction. If this parameter is specified, the response includes only results beyond the token, up to thevalue specified by MaxResults. Required.



Type: String


Required: No

SortCriteria (p. 175)

The sort order to use in listing the filtered set of users. Required. Supported sort keys are UserId,FirstName, LastName, Email, and EnrollmentStatus.



Required: No

Response Syntax{ "NextToken": "string", "TotalCount": number, "Users": [ { "Email": "string", "EnrollmentId": "string", "EnrollmentStatus": "string", "FirstName": "string", "LastName": "string", "UserArn": "string" } ]}



NextToken (p. 176)


Type: String


TotalCount (p. 176)

The total number of users returned.

Type: Integer

Users (p. 176)

The users that meet the specified set of filter criteria, in sort order.

Type: Array of UserData (p. 301) objects







https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/SearchUsers

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/SearchUsers

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/SearchUsers

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/SearchUsers

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/SearchUsers

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/SearchUsers

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/SearchUsers

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/SearchUsers

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/SearchUsers

Alexa For Business Alexa for Business APISendAnnouncement

SendAnnouncementTriggers an asynchronous flow to send text, SSML, or audio announcements to rooms that are identifiedby a search or filter.

Request Syntax{ "ClientRequestToken": "string", "Content": { "AudioList": [ { "Locale": "string", "Location": "string" } ], "SsmlList": [ { "Locale": "string", "Value": "string" } ], "TextList": [ { "Locale": "string", "Value": "string" } ] }, "RoomFilters": [ { "Key": "string", "Values": [ "string" ] } ], "TimeToLiveInSeconds": number}




The unique, user-specified identifier for the request that ensures idempotency.

Type: String



Required: YesContent (p. 178)

The announcement content. This can contain only one of the three possible announcement types(text, SSML or audio).



Type: Content (p. 237) object

Required: YesRoomFilters (p. 178)

The filters to use to send an announcement to a specified list of rooms. The supported filter keysare RoomName, ProfileName, RoomArn, and ProfileArn. To send to all rooms, specify an emptyRoomFilters list.



Required: YesTimeToLiveInSeconds (p. 178)

The time to live for an announcement. Default is 300. If delivery doesn't occur within this time, theannouncement is not delivered.

Type: Integer


Required: No

Response Syntax{ "AnnouncementArn": "string"}



AnnouncementArn (p. 179)

The identifier of the announcement.

Type: String














https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/SendAnnouncement

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/SendAnnouncement

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/SendAnnouncement

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/SendAnnouncement

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/SendAnnouncement

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/SendAnnouncement

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/SendAnnouncement

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/SendAnnouncement

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/SendAnnouncement

Alexa For Business Alexa for Business APISendInvitation

SendInvitationSends an enrollment invitation email with a URL to a user. The URL is valid for 30 days or until you callthis operation again, whichever comes first.

Request Syntax{ "UserArn": "string"}



UserArn (p. 181)

The ARN of the user to whom to send an invitation. Required.

Type: String


Required: No






InvalidUserStatusException

The attempt to update a user is invalid due to the user's current status.


NotFoundException








https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/SendInvitation

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/SendInvitation

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/SendInvitation

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/SendInvitation

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/SendInvitation

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/SendInvitation

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/SendInvitation

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/SendInvitation

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/SendInvitation

Alexa For Business Alexa for Business APIStartDeviceSync

StartDeviceSyncResets a device and its account to the known default settings. This clears all information and settings setby previous users in the following ways:

• Bluetooth - This unpairs all bluetooth devices paired with your echo device.• Volume - This resets the echo device's volume to the default value.• Notifications - This clears all notifications from your echo device.• Lists - This clears all to-do items from your echo device.• Settings - This internally syncs the room's profile (if the device is assigned to a room), contacts, address

books, delegation access for account linking, and communications (if enabled on the room profile).

Request Syntax{ "DeviceArn": "string", "Features": [ "string" ], "RoomArn": "string"}



DeviceArn (p. 183)

The ARN of the device to sync. Required.

Type: String


Required: NoFeatures (p. 183)

Request structure to start the device sync. Required.


Valid Values: BLUETOOTH | VOLUME | NOTIFICATIONS | LISTS | SKILLS |NETWORK_PROFILE | SETTINGS | ALL


The ARN of the room with which the device to sync is associated. Required.

Type: String




Required: No









https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/StartDeviceSync

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/StartDeviceSync

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/StartDeviceSync

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/StartDeviceSync

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/StartDeviceSync

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/StartDeviceSync

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/StartDeviceSync

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/StartDeviceSync

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/StartDeviceSync

Alexa For Business Alexa for Business APIStartSmartHomeApplianceDiscovery

StartSmartHomeApplianceDiscoveryInitiates the discovery of any smart home appliances associated with the room.




RoomArn (p. 185)

The room where smart home appliance discovery was initiated.

Type: String


Required: Yes



NotFoundException






https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/StartSmartHomeApplianceDiscovery

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/StartSmartHomeApplianceDiscovery

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/StartSmartHomeApplianceDiscovery

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/StartSmartHomeApplianceDiscovery

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/StartSmartHomeApplianceDiscovery




https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/StartSmartHomeApplianceDiscovery

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/StartSmartHomeApplianceDiscovery

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/StartSmartHomeApplianceDiscovery

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/StartSmartHomeApplianceDiscovery

Alexa For Business Alexa for Business APITagResource

TagResourceAdds metadata tags to a specified resource.

Request Syntax{ "Arn": "string", "Tags": [ { "Key": "string", "Value": "string" } ]}



Arn (p. 187)

The ARN of the resource to which to add metadata tags. Required.

Type: String



The tags to be added to the specified resource. Do not provide system tags. Required.


Required: Yes



NotFoundException








https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/TagResource

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/TagResource

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/TagResource

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/TagResource

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/TagResource

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/TagResource

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/TagResource

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/TagResource

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/TagResource

Alexa For Business Alexa for Business APIUntagResource

UntagResourceRemoves metadata tags from a specified resource.

Request Syntax{ "Arn": "string", "TagKeys": [ "string" ]}



Arn (p. 189)

The ARN of the resource from which to remove metadata tags. Required.

Type: String


Required: Yes

TagKeys (p. 189)

The tags to be removed from the specified resource. Do not provide system tags. Required.



Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

Required: Yes



NotFoundException








https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/UntagResource

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/UntagResource

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/UntagResource

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/UntagResource

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/UntagResource

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/UntagResource

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/UntagResource

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/UntagResource

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/UntagResource

Alexa For Business Alexa for Business APIUpdateAddressBook

UpdateAddressBookUpdates address book details by the address book ARN.

Request Syntax{ "AddressBookArn": "string", "Description": "string", "Name": "string"}




The ARN of the room to update.

Type: String


Required: YesDescription (p. 191)

The updated description of the room.

Type: String



Required: NoName (p. 191)

The updated name of the room.

Type: String



Required: No







HTTP Status Code: 400NameInUseException

The name sent in the request is already in use.







https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/UpdateAddressBook

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/UpdateAddressBook

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/UpdateAddressBook

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/UpdateAddressBook

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/UpdateAddressBook

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/UpdateAddressBook

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/UpdateAddressBook

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/UpdateAddressBook

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/UpdateAddressBook

Alexa For Business Alexa for Business APIUpdateBusinessReportSchedule

UpdateBusinessReportScheduleUpdates the configuration of the report delivery schedule with the specified schedule ARN.

Request Syntax{ "Format": "string", "Recurrence": { "StartDate": "string" }, "S3BucketName": "string", "S3KeyPrefix": "string", "ScheduleArn": "string", "ScheduleName": "string"}



Format (p. 193)


Type: String


Required: NoRecurrence (p. 193)

The recurrence of the reports.


Required: NoS3BucketName (p. 193)

The S3 location of the output reports.

Type: String

Pattern: [a-z0-9-\.]{3,63}

Required: NoS3KeyPrefix (p. 193)


Type: String


Pattern: [A-Za-z0-9!_\-\.\*'()/]*



Required: NoScheduleArn (p. 193)


Type: String


Required: YesScheduleName (p. 193)


Type: String



Required: No









• 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


https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/UpdateBusinessReportSchedule

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/UpdateBusinessReportSchedule

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/UpdateBusinessReportSchedule

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/UpdateBusinessReportSchedule

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/UpdateBusinessReportSchedule

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/UpdateBusinessReportSchedule

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/UpdateBusinessReportSchedule


• AWS SDK for Python• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/UpdateBusinessReportSchedule

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/UpdateBusinessReportSchedule

Alexa For Business Alexa for Business APIUpdateConferenceProvider

UpdateConferenceProviderUpdates an existing conference provider's settings.

Request Syntax{ "ConferenceProviderArn": "string", "ConferenceProviderType": "string", "IPDialIn": { "CommsProtocol": "string", "Endpoint": "string" }, "MeetingSetting": { "RequirePin": "string" }, "PSTNDialIn": { "CountryCode": "string", "OneClickIdDelay": "string", "OneClickPinDelay": "string", "PhoneNumber": "string" }}




The ARN of the conference provider.

Type: String


Required: YesConferenceProviderType (p. 196)

The type of the conference provider.

Type: String


Required: YesIPDialIn (p. 196)



Required: No



MeetingSetting (p. 196)



Required: YesPSTNDialIn (p. 196)



Required: No



NotFoundException






https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/UpdateConferenceProvider

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/UpdateConferenceProvider

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/UpdateConferenceProvider

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/UpdateConferenceProvider

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/UpdateConferenceProvider

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/UpdateConferenceProvider

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/UpdateConferenceProvider

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/UpdateConferenceProvider

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/UpdateConferenceProvider

Alexa For Business Alexa for Business APIUpdateContact

UpdateContactUpdates the contact details by the contact ARN.

Request Syntax{ "ContactArn": "string", "DisplayName": "string", "FirstName": "string", "LastName": "string", "PhoneNumber": "string", "PhoneNumbers": [ { "Number": "string", "Type": "string" } ], "SipAddresses": [ { "Type": "string", "Uri": "string" } ]}



ContactArn (p. 198)

The ARN of the contact to update.

Type: String


Required: YesDisplayName (p. 198)

The updated display name of the contact.

Type: String




The updated first name of the contact.



Type: String



Required: NoLastName (p. 198)

The updated last name of the contact.

Type: String



Required: NoPhoneNumber (p. 198)

The updated phone number of the contact. The phone number type defaults to WORK. You caneither specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, whichlets you specify the phone number type and multiple numbers.

Type: String


Pattern: ^[\+0-9\#\,$][\+0-9\-\.\/\($\,\#\s]+$

Required: NoPhoneNumbers (p. 198)




Required: NoSipAddresses (p. 198)




Required: No













https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/UpdateContact

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/UpdateContact

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/UpdateContact

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/UpdateContact

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/UpdateContact

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/UpdateContact

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/UpdateContact

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/UpdateContact

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/UpdateContact

Alexa For Business Alexa for Business APIUpdateDevice

UpdateDeviceUpdates the device name by device ARN.

Request Syntax{ "DeviceArn": "string", "DeviceName": "string"}



DeviceArn (p. 201)

The ARN of the device to update. Required.

Type: String


Required: NoDeviceName (p. 201)

The updated device name. Required.

Type: String



Required: No
















https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/UpdateDevice

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/UpdateDevice

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/UpdateDevice

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/UpdateDevice

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/UpdateDevice

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/UpdateDevice

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/UpdateDevice

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/UpdateDevice

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/UpdateDevice

Alexa For Business Alexa for Business APIUpdateGateway

UpdateGatewayUpdates the details of a gateway. If any optional field is not provided, the existing corresponding value isleft unmodified.

Request Syntax{ "Description": "string", "GatewayArn": "string", "Name": "string", "SoftwareVersion": "string"}



Description (p. 203)

The updated description of the gateway.

Type: String



Required: No

GatewayArn (p. 203)

The ARN of the gateway to update.

Type: String


Required: Yes

Name (p. 203)

The updated name of the gateway.

Type: String



Required: No



SoftwareVersion (p. 203)

The updated software version of the gateway. The gateway automatically updates its softwareversion during normal operation.

Type: String


Required: No



NameInUseException








https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/UpdateGateway

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/UpdateGateway

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/UpdateGateway

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/UpdateGateway

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/UpdateGateway

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/UpdateGateway

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/UpdateGateway

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/UpdateGateway

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/UpdateGateway

Alexa For Business Alexa for Business APIUpdateGatewayGroup

UpdateGatewayGroupUpdates the details of a gateway group. If any optional field is not provided, the existing correspondingvalue is left unmodified.

Request Syntax{ "Description": "string", "GatewayGroupArn": "string", "Name": "string"}




The updated description of the gateway group.

Type: String


Required: NoGatewayGroupArn (p. 205)

The ARN of the gateway group to update.

Type: String


Required: YesName (p. 205)

The updated name of the gateway group.

Type: String



Required: No





NameInUseException








https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/UpdateGatewayGroup

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/UpdateGatewayGroup

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/UpdateGatewayGroup

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/UpdateGatewayGroup

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/UpdateGatewayGroup

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/UpdateGatewayGroup

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/UpdateGatewayGroup

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/UpdateGatewayGroup

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/UpdateGatewayGroup

Alexa For Business Alexa for Business APIUpdateNetworkProfile

UpdateNetworkProfileUpdates a network profile by the network profile ARN.

Request Syntax{ "CertificateAuthorityArn": "string", "CurrentPassword": "string", "Description": "string", "NetworkProfileArn": "string", "NetworkProfileName": "string", "NextPassword": "string", "TrustAnchors": [ "string" ]}



CertificateAuthorityArn (p. 207)


Type: String


Required: NoCurrentPassword (p. 207)


Type: String





Type: String



Required: No





Type: String


Required: Yes

NetworkProfileName (p. 207)


Type: String



Required: No

NextPassword (p. 207)


Type: String


Pattern: (^$)|([\x00-\x7F]{5,})

Required: No

TrustAnchors (p. 207)

The root certificate(s) of your authentication server that will be installed on your devices and used totrust your authentication server during EAP negotiation.




Required: No









HTTP Status Code: 400InvalidSecretsManagerResourceException

A password in SecretsManager is in an invalid state.









https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/UpdateNetworkProfile

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/UpdateNetworkProfile

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/UpdateNetworkProfile

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/UpdateNetworkProfile

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/UpdateNetworkProfile

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/UpdateNetworkProfile

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/UpdateNetworkProfile

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/UpdateNetworkProfile

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/UpdateNetworkProfile

Alexa For Business Alexa for Business APIUpdateProfile

UpdateProfileUpdates an existing room profile by room profile ARN.

Request Syntax{ "Address": "string", "DistanceUnit": "string", "IsDefault": boolean, "Locale": "string", "MaxVolumeLimit": number, "MeetingRoomConfiguration": { "EndOfMeetingReminder": { "Enabled": boolean, "ReminderAtMinutes": [ number ], "ReminderType": "string" }, "InstantBooking": { "DurationInMinutes": number, "Enabled": boolean }, "RequireCheckIn": { "Enabled": boolean, "ReleaseAfterMinutes": number }, "RoomUtilizationMetricsEnabled": boolean }, "ProfileArn": "string", "ProfileName": "string", "PSTNEnabled": boolean, "SetupModeDisabled": boolean, "TemperatureUnit": "string", "Timezone": "string", "WakeWord": "string"}



Address (p. 210)

The updated address for the room profile.

Type: String


Required: NoDistanceUnit (p. 210)

The updated distance unit for the room profile.

Type: String




Required: NoIsDefault (p. 210)

Sets the profile as default if selected. If this is missing, no update is done to the default status.

Type: Boolean

Required: NoLocale (p. 210)

The updated locale for the room profile. (This is currently only available to a limited previewaudience.)

Type: String


Required: NoMaxVolumeLimit (p. 210)

The updated maximum volume limit for the room profile.

Type: Integer

Required: NoMeetingRoomConfiguration (p. 210)

The updated meeting room settings of a room profile.

Type: UpdateMeetingRoomConfiguration (p. 299) object


The ARN of the room profile to update. Required.

Type: String


Required: NoProfileName (p. 210)

The updated name for the room profile.

Type: String



Required: NoPSTNEnabled (p. 210)

Whether the PSTN setting of the room profile is enabled.

Type: Boolean



Required: NoSetupModeDisabled (p. 210)

Whether the setup mode of the profile is enabled.

Type: Boolean

Required: NoTemperatureUnit (p. 210)

The updated temperature unit for the room profile.

Type: String


Required: NoTimezone (p. 210)

The updated timezone for the room profile.

Type: String


Required: NoWakeWord (p. 210)

The updated wake word for the room profile.

Type: String


Required: No















https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/UpdateProfile

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/UpdateProfile

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/UpdateProfile

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/UpdateProfile

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/UpdateProfile

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/UpdateProfile

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/UpdateProfile

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/UpdateProfile

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/UpdateProfile

Alexa For Business Alexa for Business APIUpdateRoom

UpdateRoomUpdates room details by room ARN.

Request Syntax{ "Description": "string", "ProfileArn": "string", "ProviderCalendarId": "string", "RoomArn": "string", "RoomName": "string"}




The updated description for the room.

Type: String




The updated profile ARN for the room.

Type: String


Required: NoProviderCalendarId (p. 214)

The updated provider calendar ARN for the room.

Type: String



The ARN of the room to update.

Type: String




Required: NoRoomName (p. 214)

The updated name for the room.

Type: String



Required: No



NameInUseException








https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/UpdateRoom

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/UpdateRoom

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/UpdateRoom

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/UpdateRoom

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/UpdateRoom

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/UpdateRoom

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/UpdateRoom

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/UpdateRoom

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/UpdateRoom

Alexa For Business Alexa for Business APIUpdateSkillGroup

UpdateSkillGroupUpdates skill group details by skill group ARN.

Request Syntax{ "Description": "string", "SkillGroupArn": "string", "SkillGroupName": "string"}




The updated description for the skill group.

Type: String



Required: NoSkillGroupArn (p. 216)

The ARN of the skill group to update.

Type: String


Required: NoSkillGroupName (p. 216)

The updated name for the skill group.

Type: String



Required: No















https://docs.aws.amazon.com/goto/aws-cli/alexaforbusiness-2017-11-09/UpdateSkillGroup

https://docs.aws.amazon.com/goto/DotNetSDKV3/alexaforbusiness-2017-11-09/UpdateSkillGroup

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/UpdateSkillGroup

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/UpdateSkillGroup

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/UpdateSkillGroup

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/alexaforbusiness-2017-11-09/UpdateSkillGroup

https://docs.aws.amazon.com/goto/SdkForPHPV3/alexaforbusiness-2017-11-09/UpdateSkillGroup

https://docs.aws.amazon.com/goto/boto3/alexaforbusiness-2017-11-09/UpdateSkillGroup

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/UpdateSkillGroup


Data TypesThe Alexa For Business API contains several data types that various actions use. This section describeseach data 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:

• AddressBook (p. 220)• AddressBookData (p. 221)• Audio (p. 222)• BusinessReport (p. 223)• BusinessReportContentRange (p. 224)• BusinessReportRecurrence (p. 225)• BusinessReportS3Location (p. 226)• BusinessReportSchedule (p. 227)• Category (p. 229)• ConferencePreference (p. 230)• ConferenceProvider (p. 231)• Contact (p. 233)• ContactData (p. 235)• Content (p. 237)• CreateEndOfMeetingReminder (p. 238)• CreateInstantBooking (p. 239)• CreateMeetingRoomConfiguration (p. 240)• CreateRequireCheckIn (p. 241)• DeveloperInfo (p. 242)• Device (p. 243)• DeviceData (p. 245)• DeviceEvent (p. 248)• DeviceNetworkProfileInfo (p. 249)• DeviceStatusDetail (p. 250)• DeviceStatusInfo (p. 251)• EndOfMeetingReminder (p. 252)• Filter (p. 253)• Gateway (p. 254)• GatewayGroup (p. 256)• GatewayGroupSummary (p. 257)• GatewaySummary (p. 258)• InstantBooking (p. 260)• IPDialIn (p. 261)• MeetingRoomConfiguration (p. 262)• MeetingSetting (p. 263)



• NetworkProfile (p. 264)• NetworkProfileData (p. 267)• PhoneNumber (p. 269)• Profile (p. 270)• ProfileData (p. 273)• PSTNDialIn (p. 275)• RequireCheckIn (p. 277)• Room (p. 278)• RoomData (p. 280)• RoomSkillParameter (p. 282)• SipAddress (p. 283)• SkillDetails (p. 284)• SkillGroup (p. 286)• SkillGroupData (p. 287)• SkillsStoreSkill (p. 288)• SkillSummary (p. 290)• SmartHomeAppliance (p. 292)• Sort (p. 293)• Ssml (p. 294)• Tag (p. 295)• Text (p. 296)• UpdateEndOfMeetingReminder (p. 297)• UpdateInstantBooking (p. 298)• UpdateMeetingRoomConfiguration (p. 299)• UpdateRequireCheckIn (p. 300)• UserData (p. 301)


Alexa For Business Alexa for Business APIAddressBook

AddressBookAn address book with attributes.

ContentsAddressBookArn

The ARN of the address book.

Type: String


Required: NoDescription


Type: String



Required: NoName


Type: String



Required: No


• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/AddressBook

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/AddressBook

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/AddressBook

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/AddressBook

Alexa For Business Alexa for Business APIAddressBookData

AddressBookDataInformation related to an address book.

ContentsAddressBookArn


Type: String




Type: String



Required: NoName


Type: String



Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/AddressBookData

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/AddressBookData

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/AddressBookData

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/AddressBookData

Alexa For Business Alexa for Business APIAudio

AudioThe audio message. There is a 1 MB limit on the audio file input and the only supported format is MP3.To convert your MP3 audio files to an Alexa-friendly,

required codec version (MPEG version 2) and bit rate (48 kbps), you might use converter software. Oneoption for this is a command-line tool, FFmpeg. For more information, see FFmpeg. The followingcommand converts the provided <input-file> to an MP3 file that is played in the announcement:

ffmpeg -i <input-file> -ac 2 -codec:a libmp3lame -b:a 48k -ar 16000 <output-file.mp3>

ContentsLocale

The locale of the audio message. Currently, en-US is supported.

Type: String

Valid Values: en-US

Required: YesLocation

The location of the audio file. Currently, S3 URLs are supported. Only S3 locations comprised of safecharacters are valid. For more information, see Safe Characters.

Type: String


Pattern: https://([A-Za-z0-9_.-]+)?(s3-[A-Za-z0-9-]+|s3\.([A-Za-z0-9-])+|s3|s3.dualstack\.([A-Za-z0-9-])+)+.amazonaws.com/.*

Required: Yes




https://www.ffmpeg.org/

https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#Safe%20Characters

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/Audio

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/Audio

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/Audio

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/Audio

Alexa For Business Alexa for Business APIBusinessReport

BusinessReportUsage report with specified parameters.

ContentsDeliveryTime

The time of report delivery.

Type: Timestamp

Required: NoDownloadUrl

The download link where a user can download the report.

Type: String

Required: NoFailureCode

The failure code.

Type: String

Valid Values: ACCESS_DENIED | NO_SUCH_BUCKET | INTERNAL_FAILURE

Required: NoS3Location

The S3 location of the output reports.

Type: BusinessReportS3Location (p. 226) object

Required: NoStatus

The status of the report generation execution (RUNNING, SUCCEEDED, or FAILED).

Type: String

Valid Values: RUNNING | SUCCEEDED | FAILED

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/BusinessReport

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/BusinessReport

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/BusinessReport

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/BusinessReport

Alexa For Business Alexa for Business APIBusinessReportContentRange

BusinessReportContentRangeThe content range of the report.

ContentsInterval

The interval of the content range.

Type: String

Valid Values: ONE_DAY | ONE_WEEK | THIRTY_DAYS

Required: Yes




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/BusinessReportContentRange

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/BusinessReportContentRange

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/BusinessReportContentRange

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/BusinessReportContentRange

Alexa For Business Alexa for Business APIBusinessReportRecurrence

BusinessReportRecurrenceThe recurrence of the reports.

ContentsStartDate

The start date.

Type: String

Pattern: ^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/BusinessReportRecurrence

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/BusinessReportRecurrence

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/BusinessReportRecurrence

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/BusinessReportRecurrence

Alexa For Business Alexa for Business APIBusinessReportS3Location

BusinessReportS3LocationThe S3 location of the output reports.

ContentsBucketName

The S3 bucket name of the output reports.

Type: String

Pattern: [a-z0-9-\.]{3,63}

Required: NoPath

The path of the business report.

Type: String

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/BusinessReportS3Location

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/BusinessReportS3Location

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/BusinessReportS3Location

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/BusinessReportS3Location

Alexa For Business Alexa for Business APIBusinessReportSchedule

BusinessReportScheduleThe schedule of the usage report.

ContentsContentRange

The content range of the reports.

Type: BusinessReportContentRange (p. 224) object

Required: NoFormat


Type: String


Required: NoLastBusinessReport

The details of the last business report delivery for a specified time interval.

Type: BusinessReport (p. 223) object

Required: NoRecurrence

The recurrence of the reports.


Required: NoS3BucketName

The S3 bucket name of the output reports.

Type: String

Pattern: [a-z0-9-\.]{3,63}

Required: NoS3KeyPrefix


Type: String


Pattern: [A-Za-z0-9!_\-\.\*'()/]*

Required: NoScheduleArn




Type: String


Required: NoScheduleName


Type: String



Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/BusinessReportSchedule

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/BusinessReportSchedule

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/BusinessReportSchedule

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/BusinessReportSchedule

Alexa For Business Alexa for Business APICategory

CategoryThe skill store category that is shown. Alexa skills are assigned a specific skill category during creation,such as News, Social, and Sports.

ContentsCategoryId

The ID of the skill store category.

Type: Long

Valid Range: Minimum value of 1.

Required: NoCategoryName

The name of the skill store category.

Type: String

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/Category

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/Category

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/Category

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/Category

Alexa For Business Alexa for Business APIConferencePreference

ConferencePreferenceThe default conference provider that is used if no other scheduled meetings are detected.

ContentsDefaultConferenceProviderArn

The ARN of the default conference provider.

Type: String


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/ConferencePreference

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/ConferencePreference

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/ConferencePreference

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/ConferencePreference

Alexa For Business Alexa for Business APIConferenceProvider

ConferenceProviderAn entity that provides a conferencing solution. Alexa for Business acts as the voice interface andmediator that connects users to their preferred conference provider. Examples of conference providersinclude Amazon Chime, Zoom, Cisco, and Polycom.

ContentsArn

The ARN of the newly created conference provider.

Type: String


Required: NoIPDialIn



Required: NoMeetingSetting



Required: NoName

The name of the conference provider.

Type: String



Required: NoPSTNDialIn



Required: NoType

The type of conference providers.

Type: String




Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/ConferenceProvider

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/ConferenceProvider

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/ConferenceProvider

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/ConferenceProvider

Alexa For Business Alexa for Business APIContact

ContactA contact with attributes.

ContentsContactArn

The ARN of the contact.

Type: String


Required: NoDisplayName


Type: String



Required: NoFirstName

The first name of the contact, used to call the contact on the device.

Type: String



Required: NoLastName

The last name of the contact, used to call the contact on the device.

Type: String



Required: NoPhoneNumber

The phone number of the contact. The phone number type defaults to WORK. You can either specifyPhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, which lets youspecify the phone number type and multiple numbers.

Type: String




Pattern: ^[\+0-9\#\,$][\+0-9\-\.\/\($\,\#\s]+$

Required: NoPhoneNumbers




Required: NoSipAddresses




Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/Contact

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/Contact

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/Contact

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/Contact

Alexa For Business Alexa for Business APIContactData

ContactDataInformation related to a contact.

ContentsContactArn

The ARN of the contact.

Type: String


Required: NoDisplayName


Type: String




The first name of the contact, used to call the contact on the device.

Type: String




The last name of the contact, used to call the contact on the device.

Type: String



Required: NoPhoneNumber

The phone number of the contact. The phone number type defaults to WORK. You can specifyPhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, which lets youspecify the phone number type and multiple numbers.

Type: String




Pattern: ^[\+0-9\#\,$][\+0-9\-\.\/\($\,\#\s]+$

Required: NoPhoneNumbers




Required: NoSipAddresses




Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/ContactData

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/ContactData

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/ContactData

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/ContactData

Alexa For Business Alexa for Business APIContent

ContentThe content definition. This can contain only one text, SSML, or audio list object.

ContentsAudioList

The list of audio messages.

Type: Array of Audio (p. 222) objects

Array Members: Maximum number of 1 item.

Required: NoSsmlList

The list of SSML messages.

Type: Array of Ssml (p. 294) objects


Required: NoTextList

The list of text messages.

Type: Array of Text (p. 296) objects


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/Content

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/Content

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/Content

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/Content

Alexa For Business Alexa for Business APICreateEndOfMeetingReminder

CreateEndOfMeetingReminderCreates settings for the end of meeting reminder feature that are applied to a room profile. The end ofmeeting reminder enables Alexa to remind users when a meeting is ending.

ContentsEnabled

Whether an end of meeting reminder is enabled or not.

Type: Boolean

Required: YesReminderAtMinutes

A range of 3 to 15 minutes that determines when the reminder begins.

Type: Array of integers

Array Members: Fixed number of 1 item.

Required: YesReminderType

The type of sound that users hear during the end of meeting reminder.

Type: String

Valid Values: ANNOUNCEMENT_TIME_CHECK | ANNOUNCEMENT_VARIABLE_TIME_LEFT | CHIME| KNOCK

Required: Yes




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/CreateEndOfMeetingReminder

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/CreateEndOfMeetingReminder

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/CreateEndOfMeetingReminder

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/CreateEndOfMeetingReminder

Alexa For Business Alexa for Business APICreateInstantBooking

CreateInstantBookingCreates settings for the instant booking feature that are applied to a room profile. When users starttheir meeting with Alexa, Alexa automatically books the room for the configured duration if the room isavailable.

ContentsDurationInMinutes

Duration between 15 and 240 minutes at increments of 15 that determines how long to book anavailable room when a meeting is started with Alexa.

Type: Integer

Required: YesEnabled

Whether instant booking is enabled or not.

Type: Boolean

Required: Yes




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/CreateInstantBooking

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/CreateInstantBooking

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/CreateInstantBooking

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/CreateInstantBooking

Alexa For Business Alexa for Business APICreateMeetingRoomConfiguration

CreateMeetingRoomConfigurationCreates meeting room settings of a room profile.

ContentsEndOfMeetingReminder

Creates settings for the end of meeting reminder feature that are applied to a room profile. The endof meeting reminder enables Alexa to remind users when a meeting is ending.

Type: CreateEndOfMeetingReminder (p. 238) object

Required: NoInstantBooking

Settings to automatically book a room for a configured duration if it's free when joining a meetingwith Alexa.

Type: CreateInstantBooking (p. 239) object

Required: NoRequireCheckIn

Settings for requiring a check in when a room is reserved. Alexa can cancel a room reservation if it'snot checked into to make the room available for others. Users can check in by joining the meetingwith Alexa or an AVS device, or by saying “Alexa, check in.”

Type: CreateRequireCheckIn (p. 241) object

Required: NoRoomUtilizationMetricsEnabled

Whether room utilization metrics are enabled or not.

Type: Boolean

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/CreateMeetingRoomConfiguration

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/CreateMeetingRoomConfiguration

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/CreateMeetingRoomConfiguration

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/CreateMeetingRoomConfiguration

Alexa For Business Alexa for Business APICreateRequireCheckIn

CreateRequireCheckInCreates settings for the require check in feature that are applied to a room profile. Require check inallows a meeting room’s Alexa or AVS device to prompt the user to check in; otherwise, the room will bereleased.

ContentsEnabled

Whether require check in is enabled or not.

Type: Boolean

Required: YesReleaseAfterMinutes

Duration between 5 and 20 minutes to determine when to release the room if it's not checked into.

Type: Integer

Required: Yes




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/CreateRequireCheckIn

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/CreateRequireCheckIn

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/CreateRequireCheckIn

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/CreateRequireCheckIn

Alexa For Business Alexa for Business APIDeveloperInfo

DeveloperInfoThe details about the developer that published the skill.

ContentsDeveloperName

The name of the developer.

Type: String

Required: NoEmail

The email of the developer.

Type: String



Required: NoPrivacyPolicy

The URL of the privacy policy.

Type: String

Required: NoUrl

The website of the developer.

Type: String

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/DeveloperInfo

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/DeveloperInfo

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/DeveloperInfo

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/DeveloperInfo

Alexa For Business Alexa for Business APIDevice

DeviceA device with attributes.

ContentsDeviceArn


Type: String


Required: NoDeviceName

The name of a device.

Type: String



Required: NoDeviceSerialNumber

The serial number of a device.

Type: String


Required: NoDeviceStatus

The status of a device. If the status is not READY, check the DeviceStatusInfo value for details.

Type: String

Valid Values: READY | PENDING | WAS_OFFLINE | DEREGISTERED | FAILED

Required: NoDeviceStatusInfo

Detailed information about a device's status.

Type: DeviceStatusInfo (p. 251) object

Required: NoDeviceType

The type of a device.

Type: String




Required: NoMacAddress

The MAC address of a device.

Type: String

Required: NoNetworkProfileInfo


Type: DeviceNetworkProfileInfo (p. 249) object

Required: NoRoomArn

The room ARN of a device.

Type: String


Required: NoSoftwareVersion

The software version of a device.

Type: String

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/Device

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/Device

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/Device

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/Device

Alexa For Business Alexa for Business APIDeviceData

DeviceDataDevice attributes.

ContentsCreatedTime

The time (in epoch) when the device data was created.

Type: Timestamp

Required: NoDeviceArn


Type: String


Required: NoDeviceName

The name of a device.

Type: String



Required: NoDeviceSerialNumber

The serial number of a device.

Type: String


Required: NoDeviceStatus

The status of a device.

Type: String

Valid Values: READY | PENDING | WAS_OFFLINE | DEREGISTERED | FAILED

Required: NoDeviceStatusInfo

Detailed information about a device's status.

Type: DeviceStatusInfo (p. 251) object


Alexa For Business Alexa for Business APIContents

Required: NoDeviceType

The type of a device.

Type: String


Required: NoMacAddress

The MAC address of a device.

Type: String

Required: NoNetworkProfileArn


Type: String


Required: NoNetworkProfileName


Type: String



Required: NoRoomArn

The room ARN associated with a device.

Type: String


Required: NoRoomName

The name of the room associated with a device.

Type: String






The software version of a device.

Type: String

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/DeviceData

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/DeviceData

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/DeviceData

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/DeviceData

Alexa For Business Alexa for Business APIDeviceEvent

DeviceEventThe list of device events.

ContentsTimestamp

The time (in epoch) when the event occurred.

Type: Timestamp

Required: NoType

The type of device event.

Type: String

Valid Values: CONNECTION_STATUS | DEVICE_STATUS

Required: NoValue

The value of the event.

Type: String

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/DeviceEvent

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/DeviceEvent

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/DeviceEvent

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/DeviceEvent

Alexa For Business Alexa for Business APIDeviceNetworkProfileInfo

DeviceNetworkProfileInfoDetailed information about a device's network profile.

ContentsCertificateArn

The ARN of the certificate associated with a device.

Type: String


Required: NoCertificateExpirationTime

The time (in epoch) when the certificate expires.

Type: Timestamp



Type: String


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/DeviceNetworkProfileInfo

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/DeviceNetworkProfileInfo

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/DeviceNetworkProfileInfo

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/DeviceNetworkProfileInfo

Alexa For Business Alexa for Business APIDeviceStatusDetail

DeviceStatusDetailDetails of a device’s status.

ContentsCode

The device status detail code.

Type: String

Valid Values: DEVICE_SOFTWARE_UPDATE_NEEDED | DEVICE_WAS_OFFLINE |CREDENTIALS_ACCESS_FAILURE | TLS_VERSION_MISMATCH | ASSOCIATION_REJECTION| AUTHENTICATION_FAILURE | DHCP_FAILURE | INTERNET_UNAVAILABLE |DNS_FAILURE | UNKNOWN_FAILURE | CERTIFICATE_ISSUING_LIMIT_EXCEEDED| INVALID_CERTIFICATE_AUTHORITY | NETWORK_PROFILE_NOT_FOUND |INVALID_PASSWORD_STATE | PASSWORD_NOT_FOUND | PASSWORD_MANAGER_ACCESS_DENIED| CERTIFICATE_AUTHORITY_ACCESS_DENIED

Required: NoFeature

The list of available features on the device.

Type: String

Valid Values: BLUETOOTH | VOLUME | NOTIFICATIONS | LISTS | SKILLS |NETWORK_PROFILE | SETTINGS | ALL

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/DeviceStatusDetail

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/DeviceStatusDetail

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/DeviceStatusDetail

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/DeviceStatusDetail

Alexa For Business Alexa for Business APIDeviceStatusInfo

DeviceStatusInfoDetailed information about a device's status.

ContentsConnectionStatus

The latest available information about the connection status of a device.

Type: String

Valid Values: ONLINE | OFFLINE

Required: NoConnectionStatusUpdatedTime

The time (in epoch) when the device connection status changed.

Type: Timestamp

Required: NoDeviceStatusDetails

One or more device status detail descriptions.

Type: Array of DeviceStatusDetail (p. 250) objects

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/DeviceStatusInfo

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/DeviceStatusInfo

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/DeviceStatusInfo

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/DeviceStatusInfo

Alexa For Business Alexa for Business APIEndOfMeetingReminder

EndOfMeetingReminderSettings for the end of meeting reminder feature that are applied to a room profile. The end of meetingreminder enables Alexa to remind users when a meeting is ending.

ContentsEnabled


Type: Boolean

Required: NoReminderAtMinutes

A range of 3 to 15 minutes that determines when the reminder begins.



Required: NoReminderType


Type: String


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/EndOfMeetingReminder

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/EndOfMeetingReminder

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/EndOfMeetingReminder

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/EndOfMeetingReminder

Alexa For Business Alexa for Business APIFilter

FilterA filter name and value pair that is used to return a more specific list of results. Filters can be used tomatch a set of resources by various criteria.

ContentsKey

The key of a filter.

Type: String


Required: YesValues

The values of a filter.




Required: Yes




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/Filter

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/Filter

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/Filter

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/Filter

Alexa For Business Alexa for Business APIGateway

GatewayThe details of the gateway.

ContentsArn

The ARN of the gateway.

Type: String



The description of the gateway.

Type: String



Required: NoGatewayGroupArn

The ARN of the gateway group that the gateway is associated to.

Type: String


Required: NoName

The name of the gateway.

Type: String




The software version of the gateway. The gateway automatically updates its software version duringnormal operation.

Type: String




Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/Gateway

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/Gateway

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/Gateway

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/Gateway

Alexa For Business Alexa for Business APIGatewayGroup

GatewayGroupThe details of the gateway group.

ContentsArn

The ARN of the gateway group.

Type: String




Type: String


Required: NoName


Type: String



Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/GatewayGroup

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/GatewayGroup

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/GatewayGroup

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/GatewayGroup

Alexa For Business Alexa for Business APIGatewayGroupSummary

GatewayGroupSummaryThe summary of a gateway group.

ContentsArn

The ARN of the gateway group.

Type: String




Type: String


Required: NoName


Type: String



Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/GatewayGroupSummary

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/GatewayGroupSummary

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/GatewayGroupSummary

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/GatewayGroupSummary

Alexa For Business Alexa for Business APIGatewaySummary

GatewaySummaryThe summary of a gateway.

ContentsArn

The ARN of the gateway.

Type: String



The description of the gateway.

Type: String



Required: NoGatewayGroupArn

The ARN of the gateway group that the gateway is associated to.

Type: String


Required: NoName

The name of the gateway.

Type: String




The software version of the gateway. The gateway automatically updates its software version duringnormal operation.

Type: String




Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/GatewaySummary

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/GatewaySummary

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/GatewaySummary

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/GatewaySummary

Alexa For Business Alexa for Business APIInstantBooking

InstantBookingSettings for the instant booking feature that are applied to a room profile. When users start theirmeeting with Alexa, Alexa automatically books the room for the configured duration if the room isavailable.



Type: Integer

Required: NoEnabled


Type: Boolean

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/InstantBooking

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/InstantBooking

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/InstantBooking

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/InstantBooking

Alexa For Business Alexa for Business APIIPDialIn

IPDialInThe IP endpoint and protocol for calling.

ContentsCommsProtocol

The protocol, including SIP, SIPS, and H323.

Type: String

Valid Values: SIP | SIPS | H323

Required: YesEndpoint

The IP address.

Type: String


Required: Yes




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/IPDialIn

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/IPDialIn

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/IPDialIn

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/IPDialIn

Alexa For Business Alexa for Business APIMeetingRoomConfiguration

MeetingRoomConfigurationMeeting room settings of a room profile.


Settings for the end of meeting reminder feature that are applied to a room profile. The end ofmeeting reminder enables Alexa to remind users when a meeting is ending.

Type: EndOfMeetingReminder (p. 252) object


Settings to automatically book the room if available for a configured duration when joining ameeting with Alexa.

Type: InstantBooking (p. 260) object


Settings for requiring a check in when a room is reserved. Alexa can cancel a room reservation ifit's not checked into. This makes the room available for others. Users can check in by joining themeeting with Alexa or an AVS device, or by saying “Alexa, check in.”

Type: RequireCheckIn (p. 277) object



Type: Boolean

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/MeetingRoomConfiguration

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/MeetingRoomConfiguration

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/MeetingRoomConfiguration

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/MeetingRoomConfiguration

Alexa For Business Alexa for Business APIMeetingSetting

MeetingSettingThe values that indicate whether a pin is always required (YES), never required (NO), or OPTIONAL.

• If YES, Alexa will always ask for a meeting pin.• If NO, Alexa will never ask for a meeting pin.• If OPTIONAL, Alexa will ask if you have a meeting pin and if the customer responds with yes, it will ask

for the meeting pin.

ContentsRequirePin

The values that indicate whether the pin is always required.

Type: String

Valid Values: YES | NO | OPTIONAL

Required: Yes




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/MeetingSetting

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/MeetingSetting

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/MeetingSetting

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/MeetingSetting

Alexa For Business Alexa for Business APINetworkProfile

NetworkProfileThe network profile associated with a device.

ContentsCertificateAuthorityArn


Type: String


Required: NoCurrentPassword


Type: String





Type: String



Required: NoEapMethod


Type: String




Type: String


Required: No



NetworkProfileName


Type: String



Required: NoNextPassword


Type: String


Pattern: (^$)|([\x00-\x7F]{5,})

Required: NoSecurityType


Type: String


Required: NoSsid


Type: String



Required: NoTrustAnchors

The root certificates of your authentication server, which is installed on your devices and used totrust your authentication server during EAP negotiation.




Required: No






https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/NetworkProfile

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/NetworkProfile

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/NetworkProfile

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/NetworkProfile

Alexa For Business Alexa for Business APINetworkProfileData

NetworkProfileDataThe data associated with a network profile.

ContentsCertificateAuthorityArn


Type: String




Type: String



Required: NoEapMethod


Type: String




Type: String


Required: NoNetworkProfileName


Type: String





Required: NoSecurityType


Type: String


Required: NoSsid


Type: String



Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/NetworkProfileData

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/NetworkProfileData

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/NetworkProfileData

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/NetworkProfileData

Alexa For Business Alexa for Business APIPhoneNumber

PhoneNumberThe phone number for the contact containing the raw number and phone number type.

ContentsNumber

The raw value of the phone number.

Type: String


Pattern: ^[\+0-9\#\,$][\+0-9\-\.\/\($\,\#\s]+$

Required: YesType

The type of the phone number.

Type: String

Valid Values: MOBILE | WORK | HOME

Required: Yes




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/PhoneNumber

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/PhoneNumber

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/PhoneNumber

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/PhoneNumber

Alexa For Business Alexa for Business APIProfile

ProfileA room profile with attributes.

ContentsAddress

The address of a room profile.

Type: String


Required: NoAddressBookArn


Type: String


Required: NoDistanceUnit

The distance unit of a room profile.

Type: String


Required: NoIsDefault

Retrieves if the profile is default or not.

Type: Boolean

Required: NoLocale

The locale of a room profile. (This is currently available only to a limited preview audience.)

Type: String


Required: NoMaxVolumeLimit

The max volume limit of a room profile.

Type: Integer

Required: No



MeetingRoomConfiguration

Meeting room settings of a room profile.

Type: MeetingRoomConfiguration (p. 262) object

Required: NoProfileArn

The ARN of a room profile.

Type: String


Required: NoProfileName


Type: String



Required: NoPSTNEnabled

The PSTN setting of a room profile.

Type: Boolean

Required: NoSetupModeDisabled

The setup mode of a room profile.

Type: Boolean

Required: NoTemperatureUnit

The temperature unit of a room profile.

Type: String


Required: NoTimezone

The time zone of a room profile.

Type: String


Required: No



WakeWord

The wake word of a room profile.

Type: String


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/Profile

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/Profile

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/Profile

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/Profile

Alexa For Business Alexa for Business APIProfileData

ProfileDataThe data of a room profile.

ContentsAddress

The address of a room profile.

Type: String


Required: NoDistanceUnit

The distance unit of a room profile.

Type: String


Required: NoIsDefault

Retrieves if the profile data is default or not.

Type: Boolean

Required: NoLocale

The locale of a room profile. (This is currently available only to a limited preview audience.)

Type: String



The ARN of a room profile.

Type: String




Type: String





Required: NoTemperatureUnit

The temperature unit of a room profile.

Type: String


Required: NoTimezone

The time zone of a room profile.

Type: String


Required: NoWakeWord

The wake word of a room profile.

Type: String


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/ProfileData

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/ProfileData

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/ProfileData

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/ProfileData

Alexa For Business Alexa for Business APIPSTNDialIn

PSTNDialInThe information for public switched telephone network (PSTN) conferencing.

ContentsCountryCode

The zip code.

Type: String

Pattern: \d{1,3}

Required: YesOneClickIdDelay

The delay duration before Alexa enters the conference ID with dual-tone multi-frequency (DTMF).Each number on the dial pad corresponds to a DTMF tone, which is how we send data over thetelephone network.

Type: String


Required: YesOneClickPinDelay

The delay duration before Alexa enters the conference pin with dual-tone multi-frequency (DTMF).Each number on the dial pad corresponds to a DTMF tone, which is how we send data over thetelephone network.

Type: String


Required: YesPhoneNumber

The phone number to call to join the conference.

Type: String

Pattern: \d{10}

Required: Yes




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/PSTNDialIn

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/PSTNDialIn

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/PSTNDialIn

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/PSTNDialIn

Alexa For Business Alexa for Business APIRequireCheckIn

RequireCheckInSettings for the require check in feature that are applied to a room profile. Require check in allows ameeting room’s Alexa or AVS device to prompt the user to check in; otherwise, the room will be released.

ContentsEnabled


Type: Boolean

Required: NoReleaseAfterMinutes


Type: Integer

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/RequireCheckIn

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/RequireCheckIn

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/RequireCheckIn

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/RequireCheckIn

Alexa For Business Alexa for Business APIRoom

RoomA room with attributes.

ContentsDescription

The description of a room.

Type: String




The profile ARN of a room.

Type: String


Required: NoProviderCalendarId

The provider calendar ARN of a room.

Type: String


Required: NoRoomArn

The ARN of a room.

Type: String


Required: NoRoomName

The name of a room.

Type: String



Required: No






https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/Room

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/Room

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/Room

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/Room

Alexa For Business Alexa for Business APIRoomData

RoomDataThe data of a room.

ContentsDescription

The description of a room.

Type: String




The profile ARN of a room.

Type: String



The profile name of a room.

Type: String



Required: NoProviderCalendarId

The provider calendar ARN of a room.

Type: String


Required: NoRoomArn

The ARN of a room.

Type: String


Required: No



RoomName

The name of a room.

Type: String



Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/RoomData

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/RoomData

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/RoomData

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/RoomData

Alexa For Business Alexa for Business APIRoomSkillParameter

RoomSkillParameterA skill parameter associated with a room.

ContentsParameterKey

The parameter key of a room skill parameter. ParameterKey is an enumerated type that only takes“DEFAULT” or “SCOPE” as valid values.

Type: String


Required: YesParameterValue

The parameter value of a room skill parameter.

Type: String


Required: Yes




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/RoomSkillParameter

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/RoomSkillParameter

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/RoomSkillParameter

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/RoomSkillParameter

Alexa For Business Alexa for Business APISipAddress

SipAddressThe SIP address for the contact containing the URI and SIP address type.

ContentsType

The type of the SIP address.

Type: String

Valid Values: WORK

Required: YesUri

The URI for the SIP address.

Type: String


Pattern: ^sip[s]?:([^@:]+)\@([^@]+)$

Required: Yes




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/SipAddress

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/SipAddress

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/SipAddress

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/SipAddress

Alexa For Business Alexa for Business APISkillDetails

SkillDetailsGranular information about the skill.

ContentsBulletPoints

The details about what the skill supports organized as bullet points.


Required: NoDeveloperInfo

The details about the developer that published the skill.

Type: DeveloperInfo (p. 242) object

Required: NoEndUserLicenseAgreement

The URL of the end user license agreement.

Type: String

Required: NoGenericKeywords

The generic keywords associated with the skill that can be used to find a skill.


Required: NoInvocationPhrase

The phrase used to trigger the skill.

Type: String

Required: NoNewInThisVersionBulletPoints

The updates added in bullet points.


Required: NoProductDescription

The description of the product.

Type: String

Required: NoReleaseDate

The date when the skill was released.



Type: String

Required: NoReviews

This member has been deprecated.

The list of reviews for the skill, including Key and Value pair.

Type: String to string map

Required: NoSkillTypes

The types of skills.


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/SkillDetails

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/SkillDetails

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/SkillDetails

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/SkillDetails

Alexa For Business Alexa for Business APISkillGroup

SkillGroupA skill group with attributes.

ContentsDescription

The description of a skill group.

Type: String



Required: NoSkillGroupArn

The ARN of a skill group.

Type: String


Required: NoSkillGroupName

The name of a skill group.

Type: String



Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/SkillGroup

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/SkillGroup

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/SkillGroup

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/SkillGroup

Alexa For Business Alexa for Business APISkillGroupData

SkillGroupDataThe attributes of a skill group.

ContentsDescription

The description of a skill group.

Type: String



Required: NoSkillGroupArn

The skill group ARN of a skill group.

Type: String


Required: NoSkillGroupName

The skill group name of a skill group.

Type: String



Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/SkillGroupData

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/SkillGroupData

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/SkillGroupData

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/SkillGroupData

Alexa For Business Alexa for Business APISkillsStoreSkill

SkillsStoreSkillThe detailed information about an Alexa skill.

ContentsIconUrl

The URL where the skill icon resides.

Type: String

Required: NoSampleUtterances

Sample utterances that interact with the skill.


Required: NoShortDescription

Short description about the skill.

Type: String

Required: NoSkillDetails

Information about the skill.

Type: SkillDetails (p. 284) object

Required: NoSkillId

The ARN of the skill.

Type: String


Required: NoSkillName

The name of the skill.

Type: String



Required: NoSupportsLinking

Linking support for a skill.



Type: Boolean

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/SkillsStoreSkill

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/SkillsStoreSkill

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/SkillsStoreSkill

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/SkillsStoreSkill

Alexa For Business Alexa for Business APISkillSummary

SkillSummaryThe summary of skills.

ContentsEnablementType

Whether the skill is enabled under the user's account, or if it requires linking to be used.

Type: String

Valid Values: ENABLED | PENDING

Required: NoSkillId

The ARN of the skill summary.

Type: String


Required: NoSkillName

The name of the skill.

Type: String



Required: NoSkillType

Whether the skill is publicly available or is a private skill.

Type: String



Valid Values: PUBLIC | PRIVATE

Required: NoSupportsLinking

Linking support for a skill.

Type: Boolean

Required: No






https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/SkillSummary

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/SkillSummary

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/SkillSummary

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/SkillSummary

Alexa For Business Alexa for Business APISmartHomeAppliance

SmartHomeApplianceA smart home appliance that can connect to a central system. Any domestic device can be a smartappliance.

ContentsDescription

The description of the smart home appliance.

Type: String

Required: NoFriendlyName

The friendly name of the smart home appliance.

Type: String

Required: NoManufacturerName

The name of the manufacturer of the smart home appliance.

Type: String

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/SmartHomeAppliance

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/SmartHomeAppliance

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/SmartHomeAppliance

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/SmartHomeAppliance

Alexa For Business Alexa for Business APISort

SortAn object representing a sort criteria.

ContentsKey

The sort key of a sort object.

Type: String


Required: YesValue

The sort value of a sort object.

Type: String

Valid Values: ASC | DESC

Required: Yes




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/Sort

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/Sort

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/Sort

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/Sort

Alexa For Business Alexa for Business APISsml

SsmlThe SSML message. For more information, see SSML Reference.

ContentsLocale

The locale of the SSML message. Currently, en-US is supported.

Type: String

Valid Values: en-US

Required: YesValue

The value of the SSML message in the correct SSML format. The audio tag is not supported.

Type: String



Required: Yes




https://developer.amazon.com/docs/custom-skills/speech-synthesis-markup-language-ssml-reference.html

https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/Ssml

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/Ssml

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/Ssml

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/Ssml

Alexa For Business Alexa for Business APITag

TagA key-value pair that can be associated with a resource.

ContentsKey

The key of a tag. Tag keys are case-sensitive.

Type: String


Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

Required: YesValue

The value of a tag. Tag values are case sensitive and can be null.

Type: String


Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

Required: Yes




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/Tag

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/Tag

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/Tag

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/Tag

Alexa For Business Alexa for Business APIText

TextThe text message.

ContentsLocale

The locale of the text message. Currently, en-US is supported.

Type: String

Valid Values: en-US

Required: YesValue

The value of the text message.

Type: String



Required: Yes




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/Text

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/Text

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/Text

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/Text

Alexa For Business Alexa for Business APIUpdateEndOfMeetingReminder

UpdateEndOfMeetingReminderSettings for the end of meeting reminder feature that are applied to a room profile. The end of meetingreminder enables Alexa to remind users when a meeting is ending.

ContentsEnabled


Type: Boolean

Required: NoReminderAtMinutes

Updates settings for the end of meeting reminder feature that are applied to a room profile. The endof meeting reminder enables Alexa to remind users when a meeting is ending.



Required: NoReminderType


Type: String


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/UpdateEndOfMeetingReminder

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/UpdateEndOfMeetingReminder

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/UpdateEndOfMeetingReminder

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/UpdateEndOfMeetingReminder

Alexa For Business Alexa for Business APIUpdateInstantBooking

UpdateInstantBookingUpdates settings for the instant booking feature that are applied to a room profile. If instant booking isenabled, Alexa automatically reserves a room if it is free when a user joins a meeting with Alexa.



Type: Integer

Required: NoEnabled


Type: Boolean

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/UpdateInstantBooking

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/UpdateInstantBooking

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/UpdateInstantBooking

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/UpdateInstantBooking

Alexa For Business Alexa for Business APIUpdateMeetingRoomConfiguration

UpdateMeetingRoomConfigurationUpdates meeting room settings of a room profile.


Settings for the end of meeting reminder feature that are applied to a room profile. The end ofmeeting reminder enables Alexa to remind users when a meeting is ending.

Type: UpdateEndOfMeetingReminder (p. 297) object


Settings to automatically book an available room available for a configured duration when joining ameeting with Alexa.

Type: UpdateInstantBooking (p. 298) object


Settings for requiring a check in when a room is reserved. Alexa can cancel a room reservation if it'snot checked into to make the room available for others. Users can check in by joining the meetingwith Alexa or an AVS device, or by saying “Alexa, check in.”

Type: UpdateRequireCheckIn (p. 300) object



Type: Boolean

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/UpdateMeetingRoomConfiguration

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/UpdateMeetingRoomConfiguration

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/UpdateMeetingRoomConfiguration

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/UpdateMeetingRoomConfiguration

Alexa For Business Alexa for Business APIUpdateRequireCheckIn

UpdateRequireCheckInUpdates settings for the require check in feature that are applied to a room profile. Require check inallows a meeting room’s Alexa or AVS device to prompt the user to check in; otherwise, the room will bereleased.

ContentsEnabled


Type: Boolean

Required: NoReleaseAfterMinutes


Type: Integer

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/UpdateRequireCheckIn

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/UpdateRequireCheckIn

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/UpdateRequireCheckIn

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/UpdateRequireCheckIn

Alexa For Business Alexa for Business APIUserData

UserDataInformation related to a user.

ContentsEmail

The email of a user.

Type: String



Required: NoEnrollmentId

The enrollment ARN of a user.

Type: String


Required: NoEnrollmentStatus

The enrollment status of a user.

Type: String

Valid Values: INITIALIZED | PENDING | REGISTERED | DISASSOCIATING |DEREGISTERING


The first name of a user.

Type: String




The last name of a user.

Type: String



Required: No



UserArn

The ARN of a user.

Type: String


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/alexaforbusiness-2017-11-09/UserData

https://docs.aws.amazon.com/goto/SdkForGoV1/alexaforbusiness-2017-11-09/UserData

https://docs.aws.amazon.com/goto/SdkForJava/alexaforbusiness-2017-11-09/UserData

https://docs.aws.amazon.com/goto/SdkForRubyV3/alexaforbusiness-2017-11-09/UserData


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.


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


http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html

http://docs.aws.amazon.com/general/latest/gr/sigv4-create-string-to-sign.html


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.


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.


Type: string

Required: Conditional


http://docs.aws.amazon.com/general/latest/gr/sigv4-date-handling.html

http://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html

http://docs.aws.amazon.com/general/latest/gr/sigv4-create-canonical-request.html

http://docs.aws.amazon.com/general/latest/gr/sigv4-create-canonical-request.html


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.




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.



alexa for business - alexa for business api · alexa for business alexa for business api api...

Documents