AWS.AlexaForBusiness (aws-elixir v0.8.0) View Source

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.

Link to this section Summary

Functions

Associates a skill with the organization under the customer's AWS account.

Associates a contact with a given address book.

Associates a device with the specified network profile.

Associates a device with a given room.

Associates a skill group with a given room.

Makes a private skill available for enrolled users to enable on their devices.

Creates an address book with the specified details.

Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or weekly interval.

Adds a new conference provider under the user's AWS account.

Creates a contact with the specified details.

Creates a gateway group with the specified details.

Creates a network profile with the specified details.

Creates a new room profile with the specified details.

Creates a room with the specified details.

Creates a skill group with a specified name and description.

Deletes an address book by the address book ARN.

Deletes the recurring report delivery schedule with the specified schedule ARN.

Deletes a contact by the contact ARN.

Removes a device from Alexa For Business.

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.

Deletes a network profile by the network profile ARN.

Deletes a room profile by the profile ARN.

Deletes a room by the room ARN.

Deletes room skill parameter details by room, skill, and parameter key ID.

Unlinks a third-party account from a skill.

Deletes a skill group by skill group ARN.

Deletes a specified user by user ARN and enrollment ARN.

Disassociates a contact from a given address book.

Disassociates a device from its current room.

Disassociates a skill from a skill group.

Makes a private skill unavailable for enrolled users and prevents them from enabling it on their devices.

Disassociates a skill group from a specified room.

Forgets smart home appliances associated to a room.

Gets address the book details by the address book ARN.

Retrieves the existing conference preferences.

Gets details about a specific conference provider.

Gets the contact details by the contact ARN.

Gets the details of a device by device ARN.

Retrieves the details of a gateway.

Retrieves the details of a gateway group.

Retrieves the configured values for the user enrollment invitation email template.

Gets the network profile details by the network profile ARN.

Gets the details of a room profile by profile ARN.

Gets room details by room ARN.

Gets room skill parameter details by room, skill, and parameter key ARN.

Gets skill group details by skill group ARN.

Lists the details of the schedules that a user configured.

Lists conference providers under a specific AWS account.

Lists the device event history, including device connection status, for up to 30 days.

Retrieves a list of gateway group summaries.

Retrieves a list of gateway summaries.

Lists all enabled skills in a specific skill group.

Lists all categories in the Alexa skill store.

Lists all skills in the Alexa skill store by category.

Lists all of the smart home appliances associated with a room.

Lists all tags for the specified resource.

Sets the conference preferences on a specific conference provider at the account level.

Configures the email template for the user enrollment invitation with the specified attributes.

Updates room skill parameter details by room, skill, and parameter key ID.

Links a user's account to a third-party skill provider.

Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service (AVS).

Disassociates a skill from the organization under a user's AWS account.

Determines the details for the room from which a skill request was invoked.

Revokes an invitation and invalidates the enrollment URL.

Searches address books and lists the ones that meet a set of filter and sort criteria.

Searches contacts and lists the ones that meet a set of filter and sort criteria.

Searches devices and lists the ones that meet a set of filter criteria.

Searches network profiles and lists the ones that meet a set of filter and sort criteria.

Searches room profiles and lists the ones that meet a set of filter criteria.

Searches rooms and lists the ones that meet a set of filter and sort criteria.

Searches skill groups and lists the ones that meet a set of filter and sort criteria.

Searches users and lists the ones that meet a set of filter and sort criteria.

Triggers an asynchronous flow to send text, SSML, or audio announcements to rooms that are identified by a search or filter.

Sends an enrollment invitation email with a URL to a user.

Resets a device and its account to the known default settings.

Initiates the discovery of any smart home appliances associated with the room.

Adds metadata tags to a specified resource.

Removes metadata tags from a specified resource.

Updates address book details by the address book ARN.

Updates the configuration of the report delivery schedule with the specified schedule ARN.

Updates an existing conference provider's settings.

Updates the contact details by the contact ARN.

Updates the device name by device ARN.

Updates the details of a gateway.

Updates the details of a gateway group.

Updates a network profile by the network profile ARN.

Updates an existing room profile by room profile ARN.

Updates room details by room ARN.

Updates skill group details by skill group ARN.

Link to this section Functions

Link to this function

approve_skill(client, input, options \\ [])

View Source

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.

Link to this function

associate_contact_with_address_book(client, input, options \\ [])

View Source

Associates a contact with a given address book.

Link to this function

associate_device_with_network_profile(client, input, options \\ [])

View Source

Associates a device with the specified network profile.

Link to this function

associate_device_with_room(client, input, options \\ [])

View Source

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.

Link to this function

associate_skill_group_with_room(client, input, options \\ [])

View Source

Associates a skill group with a given room.

This enables all skills in the associated skill group on all devices in the room.

Link to this function

associate_skill_with_skill_group(client, input, options \\ [])

View Source

Associates a skill with a skill group.

Link to this function

associate_skill_with_users(client, input, options \\ [])

View Source

Makes a private skill available for enrolled users to enable on their devices.

