Data retrieval APIs for Alexa for Business
Alexa for Business provides the following APIs for data retrieval.
| Actions | Description | Access level |
|---|---|---|
| GetAddressBook | Get the address book details by the address book ARN | Read |
| GetConferencePreference | Retrieve the existing conference preferences | Read |
| GetConferenceProvider | Get details about a specific conference provider | Read |
| GetContact | Get the contact details by the contact ARN | Read |
| GetDevice | Get device details | Read |
| GetGateway | Retrieve the details of a gateway | Read |
| GetGatewayGroup | Retrieve the details of a gateway group | Read |
| GetInvitationConfiguration | Retrieve the configured values for the user enrollment invitation email template | Read |
| GetNetworkProfile | Get the network profile details by the network profile ARN | Read |
| GetProfile | Get profile when provided with Profile ARN | Read |
| GetRoom | Get room details | Read |
| GetRoomSkillParameter | Get an existing parameter that has been set for a skill and room | Read |
| GetSkillGroup | Get skill group details with skill group ARN | Read |
| ListBusinessReportSchedules | List the details of the schedules that a user configured | List |
| ListConferenceProviders | List conference providers under a specific AWS account | List |
| ListDeviceEvents | List the device event history, including device connection status, for up to 30 days | List |
| ListGatewayGroups | List gateway group summaries | List |
| ListGateways | List gateway summaries | List |
| ListSkills | List skills | List |
| ListSkillsStoreCategories | List all categories in the Alexa skill store | List |
| ListSkillsStoreSkillsByCategory | List all skills in the Alexa skill store by category | List |
| ListSmartHomeAppliances | List all of the smart home appliances associated with a room | List |
| ListTags | List all tags on a resource | Read |
| ResolveRoom | Resolve room information | Read |
| SearchAddressBooks | Search address books and list the ones that meet a set of filter and sort criteria | List |
| SearchContacts | Search contacts and list the ones that meet a set of filter and sort criteria | List |
| SearchDevices | Search for devices | List |
| SearchNetworkProfiles | Search network profiles and list the ones that meet a set of filter and sort criteria | List |
| SearchProfiles | Search for profiles | List |
| SearchRooms | Search for rooms | List |
| SearchSkillGroups | Search for skill groups | List |
| SearchUsers | Search for users | List |
| StartSmartHomeApplianceDiscovery | Initiate the discovery of any smart home appliances associated with the room | Read |
