com.amazonaws.services.alexaforbusiness

Class AmazonAlexaForBusinessClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.alexaforbusiness.AmazonAlexaForBusinessClient

All Implemented Interfaces:

AmazonAlexaForBusiness

Direct Known Subclasses:

AmazonAlexaForBusinessAsyncClient

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

Client for accessing Alexa For Business. All service calls made using this client are blocking, and will not return until the service call completes.

Alexa for Business has been retired and is no longer supported.

Field Summary

Fields

Modifier and Type	Field and Description
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

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

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
ApproveSkillResult	approveSkill(ApproveSkillRequest request) Deprecated.
AssociateContactWithAddressBookResult	associateContactWithAddressBook(AssociateContactWithAddressBookRequest request) Deprecated.
AssociateDeviceWithNetworkProfileResult	associateDeviceWithNetworkProfile(AssociateDeviceWithNetworkProfileRequest request) Deprecated.
AssociateDeviceWithRoomResult	associateDeviceWithRoom(AssociateDeviceWithRoomRequest request) Deprecated.
AssociateSkillGroupWithRoomResult	associateSkillGroupWithRoom(AssociateSkillGroupWithRoomRequest request) Deprecated.
AssociateSkillWithSkillGroupResult	associateSkillWithSkillGroup(AssociateSkillWithSkillGroupRequest request) Deprecated.
AssociateSkillWithUsersResult	associateSkillWithUsers(AssociateSkillWithUsersRequest request) Deprecated.
static AmazonAlexaForBusinessClientBuilder	builder()
CreateAddressBookResult	createAddressBook(CreateAddressBookRequest request) Deprecated.
CreateBusinessReportScheduleResult	createBusinessReportSchedule(CreateBusinessReportScheduleRequest request) Deprecated.
CreateConferenceProviderResult	createConferenceProvider(CreateConferenceProviderRequest request) Deprecated.
CreateContactResult	createContact(CreateContactRequest request) Deprecated.
CreateGatewayGroupResult	createGatewayGroup(CreateGatewayGroupRequest request) Deprecated.
CreateNetworkProfileResult	createNetworkProfile(CreateNetworkProfileRequest request) Deprecated.
CreateProfileResult	createProfile(CreateProfileRequest request) Deprecated.
CreateRoomResult	createRoom(CreateRoomRequest request) Deprecated.
CreateSkillGroupResult	createSkillGroup(CreateSkillGroupRequest request) Deprecated.
CreateUserResult	createUser(CreateUserRequest request) Deprecated.
DeleteAddressBookResult	deleteAddressBook(DeleteAddressBookRequest request) Deprecated.
DeleteBusinessReportScheduleResult	deleteBusinessReportSchedule(DeleteBusinessReportScheduleRequest request) Deprecated.
DeleteConferenceProviderResult	deleteConferenceProvider(DeleteConferenceProviderRequest request) Deprecated.
DeleteContactResult	deleteContact(DeleteContactRequest request) Deprecated.
DeleteDeviceResult	deleteDevice(DeleteDeviceRequest request) Deprecated.
DeleteDeviceUsageDataResult	deleteDeviceUsageData(DeleteDeviceUsageDataRequest request) Deprecated.
DeleteGatewayGroupResult	deleteGatewayGroup(DeleteGatewayGroupRequest request) Deprecated.
DeleteNetworkProfileResult	deleteNetworkProfile(DeleteNetworkProfileRequest request) Deprecated.
DeleteProfileResult	deleteProfile(DeleteProfileRequest request) Deprecated.
DeleteRoomResult	deleteRoom(DeleteRoomRequest request) Deprecated.
DeleteRoomSkillParameterResult	deleteRoomSkillParameter(DeleteRoomSkillParameterRequest request) Deprecated.
DeleteSkillAuthorizationResult	deleteSkillAuthorization(DeleteSkillAuthorizationRequest request) Deprecated.
DeleteSkillGroupResult	deleteSkillGroup(DeleteSkillGroupRequest request) Deprecated.
DeleteUserResult	deleteUser(DeleteUserRequest request) Deprecated.
DisassociateContactFromAddressBookResult	disassociateContactFromAddressBook(DisassociateContactFromAddressBookRequest request) Deprecated.
DisassociateDeviceFromRoomResult	disassociateDeviceFromRoom(DisassociateDeviceFromRoomRequest request) Deprecated.
DisassociateSkillFromSkillGroupResult	disassociateSkillFromSkillGroup(DisassociateSkillFromSkillGroupRequest request) Deprecated.
DisassociateSkillFromUsersResult	disassociateSkillFromUsers(DisassociateSkillFromUsersRequest request) Deprecated.
DisassociateSkillGroupFromRoomResult	disassociateSkillGroupFromRoom(DisassociateSkillGroupFromRoomRequest request) Deprecated.
ForgetSmartHomeAppliancesResult	forgetSmartHomeAppliances(ForgetSmartHomeAppliancesRequest request) Deprecated.
GetAddressBookResult	getAddressBook(GetAddressBookRequest request) Deprecated.
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) Deprecated.
GetConferenceProviderResult	getConferenceProvider(GetConferenceProviderRequest request) Deprecated.
GetContactResult	getContact(GetContactRequest request) Deprecated.
GetDeviceResult	getDevice(GetDeviceRequest request) Deprecated.
GetGatewayResult	getGateway(GetGatewayRequest request) Deprecated.
GetGatewayGroupResult	getGatewayGroup(GetGatewayGroupRequest request) Deprecated.
GetInvitationConfigurationResult	getInvitationConfiguration(GetInvitationConfigurationRequest request) Deprecated.
GetNetworkProfileResult	getNetworkProfile(GetNetworkProfileRequest request) Deprecated.
GetProfileResult	getProfile(GetProfileRequest request) Deprecated.
GetRoomResult	getRoom(GetRoomRequest request) Deprecated.
GetRoomSkillParameterResult	getRoomSkillParameter(GetRoomSkillParameterRequest request) Deprecated.
GetSkillGroupResult	getSkillGroup(GetSkillGroupRequest request) Deprecated.
ListBusinessReportSchedulesResult	listBusinessReportSchedules(ListBusinessReportSchedulesRequest request) Deprecated.
ListConferenceProvidersResult	listConferenceProviders(ListConferenceProvidersRequest request) Deprecated.
ListDeviceEventsResult	listDeviceEvents(ListDeviceEventsRequest request) Deprecated.
ListGatewayGroupsResult	listGatewayGroups(ListGatewayGroupsRequest request) Deprecated.
ListGatewaysResult	listGateways(ListGatewaysRequest request) Deprecated.
ListSkillsResult	listSkills(ListSkillsRequest request) Deprecated.
ListSkillsStoreCategoriesResult	listSkillsStoreCategories(ListSkillsStoreCategoriesRequest request) Deprecated.
ListSkillsStoreSkillsByCategoryResult	listSkillsStoreSkillsByCategory(ListSkillsStoreSkillsByCategoryRequest request) Deprecated.
ListSmartHomeAppliancesResult	listSmartHomeAppliances(ListSmartHomeAppliancesRequest request) Deprecated.
ListTagsResult	listTags(ListTagsRequest request) Deprecated.
PutConferencePreferenceResult	putConferencePreference(PutConferencePreferenceRequest request) Deprecated.
PutInvitationConfigurationResult	putInvitationConfiguration(PutInvitationConfigurationRequest request) Deprecated.
PutRoomSkillParameterResult	putRoomSkillParameter(PutRoomSkillParameterRequest request) Deprecated.
PutSkillAuthorizationResult	putSkillAuthorization(PutSkillAuthorizationRequest request) Deprecated.
RegisterAVSDeviceResult	registerAVSDevice(RegisterAVSDeviceRequest request) Deprecated.
RejectSkillResult	rejectSkill(RejectSkillRequest request) Deprecated.
ResolveRoomResult	resolveRoom(ResolveRoomRequest request) Deprecated.
RevokeInvitationResult	revokeInvitation(RevokeInvitationRequest request) Deprecated.
SearchAddressBooksResult	searchAddressBooks(SearchAddressBooksRequest request) Deprecated.
SearchContactsResult	searchContacts(SearchContactsRequest request) Deprecated.
SearchDevicesResult	searchDevices(SearchDevicesRequest request) Deprecated.
SearchNetworkProfilesResult	searchNetworkProfiles(SearchNetworkProfilesRequest request) Deprecated.
SearchProfilesResult	searchProfiles(SearchProfilesRequest request) Deprecated.
SearchRoomsResult	searchRooms(SearchRoomsRequest request) Deprecated.
SearchSkillGroupsResult	searchSkillGroups(SearchSkillGroupsRequest request) Deprecated.
SearchUsersResult	searchUsers(SearchUsersRequest request) Deprecated.
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.
SendInvitationResult	sendInvitation(SendInvitationRequest request) Deprecated.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartDeviceSyncResult	startDeviceSync(StartDeviceSyncRequest request) Deprecated.
StartSmartHomeApplianceDiscoveryResult	startSmartHomeApplianceDiscovery(StartSmartHomeApplianceDiscoveryRequest request) Deprecated.
TagResourceResult	tagResource(TagResourceRequest request) Deprecated.
UntagResourceResult	untagResource(UntagResourceRequest request) Deprecated.
UpdateAddressBookResult	updateAddressBook(UpdateAddressBookRequest request) Deprecated.
UpdateBusinessReportScheduleResult	updateBusinessReportSchedule(UpdateBusinessReportScheduleRequest request) Deprecated.
UpdateConferenceProviderResult	updateConferenceProvider(UpdateConferenceProviderRequest request) Deprecated.
UpdateContactResult	updateContact(UpdateContactRequest request) Deprecated.
UpdateDeviceResult	updateDevice(UpdateDeviceRequest request) Deprecated.
UpdateGatewayResult	updateGateway(UpdateGatewayRequest request) Deprecated.
UpdateGatewayGroupResult	updateGatewayGroup(UpdateGatewayGroupRequest request) Deprecated.
UpdateNetworkProfileResult	updateNetworkProfile(UpdateNetworkProfileRequest request) Deprecated.
UpdateProfileResult	updateProfile(UpdateProfileRequest request) Deprecated.
UpdateRoomResult	updateRoom(UpdateRoomRequest request) Deprecated.
UpdateSkillGroupResult	updateSkillGroup(UpdateSkillGroupRequest request) Deprecated.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

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

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Method Detail

