com.amazonaws.services.alexaforbusiness

Class AbstractAmazonAlexaForBusiness

java.lang.Object

com.amazonaws.services.alexaforbusiness.AbstractAmazonAlexaForBusiness

All Implemented Interfaces:

AmazonAlexaForBusiness

Direct Known Subclasses:

AbstractAmazonAlexaForBusinessAsync

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonAlexaForBusiness
extends Object
implements AmazonAlexaForBusiness

Abstract implementation of AmazonAlexaForBusiness. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary

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

ENDPOINT_PREFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAmazonAlexaForBusiness()

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.
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.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
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 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractAmazonAlexaForBusiness

protected AbstractAmazonAlexaForBusiness()

Method Detail

associateDeviceWithRoom

public AssociateDeviceWithRoomResult associateDeviceWithRoom(AssociateDeviceWithRoomRequest request)

Description copied from interface: AmazonAlexaForBusiness

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

Returns:

Result of the AssociateDeviceWithRoom operation returned by the service.

See Also:

AWS API Documentation

associateSkillGroupWithRoom

public AssociateSkillGroupWithRoomResult associateSkillGroupWithRoom(AssociateSkillGroupWithRoomRequest request)

Description copied from interface: AmazonAlexaForBusiness

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

Returns:

Result of the AssociateSkillGroupWithRoom operation returned by the service.

See Also:

AWS API Documentation

createProfile

public CreateProfileResult createProfile(CreateProfileRequest request)

Description copied from interface: AmazonAlexaForBusiness

Creates a new room profile with the specified details.

Specified by:

createProfile in interface AmazonAlexaForBusiness

Returns:

Result of the CreateProfile operation returned by the service.

See Also:

AWS API Documentation

createRoom

public CreateRoomResult createRoom(CreateRoomRequest request)

Description copied from interface: AmazonAlexaForBusiness

Creates a room with the specified details.

Specified by:

createRoom in interface AmazonAlexaForBusiness

Returns:

Result of the CreateRoom operation returned by the service.

See Also:

AWS API Documentation

createSkillGroup

public CreateSkillGroupResult createSkillGroup(CreateSkillGroupRequest request)

Description copied from interface: AmazonAlexaForBusiness

Creates a skill group with a specified name and description.

Specified by:

createSkillGroup in interface AmazonAlexaForBusiness

Returns:

Result of the CreateSkillGroup operation returned by the service.

See Also:

AWS API Documentation

createUser

public CreateUserResult createUser(CreateUserRequest request)

Description copied from interface: AmazonAlexaForBusiness

Creates a user.

Specified by:

createUser in interface AmazonAlexaForBusiness

Returns:

Result of the CreateUser operation returned by the service.

See Also:

AWS API Documentation

deleteProfile

public DeleteProfileResult deleteProfile(DeleteProfileRequest request)

Description copied from interface: AmazonAlexaForBusiness

Deletes a room profile by the profile ARN.

Specified by:

deleteProfile in interface AmazonAlexaForBusiness

Returns:

Result of the DeleteProfile operation returned by the service.

See Also:

AWS API Documentation

deleteRoom

public DeleteRoomResult deleteRoom(DeleteRoomRequest request)

Description copied from interface: AmazonAlexaForBusiness

Deletes a room by the room ARN.

Specified by:

deleteRoom in interface AmazonAlexaForBusiness

Returns:

Result of the DeleteRoom operation returned by the service.

See Also:

AWS API Documentation

deleteRoomSkillParameter

public DeleteRoomSkillParameterResult deleteRoomSkillParameter(DeleteRoomSkillParameterRequest request)

Description copied from interface: AmazonAlexaForBusiness

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

Specified by:

deleteRoomSkillParameter in interface AmazonAlexaForBusiness

Returns:

Result of the DeleteRoomSkillParameter operation returned by the service.

See Also:

AWS API Documentation

deleteSkillGroup

public DeleteSkillGroupResult deleteSkillGroup(DeleteSkillGroupRequest request)

Description copied from interface: AmazonAlexaForBusiness

Deletes a skill group by skill group ARN.

Specified by:

deleteSkillGroup in interface AmazonAlexaForBusiness

Returns:

Result of the DeleteSkillGroup operation returned by the service.

See Also:

AWS API Documentation

deleteUser

