@Generated(value="software.amazon.awssdk:codegen") public interface AlexaForBusinessClient extends SdkClient
builder()
method.
Alexa for Business helps you use Alexa in your organization. Alexa for Business provides you with the tools to manage Alexa devices, enroll your users, and assign skills, at scale. You can build your own context-aware voice skills using the Alexa Skills Kit and the Alexa for Business API operations. You can also make these available as private skills for your organization. Alexa for Business makes it efficient to voice-enable your products and services, thus providing context-aware voice experiences for your customers. Device makers building with the Alexa Voice Service (AVS) can create fully integrated solutions, register their products with Alexa for Business, and manage them as shared devices in their organization.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
default ApproveSkillResponse |
approveSkill(ApproveSkillRequest approveSkillRequest)
Associates a skill with the organization under the customer's AWS account.
|
default ApproveSkillResponse |
approveSkill(Consumer<ApproveSkillRequest.Builder> approveSkillRequest)
Associates a skill with the organization under the customer's AWS account.
|
default AssociateContactWithAddressBookResponse |
associateContactWithAddressBook(AssociateContactWithAddressBookRequest associateContactWithAddressBookRequest)
Associates a contact with a given address book.
|
default AssociateContactWithAddressBookResponse |
associateContactWithAddressBook(Consumer<AssociateContactWithAddressBookRequest.Builder> associateContactWithAddressBookRequest)
Associates a contact with a given address book.
|
default AssociateDeviceWithNetworkProfileResponse |
associateDeviceWithNetworkProfile(AssociateDeviceWithNetworkProfileRequest associateDeviceWithNetworkProfileRequest)
Associates a device with the specified network profile.
|
default AssociateDeviceWithNetworkProfileResponse |
associateDeviceWithNetworkProfile(Consumer<AssociateDeviceWithNetworkProfileRequest.Builder> associateDeviceWithNetworkProfileRequest)
Associates a device with the specified network profile.
|
default AssociateDeviceWithRoomResponse |
associateDeviceWithRoom(AssociateDeviceWithRoomRequest associateDeviceWithRoomRequest)
Associates a device with a given room.
|
default AssociateDeviceWithRoomResponse |
associateDeviceWithRoom(Consumer<AssociateDeviceWithRoomRequest.Builder> associateDeviceWithRoomRequest)
Associates a device with a given room.
|
default AssociateSkillGroupWithRoomResponse |
associateSkillGroupWithRoom(AssociateSkillGroupWithRoomRequest associateSkillGroupWithRoomRequest)
Associates a skill group with a given room.
|
default AssociateSkillGroupWithRoomResponse |
associateSkillGroupWithRoom(Consumer<AssociateSkillGroupWithRoomRequest.Builder> associateSkillGroupWithRoomRequest)
Associates a skill group with a given room.
|
default AssociateSkillWithSkillGroupResponse |
associateSkillWithSkillGroup(AssociateSkillWithSkillGroupRequest associateSkillWithSkillGroupRequest)
Associates a skill with a skill group.
|
default AssociateSkillWithSkillGroupResponse |
associateSkillWithSkillGroup(Consumer<AssociateSkillWithSkillGroupRequest.Builder> associateSkillWithSkillGroupRequest)
Associates a skill with a skill group.
|
default AssociateSkillWithUsersResponse |
associateSkillWithUsers(AssociateSkillWithUsersRequest associateSkillWithUsersRequest)
Makes a private skill available for enrolled users to enable on their devices.
|
default AssociateSkillWithUsersResponse |
associateSkillWithUsers(Consumer<AssociateSkillWithUsersRequest.Builder> associateSkillWithUsersRequest)
Makes a private skill available for enrolled users to enable on their devices.
|
static AlexaForBusinessClientBuilder |
builder()
Create a builder that can be used to configure and create a
AlexaForBusinessClient . |
static AlexaForBusinessClient |
create()
Create a
AlexaForBusinessClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CreateAddressBookResponse |
createAddressBook(Consumer<CreateAddressBookRequest.Builder> createAddressBookRequest)
Creates an address book with the specified details.
|
default CreateAddressBookResponse |
createAddressBook(CreateAddressBookRequest createAddressBookRequest)
Creates an address book with the specified details.
|
default CreateBusinessReportScheduleResponse |
createBusinessReportSchedule(Consumer<CreateBusinessReportScheduleRequest.Builder> createBusinessReportScheduleRequest)
Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or
weekly interval.
|
default CreateBusinessReportScheduleResponse |
createBusinessReportSchedule(CreateBusinessReportScheduleRequest createBusinessReportScheduleRequest)
Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or
weekly interval.
|
default CreateConferenceProviderResponse |
createConferenceProvider(Consumer<CreateConferenceProviderRequest.Builder> createConferenceProviderRequest)
Adds a new conference provider under the user's AWS account.
|
default CreateConferenceProviderResponse |
createConferenceProvider(CreateConferenceProviderRequest createConferenceProviderRequest)
Adds a new conference provider under the user's AWS account.
|
default CreateContactResponse |
createContact(Consumer<CreateContactRequest.Builder> createContactRequest)
Creates a contact with the specified details.
|
default CreateContactResponse |
createContact(CreateContactRequest createContactRequest)
Creates a contact with the specified details.
|
default CreateGatewayGroupResponse |
createGatewayGroup(Consumer<CreateGatewayGroupRequest.Builder> createGatewayGroupRequest)
Creates a gateway group with the specified details.
|
default CreateGatewayGroupResponse |
createGatewayGroup(CreateGatewayGroupRequest createGatewayGroupRequest)
Creates a gateway group with the specified details.
|
default CreateNetworkProfileResponse |
createNetworkProfile(Consumer<CreateNetworkProfileRequest.Builder> createNetworkProfileRequest)
Creates a network profile with the specified details.
|
default CreateNetworkProfileResponse |
createNetworkProfile(CreateNetworkProfileRequest createNetworkProfileRequest)
Creates a network profile with the specified details.
|
default CreateProfileResponse |
createProfile(Consumer<CreateProfileRequest.Builder> createProfileRequest)
Creates a new room profile with the specified details.
|
default CreateProfileResponse |
createProfile(CreateProfileRequest createProfileRequest)
Creates a new room profile with the specified details.
|
default CreateRoomResponse |
createRoom(Consumer<CreateRoomRequest.Builder> createRoomRequest)
Creates a room with the specified details.
|
default CreateRoomResponse |
createRoom(CreateRoomRequest createRoomRequest)
Creates a room with the specified details.
|
default CreateSkillGroupResponse |
createSkillGroup(Consumer<CreateSkillGroupRequest.Builder> createSkillGroupRequest)
Creates a skill group with a specified name and description.
|
default CreateSkillGroupResponse |
createSkillGroup(CreateSkillGroupRequest createSkillGroupRequest)
Creates a skill group with a specified name and description.
|
default CreateUserResponse |
createUser(Consumer<CreateUserRequest.Builder> createUserRequest)
Creates a user.
|
default CreateUserResponse |
createUser(CreateUserRequest createUserRequest)
Creates a user.
|
default DeleteAddressBookResponse |
deleteAddressBook(Consumer<DeleteAddressBookRequest.Builder> deleteAddressBookRequest)
Deletes an address book by the address book ARN.
|
default DeleteAddressBookResponse |
deleteAddressBook(DeleteAddressBookRequest deleteAddressBookRequest)
Deletes an address book by the address book ARN.
|
default DeleteBusinessReportScheduleResponse |
deleteBusinessReportSchedule(Consumer<DeleteBusinessReportScheduleRequest.Builder> deleteBusinessReportScheduleRequest)
Deletes the recurring report delivery schedule with the specified schedule ARN.
|
default DeleteBusinessReportScheduleResponse |
deleteBusinessReportSchedule(DeleteBusinessReportScheduleRequest deleteBusinessReportScheduleRequest)
Deletes the recurring report delivery schedule with the specified schedule ARN.
|
default DeleteConferenceProviderResponse |
deleteConferenceProvider(Consumer<DeleteConferenceProviderRequest.Builder> deleteConferenceProviderRequest)
Deletes a conference provider.
|
default DeleteConferenceProviderResponse |
deleteConferenceProvider(DeleteConferenceProviderRequest deleteConferenceProviderRequest)
Deletes a conference provider.
|
default DeleteContactResponse |
deleteContact(Consumer<DeleteContactRequest.Builder> deleteContactRequest)
Deletes a contact by the contact ARN.
|
default DeleteContactResponse |
deleteContact(DeleteContactRequest deleteContactRequest)
Deletes a contact by the contact ARN.
|
default DeleteDeviceResponse |
deleteDevice(Consumer<DeleteDeviceRequest.Builder> deleteDeviceRequest)
Removes a device from Alexa For Business.
|
default DeleteDeviceResponse |
deleteDevice(DeleteDeviceRequest deleteDeviceRequest)
Removes a device from Alexa For Business.
|
default DeleteDeviceUsageDataResponse |
deleteDeviceUsageData(Consumer<DeleteDeviceUsageDataRequest.Builder> 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.
|
default DeleteDeviceUsageDataResponse |
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.
|
default DeleteGatewayGroupResponse |
deleteGatewayGroup(Consumer<DeleteGatewayGroupRequest.Builder> deleteGatewayGroupRequest)
Deletes a gateway group.
|
default DeleteGatewayGroupResponse |
deleteGatewayGroup(DeleteGatewayGroupRequest deleteGatewayGroupRequest)
Deletes a gateway group.
|
default DeleteNetworkProfileResponse |
deleteNetworkProfile(Consumer<DeleteNetworkProfileRequest.Builder> deleteNetworkProfileRequest)
Deletes a network profile by the network profile ARN.
|
default DeleteNetworkProfileResponse |
deleteNetworkProfile(DeleteNetworkProfileRequest deleteNetworkProfileRequest)
Deletes a network profile by the network profile ARN.
|
default DeleteProfileResponse |
deleteProfile(Consumer<DeleteProfileRequest.Builder> deleteProfileRequest)
Deletes a room profile by the profile ARN.
|
default DeleteProfileResponse |
deleteProfile(DeleteProfileRequest deleteProfileRequest)
Deletes a room profile by the profile ARN.
|
default DeleteRoomResponse |
deleteRoom(Consumer<DeleteRoomRequest.Builder> deleteRoomRequest)
Deletes a room by the room ARN.
|
default DeleteRoomResponse |
deleteRoom(DeleteRoomRequest deleteRoomRequest)
Deletes a room by the room ARN.
|
default DeleteRoomSkillParameterResponse |
deleteRoomSkillParameter(Consumer<DeleteRoomSkillParameterRequest.Builder> deleteRoomSkillParameterRequest)
Deletes room skill parameter details by room, skill, and parameter key ID.
|
default DeleteRoomSkillParameterResponse |
deleteRoomSkillParameter(DeleteRoomSkillParameterRequest deleteRoomSkillParameterRequest)
Deletes room skill parameter details by room, skill, and parameter key ID.
|
default DeleteSkillAuthorizationResponse |
deleteSkillAuthorization(Consumer<DeleteSkillAuthorizationRequest.Builder> deleteSkillAuthorizationRequest)
Unlinks a third-party account from a skill.
|
default DeleteSkillAuthorizationResponse |
deleteSkillAuthorization(DeleteSkillAuthorizationRequest deleteSkillAuthorizationRequest)
Unlinks a third-party account from a skill.
|
default DeleteSkillGroupResponse |
deleteSkillGroup(Consumer<DeleteSkillGroupRequest.Builder> deleteSkillGroupRequest)
Deletes a skill group by skill group ARN.
|
default DeleteSkillGroupResponse |
deleteSkillGroup(DeleteSkillGroupRequest deleteSkillGroupRequest)
Deletes a skill group by skill group ARN.
|
default DeleteUserResponse |
deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest)
Deletes a specified user by user ARN and enrollment ARN.
|
default DeleteUserResponse |
deleteUser(DeleteUserRequest deleteUserRequest)
Deletes a specified user by user ARN and enrollment ARN.
|
default DisassociateContactFromAddressBookResponse |
disassociateContactFromAddressBook(Consumer<DisassociateContactFromAddressBookRequest.Builder> disassociateContactFromAddressBookRequest)
Disassociates a contact from a given address book.
|
default DisassociateContactFromAddressBookResponse |
disassociateContactFromAddressBook(DisassociateContactFromAddressBookRequest disassociateContactFromAddressBookRequest)
Disassociates a contact from a given address book.
|
default DisassociateDeviceFromRoomResponse |
disassociateDeviceFromRoom(Consumer<DisassociateDeviceFromRoomRequest.Builder> disassociateDeviceFromRoomRequest)
Disassociates a device from its current room.
|
default DisassociateDeviceFromRoomResponse |
disassociateDeviceFromRoom(DisassociateDeviceFromRoomRequest disassociateDeviceFromRoomRequest)
Disassociates a device from its current room.
|
default DisassociateSkillFromSkillGroupResponse |
disassociateSkillFromSkillGroup(Consumer<DisassociateSkillFromSkillGroupRequest.Builder> disassociateSkillFromSkillGroupRequest)
Disassociates a skill from a skill group.
|
default DisassociateSkillFromSkillGroupResponse |
disassociateSkillFromSkillGroup(DisassociateSkillFromSkillGroupRequest disassociateSkillFromSkillGroupRequest)
Disassociates a skill from a skill group.
|
default DisassociateSkillFromUsersResponse |
disassociateSkillFromUsers(Consumer<DisassociateSkillFromUsersRequest.Builder> disassociateSkillFromUsersRequest)
Makes a private skill unavailable for enrolled users and prevents them from enabling it on their devices.
|
default DisassociateSkillFromUsersResponse |
disassociateSkillFromUsers(DisassociateSkillFromUsersRequest disassociateSkillFromUsersRequest)
Makes a private skill unavailable for enrolled users and prevents them from enabling it on their devices.
|
default DisassociateSkillGroupFromRoomResponse |
disassociateSkillGroupFromRoom(Consumer<DisassociateSkillGroupFromRoomRequest.Builder> disassociateSkillGroupFromRoomRequest)
Disassociates a skill group from a specified room.
|
default DisassociateSkillGroupFromRoomResponse |
disassociateSkillGroupFromRoom(DisassociateSkillGroupFromRoomRequest disassociateSkillGroupFromRoomRequest)
Disassociates a skill group from a specified room.
|
default ForgetSmartHomeAppliancesResponse |
forgetSmartHomeAppliances(Consumer<ForgetSmartHomeAppliancesRequest.Builder> forgetSmartHomeAppliancesRequest)
Forgets smart home appliances associated to a room.
|
default ForgetSmartHomeAppliancesResponse |
forgetSmartHomeAppliances(ForgetSmartHomeAppliancesRequest forgetSmartHomeAppliancesRequest)
Forgets smart home appliances associated to a room.
|
default GetAddressBookResponse |
getAddressBook(Consumer<GetAddressBookRequest.Builder> getAddressBookRequest)
Gets address the book details by the address book ARN.
|
default GetAddressBookResponse |
getAddressBook(GetAddressBookRequest getAddressBookRequest)
Gets address the book details by the address book ARN.
|
default GetConferencePreferenceResponse |
getConferencePreference(Consumer<GetConferencePreferenceRequest.Builder> getConferencePreferenceRequest)
Retrieves the existing conference preferences.
|
default GetConferencePreferenceResponse |
getConferencePreference(GetConferencePreferenceRequest getConferencePreferenceRequest)
Retrieves the existing conference preferences.
|
default GetConferenceProviderResponse |
getConferenceProvider(Consumer<GetConferenceProviderRequest.Builder> getConferenceProviderRequest)
Gets details about a specific conference provider.
|
default GetConferenceProviderResponse |
getConferenceProvider(GetConferenceProviderRequest getConferenceProviderRequest)
Gets details about a specific conference provider.
|
default GetContactResponse |
getContact(Consumer<GetContactRequest.Builder> getContactRequest)
Gets the contact details by the contact ARN.
|
default GetContactResponse |
getContact(GetContactRequest getContactRequest)
Gets the contact details by the contact ARN.
|
default GetDeviceResponse |
getDevice(Consumer<GetDeviceRequest.Builder> getDeviceRequest)
Gets the details of a device by device ARN.
|
default GetDeviceResponse |
getDevice(GetDeviceRequest getDeviceRequest)
Gets the details of a device by device ARN.
|
default GetGatewayResponse |
getGateway(Consumer<GetGatewayRequest.Builder> getGatewayRequest)
Retrieves the details of a gateway.
|
default GetGatewayResponse |
getGateway(GetGatewayRequest getGatewayRequest)
Retrieves the details of a gateway.
|
default GetGatewayGroupResponse |
getGatewayGroup(Consumer<GetGatewayGroupRequest.Builder> getGatewayGroupRequest)
Retrieves the details of a gateway group.
|
default GetGatewayGroupResponse |
getGatewayGroup(GetGatewayGroupRequest getGatewayGroupRequest)
Retrieves the details of a gateway group.
|
default GetInvitationConfigurationResponse |
getInvitationConfiguration(Consumer<GetInvitationConfigurationRequest.Builder> getInvitationConfigurationRequest)
Retrieves the configured values for the user enrollment invitation email template.
|
default GetInvitationConfigurationResponse |
getInvitationConfiguration(GetInvitationConfigurationRequest getInvitationConfigurationRequest)
Retrieves the configured values for the user enrollment invitation email template.
|
default GetNetworkProfileResponse |
getNetworkProfile(Consumer<GetNetworkProfileRequest.Builder> getNetworkProfileRequest)
Gets the network profile details by the network profile ARN.
|
default GetNetworkProfileResponse |
getNetworkProfile(GetNetworkProfileRequest getNetworkProfileRequest)
Gets the network profile details by the network profile ARN.
|
default GetProfileResponse |
getProfile(Consumer<GetProfileRequest.Builder> getProfileRequest)
Gets the details of a room profile by profile ARN.
|
default GetProfileResponse |
getProfile(GetProfileRequest getProfileRequest)
Gets the details of a room profile by profile ARN.
|
default GetRoomResponse |
getRoom(Consumer<GetRoomRequest.Builder> getRoomRequest)
Gets room details by room ARN.
|
default GetRoomResponse |
getRoom(GetRoomRequest getRoomRequest)
Gets room details by room ARN.
|
default GetRoomSkillParameterResponse |
getRoomSkillParameter(Consumer<GetRoomSkillParameterRequest.Builder> getRoomSkillParameterRequest)
Gets room skill parameter details by room, skill, and parameter key ARN.
|
default GetRoomSkillParameterResponse |
getRoomSkillParameter(GetRoomSkillParameterRequest getRoomSkillParameterRequest)
Gets room skill parameter details by room, skill, and parameter key ARN.
|
default GetSkillGroupResponse |
getSkillGroup(Consumer<GetSkillGroupRequest.Builder> getSkillGroupRequest)
Gets skill group details by skill group ARN.
|
default GetSkillGroupResponse |
getSkillGroup(GetSkillGroupRequest getSkillGroupRequest)
Gets skill group details by skill group ARN.
|
default ListBusinessReportSchedulesResponse |
listBusinessReportSchedules(Consumer<ListBusinessReportSchedulesRequest.Builder> listBusinessReportSchedulesRequest)
Lists the details of the schedules that a user configured.
|
default ListBusinessReportSchedulesResponse |
listBusinessReportSchedules(ListBusinessReportSchedulesRequest listBusinessReportSchedulesRequest)
Lists the details of the schedules that a user configured.
|
default ListBusinessReportSchedulesIterable |
listBusinessReportSchedulesPaginator(Consumer<ListBusinessReportSchedulesRequest.Builder> listBusinessReportSchedulesRequest)
Lists the details of the schedules that a user configured.
|
default ListBusinessReportSchedulesIterable |
listBusinessReportSchedulesPaginator(ListBusinessReportSchedulesRequest listBusinessReportSchedulesRequest)
Lists the details of the schedules that a user configured.
|
default ListConferenceProvidersResponse |
listConferenceProviders(Consumer<ListConferenceProvidersRequest.Builder> listConferenceProvidersRequest)
Lists conference providers under a specific AWS account.
|
default ListConferenceProvidersResponse |
listConferenceProviders(ListConferenceProvidersRequest listConferenceProvidersRequest)
Lists conference providers under a specific AWS account.
|
default ListConferenceProvidersIterable |
listConferenceProvidersPaginator(Consumer<ListConferenceProvidersRequest.Builder> listConferenceProvidersRequest)
Lists conference providers under a specific AWS account.
|
default ListConferenceProvidersIterable |
listConferenceProvidersPaginator(ListConferenceProvidersRequest listConferenceProvidersRequest)
Lists conference providers under a specific AWS account.
|
default ListDeviceEventsResponse |
listDeviceEvents(Consumer<ListDeviceEventsRequest.Builder> listDeviceEventsRequest)
Lists the device event history, including device connection status, for up to 30 days.
|
default ListDeviceEventsResponse |
listDeviceEvents(ListDeviceEventsRequest listDeviceEventsRequest)
Lists the device event history, including device connection status, for up to 30 days.
|
default ListDeviceEventsIterable |
listDeviceEventsPaginator(Consumer<ListDeviceEventsRequest.Builder> listDeviceEventsRequest)
Lists the device event history, including device connection status, for up to 30 days.
|
default ListDeviceEventsIterable |
listDeviceEventsPaginator(ListDeviceEventsRequest listDeviceEventsRequest)
Lists the device event history, including device connection status, for up to 30 days.
|
default ListGatewayGroupsResponse |
listGatewayGroups(Consumer<ListGatewayGroupsRequest.Builder> listGatewayGroupsRequest)
Retrieves a list of gateway group summaries.
|
default ListGatewayGroupsResponse |
listGatewayGroups(ListGatewayGroupsRequest listGatewayGroupsRequest)
Retrieves a list of gateway group summaries.
|
default ListGatewayGroupsIterable |
listGatewayGroupsPaginator(Consumer<ListGatewayGroupsRequest.Builder> listGatewayGroupsRequest)
Retrieves a list of gateway group summaries.
|
default ListGatewayGroupsIterable |
listGatewayGroupsPaginator(ListGatewayGroupsRequest listGatewayGroupsRequest)
Retrieves a list of gateway group summaries.
|
default ListGatewaysResponse |
listGateways(Consumer<ListGatewaysRequest.Builder> listGatewaysRequest)
Retrieves a list of gateway summaries.
|
default ListGatewaysResponse |
listGateways(ListGatewaysRequest listGatewaysRequest)
Retrieves a list of gateway summaries.
|
default ListGatewaysIterable |
listGatewaysPaginator(Consumer<ListGatewaysRequest.Builder> listGatewaysRequest)
Retrieves a list of gateway summaries.
|
default ListGatewaysIterable |
listGatewaysPaginator(ListGatewaysRequest listGatewaysRequest)
Retrieves a list of gateway summaries.
|
default ListSkillsResponse |
listSkills(Consumer<ListSkillsRequest.Builder> listSkillsRequest)
Lists all enabled skills in a specific skill group.
|
default ListSkillsResponse |
listSkills(ListSkillsRequest listSkillsRequest)
Lists all enabled skills in a specific skill group.
|
default ListSkillsIterable |
listSkillsPaginator(Consumer<ListSkillsRequest.Builder> listSkillsRequest)
Lists all enabled skills in a specific skill group.
|
default ListSkillsIterable |
listSkillsPaginator(ListSkillsRequest listSkillsRequest)
Lists all enabled skills in a specific skill group.
|
default ListSkillsStoreCategoriesResponse |
listSkillsStoreCategories(Consumer<ListSkillsStoreCategoriesRequest.Builder> listSkillsStoreCategoriesRequest)
Lists all categories in the Alexa skill store.
|
default ListSkillsStoreCategoriesResponse |
listSkillsStoreCategories(ListSkillsStoreCategoriesRequest listSkillsStoreCategoriesRequest)
Lists all categories in the Alexa skill store.
|
default ListSkillsStoreCategoriesIterable |
listSkillsStoreCategoriesPaginator(Consumer<ListSkillsStoreCategoriesRequest.Builder> listSkillsStoreCategoriesRequest)
Lists all categories in the Alexa skill store.
|
default ListSkillsStoreCategoriesIterable |
listSkillsStoreCategoriesPaginator(ListSkillsStoreCategoriesRequest listSkillsStoreCategoriesRequest)
Lists all categories in the Alexa skill store.
|
default ListSkillsStoreSkillsByCategoryResponse |
listSkillsStoreSkillsByCategory(Consumer<ListSkillsStoreSkillsByCategoryRequest.Builder> listSkillsStoreSkillsByCategoryRequest)
Lists all skills in the Alexa skill store by category.
|
default ListSkillsStoreSkillsByCategoryResponse |
listSkillsStoreSkillsByCategory(ListSkillsStoreSkillsByCategoryRequest listSkillsStoreSkillsByCategoryRequest)
Lists all skills in the Alexa skill store by category.
|
default ListSkillsStoreSkillsByCategoryIterable |
listSkillsStoreSkillsByCategoryPaginator(Consumer<ListSkillsStoreSkillsByCategoryRequest.Builder> listSkillsStoreSkillsByCategoryRequest)
Lists all skills in the Alexa skill store by category.
|
default ListSkillsStoreSkillsByCategoryIterable |
listSkillsStoreSkillsByCategoryPaginator(ListSkillsStoreSkillsByCategoryRequest listSkillsStoreSkillsByCategoryRequest)
Lists all skills in the Alexa skill store by category.
|
default ListSmartHomeAppliancesResponse |
listSmartHomeAppliances(Consumer<ListSmartHomeAppliancesRequest.Builder> listSmartHomeAppliancesRequest)
Lists all of the smart home appliances associated with a room.
|
default ListSmartHomeAppliancesResponse |
listSmartHomeAppliances(ListSmartHomeAppliancesRequest listSmartHomeAppliancesRequest)
Lists all of the smart home appliances associated with a room.
|
default ListSmartHomeAppliancesIterable |
listSmartHomeAppliancesPaginator(Consumer<ListSmartHomeAppliancesRequest.Builder> listSmartHomeAppliancesRequest)
Lists all of the smart home appliances associated with a room.
|
default ListSmartHomeAppliancesIterable |
listSmartHomeAppliancesPaginator(ListSmartHomeAppliancesRequest listSmartHomeAppliancesRequest)
Lists all of the smart home appliances associated with a room.
|
default ListTagsResponse |
listTags(Consumer<ListTagsRequest.Builder> listTagsRequest)
Lists all tags for the specified resource.
|
default ListTagsResponse |
listTags(ListTagsRequest listTagsRequest)
Lists all tags for the specified resource.
|
default ListTagsIterable |
listTagsPaginator(Consumer<ListTagsRequest.Builder> listTagsRequest)
Lists all tags for the specified resource.
|
default ListTagsIterable |
listTagsPaginator(ListTagsRequest listTagsRequest)
Lists all tags for the specified resource.
|
default PutConferencePreferenceResponse |
putConferencePreference(Consumer<PutConferencePreferenceRequest.Builder> putConferencePreferenceRequest)
Sets the conference preferences on a specific conference provider at the account level.
|
default PutConferencePreferenceResponse |
putConferencePreference(PutConferencePreferenceRequest putConferencePreferenceRequest)
Sets the conference preferences on a specific conference provider at the account level.
|
default PutInvitationConfigurationResponse |
putInvitationConfiguration(Consumer<PutInvitationConfigurationRequest.Builder> putInvitationConfigurationRequest)
Configures the email template for the user enrollment invitation with the specified attributes.
|
default PutInvitationConfigurationResponse |
putInvitationConfiguration(PutInvitationConfigurationRequest putInvitationConfigurationRequest)
Configures the email template for the user enrollment invitation with the specified attributes.
|
default PutRoomSkillParameterResponse |
putRoomSkillParameter(Consumer<PutRoomSkillParameterRequest.Builder> putRoomSkillParameterRequest)
Updates room skill parameter details by room, skill, and parameter key ID.
|
default PutRoomSkillParameterResponse |
putRoomSkillParameter(PutRoomSkillParameterRequest putRoomSkillParameterRequest)
Updates room skill parameter details by room, skill, and parameter key ID.
|
default PutSkillAuthorizationResponse |
putSkillAuthorization(Consumer<PutSkillAuthorizationRequest.Builder> putSkillAuthorizationRequest)
Links a user's account to a third-party skill provider.
|
default PutSkillAuthorizationResponse |
putSkillAuthorization(PutSkillAuthorizationRequest putSkillAuthorizationRequest)
Links a user's account to a third-party skill provider.
|
default RegisterAvsDeviceResponse |
registerAVSDevice(Consumer<RegisterAvsDeviceRequest.Builder> registerAvsDeviceRequest)
Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service
(AVS).
|
default RegisterAvsDeviceResponse |
registerAVSDevice(RegisterAvsDeviceRequest registerAvsDeviceRequest)
Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service
(AVS).
|
default RejectSkillResponse |
rejectSkill(Consumer<RejectSkillRequest.Builder> rejectSkillRequest)
Disassociates a skill from the organization under a user's AWS account.
|
default RejectSkillResponse |
rejectSkill(RejectSkillRequest rejectSkillRequest)
Disassociates a skill from the organization under a user's AWS account.
|
default ResolveRoomResponse |
resolveRoom(Consumer<ResolveRoomRequest.Builder> resolveRoomRequest)
Determines the details for the room from which a skill request was invoked.
|
default ResolveRoomResponse |
resolveRoom(ResolveRoomRequest resolveRoomRequest)
Determines the details for the room from which a skill request was invoked.
|
default RevokeInvitationResponse |
revokeInvitation(Consumer<RevokeInvitationRequest.Builder> revokeInvitationRequest)
Revokes an invitation and invalidates the enrollment URL.
|
default RevokeInvitationResponse |
revokeInvitation(RevokeInvitationRequest revokeInvitationRequest)
Revokes an invitation and invalidates the enrollment URL.
|
default SearchAddressBooksResponse |
searchAddressBooks(Consumer<SearchAddressBooksRequest.Builder> searchAddressBooksRequest)
Searches address books and lists the ones that meet a set of filter and sort criteria.
|
default SearchAddressBooksResponse |
searchAddressBooks(SearchAddressBooksRequest searchAddressBooksRequest)
Searches address books and lists the ones that meet a set of filter and sort criteria.
|
default SearchAddressBooksIterable |
searchAddressBooksPaginator(Consumer<SearchAddressBooksRequest.Builder> searchAddressBooksRequest)
Searches address books and lists the ones that meet a set of filter and sort criteria.
|
default SearchAddressBooksIterable |
searchAddressBooksPaginator(SearchAddressBooksRequest searchAddressBooksRequest)
Searches address books and lists the ones that meet a set of filter and sort criteria.
|
default SearchContactsResponse |
searchContacts(Consumer<SearchContactsRequest.Builder> searchContactsRequest)
Searches contacts and lists the ones that meet a set of filter and sort criteria.
|
default SearchContactsResponse |
searchContacts(SearchContactsRequest searchContactsRequest)
Searches contacts and lists the ones that meet a set of filter and sort criteria.
|
default SearchContactsIterable |
searchContactsPaginator(Consumer<SearchContactsRequest.Builder> searchContactsRequest)
Searches contacts and lists the ones that meet a set of filter and sort criteria.
|
default SearchContactsIterable |
searchContactsPaginator(SearchContactsRequest searchContactsRequest)
Searches contacts and lists the ones that meet a set of filter and sort criteria.
|
default SearchDevicesResponse |
searchDevices(Consumer<SearchDevicesRequest.Builder> searchDevicesRequest)
Searches devices and lists the ones that meet a set of filter criteria.
|
default SearchDevicesResponse |
searchDevices(SearchDevicesRequest searchDevicesRequest)
Searches devices and lists the ones that meet a set of filter criteria.
|
default SearchDevicesIterable |
searchDevicesPaginator(Consumer<SearchDevicesRequest.Builder> searchDevicesRequest)
Searches devices and lists the ones that meet a set of filter criteria.
|
default SearchDevicesIterable |
searchDevicesPaginator(SearchDevicesRequest searchDevicesRequest)
Searches devices and lists the ones that meet a set of filter criteria.
|
default SearchNetworkProfilesResponse |
searchNetworkProfiles(Consumer<SearchNetworkProfilesRequest.Builder> searchNetworkProfilesRequest)
Searches network profiles and lists the ones that meet a set of filter and sort criteria.
|
default SearchNetworkProfilesResponse |
searchNetworkProfiles(SearchNetworkProfilesRequest searchNetworkProfilesRequest)
Searches network profiles and lists the ones that meet a set of filter and sort criteria.
|
default SearchNetworkProfilesIterable |
searchNetworkProfilesPaginator(Consumer<SearchNetworkProfilesRequest.Builder> searchNetworkProfilesRequest)
Searches network profiles and lists the ones that meet a set of filter and sort criteria.
|
default SearchNetworkProfilesIterable |
searchNetworkProfilesPaginator(SearchNetworkProfilesRequest searchNetworkProfilesRequest)
Searches network profiles and lists the ones that meet a set of filter and sort criteria.
|
default SearchProfilesResponse |
searchProfiles(Consumer<SearchProfilesRequest.Builder> searchProfilesRequest)
Searches room profiles and lists the ones that meet a set of filter criteria.
|
default SearchProfilesResponse |
searchProfiles(SearchProfilesRequest searchProfilesRequest)
Searches room profiles and lists the ones that meet a set of filter criteria.
|
default SearchProfilesIterable |
searchProfilesPaginator(Consumer<SearchProfilesRequest.Builder> searchProfilesRequest)
Searches room profiles and lists the ones that meet a set of filter criteria.
|
default SearchProfilesIterable |
searchProfilesPaginator(SearchProfilesRequest searchProfilesRequest)
Searches room profiles and lists the ones that meet a set of filter criteria.
|
default SearchRoomsResponse |
searchRooms(Consumer<SearchRoomsRequest.Builder> searchRoomsRequest)
Searches rooms and lists the ones that meet a set of filter and sort criteria.
|
default SearchRoomsResponse |
searchRooms(SearchRoomsRequest searchRoomsRequest)
Searches rooms and lists the ones that meet a set of filter and sort criteria.
|
default SearchRoomsIterable |
searchRoomsPaginator(Consumer<SearchRoomsRequest.Builder> searchRoomsRequest)
Searches rooms and lists the ones that meet a set of filter and sort criteria.
|
default SearchRoomsIterable |
searchRoomsPaginator(SearchRoomsRequest searchRoomsRequest)
Searches rooms and lists the ones that meet a set of filter and sort criteria.
|
default SearchSkillGroupsResponse |
searchSkillGroups(Consumer<SearchSkillGroupsRequest.Builder> searchSkillGroupsRequest)
Searches skill groups and lists the ones that meet a set of filter and sort criteria.
|
default SearchSkillGroupsResponse |
searchSkillGroups(SearchSkillGroupsRequest searchSkillGroupsRequest)
Searches skill groups and lists the ones that meet a set of filter and sort criteria.
|
default SearchSkillGroupsIterable |
searchSkillGroupsPaginator(Consumer<SearchSkillGroupsRequest.Builder> searchSkillGroupsRequest)
Searches skill groups and lists the ones that meet a set of filter and sort criteria.
|
default SearchSkillGroupsIterable |
searchSkillGroupsPaginator(SearchSkillGroupsRequest searchSkillGroupsRequest)
Searches skill groups and lists the ones that meet a set of filter and sort criteria.
|
default SearchUsersResponse |
searchUsers(Consumer<SearchUsersRequest.Builder> searchUsersRequest)
Searches users and lists the ones that meet a set of filter and sort criteria.
|
default SearchUsersResponse |
searchUsers(SearchUsersRequest searchUsersRequest)
Searches users and lists the ones that meet a set of filter and sort criteria.
|
default SearchUsersIterable |
searchUsersPaginator(Consumer<SearchUsersRequest.Builder> searchUsersRequest)
Searches users and lists the ones that meet a set of filter and sort criteria.
|
default SearchUsersIterable |
searchUsersPaginator(SearchUsersRequest searchUsersRequest)
Searches users and lists the ones that meet a set of filter and sort criteria.
|
default SendAnnouncementResponse |
sendAnnouncement(Consumer<SendAnnouncementRequest.Builder> sendAnnouncementRequest)
Triggers an asynchronous flow to send text, SSML, or audio announcements to rooms that are identified by a search
or filter.
|
default SendAnnouncementResponse |
sendAnnouncement(SendAnnouncementRequest sendAnnouncementRequest)
Triggers an asynchronous flow to send text, SSML, or audio announcements to rooms that are identified by a search
or filter.
|
default SendInvitationResponse |
sendInvitation(Consumer<SendInvitationRequest.Builder> sendInvitationRequest)
Sends an enrollment invitation email with a URL to a user.
|
default SendInvitationResponse |
sendInvitation(SendInvitationRequest sendInvitationRequest)
Sends an enrollment invitation email with a URL to a user.
|
static ServiceMetadata |
serviceMetadata() |
default StartDeviceSyncResponse |
startDeviceSync(Consumer<StartDeviceSyncRequest.Builder> startDeviceSyncRequest)
Resets a device and its account to the known default settings.
|
default StartDeviceSyncResponse |
startDeviceSync(StartDeviceSyncRequest startDeviceSyncRequest)
Resets a device and its account to the known default settings.
|
default StartSmartHomeApplianceDiscoveryResponse |
startSmartHomeApplianceDiscovery(Consumer<StartSmartHomeApplianceDiscoveryRequest.Builder> startSmartHomeApplianceDiscoveryRequest)
Initiates the discovery of any smart home appliances associated with the room.
|
default StartSmartHomeApplianceDiscoveryResponse |
startSmartHomeApplianceDiscovery(StartSmartHomeApplianceDiscoveryRequest startSmartHomeApplianceDiscoveryRequest)
Initiates the discovery of any smart home appliances associated with the room.
|
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds metadata tags to a specified resource.
|
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
Adds metadata tags to a specified resource.
|
default UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes metadata tags from a specified resource.
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest)
Removes metadata tags from a specified resource.
|
default UpdateAddressBookResponse |
updateAddressBook(Consumer<UpdateAddressBookRequest.Builder> updateAddressBookRequest)
Updates address book details by the address book ARN.
|
default UpdateAddressBookResponse |
updateAddressBook(UpdateAddressBookRequest updateAddressBookRequest)
Updates address book details by the address book ARN.
|
default UpdateBusinessReportScheduleResponse |
updateBusinessReportSchedule(Consumer<UpdateBusinessReportScheduleRequest.Builder> updateBusinessReportScheduleRequest)
Updates the configuration of the report delivery schedule with the specified schedule ARN.
|
default UpdateBusinessReportScheduleResponse |
updateBusinessReportSchedule(UpdateBusinessReportScheduleRequest updateBusinessReportScheduleRequest)
Updates the configuration of the report delivery schedule with the specified schedule ARN.
|
default UpdateConferenceProviderResponse |
updateConferenceProvider(Consumer<UpdateConferenceProviderRequest.Builder> updateConferenceProviderRequest)
Updates an existing conference provider's settings.
|
default UpdateConferenceProviderResponse |
updateConferenceProvider(UpdateConferenceProviderRequest updateConferenceProviderRequest)
Updates an existing conference provider's settings.
|
default UpdateContactResponse |
updateContact(Consumer<UpdateContactRequest.Builder> updateContactRequest)
Updates the contact details by the contact ARN.
|
default UpdateContactResponse |
updateContact(UpdateContactRequest updateContactRequest)
Updates the contact details by the contact ARN.
|
default UpdateDeviceResponse |
updateDevice(Consumer<UpdateDeviceRequest.Builder> updateDeviceRequest)
Updates the device name by device ARN.
|
default UpdateDeviceResponse |
updateDevice(UpdateDeviceRequest updateDeviceRequest)
Updates the device name by device ARN.
|
default UpdateGatewayResponse |
updateGateway(Consumer<UpdateGatewayRequest.Builder> updateGatewayRequest)
Updates the details of a gateway.
|
default UpdateGatewayResponse |
updateGateway(UpdateGatewayRequest updateGatewayRequest)
Updates the details of a gateway.
|
default UpdateGatewayGroupResponse |
updateGatewayGroup(Consumer<UpdateGatewayGroupRequest.Builder> updateGatewayGroupRequest)
Updates the details of a gateway group.
|
default UpdateGatewayGroupResponse |
updateGatewayGroup(UpdateGatewayGroupRequest updateGatewayGroupRequest)
Updates the details of a gateway group.
|
default UpdateNetworkProfileResponse |
updateNetworkProfile(Consumer<UpdateNetworkProfileRequest.Builder> updateNetworkProfileRequest)
Updates a network profile by the network profile ARN.
|
default UpdateNetworkProfileResponse |
updateNetworkProfile(UpdateNetworkProfileRequest updateNetworkProfileRequest)
Updates a network profile by the network profile ARN.
|
default UpdateProfileResponse |
updateProfile(Consumer<UpdateProfileRequest.Builder> updateProfileRequest)
Updates an existing room profile by room profile ARN.
|
default UpdateProfileResponse |
updateProfile(UpdateProfileRequest updateProfileRequest)
Updates an existing room profile by room profile ARN.
|
default UpdateRoomResponse |
updateRoom(Consumer<UpdateRoomRequest.Builder> updateRoomRequest)
Updates room details by room ARN.
|
default UpdateRoomResponse |
updateRoom(UpdateRoomRequest updateRoomRequest)
Updates room details by room ARN.
|
default UpdateSkillGroupResponse |
updateSkillGroup(Consumer<UpdateSkillGroupRequest.Builder> updateSkillGroupRequest)
Updates skill group details by skill group ARN.
|
default UpdateSkillGroupResponse |
updateSkillGroup(UpdateSkillGroupRequest updateSkillGroupRequest)
Updates skill group details by skill group ARN.
|
serviceName
close
static final String SERVICE_NAME
static AlexaForBusinessClient create()
AlexaForBusinessClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static AlexaForBusinessClientBuilder builder()
AlexaForBusinessClient
.default ApproveSkillResponse approveSkill(ApproveSkillRequest approveSkillRequest) throws LimitExceededException, NotFoundException, ConcurrentModificationException, AwsServiceException, SdkClientException, AlexaForBusinessException
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ApproveSkillResponse approveSkill(Consumer<ApproveSkillRequest.Builder> approveSkillRequest) throws LimitExceededException, NotFoundException, ConcurrentModificationException, AwsServiceException, SdkClientException, AlexaForBusinessException
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.
This is a convenience which creates an instance of the ApproveSkillRequest.Builder
avoiding the need to
create one manually via ApproveSkillRequest.builder()
approveSkillRequest
- A Consumer
that will call methods on ApproveSkillRequest.Builder
to create a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AssociateContactWithAddressBookResponse associateContactWithAddressBook(AssociateContactWithAddressBookRequest associateContactWithAddressBookRequest) throws LimitExceededException, AwsServiceException, SdkClientException, AlexaForBusinessException
Associates a contact with a given address book.
associateContactWithAddressBookRequest
- LimitExceededException
- You are performing an action that would put you beyond your account's limits.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AssociateContactWithAddressBookResponse associateContactWithAddressBook(Consumer<AssociateContactWithAddressBookRequest.Builder> associateContactWithAddressBookRequest) throws LimitExceededException, AwsServiceException, SdkClientException, AlexaForBusinessException
Associates a contact with a given address book.
This is a convenience which creates an instance of the AssociateContactWithAddressBookRequest.Builder
avoiding the need to create one manually via AssociateContactWithAddressBookRequest.builder()
associateContactWithAddressBookRequest
- A Consumer
that will call methods on AssociateContactWithAddressBookRequest.Builder
to
create a request.LimitExceededException
- You are performing an action that would put you beyond your account's limits.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AssociateDeviceWithNetworkProfileResponse associateDeviceWithNetworkProfile(AssociateDeviceWithNetworkProfileRequest associateDeviceWithNetworkProfileRequest) throws NotFoundException, ConcurrentModificationException, DeviceNotRegisteredException, AwsServiceException, SdkClientException, AlexaForBusinessException
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AssociateDeviceWithNetworkProfileResponse associateDeviceWithNetworkProfile(Consumer<AssociateDeviceWithNetworkProfileRequest.Builder> associateDeviceWithNetworkProfileRequest) throws NotFoundException, ConcurrentModificationException, DeviceNotRegisteredException, AwsServiceException, SdkClientException, AlexaForBusinessException
Associates a device with the specified network profile.
This is a convenience which creates an instance of the AssociateDeviceWithNetworkProfileRequest.Builder
avoiding the need to create one manually via AssociateDeviceWithNetworkProfileRequest.builder()
associateDeviceWithNetworkProfileRequest
- A Consumer
that will call methods on AssociateDeviceWithNetworkProfileRequest.Builder
to
create a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AssociateDeviceWithRoomResponse associateDeviceWithRoom(AssociateDeviceWithRoomRequest associateDeviceWithRoomRequest) throws LimitExceededException, ConcurrentModificationException, DeviceNotRegisteredException, AwsServiceException, SdkClientException, AlexaForBusinessException
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AssociateDeviceWithRoomResponse associateDeviceWithRoom(Consumer<AssociateDeviceWithRoomRequest.Builder> associateDeviceWithRoomRequest) throws LimitExceededException, ConcurrentModificationException, DeviceNotRegisteredException, AwsServiceException, SdkClientException, AlexaForBusinessException
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.
This is a convenience which creates an instance of the AssociateDeviceWithRoomRequest.Builder
avoiding
the need to create one manually via AssociateDeviceWithRoomRequest.builder()
associateDeviceWithRoomRequest
- A Consumer
that will call methods on AssociateDeviceWithRoomRequest.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AssociateSkillGroupWithRoomResponse associateSkillGroupWithRoom(AssociateSkillGroupWithRoomRequest associateSkillGroupWithRoomRequest) throws ConcurrentModificationException, AwsServiceException, SdkClientException, AlexaForBusinessException
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AssociateSkillGroupWithRoomResponse associateSkillGroupWithRoom(Consumer<AssociateSkillGroupWithRoomRequest.Builder> associateSkillGroupWithRoomRequest) throws ConcurrentModificationException, AwsServiceException, SdkClientException, AlexaForBusinessException
Associates a skill group with a given room. This enables all skills in the associated skill group on all devices in the room.
This is a convenience which creates an instance of the AssociateSkillGroupWithRoomRequest.Builder
avoiding the need to create one manually via AssociateSkillGroupWithRoomRequest.builder()
associateSkillGroupWithRoomRequest
- A Consumer
that will call methods on AssociateSkillGroupWithRoomRequest.Builder
to create
a request.ConcurrentModificationException
- There is a concurrent modification of resources.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AssociateSkillWithSkillGroupResponse associateSkillWithSkillGroup(AssociateSkillWithSkillGroupRequest associateSkillWithSkillGroupRequest) throws ConcurrentModificationException, NotFoundException, SkillNotLinkedException, AwsServiceException, SdkClientException, AlexaForBusinessException
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AssociateSkillWithSkillGroupResponse associateSkillWithSkillGroup(Consumer<AssociateSkillWithSkillGroupRequest.Builder> associateSkillWithSkillGroupRequest) throws ConcurrentModificationException, NotFoundException, SkillNotLinkedException, AwsServiceException, SdkClientException, AlexaForBusinessException
Associates a skill with a skill group.
This is a convenience which creates an instance of the AssociateSkillWithSkillGroupRequest.Builder
avoiding the need to create one manually via AssociateSkillWithSkillGroupRequest.builder()
associateSkillWithSkillGroupRequest
- A Consumer
that will call methods on AssociateSkillWithSkillGroupRequest.Builder
to create
a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AssociateSkillWithUsersResponse associateSkillWithUsers(AssociateSkillWithUsersRequest associateSkillWithUsersRequest) throws ConcurrentModificationException, NotFoundException, AwsServiceException, SdkClientException, AlexaForBusinessException
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AssociateSkillWithUsersResponse associateSkillWithUsers(Consumer<AssociateSkillWithUsersRequest.Builder> associateSkillWithUsersRequest) throws ConcurrentModificationException, NotFoundException, AwsServiceException, SdkClientException, AlexaForBusinessException
Makes a private skill available for enrolled users to enable on their devices.
This is a convenience which creates an instance of the AssociateSkillWithUsersRequest.Builder
avoiding
the need to create one manually via AssociateSkillWithUsersRequest.builder()
associateSkillWithUsersRequest
- A Consumer
that will call methods on AssociateSkillWithUsersRequest.Builder
to create a
request.ConcurrentModificationException
- There is a concurrent modification of resources.NotFoundException
- The resource is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateAddressBookResponse createAddressBook(CreateAddressBookRequest createAddressBookRequest) throws AlreadyExistsException, LimitExceededException, AwsServiceException, SdkClientException, AlexaForBusinessException
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateAddressBookResponse createAddressBook(Consumer<CreateAddressBookRequest.Builder> createAddressBookRequest) throws AlreadyExistsException, LimitExceededException, AwsServiceException, SdkClientException, AlexaForBusinessException
Creates an address book with the specified details.
This is a convenience which creates an instance of the CreateAddressBookRequest.Builder
avoiding the need
to create one manually via CreateAddressBookRequest.builder()
createAddressBookRequest
- A Consumer
that will call methods on CreateAddressBookRequest.Builder
to create a request.AlreadyExistsException
- The resource being created already exists.LimitExceededException
- You are performing an action that would put you beyond your account's limits.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateBusinessReportScheduleResponse createBusinessReportSchedule(CreateBusinessReportScheduleRequest createBusinessReportScheduleRequest) throws AlreadyExistsException, AwsServiceException, SdkClientException, AlexaForBusinessException
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateBusinessReportScheduleResponse createBusinessReportSchedule(Consumer<CreateBusinessReportScheduleRequest.Builder> createBusinessReportScheduleRequest) throws AlreadyExistsException, AwsServiceException, SdkClientException, AlexaForBusinessException
Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or weekly interval.
This is a convenience which creates an instance of the CreateBusinessReportScheduleRequest.Builder
avoiding the need to create one manually via CreateBusinessReportScheduleRequest.builder()
createBusinessReportScheduleRequest
- A Consumer
that will call methods on CreateBusinessReportScheduleRequest.Builder
to create
a request.AlreadyExistsException
- The resource being created already exists.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateConferenceProviderResponse createConferenceProvider(CreateConferenceProviderRequest createConferenceProviderRequest) throws AlreadyExistsException, AwsServiceException, SdkClientException, AlexaForBusinessException
Adds a new conference provider under the user's AWS account.
createConferenceProviderRequest
- AlreadyExistsException
- The resource being created already exists.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateConferenceProviderResponse createConferenceProvider(Consumer<CreateConferenceProviderRequest.Builder> createConferenceProviderRequest) throws AlreadyExistsException, AwsServiceException, SdkClientException, AlexaForBusinessException
Adds a new conference provider under the user's AWS account.
This is a convenience which creates an instance of the CreateConferenceProviderRequest.Builder
avoiding
the need to create one manually via CreateConferenceProviderRequest.builder()
createConferenceProviderRequest
- A Consumer
that will call methods on CreateConferenceProviderRequest.Builder
to create a
request.AlreadyExistsException
- The resource being created already exists.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateContactResponse createContact(CreateContactRequest createContactRequest) throws AlreadyExistsException, LimitExceededException, AwsServiceException, SdkClientException, AlexaForBusinessException
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateContactResponse createContact(Consumer<CreateContactRequest.Builder> createContactRequest) throws AlreadyExistsException, LimitExceededException, AwsServiceException, SdkClientException, AlexaForBusinessException
Creates a contact with the specified details.
This is a convenience which creates an instance of the CreateContactRequest.Builder
avoiding the need to
create one manually via CreateContactRequest.builder()
createContactRequest
- A Consumer
that will call methods on CreateContactRequest.Builder
to create a request.AlreadyExistsException
- The resource being created already exists.LimitExceededException
- You are performing an action that would put you beyond your account's limits.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateGatewayGroupResponse createGatewayGroup(CreateGatewayGroupRequest createGatewayGroupRequest) throws AlreadyExistsException, LimitExceededException, AwsServiceException, SdkClientException, AlexaForBusinessException
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateGatewayGroupResponse createGatewayGroup(Consumer<CreateGatewayGroupRequest.Builder> createGatewayGroupRequest) throws AlreadyExistsException, LimitExceededException, AwsServiceException, SdkClientException, AlexaForBusinessException
Creates a gateway group with the specified details.
This is a convenience which creates an instance of the CreateGatewayGroupRequest.Builder
avoiding the
need to create one manually via CreateGatewayGroupRequest.builder()
createGatewayGroupRequest
- A Consumer
that will call methods on CreateGatewayGroupRequest.Builder
to create a
request.AlreadyExistsException
- The resource being created already exists.LimitExceededException
- You are performing an action that would put you beyond your account's limits.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateNetworkProfileResponse createNetworkProfile(CreateNetworkProfileRequest createNetworkProfileRequest) throws AlreadyExistsException, LimitExceededException, ConcurrentModificationException, InvalidCertificateAuthorityException, InvalidServiceLinkedRoleStateException, AwsServiceException, SdkClientException, AlexaForBusinessException
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateNetworkProfileResponse createNetworkProfile(Consumer<CreateNetworkProfileRequest.Builder> createNetworkProfileRequest) throws AlreadyExistsException, LimitExceededException, ConcurrentModificationException, InvalidCertificateAuthorityException, InvalidServiceLinkedRoleStateException, AwsServiceException, SdkClientException, AlexaForBusinessException
Creates a network profile with the specified details.
This is a convenience which creates an instance of the CreateNetworkProfileRequest.Builder
avoiding the
need to create one manually via CreateNetworkProfileRequest.builder()
createNetworkProfileRequest
- A Consumer
that will call methods on CreateNetworkProfileRequest.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateProfileResponse createProfile(CreateProfileRequest createProfileRequest) throws LimitExceededException, AlreadyExistsException, ConcurrentModificationException, AwsServiceException, SdkClientException, AlexaForBusinessException
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateProfileResponse createProfile(Consumer<CreateProfileRequest.Builder> createProfileRequest) throws LimitExceededException, AlreadyExistsException, ConcurrentModificationException, AwsServiceException, SdkClientException, AlexaForBusinessException
Creates a new room profile with the specified details.
This is a convenience which creates an instance of the CreateProfileRequest.Builder
avoiding the need to
create one manually via CreateProfileRequest.builder()
createProfileRequest
- A Consumer
that will call methods on CreateProfileRequest.Builder
to create a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateRoomResponse createRoom(CreateRoomRequest createRoomRequest) throws AlreadyExistsException, LimitExceededException, AwsServiceException, SdkClientException, AlexaForBusinessException
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateRoomResponse createRoom(Consumer<CreateRoomRequest.Builder> createRoomRequest) throws AlreadyExistsException, LimitExceededException, AwsServiceException, SdkClientException, AlexaForBusinessException
Creates a room with the specified details.
This is a convenience which creates an instance of the CreateRoomRequest.Builder
avoiding the need to
create one manually via CreateRoomRequest.builder()
createRoomRequest
- A Consumer
that will call methods on CreateRoomRequest.Builder
to create a request.AlreadyExistsException
- The resource being created already exists.LimitExceededException
- You are performing an action that would put you beyond your account's limits.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateSkillGroupResponse createSkillGroup(CreateSkillGroupRequest createSkillGroupRequest) throws AlreadyExistsException, LimitExceededException, ConcurrentModificationException, AwsServiceException, SdkClientException, AlexaForBusinessException
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateSkillGroupResponse createSkillGroup(Consumer<CreateSkillGroupRequest.Builder> createSkillGroupRequest) throws AlreadyExistsException, LimitExceededException, ConcurrentModificationException, AwsServiceException, SdkClientException, AlexaForBusinessException
Creates a skill group with a specified name and description.
This is a convenience which creates an instance of the CreateSkillGroupRequest.Builder
avoiding the need
to create one manually via CreateSkillGroupRequest.builder()
createSkillGroupRequest
- A Consumer
that will call methods on CreateSkillGroupRequest.Builder
to create a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateUserResponse createUser(CreateUserRequest createUserRequest) throws ResourceInUseException, LimitExceededException, ConcurrentModificationException, AwsServiceException, SdkClientException, AlexaForBusinessException
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateUserResponse createUser(Consumer<CreateUserRequest.Builder> createUserRequest) throws ResourceInUseException, LimitExceededException, ConcurrentModificationException, AwsServiceException, SdkClientException, AlexaForBusinessException
Creates a user.
This is a convenience which creates an instance of the CreateUserRequest.Builder
avoiding the need to
create one manually via CreateUserRequest.builder()
createUserRequest
- A Consumer
that will call methods on CreateUserRequest.Builder
to create a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteAddressBookResponse deleteAddressBook(DeleteAddressBookRequest deleteAddressBookRequest) throws NotFoundException, ConcurrentModificationException, AwsServiceException, SdkClientException, AlexaForBusinessException
Deletes an address book by the address book ARN.
deleteAddressBookRequest
- NotFoundException
- The resource is not found.ConcurrentModificationException
- There is a concurrent modification of resources.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteAddressBookResponse deleteAddressBook(Consumer<DeleteAddressBookRequest.Builder> deleteAddressBookRequest) throws NotFoundException, ConcurrentModificationException, AwsServiceException, SdkClientException, AlexaForBusinessException
Deletes an address book by the address book ARN.
This is a convenience which creates an instance of the DeleteAddressBookRequest.Builder
avoiding the need
to create one manually via DeleteAddressBookRequest.builder()
deleteAddressBookRequest
- A Consumer
that will call methods on DeleteAddressBookRequest.Builder
to create a request.NotFoundException
- The resource is not found.ConcurrentModificationException
- There is a concurrent modification of resources.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteBusinessReportScheduleResponse deleteBusinessReportSchedule(DeleteBusinessReportScheduleRequest deleteBusinessReportScheduleRequest) throws NotFoundException, ConcurrentModificationException, AwsServiceException, SdkClientException, AlexaForBusinessException
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteBusinessReportScheduleResponse deleteBusinessReportSchedule(Consumer<DeleteBusinessReportScheduleRequest.Builder> deleteBusinessReportScheduleRequest) throws NotFoundException, ConcurrentModificationException, AwsServiceException, SdkClientException, AlexaForBusinessException
Deletes the recurring report delivery schedule with the specified schedule ARN.
This is a convenience which creates an instance of the DeleteBusinessReportScheduleRequest.Builder
avoiding the need to create one manually via DeleteBusinessReportScheduleRequest.builder()
deleteBusinessReportScheduleRequest
- A Consumer
that will call methods on DeleteBusinessReportScheduleRequest.Builder
to create
a request.NotFoundException
- The resource is not found.ConcurrentModificationException
- There is a concurrent modification of resources.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteConferenceProviderResponse deleteConferenceProvider(DeleteConferenceProviderRequest deleteConferenceProviderRequest) throws NotFoundException, AwsServiceException, SdkClientException, AlexaForBusinessException
Deletes a conference provider.
deleteConferenceProviderRequest
- NotFoundException
- The resource is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteConferenceProviderResponse deleteConferenceProvider(Consumer<DeleteConferenceProviderRequest.Builder> deleteConferenceProviderRequest) throws NotFoundException, AwsServiceException, SdkClientException, AlexaForBusinessException
Deletes a conference provider.
This is a convenience which creates an instance of the DeleteConferenceProviderRequest.Builder
avoiding
the need to create one manually via DeleteConferenceProviderRequest.builder()
deleteConferenceProviderRequest
- A Consumer
that will call methods on DeleteConferenceProviderRequest.Builder
to create a
request.NotFoundException
- The resource is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteContactResponse deleteContact(DeleteContactRequest deleteContactRequest) throws NotFoundException, ConcurrentModificationException, AwsServiceException, SdkClientException, AlexaForBusinessException
Deletes a contact by the contact ARN.
deleteContactRequest
- NotFoundException
- The resource is not found.ConcurrentModificationException
- There is a concurrent modification of resources.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteContactResponse deleteContact(Consumer<DeleteContactRequest.Builder> deleteContactRequest) throws NotFoundException, ConcurrentModificationException, AwsServiceException, SdkClientException, AlexaForBusinessException
Deletes a contact by the contact ARN.
This is a convenience which creates an instance of the DeleteContactRequest.Builder
avoiding the need to
create one manually via DeleteContactRequest.builder()
deleteContactRequest
- A Consumer
that will call methods on DeleteContactRequest.Builder
to create a request.NotFoundException
- The resource is not found.ConcurrentModificationException
- There is a concurrent modification of resources.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteDeviceResponse deleteDevice(DeleteDeviceRequest deleteDeviceRequest) throws NotFoundException, ConcurrentModificationException, InvalidCertificateAuthorityException, AwsServiceException, SdkClientException, AlexaForBusinessException
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteDeviceResponse deleteDevice(Consumer<DeleteDeviceRequest.Builder> deleteDeviceRequest) throws NotFoundException, ConcurrentModificationException, InvalidCertificateAuthorityException, AwsServiceException, SdkClientException, AlexaForBusinessException
Removes a device from Alexa For Business.
This is a convenience which creates an instance of the DeleteDeviceRequest.Builder
avoiding the need to
create one manually via DeleteDeviceRequest.builder()
deleteDeviceRequest
- A Consumer
that will call methods on DeleteDeviceRequest.Builder
to create a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteDeviceUsageDataResponse deleteDeviceUsageData(DeleteDeviceUsageDataRequest deleteDeviceUsageDataRequest) throws NotFoundException, DeviceNotRegisteredException, LimitExceededException, AwsServiceException, SdkClientException, AlexaForBusinessException
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteDeviceUsageDataResponse deleteDeviceUsageData(Consumer<DeleteDeviceUsageDataRequest.Builder> deleteDeviceUsageDataRequest) throws NotFoundException, DeviceNotRegisteredException, LimitExceededException, AwsServiceException, SdkClientException, AlexaForBusinessException
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.
This is a convenience which creates an instance of the DeleteDeviceUsageDataRequest.Builder
avoiding the
need to create one manually via DeleteDeviceUsageDataRequest.builder()
deleteDeviceUsageDataRequest
- A Consumer
that will call methods on DeleteDeviceUsageDataRequest.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteGatewayGroupResponse deleteGatewayGroup(DeleteGatewayGroupRequest deleteGatewayGroupRequest) throws ResourceAssociatedException, AwsServiceException, SdkClientException, AlexaForBusinessException
Deletes a gateway group.
deleteGatewayGroupRequest
- ResourceAssociatedException
- Another resource is associated with the resource in the request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteGatewayGroupResponse deleteGatewayGroup(Consumer<DeleteGatewayGroupRequest.Builder> deleteGatewayGroupRequest) throws ResourceAssociatedException, AwsServiceException, SdkClientException, AlexaForBusinessException
Deletes a gateway group.
This is a convenience which creates an instance of the DeleteGatewayGroupRequest.Builder
avoiding the
need to create one manually via DeleteGatewayGroupRequest.builder()
deleteGatewayGroupRequest
- A Consumer
that will call methods on DeleteGatewayGroupRequest.Builder
to create a
request.ResourceAssociatedException
- Another resource is associated with the resource in the request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteNetworkProfileResponse deleteNetworkProfile(DeleteNetworkProfileRequest deleteNetworkProfileRequest) throws ResourceInUseException, ConcurrentModificationException, NotFoundException, AwsServiceException, SdkClientException, AlexaForBusinessException
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteNetworkProfileResponse deleteNetworkProfile(Consumer<DeleteNetworkProfileRequest.Builder> deleteNetworkProfileRequest) throws ResourceInUseException, ConcurrentModificationException, NotFoundException, AwsServiceException, SdkClientException, AlexaForBusinessException
Deletes a network profile by the network profile ARN.
This is a convenience which creates an instance of the DeleteNetworkProfileRequest.Builder
avoiding the
need to create one manually via DeleteNetworkProfileRequest.builder()
deleteNetworkProfileRequest
- A Consumer
that will call methods on DeleteNetworkProfileRequest.Builder
to create a
request.ResourceInUseException
- The resource in the request is already in use.ConcurrentModificationException
- There is a concurrent modification of resources.NotFoundException
- The resource is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteProfileResponse deleteProfile(DeleteProfileRequest deleteProfileRequest) throws NotFoundException, ConcurrentModificationException, AwsServiceException, SdkClientException, AlexaForBusinessException
Deletes a room profile by the profile ARN.
deleteProfileRequest
- NotFoundException
- The resource is not found.ConcurrentModificationException
- There is a concurrent modification of resources.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteProfileResponse deleteProfile(Consumer<DeleteProfileRequest.Builder> deleteProfileRequest) throws NotFoundException, ConcurrentModificationException, AwsServiceException, SdkClientException, AlexaForBusinessException
Deletes a room profile by the profile ARN.
This is a convenience which creates an instance of the DeleteProfileRequest.Builder
avoiding the need to
create one manually via DeleteProfileRequest.builder()
deleteProfileRequest
- A Consumer
that will call methods on DeleteProfileRequest.Builder
to create a request.NotFoundException
- The resource is not found.ConcurrentModificationException
- There is a concurrent modification of resources.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteRoomResponse deleteRoom(DeleteRoomRequest deleteRoomRequest) throws NotFoundException, ConcurrentModificationException, AwsServiceException, SdkClientException, AlexaForBusinessException
Deletes a room by the room ARN.
deleteRoomRequest
- NotFoundException
- The resource is not found.ConcurrentModificationException
- There is a concurrent modification of resources.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteRoomResponse deleteRoom(Consumer<DeleteRoomRequest.Builder> deleteRoomRequest) throws NotFoundException, ConcurrentModificationException, AwsServiceException, SdkClientException, AlexaForBusinessException
Deletes a room by the room ARN.
This is a convenience which creates an instance of the DeleteRoomRequest.Builder
avoiding the need to
create one manually via DeleteRoomRequest.builder()
deleteRoomRequest
- A Consumer
that will call methods on DeleteRoomRequest.Builder
to create a request.NotFoundException
- The resource is not found.ConcurrentModificationException
- There is a concurrent modification of resources.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteRoomSkillParameterResponse deleteRoomSkillParameter(DeleteRoomSkillParameterRequest deleteRoomSkillParameterRequest) throws ConcurrentModificationException, AwsServiceException, SdkClientException, AlexaForBusinessException
Deletes room skill parameter details by room, skill, and parameter key ID.
deleteRoomSkillParameterRequest
- ConcurrentModificationException
- There is a concurrent modification of resources.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteRoomSkillParameterResponse deleteRoomSkillParameter(Consumer<DeleteRoomSkillParameterRequest.Builder> deleteRoomSkillParameterRequest) throws ConcurrentModificationException, AwsServiceException, SdkClientException, AlexaForBusinessException
Deletes room skill parameter details by room, skill, and parameter key ID.
This is a convenience which creates an instance of the DeleteRoomSkillParameterRequest.Builder
avoiding
the need to create one manually via DeleteRoomSkillParameterRequest.builder()
deleteRoomSkillParameterRequest
- A Consumer
that will call methods on DeleteRoomSkillParameterRequest.Builder
to create a
request.ConcurrentModificationException
- There is a concurrent modification of resources.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteSkillAuthorizationResponse deleteSkillAuthorization(DeleteSkillAuthorizationRequest deleteSkillAuthorizationRequest) throws NotFoundException, ConcurrentModificationException, AwsServiceException, SdkClientException, AlexaForBusinessException
Unlinks a third-party account from a skill.
deleteSkillAuthorizationRequest
- NotFoundException
- The resource is not found.ConcurrentModificationException
- There is a concurrent modification of resources.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteSkillAuthorizationResponse deleteSkillAuthorization(Consumer<DeleteSkillAuthorizationRequest.Builder> deleteSkillAuthorizationRequest) throws NotFoundException, ConcurrentModificationException, AwsServiceException, SdkClientException, AlexaForBusinessException
Unlinks a third-party account from a skill.
This is a convenience which creates an instance of the DeleteSkillAuthorizationRequest.Builder
avoiding
the need to create one manually via DeleteSkillAuthorizationRequest.builder()
deleteSkillAuthorizationRequest
- A Consumer
that will call methods on DeleteSkillAuthorizationRequest.Builder
to create a
request.NotFoundException
- The resource is not found.ConcurrentModificationException
- There is a concurrent modification of resources.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteSkillGroupResponse deleteSkillGroup(DeleteSkillGroupRequest deleteSkillGroupRequest) throws NotFoundException, ConcurrentModificationException, AwsServiceException, SdkClientException, AlexaForBusinessException
Deletes a skill group by skill group ARN.
deleteSkillGroupRequest
- NotFoundException
- The resource is not found.ConcurrentModificationException
- There is a concurrent modification of resources.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteSkillGroupResponse deleteSkillGroup(Consumer<DeleteSkillGroupRequest.Builder> deleteSkillGroupRequest) throws NotFoundException, ConcurrentModificationException, AwsServiceException, SdkClientException, AlexaForBusinessException
Deletes a skill group by skill group ARN.
This is a convenience which creates an instance of the DeleteSkillGroupRequest.Builder
avoiding the need
to create one manually via DeleteSkillGroupRequest.builder()
deleteSkillGroupRequest
- A Consumer
that will call methods on DeleteSkillGroupRequest.Builder
to create a request.NotFoundException
- The resource is not found.ConcurrentModificationException
- There is a concurrent modification of resources.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteUserResponse deleteUser(DeleteUserRequest deleteUserRequest) throws NotFoundException, ConcurrentModificationException, AwsServiceException, SdkClientException, AlexaForBusinessException
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteUserResponse deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest) throws NotFoundException, ConcurrentModificationException, AwsServiceException, SdkClientException, AlexaForBusinessException
Deletes a specified user by user ARN and enrollment ARN.
This is a convenience which creates an instance of the DeleteUserRequest.Builder
avoiding the need to
create one manually via DeleteUserRequest.builder()
deleteUserRequest
- A Consumer
that will call methods on DeleteUserRequest.Builder
to create a request.NotFoundException
- The resource is not found.ConcurrentModificationException
- There is a concurrent modification of resources.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DisassociateContactFromAddressBookResponse disassociateContactFromAddressBook(DisassociateContactFromAddressBookRequest disassociateContactFromAddressBookRequest) throws AwsServiceException, SdkClientException, AlexaForBusinessException
Disassociates a contact from a given address book.
disassociateContactFromAddressBookRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DisassociateContactFromAddressBookResponse disassociateContactFromAddressBook(Consumer<DisassociateContactFromAddressBookRequest.Builder> disassociateContactFromAddressBookRequest) throws AwsServiceException, SdkClientException, AlexaForBusinessException
Disassociates a contact from a given address book.
This is a convenience which creates an instance of the DisassociateContactFromAddressBookRequest.Builder
avoiding the need to create one manually via DisassociateContactFromAddressBookRequest.builder()
disassociateContactFromAddressBookRequest
- A Consumer
that will call methods on DisassociateContactFromAddressBookRequest.Builder
to
create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DisassociateDeviceFromRoomResponse disassociateDeviceFromRoom(DisassociateDeviceFromRoomRequest disassociateDeviceFromRoomRequest) throws ConcurrentModificationException, DeviceNotRegisteredException, AwsServiceException, SdkClientException, AlexaForBusinessException
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DisassociateDeviceFromRoomResponse disassociateDeviceFromRoom(Consumer<DisassociateDeviceFromRoomRequest.Builder> disassociateDeviceFromRoomRequest) throws ConcurrentModificationException, DeviceNotRegisteredException, AwsServiceException, SdkClientException, AlexaForBusinessException
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.
This is a convenience which creates an instance of the DisassociateDeviceFromRoomRequest.Builder
avoiding
the need to create one manually via DisassociateDeviceFromRoomRequest.builder()
disassociateDeviceFromRoomRequest
- A Consumer
that will call methods on DisassociateDeviceFromRoomRequest.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DisassociateSkillFromSkillGroupResponse disassociateSkillFromSkillGroup(DisassociateSkillFromSkillGroupRequest disassociateSkillFromSkillGroupRequest) throws ConcurrentModificationException, NotFoundException, AwsServiceException, SdkClientException, AlexaForBusinessException
Disassociates a skill from a skill group.
disassociateSkillFromSkillGroupRequest
- ConcurrentModificationException
- There is a concurrent modification of resources.NotFoundException
- The resource is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DisassociateSkillFromSkillGroupResponse disassociateSkillFromSkillGroup(Consumer<DisassociateSkillFromSkillGroupRequest.Builder> disassociateSkillFromSkillGroupRequest) throws ConcurrentModificationException, NotFoundException, AwsServiceException, SdkClientException, AlexaForBusinessException
Disassociates a skill from a skill group.
This is a convenience which creates an instance of the DisassociateSkillFromSkillGroupRequest.Builder
avoiding the need to create one manually via DisassociateSkillFromSkillGroupRequest.builder()
disassociateSkillFromSkillGroupRequest
- A Consumer
that will call methods on DisassociateSkillFromSkillGroupRequest.Builder
to
create a request.ConcurrentModificationException
- There is a concurrent modification of resources.NotFoundException
- The resource is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DisassociateSkillFromUsersResponse disassociateSkillFromUsers(DisassociateSkillFromUsersRequest disassociateSkillFromUsersRequest) throws ConcurrentModificationException, NotFoundException, AwsServiceException, SdkClientException, AlexaForBusinessException
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DisassociateSkillFromUsersResponse disassociateSkillFromUsers(Consumer<DisassociateSkillFromUsersRequest.Builder> disassociateSkillFromUsersRequest) throws ConcurrentModificationException, NotFoundException, AwsServiceException, SdkClientException, AlexaForBusinessException
Makes a private skill unavailable for enrolled users and prevents them from enabling it on their devices.
This is a convenience which creates an instance of the DisassociateSkillFromUsersRequest.Builder
avoiding
the need to create one manually via DisassociateSkillFromUsersRequest.builder()
disassociateSkillFromUsersRequest
- A Consumer
that will call methods on DisassociateSkillFromUsersRequest.Builder
to create a
request.ConcurrentModificationException
- There is a concurrent modification of resources.NotFoundException
- The resource is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DisassociateSkillGroupFromRoomResponse disassociateSkillGroupFromRoom(DisassociateSkillGroupFromRoomRequest disassociateSkillGroupFromRoomRequest) throws ConcurrentModificationException, AwsServiceException, SdkClientException, AlexaForBusinessException
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DisassociateSkillGroupFromRoomResponse disassociateSkillGroupFromRoom(Consumer<DisassociateSkillGroupFromRoomRequest.Builder> disassociateSkillGroupFromRoomRequest) throws ConcurrentModificationException, AwsServiceException, SdkClientException, AlexaForBusinessException
Disassociates a skill group from a specified room. This disables all skills in the skill group on all devices in the room.
This is a convenience which creates an instance of the DisassociateSkillGroupFromRoomRequest.Builder
avoiding the need to create one manually via DisassociateSkillGroupFromRoomRequest.builder()
disassociateSkillGroupFromRoomRequest
- A Consumer
that will call methods on DisassociateSkillGroupFromRoomRequest.Builder
to
create a request.ConcurrentModificationException
- There is a concurrent modification of resources.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ForgetSmartHomeAppliancesResponse forgetSmartHomeAppliances(ForgetSmartHomeAppliancesRequest forgetSmartHomeAppliancesRequest) throws NotFoundException, AwsServiceException, SdkClientException, AlexaForBusinessException
Forgets smart home appliances associated to a room.
forgetSmartHomeAppliancesRequest
- NotFoundException
- The resource is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ForgetSmartHomeAppliancesResponse forgetSmartHomeAppliances(Consumer<ForgetSmartHomeAppliancesRequest.Builder> forgetSmartHomeAppliancesRequest) throws NotFoundException, AwsServiceException, SdkClientException, AlexaForBusinessException
Forgets smart home appliances associated to a room.
This is a convenience which creates an instance of the ForgetSmartHomeAppliancesRequest.Builder
avoiding
the need to create one manually via ForgetSmartHomeAppliancesRequest.builder()
forgetSmartHomeAppliancesRequest
- A Consumer
that will call methods on ForgetSmartHomeAppliancesRequest.Builder
to create a
request.NotFoundException
- The resource is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetAddressBookResponse getAddressBook(GetAddressBookRequest getAddressBookRequest) throws NotFoundException, AwsServiceException, SdkClientException, AlexaForBusinessException
Gets address the book details by the address book ARN.
getAddressBookRequest
- NotFoundException
- The resource is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetAddressBookResponse getAddressBook(Consumer<GetAddressBookRequest.Builder> getAddressBookRequest) throws NotFoundException, AwsServiceException, SdkClientException, AlexaForBusinessException
Gets address the book details by the address book ARN.
This is a convenience which creates an instance of the GetAddressBookRequest.Builder
avoiding the need to
create one manually via GetAddressBookRequest.builder()
getAddressBookRequest
- A Consumer
that will call methods on GetAddressBookRequest.Builder
to create a request.NotFoundException
- The resource is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetConferencePreferenceResponse getConferencePreference(GetConferencePreferenceRequest getConferencePreferenceRequest) throws NotFoundException, AwsServiceException, SdkClientException, AlexaForBusinessException
Retrieves the existing conference preferences.
getConferencePreferenceRequest
- NotFoundException
- The resource is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetConferencePreferenceResponse getConferencePreference(Consumer<GetConferencePreferenceRequest.Builder> getConferencePreferenceRequest) throws NotFoundException, AwsServiceException, SdkClientException, AlexaForBusinessException
Retrieves the existing conference preferences.
This is a convenience which creates an instance of the GetConferencePreferenceRequest.Builder
avoiding
the need to create one manually via GetConferencePreferenceRequest.builder()
getConferencePreferenceRequest
- A Consumer
that will call methods on GetConferencePreferenceRequest.Builder
to create a
request.NotFoundException
- The resource is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetConferenceProviderResponse getConferenceProvider(GetConferenceProviderRequest getConferenceProviderRequest) throws NotFoundException, AwsServiceException, SdkClientException, AlexaForBusinessException
Gets details about a specific conference provider.
getConferenceProviderRequest
- NotFoundException
- The resource is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetConferenceProviderResponse getConferenceProvider(Consumer<GetConferenceProviderRequest.Builder> getConferenceProviderRequest) throws NotFoundException, AwsServiceException, SdkClientException, AlexaForBusinessException
Gets details about a specific conference provider.
This is a convenience which creates an instance of the GetConferenceProviderRequest.Builder
avoiding the
need to create one manually via GetConferenceProviderRequest.builder()
getConferenceProviderRequest
- A Consumer
that will call methods on GetConferenceProviderRequest.Builder
to create a
request.NotFoundException
- The resource is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetContactResponse getContact(GetContactRequest getContactRequest) throws NotFoundException, AwsServiceException, SdkClientException, AlexaForBusinessException
Gets the contact details by the contact ARN.
getContactRequest
- NotFoundException
- The resource is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetContactResponse getContact(Consumer<GetContactRequest.Builder> getContactRequest) throws NotFoundException, AwsServiceException, SdkClientException, AlexaForBusinessException
Gets the contact details by the contact ARN.
This is a convenience which creates an instance of the GetContactRequest.Builder
avoiding the need to
create one manually via GetContactRequest.builder()
getContactRequest
- A Consumer
that will call methods on GetContactRequest.Builder
to create a request.NotFoundException
- The resource is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetDeviceResponse getDevice(GetDeviceRequest getDeviceRequest) throws NotFoundException, AwsServiceException, SdkClientException, AlexaForBusinessException
Gets the details of a device by device ARN.
getDeviceRequest
- NotFoundException
- The resource is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetDeviceResponse getDevice(Consumer<GetDeviceRequest.Builder> getDeviceRequest) throws NotFoundException, AwsServiceException, SdkClientException, AlexaForBusinessException
Gets the details of a device by device ARN.
This is a convenience which creates an instance of the GetDeviceRequest.Builder
avoiding the need to
create one manually via GetDeviceRequest.builder()
getDeviceRequest
- A Consumer
that will call methods on GetDeviceRequest.Builder
to create a request.NotFoundException
- The resource is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetGatewayResponse getGateway(GetGatewayRequest getGatewayRequest) throws NotFoundException, AwsServiceException, SdkClientException, AlexaForBusinessException
Retrieves the details of a gateway.
getGatewayRequest
- NotFoundException
- The resource is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetGatewayResponse getGateway(Consumer<GetGatewayRequest.Builder> getGatewayRequest) throws NotFoundException, AwsServiceException, SdkClientException, AlexaForBusinessException
Retrieves the details of a gateway.
This is a convenience which creates an instance of the GetGatewayRequest.Builder
avoiding the need to
create one manually via GetGatewayRequest.builder()
getGatewayRequest
- A Consumer
that will call methods on GetGatewayRequest.Builder
to create a request.NotFoundException
- The resource is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetGatewayGroupResponse getGatewayGroup(GetGatewayGroupRequest getGatewayGroupRequest) throws NotFoundException, AwsServiceException, SdkClientException, AlexaForBusinessException
Retrieves the details of a gateway group.
getGatewayGroupRequest
- NotFoundException
- The resource is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetGatewayGroupResponse getGatewayGroup(Consumer<GetGatewayGroupRequest.Builder> getGatewayGroupRequest) throws NotFoundException, AwsServiceException, SdkClientException, AlexaForBusinessException
Retrieves the details of a gateway group.
This is a convenience which creates an instance of the GetGatewayGroupRequest.Builder
avoiding the need
to create one manually via GetGatewayGroupRequest.builder()
getGatewayGroupRequest
- A Consumer
that will call methods on GetGatewayGroupRequest.Builder
to create a request.NotFoundException
- The resource is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetInvitationConfigurationResponse getInvitationConfiguration(GetInvitationConfigurationRequest getInvitationConfigurationRequest) throws NotFoundException, AwsServiceException, SdkClientException, AlexaForBusinessException
Retrieves the configured values for the user enrollment invitation email template.
getInvitationConfigurationRequest
- NotFoundException
- The resource is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetInvitationConfigurationResponse getInvitationConfiguration(Consumer<GetInvitationConfigurationRequest.Builder> getInvitationConfigurationRequest) throws NotFoundException, AwsServiceException, SdkClientException, AlexaForBusinessException
Retrieves the configured values for the user enrollment invitation email template.
This is a convenience which creates an instance of the GetInvitationConfigurationRequest.Builder
avoiding
the need to create one manually via GetInvitationConfigurationRequest.builder()
getInvitationConfigurationRequest
- A Consumer
that will call methods on GetInvitationConfigurationRequest.Builder
to create a
request.NotFoundException
- The resource is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetNetworkProfileResponse getNetworkProfile(GetNetworkProfileRequest getNetworkProfileRequest) throws NotFoundException, InvalidSecretsManagerResourceException, AwsServiceException, SdkClientException, AlexaForBusinessException
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetNetworkProfileResponse getNetworkProfile(Consumer<GetNetworkProfileRequest.Builder> getNetworkProfileRequest) throws NotFoundException, InvalidSecretsManagerResourceException, AwsServiceException, SdkClientException, AlexaForBusinessException
Gets the network profile details by the network profile ARN.
This is a convenience which creates an instance of the GetNetworkProfileRequest.Builder
avoiding the need
to create one manually via GetNetworkProfileRequest.builder()
getNetworkProfileRequest
- A Consumer
that will call methods on GetNetworkProfileRequest.Builder
to create a request.NotFoundException
- The resource is not found.InvalidSecretsManagerResourceException
- A password in SecretsManager is in an invalid state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetProfileResponse getProfile(GetProfileRequest getProfileRequest) throws NotFoundException, AwsServiceException, SdkClientException, AlexaForBusinessException
Gets the details of a room profile by profile ARN.
getProfileRequest
- NotFoundException
- The resource is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetProfileResponse getProfile(Consumer<GetProfileRequest.Builder> getProfileRequest) throws NotFoundException, AwsServiceException, SdkClientException, AlexaForBusinessException
Gets the details of a room profile by profile ARN.
This is a convenience which creates an instance of the GetProfileRequest.Builder
avoiding the need to
create one manually via GetProfileRequest.builder()
getProfileRequest
- A Consumer
that will call methods on GetProfileRequest.Builder
to create a request.NotFoundException
- The resource is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetRoomResponse getRoom(GetRoomRequest getRoomRequest) throws NotFoundException, AwsServiceException, SdkClientException, AlexaForBusinessException
Gets room details by room ARN.
getRoomRequest
- NotFoundException
- The resource is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetRoomResponse getRoom(Consumer<GetRoomRequest.Builder> getRoomRequest) throws NotFoundException, AwsServiceException, SdkClientException, AlexaForBusinessException
Gets room details by room ARN.
This is a convenience which creates an instance of the GetRoomRequest.Builder
avoiding the need to create
one manually via GetRoomRequest.builder()
getRoomRequest
- A Consumer
that will call methods on GetRoomRequest.Builder
to create a request.NotFoundException
- The resource is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetRoomSkillParameterResponse getRoomSkillParameter(GetRoomSkillParameterRequest getRoomSkillParameterRequest) throws NotFoundException, AwsServiceException, SdkClientException, AlexaForBusinessException
Gets room skill parameter details by room, skill, and parameter key ARN.
getRoomSkillParameterRequest
- NotFoundException
- The resource is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetRoomSkillParameterResponse getRoomSkillParameter(Consumer<GetRoomSkillParameterRequest.Builder> getRoomSkillParameterRequest) throws NotFoundException, AwsServiceException, SdkClientException, AlexaForBusinessException
Gets room skill parameter details by room, skill, and parameter key ARN.
This is a convenience which creates an instance of the GetRoomSkillParameterRequest.Builder
avoiding the
need to create one manually via GetRoomSkillParameterRequest.builder()
getRoomSkillParameterRequest
- A Consumer
that will call methods on GetRoomSkillParameterRequest.Builder
to create a
request.NotFoundException
- The resource is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetSkillGroupResponse getSkillGroup(GetSkillGroupRequest getSkillGroupRequest) throws NotFoundException, AwsServiceException, SdkClientException, AlexaForBusinessException
Gets skill group details by skill group ARN.
getSkillGroupRequest
- NotFoundException
- The resource is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetSkillGroupResponse getSkillGroup(Consumer<GetSkillGroupRequest.Builder> getSkillGroupRequest) throws NotFoundException, AwsServiceException, SdkClientException, AlexaForBusinessException
Gets skill group details by skill group ARN.
This is a convenience which creates an instance of the GetSkillGroupRequest.Builder
avoiding the need to
create one manually via GetSkillGroupRequest.builder()
getSkillGroupRequest
- A Consumer
that will call methods on GetSkillGroupRequest.Builder
to create a request.NotFoundException
- The resource is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListBusinessReportSchedulesResponse listBusinessReportSchedules(ListBusinessReportSchedulesRequest listBusinessReportSchedulesRequest) throws AwsServiceException, SdkClientException, AlexaForBusinessException
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
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListBusinessReportSchedulesResponse listBusinessReportSchedules(Consumer<ListBusinessReportSchedulesRequest.Builder> listBusinessReportSchedulesRequest) throws AwsServiceException, SdkClientException, AlexaForBusinessException
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.
This is a convenience which creates an instance of the ListBusinessReportSchedulesRequest.Builder
avoiding the need to create one manually via ListBusinessReportSchedulesRequest.builder()
listBusinessReportSchedulesRequest
- A Consumer
that will call methods on ListBusinessReportSchedulesRequest.Builder
to create
a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListBusinessReportSchedulesIterable listBusinessReportSchedulesPaginator(ListBusinessReportSchedulesRequest listBusinessReportSchedulesRequest) throws AwsServiceException, SdkClientException, AlexaForBusinessException
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.
This is a variant of
listBusinessReportSchedules(software.amazon.awssdk.services.alexaforbusiness.model.ListBusinessReportSchedulesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.alexaforbusiness.paginators.ListBusinessReportSchedulesIterable responses = client.listBusinessReportSchedulesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.alexaforbusiness.paginators.ListBusinessReportSchedulesIterable responses = client .listBusinessReportSchedulesPaginator(request); for (software.amazon.awssdk.services.alexaforbusiness.model.ListBusinessReportSchedulesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.alexaforbusiness.paginators.ListBusinessReportSchedulesIterable responses = client.listBusinessReportSchedulesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBusinessReportSchedules(software.amazon.awssdk.services.alexaforbusiness.model.ListBusinessReportSchedulesRequest)
operation.
listBusinessReportSchedulesRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListBusinessReportSchedulesIterable listBusinessReportSchedulesPaginator(Consumer<ListBusinessReportSchedulesRequest.Builder> listBusinessReportSchedulesRequest) throws AwsServiceException, SdkClientException, AlexaForBusinessException
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.
This is a variant of
listBusinessReportSchedules(software.amazon.awssdk.services.alexaforbusiness.model.ListBusinessReportSchedulesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.alexaforbusiness.paginators.ListBusinessReportSchedulesIterable responses = client.listBusinessReportSchedulesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.alexaforbusiness.paginators.ListBusinessReportSchedulesIterable responses = client .listBusinessReportSchedulesPaginator(request); for (software.amazon.awssdk.services.alexaforbusiness.model.ListBusinessReportSchedulesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.alexaforbusiness.paginators.ListBusinessReportSchedulesIterable responses = client.listBusinessReportSchedulesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBusinessReportSchedules(software.amazon.awssdk.services.alexaforbusiness.model.ListBusinessReportSchedulesRequest)
operation.
This is a convenience which creates an instance of the ListBusinessReportSchedulesRequest.Builder
avoiding the need to create one manually via ListBusinessReportSchedulesRequest.builder()
listBusinessReportSchedulesRequest
- A Consumer
that will call methods on ListBusinessReportSchedulesRequest.Builder
to create
a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListConferenceProvidersResponse listConferenceProviders(ListConferenceProvidersRequest listConferenceProvidersRequest) throws AwsServiceException, SdkClientException, AlexaForBusinessException
Lists conference providers under a specific AWS account.
listConferenceProvidersRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListConferenceProvidersResponse listConferenceProviders(Consumer<ListConferenceProvidersRequest.Builder> listConferenceProvidersRequest) throws AwsServiceException, SdkClientException, AlexaForBusinessException
Lists conference providers under a specific AWS account.
This is a convenience which creates an instance of the ListConferenceProvidersRequest.Builder
avoiding
the need to create one manually via ListConferenceProvidersRequest.builder()
listConferenceProvidersRequest
- A Consumer
that will call methods on ListConferenceProvidersRequest.Builder
to create a
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListConferenceProvidersIterable listConferenceProvidersPaginator(ListConferenceProvidersRequest listConferenceProvidersRequest) throws AwsServiceException, SdkClientException, AlexaForBusinessException
Lists conference providers under a specific AWS account.
This is a variant of
listConferenceProviders(software.amazon.awssdk.services.alexaforbusiness.model.ListConferenceProvidersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.alexaforbusiness.paginators.ListConferenceProvidersIterable responses = client.listConferenceProvidersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.alexaforbusiness.paginators.ListConferenceProvidersIterable responses = client .listConferenceProvidersPaginator(request); for (software.amazon.awssdk.services.alexaforbusiness.model.ListConferenceProvidersResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.alexaforbusiness.paginators.ListConferenceProvidersIterable responses = client.listConferenceProvidersPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listConferenceProviders(software.amazon.awssdk.services.alexaforbusiness.model.ListConferenceProvidersRequest)
operation.
listConferenceProvidersRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListConferenceProvidersIterable listConferenceProvidersPaginator(Consumer<ListConferenceProvidersRequest.Builder> listConferenceProvidersRequest) throws AwsServiceException, SdkClientException, AlexaForBusinessException
Lists conference providers under a specific AWS account.
This is a variant of
listConferenceProviders(software.amazon.awssdk.services.alexaforbusiness.model.ListConferenceProvidersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.alexaforbusiness.paginators.ListConferenceProvidersIterable responses = client.listConferenceProvidersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.alexaforbusiness.paginators.ListConferenceProvidersIterable responses = client .listConferenceProvidersPaginator(request); for (software.amazon.awssdk.services.alexaforbusiness.model.ListConferenceProvidersResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.alexaforbusiness.paginators.ListConferenceProvidersIterable responses = client.listConferenceProvidersPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listConferenceProviders(software.amazon.awssdk.services.alexaforbusiness.model.ListConferenceProvidersRequest)
operation.
This is a convenience which creates an instance of the ListConferenceProvidersRequest.Builder
avoiding
the need to create one manually via ListConferenceProvidersRequest.builder()
listConferenceProvidersRequest
- A Consumer
that will call methods on ListConferenceProvidersRequest.Builder
to create a
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListDeviceEventsResponse listDeviceEvents(ListDeviceEventsRequest listDeviceEventsRequest) throws NotFoundException, AwsServiceException, SdkClientException, AlexaForBusinessException
Lists the device event history, including device connection status, for up to 30 days.
listDeviceEventsRequest
- NotFoundException
- The resource is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListDeviceEventsResponse listDeviceEvents(Consumer<ListDeviceEventsRequest.Builder> listDeviceEventsRequest) throws NotFoundException, AwsServiceException, SdkClientException, AlexaForBusinessException
Lists the device event history, including device connection status, for up to 30 days.
This is a convenience which creates an instance of the ListDeviceEventsRequest.Builder
avoiding the need
to create one manually via ListDeviceEventsRequest.builder()
listDeviceEventsRequest
- A Consumer
that will call methods on ListDeviceEventsRequest.Builder
to create a request.NotFoundException
- The resource is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListDeviceEventsIterable listDeviceEventsPaginator(ListDeviceEventsRequest listDeviceEventsRequest) throws NotFoundException, AwsServiceException, SdkClientException, AlexaForBusinessException
Lists the device event history, including device connection status, for up to 30 days.
This is a variant of
listDeviceEvents(software.amazon.awssdk.services.alexaforbusiness.model.ListDeviceEventsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.alexaforbusiness.paginators.ListDeviceEventsIterable responses = client.listDeviceEventsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.alexaforbusiness.paginators.ListDeviceEventsIterable responses = client .listDeviceEventsPaginator(request); for (software.amazon.awssdk.services.alexaforbusiness.model.ListDeviceEventsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.alexaforbusiness.paginators.ListDeviceEventsIterable responses = client.listDeviceEventsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDeviceEvents(software.amazon.awssdk.services.alexaforbusiness.model.ListDeviceEventsRequest)
operation.
listDeviceEventsRequest
- NotFoundException
- The resource is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListDeviceEventsIterable listDeviceEventsPaginator(Consumer<ListDeviceEventsRequest.Builder> listDeviceEventsRequest) throws NotFoundException, AwsServiceException, SdkClientException, AlexaForBusinessException
Lists the device event history, including device connection status, for up to 30 days.
This is a variant of
listDeviceEvents(software.amazon.awssdk.services.alexaforbusiness.model.ListDeviceEventsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.alexaforbusiness.paginators.ListDeviceEventsIterable responses = client.listDeviceEventsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.alexaforbusiness.paginators.ListDeviceEventsIterable responses = client .listDeviceEventsPaginator(request); for (software.amazon.awssdk.services.alexaforbusiness.model.ListDeviceEventsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.alexaforbusiness.paginators.ListDeviceEventsIterable responses = client.listDeviceEventsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDeviceEvents(software.amazon.awssdk.services.alexaforbusiness.model.ListDeviceEventsRequest)
operation.
This is a convenience which creates an instance of the ListDeviceEventsRequest.Builder
avoiding the need
to create one manually via ListDeviceEventsRequest.builder()
listDeviceEventsRequest
- A Consumer
that will call methods on ListDeviceEventsRequest.Builder
to create a request.NotFoundException
- The resource is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListGatewayGroupsResponse listGatewayGroups(ListGatewayGroupsRequest listGatewayGroupsRequest) throws AwsServiceException, SdkClientException, AlexaForBusinessException
Retrieves a list of gateway group summaries. Use GetGatewayGroup to retrieve details of a specific gateway group.
listGatewayGroupsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListGatewayGroupsResponse listGatewayGroups(Consumer<ListGatewayGroupsRequest.Builder> listGatewayGroupsRequest) throws AwsServiceException, SdkClientException, AlexaForBusinessException
Retrieves a list of gateway group summaries. Use GetGatewayGroup to retrieve details of a specific gateway group.
This is a convenience which creates an instance of the ListGatewayGroupsRequest.Builder
avoiding the need
to create one manually via ListGatewayGroupsRequest.builder()
listGatewayGroupsRequest
- A Consumer
that will call methods on ListGatewayGroupsRequest.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListGatewayGroupsIterable listGatewayGroupsPaginator(ListGatewayGroupsRequest listGatewayGroupsRequest) throws AwsServiceException, SdkClientException, AlexaForBusinessException
Retrieves a list of gateway group summaries. Use GetGatewayGroup to retrieve details of a specific gateway group.
This is a variant of
listGatewayGroups(software.amazon.awssdk.services.alexaforbusiness.model.ListGatewayGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.alexaforbusiness.paginators.ListGatewayGroupsIterable responses = client.listGatewayGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.alexaforbusiness.paginators.ListGatewayGroupsIterable responses = client .listGatewayGroupsPaginator(request); for (software.amazon.awssdk.services.alexaforbusiness.model.ListGatewayGroupsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.alexaforbusiness.paginators.ListGatewayGroupsIterable responses = client.listGatewayGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGatewayGroups(software.amazon.awssdk.services.alexaforbusiness.model.ListGatewayGroupsRequest)
operation.
listGatewayGroupsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListGatewayGroupsIterable listGatewayGroupsPaginator(Consumer<ListGatewayGroupsRequest.Builder> listGatewayGroupsRequest) throws AwsServiceException, SdkClientException, AlexaForBusinessException
Retrieves a list of gateway group summaries. Use GetGatewayGroup to retrieve details of a specific gateway group.
This is a variant of
listGatewayGroups(software.amazon.awssdk.services.alexaforbusiness.model.ListGatewayGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.alexaforbusiness.paginators.ListGatewayGroupsIterable responses = client.listGatewayGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.alexaforbusiness.paginators.ListGatewayGroupsIterable responses = client .listGatewayGroupsPaginator(request); for (software.amazon.awssdk.services.alexaforbusiness.model.ListGatewayGroupsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.alexaforbusiness.paginators.ListGatewayGroupsIterable responses = client.listGatewayGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGatewayGroups(software.amazon.awssdk.services.alexaforbusiness.model.ListGatewayGroupsRequest)
operation.
This is a convenience which creates an instance of the ListGatewayGroupsRequest.Builder
avoiding the need
to create one manually via ListGatewayGroupsRequest.builder()
listGatewayGroupsRequest
- A Consumer
that will call methods on ListGatewayGroupsRequest.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListGatewaysResponse listGateways(ListGatewaysRequest listGatewaysRequest) throws AwsServiceException, SdkClientException, AlexaForBusinessException
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
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListGatewaysResponse listGateways(Consumer<ListGatewaysRequest.Builder> listGatewaysRequest) throws AwsServiceException, SdkClientException, AlexaForBusinessException
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.
This is a convenience which creates an instance of the ListGatewaysRequest.Builder
avoiding the need to
create one manually via ListGatewaysRequest.builder()
listGatewaysRequest
- A Consumer
that will call methods on ListGatewaysRequest.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListGatewaysIterable listGatewaysPaginator(ListGatewaysRequest listGatewaysRequest) throws AwsServiceException, SdkClientException, AlexaForBusinessException
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.
This is a variant of
listGateways(software.amazon.awssdk.services.alexaforbusiness.model.ListGatewaysRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.alexaforbusiness.paginators.ListGatewaysIterable responses = client.listGatewaysPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.alexaforbusiness.paginators.ListGatewaysIterable responses = client .listGatewaysPaginator(request); for (software.amazon.awssdk.services.alexaforbusiness.model.ListGatewaysResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.alexaforbusiness.paginators.ListGatewaysIterable responses = client.listGatewaysPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGateways(software.amazon.awssdk.services.alexaforbusiness.model.ListGatewaysRequest)
operation.
listGatewaysRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListGatewaysIterable listGatewaysPaginator(Consumer<ListGatewaysRequest.Builder> listGatewaysRequest) throws AwsServiceException, SdkClientException, AlexaForBusinessException
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.
This is a variant of
listGateways(software.amazon.awssdk.services.alexaforbusiness.model.ListGatewaysRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.alexaforbusiness.paginators.ListGatewaysIterable responses = client.listGatewaysPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.alexaforbusiness.paginators.ListGatewaysIterable responses = client .listGatewaysPaginator(request); for (software.amazon.awssdk.services.alexaforbusiness.model.ListGatewaysResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.alexaforbusiness.paginators.ListGatewaysIterable responses = client.listGatewaysPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGateways(software.amazon.awssdk.services.alexaforbusiness.model.ListGatewaysRequest)
operation.
This is a convenience which creates an instance of the ListGatewaysRequest.Builder
avoiding the need to
create one manually via ListGatewaysRequest.builder()
listGatewaysRequest
- A Consumer
that will call methods on ListGatewaysRequest.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListSkillsResponse listSkills(ListSkillsRequest listSkillsRequest) throws AwsServiceException, SdkClientException, AlexaForBusinessException
Lists all enabled skills in a specific skill group.
listSkillsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListSkillsResponse listSkills(Consumer<ListSkillsRequest.Builder> listSkillsRequest) throws AwsServiceException, SdkClientException, AlexaForBusinessException
Lists all enabled skills in a specific skill group.
This is a convenience which creates an instance of the ListSkillsRequest.Builder
avoiding the need to
create one manually via ListSkillsRequest.builder()
listSkillsRequest
- A Consumer
that will call methods on ListSkillsRequest.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListSkillsIterable listSkillsPaginator(ListSkillsRequest listSkillsRequest) throws AwsServiceException, SdkClientException, AlexaForBusinessException
Lists all enabled skills in a specific skill group.
This is a variant of
listSkills(software.amazon.awssdk.services.alexaforbusiness.model.ListSkillsRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.alexaforbusiness.paginators.ListSkillsIterable responses = client.listSkillsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.alexaforbusiness.paginators.ListSkillsIterable responses = client .listSkillsPaginator(request); for (software.amazon.awssdk.services.alexaforbusiness.model.ListSkillsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.alexaforbusiness.paginators.ListSkillsIterable responses = client.listSkillsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSkills(software.amazon.awssdk.services.alexaforbusiness.model.ListSkillsRequest)
operation.
listSkillsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListSkillsIterable listSkillsPaginator(Consumer<ListSkillsRequest.Builder> listSkillsRequest) throws AwsServiceException, SdkClientException, AlexaForBusinessException
Lists all enabled skills in a specific skill group.
This is a variant of
listSkills(software.amazon.awssdk.services.alexaforbusiness.model.ListSkillsRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.alexaforbusiness.paginators.ListSkillsIterable responses = client.listSkillsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.alexaforbusiness.paginators.ListSkillsIterable responses = client .listSkillsPaginator(request); for (software.amazon.awssdk.services.alexaforbusiness.model.ListSkillsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.alexaforbusiness.paginators.ListSkillsIterable responses = client.listSkillsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSkills(software.amazon.awssdk.services.alexaforbusiness.model.ListSkillsRequest)
operation.
This is a convenience which creates an instance of the ListSkillsRequest.Builder
avoiding the need to
create one manually via ListSkillsRequest.builder()
listSkillsRequest
- A Consumer
that will call methods on ListSkillsRequest.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListSkillsStoreCategoriesResponse listSkillsStoreCategories(ListSkillsStoreCategoriesRequest listSkillsStoreCategoriesRequest) throws AwsServiceException, SdkClientException, AlexaForBusinessException
Lists all categories in the Alexa skill store.
listSkillsStoreCategoriesRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListSkillsStoreCategoriesResponse listSkillsStoreCategories(Consumer<ListSkillsStoreCategoriesRequest.Builder> listSkillsStoreCategoriesRequest) throws AwsServiceException, SdkClientException, AlexaForBusinessException
Lists all categories in the Alexa skill store.
This is a convenience which creates an instance of the ListSkillsStoreCategoriesRequest.Builder
avoiding
the need to create one manually via ListSkillsStoreCategoriesRequest.builder()
listSkillsStoreCategoriesRequest
- A Consumer
that will call methods on ListSkillsStoreCategoriesRequest.Builder
to create a
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListSkillsStoreCategoriesIterable listSkillsStoreCategoriesPaginator(ListSkillsStoreCategoriesRequest listSkillsStoreCategoriesRequest) throws AwsServiceException, SdkClientException, AlexaForBusinessException
Lists all categories in the Alexa skill store.
This is a variant of
listSkillsStoreCategories(software.amazon.awssdk.services.alexaforbusiness.model.ListSkillsStoreCategoriesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.alexaforbusiness.paginators.ListSkillsStoreCategoriesIterable responses = client.listSkillsStoreCategoriesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.alexaforbusiness.paginators.ListSkillsStoreCategoriesIterable responses = client .listSkillsStoreCategoriesPaginator(request); for (software.amazon.awssdk.services.alexaforbusiness.model.ListSkillsStoreCategoriesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.alexaforbusiness.paginators.ListSkillsStoreCategoriesIterable responses = client.listSkillsStoreCategoriesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSkillsStoreCategories(software.amazon.awssdk.services.alexaforbusiness.model.ListSkillsStoreCategoriesRequest)
operation.
listSkillsStoreCategoriesRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListSkillsStoreCategoriesIterable listSkillsStoreCategoriesPaginator(Consumer<ListSkillsStoreCategoriesRequest.Builder> listSkillsStoreCategoriesRequest) throws AwsServiceException, SdkClientException, AlexaForBusinessException
Lists all categories in the Alexa skill store.
This is a variant of
listSkillsStoreCategories(software.amazon.awssdk.services.alexaforbusiness.model.ListSkillsStoreCategoriesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.alexaforbusiness.paginators.ListSkillsStoreCategoriesIterable responses = client.listSkillsStoreCategoriesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.alexaforbusiness.paginators.ListSkillsStoreCategoriesIterable responses = client .listSkillsStoreCategoriesPaginator(request); for (software.amazon.awssdk.services.alexaforbusiness.model.ListSkillsStoreCategoriesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.alexaforbusiness.paginators.ListSkillsStoreCategoriesIterable responses = client.listSkillsStoreCategoriesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSkillsStoreCategories(software.amazon.awssdk.services.alexaforbusiness.model.ListSkillsStoreCategoriesRequest)
operation.
This is a convenience which creates an instance of the ListSkillsStoreCategoriesRequest.Builder
avoiding
the need to create one manually via ListSkillsStoreCategoriesRequest.builder()
listSkillsStoreCategoriesRequest
- A Consumer
that will call methods on ListSkillsStoreCategoriesRequest.Builder
to create a
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListSkillsStoreSkillsByCategoryResponse listSkillsStoreSkillsByCategory(ListSkillsStoreSkillsByCategoryRequest listSkillsStoreSkillsByCategoryRequest) throws AwsServiceException, SdkClientException, AlexaForBusinessException
Lists all skills in the Alexa skill store by category.
listSkillsStoreSkillsByCategoryRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListSkillsStoreSkillsByCategoryResponse listSkillsStoreSkillsByCategory(Consumer<ListSkillsStoreSkillsByCategoryRequest.Builder> listSkillsStoreSkillsByCategoryRequest) throws AwsServiceException, SdkClientException, AlexaForBusinessException
Lists all skills in the Alexa skill store by category.
This is a convenience which creates an instance of the ListSkillsStoreSkillsByCategoryRequest.Builder
avoiding the need to create one manually via ListSkillsStoreSkillsByCategoryRequest.builder()
listSkillsStoreSkillsByCategoryRequest
- A Consumer
that will call methods on ListSkillsStoreSkillsByCategoryRequest.Builder
to
create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListSkillsStoreSkillsByCategoryIterable listSkillsStoreSkillsByCategoryPaginator(ListSkillsStoreSkillsByCategoryRequest listSkillsStoreSkillsByCategoryRequest) throws AwsServiceException, SdkClientException, AlexaForBusinessException
Lists all skills in the Alexa skill store by category.
This is a variant of
listSkillsStoreSkillsByCategory(software.amazon.awssdk.services.alexaforbusiness.model.ListSkillsStoreSkillsByCategoryRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.alexaforbusiness.paginators.ListSkillsStoreSkillsByCategoryIterable responses = client.listSkillsStoreSkillsByCategoryPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.alexaforbusiness.paginators.ListSkillsStoreSkillsByCategoryIterable responses = client .listSkillsStoreSkillsByCategoryPaginator(request); for (software.amazon.awssdk.services.alexaforbusiness.model.ListSkillsStoreSkillsByCategoryResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.alexaforbusiness.paginators.ListSkillsStoreSkillsByCategoryIterable responses = client.listSkillsStoreSkillsByCategoryPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSkillsStoreSkillsByCategory(software.amazon.awssdk.services.alexaforbusiness.model.ListSkillsStoreSkillsByCategoryRequest)
operation.
listSkillsStoreSkillsByCategoryRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListSkillsStoreSkillsByCategoryIterable listSkillsStoreSkillsByCategoryPaginator(Consumer<ListSkillsStoreSkillsByCategoryRequest.Builder> listSkillsStoreSkillsByCategoryRequest) throws AwsServiceException, SdkClientException, AlexaForBusinessException
Lists all skills in the Alexa skill store by category.
This is a variant of
listSkillsStoreSkillsByCategory(software.amazon.awssdk.services.alexaforbusiness.model.ListSkillsStoreSkillsByCategoryRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.alexaforbusiness.paginators.ListSkillsStoreSkillsByCategoryIterable responses = client.listSkillsStoreSkillsByCategoryPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.alexaforbusiness.paginators.ListSkillsStoreSkillsByCategoryIterable responses = client .listSkillsStoreSkillsByCategoryPaginator(request); for (software.amazon.awssdk.services.alexaforbusiness.model.ListSkillsStoreSkillsByCategoryResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.alexaforbusiness.paginators.ListSkillsStoreSkillsByCategoryIterable responses = client.listSkillsStoreSkillsByCategoryPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSkillsStoreSkillsByCategory(software.amazon.awssdk.services.alexaforbusiness.model.ListSkillsStoreSkillsByCategoryRequest)
operation.
This is a convenience which creates an instance of the ListSkillsStoreSkillsByCategoryRequest.Builder
avoiding the need to create one manually via ListSkillsStoreSkillsByCategoryRequest.builder()
listSkillsStoreSkillsByCategoryRequest
- A Consumer
that will call methods on ListSkillsStoreSkillsByCategoryRequest.Builder
to
create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListSmartHomeAppliancesResponse listSmartHomeAppliances(ListSmartHomeAppliancesRequest listSmartHomeAppliancesRequest) throws NotFoundException, AwsServiceException, SdkClientException, AlexaForBusinessException
Lists all of the smart home appliances associated with a room.
listSmartHomeAppliancesRequest
- NotFoundException
- The resource is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListSmartHomeAppliancesResponse listSmartHomeAppliances(Consumer<ListSmartHomeAppliancesRequest.Builder> listSmartHomeAppliancesRequest) throws NotFoundException, AwsServiceException, SdkClientException, AlexaForBusinessException
Lists all of the smart home appliances associated with a room.
This is a convenience which creates an instance of the ListSmartHomeAppliancesRequest.Builder
avoiding
the need to create one manually via ListSmartHomeAppliancesRequest.builder()
listSmartHomeAppliancesRequest
- A Consumer
that will call methods on ListSmartHomeAppliancesRequest.Builder
to create a
request.NotFoundException
- The resource is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListSmartHomeAppliancesIterable listSmartHomeAppliancesPaginator(ListSmartHomeAppliancesRequest listSmartHomeAppliancesRequest) throws NotFoundException, AwsServiceException, SdkClientException, AlexaForBusinessException
Lists all of the smart home appliances associated with a room.
This is a variant of
listSmartHomeAppliances(software.amazon.awssdk.services.alexaforbusiness.model.ListSmartHomeAppliancesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.alexaforbusiness.paginators.ListSmartHomeAppliancesIterable responses = client.listSmartHomeAppliancesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.alexaforbusiness.paginators.ListSmartHomeAppliancesIterable responses = client .listSmartHomeAppliancesPaginator(request); for (software.amazon.awssdk.services.alexaforbusiness.model.ListSmartHomeAppliancesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.alexaforbusiness.paginators.ListSmartHomeAppliancesIterable responses = client.listSmartHomeAppliancesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSmartHomeAppliances(software.amazon.awssdk.services.alexaforbusiness.model.ListSmartHomeAppliancesRequest)
operation.
listSmartHomeAppliancesRequest
- NotFoundException
- The resource is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListSmartHomeAppliancesIterable listSmartHomeAppliancesPaginator(Consumer<ListSmartHomeAppliancesRequest.Builder> listSmartHomeAppliancesRequest) throws NotFoundException, AwsServiceException, SdkClientException, AlexaForBusinessException
Lists all of the smart home appliances associated with a room.
This is a variant of
listSmartHomeAppliances(software.amazon.awssdk.services.alexaforbusiness.model.ListSmartHomeAppliancesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.alexaforbusiness.paginators.ListSmartHomeAppliancesIterable responses = client.listSmartHomeAppliancesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.alexaforbusiness.paginators.ListSmartHomeAppliancesIterable responses = client .listSmartHomeAppliancesPaginator(request); for (software.amazon.awssdk.services.alexaforbusiness.model.ListSmartHomeAppliancesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.alexaforbusiness.paginators.ListSmartHomeAppliancesIterable responses = client.listSmartHomeAppliancesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSmartHomeAppliances(software.amazon.awssdk.services.alexaforbusiness.model.ListSmartHomeAppliancesRequest)
operation.
This is a convenience which creates an instance of the ListSmartHomeAppliancesRequest.Builder
avoiding
the need to create one manually via ListSmartHomeAppliancesRequest.builder()
listSmartHomeAppliancesRequest
- A Consumer
that will call methods on ListSmartHomeAppliancesRequest.Builder
to create a
request.NotFoundException
- The resource is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTagsResponse listTags(ListTagsRequest listTagsRequest) throws NotFoundException, AwsServiceException, SdkClientException, AlexaForBusinessException
Lists all tags for the specified resource.
listTagsRequest
- NotFoundException
- The resource is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTagsResponse listTags(Consumer<ListTagsRequest.Builder> listTagsRequest) throws NotFoundException, AwsServiceException, SdkClientException, AlexaForBusinessException
Lists all tags for the specified resource.
This is a convenience which creates an instance of the ListTagsRequest.Builder
avoiding the need to
create one manually via ListTagsRequest.builder()
listTagsRequest
- A Consumer
that will call methods on ListTagsRequest.Builder
to create a request.NotFoundException
- The resource is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTagsIterable listTagsPaginator(ListTagsRequest listTagsRequest) throws NotFoundException, AwsServiceException, SdkClientException, AlexaForBusinessException
Lists all tags for the specified resource.
This is a variant of listTags(software.amazon.awssdk.services.alexaforbusiness.model.ListTagsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.alexaforbusiness.paginators.ListTagsIterable responses = client.listTagsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.alexaforbusiness.paginators.ListTagsIterable responses = client.listTagsPaginator(request); for (software.amazon.awssdk.services.alexaforbusiness.model.ListTagsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.alexaforbusiness.paginators.ListTagsIterable responses = client.listTagsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTags(software.amazon.awssdk.services.alexaforbusiness.model.ListTagsRequest)
operation.
listTagsRequest
- NotFoundException
- The resource is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTagsIterable listTagsPaginator(Consumer<ListTagsRequest.Builder> listTagsRequest) throws NotFoundException, AwsServiceException, SdkClientException, AlexaForBusinessException
Lists all tags for the specified resource.
This is a variant of listTags(software.amazon.awssdk.services.alexaforbusiness.model.ListTagsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.alexaforbusiness.paginators.ListTagsIterable responses = client.listTagsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.alexaforbusiness.paginators.ListTagsIterable responses = client.listTagsPaginator(request); for (software.amazon.awssdk.services.alexaforbusiness.model.ListTagsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.alexaforbusiness.paginators.ListTagsIterable responses = client.listTagsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTags(software.amazon.awssdk.services.alexaforbusiness.model.ListTagsRequest)
operation.
This is a convenience which creates an instance of the ListTagsRequest.Builder
avoiding the need to
create one manually via ListTagsRequest.builder()
listTagsRequest
- A Consumer
that will call methods on ListTagsRequest.Builder
to create a request.NotFoundException
- The resource is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutConferencePreferenceResponse putConferencePreference(PutConferencePreferenceRequest putConferencePreferenceRequest) throws NotFoundException, AwsServiceException, SdkClientException, AlexaForBusinessException
Sets the conference preferences on a specific conference provider at the account level.
putConferencePreferenceRequest
- NotFoundException
- The resource is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutConferencePreferenceResponse putConferencePreference(Consumer<PutConferencePreferenceRequest.Builder> putConferencePreferenceRequest) throws NotFoundException, AwsServiceException, SdkClientException, AlexaForBusinessException
Sets the conference preferences on a specific conference provider at the account level.
This is a convenience which creates an instance of the PutConferencePreferenceRequest.Builder
avoiding
the need to create one manually via PutConferencePreferenceRequest.builder()
putConferencePreferenceRequest
- A Consumer
that will call methods on PutConferencePreferenceRequest.Builder
to create a
request.NotFoundException
- The resource is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutInvitationConfigurationResponse putInvitationConfiguration(PutInvitationConfigurationRequest putInvitationConfigurationRequest) throws NotFoundException, ConcurrentModificationException, AwsServiceException, SdkClientException, AlexaForBusinessException
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutInvitationConfigurationResponse putInvitationConfiguration(Consumer<PutInvitationConfigurationRequest.Builder> putInvitationConfigurationRequest) throws NotFoundException, ConcurrentModificationException, AwsServiceException, SdkClientException, AlexaForBusinessException
Configures the email template for the user enrollment invitation with the specified attributes.
This is a convenience which creates an instance of the PutInvitationConfigurationRequest.Builder
avoiding
the need to create one manually via PutInvitationConfigurationRequest.builder()
putInvitationConfigurationRequest
- A Consumer
that will call methods on PutInvitationConfigurationRequest.Builder
to create a
request.NotFoundException
- The resource is not found.ConcurrentModificationException
- There is a concurrent modification of resources.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutRoomSkillParameterResponse putRoomSkillParameter(PutRoomSkillParameterRequest putRoomSkillParameterRequest) throws ConcurrentModificationException, AwsServiceException, SdkClientException, AlexaForBusinessException
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutRoomSkillParameterResponse putRoomSkillParameter(Consumer<PutRoomSkillParameterRequest.Builder> putRoomSkillParameterRequest) throws ConcurrentModificationException, AwsServiceException, SdkClientException, AlexaForBusinessException
Updates room skill parameter details by room, skill, and parameter key ID. Not all skills have a room skill parameter.
This is a convenience which creates an instance of the PutRoomSkillParameterRequest.Builder
avoiding the
need to create one manually via PutRoomSkillParameterRequest.builder()
putRoomSkillParameterRequest
- A Consumer
that will call methods on PutRoomSkillParameterRequest.Builder
to create a
request.ConcurrentModificationException
- There is a concurrent modification of resources.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutSkillAuthorizationResponse putSkillAuthorization(PutSkillAuthorizationRequest putSkillAuthorizationRequest) throws UnauthorizedException, ConcurrentModificationException, AwsServiceException, SdkClientException, AlexaForBusinessException
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutSkillAuthorizationResponse putSkillAuthorization(Consumer<PutSkillAuthorizationRequest.Builder> putSkillAuthorizationRequest) throws UnauthorizedException, ConcurrentModificationException, AwsServiceException, SdkClientException, AlexaForBusinessException
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.
This is a convenience which creates an instance of the PutSkillAuthorizationRequest.Builder
avoiding the
need to create one manually via PutSkillAuthorizationRequest.builder()
putSkillAuthorizationRequest
- A Consumer
that will call methods on PutSkillAuthorizationRequest.Builder
to create a
request.UnauthorizedException
- The caller has no permissions to operate on the resource involved in the API call.ConcurrentModificationException
- There is a concurrent modification of resources.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RegisterAvsDeviceResponse registerAVSDevice(RegisterAvsDeviceRequest registerAvsDeviceRequest) throws LimitExceededException, ConcurrentModificationException, NotFoundException, InvalidDeviceException, AwsServiceException, SdkClientException, AlexaForBusinessException
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RegisterAvsDeviceResponse registerAVSDevice(Consumer<RegisterAvsDeviceRequest.Builder> registerAvsDeviceRequest) throws LimitExceededException, ConcurrentModificationException, NotFoundException, InvalidDeviceException, AwsServiceException, SdkClientException, AlexaForBusinessException
Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service (AVS).
This is a convenience which creates an instance of the RegisterAvsDeviceRequest.Builder
avoiding the need
to create one manually via RegisterAvsDeviceRequest.builder()
registerAvsDeviceRequest
- A Consumer
that will call methods on RegisterAVSDeviceRequest.Builder
to create a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RejectSkillResponse rejectSkill(RejectSkillRequest rejectSkillRequest) throws ConcurrentModificationException, NotFoundException, AwsServiceException, SdkClientException, AlexaForBusinessException
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RejectSkillResponse rejectSkill(Consumer<RejectSkillRequest.Builder> rejectSkillRequest) throws ConcurrentModificationException, NotFoundException, AwsServiceException, SdkClientException, AlexaForBusinessException
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.
This is a convenience which creates an instance of the RejectSkillRequest.Builder
avoiding the need to
create one manually via RejectSkillRequest.builder()
rejectSkillRequest
- A Consumer
that will call methods on RejectSkillRequest.Builder
to create a request.ConcurrentModificationException
- There is a concurrent modification of resources.NotFoundException
- The resource is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ResolveRoomResponse resolveRoom(ResolveRoomRequest resolveRoomRequest) throws NotFoundException, AwsServiceException, SdkClientException, AlexaForBusinessException
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ResolveRoomResponse resolveRoom(Consumer<ResolveRoomRequest.Builder> resolveRoomRequest) throws NotFoundException, AwsServiceException, SdkClientException, AlexaForBusinessException
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.
This is a convenience which creates an instance of the ResolveRoomRequest.Builder
avoiding the need to
create one manually via ResolveRoomRequest.builder()
resolveRoomRequest
- A Consumer
that will call methods on ResolveRoomRequest.Builder
to create a request.NotFoundException
- The resource is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RevokeInvitationResponse revokeInvitation(RevokeInvitationRequest revokeInvitationRequest) throws NotFoundException, ConcurrentModificationException, AwsServiceException, SdkClientException, AlexaForBusinessException
Revokes an invitation and invalidates the enrollment URL.
revokeInvitationRequest
- NotFoundException
- The resource is not found.ConcurrentModificationException
- There is a concurrent modification of resources.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RevokeInvitationResponse revokeInvitation(Consumer<RevokeInvitationRequest.Builder> revokeInvitationRequest) throws NotFoundException, ConcurrentModificationException, AwsServiceException, SdkClientException, AlexaForBusinessException
Revokes an invitation and invalidates the enrollment URL.
This is a convenience which creates an instance of the RevokeInvitationRequest.Builder
avoiding the need
to create one manually via RevokeInvitationRequest.builder()
revokeInvitationRequest
- A Consumer
that will call methods on RevokeInvitationRequest.Builder
to create a request.NotFoundException
- The resource is not found.ConcurrentModificationException
- There is a concurrent modification of resources.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SearchAddressBooksResponse searchAddressBooks(SearchAddressBooksRequest searchAddressBooksRequest) throws AwsServiceException, SdkClientException, AlexaForBusinessException
Searches address books and lists the ones that meet a set of filter and sort criteria.
searchAddressBooksRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SearchAddressBooksResponse searchAddressBooks(Consumer<SearchAddressBooksRequest.Builder> searchAddressBooksRequest) throws AwsServiceException, SdkClientException, AlexaForBusinessException
Searches address books and lists the ones that meet a set of filter and sort criteria.
This is a convenience which creates an instance of the SearchAddressBooksRequest.Builder
avoiding the
need to create one manually via SearchAddressBooksRequest.builder()
searchAddressBooksRequest
- A Consumer
that will call methods on SearchAddressBooksRequest.Builder
to create a
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SearchAddressBooksIterable searchAddressBooksPaginator(SearchAddressBooksRequest searchAddressBooksRequest) throws AwsServiceException, SdkClientException, AlexaForBusinessException
Searches address books and lists the ones that meet a set of filter and sort criteria.
This is a variant of
searchAddressBooks(software.amazon.awssdk.services.alexaforbusiness.model.SearchAddressBooksRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.alexaforbusiness.paginators.SearchAddressBooksIterable responses = client.searchAddressBooksPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.alexaforbusiness.paginators.SearchAddressBooksIterable responses = client .searchAddressBooksPaginator(request); for (software.amazon.awssdk.services.alexaforbusiness.model.SearchAddressBooksResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.alexaforbusiness.paginators.SearchAddressBooksIterable responses = client.searchAddressBooksPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchAddressBooks(software.amazon.awssdk.services.alexaforbusiness.model.SearchAddressBooksRequest)
operation.
searchAddressBooksRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SearchAddressBooksIterable searchAddressBooksPaginator(Consumer<SearchAddressBooksRequest.Builder> searchAddressBooksRequest) throws AwsServiceException, SdkClientException, AlexaForBusinessException
Searches address books and lists the ones that meet a set of filter and sort criteria.
This is a variant of
searchAddressBooks(software.amazon.awssdk.services.alexaforbusiness.model.SearchAddressBooksRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.alexaforbusiness.paginators.SearchAddressBooksIterable responses = client.searchAddressBooksPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.alexaforbusiness.paginators.SearchAddressBooksIterable responses = client .searchAddressBooksPaginator(request); for (software.amazon.awssdk.services.alexaforbusiness.model.SearchAddressBooksResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.alexaforbusiness.paginators.SearchAddressBooksIterable responses = client.searchAddressBooksPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchAddressBooks(software.amazon.awssdk.services.alexaforbusiness.model.SearchAddressBooksRequest)
operation.
This is a convenience which creates an instance of the SearchAddressBooksRequest.Builder
avoiding the
need to create one manually via SearchAddressBooksRequest.builder()
searchAddressBooksRequest
- A Consumer
that will call methods on SearchAddressBooksRequest.Builder
to create a
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SearchContactsResponse searchContacts(SearchContactsRequest searchContactsRequest) throws AwsServiceException, SdkClientException, AlexaForBusinessException
Searches contacts and lists the ones that meet a set of filter and sort criteria.
searchContactsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SearchContactsResponse searchContacts(Consumer<SearchContactsRequest.Builder> searchContactsRequest) throws AwsServiceException, SdkClientException, AlexaForBusinessException
Searches contacts and lists the ones that meet a set of filter and sort criteria.
This is a convenience which creates an instance of the SearchContactsRequest.Builder
avoiding the need to
create one manually via SearchContactsRequest.builder()
searchContactsRequest
- A Consumer
that will call methods on SearchContactsRequest.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SearchContactsIterable searchContactsPaginator(SearchContactsRequest searchContactsRequest) throws AwsServiceException, SdkClientException, AlexaForBusinessException
Searches contacts and lists the ones that meet a set of filter and sort criteria.
This is a variant of
searchContacts(software.amazon.awssdk.services.alexaforbusiness.model.SearchContactsRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.alexaforbusiness.paginators.SearchContactsIterable responses = client.searchContactsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.alexaforbusiness.paginators.SearchContactsIterable responses = client .searchContactsPaginator(request); for (software.amazon.awssdk.services.alexaforbusiness.model.SearchContactsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.alexaforbusiness.paginators.SearchContactsIterable responses = client.searchContactsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchContacts(software.amazon.awssdk.services.alexaforbusiness.model.SearchContactsRequest)
operation.
searchContactsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SearchContactsIterable searchContactsPaginator(Consumer<SearchContactsRequest.Builder> searchContactsRequest) throws AwsServiceException, SdkClientException, AlexaForBusinessException
Searches contacts and lists the ones that meet a set of filter and sort criteria.
This is a variant of
searchContacts(software.amazon.awssdk.services.alexaforbusiness.model.SearchContactsRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.alexaforbusiness.paginators.SearchContactsIterable responses = client.searchContactsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.alexaforbusiness.paginators.SearchContactsIterable responses = client .searchContactsPaginator(request); for (software.amazon.awssdk.services.alexaforbusiness.model.SearchContactsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.alexaforbusiness.paginators.SearchContactsIterable responses = client.searchContactsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchContacts(software.amazon.awssdk.services.alexaforbusiness.model.SearchContactsRequest)
operation.
This is a convenience which creates an instance of the SearchContactsRequest.Builder
avoiding the need to
create one manually via SearchContactsRequest.builder()
searchContactsRequest
- A Consumer
that will call methods on SearchContactsRequest.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SearchDevicesResponse searchDevices(SearchDevicesRequest searchDevicesRequest) throws AwsServiceException, SdkClientException, AlexaForBusinessException
Searches devices and lists the ones that meet a set of filter criteria.
searchDevicesRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SearchDevicesResponse searchDevices(Consumer<SearchDevicesRequest.Builder> searchDevicesRequest) throws AwsServiceException, SdkClientException, AlexaForBusinessException
Searches devices and lists the ones that meet a set of filter criteria.
This is a convenience which creates an instance of the SearchDevicesRequest.Builder
avoiding the need to
create one manually via SearchDevicesRequest.builder()
searchDevicesRequest
- A Consumer
that will call methods on SearchDevicesRequest.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SearchDevicesIterable searchDevicesPaginator(SearchDevicesRequest searchDevicesRequest) throws AwsServiceException, SdkClientException, AlexaForBusinessException
Searches devices and lists the ones that meet a set of filter criteria.
This is a variant of
searchDevices(software.amazon.awssdk.services.alexaforbusiness.model.SearchDevicesRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.alexaforbusiness.paginators.SearchDevicesIterable responses = client.searchDevicesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.alexaforbusiness.paginators.SearchDevicesIterable responses = client .searchDevicesPaginator(request); for (software.amazon.awssdk.services.alexaforbusiness.model.SearchDevicesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.alexaforbusiness.paginators.SearchDevicesIterable responses = client.searchDevicesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchDevices(software.amazon.awssdk.services.alexaforbusiness.model.SearchDevicesRequest)
operation.
searchDevicesRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SearchDevicesIterable searchDevicesPaginator(Consumer<SearchDevicesRequest.Builder> searchDevicesRequest) throws AwsServiceException, SdkClientException, AlexaForBusinessException
Searches devices and lists the ones that meet a set of filter criteria.
This is a variant of
searchDevices(software.amazon.awssdk.services.alexaforbusiness.model.SearchDevicesRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.alexaforbusiness.paginators.SearchDevicesIterable responses = client.searchDevicesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.alexaforbusiness.paginators.SearchDevicesIterable responses = client .searchDevicesPaginator(request); for (software.amazon.awssdk.services.alexaforbusiness.model.SearchDevicesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.alexaforbusiness.paginators.SearchDevicesIterable responses = client.searchDevicesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchDevices(software.amazon.awssdk.services.alexaforbusiness.model.SearchDevicesRequest)
operation.
This is a convenience which creates an instance of the SearchDevicesRequest.Builder
avoiding the need to
create one manually via SearchDevicesRequest.builder()
searchDevicesRequest
- A Consumer
that will call methods on SearchDevicesRequest.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SearchNetworkProfilesResponse searchNetworkProfiles(SearchNetworkProfilesRequest searchNetworkProfilesRequest) throws AwsServiceException, SdkClientException, AlexaForBusinessException
Searches network profiles and lists the ones that meet a set of filter and sort criteria.
searchNetworkProfilesRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SearchNetworkProfilesResponse searchNetworkProfiles(Consumer<SearchNetworkProfilesRequest.Builder> searchNetworkProfilesRequest) throws AwsServiceException, SdkClientException, AlexaForBusinessException
Searches network profiles and lists the ones that meet a set of filter and sort criteria.
This is a convenience which creates an instance of the SearchNetworkProfilesRequest.Builder
avoiding the
need to create one manually via SearchNetworkProfilesRequest.builder()
searchNetworkProfilesRequest
- A Consumer
that will call methods on SearchNetworkProfilesRequest.Builder
to create a
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SearchNetworkProfilesIterable searchNetworkProfilesPaginator(SearchNetworkProfilesRequest searchNetworkProfilesRequest) throws AwsServiceException, SdkClientException, AlexaForBusinessException
Searches network profiles and lists the ones that meet a set of filter and sort criteria.
This is a variant of
searchNetworkProfiles(software.amazon.awssdk.services.alexaforbusiness.model.SearchNetworkProfilesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.alexaforbusiness.paginators.SearchNetworkProfilesIterable responses = client.searchNetworkProfilesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.alexaforbusiness.paginators.SearchNetworkProfilesIterable responses = client .searchNetworkProfilesPaginator(request); for (software.amazon.awssdk.services.alexaforbusiness.model.SearchNetworkProfilesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.alexaforbusiness.paginators.SearchNetworkProfilesIterable responses = client.searchNetworkProfilesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchNetworkProfiles(software.amazon.awssdk.services.alexaforbusiness.model.SearchNetworkProfilesRequest)
operation.
searchNetworkProfilesRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SearchNetworkProfilesIterable searchNetworkProfilesPaginator(Consumer<SearchNetworkProfilesRequest.Builder> searchNetworkProfilesRequest) throws AwsServiceException, SdkClientException, AlexaForBusinessException
Searches network profiles and lists the ones that meet a set of filter and sort criteria.
This is a variant of
searchNetworkProfiles(software.amazon.awssdk.services.alexaforbusiness.model.SearchNetworkProfilesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.alexaforbusiness.paginators.SearchNetworkProfilesIterable responses = client.searchNetworkProfilesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.alexaforbusiness.paginators.SearchNetworkProfilesIterable responses = client .searchNetworkProfilesPaginator(request); for (software.amazon.awssdk.services.alexaforbusiness.model.SearchNetworkProfilesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.alexaforbusiness.paginators.SearchNetworkProfilesIterable responses = client.searchNetworkProfilesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchNetworkProfiles(software.amazon.awssdk.services.alexaforbusiness.model.SearchNetworkProfilesRequest)
operation.
This is a convenience which creates an instance of the SearchNetworkProfilesRequest.Builder
avoiding the
need to create one manually via SearchNetworkProfilesRequest.builder()
searchNetworkProfilesRequest
- A Consumer
that will call methods on SearchNetworkProfilesRequest.Builder
to create a
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SearchProfilesResponse searchProfiles(SearchProfilesRequest searchProfilesRequest) throws AwsServiceException, SdkClientException, AlexaForBusinessException
Searches room profiles and lists the ones that meet a set of filter criteria.
searchProfilesRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SearchProfilesResponse searchProfiles(Consumer<SearchProfilesRequest.Builder> searchProfilesRequest) throws AwsServiceException, SdkClientException, AlexaForBusinessException
Searches room profiles and lists the ones that meet a set of filter criteria.
This is a convenience which creates an instance of the SearchProfilesRequest.Builder
avoiding the need to
create one manually via SearchProfilesRequest.builder()
searchProfilesRequest
- A Consumer
that will call methods on SearchProfilesRequest.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SearchProfilesIterable searchProfilesPaginator(SearchProfilesRequest searchProfilesRequest) throws AwsServiceException, SdkClientException, AlexaForBusinessException
Searches room profiles and lists the ones that meet a set of filter criteria.
This is a variant of
searchProfiles(software.amazon.awssdk.services.alexaforbusiness.model.SearchProfilesRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.alexaforbusiness.paginators.SearchProfilesIterable responses = client.searchProfilesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.alexaforbusiness.paginators.SearchProfilesIterable responses = client .searchProfilesPaginator(request); for (software.amazon.awssdk.services.alexaforbusiness.model.SearchProfilesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.alexaforbusiness.paginators.SearchProfilesIterable responses = client.searchProfilesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchProfiles(software.amazon.awssdk.services.alexaforbusiness.model.SearchProfilesRequest)
operation.
searchProfilesRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SearchProfilesIterable searchProfilesPaginator(Consumer<SearchProfilesRequest.Builder> searchProfilesRequest) throws AwsServiceException, SdkClientException, AlexaForBusinessException
Searches room profiles and lists the ones that meet a set of filter criteria.
This is a variant of
searchProfiles(software.amazon.awssdk.services.alexaforbusiness.model.SearchProfilesRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.alexaforbusiness.paginators.SearchProfilesIterable responses = client.searchProfilesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.alexaforbusiness.paginators.SearchProfilesIterable responses = client .searchProfilesPaginator(request); for (software.amazon.awssdk.services.alexaforbusiness.model.SearchProfilesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.alexaforbusiness.paginators.SearchProfilesIterable responses = client.searchProfilesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchProfiles(software.amazon.awssdk.services.alexaforbusiness.model.SearchProfilesRequest)
operation.
This is a convenience which creates an instance of the SearchProfilesRequest.Builder
avoiding the need to
create one manually via SearchProfilesRequest.builder()
searchProfilesRequest
- A Consumer
that will call methods on SearchProfilesRequest.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SearchRoomsResponse searchRooms(SearchRoomsRequest searchRoomsRequest) throws AwsServiceException, SdkClientException, AlexaForBusinessException
Searches rooms and lists the ones that meet a set of filter and sort criteria.
searchRoomsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AlexaForBusinessException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SearchRoomsResponse searchRooms(Consumer<SearchRoomsRequest.Builder> searchRoomsRequest) throws AwsServiceException, SdkClientException, AlexaForBusinessException
Searches rooms and lists the ones that meet a set of filter and sort criteria.
This is a convenience which creates an instance of the SearchRoomsRequest.Builder
avoiding the need to
create one manually via SearchRoomsRequest.builder()
searchRoomsRequest
- A Consumer
that will call methods on SearchRoomsRequest.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.