AmazonAlexaForBusinessClient (AWS Java SDK for Alexa For Business 1.11.701 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.alexaforbusiness.AmazonAlexaForBusinessClient

All Implemented Interfaces:

AmazonAlexaForBusiness

Direct Known Subclasses:

AmazonAlexaForBusinessAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonAlexaForBusinessClient
extends AmazonWebServiceClient
implements AmazonAlexaForBusiness
```
Client for accessing Alexa For Business. All service calls made using this client are blocking, and will not return until the service call completes.

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

protected static ClientConfigurationFactory configFactory
Client configuration factory providing ClientConfigurations tailored to this client
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
- Fields inherited from interface com.amazonaws.services.alexaforbusiness.AmazonAlexaForBusiness
  ENDPOINT_PREFIX

Fields
Modifier and Type	Field and Description
`protected static ClientConfigurationFactory`	`configFactory` Client configuration factory providing ClientConfigurations tailored to this client

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ApproveSkillResult`	`approveSkill(ApproveSkillRequest request)` Associates a skill with the organization under the customer's AWS account.
`AssociateContactWithAddressBookResult`	`associateContactWithAddressBook(AssociateContactWithAddressBookRequest request)` Associates a contact with a given address book.
`AssociateDeviceWithNetworkProfileResult`	`associateDeviceWithNetworkProfile(AssociateDeviceWithNetworkProfileRequest request)` Associates a device with the specified network profile.
`AssociateDeviceWithRoomResult`	`associateDeviceWithRoom(AssociateDeviceWithRoomRequest request)` Associates a device with a given room.
`AssociateSkillGroupWithRoomResult`	`associateSkillGroupWithRoom(AssociateSkillGroupWithRoomRequest request)` Associates a skill group with a given room.
`AssociateSkillWithSkillGroupResult`	`associateSkillWithSkillGroup(AssociateSkillWithSkillGroupRequest request)` Associates a skill with a skill group.
`AssociateSkillWithUsersResult`	`associateSkillWithUsers(AssociateSkillWithUsersRequest request)` Makes a private skill available for enrolled users to enable on their devices.
`static AmazonAlexaForBusinessClientBuilder`	`builder()`
`CreateAddressBookResult`	`createAddressBook(CreateAddressBookRequest request)` Creates an address book with the specified details.
`CreateBusinessReportScheduleResult`	`createBusinessReportSchedule(CreateBusinessReportScheduleRequest request)` Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or weekly interval.
`CreateConferenceProviderResult`	`createConferenceProvider(CreateConferenceProviderRequest request)` Adds a new conference provider under the user's AWS account.
`CreateContactResult`	`createContact(CreateContactRequest request)` Creates a contact with the specified details.
`CreateGatewayGroupResult`	`createGatewayGroup(CreateGatewayGroupRequest request)` Creates a gateway group with the specified details.
`CreateNetworkProfileResult`	`createNetworkProfile(CreateNetworkProfileRequest request)` Creates a network profile with the specified details.
`CreateProfileResult`	`createProfile(CreateProfileRequest request)` Creates a new room profile with the specified details.
`CreateRoomResult`	`createRoom(CreateRoomRequest request)` Creates a room with the specified details.
`CreateSkillGroupResult`	`createSkillGroup(CreateSkillGroupRequest request)` Creates a skill group with a specified name and description.
`CreateUserResult`	`createUser(CreateUserRequest request)` Creates a user.
`DeleteAddressBookResult`	`deleteAddressBook(DeleteAddressBookRequest request)` Deletes an address book by the address book ARN.
`DeleteBusinessReportScheduleResult`	`deleteBusinessReportSchedule(DeleteBusinessReportScheduleRequest request)` Deletes the recurring report delivery schedule with the specified schedule ARN.
`DeleteConferenceProviderResult`	`deleteConferenceProvider(DeleteConferenceProviderRequest request)` Deletes a conference provider.
`DeleteContactResult`	`deleteContact(DeleteContactRequest request)` Deletes a contact by the contact ARN.
`DeleteDeviceResult`	`deleteDevice(DeleteDeviceRequest request)` Removes a device from Alexa For Business.
`DeleteDeviceUsageDataResult`	`deleteDeviceUsageData(DeleteDeviceUsageDataRequest request)` 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 request)` Deletes a gateway group.
`DeleteNetworkProfileResult`	`deleteNetworkProfile(DeleteNetworkProfileRequest request)` Deletes a network profile by the network profile ARN.
`DeleteProfileResult`	`deleteProfile(DeleteProfileRequest request)` Deletes a room profile by the profile ARN.
`DeleteRoomResult`	`deleteRoom(DeleteRoomRequest request)` Deletes a room by the room ARN.
`DeleteRoomSkillParameterResult`	`deleteRoomSkillParameter(DeleteRoomSkillParameterRequest request)` Deletes room skill parameter details by room, skill, and parameter key ID.
`DeleteSkillAuthorizationResult`	`deleteSkillAuthorization(DeleteSkillAuthorizationRequest request)` Unlinks a third-party account from a skill.
`DeleteSkillGroupResult`	`deleteSkillGroup(DeleteSkillGroupRequest request)` Deletes a skill group by skill group ARN.
`DeleteUserResult`	`deleteUser(DeleteUserRequest request)` Deletes a specified user by user ARN and enrollment ARN.
`DisassociateContactFromAddressBookResult`	`disassociateContactFromAddressBook(DisassociateContactFromAddressBookRequest request)` Disassociates a contact from a given address book.
`DisassociateDeviceFromRoomResult`	`disassociateDeviceFromRoom(DisassociateDeviceFromRoomRequest request)` Disassociates a device from its current room.
`DisassociateSkillFromSkillGroupResult`	`disassociateSkillFromSkillGroup(DisassociateSkillFromSkillGroupRequest request)` Disassociates a skill from a skill group.
`DisassociateSkillFromUsersResult`	`disassociateSkillFromUsers(DisassociateSkillFromUsersRequest request)` Makes a private skill unavailable for enrolled users and prevents them from enabling it on their devices.
`DisassociateSkillGroupFromRoomResult`	`disassociateSkillGroupFromRoom(DisassociateSkillGroupFromRoomRequest request)` Disassociates a skill group from a specified room.
`ForgetSmartHomeAppliancesResult`	`forgetSmartHomeAppliances(ForgetSmartHomeAppliancesRequest request)` Forgets smart home appliances associated to a room.
`GetAddressBookResult`	`getAddressBook(GetAddressBookRequest request)` 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 request)` Retrieves the existing conference preferences.
`GetConferenceProviderResult`	`getConferenceProvider(GetConferenceProviderRequest request)` Gets details about a specific conference provider.
`GetContactResult`	`getContact(GetContactRequest request)` Gets the contact details by the contact ARN.
`GetDeviceResult`	`getDevice(GetDeviceRequest request)` Gets the details of a device by device ARN.
`GetGatewayResult`	`getGateway(GetGatewayRequest request)` Retrieves the details of a gateway.
`GetGatewayGroupResult`	`getGatewayGroup(GetGatewayGroupRequest request)` Retrieves the details of a gateway group.
`GetInvitationConfigurationResult`	`getInvitationConfiguration(GetInvitationConfigurationRequest request)` Retrieves the configured values for the user enrollment invitation email template.
`GetNetworkProfileResult`	`getNetworkProfile(GetNetworkProfileRequest request)` Gets the network profile details by the network profile ARN.
`GetProfileResult`	`getProfile(GetProfileRequest request)` Gets the details of a room profile by profile ARN.
`GetRoomResult`	`getRoom(GetRoomRequest request)` Gets room details by room ARN.
`GetRoomSkillParameterResult`	`getRoomSkillParameter(GetRoomSkillParameterRequest request)` Gets room skill parameter details by room, skill, and parameter key ARN.
`GetSkillGroupResult`	`getSkillGroup(GetSkillGroupRequest request)` Gets skill group details by skill group ARN.
`ListBusinessReportSchedulesResult`	`listBusinessReportSchedules(ListBusinessReportSchedulesRequest request)` Lists the details of the schedules that a user configured.
`ListConferenceProvidersResult`	`listConferenceProviders(ListConferenceProvidersRequest request)` Lists conference providers under a specific AWS account.
`ListDeviceEventsResult`	`listDeviceEvents(ListDeviceEventsRequest request)` Lists the device event history, including device connection status, for up to 30 days.
`ListGatewayGroupsResult`	`listGatewayGroups(ListGatewayGroupsRequest request)` Retrieves a list of gateway group summaries.
`ListGatewaysResult`	`listGateways(ListGatewaysRequest request)` Retrieves a list of gateway summaries.
`ListSkillsResult`	`listSkills(ListSkillsRequest request)` Lists all enabled skills in a specific skill group.
`ListSkillsStoreCategoriesResult`	`listSkillsStoreCategories(ListSkillsStoreCategoriesRequest request)` Lists all categories in the Alexa skill store.
`ListSkillsStoreSkillsByCategoryResult`	`listSkillsStoreSkillsByCategory(ListSkillsStoreSkillsByCategoryRequest request)` Lists all skills in the Alexa skill store by category.
`ListSmartHomeAppliancesResult`	`listSmartHomeAppliances(ListSmartHomeAppliancesRequest request)` Lists all of the smart home appliances associated with a room.
`ListTagsResult`	`listTags(ListTagsRequest request)` Lists all tags for the specified resource.
`PutConferencePreferenceResult`	`putConferencePreference(PutConferencePreferenceRequest request)` Sets the conference preferences on a specific conference provider at the account level.
`PutInvitationConfigurationResult`	`putInvitationConfiguration(PutInvitationConfigurationRequest request)` Configures the email template for the user enrollment invitation with the specified attributes.
`PutRoomSkillParameterResult`	`putRoomSkillParameter(PutRoomSkillParameterRequest request)` Updates room skill parameter details by room, skill, and parameter key ID.
`PutSkillAuthorizationResult`	`putSkillAuthorization(PutSkillAuthorizationRequest request)` Links a user's account to a third-party skill provider.
`RegisterAVSDeviceResult`	`registerAVSDevice(RegisterAVSDeviceRequest request)` Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service (AVS).
`RejectSkillResult`	`rejectSkill(RejectSkillRequest request)` Disassociates a skill from the organization under a user's AWS account.
`ResolveRoomResult`	`resolveRoom(ResolveRoomRequest request)` Determines the details for the room from which a skill request was invoked.
`RevokeInvitationResult`	`revokeInvitation(RevokeInvitationRequest request)` Revokes an invitation and invalidates the enrollment URL.
`SearchAddressBooksResult`	`searchAddressBooks(SearchAddressBooksRequest request)` Searches address books and lists the ones that meet a set of filter and sort criteria.
`SearchContactsResult`	`searchContacts(SearchContactsRequest request)` Searches contacts and lists the ones that meet a set of filter and sort criteria.
`SearchDevicesResult`	`searchDevices(SearchDevicesRequest request)` Searches devices and lists the ones that meet a set of filter criteria.
`SearchNetworkProfilesResult`	`searchNetworkProfiles(SearchNetworkProfilesRequest request)` Searches network profiles and lists the ones that meet a set of filter and sort criteria.
`SearchProfilesResult`	`searchProfiles(SearchProfilesRequest request)` Searches room profiles and lists the ones that meet a set of filter criteria.
`SearchRoomsResult`	`searchRooms(SearchRoomsRequest request)` Searches rooms and lists the ones that meet a set of filter and sort criteria.
`SearchSkillGroupsResult`	`searchSkillGroups(SearchSkillGroupsRequest request)` Searches skill groups and lists the ones that meet a set of filter and sort criteria.
`SearchUsersResult`	`searchUsers(SearchUsersRequest request)` Searches users and lists the ones that meet a set of filter and sort criteria.
`SendAnnouncementResult`	`sendAnnouncement(SendAnnouncementRequest request)` Triggers an asynchronous flow to send text, SSML, or audio announcements to rooms that are identified by a search or filter.
`SendInvitationResult`	`sendInvitation(SendInvitationRequest request)` Sends an enrollment invitation email with a URL to a user.
`StartDeviceSyncResult`	`startDeviceSync(StartDeviceSyncRequest request)` Resets a device and its account to the known default settings.
`StartSmartHomeApplianceDiscoveryResult`	`startSmartHomeApplianceDiscovery(StartSmartHomeApplianceDiscoveryRequest request)` Initiates the discovery of any smart home appliances associated with the room.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Adds metadata tags to a specified resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Removes metadata tags from a specified resource.
`UpdateAddressBookResult`	`updateAddressBook(UpdateAddressBookRequest request)` Updates address book details by the address book ARN.
`UpdateBusinessReportScheduleResult`	`updateBusinessReportSchedule(UpdateBusinessReportScheduleRequest request)` Updates the configuration of the report delivery schedule with the specified schedule ARN.
`UpdateConferenceProviderResult`	`updateConferenceProvider(UpdateConferenceProviderRequest request)` Updates an existing conference provider's settings.
`UpdateContactResult`	`updateContact(UpdateContactRequest request)` Updates the contact details by the contact ARN.
`UpdateDeviceResult`	`updateDevice(UpdateDeviceRequest request)` Updates the device name by device ARN.
`UpdateGatewayResult`	`updateGateway(UpdateGatewayRequest request)` Updates the details of a gateway.
`UpdateGatewayGroupResult`	`updateGatewayGroup(UpdateGatewayGroupRequest request)` Updates the details of a gateway group.
`UpdateNetworkProfileResult`	`updateNetworkProfile(UpdateNetworkProfileRequest request)` Updates a network profile by the network profile ARN.
`UpdateProfileResult`	`updateProfile(UpdateProfileRequest request)` Updates an existing room profile by room profile ARN.
`UpdateRoomResult`	`updateRoom(UpdateRoomRequest request)` Updates room details by room ARN.
`UpdateSkillGroupResult`	`updateSkillGroup(UpdateSkillGroupRequest request)` Updates skill group details by skill group ARN.

Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, shutdown, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.alexaforbusiness.AmazonAlexaForBusiness
shutdown

