com.amazonaws.services.alexaforbusiness

Interface AmazonAlexaForBusiness

All Known Subinterfaces:

AmazonAlexaForBusinessAsync

All Known Implementing Classes:

AbstractAmazonAlexaForBusiness, AbstractAmazonAlexaForBusinessAsync, AmazonAlexaForBusinessAsyncClient, AmazonAlexaForBusinessClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonAlexaForBusiness

Interface for accessing Alexa For Business.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonAlexaForBusiness instead.

Alexa for Business 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
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
AssociateDeviceWithRoomResult	associateDeviceWithRoom(AssociateDeviceWithRoomRequest associateDeviceWithRoomRequest) Associates a device to a given room.
AssociateSkillGroupWithRoomResult	associateSkillGroupWithRoom(AssociateSkillGroupWithRoomRequest associateSkillGroupWithRoomRequest) Associates a skill group to a given room.
CreateProfileResult	createProfile(CreateProfileRequest createProfileRequest) Creates a new room profile with the specified details.
CreateRoomResult	createRoom(CreateRoomRequest createRoomRequest) Creates a room with the specified details.
CreateSkillGroupResult	createSkillGroup(CreateSkillGroupRequest createSkillGroupRequest) Creates a skill group with a specified name and description.
CreateUserResult	createUser(CreateUserRequest createUserRequest) Creates a user.
DeleteProfileResult	deleteProfile(DeleteProfileRequest deleteProfileRequest) Deletes a room profile by the profile ARN.
DeleteRoomResult	deleteRoom(DeleteRoomRequest deleteRoomRequest) Deletes a room by the room ARN.
DeleteRoomSkillParameterResult	deleteRoomSkillParameter(DeleteRoomSkillParameterRequest deleteRoomSkillParameterRequest) Deletes room skill parameter details by room, skill, and parameter key ID.
DeleteSkillGroupResult	deleteSkillGroup(DeleteSkillGroupRequest deleteSkillGroupRequest) Deletes a skill group by skill group ARN.
DeleteUserResult	deleteUser(DeleteUserRequest deleteUserRequest) Deletes a specified user by user ARN and enrollment ARN.
DisassociateDeviceFromRoomResult	disassociateDeviceFromRoom(DisassociateDeviceFromRoomRequest disassociateDeviceFromRoomRequest) Disassociates a device from its current room.
DisassociateSkillGroupFromRoomResult	disassociateSkillGroupFromRoom(DisassociateSkillGroupFromRoomRequest disassociateSkillGroupFromRoomRequest) 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 getDeviceRequest) Gets the details of a device by device ARN.
GetProfileResult	getProfile(GetProfileRequest getProfileRequest) Gets the details of a room profile by profile ARN.
GetRoomResult	getRoom(GetRoomRequest getRoomRequest) Gets room details by room ARN.
GetRoomSkillParameterResult	getRoomSkillParameter(GetRoomSkillParameterRequest getRoomSkillParameterRequest) Gets room skill parameter details by room, skill, and parameter key ARN.
GetSkillGroupResult	getSkillGroup(GetSkillGroupRequest getSkillGroupRequest) Gets skill group details by skill group ARN.
ListSkillsResult	listSkills(ListSkillsRequest listSkillsRequest) Lists all enabled skills in a specific skill group.
ListTagsResult	listTags(ListTagsRequest listTagsRequest) Lists all tags for a specific resource.
PutRoomSkillParameterResult	putRoomSkillParameter(PutRoomSkillParameterRequest putRoomSkillParameterRequest) Updates room skill parameter details by room, skill, and parameter key ID.
ResolveRoomResult	resolveRoom(ResolveRoomRequest resolveRoomRequest) Determines the details for the room from which a skill request was invoked.
RevokeInvitationResult	revokeInvitation(RevokeInvitationRequest revokeInvitationRequest) Revokes an invitation and invalidates the enrollment URL.
SearchDevicesResult	searchDevices(SearchDevicesRequest searchDevicesRequest) Searches devices and lists the ones that meet a set of filter criteria.
SearchProfilesResult	searchProfiles(SearchProfilesRequest searchProfilesRequest) Searches room profiles and lists the ones that meet a set of filter criteria.
SearchRoomsResult	searchRooms(SearchRoomsRequest searchRoomsRequest) Searches rooms and lists the ones that meet a set of filter and sort criteria.
SearchSkillGroupsResult	searchSkillGroups(SearchSkillGroupsRequest searchSkillGroupsRequest) Searches skill groups and lists the ones that meet a set of filter and sort criteria.
SearchUsersResult	searchUsers(SearchUsersRequest searchUsersRequest) Searches users and lists the ones that meet a set of filter and sort criteria.
SendInvitationResult	sendInvitation(SendInvitationRequest sendInvitationRequest) Sends an enrollment invitation email with a URL to a user.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartDeviceSyncResult	startDeviceSync(StartDeviceSyncRequest startDeviceSyncRequest) Resets a device and its account to the known default settings by clearing all information and settings set by previous users.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Adds metadata tags to a specified resource.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes metadata tags from a specified resource.
UpdateDeviceResult	updateDevice(UpdateDeviceRequest updateDeviceRequest) Updates the device name by device ARN.
UpdateProfileResult	updateProfile(UpdateProfileRequest updateProfileRequest) Updates an existing room profile by room profile ARN.
UpdateRoomResult	updateRoom(UpdateRoomRequest updateRoomRequest) Updates room details by room ARN.
UpdateSkillGroupResult	updateSkillGroup(UpdateSkillGroupRequest updateSkillGroupRequest) Updates skill group details by skill group ARN.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

