AmazonAlexaForBusiness (AWS SDK for Java

All Known Subinterfaces:

AmazonAlexaForBusinessAsync

All Known Implementing Classes:

AbstractAmazonAlexaForBusiness, AbstractAmazonAlexaForBusinessAsync, AmazonAlexaForBusinessAsyncClient, AmazonAlexaForBusinessClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonAlexaForBusiness
```
Interface for accessing Alexa For Business.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonAlexaForBusiness instead.

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.

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`ApproveSkillResult`	`approveSkill(ApproveSkillRequest approveSkillRequest)` Associates a skill with the organization under the customer's AWS account.
`AssociateContactWithAddressBookResult`	`associateContactWithAddressBook(AssociateContactWithAddressBookRequest associateContactWithAddressBookRequest)` Associates a contact with a given address book.
`AssociateDeviceWithNetworkProfileResult`	`associateDeviceWithNetworkProfile(AssociateDeviceWithNetworkProfileRequest associateDeviceWithNetworkProfileRequest)` Associates a device with the specified network profile.
`AssociateDeviceWithRoomResult`	`associateDeviceWithRoom(AssociateDeviceWithRoomRequest associateDeviceWithRoomRequest)` Associates a device with a given room.
`AssociateSkillGroupWithRoomResult`	`associateSkillGroupWithRoom(AssociateSkillGroupWithRoomRequest associateSkillGroupWithRoomRequest)` Associates a skill group with a given room.
`AssociateSkillWithSkillGroupResult`	`associateSkillWithSkillGroup(AssociateSkillWithSkillGroupRequest associateSkillWithSkillGroupRequest)` Associates a skill with a skill group.
`AssociateSkillWithUsersResult`	`associateSkillWithUsers(AssociateSkillWithUsersRequest associateSkillWithUsersRequest)` Makes a private skill available for enrolled users to enable on their devices.
`CreateAddressBookResult`	`createAddressBook(CreateAddressBookRequest createAddressBookRequest)` Creates an address book with the specified details.
`CreateBusinessReportScheduleResult`	`createBusinessReportSchedule(CreateBusinessReportScheduleRequest createBusinessReportScheduleRequest)` Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or weekly interval.
`CreateConferenceProviderResult`	`createConferenceProvider(CreateConferenceProviderRequest createConferenceProviderRequest)` Adds a new conference provider under the user's AWS account.
`CreateContactResult`	`createContact(CreateContactRequest createContactRequest)` Creates a contact with the specified details.
`CreateGatewayGroupResult`	`createGatewayGroup(CreateGatewayGroupRequest createGatewayGroupRequest)` Creates a gateway group with the specified details.
`CreateNetworkProfileResult`	`createNetworkProfile(CreateNetworkProfileRequest createNetworkProfileRequest)` Creates a network profile with the specified details.
`CreateProfileResult`	`createProfile(CreateProfileRequest createProfileRequest)` Creates a new room profile with the specified details.
`CreateRoomResult`	`createRoom(CreateRoomRequest createRoomRequest)` Creates a room with the specified details.
`CreateSkillGroupResult`	`createSkillGroup(CreateSkillGroupRequest createSkillGroupRequest)` Creates a skill group with a specified name and description.
`CreateUserResult`	`createUser(CreateUserRequest createUserRequest)` Creates a user.
`DeleteAddressBookResult`	`deleteAddressBook(DeleteAddressBookRequest deleteAddressBookRequest)` Deletes an address book by the address book ARN.
`DeleteBusinessReportScheduleResult`	`deleteBusinessReportSchedule(DeleteBusinessReportScheduleRequest deleteBusinessReportScheduleRequest)` Deletes the recurring report delivery schedule with the specified schedule ARN.
`DeleteConferenceProviderResult`	`deleteConferenceProvider(DeleteConferenceProviderRequest deleteConferenceProviderRequest)` Deletes a conference provider.
`DeleteContactResult`	`deleteContact(DeleteContactRequest deleteContactRequest)` Deletes a contact by the contact ARN.
`DeleteDeviceResult`	`deleteDevice(DeleteDeviceRequest deleteDeviceRequest)` Removes a device from Alexa For Business.
`DeleteDeviceUsageDataResult`	`deleteDeviceUsageData(DeleteDeviceUsageDataRequest deleteDeviceUsageDataRequest)` 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.
`DeleteGatewayGroupResult`	`deleteGatewayGroup(DeleteGatewayGroupRequest deleteGatewayGroupRequest)` Deletes a gateway group.
`DeleteNetworkProfileResult`	`deleteNetworkProfile(DeleteNetworkProfileRequest deleteNetworkProfileRequest)` Deletes a network profile by the network profile ARN.
`DeleteProfileResult`	`deleteProfile(DeleteProfileRequest deleteProfileRequest)` Deletes a room profile by the profile ARN.
`DeleteRoomResult`	`deleteRoom(DeleteRoomRequest deleteRoomRequest)` Deletes a room by the room ARN.
`DeleteRoomSkillParameterResult`	`deleteRoomSkillParameter(DeleteRoomSkillParameterRequest deleteRoomSkillParameterRequest)` Deletes room skill parameter details by room, skill, and parameter key ID.
`DeleteSkillAuthorizationResult`	`deleteSkillAuthorization(DeleteSkillAuthorizationRequest deleteSkillAuthorizationRequest)` Unlinks a third-party account from a skill.
`DeleteSkillGroupResult`	`deleteSkillGroup(DeleteSkillGroupRequest deleteSkillGroupRequest)` Deletes a skill group by skill group ARN.
`DeleteUserResult`	`deleteUser(DeleteUserRequest deleteUserRequest)` Deletes a specified user by user ARN and enrollment ARN.
`DisassociateContactFromAddressBookResult`	`disassociateContactFromAddressBook(DisassociateContactFromAddressBookRequest disassociateContactFromAddressBookRequest)` Disassociates a contact from a given address book.
`DisassociateDeviceFromRoomResult`	`disassociateDeviceFromRoom(DisassociateDeviceFromRoomRequest disassociateDeviceFromRoomRequest)` Disassociates a device from its current room.
`DisassociateSkillFromSkillGroupResult`	`disassociateSkillFromSkillGroup(DisassociateSkillFromSkillGroupRequest disassociateSkillFromSkillGroupRequest)` Disassociates a skill from a skill group.
`DisassociateSkillFromUsersResult`	`disassociateSkillFromUsers(DisassociateSkillFromUsersRequest disassociateSkillFromUsersRequest)` Makes a private skill unavailable for enrolled users and prevents them from enabling it on their devices.
`DisassociateSkillGroupFromRoomResult`	`disassociateSkillGroupFromRoom(DisassociateSkillGroupFromRoomRequest disassociateSkillGroupFromRoomRequest)` Disassociates a skill group from a specified room.
`ForgetSmartHomeAppliancesResult`	`forgetSmartHomeAppliances(ForgetSmartHomeAppliancesRequest forgetSmartHomeAppliancesRequest)` Forgets smart home appliances associated to a room.
`GetAddressBookResult`	`getAddressBook(GetAddressBookRequest getAddressBookRequest)` Gets address the book details by the address book ARN.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetConferencePreferenceResult`	`getConferencePreference(GetConferencePreferenceRequest getConferencePreferenceRequest)` Retrieves the existing conference preferences.
`GetConferenceProviderResult`	`getConferenceProvider(GetConferenceProviderRequest getConferenceProviderRequest)` Gets details about a specific conference provider.
`GetContactResult`	`getContact(GetContactRequest getContactRequest)` Gets the contact details by the contact ARN.
`GetDeviceResult`	`getDevice(GetDeviceRequest getDeviceRequest)` Gets the details of a device by device ARN.
`GetGatewayResult`	`getGateway(GetGatewayRequest getGatewayRequest)` Retrieves the details of a gateway.
`GetGatewayGroupResult`	`getGatewayGroup(GetGatewayGroupRequest getGatewayGroupRequest)` Retrieves the details of a gateway group.
`GetInvitationConfigurationResult`	`getInvitationConfiguration(GetInvitationConfigurationRequest getInvitationConfigurationRequest)` Retrieves the configured values for the user enrollment invitation email template.
`GetNetworkProfileResult`	`getNetworkProfile(GetNetworkProfileRequest getNetworkProfileRequest)` Gets the network profile details by the network profile ARN.
`GetProfileResult`	`getProfile(GetProfileRequest getProfileRequest)` Gets the details of a room profile by profile ARN.
`GetRoomResult`	`getRoom(GetRoomRequest getRoomRequest)` Gets room details by room ARN.
`GetRoomSkillParameterResult`	`getRoomSkillParameter(GetRoomSkillParameterRequest getRoomSkillParameterRequest)` Gets room skill parameter details by room, skill, and parameter key ARN.
`GetSkillGroupResult`	`getSkillGroup(GetSkillGroupRequest getSkillGroupRequest)` Gets skill group details by skill group ARN.
`ListBusinessReportSchedulesResult`	`listBusinessReportSchedules(ListBusinessReportSchedulesRequest listBusinessReportSchedulesRequest)` Lists the details of the schedules that a user configured.
`ListConferenceProvidersResult`	`listConferenceProviders(ListConferenceProvidersRequest listConferenceProvidersRequest)` Lists conference providers under a specific AWS account.
`ListDeviceEventsResult`	`listDeviceEvents(ListDeviceEventsRequest listDeviceEventsRequest)` Lists the device event history, including device connection status, for up to 30 days.
`ListGatewayGroupsResult`	`listGatewayGroups(ListGatewayGroupsRequest listGatewayGroupsRequest)` Retrieves a list of gateway group summaries.
`ListGatewaysResult`	`listGateways(ListGatewaysRequest listGatewaysRequest)` Retrieves a list of gateway summaries.
`ListSkillsResult`	`listSkills(ListSkillsRequest listSkillsRequest)` Lists all enabled skills in a specific skill group.
`ListSkillsStoreCategoriesResult`	`listSkillsStoreCategories(ListSkillsStoreCategoriesRequest listSkillsStoreCategoriesRequest)` Lists all categories in the Alexa skill store.
`ListSkillsStoreSkillsByCategoryResult`	`listSkillsStoreSkillsByCategory(ListSkillsStoreSkillsByCategoryRequest listSkillsStoreSkillsByCategoryRequest)` Lists all skills in the Alexa skill store by category.
`ListSmartHomeAppliancesResult`	`listSmartHomeAppliances(ListSmartHomeAppliancesRequest listSmartHomeAppliancesRequest)` Lists all of the smart home appliances associated with a room.
`ListTagsResult`	`listTags(ListTagsRequest listTagsRequest)` Lists all tags for the specified resource.
`PutConferencePreferenceResult`	`putConferencePreference(PutConferencePreferenceRequest putConferencePreferenceRequest)` Sets the conference preferences on a specific conference provider at the account level.
`PutInvitationConfigurationResult`	`putInvitationConfiguration(PutInvitationConfigurationRequest putInvitationConfigurationRequest)` Configures the email template for the user enrollment invitation with the specified attributes.
`PutRoomSkillParameterResult`	`putRoomSkillParameter(PutRoomSkillParameterRequest putRoomSkillParameterRequest)` Updates room skill parameter details by room, skill, and parameter key ID.
`PutSkillAuthorizationResult`	`putSkillAuthorization(PutSkillAuthorizationRequest putSkillAuthorizationRequest)` Links a user's account to a third-party skill provider.
`RegisterAVSDeviceResult`	`registerAVSDevice(RegisterAVSDeviceRequest registerAVSDeviceRequest)` Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service (AVS).
`RejectSkillResult`	`rejectSkill(RejectSkillRequest rejectSkillRequest)` Disassociates a skill from the organization under a user's AWS account.
`ResolveRoomResult`	`resolveRoom(ResolveRoomRequest resolveRoomRequest)` Determines the details for the room from which a skill request was invoked.
`RevokeInvitationResult`	`revokeInvitation(RevokeInvitationRequest revokeInvitationRequest)` Revokes an invitation and invalidates the enrollment URL.
`SearchAddressBooksResult`	`searchAddressBooks(SearchAddressBooksRequest searchAddressBooksRequest)` Searches address books and lists the ones that meet a set of filter and sort criteria.
`SearchContactsResult`	`searchContacts(SearchContactsRequest searchContactsRequest)` Searches contacts and lists the ones that meet a set of filter and sort criteria.
`SearchDevicesResult`	`searchDevices(SearchDevicesRequest searchDevicesRequest)` Searches devices and lists the ones that meet a set of filter criteria.
`SearchNetworkProfilesResult`	`searchNetworkProfiles(SearchNetworkProfilesRequest searchNetworkProfilesRequest)` Searches network profiles and lists the ones that meet a set of filter and sort criteria.
`SearchProfilesResult`	`searchProfiles(SearchProfilesRequest searchProfilesRequest)` Searches room profiles and lists the ones that meet a set of filter criteria.
`SearchRoomsResult`	`searchRooms(SearchRoomsRequest searchRoomsRequest)` Searches rooms and lists the ones that meet a set of filter and sort criteria.
`SearchSkillGroupsResult`	`searchSkillGroups(SearchSkillGroupsRequest searchSkillGroupsRequest)` Searches skill groups and lists the ones that meet a set of filter and sort criteria.
`SearchUsersResult`	`searchUsers(SearchUsersRequest searchUsersRequest)` Searches users and lists the ones that meet a set of filter and sort criteria.
`SendAnnouncementResult`	`sendAnnouncement(SendAnnouncementRequest sendAnnouncementRequest)` Triggers an asynchronous flow to send text, SSML, or audio announcements to rooms that are identified by a search or filter.
`SendInvitationResult`	`sendInvitation(SendInvitationRequest sendInvitationRequest)` Sends an enrollment invitation email with a URL to a user.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartDeviceSyncResult`	`startDeviceSync(StartDeviceSyncRequest startDeviceSyncRequest)` Resets a device and its account to the known default settings.
`StartSmartHomeApplianceDiscoveryResult`	`startSmartHomeApplianceDiscovery(StartSmartHomeApplianceDiscoveryRequest startSmartHomeApplianceDiscoveryRequest)` Initiates the discovery of any smart home appliances associated with the room.
`TagResourceResult`	`tagResource(TagResourceRequest tagResourceRequest)` Adds metadata tags to a specified resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest untagResourceRequest)` Removes metadata tags from a specified resource.
`UpdateAddressBookResult`	`updateAddressBook(UpdateAddressBookRequest updateAddressBookRequest)` Updates address book details by the address book ARN.
`UpdateBusinessReportScheduleResult`	`updateBusinessReportSchedule(UpdateBusinessReportScheduleRequest updateBusinessReportScheduleRequest)` Updates the configuration of the report delivery schedule with the specified schedule ARN.
`UpdateConferenceProviderResult`	`updateConferenceProvider(UpdateConferenceProviderRequest updateConferenceProviderRequest)` Updates an existing conference provider's settings.
`UpdateContactResult`	`updateContact(UpdateContactRequest updateContactRequest)` Updates the contact details by the contact ARN.
`UpdateDeviceResult`	`updateDevice(UpdateDeviceRequest updateDeviceRequest)` Updates the device name by device ARN.
`UpdateGatewayResult`	`updateGateway(UpdateGatewayRequest updateGatewayRequest)` Updates the details of a gateway.
`UpdateGatewayGroupResult`	`updateGatewayGroup(UpdateGatewayGroupRequest updateGatewayGroupRequest)` Updates the details of a gateway group.
`UpdateNetworkProfileResult`	`updateNetworkProfile(UpdateNetworkProfileRequest updateNetworkProfileRequest)` Updates a network profile by the network profile ARN.
`UpdateProfileResult`	`updateProfile(UpdateProfileRequest updateProfileRequest)` Updates an existing room profile by room profile ARN.
`UpdateRoomResult`	`updateRoom(UpdateRoomRequest updateRoomRequest)` Updates room details by room ARN.
`UpdateSkillGroupResult`	`updateSkillGroup(UpdateSkillGroupRequest updateSkillGroupRequest)` Updates skill group details by skill group ARN.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - approveSkill
```
ApproveSkillResult approveSkill(ApproveSkillRequest approveSkillRequest)
```
    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.
    
    Parameters:
    
    approveSkillRequest -
    
    Returns:
    
    Result of the ApproveSkill operation returned by the service.
    
    Throws:
    
    LimitExceededException - You are performing an action that would put you beyond your account's limits.
    
    NotFoundException - The resource is not found.
    
    ConcurrentModificationException - There is a concurrent modification of resources.
    
    See Also:
    
    AWS API Documentation
  - associateContactWithAddressBook
```
AssociateContactWithAddressBookResult associateContactWithAddressBook(AssociateContactWithAddressBookRequest associateContactWithAddressBookRequest)
```
    Associates a contact with a given address book.
    
    Parameters:
    
    associateContactWithAddressBookRequest -
    
    Returns:
    
    Result of the AssociateContactWithAddressBook operation returned by the service.
    
    Throws:
    
    LimitExceededException - You are performing an action that would put you beyond your account's limits.
    
    See Also:
    
    AWS API Documentation
  - associateDeviceWithNetworkProfile
```
AssociateDeviceWithNetworkProfileResult associateDeviceWithNetworkProfile(AssociateDeviceWithNetworkProfileRequest associateDeviceWithNetworkProfileRequest)
```
    Associates a device with the specified network profile.
    
    Parameters:
    
    associateDeviceWithNetworkProfileRequest -
    
    Returns:
    
    Result of the AssociateDeviceWithNetworkProfile operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource is not found.
    
    ConcurrentModificationException - There is a concurrent modification of resources.
    
    DeviceNotRegisteredException - The request failed because this device is no longer registered and therefore no longer managed by this account.
    
    See Also:
    
    AWS API Documentation
  - associateDeviceWithRoom
```
AssociateDeviceWithRoomResult associateDeviceWithRoom(AssociateDeviceWithRoomRequest associateDeviceWithRoomRequest)
```
    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.
    
    Parameters:
    
    associateDeviceWithRoomRequest -
    
    Returns:
    
    Result of the AssociateDeviceWithRoom operation returned by the service.
    
    Throws:
    
    LimitExceededException - You are performing an action that would put you beyond your account's limits.
    
    ConcurrentModificationException - There is a concurrent modification of resources.
    
    DeviceNotRegisteredException - The request failed because this device is no longer registered and therefore no longer managed by this account.
    
    See Also:
    
    AWS API Documentation
  - associateSkillGroupWithRoom
```
AssociateSkillGroupWithRoomResult associateSkillGroupWithRoom(AssociateSkillGroupWithRoomRequest associateSkillGroupWithRoomRequest)
```
    Associates a skill group with a given room. This enables all skills in the associated skill group on all devices in the room.
    
    Parameters:
    
    associateSkillGroupWithRoomRequest -
    
    Returns:
    
    Result of the AssociateSkillGroupWithRoom operation returned by the service.
    
    Throws:
    
    ConcurrentModificationException - There is a concurrent modification of resources.
    
    See Also:
    
    AWS API Documentation
  - associateSkillWithSkillGroup
```
AssociateSkillWithSkillGroupResult associateSkillWithSkillGroup(AssociateSkillWithSkillGroupRequest associateSkillWithSkillGroupRequest)
```
    Associates a skill with a skill group.
    
    Parameters:
    
    associateSkillWithSkillGroupRequest -
    
    Returns:
    
    Result of the AssociateSkillWithSkillGroup operation returned by the service.
    
    Throws:
    
    ConcurrentModificationException - There is a concurrent modification of resources.
    
    NotFoundException - The resource is not found.
    
    SkillNotLinkedException - The skill must be linked to a third-party account.
    
    See Also:
    
    AWS API Documentation
  - associateSkillWithUsers
```
AssociateSkillWithUsersResult associateSkillWithUsers(AssociateSkillWithUsersRequest associateSkillWithUsersRequest)
```
    Makes a private skill available for enrolled users to enable on their devices.
    
    Parameters:
    
    associateSkillWithUsersRequest -
    
    Returns:
    
    Result of the AssociateSkillWithUsers operation returned by the service.
    
    Throws:
    
    ConcurrentModificationException - There is a concurrent modification of resources.
    
    NotFoundException - The resource is not found.
    
    See Also:
    
    AWS API Documentation
  - createAddressBook
```
CreateAddressBookResult createAddressBook(CreateAddressBookRequest createAddressBookRequest)
```
    Creates an address book with the specified details.
    
    Parameters:
    
    createAddressBookRequest -
    
    Returns:
    
    Result of the CreateAddressBook operation returned by the service.
    
    Throws:
    
    AlreadyExistsException - The resource being created already exists.
    
    LimitExceededException - You are performing an action that would put you beyond your account's limits.
    
    See Also:
    
    AWS API Documentation
  - createBusinessReportSchedule
```
CreateBusinessReportScheduleResult createBusinessReportSchedule(CreateBusinessReportScheduleRequest createBusinessReportScheduleRequest)
```
    Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or weekly interval.
    
    Parameters:
    
    createBusinessReportScheduleRequest -
    
    Returns:
    
    Result of the CreateBusinessReportSchedule operation returned by the service.
    
    Throws:
    
    AlreadyExistsException - The resource being created already exists.
    
    See Also:
    
    AWS API Documentation
  - createConferenceProvider
```
CreateConferenceProviderResult createConferenceProvider(CreateConferenceProviderRequest createConferenceProviderRequest)
```
    Adds a new conference provider under the user's AWS account.
    
    Parameters:
    
    createConferenceProviderRequest -
    
    Returns:
    
    Result of the CreateConferenceProvider operation returned by the service.
    
    Throws:
    
    AlreadyExistsException - The resource being created already exists.
    
    See Also:
    
    AWS API Documentation
  - createContact
```
CreateContactResult createContact(CreateContactRequest createContactRequest)
```
    Creates a contact with the specified details.
    
    Parameters:
    
    createContactRequest -
    
    Returns:
    
    Result of the CreateContact operation returned by the service.
    
    Throws:
    
    AlreadyExistsException - The resource being created already exists.
    
    LimitExceededException - You are performing an action that would put you beyond your account's limits.
    
    See Also:
    
    AWS API Documentation
  - createGatewayGroup
```
CreateGatewayGroupResult createGatewayGroup(CreateGatewayGroupRequest createGatewayGroupRequest)
```
    Creates a gateway group with the specified details.
    
    Parameters:
    
    createGatewayGroupRequest -
    
    Returns:
    
    Result of the CreateGatewayGroup operation returned by the service.
    
    Throws:
    
    AlreadyExistsException - The resource being created already exists.
    
    LimitExceededException - You are performing an action that would put you beyond your account's limits.
    
    See Also:
    
    AWS API Documentation
  - createNetworkProfile
```
CreateNetworkProfileResult createNetworkProfile(CreateNetworkProfileRequest createNetworkProfileRequest)
```
    Creates a network profile with the specified details.
    
    Parameters:
    
    createNetworkProfileRequest -
    
    Returns:
    
    Result of the CreateNetworkProfile operation returned by the service.
    
    Throws:
    
    AlreadyExistsException - The resource being created already exists.
    
    LimitExceededException - You are performing an action that would put you beyond your account's limits.
    
    ConcurrentModificationException - There is a concurrent modification of resources.
    
    InvalidCertificateAuthorityException - The Certificate Authority can't issue or revoke a certificate.
    
    InvalidServiceLinkedRoleStateException - The service linked role is locked for deletion.
    
    See Also:
    
    AWS API Documentation
  - createProfile
```
CreateProfileResult createProfile(CreateProfileRequest createProfileRequest)
```
    Creates a new room profile with the specified details.
    
    Parameters:
    
    createProfileRequest -
    
    Returns:
    
    Result of the CreateProfile operation returned by the service.
    
    Throws:
    
    LimitExceededException - You are performing an action that would put you beyond your account's limits.
    
    AlreadyExistsException - The resource being created already exists.
    
    ConcurrentModificationException - There is a concurrent modification of resources.
    
    See Also:
    
    AWS API Documentation
  - createRoom
```
CreateRoomResult createRoom(CreateRoomRequest createRoomRequest)
```
    Creates a room with the specified details.
    
    Parameters:
    
    createRoomRequest -
    
    Returns:
    
    Result of the CreateRoom operation returned by the service.
    
    Throws:
    
    AlreadyExistsException - The resource being created already exists.
    
    LimitExceededException - You are performing an action that would put you beyond your account's limits.
    
    See Also:
    
    AWS API Documentation
  - createSkillGroup
```
CreateSkillGroupResult createSkillGroup(CreateSkillGroupRequest createSkillGroupRequest)
```
    Creates a skill group with a specified name and description.
    
    Parameters:
    
    createSkillGroupRequest -
    
    Returns:
    
    Result of the CreateSkillGroup operation returned by the service.
    
    Throws:
    
    AlreadyExistsException - The resource being created already exists.
    
    LimitExceededException - You are performing an action that would put you beyond your account's limits.
    
    ConcurrentModificationException - There is a concurrent modification of resources.
    
    See Also:
    
    AWS API Documentation
  - createUser
```
CreateUserResult createUser(CreateUserRequest createUserRequest)
```
    Creates a user.
    
    Parameters:
    
    createUserRequest -
    
    Returns:
    
    Result of the CreateUser operation returned by the service.
    
    Throws:
    
    ResourceInUseException - The resource in the request is already in use.
    
    LimitExceededException - You are performing an action that would put you beyond your account's limits.
    
    ConcurrentModificationException - There is a concurrent modification of resources.
    
    See Also:
    
    AWS API Documentation
  - deleteAddressBook
```
DeleteAddressBookResult deleteAddressBook(DeleteAddressBookRequest deleteAddressBookRequest)
```
    Deletes an address book by the address book ARN.
    
    Parameters:
    
    deleteAddressBookRequest -
    
    Returns:
    
    Result of the DeleteAddressBook operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource is not found.
    
    ConcurrentModificationException - There is a concurrent modification of resources.
    
    See Also:
    
    AWS API Documentation
  - deleteBusinessReportSchedule
```
DeleteBusinessReportScheduleResult deleteBusinessReportSchedule(DeleteBusinessReportScheduleRequest deleteBusinessReportScheduleRequest)
```
    Deletes the recurring report delivery schedule with the specified schedule ARN.
    
    Parameters:
    
    deleteBusinessReportScheduleRequest -
    
    Returns:
    
    Result of the DeleteBusinessReportSchedule operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource is not found.
    
    ConcurrentModificationException - There is a concurrent modification of resources.
    
    See Also:
    
    AWS API Documentation
  - deleteConferenceProvider
```
DeleteConferenceProviderResult deleteConferenceProvider(DeleteConferenceProviderRequest deleteConferenceProviderRequest)
```
    Deletes a conference provider.
    
    Parameters:
    
    deleteConferenceProviderRequest -
    
    Returns:
    
    Result of the DeleteConferenceProvider operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource is not found.
    
    See Also:
    
    AWS API Documentation
  - deleteContact
```
DeleteContactResult deleteContact(DeleteContactRequest deleteContactRequest)
```
    Deletes a contact by the contact ARN.
    
    Parameters:
    
    deleteContactRequest -
    
    Returns:
    
    Result of the DeleteContact operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource is not found.
    
    ConcurrentModificationException - There is a concurrent modification of resources.
    
    See Also:
    
    AWS API Documentation
  - deleteDevice
```
DeleteDeviceResult deleteDevice(DeleteDeviceRequest deleteDeviceRequest)
```
    Removes a device from Alexa For Business.
    
    Parameters:
    
    deleteDeviceRequest -
    
    Returns:
    
    Result of the DeleteDevice operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource is not found.
    
    ConcurrentModificationException - There is a concurrent modification of resources.
    
    InvalidCertificateAuthorityException - The Certificate Authority can't issue or revoke a certificate.
    
    See Also:
    
    AWS API Documentation
  - deleteDeviceUsageData
```
DeleteDeviceUsageDataResult deleteDeviceUsageData(DeleteDeviceUsageDataRequest deleteDeviceUsageDataRequest)
```
    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.
    
    Parameters:
    
    deleteDeviceUsageDataRequest -
    
    Returns:
    
    Result of the DeleteDeviceUsageData operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource is not found.
    
    DeviceNotRegisteredException - The request failed because this device is no longer registered and therefore no longer managed by this account.
    
    LimitExceededException - You are performing an action that would put you beyond your account's limits.
    
    See Also:
    
    AWS API Documentation
  - deleteGatewayGroup
```
DeleteGatewayGroupResult deleteGatewayGroup(DeleteGatewayGroupRequest deleteGatewayGroupRequest)
```
    Deletes a gateway group.
    
    Parameters:
    
    deleteGatewayGroupRequest -
    
    Returns:
    
    Result of the DeleteGatewayGroup operation returned by the service.
    
    Throws:
    
    ResourceAssociatedException - Another resource is associated with the resource in the request.
    
    See Also:
    
    AWS API Documentation
  - deleteNetworkProfile
```
DeleteNetworkProfileResult deleteNetworkProfile(DeleteNetworkProfileRequest deleteNetworkProfileRequest)
```
    Deletes a network profile by the network profile ARN.
    
    Parameters:
    
    deleteNetworkProfileRequest -
    
    Returns:
    
    Result of the DeleteNetworkProfile operation returned by the service.
    
    Throws:
    
    ResourceInUseException - The resource in the request is already in use.
    
    ConcurrentModificationException - There is a concurrent modification of resources.
    
    NotFoundException - The resource is not found.
    
    See Also:
    
    AWS API Documentation
  - deleteProfile
```
DeleteProfileResult deleteProfile(DeleteProfileRequest deleteProfileRequest)
```
    Deletes a room profile by the profile ARN.
    
    Parameters:
    
    deleteProfileRequest -
    
    Returns:
    
    Result of the DeleteProfile operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource is not found.
    
    ConcurrentModificationException - There is a concurrent modification of resources.
    
    See Also:
    
    AWS API Documentation
  - deleteRoom
```
DeleteRoomResult deleteRoom(DeleteRoomRequest deleteRoomRequest)
```
    Deletes a room by the room ARN.
    
    Parameters:
    
    deleteRoomRequest -
    
    Returns:
    
    Result of the DeleteRoom operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource is not found.
    
    ConcurrentModificationException - There is a concurrent modification of resources.
    
    See Also:
    
    AWS API Documentation
  - deleteRoomSkillParameter
```
DeleteRoomSkillParameterResult deleteRoomSkillParameter(DeleteRoomSkillParameterRequest deleteRoomSkillParameterRequest)
```
    Deletes room skill parameter details by room, skill, and parameter key ID.
    
    Parameters:
    
    deleteRoomSkillParameterRequest -
    
    Returns:
    
    Result of the DeleteRoomSkillParameter operation returned by the service.
    
    Throws:
    
    ConcurrentModificationException - There is a concurrent modification of resources.
    
    See Also:
    
    AWS API Documentation
  - deleteSkillAuthorization
```
DeleteSkillAuthorizationResult deleteSkillAuthorization(DeleteSkillAuthorizationRequest deleteSkillAuthorizationRequest)
```
    Unlinks a third-party account from a skill.
    
    Parameters:
    
    deleteSkillAuthorizationRequest -
    
    Returns:
    
    Result of the DeleteSkillAuthorization operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource is not found.
    
    ConcurrentModificationException - There is a concurrent modification of resources.
    
    See Also:
    
    AWS API Documentation
  - deleteSkillGroup
```
DeleteSkillGroupResult deleteSkillGroup(DeleteSkillGroupRequest deleteSkillGroupRequest)
```
    Deletes a skill group by skill group ARN.
    
    Parameters:
    
    deleteSkillGroupRequest -
    
    Returns:
    
    Result of the DeleteSkillGroup operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource is not found.
    
    ConcurrentModificationException - There is a concurrent modification of resources.
    
    See Also:
    
    AWS API Documentation
  - deleteUser
```
DeleteUserResult deleteUser(DeleteUserRequest deleteUserRequest)
```
    Deletes a specified user by user ARN and enrollment ARN.
    
    Parameters:
    
    deleteUserRequest -
    
    Returns:
    
    Result of the DeleteUser operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource is not found.
    
    ConcurrentModificationException - There is a concurrent modification of resources.
    
    See Also:
    
    AWS API Documentation
  - disassociateContactFromAddressBook
```
DisassociateContactFromAddressBookResult disassociateContactFromAddressBook(DisassociateContactFromAddressBookRequest disassociateContactFromAddressBookRequest)
```
    Disassociates a contact from a given address book.
    
    Parameters:
    
    disassociateContactFromAddressBookRequest -
    
    Returns:
    
    Result of the DisassociateContactFromAddressBook operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - disassociateDeviceFromRoom
```
DisassociateDeviceFromRoomResult disassociateDeviceFromRoom(DisassociateDeviceFromRoomRequest disassociateDeviceFromRoomRequest)
```
    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.
    
    Parameters:
    
    disassociateDeviceFromRoomRequest -
    
    Returns:
    
    Result of the DisassociateDeviceFromRoom operation returned by the service.
    
    Throws:
    
    ConcurrentModificationException - There is a concurrent modification of resources.
    
    DeviceNotRegisteredException - The request failed because this device is no longer registered and therefore no longer managed by this account.
    
    See Also:
    
    AWS API Documentation
  - disassociateSkillFromSkillGroup
```
DisassociateSkillFromSkillGroupResult disassociateSkillFromSkillGroup(DisassociateSkillFromSkillGroupRequest disassociateSkillFromSkillGroupRequest)
```
    Disassociates a skill from a skill group.
    
    Parameters:
    
    disassociateSkillFromSkillGroupRequest -
    
    Returns:
    
    Result of the DisassociateSkillFromSkillGroup operation returned by the service.
    
    Throws:
    
    ConcurrentModificationException - There is a concurrent modification of resources.
    
    NotFoundException - The resource is not found.
    
    See Also:
    
    AWS API Documentation
  - disassociateSkillFromUsers
```
DisassociateSkillFromUsersResult disassociateSkillFromUsers(DisassociateSkillFromUsersRequest disassociateSkillFromUsersRequest)
```
    Makes a private skill unavailable for enrolled users and prevents them from enabling it on their devices.
    
    Parameters:
    
    disassociateSkillFromUsersRequest -
    
    Returns:
    
    Result of the DisassociateSkillFromUsers operation returned by the service.
    
    Throws:
    
    ConcurrentModificationException - There is a concurrent modification of resources.
    
    NotFoundException - The resource is not found.
    
    See Also:
    
    AWS API Documentation
  - disassociateSkillGroupFromRoom
```
DisassociateSkillGroupFromRoomResult disassociateSkillGroupFromRoom(DisassociateSkillGroupFromRoomRequest disassociateSkillGroupFromRoomRequest)
```
    Disassociates a skill group from a specified room. This disables all skills in the skill group on all devices in the room.
    
    Parameters:
    
    disassociateSkillGroupFromRoomRequest -
    
    Returns:
    
    Result of the DisassociateSkillGroupFromRoom operation returned by the service.
    
    Throws:
    
    ConcurrentModificationException - There is a concurrent modification of resources.
    
    See Also:
    
    AWS API Documentation
  - forgetSmartHomeAppliances
```
ForgetSmartHomeAppliancesResult forgetSmartHomeAppliances(ForgetSmartHomeAppliancesRequest forgetSmartHomeAppliancesRequest)
```
    Forgets smart home appliances associated to a room.
    
    Parameters:
    
    forgetSmartHomeAppliancesRequest -
    
    Returns:
    
    Result of the ForgetSmartHomeAppliances operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource is not found.
    
    See Also:
    
    AWS API Documentation
  - getAddressBook
```
GetAddressBookResult getAddressBook(GetAddressBookRequest getAddressBookRequest)
```
    Gets address the book details by the address book ARN.
    
    Parameters:
    
    getAddressBookRequest -
    
    Returns:
    
    Result of the GetAddressBook operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource is not found.
    
    See Also:
    
    AWS API Documentation
  - getConferencePreference
```
GetConferencePreferenceResult getConferencePreference(GetConferencePreferenceRequest getConferencePreferenceRequest)
```
    Retrieves the existing conference preferences.
    
    Parameters:
    
    getConferencePreferenceRequest -
    
    Returns:
    
    Result of the GetConferencePreference operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource is not found.
    
    See Also:
    
    AWS API Documentation
  - getConferenceProvider
```
GetConferenceProviderResult getConferenceProvider(GetConferenceProviderRequest getConferenceProviderRequest)
```
    Gets details about a specific conference provider.
    
    Parameters:
    
    getConferenceProviderRequest -
    
    Returns:
    
    Result of the GetConferenceProvider operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource is not found.
    
    See Also:
    
    AWS API Documentation
  - getContact
```
GetContactResult getContact(GetContactRequest getContactRequest)
```
    Gets the contact details by the contact ARN.
    
    Parameters:
    
    getContactRequest -
    
    Returns:
    
    Result of the GetContact operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource is not found.
    
    See Also:
    
    AWS API Documentation
  - getDevice
```
GetDeviceResult getDevice(GetDeviceRequest getDeviceRequest)
```
    Gets the details of a device by device ARN.
    
    Parameters:
    
    getDeviceRequest -
    
    Returns:
    
    Result of the GetDevice operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource is not found.
    
    See Also:
    
    AWS API Documentation
  - getGateway
```
GetGatewayResult getGateway(GetGatewayRequest getGatewayRequest)
```
    Retrieves the details of a gateway.
    
    Parameters:
    
    getGatewayRequest -
    
    Returns:
    
    Result of the GetGateway operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource is not found.
    
    See Also:
    
    AWS API Documentation
  - getGatewayGroup
```
GetGatewayGroupResult getGatewayGroup(GetGatewayGroupRequest getGatewayGroupRequest)
```
    Retrieves the details of a gateway group.
    
    Parameters:
    
    getGatewayGroupRequest -
    
    Returns:
    
    Result of the GetGatewayGroup operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource is not found.
    
    See Also:
    
    AWS API Documentation
  - getInvitationConfiguration
```
GetInvitationConfigurationResult getInvitationConfiguration(GetInvitationConfigurationRequest getInvitationConfigurationRequest)
```
    Retrieves the configured values for the user enrollment invitation email template.
    
    Parameters:
    
    getInvitationConfigurationRequest -
    
    Returns:
    
    Result of the GetInvitationConfiguration operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource is not found.
    
    See Also:
    
    AWS API Documentation
  - getNetworkProfile
```
GetNetworkProfileResult getNetworkProfile(GetNetworkProfileRequest getNetworkProfileRequest)
```
    Gets the network profile details by the network profile ARN.
    
    Parameters:
    
    getNetworkProfileRequest -
    
    Returns:
    
    Result of the GetNetworkProfile operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource is not found.
    
    InvalidSecretsManagerResourceException - A password in SecretsManager is in an invalid state.
    
    See Also:
    
    AWS API Documentation
  - getProfile
```
GetProfileResult getProfile(GetProfileRequest getProfileRequest)
```
    Gets the details of a room profile by profile ARN.
    
    Parameters:
    
    getProfileRequest -
    
    Returns:
    
    Result of the GetProfile operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource is not found.
    
    See Also:
    
    AWS API Documentation
  - getRoom
```
GetRoomResult getRoom(GetRoomRequest getRoomRequest)
```
    Gets room details by room ARN.
    
    Parameters:
    
    getRoomRequest -
    
    Returns:
    
    Result of the GetRoom operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource is not found.
    
    See Also:
    
    AWS API Documentation
  - getRoomSkillParameter
```
GetRoomSkillParameterResult getRoomSkillParameter(GetRoomSkillParameterRequest getRoomSkillParameterRequest)
```
    Gets room skill parameter details by room, skill, and parameter key ARN.
    
    Parameters:
    
    getRoomSkillParameterRequest -
    
    Returns:
    
    Result of the GetRoomSkillParameter operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource is not found.
    
    See Also:
    
    AWS API Documentation
  - getSkillGroup
```
GetSkillGroupResult getSkillGroup(GetSkillGroupRequest getSkillGroupRequest)
```
    Gets skill group details by skill group ARN.
    
    Parameters:
    
    getSkillGroupRequest -
    
    Returns:
    
    Result of the GetSkillGroup operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource is not found.
    
    See Also:
    
    AWS API Documentation
  - listBusinessReportSchedules
```
ListBusinessReportSchedulesResult listBusinessReportSchedules(ListBusinessReportSchedulesRequest listBusinessReportSchedulesRequest)
```
    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.
    
    Parameters:
    
    listBusinessReportSchedulesRequest -
    
    Returns:
    
    Result of the ListBusinessReportSchedules operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listConferenceProviders
```
ListConferenceProvidersResult listConferenceProviders(ListConferenceProvidersRequest listConferenceProvidersRequest)
```
    Lists conference providers under a specific AWS account.
    
    Parameters:
    
    listConferenceProvidersRequest -
    
    Returns:
    
    Result of the ListConferenceProviders operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listDeviceEvents
```
ListDeviceEventsResult listDeviceEvents(ListDeviceEventsRequest listDeviceEventsRequest)
```
    Lists the device event history, including device connection status, for up to 30 days.
    
    Parameters:
    
    listDeviceEventsRequest -
    
    Returns:
    
    Result of the ListDeviceEvents operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource is not found.
    
    See Also:
    
    AWS API Documentation
  - listGatewayGroups
```
ListGatewayGroupsResult listGatewayGroups(ListGatewayGroupsRequest listGatewayGroupsRequest)
```
    Retrieves a list of gateway group summaries. Use GetGatewayGroup to retrieve details of a specific gateway group.
    
    Parameters:
    
    listGatewayGroupsRequest -
    
    Returns:
    
    Result of the ListGatewayGroups operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listGateways
```
ListGatewaysResult listGateways(ListGatewaysRequest listGatewaysRequest)
```
    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.
    
    Parameters:
    
    listGatewaysRequest -
    
    Returns:
    
    Result of the ListGateways operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listSkills
```
ListSkillsResult listSkills(ListSkillsRequest listSkillsRequest)
```
    Lists all enabled skills in a specific skill group.
    
    Parameters:
    
    listSkillsRequest -
    
    Returns:
    
    Result of the ListSkills operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listSkillsStoreCategories
```
ListSkillsStoreCategoriesResult listSkillsStoreCategories(ListSkillsStoreCategoriesRequest listSkillsStoreCategoriesRequest)
```
    Lists all categories in the Alexa skill store.
    
    Parameters:
    
    listSkillsStoreCategoriesRequest -
    
    Returns:
    
    Result of the ListSkillsStoreCategories operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listSkillsStoreSkillsByCategory
```
ListSkillsStoreSkillsByCategoryResult listSkillsStoreSkillsByCategory(ListSkillsStoreSkillsByCategoryRequest listSkillsStoreSkillsByCategoryRequest)
```
    Lists all skills in the Alexa skill store by category.
    
    Parameters:
    
    listSkillsStoreSkillsByCategoryRequest -
    
    Returns:
    
    Result of the ListSkillsStoreSkillsByCategory operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listSmartHomeAppliances
```
ListSmartHomeAppliancesResult listSmartHomeAppliances(ListSmartHomeAppliancesRequest listSmartHomeAppliancesRequest)
```
    Lists all of the smart home appliances associated with a room.
    
    Parameters:
    
    listSmartHomeAppliancesRequest -
    
    Returns:
    
    Result of the ListSmartHomeAppliances operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource is not found.
    
    See Also:
    
    AWS API Documentation
  - listTags
```
ListTagsResult listTags(ListTagsRequest listTagsRequest)
```
    Lists all tags for the specified resource.
    
    Parameters:
    
    listTagsRequest -
    
    Returns:
    
    Result of the ListTags operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource is not found.
    
    See Also:
    
    AWS API Documentation
  - putConferencePreference
```
PutConferencePreferenceResult putConferencePreference(PutConferencePreferenceRequest putConferencePreferenceRequest)
```
    Sets the conference preferences on a specific conference provider at the account level.
    
    Parameters:
    
    putConferencePreferenceRequest -
    
    Returns:
    
    Result of the PutConferencePreference operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource is not found.
    
    See Also:
    
    AWS API Documentation
  - putInvitationConfiguration
```
PutInvitationConfigurationResult putInvitationConfiguration(PutInvitationConfigurationRequest putInvitationConfigurationRequest)
```
    Configures the email template for the user enrollment invitation with the specified attributes.
    
    Parameters:
    
    putInvitationConfigurationRequest -
    
    Returns:
    
    Result of the PutInvitationConfiguration operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource is not found.
    
    ConcurrentModificationException - There is a concurrent modification of resources.
    
    See Also:
    
    AWS API Documentation
  - putRoomSkillParameter
```
PutRoomSkillParameterResult putRoomSkillParameter(PutRoomSkillParameterRequest putRoomSkillParameterRequest)
```
    Updates room skill parameter details by room, skill, and parameter key ID. Not all skills have a room skill parameter.
    
    Parameters:
    
    putRoomSkillParameterRequest -
    
    Returns:
    
    Result of the PutRoomSkillParameter operation returned by the service.
    
    Throws:
    
    ConcurrentModificationException - There is a concurrent modification of resources.
    
    See Also:
    
    AWS API Documentation
  - putSkillAuthorization
```
PutSkillAuthorizationResult putSkillAuthorization(PutSkillAuthorizationRequest putSkillAuthorizationRequest)
```
    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.
    
    Parameters:
    
    putSkillAuthorizationRequest -
    
    Returns:
    
    Result of the PutSkillAuthorization operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The caller has no permissions to operate on the resource involved in the API call.
    
    ConcurrentModificationException - There is a concurrent modification of resources.
    
    See Also:
    
    AWS API Documentation
  - registerAVSDevice
```
RegisterAVSDeviceResult registerAVSDevice(RegisterAVSDeviceRequest registerAVSDeviceRequest)
```
    Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service (AVS).
    
    Parameters:
    
    registerAVSDeviceRequest -
    
    Returns:
    
    Result of the RegisterAVSDevice operation returned by the service.
    
    Throws:
    
    LimitExceededException - You are performing an action that would put you beyond your account's limits.
    
    ConcurrentModificationException - There is a concurrent modification of resources.
    
    NotFoundException - The resource is not found.
    
    InvalidDeviceException - The device is in an invalid state.
    
    See Also:
    
    AWS API Documentation
  - rejectSkill
```
RejectSkillResult rejectSkill(RejectSkillRequest rejectSkillRequest)
```
    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.
    
    Parameters:
    
    rejectSkillRequest -
    
    Returns:
    
    Result of the RejectSkill operation returned by the service.
    
    Throws:
    
    ConcurrentModificationException - There is a concurrent modification of resources.
    
    NotFoundException - The resource is not found.
    
    See Also:
    
    AWS API Documentation
  - resolveRoom
```
ResolveRoomResult resolveRoom(ResolveRoomRequest resolveRoomRequest)
```
    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.
    
    Parameters:
    
    resolveRoomRequest -
    
    Returns:
    
    Result of the ResolveRoom operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource is not found.
    
    See Also:
    
    AWS API Documentation
  - revokeInvitation
```
RevokeInvitationResult revokeInvitation(RevokeInvitationRequest revokeInvitationRequest)
```
    Revokes an invitation and invalidates the enrollment URL.
    
    Parameters:
    
    revokeInvitationRequest -
    
    Returns:
    
    Result of the RevokeInvitation operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource is not found.
    
    ConcurrentModificationException - There is a concurrent modification of resources.
    
    See Also:
    
    AWS API Documentation
  - searchAddressBooks
```
SearchAddressBooksResult searchAddressBooks(SearchAddressBooksRequest searchAddressBooksRequest)
```
    Searches address books and lists the ones that meet a set of filter and sort criteria.
    
    Parameters:
    
    searchAddressBooksRequest -
    
    Returns:
    
    Result of the SearchAddressBooks operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - searchContacts
```
SearchContactsResult searchContacts(SearchContactsRequest searchContactsRequest)
```
    Searches contacts and lists the ones that meet a set of filter and sort criteria.
    
    Parameters:
    
    searchContactsRequest -
    
    Returns:
    
    Result of the SearchContacts operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - searchDevices
```
SearchDevicesResult searchDevices(SearchDevicesRequest searchDevicesRequest)
```
    Searches devices and lists the ones that meet a set of filter criteria.
    
    Parameters:
    
    searchDevicesRequest -
    
    Returns:
    
    Result of the SearchDevices operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - searchNetworkProfiles
```
SearchNetworkProfilesResult searchNetworkProfiles(SearchNetworkProfilesRequest searchNetworkProfilesRequest)
```
    Searches network profiles and lists the ones that meet a set of filter and sort criteria.
    
    Parameters:
    
    searchNetworkProfilesRequest -
    
    Returns:
    
    Result of the SearchNetworkProfiles operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - searchProfiles
```
SearchProfilesResult searchProfiles(SearchProfilesRequest searchProfilesRequest)
```
    Searches room profiles and lists the ones that meet a set of filter criteria.
    
    Parameters:
    
    searchProfilesRequest -
    
    Returns:
    
    Result of the SearchProfiles operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - searchRooms
```
SearchRoomsResult searchRooms(SearchRoomsRequest searchRoomsRequest)
```
    Searches rooms and lists the ones that meet a set of filter and sort criteria.
    
    Parameters:
    
    searchRoomsRequest -
    
    Returns:
    
    Result of the SearchRooms operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - searchSkillGroups
```
SearchSkillGroupsResult searchSkillGroups(SearchSkillGroupsRequest searchSkillGroupsRequest)
```
    Searches skill groups and lists the ones that meet a set of filter and sort criteria.
    
    Parameters:
    
    searchSkillGroupsRequest -
    
    Returns:
    
    Result of the SearchSkillGroups operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - searchUsers
```
SearchUsersResult searchUsers(SearchUsersRequest searchUsersRequest)
```
    Searches users and lists the ones that meet a set of filter and sort criteria.
    
    Parameters:
    
    searchUsersRequest -
    
    Returns:
    
    Result of the SearchUsers operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - sendAnnouncement
```
SendAnnouncementResult sendAnnouncement(SendAnnouncementRequest sendAnnouncementRequest)
```
    Triggers an asynchronous flow to send text, SSML, or audio announcements to rooms that are identified by a search or filter.
    
    Parameters:
    
    sendAnnouncementRequest -
    
    Returns:
    
    Result of the SendAnnouncement operation returned by the service.
    
    Throws:
    
    LimitExceededException - You are performing an action that would put you beyond your account's limits.
    
    AlreadyExistsException - The resource being created already exists.
    
    See Also:
    
    AWS API Documentation
  - sendInvitation
```
SendInvitationResult sendInvitation(SendInvitationRequest sendInvitationRequest)
```
    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.
    
    Parameters:
    
    sendInvitationRequest -
    
    Returns:
    
    Result of the SendInvitation operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource is not found.
    
    InvalidUserStatusException - The attempt to update a user is invalid due to the user's current status.
    
    ConcurrentModificationException - There is a concurrent modification of resources.
    
    See Also:
    
    AWS API Documentation
  - startDeviceSync
```
StartDeviceSyncResult startDeviceSync(StartDeviceSyncRequest startDeviceSyncRequest)
```
    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).
    Parameters:
    
    startDeviceSyncRequest -
    
    Returns:
    
    Result of the StartDeviceSync operation returned by the service.
    
    Throws:
    
    DeviceNotRegisteredException - The request failed because this device is no longer registered and therefore no longer managed by this account.
    
    See Also:
    
    AWS API Documentation
  - startSmartHomeApplianceDiscovery