- Field Detail
  - configFactory
```
protected static final ClientConfigurationFactory configFactory
```
    Client configuration factory providing ClientConfigurations tailored to this client
- Method Detail
  - builder
```
public static AmazonAlexaForBusinessClientBuilder builder()
```
  - approveSkill
```
public ApproveSkillResult approveSkill(ApproveSkillRequest request)
```
    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.
    
    Specified by:
    
    approveSkill in interface AmazonAlexaForBusiness
    
    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
```
public AssociateContactWithAddressBookResult associateContactWithAddressBook(AssociateContactWithAddressBookRequest request)
```
    Associates a contact with a given address book.
    
    Specified by:
    
    associateContactWithAddressBook in interface AmazonAlexaForBusiness
    
    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
```
public AssociateDeviceWithNetworkProfileResult associateDeviceWithNetworkProfile(AssociateDeviceWithNetworkProfileRequest request)
```
    Associates a device with the specified network profile.
    
    Specified by:
    
    associateDeviceWithNetworkProfile in interface AmazonAlexaForBusiness
    
    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
```
public AssociateDeviceWithRoomResult associateDeviceWithRoom(AssociateDeviceWithRoomRequest request)
```
    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.
    
    Specified by:
    
    associateDeviceWithRoom in interface AmazonAlexaForBusiness
    
    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