associateDeviceWithRoom

AssociateDeviceWithRoomResult associateDeviceWithRoom(AssociateDeviceWithRoomRequest associateDeviceWithRoomRequest)

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.

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

AssociateSkillGroupWithRoomResult associateSkillGroupWithRoom(AssociateSkillGroupWithRoomRequest associateSkillGroupWithRoomRequest)

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

Parameters:

associateSkillGroupWithRoomRequest -

Returns:

Result of the AssociateSkillGroupWithRoom operation returned by the service.

See Also:

AWS API Documentation

createProfile

CreateProfileResult createProfile(CreateProfileRequest createProfileRequest)

Creates a new room profile with the specified details.

Parameters:

createProfileRequest -

Returns:

Result of the CreateProfile operation returned by the service.

Throws:

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

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

See Also:

AWS API Documentation

createRoom

CreateRoomResult createRoom(CreateRoomRequest createRoomRequest)

Creates a room with the specified details.

Parameters:

createRoomRequest -

Returns:

Result of the CreateRoom operation returned by the service.

Throws:

AlreadyExistsException - The resource being created already exists. 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

CreateSkillGroupResult createSkillGroup(CreateSkillGroupRequest createSkillGroupRequest)

Creates a skill group with a specified name and description.

Parameters:

createSkillGroupRequest -

Returns:

Result of the CreateSkillGroup operation returned by the service.

Throws:

AlreadyExistsException - The resource being created already exists. 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

CreateUserResult createUser(CreateUserRequest createUserRequest)

Creates a user.

Parameters:

createUserRequest -

Returns:

Result of the CreateUser operation returned by the service.

Throws:

ResourceInUseException - The resource in the request is already in use. 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

DeleteProfileResult deleteProfile(DeleteProfileRequest deleteProfileRequest)

Deletes a room profile by the profile ARN.

Parameters:

deleteProfileRequest -

Returns:

Result of the DeleteProfile operation returned by the service.

Throws:

NotFoundException - The resource is not found. HTTP Status Code: 400

See Also:

AWS API Documentation

deleteRoom

DeleteRoomResult deleteRoom(DeleteRoomRequest deleteRoomRequest)

Deletes a room by the room ARN.

Parameters:

deleteRoomRequest -

Returns:

Result of the DeleteRoom operation returned by the service.

Throws:

NotFoundException - The resource is not found. HTTP Status Code: 400

See Also:

AWS API Documentation

deleteRoomSkillParameter

DeleteRoomSkillParameterResult deleteRoomSkillParameter(DeleteRoomSkillParameterRequest deleteRoomSkillParameterRequest)

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

