@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonAlexaForBusiness
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonAlexaForBusiness
instead.
Alexa for Business has been retired and is no longer supported.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
static final String ENDPOINT_PREFIX
@Deprecated ApproveSkillResult approveSkill(ApproveSkillRequest approveSkillRequest)
Associates a skill with the organization under the customer's AWS account. If a skill is private, the user implicitly accepts access to this skill during enablement.
approveSkillRequest
- LimitExceededException
- You are performing an action that would put you beyond your account's limits.NotFoundException
- The resource is not found.ConcurrentModificationException
- There is a concurrent modification of resources.@Deprecated AssociateContactWithAddressBookResult associateContactWithAddressBook(AssociateContactWithAddressBookRequest associateContactWithAddressBookRequest)
Associates a contact with a given address book.
associateContactWithAddressBookRequest
- LimitExceededException
- You are performing an action that would put you beyond your account's limits.@Deprecated AssociateDeviceWithNetworkProfileResult associateDeviceWithNetworkProfile(AssociateDeviceWithNetworkProfileRequest associateDeviceWithNetworkProfileRequest)
Associates a device with the specified network profile.
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 AssociateDeviceWithRoomResult associateDeviceWithRoom(AssociateDeviceWithRoomRequest associateDeviceWithRoomRequest)
Associates a device with a given room. This applies all the settings from the room profile to the device, and all the skills in any skill groups added to that room. This operation requires the device to be online, or else a manual sync is required.
associateDeviceWithRoomRequest
- LimitExceededException
- You are performing an action that would put you beyond your account's limits.ConcurrentModificationException
- 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 AssociateSkillGroupWithRoomResult associateSkillGroupWithRoom(AssociateSkillGroupWithRoomRequest associateSkillGroupWithRoomRequest)
Associates a skill group with a given room. This enables all skills in the associated skill group on all devices in the room.
associateSkillGroupWithRoomRequest
- ConcurrentModificationException
- There is a concurrent modification of resources.@Deprecated AssociateSkillWithSkillGroupResult associateSkillWithSkillGroup(AssociateSkillWithSkillGroupRequest associateSkillWithSkillGroupRequest)
Associates a skill with a skill group.
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 AssociateSkillWithUsersResult associateSkillWithUsers(AssociateSkillWithUsersRequest associateSkillWithUsersRequest)
Makes a private skill available for enrolled users to enable on their devices.
associateSkillWithUsersRequest
- ConcurrentModificationException
- There is a concurrent modification of resources.NotFoundException
- The resource is not found.@Deprecated CreateAddressBookResult createAddressBook(CreateAddressBookRequest createAddressBookRequest)
Creates an address book with the specified details.
createAddressBookRequest
- AlreadyExistsException
- The resource being created already exists.LimitExceededException
- You are performing an action that would put you beyond your account's limits.@Deprecated CreateBusinessReportScheduleResult createBusinessReportSchedule(CreateBusinessReportScheduleRequest createBusinessReportScheduleRequest)
Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or weekly interval.
createBusinessReportScheduleRequest
- AlreadyExistsException
- The resource being created already exists.@Deprecated CreateConferenceProviderResult createConferenceProvider(CreateConferenceProviderRequest createConferenceProviderRequest)
Adds a new conference provider under the user's AWS account.
createConferenceProviderRequest
- AlreadyExistsException
- The resource being created already exists.@Deprecated CreateContactResult createContact(CreateContactRequest createContactRequest)
Creates a contact with the specified details.
createContactRequest
- AlreadyExistsException
- The resource being created already exists.LimitExceededException
- You are performing an action that would put you beyond your account's limits.@Deprecated CreateGatewayGroupResult createGatewayGroup(CreateGatewayGroupRequest createGatewayGroupRequest)
Creates a gateway group with the specified details.
createGatewayGroupRequest
- AlreadyExistsException
- The resource being created already exists.LimitExceededException
- You are performing an action that would put you beyond your account's limits.@Deprecated CreateNetworkProfileResult createNetworkProfile(CreateNetworkProfileRequest createNetworkProfileRequest)
Creates a network profile with the specified details.
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 CreateProfileResult createProfile(CreateProfileRequest createProfileRequest)
Creates a new room profile with the specified details.
createProfileRequest
- LimitExceededException
- You are performing an action that would put you beyond your account's limits.AlreadyExistsException
- The resource being created already exists.ConcurrentModificationException
- There is a concurrent modification of resources.@Deprecated CreateRoomResult createRoom(CreateRoomRequest createRoomRequest)
Creates a room with the specified details.
createRoomRequest
- AlreadyExistsException
- The resource being created already exists.LimitExceededException
- You are performing an action that would put you beyond your account's limits.@Deprecated CreateSkillGroupResult createSkillGroup(CreateSkillGroupRequest createSkillGroupRequest)
Creates a skill group with a specified name and description.
createSkillGroupRequest
- AlreadyExistsException
- The resource being created already exists.LimitExceededException
- You are performing an action that would put you beyond your account's limits.ConcurrentModificationException
- There is a concurrent modification of resources.@Deprecated CreateUserResult createUser(CreateUserRequest createUserRequest)
Creates a user.
createUserRequest
- ResourceInUseException
- The resource in the request is already in use.LimitExceededException
- You are performing an action that would put you beyond your account's limits.ConcurrentModificationException
- There is a concurrent modification of resources.@Deprecated DeleteAddressBookResult deleteAddressBook(DeleteAddressBookRequest deleteAddressBookRequest)
Deletes an address book by the address book ARN.
deleteAddressBookRequest
- NotFoundException
- The resource is not found.ConcurrentModificationException
- There is a concurrent modification of resources.@Deprecated DeleteBusinessReportScheduleResult deleteBusinessReportSchedule(DeleteBusinessReportScheduleRequest deleteBusinessReportScheduleRequest)
Deletes the recurring report delivery schedule with the specified schedule ARN.
deleteBusinessReportScheduleRequest
- NotFoundException
- The resource is not found.ConcurrentModificationException
- There is a concurrent modification of resources.@Deprecated DeleteConferenceProviderResult deleteConferenceProvider(DeleteConferenceProviderRequest deleteConferenceProviderRequest)
Deletes a conference provider.
deleteConferenceProviderRequest
- NotFoundException
- The resource is not found.@Deprecated DeleteContactResult deleteContact(DeleteContactRequest deleteContactRequest)
Deletes a contact by the contact ARN.
deleteContactRequest
- NotFoundException
- The resource is not found.ConcurrentModificationException
- There is a concurrent modification of resources.@Deprecated DeleteDeviceResult deleteDevice(DeleteDeviceRequest deleteDeviceRequest)
Removes a device from Alexa For Business.
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 DeleteDeviceUsageDataResult deleteDeviceUsageData(DeleteDeviceUsageDataRequest deleteDeviceUsageDataRequest)
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.
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 DeleteGatewayGroupResult deleteGatewayGroup(DeleteGatewayGroupRequest deleteGatewayGroupRequest)
Deletes a gateway group.
deleteGatewayGroupRequest
- ResourceAssociatedException
- Another resource is associated with the resource in the request.@Deprecated DeleteNetworkProfileResult deleteNetworkProfile(DeleteNetworkProfileRequest deleteNetworkProfileRequest)
Deletes a network profile by the network profile ARN.
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 DeleteProfileResult deleteProfile(DeleteProfileRequest deleteProfileRequest)
Deletes a room profile by the profile ARN.
deleteProfileRequest
- NotFoundException
- The resource is not found.ConcurrentModificationException
- There is a concurrent modification of resources.@Deprecated DeleteRoomResult deleteRoom(DeleteRoomRequest deleteRoomRequest)
Deletes a room by the room ARN.
deleteRoomRequest
- NotFoundException
- The resource is not found.ConcurrentModificationException
- There is a concurrent modification of resources.@Deprecated DeleteRoomSkillParameterResult deleteRoomSkillParameter(DeleteRoomSkillParameterRequest deleteRoomSkillParameterRequest)
Deletes room skill parameter details by room, skill, and parameter key ID.
deleteRoomSkillParameterRequest
- ConcurrentModificationException
- There is a concurrent modification of resources.@Deprecated DeleteSkillAuthorizationResult deleteSkillAuthorization(DeleteSkillAuthorizationRequest deleteSkillAuthorizationRequest)
Unlinks a third-party account from a skill.
deleteSkillAuthorizationRequest
- NotFoundException
- The resource is not found.ConcurrentModificationException
- There is a concurrent modification of resources.@Deprecated DeleteSkillGroupResult deleteSkillGroup(DeleteSkillGroupRequest deleteSkillGroupRequest)
Deletes a skill group by skill group ARN.
deleteSkillGroupRequest
- NotFoundException
- The resource is not found.ConcurrentModificationException
- There is a concurrent modification of resources.@Deprecated DeleteUserResult deleteUser(DeleteUserRequest deleteUserRequest)
Deletes a specified user by user ARN and enrollment ARN.
deleteUserRequest
- NotFoundException
- The resource is not found.ConcurrentModificationException
- There is a concurrent modification of resources.@Deprecated DisassociateContactFromAddressBookResult disassociateContactFromAddressBook(DisassociateContactFromAddressBookRequest disassociateContactFromAddressBookRequest)
Disassociates a contact from a given address book.
disassociateContactFromAddressBookRequest
- @Deprecated DisassociateDeviceFromRoomResult disassociateDeviceFromRoom(DisassociateDeviceFromRoomRequest disassociateDeviceFromRoomRequest)
Disassociates a device from its current room. The device continues to be connected to the Wi-Fi network and is still registered to the account. The device settings and skills are removed from the room.
disassociateDeviceFromRoomRequest
- ConcurrentModificationException
- 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 DisassociateSkillFromSkillGroupResult disassociateSkillFromSkillGroup(DisassociateSkillFromSkillGroupRequest disassociateSkillFromSkillGroupRequest)
Disassociates a skill from a skill group.
disassociateSkillFromSkillGroupRequest
- ConcurrentModificationException
- There is a concurrent modification of resources.NotFoundException
- The resource is not found.@Deprecated DisassociateSkillFromUsersResult disassociateSkillFromUsers(DisassociateSkillFromUsersRequest disassociateSkillFromUsersRequest)
Makes a private skill unavailable for enrolled users and prevents them from enabling it on their devices.
disassociateSkillFromUsersRequest
- ConcurrentModificationException
- There is a concurrent modification of resources.NotFoundException
- The resource is not found.@Deprecated DisassociateSkillGroupFromRoomResult disassociateSkillGroupFromRoom(DisassociateSkillGroupFromRoomRequest disassociateSkillGroupFromRoomRequest)
Disassociates a skill group from a specified room. This disables all skills in the skill group on all devices in the room.
disassociateSkillGroupFromRoomRequest
- ConcurrentModificationException
- There is a concurrent modification of resources.@Deprecated ForgetSmartHomeAppliancesResult forgetSmartHomeAppliances(ForgetSmartHomeAppliancesRequest forgetSmartHomeAppliancesRequest)
Forgets smart home appliances associated to a room.
forgetSmartHomeAppliancesRequest
- NotFoundException
- The resource is not found.@Deprecated GetAddressBookResult getAddressBook(GetAddressBookRequest getAddressBookRequest)
Gets address the book details by the address book ARN.
getAddressBookRequest
- NotFoundException
- The resource is not found.@Deprecated GetConferencePreferenceResult getConferencePreference(GetConferencePreferenceRequest getConferencePreferenceRequest)
Retrieves the existing conference preferences.
getConferencePreferenceRequest
- NotFoundException
- The resource is not found.@Deprecated GetConferenceProviderResult getConferenceProvider(GetConferenceProviderRequest getConferenceProviderRequest)
Gets details about a specific conference provider.
getConferenceProviderRequest
- NotFoundException
- The resource is not found.@Deprecated GetContactResult getContact(GetContactRequest getContactRequest)
Gets the contact details by the contact ARN.
getContactRequest
- NotFoundException
- The resource is not found.@Deprecated GetDeviceResult getDevice(GetDeviceRequest getDeviceRequest)
Gets the details of a device by device ARN.
getDeviceRequest
- NotFoundException
- The resource is not found.@Deprecated GetGatewayResult getGateway(GetGatewayRequest getGatewayRequest)
Retrieves the details of a gateway.
getGatewayRequest
- NotFoundException
- The resource is not found.@Deprecated GetGatewayGroupResult getGatewayGroup(GetGatewayGroupRequest getGatewayGroupRequest)
Retrieves the details of a gateway group.
getGatewayGroupRequest
- NotFoundException
- The resource is not found.@Deprecated GetInvitationConfigurationResult getInvitationConfiguration(GetInvitationConfigurationRequest getInvitationConfigurationRequest)
Retrieves the configured values for the user enrollment invitation email template.
getInvitationConfigurationRequest
- NotFoundException
- The resource is not found.@Deprecated GetNetworkProfileResult getNetworkProfile(GetNetworkProfileRequest getNetworkProfileRequest)
Gets the network profile details by the network profile ARN.
getNetworkProfileRequest
- NotFoundException
- The resource is not found.InvalidSecretsManagerResourceException
- A password in SecretsManager is in an invalid state.@Deprecated GetProfileResult getProfile(GetProfileRequest getProfileRequest)
Gets the details of a room profile by profile ARN.
getProfileRequest
- NotFoundException
- The resource is not found.@Deprecated GetRoomResult getRoom(GetRoomRequest getRoomRequest)
Gets room details by room ARN.
getRoomRequest
- NotFoundException
- The resource is not found.@Deprecated GetRoomSkillParameterResult getRoomSkillParameter(GetRoomSkillParameterRequest getRoomSkillParameterRequest)
Gets room skill parameter details by room, skill, and parameter key ARN.
getRoomSkillParameterRequest
- NotFoundException
- The resource is not found.@Deprecated GetSkillGroupResult getSkillGroup(GetSkillGroupRequest getSkillGroupRequest)
Gets skill group details by skill group ARN.
getSkillGroupRequest
- NotFoundException
- The resource is not found.@Deprecated ListBusinessReportSchedulesResult listBusinessReportSchedules(ListBusinessReportSchedulesRequest listBusinessReportSchedulesRequest)
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.
listBusinessReportSchedulesRequest
- @Deprecated ListConferenceProvidersResult listConferenceProviders(ListConferenceProvidersRequest listConferenceProvidersRequest)
Lists conference providers under a specific AWS account.
listConferenceProvidersRequest
- @Deprecated ListDeviceEventsResult listDeviceEvents(ListDeviceEventsRequest listDeviceEventsRequest)
Lists the device event history, including device connection status, for up to 30 days.
listDeviceEventsRequest
- NotFoundException
- The resource is not found.@Deprecated ListGatewayGroupsResult listGatewayGroups(ListGatewayGroupsRequest listGatewayGroupsRequest)
Retrieves a list of gateway group summaries. Use GetGatewayGroup to retrieve details of a specific gateway group.
listGatewayGroupsRequest
- @Deprecated ListGatewaysResult listGateways(ListGatewaysRequest listGatewaysRequest)
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.
listGatewaysRequest
- @Deprecated ListSkillsResult listSkills(ListSkillsRequest listSkillsRequest)
Lists all enabled skills in a specific skill group.
listSkillsRequest
- @Deprecated ListSkillsStoreCategoriesResult listSkillsStoreCategories(ListSkillsStoreCategoriesRequest listSkillsStoreCategoriesRequest)
Lists all categories in the Alexa skill store.
listSkillsStoreCategoriesRequest
- @Deprecated ListSkillsStoreSkillsByCategoryResult listSkillsStoreSkillsByCategory(ListSkillsStoreSkillsByCategoryRequest listSkillsStoreSkillsByCategoryRequest)
Lists all skills in the Alexa skill store by category.
listSkillsStoreSkillsByCategoryRequest
- @Deprecated ListSmartHomeAppliancesResult listSmartHomeAppliances(ListSmartHomeAppliancesRequest listSmartHomeAppliancesRequest)
Lists all of the smart home appliances associated with a room.
listSmartHomeAppliancesRequest
- NotFoundException
- The resource is not found.@Deprecated ListTagsResult listTags(ListTagsRequest listTagsRequest)
Lists all tags for the specified resource.
listTagsRequest
- NotFoundException
- The resource is not found.@Deprecated PutConferencePreferenceResult putConferencePreference(PutConferencePreferenceRequest putConferencePreferenceRequest)
Sets the conference preferences on a specific conference provider at the account level.
putConferencePreferenceRequest
- NotFoundException
- The resource is not found.@Deprecated PutInvitationConfigurationResult putInvitationConfiguration(PutInvitationConfigurationRequest putInvitationConfigurationRequest)
Configures the email template for the user enrollment invitation with the specified attributes.
putInvitationConfigurationRequest
- NotFoundException
- The resource is not found.ConcurrentModificationException
- There is a concurrent modification of resources.@Deprecated PutRoomSkillParameterResult putRoomSkillParameter(PutRoomSkillParameterRequest putRoomSkillParameterRequest)
Updates room skill parameter details by room, skill, and parameter key ID. Not all skills have a room skill parameter.
putRoomSkillParameterRequest
- ConcurrentModificationException
- There is a concurrent modification of resources.@Deprecated PutSkillAuthorizationResult putSkillAuthorization(PutSkillAuthorizationRequest putSkillAuthorizationRequest)
Links a user's account to a third-party skill provider. If this API operation is called by an assumed IAM role, the skill being linked must be a private skill. Also, the skill must be owned by the AWS account that assumed the IAM role.
putSkillAuthorizationRequest
- UnauthorizedException
- The caller has no permissions to operate on the resource involved in the API call.ConcurrentModificationException
- There is a concurrent modification of resources.@Deprecated RegisterAVSDeviceResult registerAVSDevice(RegisterAVSDeviceRequest registerAVSDeviceRequest)
Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service (AVS).
registerAVSDeviceRequest
- LimitExceededException
- You are performing an action that would put you beyond your account's limits.ConcurrentModificationException
- There is a concurrent modification of resources.NotFoundException
- The resource is not found.InvalidDeviceException
- The device is in an invalid state.@Deprecated RejectSkillResult rejectSkill(RejectSkillRequest rejectSkillRequest)
Disassociates a skill from the organization under a user's AWS account. If the skill is a private skill, it moves to an AcceptStatus of PENDING. Any private or public skill that is rejected can be added later by calling the ApproveSkill API.
rejectSkillRequest
- ConcurrentModificationException
- There is a concurrent modification of resources.NotFoundException
- The resource is not found.@Deprecated ResolveRoomResult resolveRoom(ResolveRoomRequest resolveRoomRequest)
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.
resolveRoomRequest
- NotFoundException
- The resource is not found.@Deprecated RevokeInvitationResult revokeInvitation(RevokeInvitationRequest revokeInvitationRequest)
Revokes an invitation and invalidates the enrollment URL.
revokeInvitationRequest
- NotFoundException
- The resource is not found.ConcurrentModificationException
- There is a concurrent modification of resources.@Deprecated SearchAddressBooksResult searchAddressBooks(SearchAddressBooksRequest searchAddressBooksRequest)
Searches address books and lists the ones that meet a set of filter and sort criteria.
searchAddressBooksRequest
- @Deprecated SearchContactsResult searchContacts(SearchContactsRequest searchContactsRequest)
Searches contacts and lists the ones that meet a set of filter and sort criteria.
searchContactsRequest
- @Deprecated SearchDevicesResult searchDevices(SearchDevicesRequest searchDevicesRequest)
Searches devices and lists the ones that meet a set of filter criteria.
searchDevicesRequest
- @Deprecated SearchNetworkProfilesResult searchNetworkProfiles(SearchNetworkProfilesRequest searchNetworkProfilesRequest)
Searches network profiles and lists the ones that meet a set of filter and sort criteria.
searchNetworkProfilesRequest
- @Deprecated SearchProfilesResult searchProfiles(SearchProfilesRequest searchProfilesRequest)
Searches room profiles and lists the ones that meet a set of filter criteria.
searchProfilesRequest
- @Deprecated SearchRoomsResult searchRooms(SearchRoomsRequest searchRoomsRequest)
Searches rooms and lists the ones that meet a set of filter and sort criteria.
searchRoomsRequest
- @Deprecated SearchSkillGroupsResult searchSkillGroups(SearchSkillGroupsRequest searchSkillGroupsRequest)
Searches skill groups and lists the ones that meet a set of filter and sort criteria.
searchSkillGroupsRequest
- @Deprecated SearchUsersResult searchUsers(SearchUsersRequest searchUsersRequest)
Searches users and lists the ones that meet a set of filter and sort criteria.
searchUsersRequest
- SendAnnouncementResult sendAnnouncement(SendAnnouncementRequest sendAnnouncementRequest)
Triggers an asynchronous flow to send text, SSML, or audio announcements to rooms that are identified by a search or filter.
sendAnnouncementRequest
- LimitExceededException
- You are performing an action that would put you beyond your account's limits.AlreadyExistsException
- The resource being created already exists.@Deprecated SendInvitationResult sendInvitation(SendInvitationRequest sendInvitationRequest)
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.
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 StartDeviceSyncResult startDeviceSync(StartDeviceSyncRequest startDeviceSyncRequest)
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).
startDeviceSyncRequest
- DeviceNotRegisteredException
- The request failed because this device is no longer registered and therefore no longer managed by this
account.@Deprecated StartSmartHomeApplianceDiscoveryResult startSmartHomeApplianceDiscovery(StartSmartHomeApplianceDiscoveryRequest startSmartHomeApplianceDiscoveryRequest)
Initiates the discovery of any smart home appliances associated with the room.
startSmartHomeApplianceDiscoveryRequest
- NotFoundException
- The resource is not found.@Deprecated TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Adds metadata tags to a specified resource.
tagResourceRequest
- NotFoundException
- The resource is not found.@Deprecated UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes metadata tags from a specified resource.
untagResourceRequest
- NotFoundException
- The resource is not found.@Deprecated UpdateAddressBookResult updateAddressBook(UpdateAddressBookRequest updateAddressBookRequest)
Updates address book details by the address book ARN.
updateAddressBookRequest
- NotFoundException
- The resource is not found.NameInUseException
- The name sent in the request is already in use.ConcurrentModificationException
- There is a concurrent modification of resources.@Deprecated UpdateBusinessReportScheduleResult updateBusinessReportSchedule(UpdateBusinessReportScheduleRequest updateBusinessReportScheduleRequest)
Updates the configuration of the report delivery schedule with the specified schedule ARN.
updateBusinessReportScheduleRequest
- NotFoundException
- The resource is not found.ConcurrentModificationException
- There is a concurrent modification of resources.@Deprecated UpdateConferenceProviderResult updateConferenceProvider(UpdateConferenceProviderRequest updateConferenceProviderRequest)
Updates an existing conference provider's settings.
updateConferenceProviderRequest
- NotFoundException
- The resource is not found.@Deprecated UpdateContactResult updateContact(UpdateContactRequest updateContactRequest)
Updates the contact details by the contact ARN.
updateContactRequest
- NotFoundException
- The resource is not found.ConcurrentModificationException
- There is a concurrent modification of resources.@Deprecated UpdateDeviceResult updateDevice(UpdateDeviceRequest updateDeviceRequest)
Updates the device name by device ARN.
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 UpdateGatewayResult updateGateway(UpdateGatewayRequest updateGatewayRequest)
Updates the details of a gateway. If any optional field is not provided, the existing corresponding value is left unmodified.
updateGatewayRequest
- NotFoundException
- The resource is not found.NameInUseException
- The name sent in the request is already in use.@Deprecated UpdateGatewayGroupResult updateGatewayGroup(UpdateGatewayGroupRequest updateGatewayGroupRequest)
Updates the details of a gateway group. If any optional field is not provided, the existing corresponding value is left unmodified.
updateGatewayGroupRequest
- NotFoundException
- The resource is not found.NameInUseException
- The name sent in the request is already in use.@Deprecated UpdateNetworkProfileResult updateNetworkProfile(UpdateNetworkProfileRequest updateNetworkProfileRequest)
Updates a network profile by the network profile ARN.
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 UpdateProfileResult updateProfile(UpdateProfileRequest updateProfileRequest)
Updates an existing room profile by room profile ARN.
updateProfileRequest
- NotFoundException
- The resource is not found.NameInUseException
- The name sent in the request is already in use.ConcurrentModificationException
- There is a concurrent modification of resources.@Deprecated UpdateRoomResult updateRoom(UpdateRoomRequest updateRoomRequest)
Updates room details by room ARN.
updateRoomRequest
- NotFoundException
- The resource is not found.NameInUseException
- The name sent in the request is already in use.@Deprecated UpdateSkillGroupResult updateSkillGroup(UpdateSkillGroupRequest updateSkillGroupRequest)
Updates skill group details by skill group ARN.
updateSkillGroupRequest
- NotFoundException
- The resource is not found.NameInUseException
- The name sent in the request is already in use.ConcurrentModificationException
- There is a concurrent modification of resources.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request
- The originally executed request.