public DeleteUserResult deleteUser(DeleteUserRequest request)

Description copied from interface: AmazonAlexaForBusiness

Deletes a specified user by user ARN and enrollment ARN.

Specified by:

deleteUser in interface AmazonAlexaForBusiness

Returns:

Result of the DeleteUser operation returned by the service.

See Also:

AWS API Documentation

disassociateDeviceFromRoom

public DisassociateDeviceFromRoomResult disassociateDeviceFromRoom(DisassociateDeviceFromRoomRequest request)

Description copied from interface: AmazonAlexaForBusiness

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

Returns:

Result of the DisassociateDeviceFromRoom operation returned by the service.

See Also:

AWS API Documentation

disassociateSkillGroupFromRoom

public DisassociateSkillGroupFromRoomResult disassociateSkillGroupFromRoom(DisassociateSkillGroupFromRoomRequest request)

Description copied from interface: AmazonAlexaForBusiness

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

Returns:

Result of the DisassociateSkillGroupFromRoom operation returned by the service.

See Also:

AWS API Documentation

getDevice

public GetDeviceResult getDevice(GetDeviceRequest request)

Description copied from interface: AmazonAlexaForBusiness

Gets the details of a device by device ARN.

Specified by:

getDevice in interface AmazonAlexaForBusiness

Returns:

Result of the GetDevice operation returned by the service.

See Also:

AWS API Documentation

getProfile

public GetProfileResult getProfile(GetProfileRequest request)

Description copied from interface: AmazonAlexaForBusiness

Gets the details of a room profile by profile ARN.

Specified by:

getProfile in interface AmazonAlexaForBusiness

Returns:

Result of the GetProfile operation returned by the service.

See Also:

AWS API Documentation

getRoom

public GetRoomResult getRoom(GetRoomRequest request)

Description copied from interface: AmazonAlexaForBusiness

Gets room details by room ARN.

Specified by:

getRoom in interface AmazonAlexaForBusiness

Returns:

Result of the GetRoom operation returned by the service.

See Also:

AWS API Documentation

getRoomSkillParameter

public GetRoomSkillParameterResult getRoomSkillParameter(GetRoomSkillParameterRequest request)

Description copied from interface: AmazonAlexaForBusiness

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

Specified by:

getRoomSkillParameter in interface AmazonAlexaForBusiness

Returns:

Result of the GetRoomSkillParameter operation returned by the service.

See Also:

AWS API Documentation

getSkillGroup

public GetSkillGroupResult getSkillGroup(GetSkillGroupRequest request)

Description copied from interface: AmazonAlexaForBusiness

Gets skill group details by skill group ARN.

Specified by:

getSkillGroup in interface AmazonAlexaForBusiness

Returns:

Result of the GetSkillGroup operation returned by the service.

See Also:

AWS API Documentation

listSkills

public ListSkillsResult listSkills(ListSkillsRequest request)

Description copied from interface: AmazonAlexaForBusiness

Lists all enabled skills in a specific skill group.

Specified by:

listSkills in interface AmazonAlexaForBusiness

Returns:

Result of the ListSkills operation returned by the service.

See Also:

AWS API Documentation

listTags

public ListTagsResult listTags(ListTagsRequest request)

Description copied from interface: AmazonAlexaForBusiness

Lists all tags for a specific resource.

Specified by:

listTags in interface AmazonAlexaForBusiness

Returns:

Result of the ListTags operation returned by the service.

See Also:

AWS API Documentation

putRoomSkillParameter

public PutRoomSkillParameterResult putRoomSkillParameter(PutRoomSkillParameterRequest request)

Description copied from interface: AmazonAlexaForBusiness

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

Returns:

Result of the PutRoomSkillParameter operation returned by the service.

See Also:

AWS API Documentation

resolveRoom

public ResolveRoomResult resolveRoom(ResolveRoomRequest request)

Description copied from interface: AmazonAlexaForBusiness

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

Returns:

Result of the ResolveRoom operation returned by the service.

See Also:

AWS API Documentation

revokeInvitation

public RevokeInvitationResult revokeInvitation(RevokeInvitationRequest request)

Description copied from interface: AmazonAlexaForBusiness

Revokes an invitation and invalidates the enrollment URL.

Specified by:

revokeInvitation in interface AmazonAlexaForBusiness