```
StartSmartHomeApplianceDiscoveryResult startSmartHomeApplianceDiscovery(StartSmartHomeApplianceDiscoveryRequest startSmartHomeApplianceDiscoveryRequest)
```
    Initiates the discovery of any smart home appliances associated with the room.
    
    Parameters:
    
    startSmartHomeApplianceDiscoveryRequest -
    
    Returns:
    
    Result of the StartSmartHomeApplianceDiscovery operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource is not found.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
```
    Adds metadata tags to a specified resource.
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource is not found.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
```
    Removes metadata tags from a specified resource.
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource is not found.
    
    See Also:
    
    AWS API Documentation
  - updateAddressBook
```
UpdateAddressBookResult updateAddressBook(UpdateAddressBookRequest updateAddressBookRequest)
```
    Updates address book details by the address book ARN.
    
    Parameters:
    
    updateAddressBookRequest -
    
    Returns:
    
    Result of the UpdateAddressBook operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource is not found.
    
    NameInUseException - The name sent in the request is already in use.
    
    ConcurrentModificationException - There is a concurrent modification of resources.
    
    See Also:
    
    AWS API Documentation
  - updateBusinessReportSchedule
```
UpdateBusinessReportScheduleResult updateBusinessReportSchedule(UpdateBusinessReportScheduleRequest updateBusinessReportScheduleRequest)
```
    Updates the configuration of the report delivery schedule with the specified schedule ARN.
    
    Parameters:
    
    updateBusinessReportScheduleRequest -
    
    Returns:
    
    Result of the UpdateBusinessReportSchedule operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource is not found.
    
    ConcurrentModificationException - There is a concurrent modification of resources.
    
    See Also:
    
    AWS API Documentation
  - updateConferenceProvider