builder

public static AmazonAlexaForBusinessClientBuilder builder()

approveSkill

@Deprecated
public ApproveSkillResult approveSkill(ApproveSkillRequest request)

Deprecated.

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.

Specified by:

approveSkill in interface AmazonAlexaForBusiness

Parameters:

approveSkillRequest -

Returns:

Result of the ApproveSkill operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

associateContactWithAddressBook

@Deprecated
public AssociateContactWithAddressBookResult associateContactWithAddressBook(AssociateContactWithAddressBookRequest request)

Deprecated.

Associates a contact with a given address book.

Specified by:

associateContactWithAddressBook in interface AmazonAlexaForBusiness

Parameters:

associateContactWithAddressBookRequest -

Returns:

Result of the AssociateContactWithAddressBook operation returned by the service.

Throws:

LimitExceededException - You are performing an action that would put you beyond your account's limits.

See Also:

AWS API Documentation

associateDeviceWithNetworkProfile

@Deprecated
public AssociateDeviceWithNetworkProfileResult associateDeviceWithNetworkProfile(AssociateDeviceWithNetworkProfileRequest request)

Deprecated.

Associates a device with the specified network profile.

Specified by:

associateDeviceWithNetworkProfile in interface AmazonAlexaForBusiness

Parameters:

associateDeviceWithNetworkProfileRequest -

Returns:

Result of the AssociateDeviceWithNetworkProfile operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

associateDeviceWithRoom

@Deprecated
public AssociateDeviceWithRoomResult associateDeviceWithRoom(AssociateDeviceWithRoomRequest request)

Deprecated.

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.

Specified by:

associateDeviceWithRoom in interface AmazonAlexaForBusiness

Parameters:

associateDeviceWithRoomRequest -

Returns:

Result of the AssociateDeviceWithRoom operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

associateSkillGroupWithRoom

@Deprecated
public AssociateSkillGroupWithRoomResult associateSkillGroupWithRoom(AssociateSkillGroupWithRoomRequest request)

Deprecated.

Associates a skill group with a given room. This enables all skills in the associated skill group on all devices in the room.

Specified by:

associateSkillGroupWithRoom in interface AmazonAlexaForBusiness

Parameters:

associateSkillGroupWithRoomRequest -

Returns:

Result of the AssociateSkillGroupWithRoom operation returned by the service.

Throws:

ConcurrentModificationException - There is a concurrent modification of resources.

See Also:

AWS API Documentation

associateSkillWithSkillGroup

@Deprecated
public AssociateSkillWithSkillGroupResult associateSkillWithSkillGroup(AssociateSkillWithSkillGroupRequest request)

Deprecated.

Associates a skill with a skill group.

Specified by:

associateSkillWithSkillGroup in interface AmazonAlexaForBusiness

Parameters:

associateSkillWithSkillGroupRequest -

Returns:

Result of the AssociateSkillWithSkillGroup operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