```
public AssociateSkillGroupWithRoomResult associateSkillGroupWithRoom(AssociateSkillGroupWithRoomRequest request)
```
    Associates a skill group with a given room. This enables all skills in the associated skill group on all devices in the room.
    
    Specified by:
    
    associateSkillGroupWithRoom in interface AmazonAlexaForBusiness
    
    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
```
public AssociateSkillWithSkillGroupResult associateSkillWithSkillGroup(AssociateSkillWithSkillGroupRequest request)
```
    Associates a skill with a skill group.
    
    Specified by:
    
    associateSkillWithSkillGroup in interface AmazonAlexaForBusiness
    
    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
```
public AssociateSkillWithUsersResult associateSkillWithUsers(AssociateSkillWithUsersRequest request)
```
    Makes a private skill available for enrolled users to enable on their devices.
    
    Specified by:
    
    associateSkillWithUsers in interface AmazonAlexaForBusiness
    
    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
```
public CreateAddressBookResult createAddressBook(CreateAddressBookRequest request)
```
    Creates an address book with the specified details.
    
    Specified by:
    
    createAddressBook in interface AmazonAlexaForBusiness
    
    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
```
public CreateBusinessReportScheduleResult createBusinessReportSchedule(CreateBusinessReportScheduleRequest request)
```
    Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or weekly interval.
    
    Specified by:
    
    createBusinessReportSchedule in interface AmazonAlexaForBusiness
    
    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