```
UpdateConferenceProviderResult updateConferenceProvider(UpdateConferenceProviderRequest updateConferenceProviderRequest)
```
    Updates an existing conference provider's settings.
    
    Parameters:
    
    updateConferenceProviderRequest -
    
    Returns:
    
    Result of the UpdateConferenceProvider operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource is not found.
    
    See Also:
    
    AWS API Documentation
  - updateContact
```
UpdateContactResult updateContact(UpdateContactRequest updateContactRequest)
```
    Updates the contact details by the contact ARN.
    
    Parameters:
    
    updateContactRequest -
    
    Returns:
    
    Result of the UpdateContact operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource is not found.
    
    ConcurrentModificationException - There is a concurrent modification of resources.
    
    See Also:
    
    AWS API Documentation
  - updateDevice
```
UpdateDeviceResult updateDevice(UpdateDeviceRequest updateDeviceRequest)
```
    Updates the device name by device ARN.
    
    Parameters:
    
    updateDeviceRequest -
    
    Returns:
    
    Result of the UpdateDevice operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource is not found.
    
    ConcurrentModificationException - There is a concurrent modification of resources.
    
    DeviceNotRegisteredException - The request failed because this device is no longer registered and therefore no longer managed by this account.
    
    See Also:
    
    AWS API Documentation
  - updateGateway
