Package-level declarations

Types

Link copied to clipboard

An address book with attributes.

Link copied to clipboard

Information related to an address book.

Link copied to clipboard

Base class for all service related exceptions thrown by the AlexaForBusiness client

Link copied to clipboard

The resource being created already exists.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class 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,

Link copied to clipboard

Usage report with specified parameters.

Link copied to clipboard

The content range of the report.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The recurrence of the reports.

Link copied to clipboard

The S3 location of the output reports.

Link copied to clipboard

The schedule of the usage report.

Link copied to clipboard
Link copied to clipboard
class Category

The skill store category that is shown. Alexa skills are assigned a specific skill category during creation, such as News, Social, and Sports.

Link copied to clipboard
sealed class CommsProtocol
Link copied to clipboard

There is a concurrent modification of resources.

Link copied to clipboard

The default conference provider that is used if no other scheduled meetings are detected.

Link copied to clipboard

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.

Link copied to clipboard
Link copied to clipboard
sealed class ConnectionStatus
Link copied to clipboard
class Contact

A contact with attributes.

Link copied to clipboard

Information related to a contact.

Link copied to clipboard
class Content

The content definition. This can contain only one text, SSML, or audio list object.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard

Creates meeting room settings of a room profile.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The details about the developer that published the skill.

Link copied to clipboard
class Device

A device with attributes.

Link copied to clipboard

Device attributes.

Link copied to clipboard

The list of device events.

Link copied to clipboard
sealed class DeviceEventType
Link copied to clipboard

Detailed information about a device's network profile.

Link copied to clipboard

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

Link copied to clipboard
sealed class DeviceStatus
Link copied to clipboard

Details of a device’s status.

Link copied to clipboard
Link copied to clipboard

Detailed information about a device's status.

Link copied to clipboard
sealed class DeviceUsageType
Link copied to clipboard
sealed class DistanceUnit
Link copied to clipboard
sealed class EnablementType
Link copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard
Link copied to clipboard
sealed class EnrollmentStatus
Link copied to clipboard
sealed class Feature
Link copied to clipboard
class 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.

Link copied to clipboard
class Gateway

The details of the gateway.

Link copied to clipboard

The details of the gateway group.

Link copied to clipboard

The summary of a gateway group.

Link copied to clipboard

The summary of a gateway.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

The device is in an invalid state.

Link copied to clipboard

A password in SecretsManager is in an invalid state.

Link copied to clipboard

The service linked role is locked for deletion.

Link copied to clipboard

The attempt to update a user is invalid due to the user's current status.

Link copied to clipboard
class IpDialIn

The IP endpoint and protocol for calling.

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed class Locale
Link copied to clipboard

Meeting room settings of a room profile.

Link copied to clipboard

The values that indicate whether a pin is always required (YES), never required (NO), or OPTIONAL.

Link copied to clipboard

The name sent in the request is already in use.

Link copied to clipboard
sealed class NetworkEapMethod
Link copied to clipboard

The network profile associated with a device.

Link copied to clipboard

The data associated with a network profile.

Link copied to clipboard
sealed class NetworkSecurityType
Link copied to clipboard

The resource is not found.

Link copied to clipboard

The phone number for the contact containing the raw number and phone number type.

Link copied to clipboard
sealed class PhoneNumberType
Link copied to clipboard
Link copied to clipboard
class Profile

A room profile with attributes.

Link copied to clipboard

The data of a room profile.

Link copied to clipboard

The information for public switched telephone network (PSTN) conferencing.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard
sealed class RequirePin
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Another resource is associated with the resource in the request.

Link copied to clipboard

The resource in the request is already in use.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class Room

A room with attributes.

Link copied to clipboard
class RoomData

The data of a room.

Link copied to clipboard

A skill parameter associated with a room.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The SIP address for the contact containing the URI and SIP address type.

Link copied to clipboard
sealed class SipType
Link copied to clipboard

Granular information about the skill.

Link copied to clipboard

A skill group with attributes.

Link copied to clipboard

The attributes of a skill group.

Link copied to clipboard

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

Link copied to clipboard

The detailed information about an Alexa skill.

Link copied to clipboard

The summary of skills.

Link copied to clipboard
sealed class SkillType
Link copied to clipboard
sealed class SkillTypeFilter
Link copied to clipboard

A smart home appliance that can connect to a central system. Any domestic device can be a smart appliance.

Link copied to clipboard
class Sort

An object representing a sort criteria.

Link copied to clipboard
sealed class SortValue
Link copied to clipboard
class Ssml

The SSML message. For more information, see SSML Reference.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class Tag

A key-value pair that can be associated with a resource.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed class TemperatureUnit
Link copied to clipboard
class Text

The text message.

Link copied to clipboard

The caller has no permissions to operate on the resource involved in the API call.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard

Updates meeting room settings of a room profile.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class UserData

Information related to a user.

Link copied to clipboard
sealed class WakeWord