alexaforbusiness-2017-11-09 library

Classes

AddressBook
An address book with attributes.
AddressBookData
Information related to an address book.
AlexaForBusiness
Alexa for Business helps you use Alexa in your organization. Alexa for Business provides you with the tools to manage Alexa devices, enroll your users, and assign skills, at scale. You can build your own context-aware voice skills using the Alexa Skills Kit and the Alexa for Business API operations. You can also make these available as private skills for your organization. Alexa for Business makes it efficient to voice-enable your products and services, thus providing context-aware voice experiences for your customers. Device makers building with the Alexa Voice Service (AVS) can create fully integrated solutions, register their products with Alexa for Business, and manage them as shared devices in their organization.
ApproveSkillResponse
AssociateContactWithAddressBookResponse
AssociateDeviceWithNetworkProfileResponse
AssociateDeviceWithRoomResponse
AssociateSkillGroupWithRoomResponse
AssociateSkillWithSkillGroupResponse
AssociateSkillWithUsersResponse
Audio
The 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, [...]
AwsClientCredentials
AWS credentials.
BusinessReport
Usage report with specified parameters.
BusinessReportContentRange
The content range of the report.
BusinessReportRecurrence
The recurrence of the reports.
BusinessReportS3Location
The S3 location of the output reports.
BusinessReportSchedule
The schedule of the usage report.
Category
The skill store category that is shown. Alexa skills are assigned a specific skill category during creation, such as News, Social, and Sports.
ConferencePreference
The default conference provider that is used if no other scheduled meetings are detected.
ConferenceProvider
An entity that provides a conferencing solution. Alexa for Business acts as the voice interface and mediator that connects users to their preferred conference provider. Examples of conference providers include Amazon Chime, Zoom, Cisco, and Polycom.
Contact
A contact with attributes.
ContactData
Information related to a contact.
Content
The content definition. This can contain only one text, SSML, or audio list object.
CreateAddressBookResponse
CreateBusinessReportScheduleResponse
CreateConferenceProviderResponse
CreateContactResponse
CreateEndOfMeetingReminder
Creates settings for the end of meeting reminder feature that are applied to a room profile. The end of meeting reminder enables Alexa to remind users when a meeting is ending.
CreateGatewayGroupResponse
CreateInstantBooking
Creates settings for the instant booking feature that are applied to a room profile. When users start their meeting with Alexa, Alexa automatically books the room for the configured duration if the room is available.
CreateMeetingRoomConfiguration
Creates meeting room settings of a room profile.
CreateNetworkProfileResponse
CreateProfileResponse
CreateRequireCheckIn
Creates settings for the require check in feature that are applied to a room profile. Require check in allows a meeting room’s Alexa or AVS device to prompt the user to check in; otherwise, the room will be released.
CreateRoomResponse
CreateSkillGroupResponse
CreateUserResponse
DeleteAddressBookResponse
DeleteBusinessReportScheduleResponse
DeleteConferenceProviderResponse
DeleteContactResponse
DeleteDeviceResponse
DeleteDeviceUsageDataResponse
DeleteGatewayGroupResponse
DeleteNetworkProfileResponse
DeleteProfileResponse
DeleteRoomResponse
DeleteRoomSkillParameterResponse
DeleteSkillAuthorizationResponse
DeleteSkillGroupResponse
DeleteUserResponse
DeveloperInfo
The details about the developer that published the skill.
Device
A device with attributes.
DeviceData
Device attributes.
DeviceEvent
The list of device events.
DeviceNetworkProfileInfo
Detailed information about a device's network profile.
DeviceStatusDetail
Details of a device’s status.
DeviceStatusInfo
Detailed information about a device's status.
DisassociateContactFromAddressBookResponse
DisassociateDeviceFromRoomResponse
DisassociateSkillFromSkillGroupResponse
DisassociateSkillFromUsersResponse
DisassociateSkillGroupFromRoomResponse
EndOfMeetingReminder
Settings for the end of meeting reminder feature that are applied to a room profile. The end of meeting reminder enables Alexa to remind users when a meeting is ending.
Filter
A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria.
ForgetSmartHomeAppliancesResponse
Gateway
The details of the gateway.
GatewayGroup
The details of the gateway group.
GatewayGroupSummary
The summary of a gateway group.
GatewaySummary
The summary of a gateway.
GetAddressBookResponse
GetConferencePreferenceResponse
GetConferenceProviderResponse
GetContactResponse
GetDeviceResponse
GetGatewayGroupResponse
GetGatewayResponse
GetInvitationConfigurationResponse
GetNetworkProfileResponse
GetProfileResponse
GetRoomResponse
GetRoomSkillParameterResponse
GetSkillGroupResponse
InstantBooking
Settings for the instant booking feature that are applied to a room profile. When users start their meeting with Alexa, Alexa automatically books the room for the configured duration if the room is available.
IPDialIn
The IP endpoint and protocol for calling.
ListBusinessReportSchedulesResponse
ListConferenceProvidersResponse
ListDeviceEventsResponse
ListGatewayGroupsResponse
ListGatewaysResponse
ListSkillsResponse
ListSkillsStoreCategoriesResponse
ListSkillsStoreSkillsByCategoryResponse
ListSmartHomeAppliancesResponse
ListTagsResponse
MeetingRoomConfiguration
Meeting room settings of a room profile.
MeetingSetting
The values that indicate whether a pin is always required (YES), never required (NO), or OPTIONAL. [...]
NetworkProfile
The network profile associated with a device.
NetworkProfileData
The data associated with a network profile.
PhoneNumber
The phone number for the contact containing the raw number and phone number type.
Profile
A room profile with attributes.
ProfileData
The data of a room profile.
PSTNDialIn
The information for public switched telephone network (PSTN) conferencing.
PutConferencePreferenceResponse
PutInvitationConfigurationResponse
PutRoomSkillParameterResponse
PutSkillAuthorizationResponse
RegisterAVSDeviceResponse
RejectSkillResponse
RequireCheckIn
Settings for the require check in feature that are applied to a room profile. Require check in allows a meeting room’s Alexa or AVS device to prompt the user to check in; otherwise, the room will be released.
ResolveRoomResponse
RevokeInvitationResponse
Room
A room with attributes.
RoomData
The data of a room.
RoomSkillParameter
A skill parameter associated with a room.
SearchAddressBooksResponse
SearchContactsResponse
SearchDevicesResponse
SearchNetworkProfilesResponse
SearchProfilesResponse
SearchRoomsResponse
SearchSkillGroupsResponse
SearchUsersResponse
SendAnnouncementResponse
SendInvitationResponse
SipAddress
The SIP address for the contact containing the URI and SIP address type.
SkillDetails
Granular information about the skill.
SkillGroup
A skill group with attributes.
SkillGroupData
The attributes of a skill group.
SkillsStoreSkill
The detailed information about an Alexa skill.
SkillSummary
The summary of skills.
SmartHomeAppliance
A smart home appliance that can connect to a central system. Any domestic device can be a smart appliance.
Sort
An object representing a sort criteria.
Ssml
The SSML message. For more information, see SSML Reference.
StartDeviceSyncResponse
StartSmartHomeApplianceDiscoveryResponse
Tag
A key-value pair that can be associated with a resource.
TagResourceResponse
Text
The text message.
UntagResourceResponse
UpdateAddressBookResponse
UpdateBusinessReportScheduleResponse
UpdateConferenceProviderResponse
UpdateContactResponse
UpdateDeviceResponse
UpdateEndOfMeetingReminder
Settings for the end of meeting reminder feature that are applied to a room profile. The end of meeting reminder enables Alexa to remind users when a meeting is ending.
UpdateGatewayGroupResponse
UpdateGatewayResponse
UpdateInstantBooking
Updates settings for the instant booking feature that are applied to a room profile. If instant booking is enabled, Alexa automatically reserves a room if it is free when a user joins a meeting with Alexa.
UpdateMeetingRoomConfiguration
Updates meeting room settings of a room profile.
UpdateNetworkProfileResponse
UpdateProfileResponse
UpdateRequireCheckIn
Updates settings for the require check in feature that are applied to a room profile. Require check in allows a meeting room’s Alexa or AVS device to prompt the user to check in; otherwise, the room will be released.
UpdateRoomResponse
UpdateSkillGroupResponse
UserData
Information related to a user.

Enums

BusinessReportFailureCode
BusinessReportFormat
BusinessReportInterval
BusinessReportStatus
CommsProtocol
ConferenceProviderType
ConnectionStatus
DeviceEventType
DeviceStatus
DeviceStatusDetailCode
DeviceUsageType
DistanceUnit
EnablementType
EnablementTypeFilter
EndOfMeetingReminderType
EnrollmentStatus
Feature
Locale
NetworkEapMethod
NetworkSecurityType
PhoneNumberType
RequirePin
SipType
SkillType
SkillTypeFilter
SortValue
TemperatureUnit
WakeWord

Exceptions / Errors

AlreadyExistsException
ConcurrentModificationException
DeviceNotRegisteredException
InvalidCertificateAuthorityException
InvalidDeviceException
InvalidSecretsManagerResourceException
InvalidServiceLinkedRoleStateException
InvalidUserStatusException
LimitExceededException
NameInUseException
NotFoundException
ResourceAssociatedException
ResourceInUseException
SkillNotLinkedException
UnauthorizedException