```
UpdateGatewayResult updateGateway(UpdateGatewayRequest updateGatewayRequest)
```
    Updates the details of a gateway. If any optional field is not provided, the existing corresponding value is left unmodified.
    
    Parameters:
    
    updateGatewayRequest -
    
    Returns:
    
    Result of the UpdateGateway operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource is not found.
    
    NameInUseException - The name sent in the request is already in use.
    
    See Also:
    
    AWS API Documentation
  - updateGatewayGroup
```
UpdateGatewayGroupResult updateGatewayGroup(UpdateGatewayGroupRequest updateGatewayGroupRequest)
```
    Updates the details of a gateway group. If any optional field is not provided, the existing corresponding value is left unmodified.
    
    Parameters:
    
    updateGatewayGroupRequest -
    
    Returns:
    
    Result of the UpdateGatewayGroup operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource is not found.
    
    NameInUseException - The name sent in the request is already in use.
    
    See Also:
    
    AWS API Documentation
  - updateNetworkProfile
```
UpdateNetworkProfileResult updateNetworkProfile(UpdateNetworkProfileRequest updateNetworkProfileRequest)
```
    Updates a network profile by the network profile ARN.
    
    Parameters:
    
    updateNetworkProfileRequest -
    
    Returns:
    
    Result of the UpdateNetworkProfile operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource is not found.
    
    NameInUseException - The name sent in the request is already in use.
    
    ConcurrentModificationException - There is a concurrent modification of resources.
    
    InvalidCertificateAuthorityException - The Certificate Authority can't issue or revoke a certificate.
    
    InvalidSecretsManagerResourceException - A password in SecretsManager is in an invalid state.
    
    See Also:
    
    AWS API Documentation
  - updateProfile