Parameters:

deleteRoomSkillParameterRequest -

Returns:

Result of the DeleteRoomSkillParameter operation returned by the service.

See Also:

AWS API Documentation

deleteSkillGroup

DeleteSkillGroupResult deleteSkillGroup(DeleteSkillGroupRequest deleteSkillGroupRequest)

Deletes a skill group by skill group ARN.

Parameters:

deleteSkillGroupRequest -

Returns:

Result of the DeleteSkillGroup operation returned by the service.

Throws:

NotFoundException - The resource is not found. HTTP Status Code: 400

See Also:

AWS API Documentation

deleteUser

DeleteUserResult deleteUser(DeleteUserRequest deleteUserRequest)

Deletes a specified user by user ARN and enrollment ARN.

Parameters:

deleteUserRequest -

Returns:

Result of the DeleteUser operation returned by the service.

Throws:

NotFoundException - The resource is not found. HTTP Status Code: 400

See Also:

AWS API Documentation

disassociateDeviceFromRoom

DisassociateDeviceFromRoomResult disassociateDeviceFromRoom(DisassociateDeviceFromRoomRequest disassociateDeviceFromRoomRequest)

Disassociates a device from its current room. The device continues to be connected to the Wi-Fi network and is still registered to the account. The device settings and skills are removed from the room.

Parameters:

disassociateDeviceFromRoomRequest -

Returns:

Result of the DisassociateDeviceFromRoom operation returned by the service.

See Also:

AWS API Documentation

disassociateSkillGroupFromRoom

DisassociateSkillGroupFromRoomResult disassociateSkillGroupFromRoom(DisassociateSkillGroupFromRoomRequest disassociateSkillGroupFromRoomRequest)

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

Parameters:

disassociateSkillGroupFromRoomRequest -

Returns:

Result of the DisassociateSkillGroupFromRoom operation returned by the service.

See Also:

AWS API Documentation

getDevice

GetDeviceResult getDevice(GetDeviceRequest getDeviceRequest)

Gets the details of a device by device ARN.

Parameters:

getDeviceRequest -

Returns:

Result of the GetDevice operation returned by the service.

Throws:

NotFoundException - The resource is not found. HTTP Status Code: 400

See Also:

AWS API Documentation

getProfile

GetProfileResult getProfile(GetProfileRequest getProfileRequest)

Gets the details of a room profile by profile ARN.

Parameters:

getProfileRequest -

Returns:

Result of the GetProfile operation returned by the service.

Throws:

NotFoundException - The resource is not found. HTTP Status Code: 400

See Also:

AWS API Documentation

getRoom

GetRoomResult getRoom(GetRoomRequest getRoomRequest)

Gets room details by room ARN.

Parameters:

getRoomRequest -

Returns:

Result of the GetRoom operation returned by the service.

Throws:

NotFoundException - The resource is not found. HTTP Status Code: 400

See Also:

AWS API Documentation

getRoomSkillParameter

GetRoomSkillParameterResult getRoomSkillParameter(GetRoomSkillParameterRequest getRoomSkillParameterRequest)

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

Parameters:

getRoomSkillParameterRequest -

Returns:

Result of the GetRoomSkillParameter operation returned by the service.

Throws:

NotFoundException - The resource is not found. HTTP Status Code: 400

See Also:

AWS API Documentation

getSkillGroup

GetSkillGroupResult getSkillGroup(GetSkillGroupRequest getSkillGroupRequest)

Gets skill group details by skill group ARN.

Parameters:

getSkillGroupRequest -

Returns:

Result of the GetSkillGroup operation returned by the service.

Throws:

NotFoundException - The resource is not found. HTTP Status Code: 400

See Also:

AWS API Documentation

listSkills

ListSkillsResult listSkills(ListSkillsRequest listSkillsRequest)

Lists all enabled skills in a specific skill group.

Parameters:

listSkillsRequest -

Returns:

Result of the ListSkills operation returned by the service.

See Also:

AWS API Documentation

listTags

ListTagsResult listTags(ListTagsRequest listTagsRequest)