```
public CreateConferenceProviderResult createConferenceProvider(CreateConferenceProviderRequest request)
```
    Adds a new conference provider under the user's AWS account.
    
    Specified by:
    
    createConferenceProvider in interface AmazonAlexaForBusiness
    
    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
```
public CreateContactResult createContact(CreateContactRequest request)
```
    Creates a contact with the specified details.
    
    Specified by:
    
    createContact in interface AmazonAlexaForBusiness
    
    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
```
public CreateGatewayGroupResult createGatewayGroup(CreateGatewayGroupRequest request)
```
    Creates a gateway group with the specified details.
    
    Specified by:
    
    createGatewayGroup in interface AmazonAlexaForBusiness
    
    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
```
public CreateNetworkProfileResult createNetworkProfile(CreateNetworkProfileRequest request)
```
    Creates a network profile with the specified details.
    
    Specified by:
    
    createNetworkProfile in interface AmazonAlexaForBusiness
    
    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
```
public CreateProfileResult createProfile(CreateProfileRequest request)
```
    Creates a new room profile with the specified details.
    
    Specified by:
    
    createProfile in interface AmazonAlexaForBusiness
    
    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
```
public CreateRoomResult createRoom(CreateRoomRequest request)
```
    Creates a room with the specified details.
    
    Specified by:
    
    createRoom in interface AmazonAlexaForBusiness
    
    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
```
public CreateSkillGroupResult createSkillGroup(CreateSkillGroupRequest request)
```
    Creates a skill group with a specified name and description.
    
    Specified by:
    
    createSkillGroup in interface AmazonAlexaForBusiness
    
    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
```
public CreateUserResult createUser(CreateUserRequest request)
```
    Creates a user.
    
    Specified by:
    
    createUser in interface AmazonAlexaForBusiness
    
    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
```
public DeleteAddressBookResult deleteAddressBook(DeleteAddressBookRequest request)
```
    Deletes an address book by the address book ARN.
    
    Specified by:
    
    deleteAddressBook in interface AmazonAlexaForBusiness
    
    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
```
public DeleteBusinessReportScheduleResult deleteBusinessReportSchedule(DeleteBusinessReportScheduleRequest request)
```
    Deletes the recurring report delivery schedule with the specified schedule ARN.
    
    Specified by:
    
    deleteBusinessReportSchedule in interface AmazonAlexaForBusiness
    
    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
```
public DeleteConferenceProviderResult deleteConferenceProvider(DeleteConferenceProviderRequest request)
```
    Deletes a conference provider.
    
    Specified by:
    
    deleteConferenceProvider in interface AmazonAlexaForBusiness
    
    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
```
public DeleteContactResult deleteContact(DeleteContactRequest request)
```
    Deletes a contact by the contact ARN.
    
    Specified by:
    
    deleteContact in interface AmazonAlexaForBusiness
    
    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
```
public DeleteDeviceResult deleteDevice(DeleteDeviceRequest request)
```
    Removes a device from Alexa For Business.
    
    Specified by:
    
    deleteDevice in interface AmazonAlexaForBusiness
    
    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
```
public DeleteDeviceUsageDataResult deleteDeviceUsageData(DeleteDeviceUsageDataRequest request)
```
    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.
    
    Specified by:
    
    deleteDeviceUsageData in interface AmazonAlexaForBusiness
    
    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
```
public DeleteGatewayGroupResult deleteGatewayGroup(DeleteGatewayGroupRequest request)
```
    Deletes a gateway group.
    
    Specified by:
    
    deleteGatewayGroup in interface AmazonAlexaForBusiness
    
    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