associateSkillWithUsers

@Deprecated
public AssociateSkillWithUsersResult associateSkillWithUsers(AssociateSkillWithUsersRequest request)

Deprecated.

Makes a private skill available for enrolled users to enable on their devices.

Specified by:

associateSkillWithUsers in interface AmazonAlexaForBusiness

Parameters:

associateSkillWithUsersRequest -

Returns:

Result of the AssociateSkillWithUsers operation returned by the service.

Throws:

ConcurrentModificationException - There is a concurrent modification of resources.

NotFoundException - The resource is not found.

See Also:

AWS API Documentation

createAddressBook

@Deprecated
public CreateAddressBookResult createAddressBook(CreateAddressBookRequest request)

Deprecated.

Creates an address book with the specified details.

Specified by:

createAddressBook in interface AmazonAlexaForBusiness

Parameters:

createAddressBookRequest -

Returns:

Result of the CreateAddressBook operation returned by the service.

Throws:

AlreadyExistsException - The resource being created already exists.

LimitExceededException - You are performing an action that would put you beyond your account's limits.

See Also:

AWS API Documentation

createBusinessReportSchedule

@Deprecated
public CreateBusinessReportScheduleResult createBusinessReportSchedule(CreateBusinessReportScheduleRequest request)

Deprecated.

Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or weekly interval.

Specified by:

createBusinessReportSchedule in interface AmazonAlexaForBusiness

Parameters:

createBusinessReportScheduleRequest -

Returns:

Result of the CreateBusinessReportSchedule operation returned by the service.

Throws:

AlreadyExistsException - The resource being created already exists.

See Also:

AWS API Documentation

createConferenceProvider

@Deprecated
public CreateConferenceProviderResult createConferenceProvider(CreateConferenceProviderRequest request)

Deprecated.

Adds a new conference provider under the user's AWS account.

Specified by:

createConferenceProvider in interface AmazonAlexaForBusiness

Parameters:

createConferenceProviderRequest -

Returns:

Result of the CreateConferenceProvider operation returned by the service.

Throws:

AlreadyExistsException - The resource being created already exists.

See Also:

AWS API Documentation

createContact

@Deprecated
public CreateContactResult createContact(CreateContactRequest request)

Deprecated.

Creates a contact with the specified details.

Specified by:

createContact in interface AmazonAlexaForBusiness

Parameters:

createContactRequest -

Returns:

Result of the CreateContact operation returned by the service.

Throws:

AlreadyExistsException - The resource being created already exists.

LimitExceededException - You are performing an action that would put you beyond your account's limits.

See Also:

AWS API Documentation

createGatewayGroup

@Deprecated
public CreateGatewayGroupResult createGatewayGroup(CreateGatewayGroupRequest request)

Deprecated.

Creates a gateway group with the specified details.

Specified by:

createGatewayGroup in interface AmazonAlexaForBusiness

Parameters:

createGatewayGroupRequest -

Returns:

Result of the CreateGatewayGroup operation returned by the service.

Throws:

AlreadyExistsException - The resource being created already exists.

LimitExceededException - You are performing an action that would put you beyond your account's limits.

See Also:

AWS API Documentation

createNetworkProfile

@Deprecated
public CreateNetworkProfileResult createNetworkProfile(CreateNetworkProfileRequest request)

Deprecated.

Creates a network profile with the specified details.

Specified by:

createNetworkProfile in interface AmazonAlexaForBusiness

Parameters:

createNetworkProfileRequest -

Returns:

Result of the CreateNetworkProfile operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createProfile

@Deprecated
public CreateProfileResult createProfile(CreateProfileRequest request)

Deprecated.

Creates a new room profile with the specified details.

Specified by:

createProfile in interface AmazonAlexaForBusiness

Parameters:

createProfileRequest -

Returns:

Result of the CreateProfile operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createRoom

@Deprecated
public CreateRoomResult createRoom(CreateRoomRequest request)

Deprecated.

Creates a room with the specified details.

Specified by:

createRoom in interface AmazonAlexaForBusiness

Parameters:

createRoomRequest -

Returns:

Result of the CreateRoom operation returned by the service.

Throws:

AlreadyExistsException - The resource being created already exists.

LimitExceededException - You are performing an action that would put you beyond your account's limits.

See Also:

AWS API Documentation

createSkillGroup

@Deprecated
public CreateSkillGroupResult createSkillGroup(CreateSkillGroupRequest request)

Deprecated.

Creates a skill group with a specified name and description.

Specified by:

createSkillGroup in interface AmazonAlexaForBusiness

Parameters:

createSkillGroupRequest -

Returns:

Result of the CreateSkillGroup operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createUser

@Deprecated
public CreateUserResult createUser(CreateUserRequest request)

Deprecated.

Creates a user.

Specified by:

createUser in interface AmazonAlexaForBusiness

Parameters:

createUserRequest -

Returns:

Result of the CreateUser operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteAddressBook

@Deprecated
public DeleteAddressBookResult deleteAddressBook(DeleteAddressBookRequest request)

Deprecated.

Deletes an address book by the address book ARN.

Specified by:

deleteAddressBook in interface AmazonAlexaForBusiness

Parameters:

deleteAddressBookRequest -

Returns:

Result of the DeleteAddressBook operation returned by the service.

Throws:

NotFoundException - The resource is not found.

ConcurrentModificationException - There is a concurrent modification of resources.

See Also:

AWS API Documentation

deleteBusinessReportSchedule

@Deprecated
public DeleteBusinessReportScheduleResult deleteBusinessReportSchedule(DeleteBusinessReportScheduleRequest request)

Deprecated.

Deletes the recurring report delivery schedule with the specified schedule ARN.

Specified by:

deleteBusinessReportSchedule in interface AmazonAlexaForBusiness

Parameters:

deleteBusinessReportScheduleRequest -

Returns:

Result of the DeleteBusinessReportSchedule operation returned by the service.

Throws:

NotFoundException - The resource is not found.

ConcurrentModificationException - There is a concurrent modification of resources.

See Also:

AWS API Documentation

deleteConferenceProvider

@Deprecated
public DeleteConferenceProviderResult deleteConferenceProvider(DeleteConferenceProviderRequest request)

Deprecated.

Deletes a conference provider.

Specified by:

deleteConferenceProvider in interface AmazonAlexaForBusiness

Parameters:

deleteConferenceProviderRequest -

Returns:

Result of the DeleteConferenceProvider operation returned by the service.

Throws:

NotFoundException - The resource is not found.

See Also:

AWS API Documentation

deleteContact

@Deprecated
public DeleteContactResult deleteContact(DeleteContactRequest request)

Deprecated.

Deletes a contact by the contact ARN.