Lists all tags for a specific resource.

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

PutRoomSkillParameterResult putRoomSkillParameter(PutRoomSkillParameterRequest putRoomSkillParameterRequest)

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

Parameters:

putRoomSkillParameterRequest -

Returns:

Result of the PutRoomSkillParameter operation returned by the service.

See Also:

AWS API Documentation

resolveRoom

ResolveRoomResult resolveRoom(ResolveRoomRequest resolveRoomRequest)

Determines the details for the room from which a skill request was invoked. This operation is used by skill developers.

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

RevokeInvitationResult revokeInvitation(RevokeInvitationRequest revokeInvitationRequest)

Revokes an invitation and invalidates the enrollment URL.

Parameters:

revokeInvitationRequest -

Returns:

Result of the RevokeInvitation operation returned by the service.

Throws:

NotFoundException - The resource is not found. HTTP Status Code: 400

See Also:

AWS API Documentation

searchDevices

SearchDevicesResult searchDevices(SearchDevicesRequest searchDevicesRequest)

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

Parameters:

searchDevicesRequest -

Returns:

Result of the SearchDevices operation returned by the service.

See Also:

AWS API Documentation

searchProfiles

SearchProfilesResult searchProfiles(SearchProfilesRequest searchProfilesRequest)

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

Parameters:

searchProfilesRequest -

Returns:

Result of the SearchProfiles operation returned by the service.

See Also:

AWS API Documentation

searchRooms

SearchRoomsResult searchRooms(SearchRoomsRequest searchRoomsRequest)

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

Parameters:

searchRoomsRequest -

Returns:

Result of the SearchRooms operation returned by the service.

See Also:

AWS API Documentation

searchSkillGroups

SearchSkillGroupsResult searchSkillGroups(SearchSkillGroupsRequest searchSkillGroupsRequest)

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

Parameters:

searchSkillGroupsRequest -

Returns:

Result of the SearchSkillGroups operation returned by the service.

See Also:

AWS API Documentation

searchUsers

SearchUsersResult searchUsers(SearchUsersRequest searchUsersRequest)

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

Parameters:

searchUsersRequest -

Returns:

Result of the SearchUsers operation returned by the service.

See Also:

AWS API Documentation

sendInvitation

SendInvitationResult sendInvitation(SendInvitationRequest sendInvitationRequest)

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.

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

StartDeviceSyncResult startDeviceSync(StartDeviceSyncRequest startDeviceSyncRequest)

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

Parameters:

startDeviceSyncRequest -

Returns:

Result of the StartDeviceSync operation returned by the service.

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Adds metadata tags to a specified resource.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

NotFoundException - The resource is not found. HTTP Status Code: 400

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes metadata tags from a specified resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

NotFoundException - The resource is not found. HTTP Status Code: 400

See Also:

AWS API Documentation

updateDevice

UpdateDeviceResult updateDevice(UpdateDeviceRequest updateDeviceRequest)

Updates the device name by device ARN.

Parameters:

updateDeviceRequest -

Returns:

Result of the UpdateDevice operation returned by the service.

Throws:

NotFoundException - The resource is not found. HTTP Status Code: 400

See Also:

AWS API Documentation

updateProfile

UpdateProfileResult updateProfile(UpdateProfileRequest updateProfileRequest)

Updates an existing room profile by room profile ARN.

Parameters:

updateProfileRequest -

Returns:

Result of the UpdateProfile operation returned by the service.

Throws:

NotFoundException - The resource is not found. 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

UpdateRoomResult updateRoom(UpdateRoomRequest updateRoomRequest)

Updates room details by room ARN.

Parameters:

updateRoomRequest -

Returns:

Result of the UpdateRoom operation returned by the service.

Throws:

NotFoundException - The resource is not found. 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

UpdateSkillGroupResult updateSkillGroup(UpdateSkillGroupRequest updateSkillGroupRequest)

Updates skill group details by skill group ARN.

Parameters:

updateSkillGroupRequest -

Returns:

Result of the UpdateSkillGroup operation returned by the service.

Throws:

NotFoundException - The resource is not found. HTTP Status Code: 400

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

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.