```
public DeleteNetworkProfileResult deleteNetworkProfile(DeleteNetworkProfileRequest request)
```
    Deletes a network profile by the network profile ARN.
    
    Specified by:
    
    deleteNetworkProfile in interface AmazonAlexaForBusiness
    
    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
```
public DeleteProfileResult deleteProfile(DeleteProfileRequest request)
```
    Deletes a room profile by the profile ARN.
    
    Specified by:
    
    deleteProfile in interface AmazonAlexaForBusiness
    
    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
```
public DeleteRoomResult deleteRoom(DeleteRoomRequest request)
```
    Deletes a room by the room ARN.
    
    Specified by:
    
    deleteRoom in interface AmazonAlexaForBusiness
    
    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
```
public DeleteRoomSkillParameterResult deleteRoomSkillParameter(DeleteRoomSkillParameterRequest request)
```
    Deletes room skill parameter details by room, skill, and parameter key ID.
    
    Specified by:
    
    deleteRoomSkillParameter in interface AmazonAlexaForBusiness
    
    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
```
public DeleteSkillAuthorizationResult deleteSkillAuthorization(DeleteSkillAuthorizationRequest request)
```
    Unlinks a third-party account from a skill.
    
    Specified by:
    
    deleteSkillAuthorization in interface AmazonAlexaForBusiness
    
    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
```
public DeleteSkillGroupResult deleteSkillGroup(DeleteSkillGroupRequest request)
```
    Deletes a skill group by skill group ARN.
    
    Specified by:
    
    deleteSkillGroup in interface AmazonAlexaForBusiness
    
    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
```
public DeleteUserResult deleteUser(DeleteUserRequest request)
```
    Deletes a specified user by user ARN and enrollment ARN.
    
    Specified by:
    
    deleteUser in interface AmazonAlexaForBusiness
    
    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
```
public DisassociateContactFromAddressBookResult disassociateContactFromAddressBook(DisassociateContactFromAddressBookRequest request)
```
    Disassociates a contact from a given address book.
    
    Specified by:
    
    disassociateContactFromAddressBook in interface AmazonAlexaForBusiness
    
    Parameters:
    
    disassociateContactFromAddressBookRequest -
    
    Returns:
    
    Result of the DisassociateContactFromAddressBook operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - disassociateDeviceFromRoom
```
public DisassociateDeviceFromRoomResult disassociateDeviceFromRoom(DisassociateDeviceFromRoomRequest request)
```
    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.
    
    Specified by:
    
    disassociateDeviceFromRoom in interface AmazonAlexaForBusiness
    
    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
```
public DisassociateSkillFromSkillGroupResult disassociateSkillFromSkillGroup(DisassociateSkillFromSkillGroupRequest request)
```
    Disassociates a skill from a skill group.
    
    Specified by:
    
    disassociateSkillFromSkillGroup in interface AmazonAlexaForBusiness
    
    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
```
public DisassociateSkillFromUsersResult disassociateSkillFromUsers(DisassociateSkillFromUsersRequest request)
```
    Makes a private skill unavailable for enrolled users and prevents them from enabling it on their devices.
    
    Specified by:
    
    disassociateSkillFromUsers in interface AmazonAlexaForBusiness
    
    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
```
public DisassociateSkillGroupFromRoomResult disassociateSkillGroupFromRoom(DisassociateSkillGroupFromRoomRequest request)
```
    Disassociates a skill group from a specified room. This disables all skills in the skill group on all devices in the room.
    
    Specified by:
    
    disassociateSkillGroupFromRoom in interface AmazonAlexaForBusiness
    
    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
```
public ForgetSmartHomeAppliancesResult forgetSmartHomeAppliances(ForgetSmartHomeAppliancesRequest request)
```
    Forgets smart home appliances associated to a room.
    
    Specified by:
    
    forgetSmartHomeAppliances in interface AmazonAlexaForBusiness
    
    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
```
public GetAddressBookResult getAddressBook(GetAddressBookRequest request)
```
    Gets address the book details by the address book ARN.
    
    Specified by:
    
    getAddressBook in interface AmazonAlexaForBusiness
    
    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
```
public GetConferencePreferenceResult getConferencePreference(GetConferencePreferenceRequest request)
```
    Retrieves the existing conference preferences.
    
    Specified by:
    
    getConferencePreference in interface AmazonAlexaForBusiness
    
    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
```
public GetConferenceProviderResult getConferenceProvider(GetConferenceProviderRequest request)
```
    Gets details about a specific conference provider.
    
    Specified by:
    
    getConferenceProvider in interface AmazonAlexaForBusiness
    
    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
```
public GetContactResult getContact(GetContactRequest request)
```
    Gets the contact details by the contact ARN.
    
    Specified by:
    
    getContact in interface AmazonAlexaForBusiness
    
    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
```
public GetDeviceResult getDevice(GetDeviceRequest request)
```
    Gets the details of a device by device ARN.
    
    Specified by:
    
    getDevice in interface AmazonAlexaForBusiness
    
    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
```
public GetGatewayResult getGateway(GetGatewayRequest request)
```
    Retrieves the details of a gateway.
    
    Specified by:
    
    getGateway in interface AmazonAlexaForBusiness
    
    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
