@Generated(value="software.amazon.awssdk:codegen") public interface AlexaForBusinessClient 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 AssociateDeviceWithRoomResponse |
associateDeviceWithRoom(AssociateDeviceWithRoomRequest associateDeviceWithRoomRequest)
Associates a device to a given room.
|
default AssociateDeviceWithRoomResponse |
associateDeviceWithRoom(Consumer<AssociateDeviceWithRoomRequest.Builder> associateDeviceWithRoomRequest)
Associates a device to a given room.
|
default AssociateSkillGroupWithRoomResponse |
associateSkillGroupWithRoom(AssociateSkillGroupWithRoomRequest associateSkillGroupWithRoomRequest)
Associates a skill group to a given room.
|
default AssociateSkillGroupWithRoomResponse |
associateSkillGroupWithRoom(Consumer<AssociateSkillGroupWithRoomRequest.Builder> associateSkillGroupWithRoomRequest)
Associates a skill group to a given room.
|
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 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 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 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 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 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 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 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 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(ListSkillsRequest listSkillsRequest)
Lists all enabled skills in a specific skill group.
|
default ListTagsResponse |
listTags(Consumer<ListTagsRequest.Builder> listTagsRequest)
Lists all tags for a specific resource.
|
default ListTagsResponse |
listTags(ListTagsRequest listTagsRequest)
Lists all tags for a specific resource.
|
default ListTagsIterable |
listTagsPaginator(ListTagsRequest listTagsRequest)
Lists all tags for a specific resource.
|
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 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 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(SearchDevicesRequest searchDevicesRequest)
Searches devices and lists the ones that meet a set of filter 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(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(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(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(SearchUsersRequest searchUsersRequest)
Searches users and lists the ones that meet a set of filter and sort criteria.
|
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 by clearing all information and settings set by
previous users.
|
default 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 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 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 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 AssociateDeviceWithRoomResponse associateDeviceWithRoom(AssociateDeviceWithRoomRequest associateDeviceWithRoomRequest) throws LimitExceededException, SdkServiceException, SdkClientException, AlexaForBusinessException
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
- LimitExceededException
- You are performing an action that would put you beyond your account's limits. HTTP Status Code: 400SdkException
- 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.SdkServiceException
default AssociateDeviceWithRoomResponse associateDeviceWithRoom(Consumer<AssociateDeviceWithRoomRequest.Builder> associateDeviceWithRoomRequest) throws LimitExceededException, SdkServiceException, SdkClientException, AlexaForBusinessException
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
- LimitExceededException
- You are performing an action that would put you beyond your account's limits. HTTP Status Code: 400SdkException
- 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.SdkServiceException
default AssociateSkillGroupWithRoomResponse associateSkillGroupWithRoom(AssociateSkillGroupWithRoomRequest associateSkillGroupWithRoomRequest) throws SdkServiceException, SdkClientException, AlexaForBusinessException
Associates a skill group to a given room. This enables all skills in the associated skill group on all devices in the room.
associateSkillGroupWithRoomRequest
- 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.SdkServiceException
default AssociateSkillGroupWithRoomResponse associateSkillGroupWithRoom(Consumer<AssociateSkillGroupWithRoomRequest.Builder> associateSkillGroupWithRoomRequest) throws SdkServiceException, SdkClientException, AlexaForBusinessException
Associates a skill group to a given room. This enables all skills in the associated skill group on all devices in the room.
associateSkillGroupWithRoomRequest
- 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.SdkServiceException
default CreateProfileResponse createProfile(CreateProfileRequest createProfileRequest) throws LimitExceededException, AlreadyExistsException, SdkServiceException, 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. HTTP Status Code: 400AlreadyExistsException
- The resource being created already exists. HTTP Status Code: 400SdkException
- 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.SdkServiceException
default CreateProfileResponse createProfile(Consumer<CreateProfileRequest.Builder> createProfileRequest) throws LimitExceededException, AlreadyExistsException, SdkServiceException, 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. HTTP Status Code: 400AlreadyExistsException
- The resource being created already exists. HTTP Status Code: 400SdkException
- 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.SdkServiceException
default CreateRoomResponse createRoom(CreateRoomRequest createRoomRequest) throws AlreadyExistsException, LimitExceededException, SdkServiceException, SdkClientException, AlexaForBusinessException
Creates a room with the specified details.
createRoomRequest
- AlreadyExistsException
- The resource being created already exists. HTTP Status Code: 400LimitExceededException
- You are performing an action that would put you beyond your account's limits. HTTP Status Code: 400SdkException
- 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.SdkServiceException
default CreateRoomResponse createRoom(Consumer<CreateRoomRequest.Builder> createRoomRequest) throws AlreadyExistsException, LimitExceededException, SdkServiceException, SdkClientException, AlexaForBusinessException
Creates a room with the specified details.
createRoomRequest
- AlreadyExistsException
- The resource being created already exists. HTTP Status Code: 400LimitExceededException
- You are performing an action that would put you beyond your account's limits. HTTP Status Code: 400SdkException
- 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.SdkServiceException
default CreateSkillGroupResponse createSkillGroup(CreateSkillGroupRequest createSkillGroupRequest) throws AlreadyExistsException, LimitExceededException, SdkServiceException, SdkClientException, AlexaForBusinessException
Creates a skill group with a specified name and description.
createSkillGroupRequest
- AlreadyExistsException
- The resource being created already exists. HTTP Status Code: 400LimitExceededException
- You are performing an action that would put you beyond your account's limits. HTTP Status Code: 400SdkException
- 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.SdkServiceException
default CreateSkillGroupResponse createSkillGroup(Consumer<CreateSkillGroupRequest.Builder> createSkillGroupRequest) throws AlreadyExistsException, LimitExceededException, SdkServiceException, SdkClientException, AlexaForBusinessException
Creates a skill group with a specified name and description.
createSkillGroupRequest
- AlreadyExistsException
- The resource being created already exists. HTTP Status Code: 400LimitExceededException
- You are performing an action that would put you beyond your account's limits. HTTP Status Code: 400SdkException
- 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.SdkServiceException
default CreateUserResponse createUser(CreateUserRequest createUserRequest) throws ResourceInUseException, LimitExceededException, SdkServiceException, SdkClientException, AlexaForBusinessException
Creates a user.
createUserRequest
- ResourceInUseException
- The resource in the request is already in use. HTTP Status Code: 400LimitExceededException
- You are performing an action that would put you beyond your account's limits. HTTP Status Code: 400SdkException
- 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.SdkServiceException
default CreateUserResponse createUser(Consumer<CreateUserRequest.Builder> createUserRequest) throws ResourceInUseException, LimitExceededException, SdkServiceException, SdkClientException, AlexaForBusinessException
Creates a user.
createUserRequest
- ResourceInUseException
- The resource in the request is already in use. HTTP Status Code: 400LimitExceededException
- You are performing an action that would put you beyond your account's limits. HTTP Status Code: 400SdkException
- 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.SdkServiceException
default DeleteProfileResponse deleteProfile(DeleteProfileRequest deleteProfileRequest) throws NotFoundException, SdkServiceException, SdkClientException, AlexaForBusinessException
Deletes a room profile by the profile ARN.
deleteProfileRequest
- NotFoundException
- The resource is not found. HTTP Status Code: 400SdkException
- 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.SdkServiceException
default DeleteProfileResponse deleteProfile(Consumer<DeleteProfileRequest.Builder> deleteProfileRequest) throws NotFoundException, SdkServiceException, SdkClientException, AlexaForBusinessException
Deletes a room profile by the profile ARN.
deleteProfileRequest
- NotFoundException
- The resource is not found. HTTP Status Code: 400SdkException
- 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.SdkServiceException
default DeleteRoomResponse deleteRoom(DeleteRoomRequest deleteRoomRequest) throws NotFoundException, SdkServiceException, SdkClientException, AlexaForBusinessException
Deletes a room by the room ARN.
deleteRoomRequest
- NotFoundException
- The resource is not found. HTTP Status Code: 400SdkException
- 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.SdkServiceException
default DeleteRoomResponse deleteRoom(Consumer<DeleteRoomRequest.Builder> deleteRoomRequest) throws NotFoundException, SdkServiceException, SdkClientException, AlexaForBusinessException
Deletes a room by the room ARN.
deleteRoomRequest
- NotFoundException
- The resource is not found. HTTP Status Code: 400SdkException
- 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.SdkServiceException
default DeleteRoomSkillParameterResponse deleteRoomSkillParameter(DeleteRoomSkillParameterRequest deleteRoomSkillParameterRequest) throws SdkServiceException, SdkClientException, AlexaForBusinessException
Deletes room skill parameter details by room, skill, and parameter key ID.
deleteRoomSkillParameterRequest
- 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.SdkServiceException
default DeleteRoomSkillParameterResponse deleteRoomSkillParameter(Consumer<DeleteRoomSkillParameterRequest.Builder> deleteRoomSkillParameterRequest) throws SdkServiceException, SdkClientException, AlexaForBusinessException
Deletes room skill parameter details by room, skill, and parameter key ID.
deleteRoomSkillParameterRequest
- 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.SdkServiceException
default DeleteSkillGroupResponse deleteSkillGroup(DeleteSkillGroupRequest deleteSkillGroupRequest) throws NotFoundException, SdkServiceException, SdkClientException, AlexaForBusinessException
Deletes a skill group by skill group ARN.
deleteSkillGroupRequest
- NotFoundException
- The resource is not found. HTTP Status Code: 400SdkException
- 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.SdkServiceException
default DeleteSkillGroupResponse deleteSkillGroup(Consumer<DeleteSkillGroupRequest.Builder> deleteSkillGroupRequest) throws NotFoundException, SdkServiceException, SdkClientException, AlexaForBusinessException
Deletes a skill group by skill group ARN.
deleteSkillGroupRequest
- NotFoundException
- The resource is not found. HTTP Status Code: 400SdkException
- 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.SdkServiceException
default DeleteUserResponse deleteUser(DeleteUserRequest deleteUserRequest) throws NotFoundException, SdkServiceException, SdkClientException, AlexaForBusinessException
Deletes a specified user by user ARN and enrollment ARN.
deleteUserRequest
- NotFoundException
- The resource is not found. HTTP Status Code: 400SdkException
- 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.SdkServiceException
default DeleteUserResponse deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest) throws NotFoundException, SdkServiceException, SdkClientException, AlexaForBusinessException
Deletes a specified user by user ARN and enrollment ARN.
deleteUserRequest
- NotFoundException
- The resource is not found. HTTP Status Code: 400SdkException
- 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.SdkServiceException
default DisassociateDeviceFromRoomResponse disassociateDeviceFromRoom(DisassociateDeviceFromRoomRequest disassociateDeviceFromRoomRequest) throws SdkServiceException, 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
- 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.SdkServiceException
default DisassociateDeviceFromRoomResponse disassociateDeviceFromRoom(Consumer<DisassociateDeviceFromRoomRequest.Builder> disassociateDeviceFromRoomRequest) throws SdkServiceException, 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
- 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.SdkServiceException
default DisassociateSkillGroupFromRoomResponse disassociateSkillGroupFromRoom(DisassociateSkillGroupFromRoomRequest disassociateSkillGroupFromRoomRequest) throws SdkServiceException, 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
- 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.SdkServiceException
default DisassociateSkillGroupFromRoomResponse disassociateSkillGroupFromRoom(Consumer<DisassociateSkillGroupFromRoomRequest.Builder> disassociateSkillGroupFromRoomRequest) throws SdkServiceException, 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
- 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.SdkServiceException
default GetDeviceResponse getDevice(GetDeviceRequest getDeviceRequest) throws NotFoundException, SdkServiceException, SdkClientException, AlexaForBusinessException
Gets the details of a device by device ARN.
getDeviceRequest
- NotFoundException
- The resource is not found. HTTP Status Code: 400SdkException
- 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.SdkServiceException
default GetDeviceResponse getDevice(Consumer<GetDeviceRequest.Builder> getDeviceRequest) throws NotFoundException, SdkServiceException, SdkClientException, AlexaForBusinessException
Gets the details of a device by device ARN.
getDeviceRequest
- NotFoundException
- The resource is not found. HTTP Status Code: 400SdkException
- 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.SdkServiceException
default GetProfileResponse getProfile(GetProfileRequest getProfileRequest) throws NotFoundException, SdkServiceException, SdkClientException, AlexaForBusinessException
Gets the details of a room profile by profile ARN.
getProfileRequest
- NotFoundException
- The resource is not found. HTTP Status Code: 400SdkException
- 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.SdkServiceException
default GetProfileResponse getProfile(Consumer<GetProfileRequest.Builder> getProfileRequest) throws NotFoundException, SdkServiceException, SdkClientException, AlexaForBusinessException
Gets the details of a room profile by profile ARN.
getProfileRequest
- NotFoundException
- The resource is not found. HTTP Status Code: 400SdkException
- 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.SdkServiceException
default GetRoomResponse getRoom(GetRoomRequest getRoomRequest) throws NotFoundException, SdkServiceException, SdkClientException, AlexaForBusinessException
Gets room details by room ARN.
getRoomRequest
- NotFoundException
- The resource is not found. HTTP Status Code: 400SdkException
- 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.SdkServiceException
default GetRoomResponse getRoom(Consumer<GetRoomRequest.Builder> getRoomRequest) throws NotFoundException, SdkServiceException, SdkClientException, AlexaForBusinessException
Gets room details by room ARN.
getRoomRequest
- NotFoundException
- The resource is not found. HTTP Status Code: 400SdkException
- 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.SdkServiceException
default GetRoomSkillParameterResponse getRoomSkillParameter(GetRoomSkillParameterRequest getRoomSkillParameterRequest) throws NotFoundException, SdkServiceException, SdkClientException, AlexaForBusinessException
Gets room skill parameter details by room, skill, and parameter key ARN.
getRoomSkillParameterRequest
- NotFoundException
- The resource is not found. HTTP Status Code: 400SdkException
- 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.SdkServiceException
default GetRoomSkillParameterResponse getRoomSkillParameter(Consumer<GetRoomSkillParameterRequest.Builder> getRoomSkillParameterRequest) throws NotFoundException, SdkServiceException, SdkClientException, AlexaForBusinessException
Gets room skill parameter details by room, skill, and parameter key ARN.
getRoomSkillParameterRequest
- NotFoundException
- The resource is not found. HTTP Status Code: 400SdkException
- 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.SdkServiceException
default GetSkillGroupResponse getSkillGroup(GetSkillGroupRequest getSkillGroupRequest) throws NotFoundException, SdkServiceException, SdkClientException, AlexaForBusinessException
Gets skill group details by skill group ARN.
getSkillGroupRequest
- NotFoundException
- The resource is not found. HTTP Status Code: 400SdkException
- 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.SdkServiceException
default GetSkillGroupResponse getSkillGroup(Consumer<GetSkillGroupRequest.Builder> getSkillGroupRequest) throws NotFoundException, SdkServiceException, SdkClientException, AlexaForBusinessException
Gets skill group details by skill group ARN.
getSkillGroupRequest
- NotFoundException
- The resource is not found. HTTP Status Code: 400SdkException
- 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.SdkServiceException
default ListSkillsResponse listSkills(ListSkillsRequest listSkillsRequest) throws SdkServiceException, 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.SdkServiceException
default ListSkillsResponse listSkills(Consumer<ListSkillsRequest.Builder> listSkillsRequest) throws SdkServiceException, 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.SdkServiceException
default ListSkillsIterable listSkillsPaginator(ListSkillsRequest listSkillsRequest) throws SdkServiceException, 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(....);
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.SdkServiceException
default ListTagsResponse listTags(ListTagsRequest listTagsRequest) throws NotFoundException, SdkServiceException, SdkClientException, AlexaForBusinessException
Lists all tags for a specific resource.
listTagsRequest
- NotFoundException
- The resource is not found. HTTP Status Code: 400SdkException
- 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.SdkServiceException
default ListTagsResponse listTags(Consumer<ListTagsRequest.Builder> listTagsRequest) throws NotFoundException, SdkServiceException, SdkClientException, AlexaForBusinessException
Lists all tags for a specific resource.
listTagsRequest
- NotFoundException
- The resource is not found. HTTP Status Code: 400SdkException
- 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.SdkServiceException
default ListTagsIterable listTagsPaginator(ListTagsRequest listTagsRequest) throws NotFoundException, SdkServiceException, SdkClientException, AlexaForBusinessException
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 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(....);
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. HTTP Status Code: 400SdkException
- 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.SdkServiceException
default PutRoomSkillParameterResponse putRoomSkillParameter(PutRoomSkillParameterRequest putRoomSkillParameterRequest) throws SdkServiceException, SdkClientException, AlexaForBusinessException
Updates room skill parameter details by room, skill, and parameter key ID. Not all skills have a room skill parameter.
putRoomSkillParameterRequest
- 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.SdkServiceException
default PutRoomSkillParameterResponse putRoomSkillParameter(Consumer<PutRoomSkillParameterRequest.Builder> putRoomSkillParameterRequest) throws SdkServiceException, SdkClientException, AlexaForBusinessException
Updates room skill parameter details by room, skill, and parameter key ID. Not all skills have a room skill parameter.
putRoomSkillParameterRequest
- 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.SdkServiceException
default ResolveRoomResponse resolveRoom(ResolveRoomRequest resolveRoomRequest) throws NotFoundException, SdkServiceException, SdkClientException, AlexaForBusinessException
Determines the details for the room from which a skill request was invoked. This operation is used by skill developers.
resolveRoomRequest
- NotFoundException
- The resource is not found. HTTP Status Code: 400SdkException
- 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.SdkServiceException
default ResolveRoomResponse resolveRoom(Consumer<ResolveRoomRequest.Builder> resolveRoomRequest) throws NotFoundException, SdkServiceException, SdkClientException, AlexaForBusinessException
Determines the details for the room from which a skill request was invoked. This operation is used by skill developers.
resolveRoomRequest
- NotFoundException
- The resource is not found. HTTP Status Code: 400SdkException
- 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.SdkServiceException
default RevokeInvitationResponse revokeInvitation(RevokeInvitationRequest revokeInvitationRequest) throws NotFoundException, SdkServiceException, SdkClientException, AlexaForBusinessException
Revokes an invitation and invalidates the enrollment URL.
revokeInvitationRequest
- NotFoundException
- The resource is not found. HTTP Status Code: 400SdkException
- 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.SdkServiceException
default RevokeInvitationResponse revokeInvitation(Consumer<RevokeInvitationRequest.Builder> revokeInvitationRequest) throws NotFoundException, SdkServiceException, SdkClientException, AlexaForBusinessException
Revokes an invitation and invalidates the enrollment URL.
revokeInvitationRequest
- NotFoundException
- The resource is not found. HTTP Status Code: 400SdkException
- 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.SdkServiceException
default SearchDevicesResponse searchDevices(SearchDevicesRequest searchDevicesRequest) throws SdkServiceException, 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.SdkServiceException
default SearchDevicesResponse searchDevices(Consumer<SearchDevicesRequest.Builder> searchDevicesRequest) throws SdkServiceException, 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.SdkServiceException
default SearchDevicesIterable searchDevicesPaginator(SearchDevicesRequest searchDevicesRequest) throws SdkServiceException, 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(....);
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.SdkServiceException
default SearchProfilesResponse searchProfiles(SearchProfilesRequest searchProfilesRequest) throws SdkServiceException, 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.SdkServiceException
default SearchProfilesResponse searchProfiles(Consumer<SearchProfilesRequest.Builder> searchProfilesRequest) throws SdkServiceException, 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.SdkServiceException
default SearchProfilesIterable searchProfilesPaginator(SearchProfilesRequest searchProfilesRequest) throws SdkServiceException, 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(....);
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.SdkServiceException
default SearchRoomsResponse searchRooms(SearchRoomsRequest searchRoomsRequest) throws SdkServiceException, 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.SdkServiceException
default SearchRoomsResponse searchRooms(Consumer<SearchRoomsRequest.Builder> searchRoomsRequest) throws SdkServiceException, 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.SdkServiceException
default SearchRoomsIterable searchRoomsPaginator(SearchRoomsRequest searchRoomsRequest) throws SdkServiceException, SdkClientException, AlexaForBusinessException
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 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.SearchRoomsIterable responses = client.searchRoomsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.alexaforbusiness.paginators.SearchRoomsIterable responses = client .searchRoomsPaginator(request); for (software.amazon.awssdk.services.alexaforbusiness.model.SearchRoomsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.alexaforbusiness.paginators.SearchRoomsIterable responses = client.searchRoomsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
searchRooms(software.amazon.awssdk.services.alexaforbusiness.model.SearchRoomsRequest)
operation.
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.SdkServiceException
default SearchSkillGroupsResponse searchSkillGroups(SearchSkillGroupsRequest searchSkillGroupsRequest) throws SdkServiceException, SdkClientException, AlexaForBusinessException
Searches skill groups and lists the ones that meet a set of filter and sort criteria.
searchSkillGroupsRequest
- 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.SdkServiceException
default SearchSkillGroupsResponse searchSkillGroups(Consumer<SearchSkillGroupsRequest.Builder> searchSkillGroupsRequest) throws SdkServiceException, SdkClientException, AlexaForBusinessException
Searches skill groups and lists the ones that meet a set of filter and sort criteria.
searchSkillGroupsRequest
- 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.SdkServiceException
default SearchSkillGroupsIterable searchSkillGroupsPaginator(SearchSkillGroupsRequest searchSkillGroupsRequest) throws SdkServiceException, SdkClientException, AlexaForBusinessException
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 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.SearchSkillGroupsIterable responses = client.searchSkillGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.alexaforbusiness.paginators.SearchSkillGroupsIterable responses = client .searchSkillGroupsPaginator(request); for (software.amazon.awssdk.services.alexaforbusiness.model.SearchSkillGroupsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.alexaforbusiness.paginators.SearchSkillGroupsIterable responses = client.searchSkillGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
searchSkillGroups(software.amazon.awssdk.services.alexaforbusiness.model.SearchSkillGroupsRequest)
operation.
searchSkillGroupsRequest
- 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.SdkServiceException
default SearchUsersResponse searchUsers(SearchUsersRequest searchUsersRequest) throws SdkServiceException, SdkClientException, AlexaForBusinessException
Searches users and lists the ones that meet a set of filter and sort criteria.
searchUsersRequest
- 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.SdkServiceException
default SearchUsersResponse searchUsers(Consumer<SearchUsersRequest.Builder> searchUsersRequest) throws SdkServiceException, SdkClientException, AlexaForBusinessException
Searches users and lists the ones that meet a set of filter and sort criteria.
searchUsersRequest
- 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.SdkServiceException
default SearchUsersIterable searchUsersPaginator(SearchUsersRequest searchUsersRequest) throws SdkServiceException, SdkClientException, AlexaForBusinessException
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 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.SearchUsersIterable responses = client.searchUsersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.alexaforbusiness.paginators.SearchUsersIterable responses = client .searchUsersPaginator(request); for (software.amazon.awssdk.services.alexaforbusiness.model.SearchUsersResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.alexaforbusiness.paginators.SearchUsersIterable responses = client.searchUsersPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
searchUsers(software.amazon.awssdk.services.alexaforbusiness.model.SearchUsersRequest)
operation.
searchUsersRequest
- 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.SdkServiceException
default SendInvitationResponse sendInvitation(SendInvitationRequest sendInvitationRequest) throws NotFoundException, InvalidUserStatusException, SdkServiceException, SdkClientException, AlexaForBusinessException
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
- NotFoundException
- The resource is not found. HTTP Status Code: 400InvalidUserStatusException
- The attempt to update a user is invalid due to the user's current status. HTTP Status Code: 400SdkException
- 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.SdkServiceException
default SendInvitationResponse sendInvitation(Consumer<SendInvitationRequest.Builder> sendInvitationRequest) throws NotFoundException, InvalidUserStatusException, SdkServiceException, SdkClientException, AlexaForBusinessException
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
- NotFoundException
- The resource is not found. HTTP Status Code: 400InvalidUserStatusException
- The attempt to update a user is invalid due to the user's current status. HTTP Status Code: 400SdkException
- 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.SdkServiceException
default StartDeviceSyncResponse startDeviceSync(StartDeviceSyncRequest startDeviceSyncRequest) throws SdkServiceException, SdkClientException, AlexaForBusinessException
Resets a device and its account to the known default settings by clearing all information and settings set by previous users.
startDeviceSyncRequest
- 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.SdkServiceException
default StartDeviceSyncResponse startDeviceSync(Consumer<StartDeviceSyncRequest.Builder> startDeviceSyncRequest) throws SdkServiceException, SdkClientException, AlexaForBusinessException
Resets a device and its account to the known default settings by clearing all information and settings set by previous users.
startDeviceSyncRequest
- 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.SdkServiceException
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws NotFoundException, SdkServiceException, SdkClientException, AlexaForBusinessException
Adds metadata tags to a specified resource.
tagResourceRequest
- NotFoundException
- The resource is not found. HTTP Status Code: 400SdkException
- 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.SdkServiceException
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws NotFoundException, SdkServiceException, SdkClientException, AlexaForBusinessException
Adds metadata tags to a specified resource.
tagResourceRequest
- NotFoundException
- The resource is not found. HTTP Status Code: 400SdkException
- 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.SdkServiceException
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws NotFoundException, SdkServiceException, SdkClientException, AlexaForBusinessException
Removes metadata tags from a specified resource.
untagResourceRequest
- NotFoundException
- The resource is not found. HTTP Status Code: 400SdkException
- 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.SdkServiceException
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws NotFoundException, SdkServiceException, SdkClientException, AlexaForBusinessException
Removes metadata tags from a specified resource.
untagResourceRequest
- NotFoundException
- The resource is not found. HTTP Status Code: 400SdkException
- 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.SdkServiceException
default UpdateDeviceResponse updateDevice(UpdateDeviceRequest updateDeviceRequest) throws NotFoundException, SdkServiceException, SdkClientException, AlexaForBusinessException
Updates the device name by device ARN.
updateDeviceRequest
- NotFoundException
- The resource is not found. HTTP Status Code: 400SdkException
- 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.SdkServiceException
default UpdateDeviceResponse updateDevice(Consumer<UpdateDeviceRequest.Builder> updateDeviceRequest) throws NotFoundException, SdkServiceException, SdkClientException, AlexaForBusinessException
Updates the device name by device ARN.
updateDeviceRequest
- NotFoundException
- The resource is not found. HTTP Status Code: 400SdkException
- 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.SdkServiceException
default UpdateProfileResponse updateProfile(UpdateProfileRequest updateProfileRequest) throws NotFoundException, NameInUseException, SdkServiceException, SdkClientException, AlexaForBusinessException
Updates an existing room profile by room profile ARN.
updateProfileRequest
- NotFoundException
- The resource is not found. HTTP Status Code: 400NameInUseException
- The name sent in the request is already in use. HTTP Status Code: 400SdkException
- 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.SdkServiceException
default UpdateProfileResponse updateProfile(Consumer<UpdateProfileRequest.Builder> updateProfileRequest) throws NotFoundException, NameInUseException, SdkServiceException, SdkClientException, AlexaForBusinessException
Updates an existing room profile by room profile ARN.
updateProfileRequest
- NotFoundException
- The resource is not found. HTTP Status Code: 400NameInUseException
- The name sent in the request is already in use. HTTP Status Code: 400SdkException
- 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.SdkServiceException
default UpdateRoomResponse updateRoom(UpdateRoomRequest updateRoomRequest) throws NotFoundException, NameInUseException, SdkServiceException, SdkClientException, AlexaForBusinessException
Updates room details by room ARN.
updateRoomRequest
- NotFoundException
- The resource is not found. HTTP Status Code: 400NameInUseException
- The name sent in the request is already in use. HTTP Status Code: 400SdkException
- 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.SdkServiceException
default UpdateRoomResponse updateRoom(Consumer<UpdateRoomRequest.Builder> updateRoomRequest) throws NotFoundException, NameInUseException, SdkServiceException, SdkClientException, AlexaForBusinessException
Updates room details by room ARN.
updateRoomRequest
- NotFoundException
- The resource is not found. HTTP Status Code: 400NameInUseException
- The name sent in the request is already in use. HTTP Status Code: 400SdkException
- 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.SdkServiceException
default UpdateSkillGroupResponse updateSkillGroup(UpdateSkillGroupRequest updateSkillGroupRequest) throws NotFoundException, NameInUseException, SdkServiceException, SdkClientException, AlexaForBusinessException
Updates skill group details by skill group ARN.
updateSkillGroupRequest
- NotFoundException
- The resource is not found. HTTP Status Code: 400NameInUseException
- The name sent in the request is already in use. HTTP Status Code: 400SdkException
- 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.SdkServiceException
default UpdateSkillGroupResponse updateSkillGroup(Consumer<UpdateSkillGroupRequest.Builder> updateSkillGroupRequest) throws NotFoundException, NameInUseException, SdkServiceException, SdkClientException, AlexaForBusinessException
Updates skill group details by skill group ARN.
updateSkillGroupRequest
- NotFoundException
- The resource is not found. HTTP Status Code: 400NameInUseException
- The name sent in the request is already in use. HTTP Status Code: 400SdkException
- 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.SdkServiceException
static ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.