integrations.sh
← all integrations

amazonaws.com – alexaforbusiness

OpenAPI apis-guru cloud

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.

Homepage
https://api.apis.guru/v2/specs/amazonaws.com:alexaforbusiness/2017-11-09.json
Provider
amazonaws.com:alexaforbusiness / alexaforbusiness
OpenAPI version
3.0.0
Spec (JSON)
https://api.apis.guru/v2/specs/amazonaws.com/alexaforbusiness/2017-11-09/openapi.json
Spec (YAML)
https://api.apis.guru/v2/specs/amazonaws.com/alexaforbusiness/2017-11-09/openapi.yaml

Tools (95)

Extracted live via the executor SDK.

  • xAmzTargetAlexaForBusinessApproveSkill.approveSkill

    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.

  • xAmzTargetAlexaForBusinessAssociateContactWithAddressBook.associateContactWithAddressBook

    Associates a contact with a given address book.

  • xAmzTargetAlexaForBusinessAssociateDeviceWithNetworkProfile.associateDeviceWithNetworkProfile

    Associates a device with the specified network profile.

  • xAmzTargetAlexaForBusinessAssociateDeviceWithRoom.associateDeviceWithRoom

    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.

  • xAmzTargetAlexaForBusinessAssociateSkillGroupWithRoom.associateSkillGroupWithRoom

    Associates a skill group with a given room. This enables all skills in the associated skill group on all devices in the room.

  • xAmzTargetAlexaForBusinessAssociateSkillWithSkillGroup.associateSkillWithSkillGroup

    Associates a skill with a skill group.

  • xAmzTargetAlexaForBusinessAssociateSkillWithUsers.associateSkillWithUsers

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

  • xAmzTargetAlexaForBusinessCreateAddressBook.createAddressBook

    Creates an address book with the specified details.

  • xAmzTargetAlexaForBusinessCreateBusinessReportSchedule.createBusinessReportSchedule

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

  • xAmzTargetAlexaForBusinessCreateConferenceProvider.createConferenceProvider

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

  • xAmzTargetAlexaForBusinessCreateContact.createContact

    Creates a contact with the specified details.

  • xAmzTargetAlexaForBusinessCreateGatewayGroup.createGatewayGroup

    Creates a gateway group with the specified details.

  • xAmzTargetAlexaForBusinessCreateNetworkProfile.createNetworkProfile

    Creates a network profile with the specified details.

  • xAmzTargetAlexaForBusinessCreateProfile.createProfile

    Creates a new room profile with the specified details.

  • xAmzTargetAlexaForBusinessCreateRoom.createRoom

    Creates a room with the specified details.

  • xAmzTargetAlexaForBusinessCreateSkillGroup.createSkillGroup

    Creates a skill group with a specified name and description.

  • xAmzTargetAlexaForBusinessCreateUser.createUser

    Creates a user.

  • xAmzTargetAlexaForBusinessDeleteAddressBook.deleteAddressBook

    Deletes an address book by the address book ARN.

  • xAmzTargetAlexaForBusinessDeleteBusinessReportSchedule.deleteBusinessReportSchedule

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

  • xAmzTargetAlexaForBusinessDeleteConferenceProvider.deleteConferenceProvider

    Deletes a conference provider.

  • xAmzTargetAlexaForBusinessDeleteContact.deleteContact

    Deletes a contact by the contact ARN.

  • xAmzTargetAlexaForBusinessDeleteDevice.deleteDevice

    Removes a device from Alexa For Business.

  • xAmzTargetAlexaForBusinessDeleteDeviceUsageData.deleteDeviceUsageData

    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.

  • xAmzTargetAlexaForBusinessDeleteGatewayGroup.deleteGatewayGroup

    Deletes a gateway group.

  • xAmzTargetAlexaForBusinessDeleteNetworkProfile.deleteNetworkProfile

    Deletes a network profile by the network profile ARN.

  • xAmzTargetAlexaForBusinessDeleteProfile.deleteProfile

    Deletes a room profile by the profile ARN.

  • xAmzTargetAlexaForBusinessDeleteRoom.deleteRoom

    Deletes a room by the room ARN.

  • xAmzTargetAlexaForBusinessDeleteRoomSkillParameter.deleteRoomSkillParameter

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

  • xAmzTargetAlexaForBusinessDeleteSkillAuthorization.deleteSkillAuthorization

    Unlinks a third-party account from a skill.

  • xAmzTargetAlexaForBusinessDeleteSkillGroup.deleteSkillGroup

    Deletes a skill group by skill group ARN.

  • xAmzTargetAlexaForBusinessDeleteUser.deleteUser

    Deletes a specified user by user ARN and enrollment ARN.

  • xAmzTargetAlexaForBusinessDisassociateContactFromAddressBook.disassociateContactFromAddressBook

    Disassociates a contact from a given address book.

  • xAmzTargetAlexaForBusinessDisassociateDeviceFromRoom.disassociateDeviceFromRoom

    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.

  • xAmzTargetAlexaForBusinessDisassociateSkillFromSkillGroup.disassociateSkillFromSkillGroup

    Disassociates a skill from a skill group.

  • xAmzTargetAlexaForBusinessDisassociateSkillFromUsers.disassociateSkillFromUsers

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

  • xAmzTargetAlexaForBusinessDisassociateSkillGroupFromRoom.disassociateSkillGroupFromRoom

    Disassociates a skill group from a specified room. This disables all skills in the skill group on all devices in the room.

  • xAmzTargetAlexaForBusinessForgetSmartHomeAppliances.forgetSmartHomeAppliances

    Forgets smart home appliances associated to a room.

  • xAmzTargetAlexaForBusinessGetAddressBook.getAddressBook

    Gets address the book details by the address book ARN.

  • xAmzTargetAlexaForBusinessGetConferencePreference.getConferencePreference

    Retrieves the existing conference preferences.

  • xAmzTargetAlexaForBusinessGetConferenceProvider.getConferenceProvider

    Gets details about a specific conference provider.

  • xAmzTargetAlexaForBusinessGetContact.getContact

    Gets the contact details by the contact ARN.

  • xAmzTargetAlexaForBusinessGetDevice.getDevice

    Gets the details of a device by device ARN.

  • xAmzTargetAlexaForBusinessGetGateway.getGateway

    Retrieves the details of a gateway.

  • xAmzTargetAlexaForBusinessGetGatewayGroup.getGatewayGroup

    Retrieves the details of a gateway group.

  • xAmzTargetAlexaForBusinessGetInvitationConfiguration.getInvitationConfiguration

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

  • xAmzTargetAlexaForBusinessGetNetworkProfile.getNetworkProfile

    Gets the network profile details by the network profile ARN.

  • xAmzTargetAlexaForBusinessGetProfile.getProfile

    Gets the details of a room profile by profile ARN.

  • xAmzTargetAlexaForBusinessGetRoom.getRoom

    Gets room details by room ARN.

  • xAmzTargetAlexaForBusinessGetRoomSkillParameter.getRoomSkillParameter

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

  • xAmzTargetAlexaForBusinessGetSkillGroup.getSkillGroup

    Gets skill group details by skill group ARN.

  • xAmzTargetAlexaForBusinessListBusinessReportSchedules.listBusinessReportSchedules

    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.

  • xAmzTargetAlexaForBusinessListConferenceProviders.listConferenceProviders

    Lists conference providers under a specific AWS account.

  • xAmzTargetAlexaForBusinessListDeviceEvents.listDeviceEvents

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

  • xAmzTargetAlexaForBusinessListGatewayGroups.listGatewayGroups

    Retrieves a list of gateway group summaries. Use GetGatewayGroup to retrieve details of a specific gateway group.

  • xAmzTargetAlexaForBusinessListGateways.listGateways

    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.

  • xAmzTargetAlexaForBusinessListSkills.listSkills

    Lists all enabled skills in a specific skill group.

  • xAmzTargetAlexaForBusinessListSkillsStoreCategories.listSkillsStoreCategories

    Lists all categories in the Alexa skill store.

  • xAmzTargetAlexaForBusinessListSkillsStoreSkillsByCategory.listSkillsStoreSkillsByCategory

    Lists all skills in the Alexa skill store by category.

  • xAmzTargetAlexaForBusinessListSmartHomeAppliances.listSmartHomeAppliances

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

  • xAmzTargetAlexaForBusinessListTags.listTags

    Lists all tags for the specified resource.

  • xAmzTargetAlexaForBusinessPutConferencePreference.putConferencePreference

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

  • xAmzTargetAlexaForBusinessPutInvitationConfiguration.putInvitationConfiguration

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

  • xAmzTargetAlexaForBusinessPutRoomSkillParameter.putRoomSkillParameter

    Updates room skill parameter details by room, skill, and parameter key ID. Not all skills have a room skill parameter.

  • xAmzTargetAlexaForBusinessPutSkillAuthorization.putSkillAuthorization

    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.

  • xAmzTargetAlexaForBusinessRegisterAvsDevice.registerAvsDevice

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

  • xAmzTargetAlexaForBusinessRejectSkill.rejectSkill

    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.

  • xAmzTargetAlexaForBusinessResolveRoom.resolveRoom

    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.

  • xAmzTargetAlexaForBusinessRevokeInvitation.revokeInvitation

    Revokes an invitation and invalidates the enrollment URL.

  • xAmzTargetAlexaForBusinessSearchAddressBooks.searchAddressBooks

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

  • xAmzTargetAlexaForBusinessSearchContacts.searchContacts

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

  • xAmzTargetAlexaForBusinessSearchDevices.searchDevices

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

  • xAmzTargetAlexaForBusinessSearchNetworkProfiles.searchNetworkProfiles

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

  • xAmzTargetAlexaForBusinessSearchProfiles.searchProfiles

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

  • xAmzTargetAlexaForBusinessSearchRooms.searchRooms

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

  • xAmzTargetAlexaForBusinessSearchSkillGroups.searchSkillGroups

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

  • xAmzTargetAlexaForBusinessSearchUsers.searchUsers

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

  • xAmzTargetAlexaForBusinessSendAnnouncement.sendAnnouncement

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

  • xAmzTargetAlexaForBusinessSendInvitation.sendInvitation

    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.

  • xAmzTargetAlexaForBusinessStartDeviceSync.startDeviceSync

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

  • xAmzTargetAlexaForBusinessStartSmartHomeApplianceDiscovery.startSmartHomeApplianceDiscovery

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

  • xAmzTargetAlexaForBusinessTagResource.tagResource

    Adds metadata tags to a specified resource.

  • xAmzTargetAlexaForBusinessUntagResource.untagResource

    Removes metadata tags from a specified resource.

  • xAmzTargetAlexaForBusinessUpdateAddressBook.updateAddressBook

    Updates address book details by the address book ARN.

  • xAmzTargetAlexaForBusinessUpdateBusinessReportSchedule.updateBusinessReportSchedule

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

  • xAmzTargetAlexaForBusinessUpdateConferenceProvider.updateConferenceProvider

    Updates an existing conference provider's settings.

  • xAmzTargetAlexaForBusinessUpdateContact.updateContact

    Updates the contact details by the contact ARN.

  • xAmzTargetAlexaForBusinessUpdateDevice.updateDevice

    Updates the device name by device ARN.

  • xAmzTargetAlexaForBusinessUpdateGateway.updateGateway

    Updates the details of a gateway. If any optional field is not provided, the existing corresponding value is left unmodified.

  • xAmzTargetAlexaForBusinessUpdateGatewayGroup.updateGatewayGroup

    Updates the details of a gateway group. If any optional field is not provided, the existing corresponding value is left unmodified.

  • xAmzTargetAlexaForBusinessUpdateNetworkProfile.updateNetworkProfile

    Updates a network profile by the network profile ARN.

  • xAmzTargetAlexaForBusinessUpdateProfile.updateProfile

    Updates an existing room profile by room profile ARN.

  • xAmzTargetAlexaForBusinessUpdateRoom.updateRoom

    Updates room details by room ARN.

  • xAmzTargetAlexaForBusinessUpdateSkillGroup.updateSkillGroup

    Updates skill group details by skill group ARN.

  • openapi.previewSpec

    Preview an OpenAPI document before adding it as a source

  • openapi.addSource

    Add an OpenAPI source and register its operations as tools