```
public GetGatewayGroupResult getGatewayGroup(GetGatewayGroupRequest request)
```
    Retrieves the details of a gateway group.
    
    Specified by:
    
    getGatewayGroup in interface AmazonAlexaForBusiness
    
    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
```
public GetInvitationConfigurationResult getInvitationConfiguration(GetInvitationConfigurationRequest request)
```
    Retrieves the configured values for the user enrollment invitation email template.
    
    Specified by:
    
    getInvitationConfiguration in interface AmazonAlexaForBusiness
    
    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
```
public GetNetworkProfileResult getNetworkProfile(GetNetworkProfileRequest request)
```
    Gets the network profile details by the network profile ARN.
    
    Specified by:
    
    getNetworkProfile in interface AmazonAlexaForBusiness
    
    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
```
public GetProfileResult getProfile(GetProfileRequest request)
```
    Gets the details of a room profile by profile ARN.
    
    Specified by:
    
    getProfile in interface AmazonAlexaForBusiness
    
    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
```
public GetRoomResult getRoom(GetRoomRequest request)
```
    Gets room details by room ARN.
    
    Specified by:
    
    getRoom in interface AmazonAlexaForBusiness
    
    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
```
public GetRoomSkillParameterResult getRoomSkillParameter(GetRoomSkillParameterRequest request)
```
    Gets room skill parameter details by room, skill, and parameter key ARN.
    
    Specified by:
    
    getRoomSkillParameter in interface AmazonAlexaForBusiness
    
    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
```
public GetSkillGroupResult getSkillGroup(GetSkillGroupRequest request)
```
    Gets skill group details by skill group ARN.
    
    Specified by:
    
    getSkillGroup in interface AmazonAlexaForBusiness
    
    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
```
public ListBusinessReportSchedulesResult listBusinessReportSchedules(ListBusinessReportSchedulesRequest request)
```
    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.
    
    Specified by:
    
    listBusinessReportSchedules in interface AmazonAlexaForBusiness
    
    Parameters:
    
    listBusinessReportSchedulesRequest -
    
    Returns:
    
    Result of the ListBusinessReportSchedules operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listConferenceProviders
```
public ListConferenceProvidersResult listConferenceProviders(ListConferenceProvidersRequest request)
```
    Lists conference providers under a specific AWS account.
    
    Specified by:
    
    listConferenceProviders in interface AmazonAlexaForBusiness
    
    Parameters:
    
    listConferenceProvidersRequest -
    
    Returns:
    
    Result of the ListConferenceProviders operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listDeviceEvents
```
public ListDeviceEventsResult listDeviceEvents(ListDeviceEventsRequest request)
```
    Lists the device event history, including device connection status, for up to 30 days.
    
    Specified by:
    
    listDeviceEvents in interface AmazonAlexaForBusiness
    
    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
```
public ListGatewayGroupsResult listGatewayGroups(ListGatewayGroupsRequest request)
```
    Retrieves a list of gateway group summaries. Use GetGatewayGroup to retrieve details of a specific gateway group.
    
    Specified by:
    
    listGatewayGroups in interface AmazonAlexaForBusiness
    
    Parameters:
    
    listGatewayGroupsRequest -
    
    Returns:
    
    Result of the ListGatewayGroups operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listGateways
```
public ListGatewaysResult listGateways(ListGatewaysRequest request)
```
    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.
    
    Specified by:
    
    listGateways in interface AmazonAlexaForBusiness
    
    Parameters:
    
    listGatewaysRequest -
    
    Returns:
    
    Result of the ListGateways operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listSkills
```
public ListSkillsResult listSkills(ListSkillsRequest request)
```
    Lists all enabled skills in a specific skill group.
    
    Specified by:
    
    listSkills in interface AmazonAlexaForBusiness
    
    Parameters:
    
    listSkillsRequest -
    
    Returns:
    
    Result of the ListSkills operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listSkillsStoreCategories
```
public ListSkillsStoreCategoriesResult listSkillsStoreCategories(ListSkillsStoreCategoriesRequest request)
```
    Lists all categories in the Alexa skill store.
    
    Specified by:
    
    listSkillsStoreCategories in interface AmazonAlexaForBusiness
    
    Parameters:
    
    listSkillsStoreCategoriesRequest -
    
    Returns:
    
    Result of the ListSkillsStoreCategories operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listSkillsStoreSkillsByCategory
```
public ListSkillsStoreSkillsByCategoryResult listSkillsStoreSkillsByCategory(ListSkillsStoreSkillsByCategoryRequest request)
```
    Lists all skills in the Alexa skill store by category.
    
    Specified by:
    
    listSkillsStoreSkillsByCategory in interface AmazonAlexaForBusiness
    
    Parameters:
    
    listSkillsStoreSkillsByCategoryRequest -
    
    Returns:
    
    Result of the ListSkillsStoreSkillsByCategory operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listSmartHomeAppliances
```
public ListSmartHomeAppliancesResult listSmartHomeAppliances(ListSmartHomeAppliancesRequest request)
```
    Lists all of the smart home appliances associated with a room.
    
    Specified by:
    
    listSmartHomeAppliances in interface AmazonAlexaForBusiness
    
    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
