@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonAlexaForBusinessClient extends AmazonWebServiceClient implements AmazonAlexaForBusiness
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.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
ApproveSkillResult |
approveSkill(ApproveSkillRequest request)
Associates a skill with the organization under the customer's AWS account.
|
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.
|
AssociateSkillWithSkillGroupResult |
associateSkillWithSkillGroup(AssociateSkillWithSkillGroupRequest request)
Associates a skill with a skill group.
|
AssociateSkillWithUsersResult |
associateSkillWithUsers(AssociateSkillWithUsersRequest request)
Makes a private skill available for enrolled users to enable on their devices.
|
static AmazonAlexaForBusinessClientBuilder |
builder() |
CreateAddressBookResult |
createAddressBook(CreateAddressBookRequest request)
Creates an address book with the specified details.
|
CreateBusinessReportScheduleResult |
createBusinessReportSchedule(CreateBusinessReportScheduleRequest request)
Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or
weekly interval.
|
CreateConferenceProviderResult |
createConferenceProvider(CreateConferenceProviderRequest request)
Adds a new conference provider under the user's AWS account.
|
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.
|
DeleteBusinessReportScheduleResult |
deleteBusinessReportSchedule(DeleteBusinessReportScheduleRequest request)
Deletes the recurring report delivery schedule with the specified schedule ARN.
|
DeleteConferenceProviderResult |
deleteConferenceProvider(DeleteConferenceProviderRequest request)
Deletes a conference provider.
|
DeleteContactResult |
deleteContact(DeleteContactRequest request)
Deletes a contact by the contact ARN.
|
DeleteDeviceResult |
deleteDevice(DeleteDeviceRequest request)
Removes a device from Alexa For Business.
|
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.
|
DeleteSkillAuthorizationResult |
deleteSkillAuthorization(DeleteSkillAuthorizationRequest request)
Unlinks a third-party account from a skill.
|
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.
|
DisassociateSkillFromSkillGroupResult |
disassociateSkillFromSkillGroup(DisassociateSkillFromSkillGroupRequest request)
Disassociates a skill from a skill group.
|
DisassociateSkillFromUsersResult |
disassociateSkillFromUsers(DisassociateSkillFromUsersRequest request)
Makes a private skill unavailable for enrolled users and prevents them from enabling it on their devices.
|
DisassociateSkillGroupFromRoomResult |
disassociateSkillGroupFromRoom(DisassociateSkillGroupFromRoomRequest request)
Disassociates a skill group from a specified room.
|
ForgetSmartHomeAppliancesResult |
forgetSmartHomeAppliances(ForgetSmartHomeAppliancesRequest request)
Forgets smart home appliances associated to a 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.
|
GetConferencePreferenceResult |
getConferencePreference(GetConferencePreferenceRequest request)
Retrieves the existing conference preferences.
|
GetConferenceProviderResult |
getConferenceProvider(GetConferenceProviderRequest request)
Gets details about a specific conference provider.
|
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.
|
ListBusinessReportSchedulesResult |
listBusinessReportSchedules(ListBusinessReportSchedulesRequest request)
Lists the details of the schedules that a user configured.
|
ListConferenceProvidersResult |
listConferenceProviders(ListConferenceProvidersRequest request)
Lists conference providers under a specific AWS account.
|
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.
|
ListSkillsStoreCategoriesResult |
listSkillsStoreCategories(ListSkillsStoreCategoriesRequest request)
Lists all categories in the Alexa skill store.
|
ListSkillsStoreSkillsByCategoryResult |
listSkillsStoreSkillsByCategory(ListSkillsStoreSkillsByCategoryRequest request)
Lists all skills in the Alexa skill store by category.
|
ListSmartHomeAppliancesResult |
listSmartHomeAppliances(ListSmartHomeAppliancesRequest request)
Lists all of the smart home appliances associated with a room.
|
ListTagsResult |
listTags(ListTagsRequest request)
Lists all tags for the specified resource.
|
PutConferencePreferenceResult |
putConferencePreference(PutConferencePreferenceRequest request)
Sets the conference preferences on a specific conference provider at the account level.
|
PutRoomSkillParameterResult |
putRoomSkillParameter(PutRoomSkillParameterRequest request)
Updates room skill parameter details by room, skill, and parameter key ID.
|
PutSkillAuthorizationResult |
putSkillAuthorization(PutSkillAuthorizationRequest request)
Links a user's account to a third-party skill provider.
|
RegisterAVSDeviceResult |
registerAVSDevice(RegisterAVSDeviceRequest request)
Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service
(AVS).
|
RejectSkillResult |
rejectSkill(RejectSkillRequest request)
Disassociates a skill from the organization under a user's AWS account.
|
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.
|
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.
|
StartSmartHomeApplianceDiscoveryResult |
startSmartHomeApplianceDiscovery(StartSmartHomeApplianceDiscoveryRequest request)
Initiates the discovery of any smart home appliances associated with the room.
|
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.
|
UpdateBusinessReportScheduleResult |
updateBusinessReportSchedule(UpdateBusinessReportScheduleRequest request)
Updates the configuration of the report delivery schedule with the specified schedule ARN.
|
UpdateConferenceProviderResult |
updateConferenceProvider(UpdateConferenceProviderRequest request)
Updates an existing conference provider's settings.
|
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.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitshutdownpublic static AmazonAlexaForBusinessClientBuilder builder()
public ApproveSkillResult approveSkill(ApproveSkillRequest request)
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.
approveSkill in interface AmazonAlexaForBusinessapproveSkillRequest - 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.public AssociateContactWithAddressBookResult associateContactWithAddressBook(AssociateContactWithAddressBookRequest request)
Associates a contact with a given address book.
associateContactWithAddressBook in interface AmazonAlexaForBusinessassociateContactWithAddressBookRequest - LimitExceededException - You are performing an action that would put you beyond your account's limits.public AssociateDeviceWithRoomResult associateDeviceWithRoom(AssociateDeviceWithRoomRequest request)
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 AmazonAlexaForBusinessassociateDeviceWithRoomRequest - 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.public AssociateSkillGroupWithRoomResult associateSkillGroupWithRoom(AssociateSkillGroupWithRoomRequest request)
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 AmazonAlexaForBusinessassociateSkillGroupWithRoomRequest - ConcurrentModificationException - Concurrent modification of resources. HTTP Status Code: 400.public AssociateSkillWithSkillGroupResult associateSkillWithSkillGroup(AssociateSkillWithSkillGroupRequest request)
Associates a skill with a skill group.
associateSkillWithSkillGroup in interface AmazonAlexaForBusinessassociateSkillWithSkillGroupRequest - 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.public AssociateSkillWithUsersResult associateSkillWithUsers(AssociateSkillWithUsersRequest request)
Makes a private skill available for enrolled users to enable on their devices.
associateSkillWithUsers in interface AmazonAlexaForBusinessassociateSkillWithUsersRequest - ConcurrentModificationException - Concurrent modification of resources. HTTP Status Code: 400.public CreateAddressBookResult createAddressBook(CreateAddressBookRequest request)
Creates an address book with the specified details.
createAddressBook in interface AmazonAlexaForBusinesscreateAddressBookRequest - AlreadyExistsException - The resource being created already exists.LimitExceededException - You are performing an action that would put you beyond your account's limits.public CreateBusinessReportScheduleResult createBusinessReportSchedule(CreateBusinessReportScheduleRequest request)
Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or weekly interval.
createBusinessReportSchedule in interface AmazonAlexaForBusinesscreateBusinessReportScheduleRequest - AlreadyExistsException - The resource being created already exists.public CreateConferenceProviderResult createConferenceProvider(CreateConferenceProviderRequest request)
Adds a new conference provider under the user's AWS account.
createConferenceProvider in interface AmazonAlexaForBusinesscreateConferenceProviderRequest - AlreadyExistsException - The resource being created already exists.public CreateContactResult createContact(CreateContactRequest request)
Creates a contact with the specified details.
createContact in interface AmazonAlexaForBusinesscreateContactRequest - AlreadyExistsException - The resource being created already exists.LimitExceededException - You are performing an action that would put you beyond your account's limits.public CreateProfileResult createProfile(CreateProfileRequest request)
Creates a new room profile with the specified details.
createProfile in interface AmazonAlexaForBusinesscreateProfileRequest - 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.public CreateRoomResult createRoom(CreateRoomRequest request)
Creates a room with the specified details.
createRoom in interface AmazonAlexaForBusinesscreateRoomRequest - AlreadyExistsException - The resource being created already exists.LimitExceededException - You are performing an action that would put you beyond your account's limits.public CreateSkillGroupResult createSkillGroup(CreateSkillGroupRequest request)
Creates a skill group with a specified name and description.
createSkillGroup in interface AmazonAlexaForBusinesscreateSkillGroupRequest - 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.public CreateUserResult createUser(CreateUserRequest request)
Creates a user.
createUser in interface AmazonAlexaForBusinesscreateUserRequest - 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.public DeleteAddressBookResult deleteAddressBook(DeleteAddressBookRequest request)
Deletes an address book by the address book ARN.
deleteAddressBook in interface AmazonAlexaForBusinessdeleteAddressBookRequest - NotFoundException - The resource is not found.ConcurrentModificationException - Concurrent modification of resources. HTTP Status Code: 400.public DeleteBusinessReportScheduleResult deleteBusinessReportSchedule(DeleteBusinessReportScheduleRequest request)
Deletes the recurring report delivery schedule with the specified schedule ARN.
deleteBusinessReportSchedule in interface AmazonAlexaForBusinessdeleteBusinessReportScheduleRequest - NotFoundException - The resource is not found.ConcurrentModificationException - Concurrent modification of resources. HTTP Status Code: 400.public DeleteConferenceProviderResult deleteConferenceProvider(DeleteConferenceProviderRequest request)
Deletes a conference provider.
deleteConferenceProvider in interface AmazonAlexaForBusinessdeleteConferenceProviderRequest - NotFoundException - The resource is not found.public DeleteContactResult deleteContact(DeleteContactRequest request)
Deletes a contact by the contact ARN.
deleteContact in interface AmazonAlexaForBusinessdeleteContactRequest - NotFoundException - The resource is not found.ConcurrentModificationException - Concurrent modification of resources. HTTP Status Code: 400.public DeleteDeviceResult deleteDevice(DeleteDeviceRequest request)
Removes a device from Alexa For Business.
deleteDevice in interface AmazonAlexaForBusinessdeleteDeviceRequest - 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.public DeleteProfileResult deleteProfile(DeleteProfileRequest request)
Deletes a room profile by the profile ARN.
deleteProfile in interface AmazonAlexaForBusinessdeleteProfileRequest - NotFoundException - The resource is not found.ConcurrentModificationException - Concurrent modification of resources. HTTP Status Code: 400.public DeleteRoomResult deleteRoom(DeleteRoomRequest request)
Deletes a room by the room ARN.
deleteRoom in interface AmazonAlexaForBusinessdeleteRoomRequest - NotFoundException - The resource is not found.ConcurrentModificationException - Concurrent modification of resources. HTTP Status Code: 400.public DeleteRoomSkillParameterResult deleteRoomSkillParameter(DeleteRoomSkillParameterRequest request)
Deletes room skill parameter details by room, skill, and parameter key ID.
deleteRoomSkillParameter in interface AmazonAlexaForBusinessdeleteRoomSkillParameterRequest - ConcurrentModificationException - Concurrent modification of resources. HTTP Status Code: 400.public DeleteSkillAuthorizationResult deleteSkillAuthorization(DeleteSkillAuthorizationRequest request)
Unlinks a third-party account from a skill.
deleteSkillAuthorization in interface AmazonAlexaForBusinessdeleteSkillAuthorizationRequest - NotFoundException - The resource is not found.ConcurrentModificationException - Concurrent modification of resources. HTTP Status Code: 400.public DeleteSkillGroupResult deleteSkillGroup(DeleteSkillGroupRequest request)
Deletes a skill group by skill group ARN.
deleteSkillGroup in interface AmazonAlexaForBusinessdeleteSkillGroupRequest - NotFoundException - The resource is not found.ConcurrentModificationException - Concurrent modification of resources. HTTP Status Code: 400.public DeleteUserResult deleteUser(DeleteUserRequest request)
Deletes a specified user by user ARN and enrollment ARN.
deleteUser in interface AmazonAlexaForBusinessdeleteUserRequest - NotFoundException - The resource is not found.ConcurrentModificationException - Concurrent modification of resources. HTTP Status Code: 400.public DisassociateContactFromAddressBookResult disassociateContactFromAddressBook(DisassociateContactFromAddressBookRequest request)
Disassociates a contact from a given address book.
disassociateContactFromAddressBook in interface AmazonAlexaForBusinessdisassociateContactFromAddressBookRequest - public DisassociateDeviceFromRoomResult disassociateDeviceFromRoom(DisassociateDeviceFromRoomRequest request)
Disassociates a device from its current room. The device continues to be connected to the Wi-Fi network and is still registered to the account. The device settings and skills are removed from the room.
disassociateDeviceFromRoom in interface AmazonAlexaForBusinessdisassociateDeviceFromRoomRequest - 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.public DisassociateSkillFromSkillGroupResult disassociateSkillFromSkillGroup(DisassociateSkillFromSkillGroupRequest request)
Disassociates a skill from a skill group.
disassociateSkillFromSkillGroup in interface AmazonAlexaForBusinessdisassociateSkillFromSkillGroupRequest - ConcurrentModificationException - Concurrent modification of resources. HTTP Status Code: 400.NotFoundException - The resource is not found.public DisassociateSkillFromUsersResult disassociateSkillFromUsers(DisassociateSkillFromUsersRequest request)
Makes a private skill unavailable for enrolled users and prevents them from enabling it on their devices.
disassociateSkillFromUsers in interface AmazonAlexaForBusinessdisassociateSkillFromUsersRequest - ConcurrentModificationException - Concurrent modification of resources. HTTP Status Code: 400.public DisassociateSkillGroupFromRoomResult disassociateSkillGroupFromRoom(DisassociateSkillGroupFromRoomRequest request)
Disassociates a skill group from a specified room. This disables all skills in the skill group on all devices in the room.
disassociateSkillGroupFromRoom in interface AmazonAlexaForBusinessdisassociateSkillGroupFromRoomRequest - ConcurrentModificationException - Concurrent modification of resources. HTTP Status Code: 400.public ForgetSmartHomeAppliancesResult forgetSmartHomeAppliances(ForgetSmartHomeAppliancesRequest request)
Forgets smart home appliances associated to a room.
forgetSmartHomeAppliances in interface AmazonAlexaForBusinessforgetSmartHomeAppliancesRequest - NotFoundException - The resource is not found.public GetAddressBookResult getAddressBook(GetAddressBookRequest request)
Gets address the book details by the address book ARN.
getAddressBook in interface AmazonAlexaForBusinessgetAddressBookRequest - NotFoundException - The resource is not found.public GetConferencePreferenceResult getConferencePreference(GetConferencePreferenceRequest request)
Retrieves the existing conference preferences.
getConferencePreference in interface AmazonAlexaForBusinessgetConferencePreferenceRequest - NotFoundException - The resource is not found.public GetConferenceProviderResult getConferenceProvider(GetConferenceProviderRequest request)
Gets details about a specific conference provider.
getConferenceProvider in interface AmazonAlexaForBusinessgetConferenceProviderRequest - NotFoundException - The resource is not found.public GetContactResult getContact(GetContactRequest request)
Gets the contact details by the contact ARN.
getContact in interface AmazonAlexaForBusinessgetContactRequest - NotFoundException - The resource is not found.public GetDeviceResult getDevice(GetDeviceRequest request)
Gets the details of a device by device ARN.
getDevice in interface AmazonAlexaForBusinessgetDeviceRequest - NotFoundException - The resource is not found.public GetProfileResult getProfile(GetProfileRequest request)
Gets the details of a room profile by profile ARN.
getProfile in interface AmazonAlexaForBusinessgetProfileRequest - NotFoundException - The resource is not found.public GetRoomResult getRoom(GetRoomRequest request)
Gets room details by room ARN.
getRoom in interface AmazonAlexaForBusinessgetRoomRequest - NotFoundException - The resource is not found.public GetRoomSkillParameterResult getRoomSkillParameter(GetRoomSkillParameterRequest request)
Gets room skill parameter details by room, skill, and parameter key ARN.
getRoomSkillParameter in interface AmazonAlexaForBusinessgetRoomSkillParameterRequest - NotFoundException - The resource is not found.public GetSkillGroupResult getSkillGroup(GetSkillGroupRequest request)
Gets skill group details by skill group ARN.
getSkillGroup in interface AmazonAlexaForBusinessgetSkillGroupRequest - NotFoundException - The resource is not found.public ListBusinessReportSchedulesResult listBusinessReportSchedules(ListBusinessReportSchedulesRequest request)
Lists the details of the schedules that a user configured.
listBusinessReportSchedules in interface AmazonAlexaForBusinesslistBusinessReportSchedulesRequest - public ListConferenceProvidersResult listConferenceProviders(ListConferenceProvidersRequest request)
Lists conference providers under a specific AWS account.
listConferenceProviders in interface AmazonAlexaForBusinesslistConferenceProvidersRequest - public ListDeviceEventsResult listDeviceEvents(ListDeviceEventsRequest request)
Lists the device event history, including device connection status, for up to 30 days.
listDeviceEvents in interface AmazonAlexaForBusinesslistDeviceEventsRequest - NotFoundException - The resource is not found.public ListSkillsResult listSkills(ListSkillsRequest request)
Lists all enabled skills in a specific skill group.
listSkills in interface AmazonAlexaForBusinesslistSkillsRequest - public ListSkillsStoreCategoriesResult listSkillsStoreCategories(ListSkillsStoreCategoriesRequest request)
Lists all categories in the Alexa skill store.
listSkillsStoreCategories in interface AmazonAlexaForBusinesslistSkillsStoreCategoriesRequest - public ListSkillsStoreSkillsByCategoryResult listSkillsStoreSkillsByCategory(ListSkillsStoreSkillsByCategoryRequest request)
Lists all skills in the Alexa skill store by category.
listSkillsStoreSkillsByCategory in interface AmazonAlexaForBusinesslistSkillsStoreSkillsByCategoryRequest - public ListSmartHomeAppliancesResult listSmartHomeAppliances(ListSmartHomeAppliancesRequest request)
Lists all of the smart home appliances associated with a room.
listSmartHomeAppliances in interface AmazonAlexaForBusinesslistSmartHomeAppliancesRequest - NotFoundException - The resource is not found.public ListTagsResult listTags(ListTagsRequest request)
Lists all tags for the specified resource.
listTags in interface AmazonAlexaForBusinesslistTagsRequest - NotFoundException - The resource is not found.public PutConferencePreferenceResult putConferencePreference(PutConferencePreferenceRequest request)
Sets the conference preferences on a specific conference provider at the account level.
putConferencePreference in interface AmazonAlexaForBusinessputConferencePreferenceRequest - NotFoundException - The resource is not found.public PutRoomSkillParameterResult putRoomSkillParameter(PutRoomSkillParameterRequest request)
Updates room skill parameter details by room, skill, and parameter key ID. Not all skills have a room skill parameter.
putRoomSkillParameter in interface AmazonAlexaForBusinessputRoomSkillParameterRequest - ConcurrentModificationException - Concurrent modification of resources. HTTP Status Code: 400.public PutSkillAuthorizationResult putSkillAuthorization(PutSkillAuthorizationRequest request)
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.
putSkillAuthorization in interface AmazonAlexaForBusinessputSkillAuthorizationRequest - 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.public RegisterAVSDeviceResult registerAVSDevice(RegisterAVSDeviceRequest request)
Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service (AVS).
registerAVSDevice in interface AmazonAlexaForBusinessregisterAVSDeviceRequest - 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.public RejectSkillResult rejectSkill(RejectSkillRequest request)
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.
rejectSkill in interface AmazonAlexaForBusinessrejectSkillRequest - ConcurrentModificationException - Concurrent modification of resources. HTTP Status Code: 400.NotFoundException - The resource is not found.public ResolveRoomResult resolveRoom(ResolveRoomRequest request)
Determines the details for the room from which a skill request was invoked. This operation is used by skill developers.
resolveRoom in interface AmazonAlexaForBusinessresolveRoomRequest - NotFoundException - The resource is not found.public RevokeInvitationResult revokeInvitation(RevokeInvitationRequest request)
Revokes an invitation and invalidates the enrollment URL.
revokeInvitation in interface AmazonAlexaForBusinessrevokeInvitationRequest - NotFoundException - The resource is not found.ConcurrentModificationException - Concurrent modification of resources. HTTP Status Code: 400.public SearchAddressBooksResult searchAddressBooks(SearchAddressBooksRequest request)
Searches address books and lists the ones that meet a set of filter and sort criteria.
searchAddressBooks in interface AmazonAlexaForBusinesssearchAddressBooksRequest - public SearchContactsResult searchContacts(SearchContactsRequest request)
Searches contacts and lists the ones that meet a set of filter and sort criteria.
searchContacts in interface AmazonAlexaForBusinesssearchContactsRequest - public SearchDevicesResult searchDevices(SearchDevicesRequest request)
Searches devices and lists the ones that meet a set of filter criteria.
searchDevices in interface AmazonAlexaForBusinesssearchDevicesRequest - public SearchProfilesResult searchProfiles(SearchProfilesRequest request)
Searches room profiles and lists the ones that meet a set of filter criteria.
searchProfiles in interface AmazonAlexaForBusinesssearchProfilesRequest - public SearchRoomsResult searchRooms(SearchRoomsRequest request)
Searches rooms and lists the ones that meet a set of filter and sort criteria.
searchRooms in interface AmazonAlexaForBusinesssearchRoomsRequest - public SearchSkillGroupsResult searchSkillGroups(SearchSkillGroupsRequest request)
Searches skill groups and lists the ones that meet a set of filter and sort criteria.
searchSkillGroups in interface AmazonAlexaForBusinesssearchSkillGroupsRequest - public SearchUsersResult searchUsers(SearchUsersRequest request)
Searches users and lists the ones that meet a set of filter and sort criteria.
searchUsers in interface AmazonAlexaForBusinesssearchUsersRequest - public SendInvitationResult sendInvitation(SendInvitationRequest request)
Sends an enrollment invitation email with a URL to a user. The URL is valid for 72 hours or until you call this operation again, whichever comes first.
sendInvitation in interface AmazonAlexaForBusinesssendInvitationRequest - 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.public StartDeviceSyncResult startDeviceSync(StartDeviceSyncRequest request)
Resets a device and its account to the known default settings, by clearing all information and settings set by previous users.
startDeviceSync in interface AmazonAlexaForBusinessstartDeviceSyncRequest - DeviceNotRegisteredException - The request failed because this device is no longer registered and therefore no longer managed by this
account.public StartSmartHomeApplianceDiscoveryResult startSmartHomeApplianceDiscovery(StartSmartHomeApplianceDiscoveryRequest request)
Initiates the discovery of any smart home appliances associated with the room.
startSmartHomeApplianceDiscovery in interface AmazonAlexaForBusinessstartSmartHomeApplianceDiscoveryRequest - NotFoundException - The resource is not found.public TagResourceResult tagResource(TagResourceRequest request)
Adds metadata tags to a specified resource.
tagResource in interface AmazonAlexaForBusinesstagResourceRequest - NotFoundException - The resource is not found.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes metadata tags from a specified resource.
untagResource in interface AmazonAlexaForBusinessuntagResourceRequest - NotFoundException - The resource is not found.public UpdateAddressBookResult updateAddressBook(UpdateAddressBookRequest request)
Updates address book details by the address book ARN.
updateAddressBook in interface AmazonAlexaForBusinessupdateAddressBookRequest - 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.public UpdateBusinessReportScheduleResult updateBusinessReportSchedule(UpdateBusinessReportScheduleRequest request)
Updates the configuration of the report delivery schedule with the specified schedule ARN.
updateBusinessReportSchedule in interface AmazonAlexaForBusinessupdateBusinessReportScheduleRequest - NotFoundException - The resource is not found.ConcurrentModificationException - Concurrent modification of resources. HTTP Status Code: 400.public UpdateConferenceProviderResult updateConferenceProvider(UpdateConferenceProviderRequest request)
Updates an existing conference provider's settings.
updateConferenceProvider in interface AmazonAlexaForBusinessupdateConferenceProviderRequest - NotFoundException - The resource is not found.public UpdateContactResult updateContact(UpdateContactRequest request)
Updates the contact details by the contact ARN.
updateContact in interface AmazonAlexaForBusinessupdateContactRequest - NotFoundException - The resource is not found.ConcurrentModificationException - Concurrent modification of resources. HTTP Status Code: 400.public UpdateDeviceResult updateDevice(UpdateDeviceRequest request)
Updates the device name by device ARN.
updateDevice in interface AmazonAlexaForBusinessupdateDeviceRequest - 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.public UpdateProfileResult updateProfile(UpdateProfileRequest request)
Updates an existing room profile by room profile ARN.
updateProfile in interface AmazonAlexaForBusinessupdateProfileRequest - 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.public UpdateRoomResult updateRoom(UpdateRoomRequest request)
Updates room details by room ARN.
updateRoom in interface AmazonAlexaForBusinessupdateRoomRequest - NotFoundException - The resource is not found.NameInUseException - The name sent in the request is already in use.public UpdateSkillGroupResult updateSkillGroup(UpdateSkillGroupRequest request)
Updates skill group details by skill group ARN.
updateSkillGroup in interface AmazonAlexaForBusinessupdateSkillGroupRequest - 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.public 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 the request.
getCachedResponseMetadata in interface AmazonAlexaForBusinessrequest - The originally executed requestCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.