Specified by:

deleteContact in interface AmazonAlexaForBusiness

Parameters:

deleteContactRequest -

Returns:

Result of the DeleteContact operation returned by the service.

Throws:

NotFoundException - The resource is not found.

ConcurrentModificationException - There is a concurrent modification of resources.

See Also:

AWS API Documentation

deleteDevice

@Deprecated
public DeleteDeviceResult deleteDevice(DeleteDeviceRequest request)

Deprecated.

Removes a device from Alexa For Business.

Specified by:

deleteDevice in interface AmazonAlexaForBusiness

Parameters:

deleteDeviceRequest -

Returns:

Result of the DeleteDevice operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteDeviceUsageData

@Deprecated
public DeleteDeviceUsageDataResult deleteDeviceUsageData(DeleteDeviceUsageDataRequest request)

Deprecated.

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.

Specified by:

deleteDeviceUsageData in interface AmazonAlexaForBusiness

Parameters:

deleteDeviceUsageDataRequest -

Returns:

Result of the DeleteDeviceUsageData operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteGatewayGroup

@Deprecated
public DeleteGatewayGroupResult deleteGatewayGroup(DeleteGatewayGroupRequest request)

Deprecated.

Deletes a gateway group.

Specified by:

deleteGatewayGroup in interface AmazonAlexaForBusiness

Parameters:

deleteGatewayGroupRequest -

Returns:

Result of the DeleteGatewayGroup operation returned by the service.

Throws:

ResourceAssociatedException - Another resource is associated with the resource in the request.

See Also:

AWS API Documentation

deleteNetworkProfile

@Deprecated
public DeleteNetworkProfileResult deleteNetworkProfile(DeleteNetworkProfileRequest request)

Deprecated.

Deletes a network profile by the network profile ARN.

Specified by:

deleteNetworkProfile in interface AmazonAlexaForBusiness

Parameters:

deleteNetworkProfileRequest -

Returns:

Result of the DeleteNetworkProfile operation returned by the service.

Throws:

ResourceInUseException - The resource in the request is already in use.

ConcurrentModificationException - There is a concurrent modification of resources.

NotFoundException - The resource is not found.

See Also:

AWS API Documentation

deleteProfile

@Deprecated
public DeleteProfileResult deleteProfile(DeleteProfileRequest request)

Deprecated.

Deletes a room profile by the profile ARN.

Specified by:

deleteProfile in interface AmazonAlexaForBusiness

Parameters:

deleteProfileRequest -

Returns:

Result of the DeleteProfile operation returned by the service.

Throws:

NotFoundException - The resource is not found.

ConcurrentModificationException - There is a concurrent modification of resources.

See Also:

AWS API Documentation

deleteRoom

@Deprecated
public DeleteRoomResult deleteRoom(DeleteRoomRequest request)

Deprecated.

Deletes a room by the room ARN.

Specified by:

deleteRoom in interface AmazonAlexaForBusiness

Parameters:

deleteRoomRequest -

Returns:

Result of the DeleteRoom operation returned by the service.

Throws:

NotFoundException - The resource is not found.

ConcurrentModificationException - There is a concurrent modification of resources.

See Also:

AWS API Documentation

deleteRoomSkillParameter

@Deprecated
public DeleteRoomSkillParameterResult deleteRoomSkillParameter(DeleteRoomSkillParameterRequest request)

Deprecated.

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

Specified by:

deleteRoomSkillParameter in interface AmazonAlexaForBusiness

Parameters:

deleteRoomSkillParameterRequest -

Returns:

Result of the DeleteRoomSkillParameter operation returned by the service.

Throws:

ConcurrentModificationException - There is a concurrent modification of resources.

See Also:

AWS API Documentation

deleteSkillAuthorization

@Deprecated
public DeleteSkillAuthorizationResult deleteSkillAuthorization(DeleteSkillAuthorizationRequest request)

Deprecated.

Unlinks a third-party account from a skill.

Specified by:

deleteSkillAuthorization in interface AmazonAlexaForBusiness

Parameters:

deleteSkillAuthorizationRequest -

Returns:

Result of the DeleteSkillAuthorization operation returned by the service.

Throws:

NotFoundException - The resource is not found.

ConcurrentModificationException - There is a concurrent modification of resources.

See Also:

AWS API Documentation

deleteSkillGroup

@Deprecated
public DeleteSkillGroupResult deleteSkillGroup(DeleteSkillGroupRequest request)

Deprecated.

Deletes a skill group by skill group ARN.

Specified by:

deleteSkillGroup in interface AmazonAlexaForBusiness

Parameters:

deleteSkillGroupRequest -

Returns:

Result of the DeleteSkillGroup operation returned by the service.

Throws:

NotFoundException - The resource is not found.

ConcurrentModificationException - There is a concurrent modification of resources.

See Also:

AWS API Documentation

deleteUser

@Deprecated
public DeleteUserResult deleteUser(DeleteUserRequest request)

Deprecated.

Deletes a specified user by user ARN and enrollment ARN.

Specified by:

deleteUser in interface AmazonAlexaForBusiness

Parameters:

deleteUserRequest -

Returns:

Result of the DeleteUser operation returned by the service.

Throws:

NotFoundException - The resource is not found.

ConcurrentModificationException - There is a concurrent modification of resources.

See Also:

AWS API Documentation

disassociateContactFromAddressBook

@Deprecated
public DisassociateContactFromAddressBookResult disassociateContactFromAddressBook(DisassociateContactFromAddressBookRequest request)

Deprecated.

Disassociates a contact from a given address book.

Specified by:

disassociateContactFromAddressBook in interface AmazonAlexaForBusiness

Parameters:

disassociateContactFromAddressBookRequest -

Returns:

Result of the DisassociateContactFromAddressBook operation returned by the service.

See Also:

AWS API Documentation

disassociateDeviceFromRoom

@Deprecated
public DisassociateDeviceFromRoomResult disassociateDeviceFromRoom(DisassociateDeviceFromRoomRequest request)

Deprecated.

Disassociates a device from its current room. The device continues to be connected to the Wi-Fi network and is still registered to the account. The device settings and skills are removed from the room.

Specified by:

disassociateDeviceFromRoom in interface AmazonAlexaForBusiness

Parameters:

disassociateDeviceFromRoomRequest -

Returns:

Result of the DisassociateDeviceFromRoom operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

disassociateSkillFromSkillGroup

@Deprecated
public DisassociateSkillFromSkillGroupResult disassociateSkillFromSkillGroup(DisassociateSkillFromSkillGroupRequest request)

Deprecated.

Disassociates a skill from a skill group.

Specified by:

disassociateSkillFromSkillGroup in interface AmazonAlexaForBusiness

