@Generated(value="software.amazon.awssdk:codegen") public interface AlexaForBusinessAsyncClient extends SdkClient, SdkAutoCloseable
builder()
method.
Alexa for Business makes it easy for you to use Alexa in your organization. Alexa for Business gives you the tools you need 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 APIs, and you can make these available as private skills for your organization. Alexa for Business also makes it easy to voice-enable your products and services, providing context-aware voice experiences for your customers.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
default CompletableFuture<AssociateDeviceWithRoomResponse> |
associateDeviceWithRoom(AssociateDeviceWithRoomRequest associateDeviceWithRoomRequest)
Associates a device to a given room.
|
default CompletableFuture<AssociateDeviceWithRoomResponse> |
associateDeviceWithRoom(Consumer<AssociateDeviceWithRoomRequest.Builder> associateDeviceWithRoomRequest)
Associates a device to a given room.
|
default CompletableFuture<AssociateSkillGroupWithRoomResponse> |
associateSkillGroupWithRoom(AssociateSkillGroupWithRoomRequest associateSkillGroupWithRoomRequest)
Associates a skill group to a given room.
|
default CompletableFuture<AssociateSkillGroupWithRoomResponse> |
associateSkillGroupWithRoom(Consumer<AssociateSkillGroupWithRoomRequest.Builder> associateSkillGroupWithRoomRequest)
Associates a skill group to a given room.
|
static AlexaForBusinessAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
AlexaForBusinessAsyncClient . |
static AlexaForBusinessAsyncClient |
create()
Create a
AlexaForBusinessAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CompletableFuture<CreateProfileResponse> |
createProfile(Consumer<CreateProfileRequest.Builder> createProfileRequest)
Creates a new room profile with the specified details.
|
default CompletableFuture<CreateProfileResponse> |
createProfile(CreateProfileRequest createProfileRequest)
Creates a new room profile with the specified details.
|
default CompletableFuture<CreateRoomResponse> |
createRoom(Consumer<CreateRoomRequest.Builder> createRoomRequest)
Creates a room with the specified details.
|
default CompletableFuture<CreateRoomResponse> |
createRoom(CreateRoomRequest createRoomRequest)
Creates a room with the specified details.
|
default CompletableFuture<CreateSkillGroupResponse> |
createSkillGroup(Consumer<CreateSkillGroupRequest.Builder> createSkillGroupRequest)
Creates a skill group with a specified name and description.
|
default CompletableFuture<CreateSkillGroupResponse> |
createSkillGroup(CreateSkillGroupRequest createSkillGroupRequest)
Creates a skill group with a specified name and description.
|
default CompletableFuture<CreateUserResponse> |
createUser(Consumer<CreateUserRequest.Builder> createUserRequest)
Creates a user.
|
default CompletableFuture<CreateUserResponse> |
createUser(CreateUserRequest createUserRequest)
Creates a user.
|
default CompletableFuture<DeleteProfileResponse> |
deleteProfile(Consumer<DeleteProfileRequest.Builder> deleteProfileRequest)
Deletes a room profile by the profile ARN.
|
default CompletableFuture<DeleteProfileResponse> |
deleteProfile(DeleteProfileRequest deleteProfileRequest)
Deletes a room profile by the profile ARN.
|
default CompletableFuture<DeleteRoomResponse> |
deleteRoom(Consumer<DeleteRoomRequest.Builder> deleteRoomRequest)
Deletes a room by the room ARN.
|
default CompletableFuture<DeleteRoomResponse> |
deleteRoom(DeleteRoomRequest deleteRoomRequest)
Deletes a room by the room ARN.
|
default CompletableFuture<DeleteRoomSkillParameterResponse> |
deleteRoomSkillParameter(Consumer<DeleteRoomSkillParameterRequest.Builder> deleteRoomSkillParameterRequest)
Deletes room skill parameter details by room, skill, and parameter key ID.
|
default CompletableFuture<DeleteRoomSkillParameterResponse> |
deleteRoomSkillParameter(DeleteRoomSkillParameterRequest deleteRoomSkillParameterRequest)
Deletes room skill parameter details by room, skill, and parameter key ID.
|
default CompletableFuture<DeleteSkillGroupResponse> |
deleteSkillGroup(Consumer<DeleteSkillGroupRequest.Builder> deleteSkillGroupRequest)
Deletes a skill group by skill group ARN.
|
default CompletableFuture<DeleteSkillGroupResponse> |
deleteSkillGroup(DeleteSkillGroupRequest deleteSkillGroupRequest)
Deletes a skill group by skill group ARN.
|
default CompletableFuture<DeleteUserResponse> |
deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest)
Deletes a specified user by user ARN and enrollment ARN.
|
default CompletableFuture<DeleteUserResponse> |
deleteUser(DeleteUserRequest deleteUserRequest)
Deletes a specified user by user ARN and enrollment ARN.
|
default CompletableFuture<DisassociateDeviceFromRoomResponse> |
disassociateDeviceFromRoom(Consumer<DisassociateDeviceFromRoomRequest.Builder> disassociateDeviceFromRoomRequest)
Disassociates a device from its current room.
|
default CompletableFuture<DisassociateDeviceFromRoomResponse> |
disassociateDeviceFromRoom(DisassociateDeviceFromRoomRequest disassociateDeviceFromRoomRequest)
Disassociates a device from its current room.
|
default CompletableFuture<DisassociateSkillGroupFromRoomResponse> |
disassociateSkillGroupFromRoom(Consumer<DisassociateSkillGroupFromRoomRequest.Builder> disassociateSkillGroupFromRoomRequest)
Disassociates a skill group from a specified room.
|
default CompletableFuture<DisassociateSkillGroupFromRoomResponse> |
disassociateSkillGroupFromRoom(DisassociateSkillGroupFromRoomRequest disassociateSkillGroupFromRoomRequest)
Disassociates a skill group from a specified room.
|
default CompletableFuture<GetDeviceResponse> |
getDevice(Consumer<GetDeviceRequest.Builder> getDeviceRequest)
Gets the details of a device by device ARN.
|
default CompletableFuture<GetDeviceResponse> |
getDevice(GetDeviceRequest getDeviceRequest)
Gets the details of a device by device ARN.
|
default CompletableFuture<GetProfileResponse> |
getProfile(Consumer<GetProfileRequest.Builder> getProfileRequest)
Gets the details of a room profile by profile ARN.
|
default CompletableFuture<GetProfileResponse> |
getProfile(GetProfileRequest getProfileRequest)
Gets the details of a room profile by profile ARN.
|
default CompletableFuture<GetRoomResponse> |
getRoom(Consumer<GetRoomRequest.Builder> getRoomRequest)
Gets room details by room ARN.
|
default CompletableFuture<GetRoomResponse> |
getRoom(GetRoomRequest getRoomRequest)
Gets room details by room ARN.
|
default CompletableFuture<GetRoomSkillParameterResponse> |
getRoomSkillParameter(Consumer<GetRoomSkillParameterRequest.Builder> getRoomSkillParameterRequest)
Gets room skill parameter details by room, skill, and parameter key ARN.
|
default CompletableFuture<GetRoomSkillParameterResponse> |
getRoomSkillParameter(GetRoomSkillParameterRequest getRoomSkillParameterRequest)
Gets room skill parameter details by room, skill, and parameter key ARN.
|
default CompletableFuture<GetSkillGroupResponse> |
getSkillGroup(Consumer<GetSkillGroupRequest.Builder> getSkillGroupRequest)
Gets skill group details by skill group ARN.
|
default CompletableFuture<GetSkillGroupResponse> |
getSkillGroup(GetSkillGroupRequest getSkillGroupRequest)
Gets skill group details by skill group ARN.
|
default CompletableFuture<ListSkillsResponse> |
listSkills(Consumer<ListSkillsRequest.Builder> listSkillsRequest)
Lists all enabled skills in a specific skill group.
|
default CompletableFuture<ListSkillsResponse> |
listSkills(ListSkillsRequest listSkillsRequest)
Lists all enabled skills in a specific skill group.
|
default ListSkillsPublisher |
listSkillsPaginator(Consumer<ListSkillsRequest.Builder> listSkillsRequest)
Lists all enabled skills in a specific skill group.
|
default ListSkillsPublisher |
listSkillsPaginator(ListSkillsRequest listSkillsRequest)
Lists all enabled skills in a specific skill group.
|
default CompletableFuture<ListTagsResponse> |
listTags(Consumer<ListTagsRequest.Builder> listTagsRequest)
Lists all tags for a specific resource.
|
default CompletableFuture<ListTagsResponse> |
listTags(ListTagsRequest listTagsRequest)
Lists all tags for a specific resource.
|
default ListTagsPublisher |
listTagsPaginator(Consumer<ListTagsRequest.Builder> listTagsRequest)
Lists all tags for a specific resource.
|
default ListTagsPublisher |
listTagsPaginator(ListTagsRequest listTagsRequest)
Lists all tags for a specific resource.
|
default CompletableFuture<PutRoomSkillParameterResponse> |
putRoomSkillParameter(Consumer<PutRoomSkillParameterRequest.Builder> putRoomSkillParameterRequest)
Updates room skill parameter details by room, skill, and parameter key ID.
|
default CompletableFuture<PutRoomSkillParameterResponse> |
putRoomSkillParameter(PutRoomSkillParameterRequest putRoomSkillParameterRequest)
Updates room skill parameter details by room, skill, and parameter key ID.
|
default CompletableFuture<ResolveRoomResponse> |
resolveRoom(Consumer<ResolveRoomRequest.Builder> resolveRoomRequest)
Determines the details for the room from which a skill request was invoked.
|
default CompletableFuture<ResolveRoomResponse> |
resolveRoom(ResolveRoomRequest resolveRoomRequest)
Determines the details for the room from which a skill request was invoked.
|
default CompletableFuture<RevokeInvitationResponse> |
revokeInvitation(Consumer<RevokeInvitationRequest.Builder> revokeInvitationRequest)
Revokes an invitation and invalidates the enrollment URL.
|
default CompletableFuture<RevokeInvitationResponse> |
revokeInvitation(RevokeInvitationRequest revokeInvitationRequest)
Revokes an invitation and invalidates the enrollment URL.
|
default CompletableFuture<SearchDevicesResponse> |
searchDevices(Consumer<SearchDevicesRequest.Builder> searchDevicesRequest)
Searches devices and lists the ones that meet a set of filter criteria.
|
default CompletableFuture<SearchDevicesResponse> |
searchDevices(SearchDevicesRequest searchDevicesRequest)
Searches devices and lists the ones that meet a set of filter criteria.
|
default SearchDevicesPublisher |
searchDevicesPaginator(Consumer<SearchDevicesRequest.Builder> searchDevicesRequest)
Searches devices and lists the ones that meet a set of filter criteria.
|
default SearchDevicesPublisher |
searchDevicesPaginator(SearchDevicesRequest searchDevicesRequest)
Searches devices and lists the ones that meet a set of filter criteria.
|
default CompletableFuture<SearchProfilesResponse> |
searchProfiles(Consumer<SearchProfilesRequest.Builder> searchProfilesRequest)
Searches room profiles and lists the ones that meet a set of filter criteria.
|
default CompletableFuture<SearchProfilesResponse> |
searchProfiles(SearchProfilesRequest searchProfilesRequest)
Searches room profiles and lists the ones that meet a set of filter criteria.
|
default SearchProfilesPublisher |
searchProfilesPaginator(Consumer<SearchProfilesRequest.Builder> searchProfilesRequest)
Searches room profiles and lists the ones that meet a set of filter criteria.
|
default SearchProfilesPublisher |
searchProfilesPaginator(SearchProfilesRequest searchProfilesRequest)
Searches room profiles and lists the ones that meet a set of filter criteria.
|
default CompletableFuture<SearchRoomsResponse> |
searchRooms(Consumer<SearchRoomsRequest.Builder> searchRoomsRequest)
Searches rooms and lists the ones that meet a set of filter and sort criteria.
|
default CompletableFuture<SearchRoomsResponse> |
searchRooms(SearchRoomsRequest searchRoomsRequest)
Searches rooms and lists the ones that meet a set of filter and sort criteria.
|
default SearchRoomsPublisher |
searchRoomsPaginator(Consumer<SearchRoomsRequest.Builder> searchRoomsRequest)
Searches rooms and lists the ones that meet a set of filter and sort criteria.
|
default SearchRoomsPublisher |
searchRoomsPaginator(SearchRoomsRequest searchRoomsRequest)
Searches rooms and lists the ones that meet a set of filter and sort criteria.
|
default CompletableFuture<SearchSkillGroupsResponse> |
searchSkillGroups(Consumer<SearchSkillGroupsRequest.Builder> searchSkillGroupsRequest)
Searches skill groups and lists the ones that meet a set of filter and sort criteria.
|
default CompletableFuture<SearchSkillGroupsResponse> |
searchSkillGroups(SearchSkillGroupsRequest searchSkillGroupsRequest)
Searches skill groups and lists the ones that meet a set of filter and sort criteria.
|
default SearchSkillGroupsPublisher |
searchSkillGroupsPaginator(Consumer<SearchSkillGroupsRequest.Builder> searchSkillGroupsRequest)
Searches skill groups and lists the ones that meet a set of filter and sort criteria.
|
default SearchSkillGroupsPublisher |
searchSkillGroupsPaginator(SearchSkillGroupsRequest searchSkillGroupsRequest)
Searches skill groups and lists the ones that meet a set of filter and sort criteria.
|
default CompletableFuture<SearchUsersResponse> |
searchUsers(Consumer<SearchUsersRequest.Builder> searchUsersRequest)
Searches users and lists the ones that meet a set of filter and sort criteria.
|
default CompletableFuture<SearchUsersResponse> |
searchUsers(SearchUsersRequest searchUsersRequest)
Searches users and lists the ones that meet a set of filter and sort criteria.
|
default SearchUsersPublisher |
searchUsersPaginator(Consumer<SearchUsersRequest.Builder> searchUsersRequest)
Searches users and lists the ones that meet a set of filter and sort criteria.
|
default SearchUsersPublisher |
searchUsersPaginator(SearchUsersRequest searchUsersRequest)
Searches users and lists the ones that meet a set of filter and sort criteria.
|
default CompletableFuture<SendInvitationResponse> |
sendInvitation(Consumer<SendInvitationRequest.Builder> sendInvitationRequest)
Sends an enrollment invitation email with a URL to a user.
|
default CompletableFuture<SendInvitationResponse> |
sendInvitation(SendInvitationRequest sendInvitationRequest)
Sends an enrollment invitation email with a URL to a user.
|
default CompletableFuture<StartDeviceSyncResponse> |
startDeviceSync(Consumer<StartDeviceSyncRequest.Builder> startDeviceSyncRequest)
Resets a device and its account to the known default settings by clearing all information and settings set by
previous users.
|
default CompletableFuture<StartDeviceSyncResponse> |
startDeviceSync(StartDeviceSyncRequest startDeviceSyncRequest)
Resets a device and its account to the known default settings by clearing all information and settings set by
previous users.
|
default CompletableFuture<TagResourceResponse> |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds metadata tags to a specified resource.
|
default CompletableFuture<TagResourceResponse> |
tagResource(TagResourceRequest tagResourceRequest)
Adds metadata tags to a specified resource.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes metadata tags from a specified resource.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(UntagResourceRequest untagResourceRequest)
Removes metadata tags from a specified resource.
|
default CompletableFuture<UpdateDeviceResponse> |
updateDevice(Consumer<UpdateDeviceRequest.Builder> updateDeviceRequest)
Updates the device name by device ARN.
|
default CompletableFuture<UpdateDeviceResponse> |
updateDevice(UpdateDeviceRequest updateDeviceRequest)
Updates the device name by device ARN.
|
default CompletableFuture<UpdateProfileResponse> |
updateProfile(Consumer<UpdateProfileRequest.Builder> updateProfileRequest)
Updates an existing room profile by room profile ARN.
|
default CompletableFuture<UpdateProfileResponse> |
updateProfile(UpdateProfileRequest updateProfileRequest)
Updates an existing room profile by room profile ARN.
|
default CompletableFuture<UpdateRoomResponse> |
updateRoom(Consumer<UpdateRoomRequest.Builder> updateRoomRequest)
Updates room details by room ARN.
|
default CompletableFuture<UpdateRoomResponse> |
updateRoom(UpdateRoomRequest updateRoomRequest)
Updates room details by room ARN.
|
default CompletableFuture<UpdateSkillGroupResponse> |
updateSkillGroup(Consumer<UpdateSkillGroupRequest.Builder> updateSkillGroupRequest)
Updates skill group details by skill group ARN.
|
default CompletableFuture<UpdateSkillGroupResponse> |
updateSkillGroup(UpdateSkillGroupRequest updateSkillGroupRequest)
Updates skill group details by skill group ARN.
|
serviceName
close
static final String SERVICE_NAME
static AlexaForBusinessAsyncClient create()
AlexaForBusinessAsyncClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static AlexaForBusinessAsyncClientBuilder builder()
AlexaForBusinessAsyncClient
.default CompletableFuture<AssociateDeviceWithRoomResponse> associateDeviceWithRoom(AssociateDeviceWithRoomRequest associateDeviceWithRoomRequest)
Associates a device to 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 a manual sync is required.
associateDeviceWithRoomRequest
- default CompletableFuture<AssociateDeviceWithRoomResponse> associateDeviceWithRoom(Consumer<AssociateDeviceWithRoomRequest.Builder> associateDeviceWithRoomRequest)
Associates a device to 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 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.default CompletableFuture<AssociateSkillGroupWithRoomResponse> associateSkillGroupWithRoom(AssociateSkillGroupWithRoomRequest associateSkillGroupWithRoomRequest)
Associates a skill group to a given room. This enables all skills in the associated skill group on all devices in the room.
associateSkillGroupWithRoomRequest
- default CompletableFuture<AssociateSkillGroupWithRoomResponse> associateSkillGroupWithRoom(Consumer<AssociateSkillGroupWithRoomRequest.Builder> associateSkillGroupWithRoomRequest)
Associates a skill group to 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.default CompletableFuture<CreateProfileResponse> createProfile(CreateProfileRequest createProfileRequest)
Creates a new room profile with the specified details.
createProfileRequest
- default CompletableFuture<CreateProfileResponse> createProfile(Consumer<CreateProfileRequest.Builder> createProfileRequest)
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.default CompletableFuture<CreateRoomResponse> createRoom(CreateRoomRequest createRoomRequest)
Creates a room with the specified details.
createRoomRequest
- default CompletableFuture<CreateRoomResponse> createRoom(Consumer<CreateRoomRequest.Builder> createRoomRequest)
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.default CompletableFuture<CreateSkillGroupResponse> createSkillGroup(CreateSkillGroupRequest createSkillGroupRequest)
Creates a skill group with a specified name and description.
createSkillGroupRequest
- default CompletableFuture<CreateSkillGroupResponse> createSkillGroup(Consumer<CreateSkillGroupRequest.Builder> createSkillGroupRequest)
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.default CompletableFuture<CreateUserResponse> createUser(CreateUserRequest createUserRequest)
Creates a user.
createUserRequest
- default CompletableFuture<CreateUserResponse> createUser(Consumer<CreateUserRequest.Builder> createUserRequest)
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.default CompletableFuture<DeleteProfileResponse> deleteProfile(DeleteProfileRequest deleteProfileRequest)
Deletes a room profile by the profile ARN.
deleteProfileRequest
- default CompletableFuture<DeleteProfileResponse> deleteProfile(Consumer<DeleteProfileRequest.Builder> deleteProfileRequest)
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.default CompletableFuture<DeleteRoomResponse> deleteRoom(DeleteRoomRequest deleteRoomRequest)
Deletes a room by the room ARN.
deleteRoomRequest
- default CompletableFuture<DeleteRoomResponse> deleteRoom(Consumer<DeleteRoomRequest.Builder> deleteRoomRequest)
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.default CompletableFuture<DeleteRoomSkillParameterResponse> deleteRoomSkillParameter(DeleteRoomSkillParameterRequest deleteRoomSkillParameterRequest)
Deletes room skill parameter details by room, skill, and parameter key ID.
deleteRoomSkillParameterRequest
- default CompletableFuture<DeleteRoomSkillParameterResponse> deleteRoomSkillParameter(Consumer<DeleteRoomSkillParameterRequest.Builder> deleteRoomSkillParameterRequest)
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.default CompletableFuture<DeleteSkillGroupResponse> deleteSkillGroup(DeleteSkillGroupRequest deleteSkillGroupRequest)
Deletes a skill group by skill group ARN.
deleteSkillGroupRequest
- default CompletableFuture<DeleteSkillGroupResponse> deleteSkillGroup(Consumer<DeleteSkillGroupRequest.Builder> deleteSkillGroupRequest)
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.default CompletableFuture<DeleteUserResponse> deleteUser(DeleteUserRequest deleteUserRequest)
Deletes a specified user by user ARN and enrollment ARN.
deleteUserRequest
- default CompletableFuture<DeleteUserResponse> deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest)
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.default CompletableFuture<DisassociateDeviceFromRoomResponse> disassociateDeviceFromRoom(DisassociateDeviceFromRoomRequest disassociateDeviceFromRoomRequest)
Disassociates a device from its current room. The device continues to be connected to the Wi-Fi network and is still registered to the account. The device settings and skills are removed from the room.
disassociateDeviceFromRoomRequest
- default CompletableFuture<DisassociateDeviceFromRoomResponse> disassociateDeviceFromRoom(Consumer<DisassociateDeviceFromRoomRequest.Builder> disassociateDeviceFromRoomRequest)
Disassociates a device from its current room. The device continues to be connected to the Wi-Fi network and is still registered to the account. The device settings and skills are removed from the room.
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.default CompletableFuture<DisassociateSkillGroupFromRoomResponse> disassociateSkillGroupFromRoom(DisassociateSkillGroupFromRoomRequest disassociateSkillGroupFromRoomRequest)
Disassociates a skill group from a specified room. This disables all skills in the skill group on all devices in the room.
disassociateSkillGroupFromRoomRequest
- default CompletableFuture<DisassociateSkillGroupFromRoomResponse> disassociateSkillGroupFromRoom(Consumer<DisassociateSkillGroupFromRoomRequest.Builder> disassociateSkillGroupFromRoomRequest)
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.default CompletableFuture<GetDeviceResponse> getDevice(GetDeviceRequest getDeviceRequest)
Gets the details of a device by device ARN.
getDeviceRequest
- default CompletableFuture<GetDeviceResponse> getDevice(Consumer<GetDeviceRequest.Builder> getDeviceRequest)
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.default CompletableFuture<GetProfileResponse> getProfile(GetProfileRequest getProfileRequest)
Gets the details of a room profile by profile ARN.
getProfileRequest
- default CompletableFuture<GetProfileResponse> getProfile(Consumer<GetProfileRequest.Builder> getProfileRequest)
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.default CompletableFuture<GetRoomResponse> getRoom(GetRoomRequest getRoomRequest)
Gets room details by room ARN.
getRoomRequest
- default CompletableFuture<GetRoomResponse> getRoom(Consumer<GetRoomRequest.Builder> getRoomRequest)
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.default CompletableFuture<GetRoomSkillParameterResponse> getRoomSkillParameter(GetRoomSkillParameterRequest getRoomSkillParameterRequest)
Gets room skill parameter details by room, skill, and parameter key ARN.
getRoomSkillParameterRequest
- default CompletableFuture<GetRoomSkillParameterResponse> getRoomSkillParameter(Consumer<GetRoomSkillParameterRequest.Builder> getRoomSkillParameterRequest)
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.default CompletableFuture<GetSkillGroupResponse> getSkillGroup(GetSkillGroupRequest getSkillGroupRequest)
Gets skill group details by skill group ARN.
getSkillGroupRequest
- default CompletableFuture<GetSkillGroupResponse> getSkillGroup(Consumer<GetSkillGroupRequest.Builder> getSkillGroupRequest)
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.default CompletableFuture<ListSkillsResponse> listSkills(ListSkillsRequest listSkillsRequest)
Lists all enabled skills in a specific skill group.
listSkillsRequest
- default CompletableFuture<ListSkillsResponse> listSkills(Consumer<ListSkillsRequest.Builder> listSkillsRequest)
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.default ListSkillsPublisher listSkillsPaginator(ListSkillsRequest listSkillsRequest)
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 publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.alexaforbusiness.paginators.ListSkillsPublisher publisher = client.listSkillsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.alexaforbusiness.paginators.ListSkillsPublisher publisher = client.listSkillsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.alexaforbusiness.model.ListSkillsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.alexaforbusiness.model.ListSkillsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listSkills(software.amazon.awssdk.services.alexaforbusiness.model.ListSkillsRequest)
operation.
listSkillsRequest
- default ListSkillsPublisher listSkillsPaginator(Consumer<ListSkillsRequest.Builder> listSkillsRequest)
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 publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.alexaforbusiness.paginators.ListSkillsPublisher publisher = client.listSkillsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.alexaforbusiness.paginators.ListSkillsPublisher publisher = client.listSkillsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.alexaforbusiness.model.ListSkillsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.alexaforbusiness.model.ListSkillsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.default CompletableFuture<ListTagsResponse> listTags(ListTagsRequest listTagsRequest)
Lists all tags for a specific resource.
listTagsRequest
- default CompletableFuture<ListTagsResponse> listTags(Consumer<ListTagsRequest.Builder> listTagsRequest)
Lists all tags for a specific 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.default ListTagsPublisher listTagsPaginator(ListTagsRequest listTagsRequest)
Lists all tags for a specific resource.
This is a variant of listTags(software.amazon.awssdk.services.alexaforbusiness.model.ListTagsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.alexaforbusiness.paginators.ListTagsPublisher publisher = client.listTagsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.alexaforbusiness.paginators.ListTagsPublisher publisher = client.listTagsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.alexaforbusiness.model.ListTagsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.alexaforbusiness.model.ListTagsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listTags(software.amazon.awssdk.services.alexaforbusiness.model.ListTagsRequest)
operation.
listTagsRequest
- default ListTagsPublisher listTagsPaginator(Consumer<ListTagsRequest.Builder> listTagsRequest)
Lists all tags for a specific resource.
This is a variant of listTags(software.amazon.awssdk.services.alexaforbusiness.model.ListTagsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.alexaforbusiness.paginators.ListTagsPublisher publisher = client.listTagsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.alexaforbusiness.paginators.ListTagsPublisher publisher = client.listTagsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.alexaforbusiness.model.ListTagsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.alexaforbusiness.model.ListTagsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.default CompletableFuture<PutRoomSkillParameterResponse> putRoomSkillParameter(PutRoomSkillParameterRequest putRoomSkillParameterRequest)
Updates room skill parameter details by room, skill, and parameter key ID. Not all skills have a room skill parameter.
putRoomSkillParameterRequest
- default CompletableFuture<PutRoomSkillParameterResponse> putRoomSkillParameter(Consumer<PutRoomSkillParameterRequest.Builder> putRoomSkillParameterRequest)
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.default CompletableFuture<ResolveRoomResponse> resolveRoom(ResolveRoomRequest resolveRoomRequest)
Determines the details for the room from which a skill request was invoked. This operation is used by skill developers.
resolveRoomRequest
- default CompletableFuture<ResolveRoomResponse> resolveRoom(Consumer<ResolveRoomRequest.Builder> resolveRoomRequest)
Determines the details for the room from which a skill request was invoked. This operation is used by skill developers.
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.default CompletableFuture<RevokeInvitationResponse> revokeInvitation(RevokeInvitationRequest revokeInvitationRequest)
Revokes an invitation and invalidates the enrollment URL.
revokeInvitationRequest
- default CompletableFuture<RevokeInvitationResponse> revokeInvitation(Consumer<RevokeInvitationRequest.Builder> revokeInvitationRequest)
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.default CompletableFuture<SearchDevicesResponse> searchDevices(SearchDevicesRequest searchDevicesRequest)
Searches devices and lists the ones that meet a set of filter criteria.
searchDevicesRequest
- default CompletableFuture<SearchDevicesResponse> searchDevices(Consumer<SearchDevicesRequest.Builder> searchDevicesRequest)
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.default SearchDevicesPublisher searchDevicesPaginator(SearchDevicesRequest searchDevicesRequest)
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 publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.alexaforbusiness.paginators.SearchDevicesPublisher publisher = client.searchDevicesPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.alexaforbusiness.paginators.SearchDevicesPublisher publisher = client.searchDevicesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.alexaforbusiness.model.SearchDevicesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.alexaforbusiness.model.SearchDevicesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
searchDevices(software.amazon.awssdk.services.alexaforbusiness.model.SearchDevicesRequest)
operation.
searchDevicesRequest
- default SearchDevicesPublisher searchDevicesPaginator(Consumer<SearchDevicesRequest.Builder> searchDevicesRequest)
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 publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.alexaforbusiness.paginators.SearchDevicesPublisher publisher = client.searchDevicesPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.alexaforbusiness.paginators.SearchDevicesPublisher publisher = client.searchDevicesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.alexaforbusiness.model.SearchDevicesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.alexaforbusiness.model.SearchDevicesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.default CompletableFuture<SearchProfilesResponse> searchProfiles(SearchProfilesRequest searchProfilesRequest)
Searches room profiles and lists the ones that meet a set of filter criteria.
searchProfilesRequest
- default CompletableFuture<SearchProfilesResponse> searchProfiles(Consumer<SearchProfilesRequest.Builder> searchProfilesRequest)
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.default SearchProfilesPublisher searchProfilesPaginator(SearchProfilesRequest searchProfilesRequest)
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 publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.alexaforbusiness.paginators.SearchProfilesPublisher publisher = client.searchProfilesPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.alexaforbusiness.paginators.SearchProfilesPublisher publisher = client.searchProfilesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.alexaforbusiness.model.SearchProfilesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.alexaforbusiness.model.SearchProfilesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
searchProfiles(software.amazon.awssdk.services.alexaforbusiness.model.SearchProfilesRequest)
operation.
searchProfilesRequest
- default SearchProfilesPublisher searchProfilesPaginator(Consumer<SearchProfilesRequest.Builder> searchProfilesRequest)
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 publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.alexaforbusiness.paginators.SearchProfilesPublisher publisher = client.searchProfilesPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.alexaforbusiness.paginators.SearchProfilesPublisher publisher = client.searchProfilesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.alexaforbusiness.model.SearchProfilesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.alexaforbusiness.model.SearchProfilesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.default CompletableFuture<SearchRoomsResponse> searchRooms(SearchRoomsRequest searchRoomsRequest)
Searches rooms and lists the ones that meet a set of filter and sort criteria.
searchRoomsRequest
- default CompletableFuture<SearchRoomsResponse> searchRooms(Consumer<SearchRoomsRequest.Builder> searchRoomsRequest)
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.default SearchRoomsPublisher searchRoomsPaginator(SearchRoomsRequest searchRoomsRequest)
Searches rooms and lists the ones that meet a set of filter and sort criteria.
This is a variant of
searchRooms(software.amazon.awssdk.services.alexaforbusiness.model.SearchRoomsRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.alexaforbusiness.paginators.SearchRoomsPublisher publisher = client.searchRoomsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.alexaforbusiness.paginators.SearchRoomsPublisher publisher = client.searchRoomsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.alexaforbusiness.model.SearchRoomsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.alexaforbusiness.model.SearchRoomsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
searchRooms(software.amazon.awssdk.services.alexaforbusiness.model.SearchRoomsRequest)
operation.
searchRoomsRequest
- default SearchRoomsPublisher searchRoomsPaginator(Consumer<SearchRoomsRequest.Builder> searchRoomsRequest)
Searches rooms and lists the ones that meet a set of filter and sort criteria.
This is a variant of
searchRooms(software.amazon.awssdk.services.alexaforbusiness.model.SearchRoomsRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.alexaforbusiness.paginators.SearchRoomsPublisher publisher = client.searchRoomsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.alexaforbusiness.paginators.SearchRoomsPublisher publisher = client.searchRoomsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.alexaforbusiness.model.SearchRoomsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.alexaforbusiness.model.SearchRoomsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
searchRooms(software.amazon.awssdk.services.alexaforbusiness.model.SearchRoomsRequest)
operation.
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.default CompletableFuture<SearchSkillGroupsResponse> searchSkillGroups(SearchSkillGroupsRequest searchSkillGroupsRequest)
Searches skill groups and lists the ones that meet a set of filter and sort criteria.
searchSkillGroupsRequest
- default CompletableFuture<SearchSkillGroupsResponse> searchSkillGroups(Consumer<SearchSkillGroupsRequest.Builder> searchSkillGroupsRequest)
Searches skill groups and lists the ones that meet a set of filter and sort criteria.
This is a convenience which creates an instance of the SearchSkillGroupsRequest.Builder
avoiding the need
to create one manually via SearchSkillGroupsRequest.builder()
searchSkillGroupsRequest
- A Consumer
that will call methods on SearchSkillGroupsRequest.Builder
to create a request.default SearchSkillGroupsPublisher searchSkillGroupsPaginator(SearchSkillGroupsRequest searchSkillGroupsRequest)
Searches skill groups and lists the ones that meet a set of filter and sort criteria.
This is a variant of
searchSkillGroups(software.amazon.awssdk.services.alexaforbusiness.model.SearchSkillGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.alexaforbusiness.paginators.SearchSkillGroupsPublisher publisher = client.searchSkillGroupsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.alexaforbusiness.paginators.SearchSkillGroupsPublisher publisher = client.searchSkillGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.alexaforbusiness.model.SearchSkillGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.alexaforbusiness.model.SearchSkillGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
searchSkillGroups(software.amazon.awssdk.services.alexaforbusiness.model.SearchSkillGroupsRequest)
operation.
searchSkillGroupsRequest
- default SearchSkillGroupsPublisher searchSkillGroupsPaginator(Consumer<SearchSkillGroupsRequest.Builder> searchSkillGroupsRequest)
Searches skill groups and lists the ones that meet a set of filter and sort criteria.
This is a variant of
searchSkillGroups(software.amazon.awssdk.services.alexaforbusiness.model.SearchSkillGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.alexaforbusiness.paginators.SearchSkillGroupsPublisher publisher = client.searchSkillGroupsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.alexaforbusiness.paginators.SearchSkillGroupsPublisher publisher = client.searchSkillGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.alexaforbusiness.model.SearchSkillGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.alexaforbusiness.model.SearchSkillGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
searchSkillGroups(software.amazon.awssdk.services.alexaforbusiness.model.SearchSkillGroupsRequest)
operation.
This is a convenience which creates an instance of the SearchSkillGroupsRequest.Builder
avoiding the need
to create one manually via SearchSkillGroupsRequest.builder()
searchSkillGroupsRequest
- A Consumer
that will call methods on SearchSkillGroupsRequest.Builder
to create a request.default CompletableFuture<SearchUsersResponse> searchUsers(SearchUsersRequest searchUsersRequest)
Searches users and lists the ones that meet a set of filter and sort criteria.
searchUsersRequest
- default CompletableFuture<SearchUsersResponse> searchUsers(Consumer<SearchUsersRequest.Builder> searchUsersRequest)
Searches users and lists the ones that meet a set of filter and sort criteria.
This is a convenience which creates an instance of the SearchUsersRequest.Builder
avoiding the need to
create one manually via SearchUsersRequest.builder()
searchUsersRequest
- A Consumer
that will call methods on SearchUsersRequest.Builder
to create a request.default SearchUsersPublisher searchUsersPaginator(SearchUsersRequest searchUsersRequest)
Searches users and lists the ones that meet a set of filter and sort criteria.
This is a variant of
searchUsers(software.amazon.awssdk.services.alexaforbusiness.model.SearchUsersRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.alexaforbusiness.paginators.SearchUsersPublisher publisher = client.searchUsersPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.alexaforbusiness.paginators.SearchUsersPublisher publisher = client.searchUsersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.alexaforbusiness.model.SearchUsersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.alexaforbusiness.model.SearchUsersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
searchUsers(software.amazon.awssdk.services.alexaforbusiness.model.SearchUsersRequest)
operation.
searchUsersRequest
- default SearchUsersPublisher searchUsersPaginator(Consumer<SearchUsersRequest.Builder> searchUsersRequest)
Searches users and lists the ones that meet a set of filter and sort criteria.
This is a variant of
searchUsers(software.amazon.awssdk.services.alexaforbusiness.model.SearchUsersRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.alexaforbusiness.paginators.SearchUsersPublisher publisher = client.searchUsersPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.alexaforbusiness.paginators.SearchUsersPublisher publisher = client.searchUsersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.alexaforbusiness.model.SearchUsersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.alexaforbusiness.model.SearchUsersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
searchUsers(software.amazon.awssdk.services.alexaforbusiness.model.SearchUsersRequest)
operation.
This is a convenience which creates an instance of the SearchUsersRequest.Builder
avoiding the need to
create one manually via SearchUsersRequest.builder()
searchUsersRequest
- A Consumer
that will call methods on SearchUsersRequest.Builder
to create a request.default CompletableFuture<SendInvitationResponse> sendInvitation(SendInvitationRequest sendInvitationRequest)
Sends an enrollment invitation email with a URL to a user. The URL is valid for 72 hours or until you call this operation again, whichever comes first.
sendInvitationRequest
- default CompletableFuture<SendInvitationResponse> sendInvitation(Consumer<SendInvitationRequest.Builder> sendInvitationRequest)
Sends an enrollment invitation email with a URL to a user. The URL is valid for 72 hours or until you call this operation again, whichever comes first.
This is a convenience which creates an instance of the SendInvitationRequest.Builder
avoiding the need to
create one manually via SendInvitationRequest.builder()
sendInvitationRequest
- A Consumer
that will call methods on SendInvitationRequest.Builder
to create a request.default CompletableFuture<StartDeviceSyncResponse> startDeviceSync(StartDeviceSyncRequest startDeviceSyncRequest)
Resets a device and its account to the known default settings by clearing all information and settings set by previous users.
startDeviceSyncRequest
- default CompletableFuture<StartDeviceSyncResponse> startDeviceSync(Consumer<StartDeviceSyncRequest.Builder> startDeviceSyncRequest)
Resets a device and its account to the known default settings by clearing all information and settings set by previous users.
This is a convenience which creates an instance of the StartDeviceSyncRequest.Builder
avoiding the need
to create one manually via StartDeviceSyncRequest.builder()
startDeviceSyncRequest
- A Consumer
that will call methods on StartDeviceSyncRequest.Builder
to create a request.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Adds metadata tags to a specified resource.
tagResourceRequest
- default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds metadata tags to a specified resource.
This is a convenience which creates an instance of the TagResourceRequest.Builder
avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest
- A Consumer
that will call methods on TagResourceRequest.Builder
to create a request.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Removes metadata tags from a specified resource.
untagResourceRequest
- default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes metadata tags from a specified resource.
This is a convenience which creates an instance of the UntagResourceRequest.Builder
avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest
- A Consumer
that will call methods on UntagResourceRequest.Builder
to create a request.default CompletableFuture<UpdateDeviceResponse> updateDevice(UpdateDeviceRequest updateDeviceRequest)
Updates the device name by device ARN.
updateDeviceRequest
- default CompletableFuture<UpdateDeviceResponse> updateDevice(Consumer<UpdateDeviceRequest.Builder> updateDeviceRequest)
Updates the device name by device ARN.
This is a convenience which creates an instance of the UpdateDeviceRequest.Builder
avoiding the need to
create one manually via UpdateDeviceRequest.builder()
updateDeviceRequest
- A Consumer
that will call methods on UpdateDeviceRequest.Builder
to create a request.default CompletableFuture<UpdateProfileResponse> updateProfile(UpdateProfileRequest updateProfileRequest)
Updates an existing room profile by room profile ARN.
updateProfileRequest
- default CompletableFuture<UpdateProfileResponse> updateProfile(Consumer<UpdateProfileRequest.Builder> updateProfileRequest)
Updates an existing room profile by room profile ARN.
This is a convenience which creates an instance of the UpdateProfileRequest.Builder
avoiding the need to
create one manually via UpdateProfileRequest.builder()
updateProfileRequest
- A Consumer
that will call methods on UpdateProfileRequest.Builder
to create a request.default CompletableFuture<UpdateRoomResponse> updateRoom(UpdateRoomRequest updateRoomRequest)
Updates room details by room ARN.
updateRoomRequest
- default CompletableFuture<UpdateRoomResponse> updateRoom(Consumer<UpdateRoomRequest.Builder> updateRoomRequest)
Updates room details by room ARN.
This is a convenience which creates an instance of the UpdateRoomRequest.Builder
avoiding the need to
create one manually via UpdateRoomRequest.builder()
updateRoomRequest
- A Consumer
that will call methods on UpdateRoomRequest.Builder
to create a request.default CompletableFuture<UpdateSkillGroupResponse> updateSkillGroup(UpdateSkillGroupRequest updateSkillGroupRequest)
Updates skill group details by skill group ARN.
updateSkillGroupRequest
- default CompletableFuture<UpdateSkillGroupResponse> updateSkillGroup(Consumer<UpdateSkillGroupRequest.Builder> updateSkillGroupRequest)
Updates skill group details by skill group ARN.
This is a convenience which creates an instance of the UpdateSkillGroupRequest.Builder
avoiding the need
to create one manually via UpdateSkillGroupRequest.builder()
updateSkillGroupRequest
- A Consumer
that will call methods on UpdateSkillGroupRequest.Builder
to create a request.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.