Module aws_sdk_alexaforbusiness::types

Data structures used by operation inputs/outputs.

Modules

• builders
  Builders
• error
  Error types that Alexa For Business can respond with.

Structs

• AddressBook

  An address book with attributes.

• AddressBookData

  Information related to an address book.

• 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,

• 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.

• 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.

• 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.

• CreateProactiveJoin
• 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.

• 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.

• 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.

• 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.

• 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.

• 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.

• ProactiveJoin
• Profile

  A room profile with attributes.

• ProfileData

  The data of a room profile.

• PstnDialIn

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

• 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.

• Room

  A room with attributes.

• RoomData

  The data of a room.

• RoomSkillParameter

  A skill parameter associated with a room.

• 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.

• SkillSummary

  The summary of skills.

• SkillsStoreSkill

  The detailed information about an Alexa skill.

• 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.

• Tag

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

• Text

  The text message.

• 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.

• 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.

• UpdateProactiveJoin
• 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.

• UserData

  Information related to a user.

Enums

• BusinessReportFailureCode
  When writing a match expression against BusinessReportFailureCode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• BusinessReportFormat
  When writing a match expression against BusinessReportFormat, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• BusinessReportInterval
  When writing a match expression against BusinessReportInterval, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• BusinessReportStatus
  When writing a match expression against BusinessReportStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• CommsProtocol
  When writing a match expression against CommsProtocol, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• ConferenceProviderType
  When writing a match expression against ConferenceProviderType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• ConnectionStatus
  When writing a match expression against ConnectionStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• DeviceEventType
  When writing a match expression against DeviceEventType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• DeviceStatus
  When writing a match expression against DeviceStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• DeviceStatusDetailCode
  When writing a match expression against DeviceStatusDetailCode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• DeviceUsageType
  When writing a match expression against DeviceUsageType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• DistanceUnit
  When writing a match expression against DistanceUnit, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• EnablementType
  When writing a match expression against EnablementType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• EnablementTypeFilter
  When writing a match expression against EnablementTypeFilter, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• EndOfMeetingReminderType
  When writing a match expression against EndOfMeetingReminderType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• EnrollmentStatus
  When writing a match expression against EnrollmentStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• Feature
  When writing a match expression against Feature, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• Locale
  When writing a match expression against Locale, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• NetworkEapMethod
  When writing a match expression against NetworkEapMethod, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• NetworkSecurityType
  When writing a match expression against NetworkSecurityType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• PhoneNumberType
  When writing a match expression against PhoneNumberType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• RequirePin
  When writing a match expression against RequirePin, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• SipType
  When writing a match expression against SipType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• SkillType
  When writing a match expression against SkillType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• SkillTypeFilter
  When writing a match expression against SkillTypeFilter, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• SortValue
  When writing a match expression against SortValue, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• TemperatureUnit
  When writing a match expression against TemperatureUnit, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• WakeWord
  When writing a match expression against WakeWord, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.