@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonAlexaForBusinessClient extends AmazonWebServiceClient implements AmazonAlexaForBusiness
Alexa for Business has been retired and is no longer supported.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
public static AmazonAlexaForBusinessClientBuilder builder()
@Deprecated 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 AmazonAlexaForBusiness
approveSkillRequest
- LimitExceededException
- You are performing an action that would put you beyond your account's limits.NotFoundException
- The resource is not found.ConcurrentModificationException
- There is a concurrent modification of resources.@Deprecated public AssociateContactWithAddressBookResult associateContactWithAddressBook(AssociateContactWithAddressBookRequest request)
Associates a contact with a given address book.
associateContactWithAddressBook
in interface AmazonAlexaForBusiness
associateContactWithAddressBookRequest
- LimitExceededException
- You are performing an action that would put you beyond your account's limits.@Deprecated public AssociateDeviceWithNetworkProfileResult associateDeviceWithNetworkProfile(AssociateDeviceWithNetworkProfileRequest request)
Associates a device with the specified network profile.
associateDeviceWithNetworkProfile
in interface AmazonAlexaForBusiness
associateDeviceWithNetworkProfileRequest
- NotFoundException
- The resource is not found.ConcurrentModificationException
- There is a concurrent modification of resources.DeviceNotRegisteredException
- The request failed because this device is no longer registered and therefore no longer managed by this
account.@Deprecated 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 AmazonAlexaForBusiness
associateDeviceWithRoomRequest
- LimitExceededException
- You are performing an action that would put you beyond your account's limits.ConcurrentModificationException
- There is a concurrent modification of resources.DeviceNotRegisteredException
- The request failed because this device is no longer registered and therefore no longer managed by this
account.@Deprecated 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 AmazonAlexaForBusiness
associateSkillGroupWithRoomRequest
- ConcurrentModificationException
- There is a concurrent modification of resources.@Deprecated public AssociateSkillWithSkillGroupResult associateSkillWithSkillGroup(AssociateSkillWithSkillGroupRequest request)
Associates a skill with a skill group.
associateSkillWithSkillGroup
in interface AmazonAlexaForBusiness
associateSkillWithSkillGroupRequest
- ConcurrentModificationException
- There is a concurrent modification of resources.NotFoundException
- The resource is not found.SkillNotLinkedException
- The skill must be linked to a third-party account.@Deprecated public AssociateSkillWithUsersResult associateSkillWithUsers(AssociateSkillWithUsersRequest request)
Makes a private skill available for enrolled users to enable on their devices.
associateSkillWithUsers
in interface AmazonAlexaForBusiness
associateSkillWithUsersRequest
- ConcurrentModificationException
- There is a concurrent modification of resources.NotFoundException
- The resource is not found.@Deprecated public CreateAddressBookResult createAddressBook(CreateAddressBookRequest request)
Creates an address book with the specified details.
createAddressBook
in interface AmazonAlexaForBusiness
createAddressBookRequest
- AlreadyExistsException
- The resource being created already exists.LimitExceededException
- You are performing an action that would put you beyond your account's limits.@Deprecated 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 AmazonAlexaForBusiness
createBusinessReportScheduleRequest
- AlreadyExistsException
- The resource being created already exists.@Deprecated public CreateConferenceProviderResult createConferenceProvider(CreateConferenceProviderRequest request)
Adds a new conference provider under the user's AWS account.
createConferenceProvider
in interface AmazonAlexaForBusiness
createConferenceProviderRequest
- AlreadyExistsException
- The resource being created already exists.@Deprecated public CreateContactResult createContact(CreateContactRequest request)
Creates a contact with the specified details.
createContact
in interface AmazonAlexaForBusiness
createContactRequest
- AlreadyExistsException
- The resource being created already exists.LimitExceededException
- You are performing an action that would put you beyond your account's limits.@Deprecated public CreateGatewayGroupResult createGatewayGroup(CreateGatewayGroupRequest request)
Creates a gateway group with the specified details.
createGatewayGroup
in interface AmazonAlexaForBusiness
createGatewayGroupRequest
- AlreadyExistsException
- The resource being created already exists.LimitExceededException
- You are performing an action that would put you beyond your account's limits.@Deprecated public CreateNetworkProfileResult createNetworkProfile(CreateNetworkProfileRequest request)
Creates a network profile with the specified details.
createNetworkProfile
in interface AmazonAlexaForBusiness
createNetworkProfileRequest
- AlreadyExistsException
- The resource being created already exists.LimitExceededException
- You are performing an action that would put you beyond your account's limits.ConcurrentModificationException
- There is a concurrent modification of resources.InvalidCertificateAuthorityException
- The Certificate Authority can't issue or revoke a certificate.InvalidServiceLinkedRoleStateException
- The service linked role is locked for deletion.@Deprecated public CreateProfileResult createProfile(CreateProfileRequest request)
Creates a new room profile with the specified details.
createProfile
in interface AmazonAlexaForBusiness
createProfileRequest
- LimitExceededException
- You are performing an action that would put you beyond your account's limits.AlreadyExistsException
- The resource being created already exists.ConcurrentModificationException
- There is a concurrent modification of resources.@Deprecated public CreateRoomResult createRoom(CreateRoomRequest request)
Creates a room with the specified details.
createRoom
in interface AmazonAlexaForBusiness
createRoomRequest
- AlreadyExistsException
- The resource being created already exists.LimitExceededException
- You are performing an action that would put you beyond your account's limits.@Deprecated public CreateSkillGroupResult createSkillGroup(CreateSkillGroupRequest request)
Creates a skill group with a specified name and description.
createSkillGroup
in interface AmazonAlexaForBusiness
createSkillGroupRequest
- AlreadyExistsException
- The resource being created already exists.LimitExceededException
- You are performing an action that would put you beyond your account's limits.ConcurrentModificationException
- There is a concurrent modification of resources.@Deprecated public CreateUserResult createUser(CreateUserRequest request)
Creates a user.
createUser
in interface AmazonAlexaForBusiness
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
- There is a concurrent modification of resources.@Deprecated public DeleteAddressBookResult deleteAddressBook(DeleteAddressBookRequest request)
Deletes an address book by the address book ARN.
deleteAddressBook
in interface AmazonAlexaForBusiness
deleteAddressBookRequest
- NotFoundException
- The resource is not found.ConcurrentModificationException
- There is a concurrent modification of resources.@Deprecated public DeleteBusinessReportScheduleResult deleteBusinessReportSchedule(DeleteBusinessReportScheduleRequest request)
Deletes the recurring report delivery schedule with the specified schedule ARN.
deleteBusinessReportSchedule
in interface AmazonAlexaForBusiness
deleteBusinessReportScheduleRequest
- NotFoundException
- The resource is not found.ConcurrentModificationException
- There is a concurrent modification of resources.@Deprecated public DeleteConferenceProviderResult deleteConferenceProvider(DeleteConferenceProviderRequest request)
Deletes a conference provider.
deleteConferenceProvider
in interface AmazonAlexaForBusiness
deleteConferenceProviderRequest
- NotFoundException
- The resource is not found.@Deprecated public DeleteContactResult deleteContact(DeleteContactRequest request)
Deletes a contact by the contact ARN.
deleteContact
in interface AmazonAlexaForBusiness
deleteContactRequest
- NotFoundException
- The resource is not found.ConcurrentModificationException
- There is a concurrent modification of resources.@Deprecated public DeleteDeviceResult deleteDevice(DeleteDeviceRequest request)
Removes a device from Alexa For Business.
deleteDevice
in interface AmazonAlexaForBusiness
deleteDeviceRequest
- NotFoundException
- The resource is not found.ConcurrentModificationException
- There is a concurrent modification of resources.InvalidCertificateAuthorityException
- The Certificate Authority can't issue or revoke a certificate.@Deprecated public DeleteDeviceUsageDataResult deleteDeviceUsageData(DeleteDeviceUsageDataRequest request)
When this action is called for a specified shared device, it allows authorized users to delete the device's entire previous history of voice input data and associated response data. This action can be called once every 24 hours for a specific shared device.
deleteDeviceUsageData
in interface AmazonAlexaForBusiness
deleteDeviceUsageDataRequest
- NotFoundException
- The resource is not found.DeviceNotRegisteredException
- The request failed because this device is no longer registered and therefore no longer managed by this
account.LimitExceededException
- You are performing an action that would put you beyond your account's limits.@Deprecated public DeleteGatewayGroupResult deleteGatewayGroup(DeleteGatewayGroupRequest request)
Deletes a gateway group.
deleteGatewayGroup
in interface AmazonAlexaForBusiness
deleteGatewayGroupRequest
- ResourceAssociatedException
- Another resource is associated with the resource in the request.@Deprecated public DeleteNetworkProfileResult deleteNetworkProfile(DeleteNetworkProfileRequest request)
Deletes a network profile by the network profile ARN.
deleteNetworkProfile
in interface AmazonAlexaForBusiness
deleteNetworkProfileRequest
- ResourceInUseException
- The resource in the request is already in use.ConcurrentModificationException
- There is a concurrent modification of resources.NotFoundException
- The resource is not found.@Deprecated public DeleteProfileResult deleteProfile(DeleteProfileRequest request)
Deletes a room profile by the profile ARN.
deleteProfile
in interface AmazonAlexaForBusiness
deleteProfileRequest
- NotFoundException
- The resource is not found.ConcurrentModificationException
- There is a concurrent modification of resources.@Deprecated public DeleteRoomResult deleteRoom(DeleteRoomRequest request)
Deletes a room by the room ARN.
deleteRoom
in interface AmazonAlexaForBusiness
deleteRoomRequest
- NotFoundException
- The resource is not found.ConcurrentModificationException
- There is a concurrent modification of resources.@Deprecated public DeleteRoomSkillParameterResult deleteRoomSkillParameter(DeleteRoomSkillParameterRequest request)
Deletes room skill parameter details by room, skill, and parameter key ID.
deleteRoomSkillParameter
in interface AmazonAlexaForBusiness
deleteRoomSkillParameterRequest
- ConcurrentModificationException
- There is a concurrent modification of resources.@Deprecated public DeleteSkillAuthorizationResult deleteSkillAuthorization(DeleteSkillAuthorizationRequest request)
Unlinks a third-party account from a skill.
deleteSkillAuthorization
in interface AmazonAlexaForBusiness
deleteSkillAuthorizationRequest
- NotFoundException
- The resource is not found.ConcurrentModificationException
- There is a concurrent modification of resources.@Deprecated public DeleteSkillGroupResult deleteSkillGroup(DeleteSkillGroupRequest request)
Deletes a skill group by skill group ARN.
deleteSkillGroup
in interface AmazonAlexaForBusiness
deleteSkillGroupRequest
- NotFoundException
- The resource is not found.ConcurrentModificationException
- There is a concurrent modification of resources.@Deprecated public DeleteUserResult deleteUser(DeleteUserRequest request)
Deletes a specified user by user ARN and enrollment ARN.
deleteUser
in interface AmazonAlexaForBusiness
deleteUserRequest
- NotFoundException
- The resource is not found.ConcurrentModificationException
- There is a concurrent modification of resources.@Deprecated public DisassociateContactFromAddressBookResult disassociateContactFromAddressBook(DisassociateContactFromAddressBookRequest request)
Disassociates a contact from a given address book.
disassociateContactFromAddressBook
in interface AmazonAlexaForBusiness
disassociateContactFromAddressBookRequest
- @Deprecated 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 AmazonAlexaForBusiness
disassociateDeviceFromRoomRequest
- ConcurrentModificationException
- There is a concurrent modification of resources.DeviceNotRegisteredException
- The request failed because this device is no longer registered and therefore no longer managed by this
account.@Deprecated public DisassociateSkillFromSkillGroupResult disassociateSkillFromSkillGroup(DisassociateSkillFromSkillGroupRequest request)
Disassociates a skill from a skill group.
disassociateSkillFromSkillGroup
in interface AmazonAlexaForBusiness
disassociateSkillFromSkillGroupRequest
- ConcurrentModificationException
- There is a concurrent modification of resources.NotFoundException
- The resource is not found.@Deprecated 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 AmazonAlexaForBusiness
disassociateSkillFromUsersRequest
- ConcurrentModificationException
- There is a concurrent modification of resources.NotFoundException
- The resource is not found.@Deprecated 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 AmazonAlexaForBusiness
disassociateSkillGroupFromRoomRequest
- ConcurrentModificationException
- There is a concurrent modification of resources.@Deprecated public ForgetSmartHomeAppliancesResult forgetSmartHomeAppliances(ForgetSmartHomeAppliancesRequest request)
Forgets smart home appliances associated to a room.
forgetSmartHomeAppliances
in interface AmazonAlexaForBusiness
forgetSmartHomeAppliancesRequest
- NotFoundException
- The resource is not found.@Deprecated public GetAddressBookResult getAddressBook(GetAddressBookRequest request)
Gets address the book details by the address book ARN.
getAddressBook
in interface AmazonAlexaForBusiness
getAddressBookRequest
- NotFoundException
- The resource is not found.@Deprecated public GetConferencePreferenceResult getConferencePreference(GetConferencePreferenceRequest request)
Retrieves the existing conference preferences.
getConferencePreference
in interface AmazonAlexaForBusiness
getConferencePreferenceRequest
- NotFoundException
- The resource is not found.@Deprecated public GetConferenceProviderResult getConferenceProvider(GetConferenceProviderRequest request)
Gets details about a specific conference provider.
getConferenceProvider
in interface AmazonAlexaForBusiness
getConferenceProviderRequest
- NotFoundException
- The resource is not found.@Deprecated public GetContactResult getContact(GetContactRequest request)
Gets the contact details by the contact ARN.
getContact
in interface AmazonAlexaForBusiness
getContactRequest
- NotFoundException
- The resource is not found.@Deprecated public GetDeviceResult getDevice(GetDeviceRequest request)
Gets the details of a device by device ARN.
getDevice
in interface AmazonAlexaForBusiness
getDeviceRequest
- NotFoundException
- The resource is not found.@Deprecated public GetGatewayResult getGateway(GetGatewayRequest request)
Retrieves the details of a gateway.
getGateway
in interface AmazonAlexaForBusiness
getGatewayRequest
- NotFoundException
- The resource is not found.@Deprecated public GetGatewayGroupResult getGatewayGroup(GetGatewayGroupRequest request)
Retrieves the details of a gateway group.
getGatewayGroup
in interface AmazonAlexaForBusiness
getGatewayGroupRequest
- NotFoundException
- The resource is not found.@Deprecated public GetInvitationConfigurationResult getInvitationConfiguration(GetInvitationConfigurationRequest request)
Retrieves the configured values for the user enrollment invitation email template.
getInvitationConfiguration
in interface AmazonAlexaForBusiness
getInvitationConfigurationRequest
- NotFoundException
- The resource is not found.@Deprecated public GetNetworkProfileResult getNetworkProfile(GetNetworkProfileRequest request)
Gets the network profile details by the network profile ARN.
getNetworkProfile
in interface AmazonAlexaForBusiness
getNetworkProfileRequest
- NotFoundException
- The resource is not found.InvalidSecretsManagerResourceException
- A password in SecretsManager is in an invalid state.@Deprecated public GetProfileResult getProfile(GetProfileRequest request)
Gets the details of a room profile by profile ARN.
getProfile
in interface AmazonAlexaForBusiness
getProfileRequest
- NotFoundException
- The resource is not found.@Deprecated public GetRoomResult getRoom(GetRoomRequest request)
Gets room details by room ARN.
getRoom
in interface AmazonAlexaForBusiness
getRoomRequest
- NotFoundException
- The resource is not found.@Deprecated public GetRoomSkillParameterResult getRoomSkillParameter(GetRoomSkillParameterRequest request)
Gets room skill parameter details by room, skill, and parameter key ARN.
getRoomSkillParameter
in interface AmazonAlexaForBusiness
getRoomSkillParameterRequest
- NotFoundException
- The resource is not found.@Deprecated public GetSkillGroupResult getSkillGroup(GetSkillGroupRequest request)
Gets skill group details by skill group ARN.
getSkillGroup
in interface AmazonAlexaForBusiness
getSkillGroupRequest
- NotFoundException
- The resource is not found.@Deprecated public ListBusinessReportSchedulesResult listBusinessReportSchedules(ListBusinessReportSchedulesRequest request)
Lists the details of the schedules that a user configured. A download URL of the report associated with each schedule is returned every time this action is called. A new download URL is returned each time, and is valid for 24 hours.
listBusinessReportSchedules
in interface AmazonAlexaForBusiness
listBusinessReportSchedulesRequest
- @Deprecated public ListConferenceProvidersResult listConferenceProviders(ListConferenceProvidersRequest request)
Lists conference providers under a specific AWS account.
listConferenceProviders
in interface AmazonAlexaForBusiness
listConferenceProvidersRequest
- @Deprecated public ListDeviceEventsResult listDeviceEvents(ListDeviceEventsRequest request)
Lists the device event history, including device connection status, for up to 30 days.
listDeviceEvents
in interface AmazonAlexaForBusiness
listDeviceEventsRequest
- NotFoundException
- The resource is not found.@Deprecated public ListGatewayGroupsResult listGatewayGroups(ListGatewayGroupsRequest request)
Retrieves a list of gateway group summaries. Use GetGatewayGroup to retrieve details of a specific gateway group.
listGatewayGroups
in interface AmazonAlexaForBusiness
listGatewayGroupsRequest
- @Deprecated public ListGatewaysResult listGateways(ListGatewaysRequest request)
Retrieves a list of gateway summaries. Use GetGateway to retrieve details of a specific gateway. An optional gateway group ARN can be provided to only retrieve gateway summaries of gateways that are associated with that gateway group ARN.
listGateways
in interface AmazonAlexaForBusiness
listGatewaysRequest
- @Deprecated public ListSkillsResult listSkills(ListSkillsRequest request)
Lists all enabled skills in a specific skill group.
listSkills
in interface AmazonAlexaForBusiness
listSkillsRequest
- @Deprecated public ListSkillsStoreCategoriesResult listSkillsStoreCategories(ListSkillsStoreCategoriesRequest request)
Lists all categories in the Alexa skill store.
listSkillsStoreCategories
in interface AmazonAlexaForBusiness
listSkillsStoreCategoriesRequest
- @Deprecated public ListSkillsStoreSkillsByCategoryResult listSkillsStoreSkillsByCategory(ListSkillsStoreSkillsByCategoryRequest request)
Lists all skills in the Alexa skill store by category.
listSkillsStoreSkillsByCategory
in interface AmazonAlexaForBusiness
listSkillsStoreSkillsByCategoryRequest
- @Deprecated public ListSmartHomeAppliancesResult listSmartHomeAppliances(ListSmartHomeAppliancesRequest request)
Lists all of the smart home appliances associated with a room.
listSmartHomeAppliances
in interface AmazonAlexaForBusiness
listSmartHomeAppliancesRequest
- NotFoundException
- The resource is not found.@Deprecated public ListTagsResult listTags(ListTagsRequest request)
Lists all tags for the specified resource.
listTags
in interface AmazonAlexaForBusiness
listTagsRequest
- NotFoundException
- The resource is not found.@Deprecated public PutConferencePreferenceResult putConferencePreference(PutConferencePreferenceRequest request)
Sets the conference preferences on a specific conference provider at the account level.
putConferencePreference
in interface AmazonAlexaForBusiness
putConferencePreferenceRequest
- NotFoundException
- The resource is not found.@Deprecated public PutInvitationConfigurationResult putInvitationConfiguration(PutInvitationConfigurationRequest request)
Configures the email template for the user enrollment invitation with the specified attributes.
putInvitationConfiguration
in interface AmazonAlexaForBusiness
putInvitationConfigurationRequest
- NotFoundException
- The resource is not found.ConcurrentModificationException
- There is a concurrent modification of resources.@Deprecated 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 AmazonAlexaForBusiness
putRoomSkillParameterRequest
- ConcurrentModificationException
- There is a concurrent modification of resources.@Deprecated 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 AmazonAlexaForBusiness
putSkillAuthorizationRequest
- UnauthorizedException
- The caller has no permissions to operate on the resource involved in the API call.ConcurrentModificationException
- There is a concurrent modification of resources.@Deprecated 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 AmazonAlexaForBusiness
registerAVSDeviceRequest
- LimitExceededException
- You are performing an action that would put you beyond your account's limits.ConcurrentModificationException
- There is a concurrent modification of resources.NotFoundException
- The resource is not found.InvalidDeviceException
- The device is in an invalid state.@Deprecated 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 AmazonAlexaForBusiness
rejectSkillRequest
- ConcurrentModificationException
- There is a concurrent modification of resources.NotFoundException
- The resource is not found.@Deprecated 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.
To query ResolveRoom from an Alexa skill, the skill ID needs to be authorized. When the skill is using an AWS Lambda function, the skill is automatically authorized when you publish your skill as a private skill to your AWS account. Skills that are hosted using a custom web service must be manually authorized. To get your skill authorized, contact AWS Support with your AWS account ID that queries the ResolveRoom API and skill ID.
resolveRoom
in interface AmazonAlexaForBusiness
resolveRoomRequest
- NotFoundException
- The resource is not found.@Deprecated public RevokeInvitationResult revokeInvitation(RevokeInvitationRequest request)
Revokes an invitation and invalidates the enrollment URL.
revokeInvitation
in interface AmazonAlexaForBusiness
revokeInvitationRequest
- NotFoundException
- The resource is not found.ConcurrentModificationException
- There is a concurrent modification of resources.@Deprecated public SearchAddressBooksResult searchAddressBooks(SearchAddressBooksRequest request)
Searches address books and lists the ones that meet a set of filter and sort criteria.
searchAddressBooks
in interface AmazonAlexaForBusiness
searchAddressBooksRequest
- @Deprecated public SearchContactsResult searchContacts(SearchContactsRequest request)
Searches contacts and lists the ones that meet a set of filter and sort criteria.
searchContacts
in interface AmazonAlexaForBusiness
searchContactsRequest
- @Deprecated public SearchDevicesResult searchDevices(SearchDevicesRequest request)
Searches devices and lists the ones that meet a set of filter criteria.
searchDevices
in interface AmazonAlexaForBusiness
searchDevicesRequest
- @Deprecated public SearchNetworkProfilesResult searchNetworkProfiles(SearchNetworkProfilesRequest request)
Searches network profiles and lists the ones that meet a set of filter and sort criteria.
searchNetworkProfiles
in interface AmazonAlexaForBusiness
searchNetworkProfilesRequest
- @Deprecated public SearchProfilesResult searchProfiles(SearchProfilesRequest request)
Searches room profiles and lists the ones that meet a set of filter criteria.
searchProfiles
in interface AmazonAlexaForBusiness
searchProfilesRequest
- @Deprecated public SearchRoomsResult searchRooms(SearchRoomsRequest request)
Searches rooms and lists the ones that meet a set of filter and sort criteria.
searchRooms
in interface AmazonAlexaForBusiness
searchRoomsRequest
- @Deprecated public SearchSkillGroupsResult searchSkillGroups(SearchSkillGroupsRequest request)
Searches skill groups and lists the ones that meet a set of filter and sort criteria.
searchSkillGroups
in interface AmazonAlexaForBusiness
searchSkillGroupsRequest
- @Deprecated public SearchUsersResult searchUsers(SearchUsersRequest request)
Searches users and lists the ones that meet a set of filter and sort criteria.
searchUsers
in interface AmazonAlexaForBusiness
searchUsersRequest
- public SendAnnouncementResult sendAnnouncement(SendAnnouncementRequest request)
Triggers an asynchronous flow to send text, SSML, or audio announcements to rooms that are identified by a search or filter.
sendAnnouncement
in interface AmazonAlexaForBusiness
sendAnnouncementRequest
- LimitExceededException
- You are performing an action that would put you beyond your account's limits.AlreadyExistsException
- The resource being created already exists.@Deprecated public SendInvitationResult sendInvitation(SendInvitationRequest request)
Sends an enrollment invitation email with a URL to a user. The URL is valid for 30 days or until you call this operation again, whichever comes first.
sendInvitation
in interface AmazonAlexaForBusiness
sendInvitationRequest
- NotFoundException
- The resource is not found.InvalidUserStatusException
- The attempt to update a user is invalid due to the user's current status.ConcurrentModificationException
- There is a concurrent modification of resources.@Deprecated public StartDeviceSyncResult startDeviceSync(StartDeviceSyncRequest request)
Resets a device and its account to the known default settings. This clears all information and settings set by previous users in the following ways:
Bluetooth - This unpairs all bluetooth devices paired with your echo device.
Volume - This resets the echo device's volume to the default value.
Notifications - This clears all notifications from your echo device.
Lists - This clears all to-do items from your echo device.
Settings - This internally syncs the room's profile (if the device is assigned to a room), contacts, address books, delegation access for account linking, and communications (if enabled on the room profile).
startDeviceSync
in interface AmazonAlexaForBusiness
startDeviceSyncRequest
- DeviceNotRegisteredException
- The request failed because this device is no longer registered and therefore no longer managed by this
account.@Deprecated public StartSmartHomeApplianceDiscoveryResult startSmartHomeApplianceDiscovery(StartSmartHomeApplianceDiscoveryRequest request)
Initiates the discovery of any smart home appliances associated with the room.
startSmartHomeApplianceDiscovery
in interface AmazonAlexaForBusiness
startSmartHomeApplianceDiscoveryRequest
- NotFoundException
- The resource is not found.@Deprecated public TagResourceResult tagResource(TagResourceRequest request)
Adds metadata tags to a specified resource.
tagResource
in interface AmazonAlexaForBusiness
tagResourceRequest
- NotFoundException
- The resource is not found.@Deprecated public UntagResourceResult untagResource(UntagResourceRequest request)
Removes metadata tags from a specified resource.
untagResource
in interface AmazonAlexaForBusiness
untagResourceRequest
- NotFoundException
- The resource is not found.@Deprecated public UpdateAddressBookResult updateAddressBook(UpdateAddressBookRequest request)
Updates address book details by the address book ARN.
updateAddressBook
in interface AmazonAlexaForBusiness
updateAddressBookRequest
- NotFoundException
- The resource is not found.NameInUseException
- The name sent in the request is already in use.ConcurrentModificationException
- There is a concurrent modification of resources.@Deprecated public UpdateBusinessReportScheduleResult updateBusinessReportSchedule(UpdateBusinessReportScheduleRequest request)
Updates the configuration of the report delivery schedule with the specified schedule ARN.
updateBusinessReportSchedule
in interface AmazonAlexaForBusiness
updateBusinessReportScheduleRequest
- NotFoundException
- The resource is not found.ConcurrentModificationException
- There is a concurrent modification of resources.@Deprecated public UpdateConferenceProviderResult updateConferenceProvider(UpdateConferenceProviderRequest request)
Updates an existing conference provider's settings.
updateConferenceProvider
in interface AmazonAlexaForBusiness
updateConferenceProviderRequest
- NotFoundException
- The resource is not found.@Deprecated public UpdateContactResult updateContact(UpdateContactRequest request)
Updates the contact details by the contact ARN.
updateContact
in interface AmazonAlexaForBusiness
updateContactRequest
- NotFoundException
- The resource is not found.ConcurrentModificationException
- There is a concurrent modification of resources.@Deprecated public UpdateDeviceResult updateDevice(UpdateDeviceRequest request)
Updates the device name by device ARN.
updateDevice
in interface AmazonAlexaForBusiness
updateDeviceRequest
- NotFoundException
- The resource is not found.ConcurrentModificationException
- There is a concurrent modification of resources.DeviceNotRegisteredException
- The request failed because this device is no longer registered and therefore no longer managed by this
account.@Deprecated public UpdateGatewayResult updateGateway(UpdateGatewayRequest request)
Updates the details of a gateway. If any optional field is not provided, the existing corresponding value is left unmodified.
updateGateway
in interface AmazonAlexaForBusiness
updateGatewayRequest
- NotFoundException
- The resource is not found.NameInUseException
- The name sent in the request is already in use.@Deprecated public UpdateGatewayGroupResult updateGatewayGroup(UpdateGatewayGroupRequest request)
Updates the details of a gateway group. If any optional field is not provided, the existing corresponding value is left unmodified.
updateGatewayGroup
in interface AmazonAlexaForBusiness
updateGatewayGroupRequest
- NotFoundException
- The resource is not found.NameInUseException
- The name sent in the request is already in use.@Deprecated public UpdateNetworkProfileResult updateNetworkProfile(UpdateNetworkProfileRequest request)
Updates a network profile by the network profile ARN.
updateNetworkProfile
in interface AmazonAlexaForBusiness
updateNetworkProfileRequest
- NotFoundException
- The resource is not found.NameInUseException
- The name sent in the request is already in use.ConcurrentModificationException
- There is a concurrent modification of resources.InvalidCertificateAuthorityException
- The Certificate Authority can't issue or revoke a certificate.InvalidSecretsManagerResourceException
- A password in SecretsManager is in an invalid state.@Deprecated public UpdateProfileResult updateProfile(UpdateProfileRequest request)
Updates an existing room profile by room profile ARN.
updateProfile
in interface AmazonAlexaForBusiness
updateProfileRequest
- NotFoundException
- The resource is not found.NameInUseException
- The name sent in the request is already in use.ConcurrentModificationException
- There is a concurrent modification of resources.@Deprecated public UpdateRoomResult updateRoom(UpdateRoomRequest request)
Updates room details by room ARN.
updateRoom
in interface AmazonAlexaForBusiness
updateRoomRequest
- NotFoundException
- The resource is not found.NameInUseException
- The name sent in the request is already in use.@Deprecated public UpdateSkillGroupResult updateSkillGroup(UpdateSkillGroupRequest request)
Updates skill group details by skill group ARN.
updateSkillGroup
in interface AmazonAlexaForBusiness
updateSkillGroupRequest
- NotFoundException
- The resource is not found.NameInUseException
- The name sent in the request is already in use.ConcurrentModificationException
- There is a concurrent modification of resources.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 AmazonAlexaForBusiness
request
- The originally executed requestpublic void shutdown()
AmazonWebServiceClient
shutdown
in interface AmazonAlexaForBusiness
shutdown
in class AmazonWebServiceClient