```
UpdateProfileResult updateProfile(UpdateProfileRequest updateProfileRequest)
```
    Updates an existing room profile by room profile ARN.
    
    Parameters:
    
    updateProfileRequest -
    
    Returns:
    
    Result of the UpdateProfile operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource is not found.
    
    NameInUseException - The name sent in the request is already in use.
    
    ConcurrentModificationException - There is a concurrent modification of resources.
    
    See Also:
    
    AWS API Documentation
  - updateRoom
```
UpdateRoomResult updateRoom(UpdateRoomRequest updateRoomRequest)
```
    Updates room details by room ARN.
    
    Parameters:
    
    updateRoomRequest -
    
    Returns:
    
    Result of the UpdateRoom operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource is not found.
    
    NameInUseException - The name sent in the request is already in use.
    
    See Also:
    
    AWS API Documentation
  - updateSkillGroup
```
UpdateSkillGroupResult updateSkillGroup(UpdateSkillGroupRequest updateSkillGroupRequest)
```
    Updates skill group details by skill group ARN.
    
    Parameters:
    
    updateSkillGroupRequest -
    
    Returns:
    
    Result of the UpdateSkillGroup operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource is not found.
    
    NameInUseException - The name sent in the request is already in use.
    
    ConcurrentModificationException - There is a concurrent modification of resources.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
