AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Name | Description | |
---|---|---|
AddressBook |
An address book with attributes. |
|
AddressBookData |
Information related to an address book. |
|
AlexaForBusinessPaginatorFactory |
Paginators for the AlexaForBusiness service |
|
AlreadyExistsException |
The resource being created already exists. |
|
ApproveSkillRequest |
Container for the parameters to the ApproveSkill operation. Associates a skill with the organization under the customer's AWS account. If a skill is private, the user implicitly accepts access to this skill during enablement. |
|
ApproveSkillResponse |
This is the response object from the ApproveSkill operation. |
|
AssociateContactWithAddressBookRequest |
Container for the parameters to the AssociateContactWithAddressBook operation. Associates a contact with a given address book. |
|
AssociateContactWithAddressBookResponse |
This is the response object from the AssociateContactWithAddressBook operation. |
|
AssociateDeviceWithNetworkProfileRequest |
Container for the parameters to the AssociateDeviceWithNetworkProfile operation. Associates a device with the specified network profile. |
|
AssociateDeviceWithNetworkProfileResponse |
This is the response object from the AssociateDeviceWithNetworkProfile operation. |
|
AssociateDeviceWithRoomRequest |
Container for the parameters to the AssociateDeviceWithRoom operation. Associates 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. |
|
AssociateDeviceWithRoomResponse |
This is the response object from the AssociateDeviceWithRoom operation. |
|
AssociateSkillGroupWithRoomRequest |
Container for the parameters to the AssociateSkillGroupWithRoom operation. Associates a skill group with a given room. This enables all skills in the associated skill group on all devices in the room. |
|
AssociateSkillGroupWithRoomResponse |
This is the response object from the AssociateSkillGroupWithRoom operation. |
|
AssociateSkillWithSkillGroupRequest |
Container for the parameters to the AssociateSkillWithSkillGroup operation. Associates a skill with a skill group. |
|
AssociateSkillWithSkillGroupResponse |
This is the response object from the AssociateSkillWithSkillGroup operation. |
|
AssociateSkillWithUsersRequest |
Container for the parameters to the AssociateSkillWithUsers operation. Makes a private skill available for enrolled users to enable on their devices. |
|
AssociateSkillWithUsersResponse |
This is the response object from the AssociateSkillWithUsers operation. |
|
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,
required codec version (MPEG version 2) and bit rate (48 kbps), you might use converter
software. One option for this is a command-line tool, FFmpeg. For more information,
see FFmpeg. The following command converts the
provided
|
|
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. |
|
ConcurrentModificationException |
There is a concurrent modification of resources. |
|
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. |
|
CreateAddressBookRequest |
Container for the parameters to the CreateAddressBook operation. Creates an address book with the specified details. |
|
CreateAddressBookResponse |
This is the response object from the CreateAddressBook operation. |
|
CreateBusinessReportScheduleRequest |
Container for the parameters to the CreateBusinessReportSchedule operation. Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or weekly interval. |
|
CreateBusinessReportScheduleResponse |
This is the response object from the CreateBusinessReportSchedule operation. |
|
CreateConferenceProviderRequest |
Container for the parameters to the CreateConferenceProvider operation. Adds a new conference provider under the user's AWS account. |
|
CreateConferenceProviderResponse |
This is the response object from the CreateConferenceProvider operation. |
|
CreateContactRequest |
Container for the parameters to the CreateContact operation. Creates a contact with the specified details. |
|
CreateContactResponse |
This is the response object from the CreateContact operation. |
|
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. |
|
CreateGatewayGroupRequest |
Container for the parameters to the CreateGatewayGroup operation. Creates a gateway group with the specified details. |
|
CreateGatewayGroupResponse |
This is the response object from the CreateGatewayGroup operation. |
|
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. |
|
CreateNetworkProfileRequest |
Container for the parameters to the CreateNetworkProfile operation. Creates a network profile with the specified details. |
|
CreateNetworkProfileResponse |
This is the response object from the CreateNetworkProfile operation. |
|
CreateProactiveJoin |
|
|
CreateProfileRequest |
Container for the parameters to the CreateProfile operation. Creates a new room profile with the specified details. |
|
CreateProfileResponse |
This is the response object from the CreateProfile operation. |
|
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. |
|
CreateRoomRequest |
Container for the parameters to the CreateRoom operation. Creates a room with the specified details. |
|
CreateRoomResponse |
This is the response object from the CreateRoom operation. |
|
CreateSkillGroupRequest |
Container for the parameters to the CreateSkillGroup operation. Creates a skill group with a specified name and description. |
|
CreateSkillGroupResponse |
This is the response object from the CreateSkillGroup operation. |
|
CreateUserRequest |
Container for the parameters to the CreateUser operation. Creates a user. |
|
CreateUserResponse |
This is the response object from the CreateUser operation. |
|
DeleteAddressBookRequest |
Container for the parameters to the DeleteAddressBook operation. Deletes an address book by the address book ARN. |
|
DeleteAddressBookResponse |
This is the response object from the DeleteAddressBook operation. |
|
DeleteBusinessReportScheduleRequest |
Container for the parameters to the DeleteBusinessReportSchedule operation. Deletes the recurring report delivery schedule with the specified schedule ARN. |
|
DeleteBusinessReportScheduleResponse |
This is the response object from the DeleteBusinessReportSchedule operation. |
|
DeleteConferenceProviderRequest |
Container for the parameters to the DeleteConferenceProvider operation. Deletes a conference provider. |
|
DeleteConferenceProviderResponse |
This is the response object from the DeleteConferenceProvider operation. |
|
DeleteContactRequest |
Container for the parameters to the DeleteContact operation. Deletes a contact by the contact ARN. |
|
DeleteContactResponse |
This is the response object from the DeleteContact operation. |
|
DeleteDeviceRequest |
Container for the parameters to the DeleteDevice operation. Removes a device from Alexa For Business. |
|
DeleteDeviceResponse |
This is the response object from the DeleteDevice operation. |
|
DeleteDeviceUsageDataRequest |
Container for the parameters to the DeleteDeviceUsageData operation. When this action is called for a specified shared device, it allows authorized users to delete the device's entire previous history of voice input data and associated response data. This action can be called once every 24 hours for a specific shared device. |
|
DeleteDeviceUsageDataResponse |
This is the response object from the DeleteDeviceUsageData operation. |
|
DeleteGatewayGroupRequest |
Container for the parameters to the DeleteGatewayGroup operation. Deletes a gateway group. |
|
DeleteGatewayGroupResponse |
This is the response object from the DeleteGatewayGroup operation. |
|
DeleteNetworkProfileRequest |
Container for the parameters to the DeleteNetworkProfile operation. Deletes a network profile by the network profile ARN. |
|
DeleteNetworkProfileResponse |
This is the response object from the DeleteNetworkProfile operation. |
|
DeleteProfileRequest |
Container for the parameters to the DeleteProfile operation. Deletes a room profile by the profile ARN. |
|
DeleteProfileResponse |
This is the response object from the DeleteProfile operation. |
|
DeleteRoomRequest |
Container for the parameters to the DeleteRoom operation. Deletes a room by the room ARN. |
|
DeleteRoomResponse |
This is the response object from the DeleteRoom operation. |
|
DeleteRoomSkillParameterRequest |
Container for the parameters to the DeleteRoomSkillParameter operation. Deletes room skill parameter details by room, skill, and parameter key ID. |
|
DeleteRoomSkillParameterResponse |
This is the response object from the DeleteRoomSkillParameter operation. |
|
DeleteSkillAuthorizationRequest |
Container for the parameters to the DeleteSkillAuthorization operation. Unlinks a third-party account from a skill. |
|
DeleteSkillAuthorizationResponse |
This is the response object from the DeleteSkillAuthorization operation. |
|
DeleteSkillGroupRequest |
Container for the parameters to the DeleteSkillGroup operation. Deletes a skill group by skill group ARN. |
|
DeleteSkillGroupResponse |
This is the response object from the DeleteSkillGroup operation. |
|
DeleteUserRequest |
Container for the parameters to the DeleteUser operation. Deletes a specified user by user ARN and enrollment ARN. |
|
DeleteUserResponse |
This is the response object from the DeleteUser operation. |
|
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. |
|
DeviceNotRegisteredException |
The request failed because this device is no longer registered and therefore no longer managed by this account. |
|
DeviceStatusDetail |
Details of a device’s status. |
|
DeviceStatusInfo |
Detailed information about a device's status. |
|
DisassociateContactFromAddressBookRequest |
Container for the parameters to the DisassociateContactFromAddressBook operation. Disassociates a contact from a given address book. |
|
DisassociateContactFromAddressBookResponse |
This is the response object from the DisassociateContactFromAddressBook operation. |
|
DisassociateDeviceFromRoomRequest |
Container for the parameters to the DisassociateDeviceFromRoom operation. Disassociates a device from its current room. The device continues to be connected to the Wi-Fi network and is still registered to the account. The device settings and skills are removed from the room. |
|
DisassociateDeviceFromRoomResponse |
This is the response object from the DisassociateDeviceFromRoom operation. |
|
DisassociateSkillFromSkillGroupRequest |
Container for the parameters to the DisassociateSkillFromSkillGroup operation. Disassociates a skill from a skill group. |
|
DisassociateSkillFromSkillGroupResponse |
This is the response object from the DisassociateSkillFromSkillGroup operation. |
|
DisassociateSkillFromUsersRequest |
Container for the parameters to the DisassociateSkillFromUsers operation. Makes a private skill unavailable for enrolled users and prevents them from enabling it on their devices. |
|
DisassociateSkillFromUsersResponse |
This is the response object from the DisassociateSkillFromUsers operation. |
|
DisassociateSkillGroupFromRoomRequest |
Container for the parameters to the DisassociateSkillGroupFromRoom operation. Disassociates a skill group from a specified room. This disables all skills in the skill group on all devices in the room. |
|
DisassociateSkillGroupFromRoomResponse |
This is the response object from the DisassociateSkillGroupFromRoom operation. |
|
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. |
|
ForgetSmartHomeAppliancesRequest |
Container for the parameters to the ForgetSmartHomeAppliances operation. Forgets smart home appliances associated to a room. |
|
ForgetSmartHomeAppliancesResponse |
This is the response object from the ForgetSmartHomeAppliances operation. |
|
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. |
|
GetAddressBookRequest |
Container for the parameters to the GetAddressBook operation. Gets address the book details by the address book ARN. |
|
GetAddressBookResponse |
This is the response object from the GetAddressBook operation. |
|
GetConferencePreferenceRequest |
Container for the parameters to the GetConferencePreference operation. Retrieves the existing conference preferences. |
|
GetConferencePreferenceResponse |
This is the response object from the GetConferencePreference operation. |
|
GetConferenceProviderRequest |
Container for the parameters to the GetConferenceProvider operation. Gets details about a specific conference provider. |
|
GetConferenceProviderResponse |
This is the response object from the GetConferenceProvider operation. |
|
GetContactRequest |
Container for the parameters to the GetContact operation. Gets the contact details by the contact ARN. |
|
GetContactResponse |
This is the response object from the GetContact operation. |
|
GetDeviceRequest |
Container for the parameters to the GetDevice operation. Gets the details of a device by device ARN. |
|
GetDeviceResponse |
This is the response object from the GetDevice operation. |
|
GetGatewayGroupRequest |
Container for the parameters to the GetGatewayGroup operation. Retrieves the details of a gateway group. |
|
GetGatewayGroupResponse |
This is the response object from the GetGatewayGroup operation. |
|
GetGatewayRequest |
Container for the parameters to the GetGateway operation. Retrieves the details of a gateway. |
|
GetGatewayResponse |
This is the response object from the GetGateway operation. |
|
GetInvitationConfigurationRequest |
Container for the parameters to the GetInvitationConfiguration operation. Retrieves the configured values for the user enrollment invitation email template. |
|
GetInvitationConfigurationResponse |
This is the response object from the GetInvitationConfiguration operation. |
|
GetNetworkProfileRequest |
Container for the parameters to the GetNetworkProfile operation. Gets the network profile details by the network profile ARN. |
|
GetNetworkProfileResponse |
This is the response object from the GetNetworkProfile operation. |
|
GetProfileRequest |
Container for the parameters to the GetProfile operation. Gets the details of a room profile by profile ARN. |
|
GetProfileResponse |
This is the response object from the GetProfile operation. |
|
GetRoomRequest |
Container for the parameters to the GetRoom operation. Gets room details by room ARN. |
|
GetRoomResponse |
This is the response object from the GetRoom operation. |
|
GetRoomSkillParameterRequest |
Container for the parameters to the GetRoomSkillParameter operation. Gets room skill parameter details by room, skill, and parameter key ARN. |
|
GetRoomSkillParameterResponse |
This is the response object from the GetRoomSkillParameter operation. |
|
GetSkillGroupRequest |
Container for the parameters to the GetSkillGroup operation. Gets skill group details by skill group ARN. |
|
GetSkillGroupResponse |
This is the response object from the GetSkillGroup operation. |
|
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. |
|
InvalidCertificateAuthorityException |
The Certificate Authority can't issue or revoke a certificate. |
|
InvalidDeviceException |
The device is in an invalid state. |
|
InvalidSecretsManagerResourceException |
A password in SecretsManager is in an invalid state. |
|
InvalidServiceLinkedRoleStateException |
The service linked role is locked for deletion. |
|
InvalidUserStatusException |
The attempt to update a user is invalid due to the user's current status. |
|
IPDialIn |
The IP endpoint and protocol for calling. |
|
LimitExceededException |
You are performing an action that would put you beyond your account's limits. |
|
ListBusinessReportSchedulesRequest |
Container for the parameters to the ListBusinessReportSchedules operation. Lists the details of the schedules that a user configured. A download URL of the report associated with each schedule is returned every time this action is called. A new download URL is returned each time, and is valid for 24 hours. |
|
ListBusinessReportSchedulesResponse |
This is the response object from the ListBusinessReportSchedules operation. |
|
ListConferenceProvidersRequest |
Container for the parameters to the ListConferenceProviders operation. Lists conference providers under a specific AWS account. |
|
ListConferenceProvidersResponse |
This is the response object from the ListConferenceProviders operation. |
|
ListDeviceEventsRequest |
Container for the parameters to the ListDeviceEvents operation. Lists the device event history, including device connection status, for up to 30 days. |
|
ListDeviceEventsResponse |
This is the response object from the ListDeviceEvents operation. |
|
ListGatewayGroupsRequest |
Container for the parameters to the ListGatewayGroups operation. Retrieves a list of gateway group summaries. Use GetGatewayGroup to retrieve details of a specific gateway group. |
|
ListGatewayGroupsResponse |
This is the response object from the ListGatewayGroups operation. |
|
ListGatewaysRequest |
Container for the parameters to the ListGateways operation. Retrieves a list of gateway summaries. Use GetGateway to retrieve details of a specific gateway. An optional gateway group ARN can be provided to only retrieve gateway summaries of gateways that are associated with that gateway group ARN. |
|
ListGatewaysResponse |
This is the response object from the ListGateways operation. |
|
ListSkillsRequest |
Container for the parameters to the ListSkills operation. Lists all enabled skills in a specific skill group. |
|
ListSkillsResponse |
This is the response object from the ListSkills operation. |
|
ListSkillsStoreCategoriesRequest |
Container for the parameters to the ListSkillsStoreCategories operation. Lists all categories in the Alexa skill store. |
|
ListSkillsStoreCategoriesResponse |
This is the response object from the ListSkillsStoreCategories operation. |
|
ListSkillsStoreSkillsByCategoryRequest |
Container for the parameters to the ListSkillsStoreSkillsByCategory operation. Lists all skills in the Alexa skill store by category. |
|
ListSkillsStoreSkillsByCategoryResponse |
This is the response object from the ListSkillsStoreSkillsByCategory operation. |
|
ListSmartHomeAppliancesRequest |
Container for the parameters to the ListSmartHomeAppliances operation. Lists all of the smart home appliances associated with a room. |
|
ListSmartHomeAppliancesResponse |
This is the response object from the ListSmartHomeAppliances operation. |
|
ListTagsRequest |
Container for the parameters to the ListTags operation. Lists all tags for the specified resource. |
|
ListTagsResponse |
This is the response object from the ListTags operation. |
|
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.
|
|
NameInUseException |
The name sent in the request is already in use. |
|
NetworkProfile |
The network profile associated with a device. |
|
NetworkProfileData |
The data associated with a network profile. |
|
NotFoundException |
The resource is not found. |
|
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. |
|
PutConferencePreferenceRequest |
Container for the parameters to the PutConferencePreference operation. Sets the conference preferences on a specific conference provider at the account level. |
|
PutConferencePreferenceResponse |
This is the response object from the PutConferencePreference operation. |
|
PutInvitationConfigurationRequest |
Container for the parameters to the PutInvitationConfiguration operation. Configures the email template for the user enrollment invitation with the specified attributes. |
|
PutInvitationConfigurationResponse |
This is the response object from the PutInvitationConfiguration operation. |
|
PutRoomSkillParameterRequest |
Container for the parameters to the PutRoomSkillParameter operation. Updates room skill parameter details by room, skill, and parameter key ID. Not all skills have a room skill parameter. |
|
PutRoomSkillParameterResponse |
This is the response object from the PutRoomSkillParameter operation. |
|
PutSkillAuthorizationRequest |
Container for the parameters to the PutSkillAuthorization operation. Links a user's account to a third-party skill provider. If this API operation is called by an assumed IAM role, the skill being linked must be a private skill. Also, the skill must be owned by the AWS account that assumed the IAM role. |
|
PutSkillAuthorizationResponse |
This is the response object from the PutSkillAuthorization operation. |
|
RegisterAVSDeviceRequest |
Container for the parameters to the RegisterAVSDevice operation. Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service (AVS). |
|
RegisterAVSDeviceResponse |
This is the response object from the RegisterAVSDevice operation. |
|
RejectSkillRequest |
Container for the parameters to the RejectSkill operation. Disassociates a skill from the organization under a user's AWS account. If the skill is a private skill, it moves to an AcceptStatus of PENDING. Any private or public skill that is rejected can be added later by calling the ApproveSkill API. |
|
RejectSkillResponse |
This is the response object from the RejectSkill operation. |
|
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. |
|
ResolveRoomRequest |
Container for the parameters to the ResolveRoom operation. Determines the details for the room from which a skill request was invoked. This operation is used by skill developers. To query ResolveRoom from an Alexa skill, the skill ID needs to be authorized. When the skill is using an AWS Lambda function, the skill is automatically authorized when you publish your skill as a private skill to your AWS account. Skills that are hosted using a custom web service must be manually authorized. To get your skill authorized, contact AWS Support with your AWS account ID that queries the ResolveRoom API and skill ID. |
|
ResolveRoomResponse |
This is the response object from the ResolveRoom operation. |
|
ResourceAssociatedException |
Another resource is associated with the resource in the request. |
|
ResourceInUseException |
The resource in the request is already in use. |
|
RevokeInvitationRequest |
Container for the parameters to the RevokeInvitation operation. Revokes an invitation and invalidates the enrollment URL. |
|
RevokeInvitationResponse |
This is the response object from the RevokeInvitation operation. |
|
Room |
A room with attributes. |
|
RoomData |
The data of a room. |
|
RoomSkillParameter |
A skill parameter associated with a room. |
|
SearchAddressBooksRequest |
Container for the parameters to the SearchAddressBooks operation. Searches address books and lists the ones that meet a set of filter and sort criteria. |
|
SearchAddressBooksResponse |
This is the response object from the SearchAddressBooks operation. |
|
SearchContactsRequest |
Container for the parameters to the SearchContacts operation. Searches contacts and lists the ones that meet a set of filter and sort criteria. |
|
SearchContactsResponse |
This is the response object from the SearchContacts operation. |
|
SearchDevicesRequest |
Container for the parameters to the SearchDevices operation. Searches devices and lists the ones that meet a set of filter criteria. |
|
SearchDevicesResponse |
This is the response object from the SearchDevices operation. |
|
SearchNetworkProfilesRequest |
Container for the parameters to the SearchNetworkProfiles operation. Searches network profiles and lists the ones that meet a set of filter and sort criteria. |
|
SearchNetworkProfilesResponse |
This is the response object from the SearchNetworkProfiles operation. |
|
SearchProfilesRequest |
Container for the parameters to the SearchProfiles operation. Searches room profiles and lists the ones that meet a set of filter criteria. |
|
SearchProfilesResponse |
This is the response object from the SearchProfiles operation. |
|
SearchRoomsRequest |
Container for the parameters to the SearchRooms operation. Searches rooms and lists the ones that meet a set of filter and sort criteria. |
|
SearchRoomsResponse |
This is the response object from the SearchRooms operation. |
|
SearchSkillGroupsRequest |
Container for the parameters to the SearchSkillGroups operation. Searches skill groups and lists the ones that meet a set of filter and sort criteria. |
|
SearchSkillGroupsResponse |
This is the response object from the SearchSkillGroups operation. |
|
SearchUsersRequest |
Container for the parameters to the SearchUsers operation. Searches users and lists the ones that meet a set of filter and sort criteria. |
|
SearchUsersResponse |
This is the response object from the SearchUsers operation. |
|
SendAnnouncementRequest |
Container for the parameters to the SendAnnouncement operation. Triggers an asynchronous flow to send text, SSML, or audio announcements to rooms that are identified by a search or filter. |
|
SendAnnouncementResponse |
This is the response object from the SendAnnouncement operation. |
|
SendInvitationRequest |
Container for the parameters to the SendInvitation operation. Sends an enrollment invitation email with a URL to a user. The URL is valid for 30 days or until you call this operation again, whichever comes first. |
|
SendInvitationResponse |
This is the response object from the SendInvitation operation. |
|
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. |
|
SkillNotLinkedException |
The skill must be linked to a third-party account. |
|
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. |
|
StartDeviceSyncRequest |
Container for the parameters to the StartDeviceSync operation. Resets a device and its account to the known default settings. This clears all information and settings set by previous users in the following ways:
|
|
StartDeviceSyncResponse |
This is the response object from the StartDeviceSync operation. |
|
StartSmartHomeApplianceDiscoveryRequest |
Container for the parameters to the StartSmartHomeApplianceDiscovery operation. Initiates the discovery of any smart home appliances associated with the room. |
|
StartSmartHomeApplianceDiscoveryResponse |
This is the response object from the StartSmartHomeApplianceDiscovery operation. |
|
Tag |
A key-value pair that can be associated with a resource. |
|
TagResourceRequest |
Container for the parameters to the TagResource operation. Adds metadata tags to a specified resource. |
|
TagResourceResponse |
This is the response object from the TagResource operation. |
|
Text |
The text message. |
|
UnauthorizedException |
The caller has no permissions to operate on the resource involved in the API call. |
|
UntagResourceRequest |
Container for the parameters to the UntagResource operation. Removes metadata tags from a specified resource. |
|
UntagResourceResponse |
This is the response object from the UntagResource operation. |
|
UpdateAddressBookRequest |
Container for the parameters to the UpdateAddressBook operation. Updates address book details by the address book ARN. |
|
UpdateAddressBookResponse |
This is the response object from the UpdateAddressBook operation. |
|
UpdateBusinessReportScheduleRequest |
Container for the parameters to the UpdateBusinessReportSchedule operation. Updates the configuration of the report delivery schedule with the specified schedule ARN. |
|
UpdateBusinessReportScheduleResponse |
This is the response object from the UpdateBusinessReportSchedule operation. |
|
UpdateConferenceProviderRequest |
Container for the parameters to the UpdateConferenceProvider operation. Updates an existing conference provider's settings. |
|
UpdateConferenceProviderResponse |
This is the response object from the UpdateConferenceProvider operation. |
|
UpdateContactRequest |
Container for the parameters to the UpdateContact operation. Updates the contact details by the contact ARN. |
|
UpdateContactResponse |
This is the response object from the UpdateContact operation. |
|
UpdateDeviceRequest |
Container for the parameters to the UpdateDevice operation. Updates the device name by device ARN. |
|
UpdateDeviceResponse |
This is the response object from the UpdateDevice operation. |
|
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. |
|
UpdateGatewayGroupRequest |
Container for the parameters to the UpdateGatewayGroup operation. Updates the details of a gateway group. If any optional field is not provided, the existing corresponding value is left unmodified. |
|
UpdateGatewayGroupResponse |
This is the response object from the UpdateGatewayGroup operation. |
|
UpdateGatewayRequest |
Container for the parameters to the UpdateGateway operation. Updates the details of a gateway. If any optional field is not provided, the existing corresponding value is left unmodified. |
|
UpdateGatewayResponse |
This is the response object from the UpdateGateway operation. |
|
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. |
|
UpdateNetworkProfileRequest |
Container for the parameters to the UpdateNetworkProfile operation. Updates a network profile by the network profile ARN. |
|
UpdateNetworkProfileResponse |
This is the response object from the UpdateNetworkProfile operation. |
|
UpdateProactiveJoin |
|
|
UpdateProfileRequest |
Container for the parameters to the UpdateProfile operation. Updates an existing room profile by room profile ARN. |
|
UpdateProfileResponse |
This is the response object from the UpdateProfile operation. |
|
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. |
|
UpdateRoomRequest |
Container for the parameters to the UpdateRoom operation. Updates room details by room ARN. |
|
UpdateRoomResponse |
This is the response object from the UpdateRoom operation. |
|
UpdateSkillGroupRequest |
Container for the parameters to the UpdateSkillGroup operation. Updates skill group details by skill group ARN. |
|
UpdateSkillGroupResponse |
This is the response object from the UpdateSkillGroup operation. |
|
UserData |
Information related to a user. |
Name | Description | |
---|---|---|
IAlexaForBusinessPaginatorFactory |
Paginators for the AlexaForBusiness service |
|
IListBusinessReportSchedulesPaginator |
Paginator for the ListBusinessReportSchedules operation |
|
IListConferenceProvidersPaginator |
Paginator for the ListConferenceProviders operation |
|
IListDeviceEventsPaginator |
Paginator for the ListDeviceEvents operation |
|
IListGatewayGroupsPaginator |
Paginator for the ListGatewayGroups operation |
|
IListGatewaysPaginator |
Paginator for the ListGateways operation |
|
IListSkillsPaginator |
Paginator for the ListSkills operation |
|
IListSkillsStoreCategoriesPaginator |
Paginator for the ListSkillsStoreCategories operation |
|
IListSkillsStoreSkillsByCategoryPaginator |
Paginator for the ListSkillsStoreSkillsByCategory operation |
|
IListSmartHomeAppliancesPaginator |
Paginator for the ListSmartHomeAppliances operation |
|
IListTagsPaginator |
Paginator for the ListTags operation |
|
ISearchAddressBooksPaginator |
Paginator for the SearchAddressBooks operation |
|
ISearchContactsPaginator |
Paginator for the SearchContacts operation |
|
ISearchDevicesPaginator |
Paginator for the SearchDevices operation |
|
ISearchNetworkProfilesPaginator |
Paginator for the SearchNetworkProfiles operation |
|
ISearchProfilesPaginator |
Paginator for the SearchProfiles operation |
|
ISearchRoomsPaginator |
Paginator for the SearchRooms operation |
|
ISearchSkillGroupsPaginator |
Paginator for the SearchSkillGroups operation |
|
ISearchUsersPaginator |
Paginator for the SearchUsers operation |