@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonAlexaForBusiness extends Object implements AmazonAlexaForBusiness
AmazonAlexaForBusiness
. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
AssociateContactWithAddressBookResult |
associateContactWithAddressBook(AssociateContactWithAddressBookRequest request)
Associates a contact with a given address book.
|
AssociateDeviceWithRoomResult |
associateDeviceWithRoom(AssociateDeviceWithRoomRequest request)
Associates a device with a given room.
|
AssociateSkillGroupWithRoomResult |
associateSkillGroupWithRoom(AssociateSkillGroupWithRoomRequest request)
Associates a skill group with a given room.
|
CreateAddressBookResult |
createAddressBook(CreateAddressBookRequest request)
Creates an address book with the specified details.
|
CreateContactResult |
createContact(CreateContactRequest request)
Creates a contact 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.
|
DeleteContactResult |
deleteContact(DeleteContactRequest request)
Deletes a contact by the contact 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.
|
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.
|
DisassociateSkillGroupFromRoomResult |
disassociateSkillGroupFromRoom(DisassociateSkillGroupFromRoomRequest request)
Disassociates a skill group from a specified 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.
|
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.
|
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.
|
ListDeviceEventsResult |
listDeviceEvents(ListDeviceEventsRequest request)
Lists the device event history, including device connection status, for up to 30 days.
|
ListSkillsResult |
listSkills(ListSkillsRequest request)
Lists all enabled skills in a specific skill group.
|
ListTagsResult |
listTags(ListTagsRequest request)
Lists all tags for the specified 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.
|
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.
|
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.
|
UpdateAddressBookResult |
updateAddressBook(UpdateAddressBookRequest request)
Updates address book details by the address book ARN.
|
UpdateContactResult |
updateContact(UpdateContactRequest request)
Updates the contact details by the contact ARN.
|
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.
|
public AssociateContactWithAddressBookResult associateContactWithAddressBook(AssociateContactWithAddressBookRequest request)
AmazonAlexaForBusiness
Associates a contact with a given address book.
associateContactWithAddressBook
in interface AmazonAlexaForBusiness
public AssociateDeviceWithRoomResult associateDeviceWithRoom(AssociateDeviceWithRoomRequest request)
AmazonAlexaForBusiness
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.
associateDeviceWithRoom
in interface AmazonAlexaForBusiness
public AssociateSkillGroupWithRoomResult associateSkillGroupWithRoom(AssociateSkillGroupWithRoomRequest request)
AmazonAlexaForBusiness
Associates a skill group with a given room. This enables all skills in the associated skill group on all devices in the room.
associateSkillGroupWithRoom
in interface AmazonAlexaForBusiness
public CreateAddressBookResult createAddressBook(CreateAddressBookRequest request)
AmazonAlexaForBusiness
Creates an address book with the specified details.
createAddressBook
in interface AmazonAlexaForBusiness
public CreateContactResult createContact(CreateContactRequest request)
AmazonAlexaForBusiness
Creates a contact with the specified details.
createContact
in interface AmazonAlexaForBusiness
public CreateProfileResult createProfile(CreateProfileRequest request)
AmazonAlexaForBusiness
Creates a new room profile with the specified details.
createProfile
in interface AmazonAlexaForBusiness
public CreateRoomResult createRoom(CreateRoomRequest request)
AmazonAlexaForBusiness
Creates a room with the specified details.
createRoom
in interface AmazonAlexaForBusiness
public CreateSkillGroupResult createSkillGroup(CreateSkillGroupRequest request)
AmazonAlexaForBusiness
Creates a skill group with a specified name and description.
createSkillGroup
in interface AmazonAlexaForBusiness
public CreateUserResult createUser(CreateUserRequest request)
AmazonAlexaForBusiness
Creates a user.
createUser
in interface AmazonAlexaForBusiness
public DeleteAddressBookResult deleteAddressBook(DeleteAddressBookRequest request)
AmazonAlexaForBusiness
Deletes an address book by the address book ARN.
deleteAddressBook
in interface AmazonAlexaForBusiness
public DeleteContactResult deleteContact(DeleteContactRequest request)
AmazonAlexaForBusiness
Deletes a contact by the contact ARN.
deleteContact
in interface AmazonAlexaForBusiness
public DeleteProfileResult deleteProfile(DeleteProfileRequest request)
AmazonAlexaForBusiness
Deletes a room profile by the profile ARN.
deleteProfile
in interface AmazonAlexaForBusiness
public DeleteRoomResult deleteRoom(DeleteRoomRequest request)
AmazonAlexaForBusiness
Deletes a room by the room ARN.
deleteRoom
in interface AmazonAlexaForBusiness
public DeleteRoomSkillParameterResult deleteRoomSkillParameter(DeleteRoomSkillParameterRequest request)
AmazonAlexaForBusiness
Deletes room skill parameter details by room, skill, and parameter key ID.
deleteRoomSkillParameter
in interface AmazonAlexaForBusiness
public DeleteSkillGroupResult deleteSkillGroup(DeleteSkillGroupRequest request)
AmazonAlexaForBusiness
Deletes a skill group by skill group ARN.
deleteSkillGroup
in interface AmazonAlexaForBusiness
public DeleteUserResult deleteUser(DeleteUserRequest request)
AmazonAlexaForBusiness
Deletes a specified user by user ARN and enrollment ARN.
deleteUser
in interface AmazonAlexaForBusiness
public DisassociateContactFromAddressBookResult disassociateContactFromAddressBook(DisassociateContactFromAddressBookRequest request)
AmazonAlexaForBusiness
Disassociates a contact from a given address book.
disassociateContactFromAddressBook
in interface AmazonAlexaForBusiness
public DisassociateDeviceFromRoomResult disassociateDeviceFromRoom(DisassociateDeviceFromRoomRequest request)
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.
disassociateDeviceFromRoom
in interface AmazonAlexaForBusiness
public DisassociateSkillGroupFromRoomResult disassociateSkillGroupFromRoom(DisassociateSkillGroupFromRoomRequest request)
AmazonAlexaForBusiness
Disassociates a skill group from a specified room. This disables all skills in the skill group on all devices in the room.
disassociateSkillGroupFromRoom
in interface AmazonAlexaForBusiness
public GetAddressBookResult getAddressBook(GetAddressBookRequest request)
AmazonAlexaForBusiness
Gets address the book details by the address book ARN.
getAddressBook
in interface AmazonAlexaForBusiness
public GetContactResult getContact(GetContactRequest request)
AmazonAlexaForBusiness
Gets the contact details by the contact ARN.
getContact
in interface AmazonAlexaForBusiness
public GetDeviceResult getDevice(GetDeviceRequest request)
AmazonAlexaForBusiness
Gets the details of a device by device ARN.
getDevice
in interface AmazonAlexaForBusiness
public GetProfileResult getProfile(GetProfileRequest request)
AmazonAlexaForBusiness
Gets the details of a room profile by profile ARN.
getProfile
in interface AmazonAlexaForBusiness
public GetRoomResult getRoom(GetRoomRequest request)
AmazonAlexaForBusiness
Gets room details by room ARN.
getRoom
in interface AmazonAlexaForBusiness
public GetRoomSkillParameterResult getRoomSkillParameter(GetRoomSkillParameterRequest request)
AmazonAlexaForBusiness
Gets room skill parameter details by room, skill, and parameter key ARN.
getRoomSkillParameter
in interface AmazonAlexaForBusiness
public GetSkillGroupResult getSkillGroup(GetSkillGroupRequest request)
AmazonAlexaForBusiness
Gets skill group details by skill group ARN.
getSkillGroup
in interface AmazonAlexaForBusiness
public ListDeviceEventsResult listDeviceEvents(ListDeviceEventsRequest request)
AmazonAlexaForBusiness
Lists the device event history, including device connection status, for up to 30 days.
listDeviceEvents
in interface AmazonAlexaForBusiness
public ListSkillsResult listSkills(ListSkillsRequest request)
AmazonAlexaForBusiness
Lists all enabled skills in a specific skill group.
listSkills
in interface AmazonAlexaForBusiness
public ListTagsResult listTags(ListTagsRequest request)
AmazonAlexaForBusiness
Lists all tags for the specified resource.
listTags
in interface AmazonAlexaForBusiness
public PutRoomSkillParameterResult putRoomSkillParameter(PutRoomSkillParameterRequest request)
AmazonAlexaForBusiness
Updates room skill parameter details by room, skill, and parameter key ID. Not all skills have a room skill parameter.
putRoomSkillParameter
in interface AmazonAlexaForBusiness
public ResolveRoomResult resolveRoom(ResolveRoomRequest request)
AmazonAlexaForBusiness
Determines the details for the room from which a skill request was invoked. This operation is used by skill developers.
resolveRoom
in interface AmazonAlexaForBusiness
public RevokeInvitationResult revokeInvitation(RevokeInvitationRequest request)
AmazonAlexaForBusiness
Revokes an invitation and invalidates the enrollment URL.
revokeInvitation
in interface AmazonAlexaForBusiness
public SearchAddressBooksResult searchAddressBooks(SearchAddressBooksRequest request)
AmazonAlexaForBusiness
Searches address books and lists the ones that meet a set of filter and sort criteria.
searchAddressBooks
in interface AmazonAlexaForBusiness
public SearchContactsResult searchContacts(SearchContactsRequest request)
AmazonAlexaForBusiness
Searches contacts and lists the ones that meet a set of filter and sort criteria.
searchContacts
in interface AmazonAlexaForBusiness
public SearchDevicesResult searchDevices(SearchDevicesRequest request)
AmazonAlexaForBusiness
Searches devices and lists the ones that meet a set of filter criteria.
searchDevices
in interface AmazonAlexaForBusiness
public SearchProfilesResult searchProfiles(SearchProfilesRequest request)
AmazonAlexaForBusiness
Searches room profiles and lists the ones that meet a set of filter criteria.
searchProfiles
in interface AmazonAlexaForBusiness
public SearchRoomsResult searchRooms(SearchRoomsRequest request)
AmazonAlexaForBusiness
Searches rooms and lists the ones that meet a set of filter and sort criteria.
searchRooms
in interface AmazonAlexaForBusiness
public SearchSkillGroupsResult searchSkillGroups(SearchSkillGroupsRequest request)
AmazonAlexaForBusiness
Searches skill groups and lists the ones that meet a set of filter and sort criteria.
searchSkillGroups
in interface AmazonAlexaForBusiness
public SearchUsersResult searchUsers(SearchUsersRequest request)
AmazonAlexaForBusiness
Searches users and lists the ones that meet a set of filter and sort criteria.
searchUsers
in interface AmazonAlexaForBusiness
public SendInvitationResult sendInvitation(SendInvitationRequest request)
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.
sendInvitation
in interface AmazonAlexaForBusiness
public StartDeviceSyncResult startDeviceSync(StartDeviceSyncRequest request)
AmazonAlexaForBusiness
Resets a device and its account to the known default settings, by clearing all information and settings set by previous users.
startDeviceSync
in interface AmazonAlexaForBusiness
public TagResourceResult tagResource(TagResourceRequest request)
AmazonAlexaForBusiness
Adds metadata tags to a specified resource.
tagResource
in interface AmazonAlexaForBusiness
public UntagResourceResult untagResource(UntagResourceRequest request)
AmazonAlexaForBusiness
Removes metadata tags from a specified resource.
untagResource
in interface AmazonAlexaForBusiness
public UpdateAddressBookResult updateAddressBook(UpdateAddressBookRequest request)
AmazonAlexaForBusiness
Updates address book details by the address book ARN.
updateAddressBook
in interface AmazonAlexaForBusiness
public UpdateContactResult updateContact(UpdateContactRequest request)
AmazonAlexaForBusiness
Updates the contact details by the contact ARN.
updateContact
in interface AmazonAlexaForBusiness
public UpdateDeviceResult updateDevice(UpdateDeviceRequest request)
AmazonAlexaForBusiness
Updates the device name by device ARN.
updateDevice
in interface AmazonAlexaForBusiness
public UpdateProfileResult updateProfile(UpdateProfileRequest request)
AmazonAlexaForBusiness
Updates an existing room profile by room profile ARN.
updateProfile
in interface AmazonAlexaForBusiness
public UpdateRoomResult updateRoom(UpdateRoomRequest request)
AmazonAlexaForBusiness
Updates room details by room ARN.
updateRoom
in interface AmazonAlexaForBusiness
public UpdateSkillGroupResult updateSkillGroup(UpdateSkillGroupRequest request)
AmazonAlexaForBusiness
Updates skill group details by skill group ARN.
updateSkillGroup
in interface AmazonAlexaForBusiness
public void shutdown()
AmazonAlexaForBusiness
shutdown
in interface AmazonAlexaForBusiness
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonAlexaForBusiness
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.
getCachedResponseMetadata
in interface AmazonAlexaForBusiness
request
- The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.