Link to this function

create_address_book(client, input, options \\ [])

View Source

Creates an address book with the specified details.

Link to this function

create_business_report_schedule(client, input, options \\ [])

View Source

Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or weekly interval.

Link to this function

create_conference_provider(client, input, options \\ [])

View Source

Adds a new conference provider under the user's AWS account.

Link to this function

create_contact(client, input, options \\ [])

View Source

Creates a contact with the specified details.

Link to this function

create_gateway_group(client, input, options \\ [])

View Source

Creates a gateway group with the specified details.

Link to this function

create_network_profile(client, input, options \\ [])

View Source

Creates a network profile with the specified details.

Link to this function

create_profile(client, input, options \\ [])

View Source

Creates a new room profile with the specified details.

Link to this function

create_room(client, input, options \\ [])

View Source

Creates a room with the specified details.

Link to this function

create_skill_group(client, input, options \\ [])

View Source

Creates a skill group with a specified name and description.

Link to this function

create_user(client, input, options \\ [])

View Source

Creates a user.

Link to this function

delete_address_book(client, input, options \\ [])

View Source

Deletes an address book by the address book ARN.

Link to this function

delete_business_report_schedule(client, input, options \\ [])

View Source

Deletes the recurring report delivery schedule with the specified schedule ARN.

Link to this function

delete_conference_provider(client, input, options \\ [])

View Source

Deletes a conference provider.

Link to this function

delete_contact(client, input, options \\ [])

View Source

Deletes a contact by the contact ARN.

Link to this function

delete_device(client, input, options \\ [])

View Source

Removes a device from Alexa For Business.

Link to this function

delete_device_usage_data(client, input, options \\ [])

View Source

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.

Link to this function

delete_gateway_group(client, input, options \\ [])

View Source

Deletes a gateway group.

Link to this function

delete_network_profile(client, input, options \\ [])

View Source

Deletes a network profile by the network profile ARN.

Link to this function

delete_profile(client, input, options \\ [])

View Source

Deletes a room profile by the profile ARN.

Link to this function

delete_room(client, input, options \\ [])

View Source

Deletes a room by the room ARN.

Link to this function

delete_room_skill_parameter(client, input, options \\ [])

View Source

Deletes room skill parameter details by room, skill, and parameter key ID.

Link to this function

delete_skill_authorization(client, input, options \\ [])

View Source

Unlinks a third-party account from a skill.

Link to this function

delete_skill_group(client, input, options \\ [])

View Source

Deletes a skill group by skill group ARN.

Link to this function

delete_user(client, input, options \\ [])

View Source

Deletes a specified user by user ARN and enrollment ARN.

Link to this function

disassociate_contact_from_address_book(client, input, options \\ [])

View Source

Disassociates a contact from a given address book.

Link to this function

disassociate_device_from_room(client, input, options \\ [])

View Source

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.

Link to this function

disassociate_skill_from_skill_group(client, input, options \\ [])

View Source

Disassociates a skill from a skill group.

Link to this function

disassociate_skill_from_users(client, input, options \\ [])

View Source

Makes a private skill unavailable for enrolled users and prevents them from enabling it on their devices.

Link to this function

disassociate_skill_group_from_room(client, input, options \\ [])

View Source

Disassociates a skill group from a specified room.

This disables all skills in the skill group on all devices in the room.

Link to this function

forget_smart_home_appliances(client, input, options \\ [])

View Source

Forgets smart home appliances associated to a room.

Link to this function

get_address_book(client, input, options \\ [])

View Source

Gets address the book details by the address book ARN.

Link to this function

get_conference_preference(client, input, options \\ [])

View Source

Retrieves the existing conference preferences.

Link to this function

get_conference_provider(client, input, options \\ [])

View Source

Gets details about a specific conference provider.

Link to this function

get_contact(client, input, options \\ [])

View Source

Gets the contact details by the contact ARN.

Link to this function

get_device(client, input, options \\ [])

View Source

Gets the details of a device by device ARN.

Link to this function

get_gateway(client, input, options \\ [])

View Source

Retrieves the details of a gateway.

Link to this function

get_gateway_group(client, input, options \\ [])

View Source

Retrieves the details of a gateway group.

Link to this function

get_invitation_configuration(client, input, options \\ [])

View Source

Retrieves the configured values for the user enrollment invitation email template.

Link to this function

get_network_profile(client, input, options \\ [])

View Source

Gets the network profile details by the network profile ARN.

Link to this function

get_profile(client, input, options \\ [])

View Source

Gets the details of a room profile by profile ARN.

Link to this function

get_room(client, input, options \\ [])

View Source

Gets room details by room ARN.

Link to this function

get_room_skill_parameter(client, input, options \\ [])

View Source

Gets room skill parameter details by room, skill, and parameter key ARN.

Link to this function

get_skill_group(client, input, options \\ [])

View Source

Gets skill group details by skill group ARN.

Link to this function

list_business_report_schedules(client, input, options \\ [])

View Source

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.

Link to this function

list_conference_providers(client, input, options \\ [])

View Source

