com.amazonaws.services.alexaforbusiness

Class AmazonAlexaForBusinessClient

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 makes it easy for you to use Alexa in your organization. Alexa for Business gives you the tools you need 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 APIs, and you can make these available as private skills for your organization. Alexa for Business also makes it easy to voice-enable your products and services, providing context-aware voice experiences for your customers.

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, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

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

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
AssociateDeviceWithRoomResult	associateDeviceWithRoom(AssociateDeviceWithRoomRequest request) Associates a device to a given room.
AssociateSkillGroupWithRoomResult	associateSkillGroupWithRoom(AssociateSkillGroupWithRoomRequest request) Associates a skill group to a given room.
static AmazonAlexaForBusinessClientBuilder	builder()
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.
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.
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.
DisassociateDeviceFromRoomResult	disassociateDeviceFromRoom(DisassociateDeviceFromRoomRequest request) Disassociates a device from its current room.
DisassociateSkillGroupFromRoomResult	disassociateSkillGroupFromRoom(DisassociateSkillGroupFromRoomRequest request) Disassociates a skill group from a specified room.
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.
GetDeviceResult	getDevice(GetDeviceRequest request) Gets the details of a device by device 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.
ListSkillsResult	listSkills(ListSkillsRequest request) Lists all enabled skills in a specific skill group.
ListTagsResult	listTags(ListTagsRequest request) Lists all tags for a specific resource.
PutRoomSkillParameterResult	putRoomSkillParameter(PutRoomSkillParameterRequest request) Updates room skill parameter details by room, skill, and parameter key ID.
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.
SearchDevicesResult	searchDevices(SearchDevicesRequest request) Searches devices and lists the ones that meet a set of filter 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.
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 by clearing all information and settings set by previous users.
TagResourceResult	tagResource(TagResourceRequest request) Adds metadata tags to a specified resource.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes metadata tags from a specified resource.
UpdateDeviceResult	updateDevice(UpdateDeviceRequest request) Updates the device name by device 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, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, 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()

associateDeviceWithRoom

public AssociateDeviceWithRoomResult associateDeviceWithRoom(AssociateDeviceWithRoomRequest request)

Associates a device to 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 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. HTTP Status Code: 400

See Also:

AWS API Documentation

associateSkillGroupWithRoom

public AssociateSkillGroupWithRoomResult associateSkillGroupWithRoom(AssociateSkillGroupWithRoomRequest request)

Associates a skill group to 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.

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. HTTP Status Code: 400

AlreadyExistsException - The resource being created already exists. HTTP Status Code: 400

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. HTTP Status Code: 400

LimitExceededException - You are performing an action that would put you beyond your account's limits. HTTP Status Code: 400

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. HTTP Status Code: 400

LimitExceededException - You are performing an action that would put you beyond your account's limits. HTTP Status Code: 400

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. HTTP Status Code: 400

LimitExceededException - You are performing an action that would put you beyond your account's limits. HTTP Status Code: 400

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. HTTP Status Code: 400

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. HTTP Status Code: 400

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.

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. HTTP Status Code: 400

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. HTTP Status Code: 400

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.

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.

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. HTTP Status Code: 400

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. HTTP Status Code: 400

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. HTTP Status Code: 400

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. HTTP Status Code: 400

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. HTTP Status Code: 400

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

listTags

public ListTagsResult listTags(ListTagsRequest request)

Lists all tags for a specific 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. HTTP Status Code: 400

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.

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. HTTP Status Code: 400

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. HTTP Status Code: 400

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

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

sendInvitation

public SendInvitationResult sendInvitation(SendInvitationRequest request)

Sends an enrollment invitation email with a URL to a user. The URL is valid for 72 hours 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. HTTP Status Code: 400

InvalidUserStatusException - The attempt to update a user is invalid due to the user's current status. HTTP Status Code: 400

See Also:

AWS API Documentation

startDeviceSync

public StartDeviceSyncResult startDeviceSync(StartDeviceSyncRequest request)

Resets a device and its account to the known default settings by clearing all information and settings set by previous users.

Specified by:

startDeviceSync in interface AmazonAlexaForBusiness

Parameters:

startDeviceSyncRequest -

Returns:

Result of the StartDeviceSync operation returned by the service.

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. HTTP Status Code: 400

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. HTTP Status Code: 400

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. HTTP Status Code: 400

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. HTTP Status Code: 400

NameInUseException - The name sent in the request is already in use. HTTP Status Code: 400

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. HTTP Status Code: 400

NameInUseException - The name sent in the request is already in use. HTTP Status Code: 400

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. HTTP Status Code: 400

NameInUseException - The name sent in the request is already in use. HTTP Status Code: 400

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.