Parameters:

disassociateSkillFromSkillGroupRequest -

Returns:

Result of the DisassociateSkillFromSkillGroup operation returned by the service.

Throws:

ConcurrentModificationException - There is a concurrent modification of resources.

NotFoundException - The resource is not found.

See Also:

AWS API Documentation

disassociateSkillFromUsers

@Deprecated
public DisassociateSkillFromUsersResult disassociateSkillFromUsers(DisassociateSkillFromUsersRequest request)

Deprecated.

Makes a private skill unavailable for enrolled users and prevents them from enabling it on their devices.

Specified by:

disassociateSkillFromUsers in interface AmazonAlexaForBusiness

Parameters:

disassociateSkillFromUsersRequest -

Returns:

Result of the DisassociateSkillFromUsers operation returned by the service.

Throws:

ConcurrentModificationException - There is a concurrent modification of resources.

NotFoundException - The resource is not found.

See Also:

AWS API Documentation

disassociateSkillGroupFromRoom

@Deprecated
public DisassociateSkillGroupFromRoomResult disassociateSkillGroupFromRoom(DisassociateSkillGroupFromRoomRequest request)

Deprecated.

Disassociates a skill group from a specified room. This disables all skills in the skill group on all devices in the room.

Specified by:

disassociateSkillGroupFromRoom in interface AmazonAlexaForBusiness

Parameters:

disassociateSkillGroupFromRoomRequest -

Returns:

Result of the DisassociateSkillGroupFromRoom operation returned by the service.

Throws:

ConcurrentModificationException - There is a concurrent modification of resources.

See Also:

AWS API Documentation

forgetSmartHomeAppliances

@Deprecated
public ForgetSmartHomeAppliancesResult forgetSmartHomeAppliances(ForgetSmartHomeAppliancesRequest request)

Deprecated.

Forgets smart home appliances associated to a room.

Specified by:

forgetSmartHomeAppliances in interface AmazonAlexaForBusiness

Parameters:

forgetSmartHomeAppliancesRequest -

Returns:

Result of the ForgetSmartHomeAppliances operation returned by the service.

Throws:

NotFoundException - The resource is not found.

See Also:

AWS API Documentation

getAddressBook

@Deprecated
public GetAddressBookResult getAddressBook(GetAddressBookRequest request)

Deprecated.

Gets address the book details by the address book ARN.

Specified by:

getAddressBook in interface AmazonAlexaForBusiness

Parameters:

getAddressBookRequest -

Returns:

Result of the GetAddressBook operation returned by the service.

Throws:

NotFoundException - The resource is not found.

See Also:

AWS API Documentation

getConferencePreference

@Deprecated
public GetConferencePreferenceResult getConferencePreference(GetConferencePreferenceRequest request)

Deprecated.

Retrieves the existing conference preferences.

Specified by:

getConferencePreference in interface AmazonAlexaForBusiness

Parameters:

getConferencePreferenceRequest -

Returns:

Result of the GetConferencePreference operation returned by the service.

Throws:

NotFoundException - The resource is not found.

See Also:

AWS API Documentation

getConferenceProvider

@Deprecated
public GetConferenceProviderResult getConferenceProvider(GetConferenceProviderRequest request)

Deprecated.

Gets details about a specific conference provider.

Specified by:

getConferenceProvider in interface AmazonAlexaForBusiness

Parameters:

getConferenceProviderRequest -

Returns:

Result of the GetConferenceProvider operation returned by the service.

Throws:

NotFoundException - The resource is not found.

See Also:

AWS API Documentation

getContact

@Deprecated
public GetContactResult getContact(GetContactRequest request)

Deprecated.

Gets the contact details by the contact ARN.

Specified by:

getContact in interface AmazonAlexaForBusiness

Parameters:

getContactRequest -

Returns:

Result of the GetContact operation returned by the service.

Throws:

NotFoundException - The resource is not found.

See Also:

AWS API Documentation

getDevice

@Deprecated
public GetDeviceResult getDevice(GetDeviceRequest request)

Deprecated.

Gets the details of a device by device ARN.

Specified by:

getDevice in interface AmazonAlexaForBusiness

Parameters:

getDeviceRequest -

Returns:

Result of the GetDevice operation returned by the service.

Throws:

NotFoundException - The resource is not found.

See Also:

AWS API Documentation

getGateway

@Deprecated
public GetGatewayResult getGateway(GetGatewayRequest request)

Deprecated.

Retrieves the details of a gateway.

Specified by:

getGateway in interface AmazonAlexaForBusiness

Parameters:

getGatewayRequest -

Returns:

Result of the GetGateway operation returned by the service.

Throws:

NotFoundException - The resource is not found.

See Also:

AWS API Documentation

getGatewayGroup

@Deprecated
public GetGatewayGroupResult getGatewayGroup(GetGatewayGroupRequest request)

Deprecated.

Retrieves the details of a gateway group.

Specified by:

getGatewayGroup in interface AmazonAlexaForBusiness

Parameters:

getGatewayGroupRequest -

Returns:

Result of the GetGatewayGroup operation returned by the service.

Throws:

NotFoundException - The resource is not found.

See Also:

AWS API Documentation

getInvitationConfiguration

@Deprecated
public GetInvitationConfigurationResult getInvitationConfiguration(GetInvitationConfigurationRequest request)

Deprecated.

Retrieves the configured values for the user enrollment invitation email template.

Specified by:

getInvitationConfiguration in interface AmazonAlexaForBusiness

Parameters:

getInvitationConfigurationRequest -

Returns:

Result of the GetInvitationConfiguration operation returned by the service.

Throws:

NotFoundException - The resource is not found.

See Also:

AWS API Documentation

getNetworkProfile

@Deprecated
public GetNetworkProfileResult getNetworkProfile(GetNetworkProfileRequest request)

Deprecated.

Gets the network profile details by the network profile ARN.

Specified by:

getNetworkProfile in interface AmazonAlexaForBusiness

Parameters:

getNetworkProfileRequest -

Returns:

Result of the GetNetworkProfile operation returned by the service.

Throws:

NotFoundException - The resource is not found.

InvalidSecretsManagerResourceException - A password in SecretsManager is in an invalid state.

See Also:

AWS API Documentation

getProfile

@Deprecated
public GetProfileResult getProfile(GetProfileRequest request)

Deprecated.

Gets the details of a room profile by profile ARN.

Specified by:

getProfile in interface AmazonAlexaForBusiness

Parameters:

getProfileRequest -

Returns:

Result of the GetProfile operation returned by the service.

Throws:

NotFoundException - The resource is not found.

See Also:

AWS API Documentation

getRoom