Lists conference providers under a specific AWS account.

Link to this function

list_device_events(client, input, options \\ [])

View Source

Lists the device event history, including device connection status, for up to 30 days.

Link to this function

list_gateway_groups(client, input, options \\ [])

View Source

Retrieves a list of gateway group summaries.

Use GetGatewayGroup to retrieve details of a specific gateway group.

Link to this function

list_gateways(client, input, options \\ [])

View Source

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.

Link to this function

list_skills(client, input, options \\ [])

View Source

Lists all enabled skills in a specific skill group.

Link to this function

list_skills_store_categories(client, input, options \\ [])

View Source

Lists all categories in the Alexa skill store.

Link to this function

list_skills_store_skills_by_category(client, input, options \\ [])

View Source

Lists all skills in the Alexa skill store by category.

Link to this function

list_smart_home_appliances(client, input, options \\ [])

View Source

Lists all of the smart home appliances associated with a room.

Link to this function

list_tags(client, input, options \\ [])

View Source

Lists all tags for the specified resource.

Link to this function

put_conference_preference(client, input, options \\ [])

View Source

Sets the conference preferences on a specific conference provider at the account level.

Link to this function

put_invitation_configuration(client, input, options \\ [])

View Source

Configures the email template for the user enrollment invitation with the specified attributes.

Link to this function

put_room_skill_parameter(client, input, options \\ [])

View Source

Updates room skill parameter details by room, skill, and parameter key ID.

Not all skills have a room skill parameter.

Link to this function

put_skill_authorization(client, input, options \\ [])

View Source

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.

Link to this function

register_avs_device(client, input, options \\ [])

View Source

Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service (AVS).

Link to this function

reject_skill(client, input, options \\ [])

View Source

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.

Link to this function

resolve_room(client, input, options \\ [])

View Source

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.

Link to this function

revoke_invitation(client, input, options \\ [])

View Source

Revokes an invitation and invalidates the enrollment URL.

Link to this function

search_address_books(client, input, options \\ [])

View Source

Searches address books and lists the ones that meet a set of filter and sort criteria.

Link to this function

search_contacts(client, input, options \\ [])

View Source

Searches contacts and lists the ones that meet a set of filter and sort criteria.

Link to this function

search_devices(client, input, options \\ [])

View Source

Searches devices and lists the ones that meet a set of filter criteria.

Link to this function

search_network_profiles(client, input, options \\ [])

View Source

Searches network profiles and lists the ones that meet a set of filter and sort criteria.

Link to this function

search_profiles(client, input, options \\ [])

View Source

Searches room profiles and lists the ones that meet a set of filter criteria.

Link to this function

search_rooms(client, input, options \\ [])

View Source

Searches rooms and lists the ones that meet a set of filter and sort criteria.

Link to this function

search_skill_groups(client, input, options \\ [])

View Source

Searches skill groups and lists the ones that meet a set of filter and sort criteria.

Link to this function

search_users(client, input, options \\ [])

View Source

Searches users and lists the ones that meet a set of filter and sort criteria.

Link to this function

send_announcement(client, input, options \\ [])

View Source

Triggers an asynchronous flow to send text, SSML, or audio announcements to rooms that are identified by a search or filter.

Link to this function

send_invitation(client, input, options \\ [])

View Source

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.

Link to this function

start_device_sync(client, input, options \\ [])

View Source

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

Link to this function

start_smart_home_appliance_discovery(client, input, options \\ [])

View Source

Initiates the discovery of any smart home appliances associated with the room.

Link to this function

tag_resource(client, input, options \\ [])

View Source

Adds metadata tags to a specified resource.

Link to this function

untag_resource(client, input, options \\ [])

View Source

Removes metadata tags from a specified resource.

Link to this function

update_address_book(client, input, options \\ [])

View Source

Updates address book details by the address book ARN.

Link to this function

update_business_report_schedule(client, input, options \\ [])

View Source

Updates the configuration of the report delivery schedule with the specified schedule ARN.

Link to this function

update_conference_provider(client, input, options \\ [])

View Source

Updates an existing conference provider's settings.

Link to this function

update_contact(client, input, options \\ [])

View Source

Updates the contact details by the contact ARN.

Link to this function

update_device(client, input, options \\ [])

View Source

Updates the device name by device ARN.

Link to this function

update_gateway(client, input, options \\ [])

View Source

Updates the details of a gateway.

If any optional field is not provided, the existing corresponding value is left unmodified.

Link to this function

update_gateway_group(client, input, options \\ [])

View Source

Updates the details of a gateway group.

If any optional field is not provided, the existing corresponding value is left unmodified.

Link to this function

update_network_profile(client, input, options \\ [])

View Source

Updates a network profile by the network profile ARN.

Link to this function

update_profile(client, input, options \\ [])

View Source

Updates an existing room profile by room profile ARN.

Link to this function

update_room(client, input, options \\ [])

View Source

Updates room details by room ARN.

Link to this function

update_skill_group(client, input, options \\ [])

View Source

Updates skill group details by skill group ARN.