```
public ListTagsResult listTags(ListTagsRequest request)
```
    Lists all tags for the specified resource.
    
    Specified by:
    
    listTags in interface AmazonAlexaForBusiness
    
    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
```
public PutConferencePreferenceResult putConferencePreference(PutConferencePreferenceRequest request)
```
    Sets the conference preferences on a specific conference provider at the account level.
    
    Specified by:
    
    putConferencePreference in interface AmazonAlexaForBusiness
    
    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
```
public PutInvitationConfigurationResult putInvitationConfiguration(PutInvitationConfigurationRequest request)
```
    Configures the email template for the user enrollment invitation with the specified attributes.
    
    Specified by:
    
    putInvitationConfiguration in interface AmazonAlexaForBusiness
    
    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
```
public PutRoomSkillParameterResult putRoomSkillParameter(PutRoomSkillParameterRequest request)
```
    Updates room skill parameter details by room, skill, and parameter key ID. Not all skills have a room skill parameter.
    
    Specified by:
    
    putRoomSkillParameter in interface AmazonAlexaForBusiness
    
    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
```
public PutSkillAuthorizationResult putSkillAuthorization(PutSkillAuthorizationRequest request)
```
    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.
    
    Specified by:
    
    putSkillAuthorization in interface AmazonAlexaForBusiness
    
    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
```
public RegisterAVSDeviceResult registerAVSDevice(RegisterAVSDeviceRequest request)
```
    Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service (AVS).
    
    Specified by:
    
    registerAVSDevice in interface AmazonAlexaForBusiness
    
    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.
    
    InvalidDeviceException - The device is in an invalid state.
    
    See Also:
    
    AWS API Documentation
  - rejectSkill
```
public RejectSkillResult rejectSkill(RejectSkillRequest request)
```
    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.
    
    Specified by:
    
    rejectSkill in interface AmazonAlexaForBusiness
    
    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
```
public ResolveRoomResult resolveRoom(ResolveRoomRequest request)
```
    Determines the details for the room from which a skill request was invoked. This operation is used by skill developers.
    
    Specified by:
    
    resolveRoom in interface AmazonAlexaForBusiness
    
    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
```
public RevokeInvitationResult revokeInvitation(RevokeInvitationRequest request)
```
    Revokes an invitation and invalidates the enrollment URL.
    
    Specified by:
    
    revokeInvitation in interface AmazonAlexaForBusiness
    
    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
```
public SearchAddressBooksResult searchAddressBooks(SearchAddressBooksRequest request)
```
    Searches address books and lists the ones that meet a set of filter and sort criteria.
    
    Specified by:
    
    searchAddressBooks in interface AmazonAlexaForBusiness
    
    Parameters:
    
    searchAddressBooksRequest -
    
    Returns:
    
    Result of the SearchAddressBooks operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - searchContacts
```
public SearchContactsResult searchContacts(SearchContactsRequest request)
```
    Searches contacts and lists the ones that meet a set of filter and sort criteria.
    
    Specified by:
    
    searchContacts in interface AmazonAlexaForBusiness
    
    Parameters:
    
    searchContactsRequest -
    
    Returns:
    
    Result of the SearchContacts operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - searchDevices
```
public SearchDevicesResult searchDevices(SearchDevicesRequest request)
```
    Searches devices and lists the ones that meet a set of filter criteria.
    
    Specified by:
    
    searchDevices in interface AmazonAlexaForBusiness
    
    Parameters:
    
    searchDevicesRequest -
    
    Returns:
    
    Result of the SearchDevices operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - searchNetworkProfiles
```
public SearchNetworkProfilesResult searchNetworkProfiles(SearchNetworkProfilesRequest request)
```
    Searches network profiles and lists the ones that meet a set of filter and sort criteria.
    
    Specified by:
    
    searchNetworkProfiles in interface AmazonAlexaForBusiness
    
    Parameters:
    
    searchNetworkProfilesRequest -
    
    Returns:
    
    Result of the SearchNetworkProfiles operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - searchProfiles
```
public SearchProfilesResult searchProfiles(SearchProfilesRequest request)
```
    Searches room profiles and lists the ones that meet a set of filter criteria.
    
    Specified by:
    
    searchProfiles in interface AmazonAlexaForBusiness
    
    Parameters:
    
    searchProfilesRequest -
    
    Returns:
    
    Result of the SearchProfiles operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - searchRooms
```
public SearchRoomsResult searchRooms(SearchRoomsRequest request)
```
    Searches rooms and lists the ones that meet a set of filter and sort criteria.
    
    Specified by:
    
    searchRooms in interface AmazonAlexaForBusiness
    
    Parameters:
    
    searchRoomsRequest -
    
    Returns:
    
    Result of the SearchRooms operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - searchSkillGroups
```
public SearchSkillGroupsResult searchSkillGroups(SearchSkillGroupsRequest request)
```
    Searches skill groups and lists the ones that meet a set of filter and sort criteria.
    
    Specified by:
    
    searchSkillGroups in interface AmazonAlexaForBusiness
    
    Parameters:
    
    searchSkillGroupsRequest -
    
    Returns:
    
    Result of the SearchSkillGroups operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - searchUsers
