aws 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
Subcommands
| Name | Description |
|---|---|
approve-skill | 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 |
associate-contact-with-address-book | Associates a contact with a given address book |
associate-device-with-network-profile | Associates a device with the specified network profile |
associate-device-with-room | 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 |
associate-skill-group-with-room | Associates a skill group with a given room. This enables all skills in the associated skill group on all devices in the room |
associate-skill-with-skill-group | Associates a skill with a skill group |
associate-skill-with-users | Makes a private skill available for enrolled users to enable on their devices |
create-address-book | Creates an address book with the specified details |
create-business-report-schedule | Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or weekly interval |
create-conference-provider | Adds a new conference provider under the user's AWS account |
create-contact | Creates a contact with the specified details |
create-gateway-group | Creates a gateway group with the specified details |
create-network-profile | Creates a network profile with the specified details |
create-profile | Creates a new room profile with the specified details |
create-room | Creates a room with the specified details |
create-skill-group | Creates a skill group with a specified name and description |
create-user | Creates a user |
delete-address-book | Deletes an address book by the address book ARN |
delete-business-report-schedule | Deletes the recurring report delivery schedule with the specified schedule ARN |
delete-conference-provider | Deletes a conference provider |
delete-contact | Deletes a contact by the contact ARN |
delete-device | Removes a device from Alexa For Business |
delete-device-usage-data | 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 |
delete-gateway-group | Deletes a gateway group |
delete-network-profile | Deletes a network profile by the network profile ARN |
delete-profile | Deletes a room profile by the profile ARN |
delete-room | Deletes a room by the room ARN |
delete-room-skill-parameter | Deletes room skill parameter details by room, skill, and parameter key ID |
delete-skill-authorization | Unlinks a third-party account from a skill |
delete-skill-group | Deletes a skill group by skill group ARN |
delete-user | Deletes a specified user by user ARN and enrollment ARN |
disassociate-contact-from-address-book | Disassociates a contact from a given address book |
disassociate-device-from-room | 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 |
disassociate-skill-from-skill-group | Disassociates a skill from a skill group |
disassociate-skill-from-users | Makes a private skill unavailable for enrolled users and prevents them from enabling it on their devices |
disassociate-skill-group-from-room | Disassociates a skill group from a specified room. This disables all skills in the skill group on all devices in the room |
forget-smart-home-appliances | Forgets smart home appliances associated to a room |
get-address-book | Gets address the book details by the address book ARN |
get-conference-preference | Retrieves the existing conference preferences |
get-conference-provider | Gets details about a specific conference provider |
get-contact | Gets the contact details by the contact ARN |
get-device | Gets the details of a device by device ARN |
get-gateway | Retrieves the details of a gateway |
get-gateway-group | Retrieves the details of a gateway group |
get-invitation-configuration | Retrieves the configured values for the user enrollment invitation email template |
get-network-profile | Gets the network profile details by the network profile ARN |
get-profile | Gets the details of a room profile by profile ARN |
get-room | Gets room details by room ARN |
get-room-skill-parameter | Gets room skill parameter details by room, skill, and parameter key ARN |
get-skill-group | Gets skill group details by skill group ARN |
list-business-report-schedules | 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 |
list-conference-providers | Lists conference providers under a specific AWS account |
list-device-events | Lists the device event history, including device connection status, for up to 30 days |
list-gateway-groups | Retrieves a list of gateway group summaries. Use GetGatewayGroup to retrieve details of a specific gateway group |
list-gateways | 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 |
list-skills | Lists all enabled skills in a specific skill group |
list-skills-store-categories | Lists all categories in the Alexa skill store |
list-skills-store-skills-by-category | Lists all skills in the Alexa skill store by category |
list-smart-home-appliances | Lists all of the smart home appliances associated with a room |
list-tags | Lists all tags for the specified resource |
put-conference-preference | Sets the conference preferences on a specific conference provider at the account level |
put-invitation-configuration | Configures the email template for the user enrollment invitation with the specified attributes |
put-room-skill-parameter | Updates room skill parameter details by room, skill, and parameter key ID. Not all skills have a room skill parameter |
put-skill-authorization | 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 |
register-avs-device | Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service (AVS) |
reject-skill | 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 |
resolve-room | 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 |
revoke-invitation | Revokes an invitation and invalidates the enrollment URL |
search-address-books | Searches address books and lists the ones that meet a set of filter and sort criteria |
search-contacts | Searches contacts and lists the ones that meet a set of filter and sort criteria |
search-devices | Searches devices and lists the ones that meet a set of filter criteria |
search-network-profiles | Searches network profiles and lists the ones that meet a set of filter and sort criteria |
search-profiles | Searches room profiles and lists the ones that meet a set of filter criteria |
search-rooms | Searches rooms and lists the ones that meet a set of filter and sort criteria |
search-skill-groups | Searches skill groups and lists the ones that meet a set of filter and sort criteria |
search-users | Searches users and lists the ones that meet a set of filter and sort criteria |
send-announcement | Triggers an asynchronous flow to send text, SSML, or audio announcements to rooms that are identified by a search or filter |
send-invitation | 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 |
start-device-sync | 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: Bluetooth - This unpairs all bluetooth devices paired with your echo device. Volume - This resets the echo device's volume to the default value. Notifications - This clears all notifications from your echo device. Lists - This clears all to-do items from your echo device. Settings - This internally syncs the room's profile (if the device is assigned to a room), contacts, address books, delegation access for account linking, and communications (if enabled on the room profile) |
start-smart-home-appliance-discovery | Initiates the discovery of any smart home appliances associated with the room |
tag-resource | Adds metadata tags to a specified resource |
untag-resource | Removes metadata tags from a specified resource |
update-address-book | Updates address book details by the address book ARN |
update-business-report-schedule | Updates the configuration of the report delivery schedule with the specified schedule ARN |
update-conference-provider | Updates an existing conference provider's settings |
update-contact | Updates the contact details by the contact ARN |
update-device | Updates the device name by device ARN |
update-gateway | Updates the details of a gateway. If any optional field is not provided, the existing corresponding value is left unmodified |
update-gateway-group | Updates the details of a gateway group. If any optional field is not provided, the existing corresponding value is left unmodified |
update-network-profile | Updates a network profile by the network profile ARN |
update-profile | Updates an existing room profile by room profile ARN |
update-room | Updates room details by room ARN |
update-skill-group | Updates skill group details by skill group ARN |