Returns:

Result of the RevokeInvitation operation returned by the service.

See Also:

AWS API Documentation

searchDevices

public SearchDevicesResult searchDevices(SearchDevicesRequest request)

Description copied from interface: AmazonAlexaForBusiness

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

Specified by:

searchDevices in interface AmazonAlexaForBusiness

Returns:

Result of the SearchDevices operation returned by the service.

See Also:

AWS API Documentation

searchProfiles

public SearchProfilesResult searchProfiles(SearchProfilesRequest request)

Description copied from interface: AmazonAlexaForBusiness

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

Specified by:

searchProfiles in interface AmazonAlexaForBusiness

Returns:

Result of the SearchProfiles operation returned by the service.

See Also:

AWS API Documentation

searchRooms

public SearchRoomsResult searchRooms(SearchRoomsRequest request)

Description copied from interface: AmazonAlexaForBusiness

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

Specified by:

searchRooms in interface AmazonAlexaForBusiness

Returns:

Result of the SearchRooms operation returned by the service.

See Also:

AWS API Documentation

searchSkillGroups

public SearchSkillGroupsResult searchSkillGroups(SearchSkillGroupsRequest request)

Description copied from interface: AmazonAlexaForBusiness

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

Specified by:

searchSkillGroups in interface AmazonAlexaForBusiness

Returns:

Result of the SearchSkillGroups operation returned by the service.

See Also:

AWS API Documentation

searchUsers

public SearchUsersResult searchUsers(SearchUsersRequest request)

Description copied from interface: AmazonAlexaForBusiness

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

Specified by:

searchUsers in interface AmazonAlexaForBusiness

Returns:

Result of the SearchUsers operation returned by the service.

See Also:

AWS API Documentation

sendInvitation

public SendInvitationResult sendInvitation(SendInvitationRequest request)

Description copied from interface: AmazonAlexaForBusiness

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

Returns:

Result of the SendInvitation operation returned by the service.

See Also:

AWS API Documentation

startDeviceSync

public StartDeviceSyncResult startDeviceSync(StartDeviceSyncRequest request)

Description copied from interface: AmazonAlexaForBusiness

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

Returns:

Result of the StartDeviceSync operation returned by the service.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Description copied from interface: AmazonAlexaForBusiness

Adds metadata tags to a specified resource.

Specified by:

tagResource in interface AmazonAlexaForBusiness

Returns:

Result of the TagResource operation returned by the service.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Description copied from interface: AmazonAlexaForBusiness

Removes metadata tags from a specified resource.

Specified by:

untagResource in interface AmazonAlexaForBusiness

Returns:

Result of the UntagResource operation returned by the service.

See Also:

AWS API Documentation

updateDevice

public UpdateDeviceResult updateDevice(UpdateDeviceRequest request)

Description copied from interface: AmazonAlexaForBusiness

Updates the device name by device ARN.

Specified by:

updateDevice in interface AmazonAlexaForBusiness

Returns:

Result of the UpdateDevice operation returned by the service.

See Also:

AWS API Documentation

updateProfile

public UpdateProfileResult updateProfile(UpdateProfileRequest request)

Description copied from interface: AmazonAlexaForBusiness

Updates an existing room profile by room profile ARN.

Specified by:

updateProfile in interface AmazonAlexaForBusiness

Returns:

Result of the UpdateProfile operation returned by the service.

See Also:

AWS API Documentation

updateRoom

public UpdateRoomResult updateRoom(UpdateRoomRequest request)

Description copied from interface: AmazonAlexaForBusiness

Updates room details by room ARN.

Specified by:

updateRoom in interface AmazonAlexaForBusiness

Returns:

Result of the UpdateRoom operation returned by the service.

See Also:

AWS API Documentation

updateSkillGroup

public UpdateSkillGroupResult updateSkillGroup(UpdateSkillGroupRequest request)

Description copied from interface: AmazonAlexaForBusiness

Updates skill group details by skill group ARN.

Specified by:

updateSkillGroup in interface AmazonAlexaForBusiness

Returns:

Result of the UpdateSkillGroup operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Description copied from interface: AmazonAlexaForBusiness

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.

Specified by:

shutdown in interface AmazonAlexaForBusiness

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Description copied from interface: AmazonAlexaForBusiness

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.

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.