@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonAlexaForBusiness extends Object implements AmazonAlexaForBusiness
AmazonAlexaForBusiness
. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
ApproveSkillResult |
approveSkill(ApproveSkillRequest request)
Associates a skill with the organization under the customer's AWS account.
|
AssociateContactWithAddressBookResult |
associateContactWithAddressBook(AssociateContactWithAddressBookRequest request)
Associates a contact with a given address book.
|
AssociateDeviceWithNetworkProfileResult |
associateDeviceWithNetworkProfile(AssociateDeviceWithNetworkProfileRequest request)
Associates a device with the specified network profile.
|
AssociateDeviceWithRoomResult |
associateDeviceWithRoom(AssociateDeviceWithRoomRequest request)
Associates a device with a given room.
|
AssociateSkillGroupWithRoomResult |
associateSkillGroupWithRoom(AssociateSkillGroupWithRoomRequest request)
Associates a skill group with a given room.
|
AssociateSkillWithSkillGroupResult |
associateSkillWithSkillGroup(AssociateSkillWithSkillGroupRequest request)
Associates a skill with a skill group.
|
AssociateSkillWithUsersResult |
associateSkillWithUsers(AssociateSkillWithUsersRequest request)
Makes a private skill available for enrolled users to enable on their devices.
|
CreateAddressBookResult |
createAddressBook(CreateAddressBookRequest request)
Creates an address book with the specified details.
|
CreateBusinessReportScheduleResult |
createBusinessReportSchedule(CreateBusinessReportScheduleRequest request)
Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or
weekly interval.
|
CreateConferenceProviderResult |
createConferenceProvider(CreateConferenceProviderRequest request)
Adds a new conference provider under the user's AWS account.
|
CreateContactResult |
createContact(CreateContactRequest request)
Creates a contact with the specified details.
|
CreateGatewayGroupResult |
createGatewayGroup(CreateGatewayGroupRequest request)
Creates a gateway group with the specified details.
|
CreateNetworkProfileResult |
createNetworkProfile(CreateNetworkProfileRequest request)
Creates a network profile with the specified details.
|
CreateProfileResult |
createProfile(CreateProfileRequest request)
Creates a new room profile with the specified details.
|
CreateRoomResult |
createRoom(CreateRoomRequest request)
Creates a room with the specified details.
|
CreateSkillGroupResult |
createSkillGroup(CreateSkillGroupRequest request)
Creates a skill group with a specified name and description.
|
CreateUserResult |
createUser(CreateUserRequest request)
Creates a user.
|
DeleteAddressBookResult |
deleteAddressBook(DeleteAddressBookRequest request)
Deletes an address book by the address book ARN.
|
DeleteBusinessReportScheduleResult |
deleteBusinessReportSchedule(DeleteBusinessReportScheduleRequest request)
Deletes the recurring report delivery schedule with the specified schedule ARN.
|
DeleteConferenceProviderResult |
deleteConferenceProvider(DeleteConferenceProviderRequest request)
Deletes a conference provider.
|
DeleteContactResult |
deleteContact(DeleteContactRequest request)
Deletes a contact by the contact ARN.
|
DeleteDeviceResult |
deleteDevice(DeleteDeviceRequest request)
Removes a device from Alexa For Business.
|
DeleteDeviceUsageDataResult |
deleteDeviceUsageData(DeleteDeviceUsageDataRequest request)
When this action is called for a specified shared device, it allows authorized users to delete the device's
entire previous history of voice input data and associated response data.
|
DeleteGatewayGroupResult |
deleteGatewayGroup(DeleteGatewayGroupRequest request)
Deletes a gateway group.
|
DeleteNetworkProfileResult |
deleteNetworkProfile(DeleteNetworkProfileRequest request)
Deletes a network profile by the network profile ARN.
|
DeleteProfileResult |
deleteProfile(DeleteProfileRequest request)
Deletes a room profile by the profile ARN.
|
DeleteRoomResult |
deleteRoom(DeleteRoomRequest request)
Deletes a room by the room ARN.
|
DeleteRoomSkillParameterResult |
deleteRoomSkillParameter(DeleteRoomSkillParameterRequest request)
Deletes room skill parameter details by room, skill, and parameter key ID.
|
DeleteSkillAuthorizationResult |
deleteSkillAuthorization(DeleteSkillAuthorizationRequest request)
Unlinks a third-party account from a skill.
|
DeleteSkillGroupResult |
deleteSkillGroup(DeleteSkillGroupRequest request)
Deletes a skill group by skill group ARN.
|
DeleteUserResult |
deleteUser(DeleteUserRequest request)
Deletes a specified user by user ARN and enrollment ARN.
|
DisassociateContactFromAddressBookResult |
disassociateContactFromAddressBook(DisassociateContactFromAddressBookRequest request)
Disassociates a contact from a given address book.
|
DisassociateDeviceFromRoomResult |
disassociateDeviceFromRoom(DisassociateDeviceFromRoomRequest request)
Disassociates a device from its current room.
|
DisassociateSkillFromSkillGroupResult |
disassociateSkillFromSkillGroup(DisassociateSkillFromSkillGroupRequest request)
Disassociates a skill from a skill group.
|
DisassociateSkillFromUsersResult |
disassociateSkillFromUsers(DisassociateSkillFromUsersRequest request)
Makes a private skill unavailable for enrolled users and prevents them from enabling it on their devices.
|
DisassociateSkillGroupFromRoomResult |
disassociateSkillGroupFromRoom(DisassociateSkillGroupFromRoomRequest request)
Disassociates a skill group from a specified room.
|
ForgetSmartHomeAppliancesResult |
forgetSmartHomeAppliances(ForgetSmartHomeAppliancesRequest request)
Forgets smart home appliances associated to a room.
|
GetAddressBookResult |
getAddressBook(GetAddressBookRequest request)
Gets address the book details by the address book ARN.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetConferencePreferenceResult |
getConferencePreference(GetConferencePreferenceRequest request)
Retrieves the existing conference preferences.
|
GetConferenceProviderResult |
getConferenceProvider(GetConferenceProviderRequest request)
Gets details about a specific conference provider.
|
GetContactResult |
getContact(GetContactRequest request)
Gets the contact details by the contact ARN.
|
GetDeviceResult |
getDevice(GetDeviceRequest request)
Gets the details of a device by device ARN.
|
GetGatewayResult |
getGateway(GetGatewayRequest request)
Retrieves the details of a gateway.
|
GetGatewayGroupResult |
getGatewayGroup(GetGatewayGroupRequest request)
Retrieves the details of a gateway group.
|
GetInvitationConfigurationResult |
getInvitationConfiguration(GetInvitationConfigurationRequest request)
Retrieves the configured values for the user enrollment invitation email template.
|
GetNetworkProfileResult |
getNetworkProfile(GetNetworkProfileRequest request)
Gets the network profile details by the network profile ARN.
|
GetProfileResult |
getProfile(GetProfileRequest request)
Gets the details of a room profile by profile ARN.
|
GetRoomResult |
getRoom(GetRoomRequest request)
Gets room details by room ARN.
|
GetRoomSkillParameterResult |
getRoomSkillParameter(GetRoomSkillParameterRequest request)
Gets room skill parameter details by room, skill, and parameter key ARN.
|
GetSkillGroupResult |
getSkillGroup(GetSkillGroupRequest request)
Gets skill group details by skill group ARN.
|
ListBusinessReportSchedulesResult |
listBusinessReportSchedules(ListBusinessReportSchedulesRequest request)
Lists the details of the schedules that a user configured.
|
ListConferenceProvidersResult |
listConferenceProviders(ListConferenceProvidersRequest request)
Lists conference providers under a specific AWS account.
|
ListDeviceEventsResult |
listDeviceEvents(ListDeviceEventsRequest request)
Lists the device event history, including device connection status, for up to 30 days.
|
ListGatewayGroupsResult |
listGatewayGroups(ListGatewayGroupsRequest request)
Retrieves a list of gateway group summaries.
|
ListGatewaysResult |
listGateways(ListGatewaysRequest request)
Retrieves a list of gateway summaries.
|
ListSkillsResult |
listSkills(ListSkillsRequest request)
Lists all enabled skills in a specific skill group.
|
ListSkillsStoreCategoriesResult |
listSkillsStoreCategories(ListSkillsStoreCategoriesRequest request)
Lists all categories in the Alexa skill store.
|
ListSkillsStoreSkillsByCategoryResult |
listSkillsStoreSkillsByCategory(ListSkillsStoreSkillsByCategoryRequest request)
Lists all skills in the Alexa skill store by category.
|
ListSmartHomeAppliancesResult |
listSmartHomeAppliances(ListSmartHomeAppliancesRequest request)
Lists all of the smart home appliances associated with a room.
|
ListTagsResult |
listTags(ListTagsRequest request)
Lists all tags for the specified resource.
|
PutConferencePreferenceResult |
putConferencePreference(PutConferencePreferenceRequest request)
Sets the conference preferences on a specific conference provider at the account level.
|
PutInvitationConfigurationResult |
putInvitationConfiguration(PutInvitationConfigurationRequest request)
Configures the email template for the user enrollment invitation with the specified attributes.
|
PutRoomSkillParameterResult |
putRoomSkillParameter(PutRoomSkillParameterRequest request)
Updates room skill parameter details by room, skill, and parameter key ID.
|
PutSkillAuthorizationResult |
putSkillAuthorization(PutSkillAuthorizationRequest request)
Links a user's account to a third-party skill provider.
|
RegisterAVSDeviceResult |
registerAVSDevice(RegisterAVSDeviceRequest request)
Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service
(AVS).
|
RejectSkillResult |
rejectSkill(RejectSkillRequest request)
Disassociates a skill from the organization under a user's AWS account.
|
ResolveRoomResult |
resolveRoom(ResolveRoomRequest request)
Determines the details for the room from which a skill request was invoked.
|
RevokeInvitationResult |
revokeInvitation(RevokeInvitationRequest request)
Revokes an invitation and invalidates the enrollment URL.
|
SearchAddressBooksResult |
searchAddressBooks(SearchAddressBooksRequest request)
Searches address books and lists the ones that meet a set of filter and sort criteria.
|
SearchContactsResult |
searchContacts(SearchContactsRequest request)
Searches contacts and lists the ones that meet a set of filter and sort criteria.
|
SearchDevicesResult |
searchDevices(SearchDevicesRequest request)
Searches devices and lists the ones that meet a set of filter criteria.
|
SearchNetworkProfilesResult |
searchNetworkProfiles(SearchNetworkProfilesRequest request)
Searches network profiles and lists the ones that meet a set of filter and sort criteria.
|
SearchProfilesResult |
searchProfiles(SearchProfilesRequest request)
Searches room profiles and lists the ones that meet a set of filter criteria.
|
SearchRoomsResult |
searchRooms(SearchRoomsRequest request)
Searches rooms and lists the ones that meet a set of filter and sort criteria.
|
SearchSkillGroupsResult |
searchSkillGroups(SearchSkillGroupsRequest request)
Searches skill groups and lists the ones that meet a set of filter and sort criteria.
|
SearchUsersResult |
searchUsers(SearchUsersRequest request)
Searches users and lists the ones that meet a set of filter and sort criteria.
|
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)
Sends an enrollment invitation email with a URL to a user.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartDeviceSyncResult |
startDeviceSync(StartDeviceSyncRequest request)
Resets a device and its account to the known default settings.
|
StartSmartHomeApplianceDiscoveryResult |
startSmartHomeApplianceDiscovery(StartSmartHomeApplianceDiscoveryRequest request)
Initiates the discovery of any smart home appliances associated with the room.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Adds metadata tags to a specified resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes metadata tags from a specified resource.
|
UpdateAddressBookResult |
updateAddressBook(UpdateAddressBookRequest request)
Updates address book details by the address book ARN.
|
UpdateBusinessReportScheduleResult |
updateBusinessReportSchedule(UpdateBusinessReportScheduleRequest request)
Updates the configuration of the report delivery schedule with the specified schedule ARN.
|
UpdateConferenceProviderResult |
updateConferenceProvider(UpdateConferenceProviderRequest request)
Updates an existing conference provider's settings.
|
UpdateContactResult |
updateContact(UpdateContactRequest request)
Updates the contact details by the contact ARN.
|
UpdateDeviceResult |
updateDevice(UpdateDeviceRequest request)
Updates the device name by device ARN.
|
UpdateGatewayResult |
updateGateway(UpdateGatewayRequest request)
Updates the details of a gateway.
|
UpdateGatewayGroupResult |
updateGatewayGroup(UpdateGatewayGroupRequest request)
Updates the details of a gateway group.
|
UpdateNetworkProfileResult |
updateNetworkProfile(UpdateNetworkProfileRequest request)
Updates a network profile by the network profile ARN.
|
UpdateProfileResult |
updateProfile(UpdateProfileRequest request)
Updates an existing room profile by room profile ARN.
|
UpdateRoomResult |
updateRoom(UpdateRoomRequest request)
Updates room details by room ARN.
|
UpdateSkillGroupResult |
updateSkillGroup(UpdateSkillGroupRequest request)
Updates skill group details by skill group ARN.
|
public ApproveSkillResult approveSkill(ApproveSkillRequest request)
AmazonAlexaForBusiness
Associates a skill with the organization under the customer's AWS account. If a skill is private, the user implicitly accepts access to this skill during enablement.
approveSkill
in interface AmazonAlexaForBusiness
public AssociateContactWithAddressBookResult associateContactWithAddressBook(AssociateContactWithAddressBookRequest request)
AmazonAlexaForBusiness
Associates a contact with a given address book.
associateContactWithAddressBook
in interface AmazonAlexaForBusiness
public AssociateDeviceWithNetworkProfileResult associateDeviceWithNetworkProfile(AssociateDeviceWithNetworkProfileRequest request)
AmazonAlexaForBusiness
Associates a device with the specified network profile.
associateDeviceWithNetworkProfile
in interface AmazonAlexaForBusiness
public AssociateDeviceWithRoomResult associateDeviceWithRoom(AssociateDeviceWithRoomRequest request)
AmazonAlexaForBusiness
Associates a device with a given room. This applies all the settings from the room profile to the device, and all the skills in any skill groups added to that room. This operation requires the device to be online, or else a manual sync is required.
associateDeviceWithRoom
in interface AmazonAlexaForBusiness
public AssociateSkillGroupWithRoomResult associateSkillGroupWithRoom(AssociateSkillGroupWithRoomRequest request)
AmazonAlexaForBusiness
Associates a skill group with a given room. This enables all skills in the associated skill group on all devices in the room.
associateSkillGroupWithRoom
in interface AmazonAlexaForBusiness
public AssociateSkillWithSkillGroupResult associateSkillWithSkillGroup(AssociateSkillWithSkillGroupRequest request)
AmazonAlexaForBusiness
Associates a skill with a skill group.
associateSkillWithSkillGroup
in interface AmazonAlexaForBusiness
public AssociateSkillWithUsersResult associateSkillWithUsers(AssociateSkillWithUsersRequest request)
AmazonAlexaForBusiness
Makes a private skill available for enrolled users to enable on their devices.
associateSkillWithUsers
in interface AmazonAlexaForBusiness
public CreateAddressBookResult createAddressBook(CreateAddressBookRequest request)
AmazonAlexaForBusiness
Creates an address book with the specified details.
createAddressBook
in interface AmazonAlexaForBusiness
public CreateBusinessReportScheduleResult createBusinessReportSchedule(CreateBusinessReportScheduleRequest request)
AmazonAlexaForBusiness
Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or weekly interval.
createBusinessReportSchedule
in interface AmazonAlexaForBusiness
public CreateConferenceProviderResult createConferenceProvider(CreateConferenceProviderRequest request)
AmazonAlexaForBusiness
Adds a new conference provider under the user's AWS account.
createConferenceProvider
in interface AmazonAlexaForBusiness
public CreateContactResult createContact(CreateContactRequest request)
AmazonAlexaForBusiness
Creates a contact with the specified details.
createContact
in interface AmazonAlexaForBusiness
public CreateGatewayGroupResult createGatewayGroup(CreateGatewayGroupRequest request)
AmazonAlexaForBusiness
Creates a gateway group with the specified details.
createGatewayGroup
in interface AmazonAlexaForBusiness
public CreateNetworkProfileResult createNetworkProfile(CreateNetworkProfileRequest request)
AmazonAlexaForBusiness
Creates a network profile with the specified details.
createNetworkProfile
in interface AmazonAlexaForBusiness
public CreateProfileResult createProfile(CreateProfileRequest request)
AmazonAlexaForBusiness
Creates a new room profile with the specified details.
createProfile
in interface AmazonAlexaForBusiness
public CreateRoomResult createRoom(CreateRoomRequest request)
AmazonAlexaForBusiness
Creates a room with the specified details.
createRoom
in interface AmazonAlexaForBusiness
public CreateSkillGroupResult createSkillGroup(CreateSkillGroupRequest request)
AmazonAlexaForBusiness
Creates a skill group with a specified name and description.
createSkillGroup
in interface AmazonAlexaForBusiness
public CreateUserResult createUser(CreateUserRequest request)
AmazonAlexaForBusiness
Creates a user.
createUser
in interface AmazonAlexaForBusiness
public DeleteAddressBookResult deleteAddressBook(DeleteAddressBookRequest request)
AmazonAlexaForBusiness
Deletes an address book by the address book ARN.
deleteAddressBook
in interface AmazonAlexaForBusiness
public DeleteBusinessReportScheduleResult deleteBusinessReportSchedule(DeleteBusinessReportScheduleRequest request)
AmazonAlexaForBusiness
Deletes the recurring report delivery schedule with the specified schedule ARN.
deleteBusinessReportSchedule
in interface AmazonAlexaForBusiness
public DeleteConferenceProviderResult deleteConferenceProvider(DeleteConferenceProviderRequest request)
AmazonAlexaForBusiness
Deletes a conference provider.
deleteConferenceProvider
in interface AmazonAlexaForBusiness
public DeleteContactResult deleteContact(DeleteContactRequest request)
AmazonAlexaForBusiness
Deletes a contact by the contact ARN.
deleteContact
in interface AmazonAlexaForBusiness
public DeleteDeviceResult deleteDevice(DeleteDeviceRequest request)
AmazonAlexaForBusiness
Removes a device from Alexa For Business.
deleteDevice
in interface AmazonAlexaForBusiness
public DeleteDeviceUsageDataResult deleteDeviceUsageData(DeleteDeviceUsageDataRequest request)
AmazonAlexaForBusiness
When this action is called for a specified shared device, it allows authorized users to delete the device's entire previous history of voice input data and associated response data. This action can be called once every 24 hours for a specific shared device.
deleteDeviceUsageData
in interface AmazonAlexaForBusiness
public DeleteGatewayGroupResult deleteGatewayGroup(DeleteGatewayGroupRequest request)
AmazonAlexaForBusiness
Deletes a gateway group.
deleteGatewayGroup
in interface AmazonAlexaForBusiness
public DeleteNetworkProfileResult deleteNetworkProfile(DeleteNetworkProfileRequest request)
AmazonAlexaForBusiness
Deletes a network profile by the network profile ARN.
deleteNetworkProfile
in interface AmazonAlexaForBusiness
public DeleteProfileResult deleteProfile(DeleteProfileRequest request)
AmazonAlexaForBusiness
Deletes a room profile by the profile ARN.
deleteProfile
in interface AmazonAlexaForBusiness
public DeleteRoomResult deleteRoom(DeleteRoomRequest request)
AmazonAlexaForBusiness
Deletes a room by the room ARN.
deleteRoom
in interface AmazonAlexaForBusiness
public DeleteRoomSkillParameterResult deleteRoomSkillParameter(DeleteRoomSkillParameterRequest request)
AmazonAlexaForBusiness
Deletes room skill parameter details by room, skill, and parameter key ID.
deleteRoomSkillParameter
in interface AmazonAlexaForBusiness
public DeleteSkillAuthorizationResult deleteSkillAuthorization(DeleteSkillAuthorizationRequest request)
AmazonAlexaForBusiness
Unlinks a third-party account from a skill.
deleteSkillAuthorization
in interface AmazonAlexaForBusiness
public DeleteSkillGroupResult deleteSkillGroup(DeleteSkillGroupRequest request)
AmazonAlexaForBusiness
Deletes a skill group by skill group ARN.
deleteSkillGroup
in interface AmazonAlexaForBusiness
public DeleteUserResult deleteUser(DeleteUserRequest request)
AmazonAlexaForBusiness
Deletes a specified user by user ARN and enrollment ARN.
deleteUser
in interface AmazonAlexaForBusiness
public DisassociateContactFromAddressBookResult disassociateContactFromAddressBook(DisassociateContactFromAddressBookRequest request)
AmazonAlexaForBusiness
Disassociates a contact from a given address book.
disassociateContactFromAddressBook
in interface AmazonAlexaForBusiness
public DisassociateDeviceFromRoomResult disassociateDeviceFromRoom(DisassociateDeviceFromRoomRequest request)
AmazonAlexaForBusiness
Disassociates a device from its current room. The device continues to be connected to the Wi-Fi network and is still registered to the account. The device settings and skills are removed from the room.
disassociateDeviceFromRoom
in interface AmazonAlexaForBusiness
public DisassociateSkillFromSkillGroupResult disassociateSkillFromSkillGroup(DisassociateSkillFromSkillGroupRequest request)
AmazonAlexaForBusiness
Disassociates a skill from a skill group.
disassociateSkillFromSkillGroup
in interface AmazonAlexaForBusiness
public DisassociateSkillFromUsersResult disassociateSkillFromUsers(DisassociateSkillFromUsersRequest request)
AmazonAlexaForBusiness
Makes a private skill unavailable for enrolled users and prevents them from enabling it on their devices.
disassociateSkillFromUsers
in interface AmazonAlexaForBusiness
public DisassociateSkillGroupFromRoomResult disassociateSkillGroupFromRoom(DisassociateSkillGroupFromRoomRequest request)
AmazonAlexaForBusiness
Disassociates a skill group from a specified room. This disables all skills in the skill group on all devices in the room.
disassociateSkillGroupFromRoom
in interface AmazonAlexaForBusiness
public ForgetSmartHomeAppliancesResult forgetSmartHomeAppliances(ForgetSmartHomeAppliancesRequest request)
AmazonAlexaForBusiness
Forgets smart home appliances associated to a room.
forgetSmartHomeAppliances
in interface AmazonAlexaForBusiness
public GetAddressBookResult getAddressBook(GetAddressBookRequest request)
AmazonAlexaForBusiness
Gets address the book details by the address book ARN.
getAddressBook
in interface AmazonAlexaForBusiness
public GetConferencePreferenceResult getConferencePreference(GetConferencePreferenceRequest request)
AmazonAlexaForBusiness
Retrieves the existing conference preferences.
getConferencePreference
in interface AmazonAlexaForBusiness
public GetConferenceProviderResult getConferenceProvider(GetConferenceProviderRequest request)
AmazonAlexaForBusiness
Gets details about a specific conference provider.
getConferenceProvider
in interface AmazonAlexaForBusiness
public GetContactResult getContact(GetContactRequest request)
AmazonAlexaForBusiness
Gets the contact details by the contact ARN.
getContact
in interface AmazonAlexaForBusiness
public GetDeviceResult getDevice(GetDeviceRequest request)
AmazonAlexaForBusiness
Gets the details of a device by device ARN.
getDevice
in interface AmazonAlexaForBusiness
public GetGatewayResult getGateway(GetGatewayRequest request)
AmazonAlexaForBusiness
Retrieves the details of a gateway.
getGateway
in interface AmazonAlexaForBusiness
public GetGatewayGroupResult getGatewayGroup(GetGatewayGroupRequest request)
AmazonAlexaForBusiness
Retrieves the details of a gateway group.
getGatewayGroup
in interface AmazonAlexaForBusiness
public GetInvitationConfigurationResult getInvitationConfiguration(GetInvitationConfigurationRequest request)
AmazonAlexaForBusiness
Retrieves the configured values for the user enrollment invitation email template.
getInvitationConfiguration
in interface AmazonAlexaForBusiness
public GetNetworkProfileResult getNetworkProfile(GetNetworkProfileRequest request)
AmazonAlexaForBusiness
Gets the network profile details by the network profile ARN.
getNetworkProfile
in interface AmazonAlexaForBusiness
public GetProfileResult getProfile(GetProfileRequest request)
AmazonAlexaForBusiness
Gets the details of a room profile by profile ARN.
getProfile
in interface AmazonAlexaForBusiness
public GetRoomResult getRoom(GetRoomRequest request)
AmazonAlexaForBusiness
Gets room details by room ARN.
getRoom
in interface AmazonAlexaForBusiness
public GetRoomSkillParameterResult getRoomSkillParameter(GetRoomSkillParameterRequest request)
AmazonAlexaForBusiness
Gets room skill parameter details by room, skill, and parameter key ARN.
getRoomSkillParameter
in interface AmazonAlexaForBusiness
public GetSkillGroupResult getSkillGroup(GetSkillGroupRequest request)
AmazonAlexaForBusiness
Gets skill group details by skill group ARN.
getSkillGroup
in interface AmazonAlexaForBusiness
public ListBusinessReportSchedulesResult listBusinessReportSchedules(ListBusinessReportSchedulesRequest request)
AmazonAlexaForBusiness
Lists the details of the schedules that a user configured. A download URL of the report associated with each schedule is returned every time this action is called. A new download URL is returned each time, and is valid for 24 hours.
listBusinessReportSchedules
in interface AmazonAlexaForBusiness
public ListConferenceProvidersResult listConferenceProviders(ListConferenceProvidersRequest request)
AmazonAlexaForBusiness
Lists conference providers under a specific AWS account.
listConferenceProviders
in interface AmazonAlexaForBusiness
public ListDeviceEventsResult listDeviceEvents(ListDeviceEventsRequest request)
AmazonAlexaForBusiness
Lists the device event history, including device connection status, for up to 30 days.
listDeviceEvents
in interface AmazonAlexaForBusiness
public ListGatewayGroupsResult listGatewayGroups(ListGatewayGroupsRequest request)
AmazonAlexaForBusiness
Retrieves a list of gateway group summaries. Use GetGatewayGroup to retrieve details of a specific gateway group.
listGatewayGroups
in interface AmazonAlexaForBusiness
public ListGatewaysResult listGateways(ListGatewaysRequest request)
AmazonAlexaForBusiness
Retrieves a list of gateway summaries. Use GetGateway to retrieve details of a specific gateway. An optional gateway group ARN can be provided to only retrieve gateway summaries of gateways that are associated with that gateway group ARN.
listGateways
in interface AmazonAlexaForBusiness
public ListSkillsResult listSkills(ListSkillsRequest request)
AmazonAlexaForBusiness
Lists all enabled skills in a specific skill group.
listSkills
in interface AmazonAlexaForBusiness
public ListSkillsStoreCategoriesResult listSkillsStoreCategories(ListSkillsStoreCategoriesRequest request)
AmazonAlexaForBusiness
Lists all categories in the Alexa skill store.
listSkillsStoreCategories
in interface AmazonAlexaForBusiness
public ListSkillsStoreSkillsByCategoryResult listSkillsStoreSkillsByCategory(ListSkillsStoreSkillsByCategoryRequest request)
AmazonAlexaForBusiness
Lists all skills in the Alexa skill store by category.
listSkillsStoreSkillsByCategory
in interface AmazonAlexaForBusiness
public ListSmartHomeAppliancesResult listSmartHomeAppliances(ListSmartHomeAppliancesRequest request)
AmazonAlexaForBusiness
Lists all of the smart home appliances associated with a room.
listSmartHomeAppliances
in interface AmazonAlexaForBusiness
public ListTagsResult listTags(ListTagsRequest request)
AmazonAlexaForBusiness
Lists all tags for the specified resource.
listTags
in interface AmazonAlexaForBusiness
public PutConferencePreferenceResult putConferencePreference(PutConferencePreferenceRequest request)
AmazonAlexaForBusiness
Sets the conference preferences on a specific conference provider at the account level.
putConferencePreference
in interface AmazonAlexaForBusiness
public PutInvitationConfigurationResult putInvitationConfiguration(PutInvitationConfigurationRequest request)
AmazonAlexaForBusiness
Configures the email template for the user enrollment invitation with the specified attributes.
putInvitationConfiguration
in interface AmazonAlexaForBusiness
public PutRoomSkillParameterResult putRoomSkillParameter(PutRoomSkillParameterRequest request)
AmazonAlexaForBusiness
Updates room skill parameter details by room, skill, and parameter key ID. Not all skills have a room skill parameter.
putRoomSkillParameter
in interface AmazonAlexaForBusiness
public PutSkillAuthorizationResult putSkillAuthorization(PutSkillAuthorizationRequest request)
AmazonAlexaForBusiness
Links a user's account to a third-party skill provider. If this API operation is called by an assumed IAM role, the skill being linked must be a private skill. Also, the skill must be owned by the AWS account that assumed the IAM role.
putSkillAuthorization
in interface AmazonAlexaForBusiness
public RegisterAVSDeviceResult registerAVSDevice(RegisterAVSDeviceRequest request)
AmazonAlexaForBusiness
Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service (AVS).
registerAVSDevice
in interface AmazonAlexaForBusiness
public RejectSkillResult rejectSkill(RejectSkillRequest request)
AmazonAlexaForBusiness
Disassociates a skill from the organization under a user's AWS account. If the skill is a private skill, it moves to an AcceptStatus of PENDING. Any private or public skill that is rejected can be added later by calling the ApproveSkill API.
rejectSkill
in interface AmazonAlexaForBusiness
public ResolveRoomResult resolveRoom(ResolveRoomRequest request)
AmazonAlexaForBusiness
Determines the details for the room from which a skill request was invoked. This operation is used by skill developers.
To query ResolveRoom from an Alexa skill, the skill ID needs to be authorized. When the skill is using an AWS Lambda function, the skill is automatically authorized when you publish your skill as a private skill to your AWS account. Skills that are hosted using a custom web service must be manually authorized. To get your skill authorized, contact AWS Support with your AWS account ID that queries the ResolveRoom API and skill ID.
resolveRoom
in interface AmazonAlexaForBusiness
public RevokeInvitationResult revokeInvitation(RevokeInvitationRequest request)
AmazonAlexaForBusiness
Revokes an invitation and invalidates the enrollment URL.
revokeInvitation
in interface AmazonAlexaForBusiness
public SearchAddressBooksResult searchAddressBooks(SearchAddressBooksRequest request)
AmazonAlexaForBusiness
Searches address books and lists the ones that meet a set of filter and sort criteria.
searchAddressBooks
in interface AmazonAlexaForBusiness
public SearchContactsResult searchContacts(SearchContactsRequest request)
AmazonAlexaForBusiness
Searches contacts and lists the ones that meet a set of filter and sort criteria.
searchContacts
in interface AmazonAlexaForBusiness
public SearchDevicesResult searchDevices(SearchDevicesRequest request)
AmazonAlexaForBusiness
Searches devices and lists the ones that meet a set of filter criteria.
searchDevices
in interface AmazonAlexaForBusiness
public SearchNetworkProfilesResult searchNetworkProfiles(SearchNetworkProfilesRequest request)
AmazonAlexaForBusiness
Searches network profiles and lists the ones that meet a set of filter and sort criteria.
searchNetworkProfiles
in interface AmazonAlexaForBusiness
public SearchProfilesResult searchProfiles(SearchProfilesRequest request)
AmazonAlexaForBusiness
Searches room profiles and lists the ones that meet a set of filter criteria.
searchProfiles
in interface AmazonAlexaForBusiness
public SearchRoomsResult searchRooms(SearchRoomsRequest request)
AmazonAlexaForBusiness
Searches rooms and lists the ones that meet a set of filter and sort criteria.
searchRooms
in interface AmazonAlexaForBusiness
public SearchSkillGroupsResult searchSkillGroups(SearchSkillGroupsRequest request)
AmazonAlexaForBusiness
Searches skill groups and lists the ones that meet a set of filter and sort criteria.
searchSkillGroups
in interface AmazonAlexaForBusiness
public SearchUsersResult searchUsers(SearchUsersRequest request)
AmazonAlexaForBusiness
Searches users and lists the ones that meet a set of filter and sort criteria.
searchUsers
in interface AmazonAlexaForBusiness
public SendAnnouncementResult sendAnnouncement(SendAnnouncementRequest request)
AmazonAlexaForBusiness
Triggers an asynchronous flow to send text, SSML, or audio announcements to rooms that are identified by a search or filter.
sendAnnouncement
in interface AmazonAlexaForBusiness
public SendInvitationResult sendInvitation(SendInvitationRequest request)
AmazonAlexaForBusiness
Sends an enrollment invitation email with a URL to a user. The URL is valid for 30 days or until you call this operation again, whichever comes first.
sendInvitation
in interface AmazonAlexaForBusiness
public StartDeviceSyncResult startDeviceSync(StartDeviceSyncRequest request)
AmazonAlexaForBusiness
Resets a device and its account to the known default settings. This clears all information and settings set by previous users in the following ways:
Bluetooth - This unpairs all bluetooth devices paired with your echo device.
Volume - This resets the echo device's volume to the default value.
Notifications - This clears all notifications from your echo device.
Lists - This clears all to-do items from your echo device.
Settings - This internally syncs the room's profile (if the device is assigned to a room), contacts, address books, delegation access for account linking, and communications (if enabled on the room profile).
startDeviceSync
in interface AmazonAlexaForBusiness
public StartSmartHomeApplianceDiscoveryResult startSmartHomeApplianceDiscovery(StartSmartHomeApplianceDiscoveryRequest request)
AmazonAlexaForBusiness
Initiates the discovery of any smart home appliances associated with the room.
startSmartHomeApplianceDiscovery
in interface AmazonAlexaForBusiness
public TagResourceResult tagResource(TagResourceRequest request)
AmazonAlexaForBusiness
Adds metadata tags to a specified resource.
tagResource
in interface AmazonAlexaForBusiness
public UntagResourceResult untagResource(UntagResourceRequest request)
AmazonAlexaForBusiness
Removes metadata tags from a specified resource.
untagResource
in interface AmazonAlexaForBusiness
public UpdateAddressBookResult updateAddressBook(UpdateAddressBookRequest request)
AmazonAlexaForBusiness
Updates address book details by the address book ARN.
updateAddressBook
in interface AmazonAlexaForBusiness
public UpdateBusinessReportScheduleResult updateBusinessReportSchedule(UpdateBusinessReportScheduleRequest request)
AmazonAlexaForBusiness
Updates the configuration of the report delivery schedule with the specified schedule ARN.
updateBusinessReportSchedule
in interface AmazonAlexaForBusiness
public UpdateConferenceProviderResult updateConferenceProvider(UpdateConferenceProviderRequest request)
AmazonAlexaForBusiness
Updates an existing conference provider's settings.
updateConferenceProvider
in interface AmazonAlexaForBusiness
public UpdateContactResult updateContact(UpdateContactRequest request)
AmazonAlexaForBusiness
Updates the contact details by the contact ARN.
updateContact
in interface AmazonAlexaForBusiness
public UpdateDeviceResult updateDevice(UpdateDeviceRequest request)
AmazonAlexaForBusiness
Updates the device name by device ARN.
updateDevice
in interface AmazonAlexaForBusiness
public UpdateGatewayResult updateGateway(UpdateGatewayRequest request)
AmazonAlexaForBusiness
Updates the details of a gateway. If any optional field is not provided, the existing corresponding value is left unmodified.
updateGateway
in interface AmazonAlexaForBusiness
public UpdateGatewayGroupResult updateGatewayGroup(UpdateGatewayGroupRequest request)
AmazonAlexaForBusiness
Updates the details of a gateway group. If any optional field is not provided, the existing corresponding value is left unmodified.
updateGatewayGroup
in interface AmazonAlexaForBusiness
public UpdateNetworkProfileResult updateNetworkProfile(UpdateNetworkProfileRequest request)
AmazonAlexaForBusiness
Updates a network profile by the network profile ARN.
updateNetworkProfile
in interface AmazonAlexaForBusiness
public UpdateProfileResult updateProfile(UpdateProfileRequest request)
AmazonAlexaForBusiness
Updates an existing room profile by room profile ARN.
updateProfile
in interface AmazonAlexaForBusiness
public UpdateRoomResult updateRoom(UpdateRoomRequest request)
AmazonAlexaForBusiness
Updates room details by room ARN.
updateRoom
in interface AmazonAlexaForBusiness
public UpdateSkillGroupResult updateSkillGroup(UpdateSkillGroupRequest request)
AmazonAlexaForBusiness
Updates skill group details by skill group ARN.
updateSkillGroup
in interface AmazonAlexaForBusiness
public void shutdown()
AmazonAlexaForBusiness
shutdown
in interface AmazonAlexaForBusiness
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonAlexaForBusiness
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.
getCachedResponseMetadata
in interface AmazonAlexaForBusiness
request
- The originally executed request.