@Deprecated
public GetRoomResult getRoom(GetRoomRequest request)

Deprecated.

Gets room details by room ARN.

Specified by:

getRoom in interface AmazonAlexaForBusiness

Parameters:

getRoomRequest -

Returns:

Result of the GetRoom operation returned by the service.

Throws:

NotFoundException - The resource is not found.

See Also:

AWS API Documentation

getRoomSkillParameter

@Deprecated
public GetRoomSkillParameterResult getRoomSkillParameter(GetRoomSkillParameterRequest request)

Deprecated.

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

Specified by:

getRoomSkillParameter in interface AmazonAlexaForBusiness

Parameters:

getRoomSkillParameterRequest -

Returns:

Result of the GetRoomSkillParameter operation returned by the service.

Throws:

NotFoundException - The resource is not found.

See Also:

AWS API Documentation

getSkillGroup

@Deprecated
public GetSkillGroupResult getSkillGroup(GetSkillGroupRequest request)

Deprecated.

Gets skill group details by skill group ARN.

Specified by:

getSkillGroup in interface AmazonAlexaForBusiness

Parameters:

getSkillGroupRequest -

Returns:

Result of the GetSkillGroup operation returned by the service.

Throws:

NotFoundException - The resource is not found.

See Also:

AWS API Documentation

listBusinessReportSchedules

@Deprecated
public ListBusinessReportSchedulesResult listBusinessReportSchedules(ListBusinessReportSchedulesRequest request)

Deprecated.

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.

Specified by:

listBusinessReportSchedules in interface AmazonAlexaForBusiness

Parameters:

listBusinessReportSchedulesRequest -

Returns:

Result of the ListBusinessReportSchedules operation returned by the service.

See Also:

AWS API Documentation

listConferenceProviders

@Deprecated
public ListConferenceProvidersResult listConferenceProviders(ListConferenceProvidersRequest request)

Deprecated.

Lists conference providers under a specific AWS account.

Specified by:

listConferenceProviders in interface AmazonAlexaForBusiness

Parameters:

listConferenceProvidersRequest -

Returns:

Result of the ListConferenceProviders operation returned by the service.

See Also:

AWS API Documentation

listDeviceEvents

@Deprecated
public ListDeviceEventsResult listDeviceEvents(ListDeviceEventsRequest request)

Deprecated.

Lists the device event history, including device connection status, for up to 30 days.

Specified by:

listDeviceEvents in interface AmazonAlexaForBusiness

Parameters:

listDeviceEventsRequest -

Returns:

Result of the ListDeviceEvents operation returned by the service.

Throws:

NotFoundException - The resource is not found.

See Also:

AWS API Documentation

listGatewayGroups

@Deprecated
public ListGatewayGroupsResult listGatewayGroups(ListGatewayGroupsRequest request)

Deprecated.

Retrieves a list of gateway group summaries. Use GetGatewayGroup to retrieve details of a specific gateway group.

Specified by:

listGatewayGroups in interface AmazonAlexaForBusiness

Parameters:

listGatewayGroupsRequest -

Returns:

Result of the ListGatewayGroups operation returned by the service.

See Also:

AWS API Documentation

listGateways

@Deprecated
public ListGatewaysResult listGateways(ListGatewaysRequest request)

Deprecated.

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.

Specified by:

listGateways in interface AmazonAlexaForBusiness

Parameters:

listGatewaysRequest -

Returns:

Result of the ListGateways operation returned by the service.

See Also:

AWS API Documentation

listSkills

@Deprecated
public ListSkillsResult listSkills(ListSkillsRequest request)

Deprecated.

Lists all enabled skills in a specific skill group.

Specified by:

listSkills in interface AmazonAlexaForBusiness

Parameters:

listSkillsRequest -

Returns:

Result of the ListSkills operation returned by the service.

See Also:

AWS API Documentation

listSkillsStoreCategories

@Deprecated
public ListSkillsStoreCategoriesResult listSkillsStoreCategories(ListSkillsStoreCategoriesRequest request)

Deprecated.

Lists all categories in the Alexa skill store.

Specified by:

listSkillsStoreCategories in interface AmazonAlexaForBusiness

Parameters:

listSkillsStoreCategoriesRequest -

Returns:

Result of the ListSkillsStoreCategories operation returned by the service.

See Also:

AWS API Documentation

listSkillsStoreSkillsByCategory

@Deprecated
public ListSkillsStoreSkillsByCategoryResult listSkillsStoreSkillsByCategory(ListSkillsStoreSkillsByCategoryRequest request)

Deprecated.

Lists all skills in the Alexa skill store by category.

Specified by:

listSkillsStoreSkillsByCategory in interface AmazonAlexaForBusiness

Parameters:

listSkillsStoreSkillsByCategoryRequest -

Returns:

Result of the ListSkillsStoreSkillsByCategory operation returned by the service.

See Also:

AWS API Documentation

listSmartHomeAppliances

@Deprecated
public ListSmartHomeAppliancesResult listSmartHomeAppliances(ListSmartHomeAppliancesRequest request)

Deprecated.

Lists all of the smart home appliances associated with a room.

Specified by:

listSmartHomeAppliances in interface AmazonAlexaForBusiness

Parameters:

listSmartHomeAppliancesRequest -

Returns:

Result of the ListSmartHomeAppliances operation returned by the service.

Throws:

NotFoundException - The resource is not found.

See Also:

AWS API Documentation

listTags

@Deprecated
public ListTagsResult listTags(ListTagsRequest request)

Deprecated.

Lists all tags for the specified resource.

Specified by:

listTags in interface AmazonAlexaForBusiness

Parameters:

listTagsRequest -

Returns:

Result of the ListTags operation returned by the service.

Throws:

NotFoundException - The resource is not found.

See Also:

AWS API Documentation

putConferencePreference

@Deprecated
public PutConferencePreferenceResult putConferencePreference(PutConferencePreferenceRequest request)

Deprecated.

Sets the conference preferences on a specific conference provider at the account level.

Specified by:

putConferencePreference in interface AmazonAlexaForBusiness

Parameters:

putConferencePreferenceRequest -

Returns:

Result of the PutConferencePreference operation returned by the service.

Throws:

NotFoundException - The resource is not found.

See Also:

AWS API Documentation

putInvitationConfiguration

@Deprecated
public PutInvitationConfigurationResult putInvitationConfiguration(PutInvitationConfigurationRequest request)

Deprecated.

Configures the email template for the user enrollment invitation with the specified attributes.

Specified by:

putInvitationConfiguration in interface AmazonAlexaForBusiness

Parameters:

putInvitationConfigurationRequest -

Returns:

Result of the PutInvitationConfiguration operation returned by the service.

Throws:

NotFoundException - The resource is not found.

ConcurrentModificationException - There is a concurrent modification of resources.

See Also:

AWS API Documentation

putRoomSkillParameter

@Deprecated
public PutRoomSkillParameterResult putRoomSkillParameter(PutRoomSkillParameterRequest request)

Deprecated.

Updates room skill parameter details by room, skill, and parameter key ID. Not all skills have a room skill parameter.

Specified by:

putRoomSkillParameter in interface AmazonAlexaForBusiness

Parameters:

putRoomSkillParameterRequest -

Returns:

Result of the PutRoomSkillParameter operation returned by the service.

Throws:

ConcurrentModificationException - There is a concurrent modification of resources.

See Also:

AWS API Documentation

putSkillAuthorization

@Deprecated
public PutSkillAuthorizationResult putSkillAuthorization(PutSkillAuthorizationRequest request)

Deprecated.

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.

Specified by:

putSkillAuthorization in interface AmazonAlexaForBusiness

Parameters:

putSkillAuthorizationRequest -

Returns:

Result of the PutSkillAuthorization operation returned by the service.

Throws:

UnauthorizedException - The caller has no permissions to operate on the resource involved in the API call.

ConcurrentModificationException - There is a concurrent modification of resources.

See Also:

AWS API Documentation

registerAVSDevice

@Deprecated
public RegisterAVSDeviceResult registerAVSDevice(RegisterAVSDeviceRequest request)

Deprecated.

Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service (AVS).

Specified by:

registerAVSDevice in interface AmazonAlexaForBusiness

Parameters:

registerAVSDeviceRequest -

Returns:

Result of the RegisterAVSDevice operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

rejectSkill

@Deprecated
public RejectSkillResult rejectSkill(RejectSkillRequest request)

Deprecated.

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.

Specified by:

rejectSkill in interface AmazonAlexaForBusiness

Parameters:

rejectSkillRequest -

Returns:

Result of the RejectSkill operation returned by the service.

Throws:

ConcurrentModificationException - There is a concurrent modification of resources.

NotFoundException - The resource is not found.

See Also:

AWS API Documentation

resolveRoom

@Deprecated
public ResolveRoomResult resolveRoom(ResolveRoomRequest request)

Deprecated.

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.

Specified by:

resolveRoom in interface AmazonAlexaForBusiness

Parameters:

resolveRoomRequest -

Returns:

Result of the ResolveRoom operation returned by the service.

Throws:

NotFoundException - The resource is not found.

See Also:

AWS API Documentation

revokeInvitation

@Deprecated
public RevokeInvitationResult revokeInvitation(RevokeInvitationRequest request)

Deprecated.

Revokes an invitation and invalidates the enrollment URL.

Specified by:

revokeInvitation in interface AmazonAlexaForBusiness

Parameters:

revokeInvitationRequest -

Returns:

Result of the RevokeInvitation operation returned by the service.

Throws:

NotFoundException - The resource is not found.

ConcurrentModificationException - There is a concurrent modification of resources.

See Also:

AWS API Documentation

searchAddressBooks

@Deprecated
public SearchAddressBooksResult searchAddressBooks(SearchAddressBooksRequest request)

Deprecated.

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

Specified by:

searchAddressBooks in interface AmazonAlexaForBusiness

Parameters:

searchAddressBooksRequest -

Returns:

Result of the SearchAddressBooks operation returned by the service.

See Also:

AWS API Documentation

searchContacts

@Deprecated
public SearchContactsResult searchContacts(SearchContactsRequest request)

Deprecated.

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

Specified by:

searchContacts in interface AmazonAlexaForBusiness

Parameters:

searchContactsRequest -

Returns:

Result of the SearchContacts operation returned by the service.

See Also:

AWS API Documentation

searchDevices

@Deprecated
public SearchDevicesResult searchDevices(SearchDevicesRequest request)

Deprecated.

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

Specified by:

searchDevices in interface AmazonAlexaForBusiness

Parameters:

searchDevicesRequest -

Returns:

Result of the SearchDevices operation returned by the service.

See Also:

AWS API Documentation

searchNetworkProfiles

@Deprecated
public SearchNetworkProfilesResult searchNetworkProfiles(SearchNetworkProfilesRequest request)

Deprecated.

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

Specified by:

searchNetworkProfiles in interface AmazonAlexaForBusiness

Parameters:

searchNetworkProfilesRequest -

Returns:

Result of the SearchNetworkProfiles operation returned by the service.

See Also:

AWS API Documentation

searchProfiles

@Deprecated
public SearchProfilesResult searchProfiles(SearchProfilesRequest request)

Deprecated.

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

Specified by:

searchProfiles in interface AmazonAlexaForBusiness

Parameters:

searchProfilesRequest -

Returns:

Result of the SearchProfiles operation returned by the service.

See Also:

AWS API Documentation

searchRooms

@Deprecated
public SearchRoomsResult searchRooms(SearchRoomsRequest request)

Deprecated.

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

Specified by:

searchRooms in interface AmazonAlexaForBusiness

Parameters:

searchRoomsRequest -

Returns:

Result of the SearchRooms operation returned by the service.

See Also:

AWS API Documentation

searchSkillGroups

@Deprecated
public SearchSkillGroupsResult searchSkillGroups(SearchSkillGroupsRequest request)

Deprecated.

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

Specified by:

searchSkillGroups in interface AmazonAlexaForBusiness

Parameters:

searchSkillGroupsRequest -

Returns:

Result of the SearchSkillGroups operation returned by the service.

See Also:

AWS API Documentation

searchUsers

@Deprecated
public SearchUsersResult searchUsers(SearchUsersRequest request)

Deprecated.

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

Specified by:

searchUsers in interface AmazonAlexaForBusiness

Parameters:

searchUsersRequest -

Returns:

Result of the SearchUsers operation returned by the service.

See Also:

AWS API Documentation

sendAnnouncement

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.

Specified by:

sendAnnouncement in interface AmazonAlexaForBusiness

Parameters:

sendAnnouncementRequest -

Returns:

Result of the SendAnnouncement operation returned by the service.

Throws:

LimitExceededException - You are performing an action that would put you beyond your account's limits.

AlreadyExistsException - The resource being created already exists.

See Also:

AWS API Documentation

sendInvitation

@Deprecated
public SendInvitationResult sendInvitation(SendInvitationRequest request)

Deprecated.

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.

Specified by:

sendInvitation in interface AmazonAlexaForBusiness

Parameters:

sendInvitationRequest -

Returns:

Result of the SendInvitation operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

startDeviceSync

@Deprecated
public StartDeviceSyncResult startDeviceSync(StartDeviceSyncRequest request)

Deprecated.

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).

