@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonAlexaForBusiness
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonAlexaForBusiness instead.
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
ApproveSkillResult |
approveSkill(ApproveSkillRequest approveSkillRequest)
Associates a skill with the organization under the customer's AWS account.
|
AssociateContactWithAddressBookResult |
associateContactWithAddressBook(AssociateContactWithAddressBookRequest associateContactWithAddressBookRequest)
Associates a contact with a given address book.
|
AssociateDeviceWithRoomResult |
associateDeviceWithRoom(AssociateDeviceWithRoomRequest associateDeviceWithRoomRequest)
Associates a device with a given room.
|
AssociateSkillGroupWithRoomResult |
associateSkillGroupWithRoom(AssociateSkillGroupWithRoomRequest associateSkillGroupWithRoomRequest)
Associates a skill group with a given room.
|
AssociateSkillWithSkillGroupResult |
associateSkillWithSkillGroup(AssociateSkillWithSkillGroupRequest associateSkillWithSkillGroupRequest)
Associates a skill with a skill group.
|
AssociateSkillWithUsersResult |
associateSkillWithUsers(AssociateSkillWithUsersRequest associateSkillWithUsersRequest)
Makes a private skill available for enrolled users to enable on their devices.
|
CreateAddressBookResult |
createAddressBook(CreateAddressBookRequest createAddressBookRequest)
Creates an address book with the specified details.
|
CreateBusinessReportScheduleResult |
createBusinessReportSchedule(CreateBusinessReportScheduleRequest createBusinessReportScheduleRequest)
Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or
weekly interval.
|
CreateConferenceProviderResult |
createConferenceProvider(CreateConferenceProviderRequest createConferenceProviderRequest)
Adds a new conference provider under the user's AWS account.
|
CreateContactResult |
createContact(CreateContactRequest createContactRequest)
Creates a contact with the specified details.
|
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.
|
DeleteAddressBookResult |
deleteAddressBook(DeleteAddressBookRequest deleteAddressBookRequest)
Deletes an address book by the address book ARN.
|
DeleteBusinessReportScheduleResult |
deleteBusinessReportSchedule(DeleteBusinessReportScheduleRequest deleteBusinessReportScheduleRequest)
Deletes the recurring report delivery schedule with the specified schedule ARN.
|
DeleteConferenceProviderResult |
deleteConferenceProvider(DeleteConferenceProviderRequest deleteConferenceProviderRequest)
Deletes a conference provider.
|
DeleteContactResult |
deleteContact(DeleteContactRequest deleteContactRequest)
Deletes a contact by the contact ARN.
|
DeleteDeviceResult |
deleteDevice(DeleteDeviceRequest deleteDeviceRequest)
Removes a device from Alexa For Business.
|
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.
|
DeleteSkillAuthorizationResult |
deleteSkillAuthorization(DeleteSkillAuthorizationRequest deleteSkillAuthorizationRequest)
Unlinks a third-party account from a skill.
|
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.
|
DisassociateContactFromAddressBookResult |
disassociateContactFromAddressBook(DisassociateContactFromAddressBookRequest disassociateContactFromAddressBookRequest)
Disassociates a contact from a given address book.
|
DisassociateDeviceFromRoomResult |
disassociateDeviceFromRoom(DisassociateDeviceFromRoomRequest disassociateDeviceFromRoomRequest)
Disassociates a device from its current room.
|
DisassociateSkillFromSkillGroupResult |
disassociateSkillFromSkillGroup(DisassociateSkillFromSkillGroupRequest disassociateSkillFromSkillGroupRequest)
Disassociates a skill from a skill group.
|
DisassociateSkillFromUsersResult |
disassociateSkillFromUsers(DisassociateSkillFromUsersRequest disassociateSkillFromUsersRequest)
Makes a private skill unavailable for enrolled users and prevents them from enabling it on their devices.
|
DisassociateSkillGroupFromRoomResult |
disassociateSkillGroupFromRoom(DisassociateSkillGroupFromRoomRequest disassociateSkillGroupFromRoomRequest)
Disassociates a skill group from a specified room.
|
ForgetSmartHomeAppliancesResult |
forgetSmartHomeAppliances(ForgetSmartHomeAppliancesRequest forgetSmartHomeAppliancesRequest)
Forgets smart home appliances associated to a room.
|
GetAddressBookResult |
getAddressBook(GetAddressBookRequest getAddressBookRequest)
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 getConferencePreferenceRequest)
Retrieves the existing conference preferences.
|
GetConferenceProviderResult |
getConferenceProvider(GetConferenceProviderRequest getConferenceProviderRequest)
Gets details about a specific conference provider.
|
GetContactResult |
getContact(GetContactRequest getContactRequest)
Gets the contact details by the contact ARN.
|
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.
|
ListBusinessReportSchedulesResult |
listBusinessReportSchedules(ListBusinessReportSchedulesRequest listBusinessReportSchedulesRequest)
Lists the details of the schedules that a user configured.
|
ListConferenceProvidersResult |
listConferenceProviders(ListConferenceProvidersRequest listConferenceProvidersRequest)
Lists conference providers under a specific AWS account.
|
ListDeviceEventsResult |
listDeviceEvents(ListDeviceEventsRequest listDeviceEventsRequest)
Lists the device event history, including device connection status, for up to 30 days.
|
ListSkillsResult |
listSkills(ListSkillsRequest listSkillsRequest)
Lists all enabled skills in a specific skill group.
|
ListSkillsStoreCategoriesResult |
listSkillsStoreCategories(ListSkillsStoreCategoriesRequest listSkillsStoreCategoriesRequest)
Lists all categories in the Alexa skill store.
|
ListSkillsStoreSkillsByCategoryResult |
listSkillsStoreSkillsByCategory(ListSkillsStoreSkillsByCategoryRequest listSkillsStoreSkillsByCategoryRequest)
Lists all skills in the Alexa skill store by category.
|
ListSmartHomeAppliancesResult |
listSmartHomeAppliances(ListSmartHomeAppliancesRequest listSmartHomeAppliancesRequest)
Lists all of the smart home appliances associated with a room.
|
ListTagsResult |
listTags(ListTagsRequest listTagsRequest)
Lists all tags for the specified resource.
|
PutConferencePreferenceResult |
putConferencePreference(PutConferencePreferenceRequest putConferencePreferenceRequest)
Sets the conference preferences on a specific conference provider at the account level.
|
PutRoomSkillParameterResult |
putRoomSkillParameter(PutRoomSkillParameterRequest putRoomSkillParameterRequest)
Updates room skill parameter details by room, skill, and parameter key ID.
|
PutSkillAuthorizationResult |
putSkillAuthorization(PutSkillAuthorizationRequest putSkillAuthorizationRequest)
Links a user's account to a third-party skill provider.
|
RegisterAVSDeviceResult |
registerAVSDevice(RegisterAVSDeviceRequest registerAVSDeviceRequest)
Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service
(AVS).
|
RejectSkillResult |
rejectSkill(RejectSkillRequest rejectSkillRequest)
Disassociates a skill from the organization under a user's AWS account.
|
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.
|
SearchAddressBooksResult |
searchAddressBooks(SearchAddressBooksRequest searchAddressBooksRequest)
Searches address books and lists the ones that meet a set of filter and sort criteria.
|
SearchContactsResult |
searchContacts(SearchContactsRequest searchContactsRequest)
Searches contacts and lists the ones that meet a set of filter and sort criteria.
|
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.
|
StartSmartHomeApplianceDiscoveryResult |
startSmartHomeApplianceDiscovery(StartSmartHomeApplianceDiscoveryRequest startSmartHomeApplianceDiscoveryRequest)
Initiates the discovery of any smart home appliances associated with the room.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Adds metadata tags to a specified resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Removes metadata tags from a specified resource.
|
UpdateAddressBookResult |
updateAddressBook(UpdateAddressBookRequest updateAddressBookRequest)
Updates address book details by the address book ARN.
|
UpdateBusinessReportScheduleResult |
updateBusinessReportSchedule(UpdateBusinessReportScheduleRequest updateBusinessReportScheduleRequest)
Updates the configuration of the report delivery schedule with the specified schedule ARN.
|
UpdateConferenceProviderResult |
updateConferenceProvider(UpdateConferenceProviderRequest updateConferenceProviderRequest)
Updates an existing conference provider's settings.
|
UpdateContactResult |
updateContact(UpdateContactRequest updateContactRequest)
Updates the contact details by the contact ARN.
|
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.
|
static final String ENDPOINT_PREFIX
ApproveSkillResult approveSkill(ApproveSkillRequest approveSkillRequest)
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.
approveSkillRequest - LimitExceededException - You are performing an action that would put you beyond your account's limits.NotFoundException - The resource is not found.ConcurrentModificationException - Concurrent modification of resources. HTTP Status Code: 400.AssociateContactWithAddressBookResult associateContactWithAddressBook(AssociateContactWithAddressBookRequest associateContactWithAddressBookRequest)
Associates a contact with a given address book.
associateContactWithAddressBookRequest - LimitExceededException - You are performing an action that would put you beyond your account's limits.AssociateDeviceWithRoomResult associateDeviceWithRoom(AssociateDeviceWithRoomRequest associateDeviceWithRoomRequest)
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.
associateDeviceWithRoomRequest - LimitExceededException - You are performing an action that would put you beyond your account's limits.ConcurrentModificationException - Concurrent modification of resources. HTTP Status Code: 400.DeviceNotRegisteredException - The request failed because this device is no longer registered and therefore no longer managed by this
account.AssociateSkillGroupWithRoomResult associateSkillGroupWithRoom(AssociateSkillGroupWithRoomRequest associateSkillGroupWithRoomRequest)
Associates a skill group with a given room. This enables all skills in the associated skill group on all devices in the room.
associateSkillGroupWithRoomRequest - ConcurrentModificationException - Concurrent modification of resources. HTTP Status Code: 400.AssociateSkillWithSkillGroupResult associateSkillWithSkillGroup(AssociateSkillWithSkillGroupRequest associateSkillWithSkillGroupRequest)
Associates a skill with a skill group.
associateSkillWithSkillGroupRequest - ConcurrentModificationException - Concurrent modification of resources. HTTP Status Code: 400.NotFoundException - The resource is not found.SkillNotLinkedException - The skill must be linked to a third-party account.AssociateSkillWithUsersResult associateSkillWithUsers(AssociateSkillWithUsersRequest associateSkillWithUsersRequest)
Makes a private skill available for enrolled users to enable on their devices.
associateSkillWithUsersRequest - ConcurrentModificationException - Concurrent modification of resources. HTTP Status Code: 400.CreateAddressBookResult createAddressBook(CreateAddressBookRequest createAddressBookRequest)
Creates an address book with the specified details.
createAddressBookRequest - AlreadyExistsException - The resource being created already exists.LimitExceededException - You are performing an action that would put you beyond your account's limits.CreateBusinessReportScheduleResult createBusinessReportSchedule(CreateBusinessReportScheduleRequest createBusinessReportScheduleRequest)
Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or weekly interval.
createBusinessReportScheduleRequest - AlreadyExistsException - The resource being created already exists.CreateConferenceProviderResult createConferenceProvider(CreateConferenceProviderRequest createConferenceProviderRequest)
Adds a new conference provider under the user's AWS account.
createConferenceProviderRequest - AlreadyExistsException - The resource being created already exists.CreateContactResult createContact(CreateContactRequest createContactRequest)
Creates a contact with the specified details.
createContactRequest - AlreadyExistsException - The resource being created already exists.LimitExceededException - You are performing an action that would put you beyond your account's limits.CreateProfileResult createProfile(CreateProfileRequest createProfileRequest)
Creates a new room profile with the specified details.
createProfileRequest - LimitExceededException - You are performing an action that would put you beyond your account's limits.AlreadyExistsException - The resource being created already exists.ConcurrentModificationException - Concurrent modification of resources. HTTP Status Code: 400.CreateRoomResult createRoom(CreateRoomRequest createRoomRequest)
Creates a room with the specified details.
createRoomRequest - AlreadyExistsException - The resource being created already exists.LimitExceededException - You are performing an action that would put you beyond your account's limits.CreateSkillGroupResult createSkillGroup(CreateSkillGroupRequest createSkillGroupRequest)
Creates a skill group with a specified name and description.
createSkillGroupRequest - AlreadyExistsException - The resource being created already exists.LimitExceededException - You are performing an action that would put you beyond your account's limits.ConcurrentModificationException - Concurrent modification of resources. HTTP Status Code: 400.CreateUserResult createUser(CreateUserRequest createUserRequest)
Creates a user.
createUserRequest - 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 - Concurrent modification of resources. HTTP Status Code: 400.DeleteAddressBookResult deleteAddressBook(DeleteAddressBookRequest deleteAddressBookRequest)
Deletes an address book by the address book ARN.
deleteAddressBookRequest - NotFoundException - The resource is not found.ConcurrentModificationException - Concurrent modification of resources. HTTP Status Code: 400.DeleteBusinessReportScheduleResult deleteBusinessReportSchedule(DeleteBusinessReportScheduleRequest deleteBusinessReportScheduleRequest)
Deletes the recurring report delivery schedule with the specified schedule ARN.
deleteBusinessReportScheduleRequest - NotFoundException - The resource is not found.ConcurrentModificationException - Concurrent modification of resources. HTTP Status Code: 400.DeleteConferenceProviderResult deleteConferenceProvider(DeleteConferenceProviderRequest deleteConferenceProviderRequest)
Deletes a conference provider.
deleteConferenceProviderRequest - NotFoundException - The resource is not found.DeleteContactResult deleteContact(DeleteContactRequest deleteContactRequest)
Deletes a contact by the contact ARN.
deleteContactRequest - NotFoundException - The resource is not found.ConcurrentModificationException - Concurrent modification of resources. HTTP Status Code: 400.DeleteDeviceResult deleteDevice(DeleteDeviceRequest deleteDeviceRequest)
Removes a device from Alexa For Business.
deleteDeviceRequest - NotFoundException - The resource is not found.ConcurrentModificationException - Concurrent modification of resources. HTTP Status Code: 400.InvalidCertificateAuthorityException - The Certificate Authority can't issue or revoke a certificate.DeleteProfileResult deleteProfile(DeleteProfileRequest deleteProfileRequest)
Deletes a room profile by the profile ARN.
deleteProfileRequest - NotFoundException - The resource is not found.ConcurrentModificationException - Concurrent modification of resources. HTTP Status Code: 400.DeleteRoomResult deleteRoom(DeleteRoomRequest deleteRoomRequest)
Deletes a room by the room ARN.
deleteRoomRequest - NotFoundException - The resource is not found.ConcurrentModificationException - Concurrent modification of resources. HTTP Status Code: 400.DeleteRoomSkillParameterResult deleteRoomSkillParameter(DeleteRoomSkillParameterRequest deleteRoomSkillParameterRequest)
Deletes room skill parameter details by room, skill, and parameter key ID.
deleteRoomSkillParameterRequest - ConcurrentModificationException - Concurrent modification of resources. HTTP Status Code: 400.DeleteSkillAuthorizationResult deleteSkillAuthorization(DeleteSkillAuthorizationRequest deleteSkillAuthorizationRequest)
Unlinks a third-party account from a skill.
deleteSkillAuthorizationRequest - NotFoundException - The resource is not found.ConcurrentModificationException - Concurrent modification of resources. HTTP Status Code: 400.DeleteSkillGroupResult deleteSkillGroup(DeleteSkillGroupRequest deleteSkillGroupRequest)
Deletes a skill group by skill group ARN.
deleteSkillGroupRequest - NotFoundException - The resource is not found.ConcurrentModificationException - Concurrent modification of resources. HTTP Status Code: 400.DeleteUserResult deleteUser(DeleteUserRequest deleteUserRequest)
Deletes a specified user by user ARN and enrollment ARN.
deleteUserRequest - NotFoundException - The resource is not found.ConcurrentModificationException - Concurrent modification of resources. HTTP Status Code: 400.DisassociateContactFromAddressBookResult disassociateContactFromAddressBook(DisassociateContactFromAddressBookRequest disassociateContactFromAddressBookRequest)
Disassociates a contact from a given address book.
disassociateContactFromAddressBookRequest - 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.
disassociateDeviceFromRoomRequest - ConcurrentModificationException - Concurrent modification of resources. HTTP Status Code: 400.DeviceNotRegisteredException - The request failed because this device is no longer registered and therefore no longer managed by this
account.DisassociateSkillFromSkillGroupResult disassociateSkillFromSkillGroup(DisassociateSkillFromSkillGroupRequest disassociateSkillFromSkillGroupRequest)
Disassociates a skill from a skill group.
disassociateSkillFromSkillGroupRequest - ConcurrentModificationException - Concurrent modification of resources. HTTP Status Code: 400.NotFoundException - The resource is not found.DisassociateSkillFromUsersResult disassociateSkillFromUsers(DisassociateSkillFromUsersRequest disassociateSkillFromUsersRequest)
Makes a private skill unavailable for enrolled users and prevents them from enabling it on their devices.
disassociateSkillFromUsersRequest - ConcurrentModificationException - Concurrent modification of resources. HTTP Status Code: 400.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.
disassociateSkillGroupFromRoomRequest - ConcurrentModificationException - Concurrent modification of resources. HTTP Status Code: 400.ForgetSmartHomeAppliancesResult forgetSmartHomeAppliances(ForgetSmartHomeAppliancesRequest forgetSmartHomeAppliancesRequest)
Forgets smart home appliances associated to a room.
forgetSmartHomeAppliancesRequest - NotFoundException - The resource is not found.GetAddressBookResult getAddressBook(GetAddressBookRequest getAddressBookRequest)
Gets address the book details by the address book ARN.
getAddressBookRequest - NotFoundException - The resource is not found.GetConferencePreferenceResult getConferencePreference(GetConferencePreferenceRequest getConferencePreferenceRequest)
Retrieves the existing conference preferences.
getConferencePreferenceRequest - NotFoundException - The resource is not found.GetConferenceProviderResult getConferenceProvider(GetConferenceProviderRequest getConferenceProviderRequest)
Gets details about a specific conference provider.
getConferenceProviderRequest - NotFoundException - The resource is not found.GetContactResult getContact(GetContactRequest getContactRequest)
Gets the contact details by the contact ARN.
getContactRequest - NotFoundException - The resource is not found.GetDeviceResult getDevice(GetDeviceRequest getDeviceRequest)
Gets the details of a device by device ARN.
getDeviceRequest - NotFoundException - The resource is not found.GetProfileResult getProfile(GetProfileRequest getProfileRequest)
Gets the details of a room profile by profile ARN.
getProfileRequest - NotFoundException - The resource is not found.GetRoomResult getRoom(GetRoomRequest getRoomRequest)
Gets room details by room ARN.
getRoomRequest - NotFoundException - The resource is not found.GetRoomSkillParameterResult getRoomSkillParameter(GetRoomSkillParameterRequest getRoomSkillParameterRequest)
Gets room skill parameter details by room, skill, and parameter key ARN.
getRoomSkillParameterRequest - NotFoundException - The resource is not found.GetSkillGroupResult getSkillGroup(GetSkillGroupRequest getSkillGroupRequest)
Gets skill group details by skill group ARN.
getSkillGroupRequest - NotFoundException - The resource is not found.ListBusinessReportSchedulesResult listBusinessReportSchedules(ListBusinessReportSchedulesRequest listBusinessReportSchedulesRequest)
Lists the details of the schedules that a user configured.
listBusinessReportSchedulesRequest - ListConferenceProvidersResult listConferenceProviders(ListConferenceProvidersRequest listConferenceProvidersRequest)
Lists conference providers under a specific AWS account.
listConferenceProvidersRequest - ListDeviceEventsResult listDeviceEvents(ListDeviceEventsRequest listDeviceEventsRequest)
Lists the device event history, including device connection status, for up to 30 days.
listDeviceEventsRequest - NotFoundException - The resource is not found.ListSkillsResult listSkills(ListSkillsRequest listSkillsRequest)
Lists all enabled skills in a specific skill group.
listSkillsRequest - ListSkillsStoreCategoriesResult listSkillsStoreCategories(ListSkillsStoreCategoriesRequest listSkillsStoreCategoriesRequest)
Lists all categories in the Alexa skill store.
listSkillsStoreCategoriesRequest - ListSkillsStoreSkillsByCategoryResult listSkillsStoreSkillsByCategory(ListSkillsStoreSkillsByCategoryRequest listSkillsStoreSkillsByCategoryRequest)
Lists all skills in the Alexa skill store by category.
listSkillsStoreSkillsByCategoryRequest - ListSmartHomeAppliancesResult listSmartHomeAppliances(ListSmartHomeAppliancesRequest listSmartHomeAppliancesRequest)
Lists all of the smart home appliances associated with a room.
listSmartHomeAppliancesRequest - NotFoundException - The resource is not found.ListTagsResult listTags(ListTagsRequest listTagsRequest)
Lists all tags for the specified resource.
listTagsRequest - NotFoundException - The resource is not found.PutConferencePreferenceResult putConferencePreference(PutConferencePreferenceRequest putConferencePreferenceRequest)
Sets the conference preferences on a specific conference provider at the account level.
putConferencePreferenceRequest - NotFoundException - The resource is not found.PutRoomSkillParameterResult putRoomSkillParameter(PutRoomSkillParameterRequest putRoomSkillParameterRequest)
Updates room skill parameter details by room, skill, and parameter key ID. Not all skills have a room skill parameter.
putRoomSkillParameterRequest - ConcurrentModificationException - Concurrent modification of resources. HTTP Status Code: 400.PutSkillAuthorizationResult putSkillAuthorization(PutSkillAuthorizationRequest putSkillAuthorizationRequest)
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.
putSkillAuthorizationRequest - UnauthorizedException - The caller has no permissions to operate on the resource involved in the API call.ConcurrentModificationException - Concurrent modification of resources. HTTP Status Code: 400.RegisterAVSDeviceResult registerAVSDevice(RegisterAVSDeviceRequest registerAVSDeviceRequest)
Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service (AVS).
registerAVSDeviceRequest - LimitExceededException - You are performing an action that would put you beyond your account's limits.ConcurrentModificationException - Concurrent modification of resources. HTTP Status Code: 400.InvalidDeviceException - The device is in an invalid state.RejectSkillResult rejectSkill(RejectSkillRequest rejectSkillRequest)
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.
rejectSkillRequest - ConcurrentModificationException - Concurrent modification of resources. HTTP Status Code: 400.NotFoundException - The resource is not found.ResolveRoomResult resolveRoom(ResolveRoomRequest resolveRoomRequest)
Determines the details for the room from which a skill request was invoked. This operation is used by skill developers.
resolveRoomRequest - NotFoundException - The resource is not found.RevokeInvitationResult revokeInvitation(RevokeInvitationRequest revokeInvitationRequest)
Revokes an invitation and invalidates the enrollment URL.
revokeInvitationRequest - NotFoundException - The resource is not found.ConcurrentModificationException - Concurrent modification of resources. HTTP Status Code: 400.SearchAddressBooksResult searchAddressBooks(SearchAddressBooksRequest searchAddressBooksRequest)
Searches address books and lists the ones that meet a set of filter and sort criteria.
searchAddressBooksRequest - SearchContactsResult searchContacts(SearchContactsRequest searchContactsRequest)
Searches contacts and lists the ones that meet a set of filter and sort criteria.
searchContactsRequest - SearchDevicesResult searchDevices(SearchDevicesRequest searchDevicesRequest)
Searches devices and lists the ones that meet a set of filter criteria.
searchDevicesRequest - SearchProfilesResult searchProfiles(SearchProfilesRequest searchProfilesRequest)
Searches room profiles and lists the ones that meet a set of filter criteria.
searchProfilesRequest - SearchRoomsResult searchRooms(SearchRoomsRequest searchRoomsRequest)
Searches rooms and lists the ones that meet a set of filter and sort criteria.
searchRoomsRequest - SearchSkillGroupsResult searchSkillGroups(SearchSkillGroupsRequest searchSkillGroupsRequest)
Searches skill groups and lists the ones that meet a set of filter and sort criteria.
searchSkillGroupsRequest - SearchUsersResult searchUsers(SearchUsersRequest searchUsersRequest)
Searches users and lists the ones that meet a set of filter and sort criteria.
searchUsersRequest - 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.
sendInvitationRequest - NotFoundException - The resource is not found.InvalidUserStatusException - The attempt to update a user is invalid due to the user's current status.ConcurrentModificationException - Concurrent modification of resources. HTTP Status Code: 400.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.
startDeviceSyncRequest - DeviceNotRegisteredException - The request failed because this device is no longer registered and therefore no longer managed by this
account.StartSmartHomeApplianceDiscoveryResult startSmartHomeApplianceDiscovery(StartSmartHomeApplianceDiscoveryRequest startSmartHomeApplianceDiscoveryRequest)
Initiates the discovery of any smart home appliances associated with the room.
startSmartHomeApplianceDiscoveryRequest - NotFoundException - The resource is not found.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Adds metadata tags to a specified resource.
tagResourceRequest - NotFoundException - The resource is not found.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes metadata tags from a specified resource.
untagResourceRequest - NotFoundException - The resource is not found.UpdateAddressBookResult updateAddressBook(UpdateAddressBookRequest updateAddressBookRequest)
Updates address book details by the address book ARN.
updateAddressBookRequest - NotFoundException - The resource is not found.NameInUseException - The name sent in the request is already in use.ConcurrentModificationException - Concurrent modification of resources. HTTP Status Code: 400.UpdateBusinessReportScheduleResult updateBusinessReportSchedule(UpdateBusinessReportScheduleRequest updateBusinessReportScheduleRequest)
Updates the configuration of the report delivery schedule with the specified schedule ARN.
updateBusinessReportScheduleRequest - NotFoundException - The resource is not found.ConcurrentModificationException - Concurrent modification of resources. HTTP Status Code: 400.UpdateConferenceProviderResult updateConferenceProvider(UpdateConferenceProviderRequest updateConferenceProviderRequest)
Updates an existing conference provider's settings.
updateConferenceProviderRequest - NotFoundException - The resource is not found.UpdateContactResult updateContact(UpdateContactRequest updateContactRequest)
Updates the contact details by the contact ARN.
updateContactRequest - NotFoundException - The resource is not found.ConcurrentModificationException - Concurrent modification of resources. HTTP Status Code: 400.UpdateDeviceResult updateDevice(UpdateDeviceRequest updateDeviceRequest)
Updates the device name by device ARN.
updateDeviceRequest - NotFoundException - The resource is not found.ConcurrentModificationException - Concurrent modification of resources. HTTP Status Code: 400.DeviceNotRegisteredException - The request failed because this device is no longer registered and therefore no longer managed by this
account.UpdateProfileResult updateProfile(UpdateProfileRequest updateProfileRequest)
Updates an existing room profile by room profile ARN.
updateProfileRequest - NotFoundException - The resource is not found.NameInUseException - The name sent in the request is already in use.ConcurrentModificationException - Concurrent modification of resources. HTTP Status Code: 400.UpdateRoomResult updateRoom(UpdateRoomRequest updateRoomRequest)
Updates room details by room ARN.
updateRoomRequest - NotFoundException - The resource is not found.NameInUseException - The name sent in the request is already in use.UpdateSkillGroupResult updateSkillGroup(UpdateSkillGroupRequest updateSkillGroupRequest)
Updates skill group details by skill group ARN.
updateSkillGroupRequest - NotFoundException - The resource is not found.NameInUseException - The name sent in the request is already in use.ConcurrentModificationException - Concurrent modification of resources. HTTP Status Code: 400.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
request - The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.