void shutdown()
```
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
  - getCachedResponseMetadata
```
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Interface AmazonAlexaForBusiness

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

approveSkill

associateContactWithAddressBook

associateDeviceWithNetworkProfile

associateDeviceWithRoom

associateSkillGroupWithRoom

associateSkillWithSkillGroup

associateSkillWithUsers

createAddressBook

createBusinessReportSchedule

createConferenceProvider

createContact

createGatewayGroup

createNetworkProfile

createProfile

createRoom

createSkillGroup

createUser

deleteAddressBook

deleteBusinessReportSchedule

deleteConferenceProvider

deleteContact

deleteDevice

deleteDeviceUsageData

deleteGatewayGroup

deleteNetworkProfile

deleteProfile

deleteRoom

deleteRoomSkillParameter

deleteSkillAuthorization

deleteSkillGroup

deleteUser

disassociateContactFromAddressBook

disassociateDeviceFromRoom

disassociateSkillFromSkillGroup

disassociateSkillFromUsers

disassociateSkillGroupFromRoom

forgetSmartHomeAppliances

getAddressBook

getConferencePreference

getConferenceProvider

getContact

getDevice

getGateway

getGatewayGroup

getInvitationConfiguration

getNetworkProfile

getProfile

getRoom

getRoomSkillParameter

getSkillGroup

listBusinessReportSchedules

listConferenceProviders

listDeviceEvents

listGatewayGroups

listGateways

listSkills

listSkillsStoreCategories

listSkillsStoreSkillsByCategory

listSmartHomeAppliances

listTags

putConferencePreference

putInvitationConfiguration

putRoomSkillParameter

putSkillAuthorization

registerAVSDevice

rejectSkill

resolveRoom

revokeInvitation

searchAddressBooks

searchContacts

searchDevices

searchNetworkProfiles

searchProfiles