```
public SearchUsersResult searchUsers(SearchUsersRequest request)
```
    Searches users and lists the ones that meet a set of filter and sort criteria.
    
    Specified by:
    
    searchUsers in interface AmazonAlexaForBusiness
    
    Parameters:
    
    searchUsersRequest -
    
    Returns:
    
    Result of the SearchUsers operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - sendAnnouncement
```
public SendAnnouncementResult sendAnnouncement(SendAnnouncementRequest request)
```
    Triggers an asynchronous flow to send text, SSML, or audio announcements to rooms that are identified by a search or filter.
    
    Specified by:
    
    sendAnnouncement in interface AmazonAlexaForBusiness
    
    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
```
public SendInvitationResult sendInvitation(SendInvitationRequest request)
```
    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.
    
    Specified by:
    
    sendInvitation in interface AmazonAlexaForBusiness
    
    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
```
public StartDeviceSyncResult startDeviceSync(StartDeviceSyncRequest request)
```
    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).
    Specified by:
    
    startDeviceSync in interface AmazonAlexaForBusiness
    
    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
```
public StartSmartHomeApplianceDiscoveryResult startSmartHomeApplianceDiscovery(StartSmartHomeApplianceDiscoveryRequest request)
```
    Initiates the discovery of any smart home appliances associated with the room.
    
    Specified by:
    
    startSmartHomeApplianceDiscovery in interface AmazonAlexaForBusiness
    
    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
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Adds metadata tags to a specified resource.
    
    Specified by:
    
    tagResource in interface AmazonAlexaForBusiness
    
    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
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Removes metadata tags from a specified resource.
    
    Specified by:
    
    untagResource in interface AmazonAlexaForBusiness
    
    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
```
public UpdateAddressBookResult updateAddressBook(UpdateAddressBookRequest request)
```
    Updates address book details by the address book ARN.
    
    Specified by:
    
    updateAddressBook in interface AmazonAlexaForBusiness
    
    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
```
public UpdateBusinessReportScheduleResult updateBusinessReportSchedule(UpdateBusinessReportScheduleRequest request)
```
    Updates the configuration of the report delivery schedule with the specified schedule ARN.
    
    Specified by:
    
    updateBusinessReportSchedule in interface AmazonAlexaForBusiness
    
    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
```
public UpdateConferenceProviderResult updateConferenceProvider(UpdateConferenceProviderRequest request)
```
    Updates an existing conference provider's settings.
    
    Specified by:
    
    updateConferenceProvider in interface AmazonAlexaForBusiness
    
    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
```
public UpdateContactResult updateContact(UpdateContactRequest request)
```
    Updates the contact details by the contact ARN.
    
    Specified by:
    
    updateContact in interface AmazonAlexaForBusiness
    
    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
```
public UpdateDeviceResult updateDevice(UpdateDeviceRequest request)
```
    Updates the device name by device ARN.
    
    Specified by:
    
    updateDevice in interface AmazonAlexaForBusiness
    
    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
```
public UpdateGatewayResult updateGateway(UpdateGatewayRequest request)
```
    Updates the details of a gateway. If any optional field is not provided, the existing corresponding value is left unmodified.
    
    Specified by:
    
    updateGateway in interface AmazonAlexaForBusiness
    
    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
```
public UpdateGatewayGroupResult updateGatewayGroup(UpdateGatewayGroupRequest request)
```
    Updates the details of a gateway group. If any optional field is not provided, the existing corresponding value is left unmodified.
    
    Specified by:
    
    updateGatewayGroup in interface AmazonAlexaForBusiness
    
    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
```
public UpdateNetworkProfileResult updateNetworkProfile(UpdateNetworkProfileRequest request)
```
    Updates a network profile by the network profile ARN.
    
    Specified by:
    
    updateNetworkProfile in interface AmazonAlexaForBusiness
    
    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
```
public UpdateProfileResult updateProfile(UpdateProfileRequest request)
```
    Updates an existing room profile by room profile ARN.
    
    Specified by:
    
    updateProfile in interface AmazonAlexaForBusiness
    
    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
```
public UpdateRoomResult updateRoom(UpdateRoomRequest request)
```
    Updates room details by room ARN.
    
    Specified by:
    
    updateRoom in interface AmazonAlexaForBusiness
    
    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
```
public UpdateSkillGroupResult updateSkillGroup(UpdateSkillGroupRequest request)
```
    Updates skill group details by skill group ARN.
    
    Specified by:
    
    updateSkillGroup in interface AmazonAlexaForBusiness
    
    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
  - getCachedResponseMetadata
```
public 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 the request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AmazonAlexaForBusiness
    
    Parameters:
    
    request - The originally executed request
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Class AmazonAlexaForBusinessClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Fields inherited from interface com.amazonaws.services.alexaforbusiness.AmazonAlexaForBusiness

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Methods inherited from interface com.amazonaws.services.alexaforbusiness.AmazonAlexaForBusiness

Field Detail

configFactory

Method Detail

builder

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