Specified by:

startDeviceSync in interface AmazonAlexaForBusiness

Parameters:

startDeviceSyncRequest -

Returns:

Result of the StartDeviceSync operation returned by the service.

Throws:

DeviceNotRegisteredException - The request failed because this device is no longer registered and therefore no longer managed by this account.

See Also:

AWS API Documentation

startSmartHomeApplianceDiscovery

@Deprecated
public StartSmartHomeApplianceDiscoveryResult startSmartHomeApplianceDiscovery(StartSmartHomeApplianceDiscoveryRequest request)

Deprecated.

Initiates the discovery of any smart home appliances associated with the room.

Specified by:

startSmartHomeApplianceDiscovery in interface AmazonAlexaForBusiness

Parameters:

startSmartHomeApplianceDiscoveryRequest -

Returns:

Result of the StartSmartHomeApplianceDiscovery operation returned by the service.

Throws:

NotFoundException - The resource is not found.

See Also:

AWS API Documentation

tagResource

@Deprecated
public TagResourceResult tagResource(TagResourceRequest request)

Deprecated.

Adds metadata tags to a specified resource.

Specified by:

tagResource in interface AmazonAlexaForBusiness

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

NotFoundException - The resource is not found.

See Also:

AWS API Documentation

untagResource

@Deprecated
public UntagResourceResult untagResource(UntagResourceRequest request)

Deprecated.

Removes metadata tags from a specified resource.

Specified by:

untagResource in interface AmazonAlexaForBusiness

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

NotFoundException - The resource is not found.

See Also:

AWS API Documentation

updateAddressBook

@Deprecated
public UpdateAddressBookResult updateAddressBook(UpdateAddressBookRequest request)

Deprecated.

Updates address book details by the address book ARN.

Specified by:

updateAddressBook in interface AmazonAlexaForBusiness

Parameters:

updateAddressBookRequest -

Returns:

Result of the UpdateAddressBook operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateBusinessReportSchedule

@Deprecated
public UpdateBusinessReportScheduleResult updateBusinessReportSchedule(UpdateBusinessReportScheduleRequest request)

Deprecated.

Updates the configuration of the report delivery schedule with the specified schedule ARN.

Specified by:

updateBusinessReportSchedule in interface AmazonAlexaForBusiness

Parameters:

updateBusinessReportScheduleRequest -

Returns:

Result of the UpdateBusinessReportSchedule operation returned by the service.

Throws:

NotFoundException - The resource is not found.

ConcurrentModificationException - There is a concurrent modification of resources.

See Also:

AWS API Documentation

updateConferenceProvider

@Deprecated
public UpdateConferenceProviderResult updateConferenceProvider(UpdateConferenceProviderRequest request)

Deprecated.

Updates an existing conference provider's settings.

Specified by:

updateConferenceProvider in interface AmazonAlexaForBusiness

Parameters:

updateConferenceProviderRequest -

Returns:

Result of the UpdateConferenceProvider operation returned by the service.

Throws:

NotFoundException - The resource is not found.

See Also:

AWS API Documentation

updateContact

@Deprecated
public UpdateContactResult updateContact(UpdateContactRequest request)

Deprecated.

Updates the contact details by the contact ARN.

Specified by:

updateContact in interface AmazonAlexaForBusiness

Parameters:

updateContactRequest -

Returns:

Result of the UpdateContact operation returned by the service.

Throws:

NotFoundException - The resource is not found.

ConcurrentModificationException - There is a concurrent modification of resources.

See Also:

AWS API Documentation

updateDevice

@Deprecated
public UpdateDeviceResult updateDevice(UpdateDeviceRequest request)

Deprecated.

Updates the device name by device ARN.

Specified by:

updateDevice in interface AmazonAlexaForBusiness

Parameters:

updateDeviceRequest -

Returns:

Result of the UpdateDevice operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateGateway

@Deprecated
public UpdateGatewayResult updateGateway(UpdateGatewayRequest request)

Deprecated.

Updates the details of a gateway. If any optional field is not provided, the existing corresponding value is left unmodified.

Specified by:

updateGateway in interface AmazonAlexaForBusiness

Parameters:

updateGatewayRequest -

Returns:

Result of the UpdateGateway operation returned by the service.

Throws:

NotFoundException - The resource is not found.

NameInUseException - The name sent in the request is already in use.

See Also:

AWS API Documentation

updateGatewayGroup

@Deprecated
public UpdateGatewayGroupResult updateGatewayGroup(UpdateGatewayGroupRequest request)

Deprecated.

Updates the details of a gateway group. If any optional field is not provided, the existing corresponding value is left unmodified.

Specified by:

updateGatewayGroup in interface AmazonAlexaForBusiness

Parameters:

updateGatewayGroupRequest -

Returns:

Result of the UpdateGatewayGroup operation returned by the service.

Throws:

NotFoundException - The resource is not found.

NameInUseException - The name sent in the request is already in use.

See Also:

AWS API Documentation

updateNetworkProfile

@Deprecated
public UpdateNetworkProfileResult updateNetworkProfile(UpdateNetworkProfileRequest request)

Deprecated.

Updates a network profile by the network profile ARN.

Specified by:

updateNetworkProfile in interface AmazonAlexaForBusiness

Parameters:

updateNetworkProfileRequest -

Returns:

Result of the UpdateNetworkProfile operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateProfile

@Deprecated
public UpdateProfileResult updateProfile(UpdateProfileRequest request)

Deprecated.

Updates an existing room profile by room profile ARN.

Specified by:

updateProfile in interface AmazonAlexaForBusiness

Parameters:

updateProfileRequest -

Returns:

Result of the UpdateProfile operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateRoom

@Deprecated
public UpdateRoomResult updateRoom(UpdateRoomRequest request)

Deprecated.

Updates room details by room ARN.

Specified by:

updateRoom in interface AmazonAlexaForBusiness

Parameters:

updateRoomRequest -

Returns:

Result of the UpdateRoom operation returned by the service.

Throws:

NotFoundException - The resource is not found.

NameInUseException - The name sent in the request is already in use.

See Also:

AWS API Documentation

updateSkillGroup

@Deprecated
public UpdateSkillGroupResult updateSkillGroup(UpdateSkillGroupRequest request)

Deprecated.

Updates skill group details by skill group ARN.

Specified by:

updateSkillGroup in interface AmazonAlexaForBusiness

Parameters:

updateSkillGroupRequest -

Returns:

Result of the UpdateSkillGroup operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getCachedResponseMetadata

public 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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AmazonAlexaForBusiness

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from interface: AmazonAlexaForBusiness

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonAlexaForBusiness

Overrides:

shutdown in class AmazonWebServiceClient