Interface ChimeClient
- All Superinterfaces:
 AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
builder() method.
 Most of these APIs are no longer supported and will not be updated. We recommend using the latest versions in the Amazon Chime SDK API reference, in the Amazon Chime SDK.
Using the latest versions requires migrating to dedicated namespaces. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
The Amazon Chime application programming interface (API) is designed so administrators can perform key tasks, such as creating and managing Amazon Chime accounts, users, and Voice Connectors. This guide provides detailed information about the Amazon Chime API, including operations, types, inputs and outputs, and error codes.
You can use an AWS SDK, the AWS Command Line Interface (AWS CLI), or the REST API to make API calls for Amazon Chime. We recommend using an AWS SDK or the AWS CLI. The page for each API action contains a See Also section that includes links to information about using the action with a language-specific AWS SDK or the AWS CLI.
- Using an AWS SDK
 - 
 
You don't need to write code to calculate a signature for request authentication. The SDK clients authenticate your requests by using access keys that you provide. For more information about AWS SDKs, see the AWS Developer Center.
 - Using the AWS CLI
 - 
 
Use your access keys with the AWS CLI to make API calls. For information about setting up the AWS CLI, see Installing the AWS Command Line Interface in the AWS Command Line Interface User Guide. For a list of available Amazon Chime commands, see the Amazon Chime commands in the AWS CLI Command Reference.
 - Using REST APIs
 - 
 
If you use REST to make API calls, you must authenticate your request by providing a signature. Amazon Chime supports Signature Version 4. For more information, see Signature Version 4 Signing Process in the Amazon Web Services General Reference.
When making REST API calls, use the service name
chimeand REST endpointhttps://service.chime.aws.amazon.com. 
Administrative permissions are controlled using AWS Identity and Access Management (IAM). For more information, see Identity and Access Management for Amazon Chime in the Amazon Chime Administration Guide.
- 
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String - 
Method Summary
Modifier and TypeMethodDescriptionassociatePhoneNumberWithUser(Consumer<AssociatePhoneNumberWithUserRequest.Builder> associatePhoneNumberWithUserRequest) Associates a phone number with the specified Amazon Chime user.associatePhoneNumberWithUser(AssociatePhoneNumberWithUserRequest associatePhoneNumberWithUserRequest) Associates a phone number with the specified Amazon Chime user.associateSigninDelegateGroupsWithAccount(Consumer<AssociateSigninDelegateGroupsWithAccountRequest.Builder> associateSigninDelegateGroupsWithAccountRequest) Associates the specified sign-in delegate groups with the specified Amazon Chime account.associateSigninDelegateGroupsWithAccount(AssociateSigninDelegateGroupsWithAccountRequest associateSigninDelegateGroupsWithAccountRequest) Associates the specified sign-in delegate groups with the specified Amazon Chime account.batchCreateRoomMembership(Consumer<BatchCreateRoomMembershipRequest.Builder> batchCreateRoomMembershipRequest) Adds up to 50 members to a chat room in an Amazon Chime Enterprise account.batchCreateRoomMembership(BatchCreateRoomMembershipRequest batchCreateRoomMembershipRequest) Adds up to 50 members to a chat room in an Amazon Chime Enterprise account.default BatchDeletePhoneNumberResponsebatchDeletePhoneNumber(Consumer<BatchDeletePhoneNumberRequest.Builder> batchDeletePhoneNumberRequest) Moves phone numbers into the Deletion queue.default BatchDeletePhoneNumberResponsebatchDeletePhoneNumber(BatchDeletePhoneNumberRequest batchDeletePhoneNumberRequest) Moves phone numbers into the Deletion queue.default BatchSuspendUserResponsebatchSuspendUser(Consumer<BatchSuspendUserRequest.Builder> batchSuspendUserRequest) Suspends up to 50 users from aTeamorEnterpriseLWAAmazon Chime account.default BatchSuspendUserResponsebatchSuspendUser(BatchSuspendUserRequest batchSuspendUserRequest) Suspends up to 50 users from aTeamorEnterpriseLWAAmazon Chime account.default BatchUnsuspendUserResponsebatchUnsuspendUser(Consumer<BatchUnsuspendUserRequest.Builder> batchUnsuspendUserRequest) Removes the suspension from up to 50 previously suspended users for the specified Amazon ChimeEnterpriseLWAaccount.default BatchUnsuspendUserResponsebatchUnsuspendUser(BatchUnsuspendUserRequest batchUnsuspendUserRequest) Removes the suspension from up to 50 previously suspended users for the specified Amazon ChimeEnterpriseLWAaccount.default BatchUpdatePhoneNumberResponsebatchUpdatePhoneNumber(Consumer<BatchUpdatePhoneNumberRequest.Builder> batchUpdatePhoneNumberRequest) Updates phone number product types or calling names.default BatchUpdatePhoneNumberResponsebatchUpdatePhoneNumber(BatchUpdatePhoneNumberRequest batchUpdatePhoneNumberRequest) Updates phone number product types or calling names.default BatchUpdateUserResponsebatchUpdateUser(Consumer<BatchUpdateUserRequest.Builder> batchUpdateUserRequest) Updates user details within the UpdateUserRequestItem object for up to 20 users for the specified Amazon Chime account.default BatchUpdateUserResponsebatchUpdateUser(BatchUpdateUserRequest batchUpdateUserRequest) Updates user details within the UpdateUserRequestItem object for up to 20 users for the specified Amazon Chime account.static ChimeClientBuilderbuilder()Create a builder that can be used to configure and create aChimeClient.static ChimeClientcreate()Create aChimeClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateAccountResponsecreateAccount(Consumer<CreateAccountRequest.Builder> createAccountRequest) Creates an Amazon Chime account under the administrator's AWS account.default CreateAccountResponsecreateAccount(CreateAccountRequest createAccountRequest) Creates an Amazon Chime account under the administrator's AWS account.default CreateBotResponsecreateBot(Consumer<CreateBotRequest.Builder> createBotRequest) Creates a bot for an Amazon Chime Enterprise account.default CreateBotResponsecreateBot(CreateBotRequest createBotRequest) Creates a bot for an Amazon Chime Enterprise account.default CreateMeetingDialOutResponsecreateMeetingDialOut(Consumer<CreateMeetingDialOutRequest.Builder> createMeetingDialOutRequest) Uses the join token and call metadata in a meeting request (From number, To number, and so forth) to initiate an outbound call to a public switched telephone network (PSTN) and join them into a Chime meeting.default CreateMeetingDialOutResponsecreateMeetingDialOut(CreateMeetingDialOutRequest createMeetingDialOutRequest) Uses the join token and call metadata in a meeting request (From number, To number, and so forth) to initiate an outbound call to a public switched telephone network (PSTN) and join them into a Chime meeting.default CreatePhoneNumberOrderResponsecreatePhoneNumberOrder(Consumer<CreatePhoneNumberOrderRequest.Builder> createPhoneNumberOrderRequest) Creates an order for phone numbers to be provisioned.default CreatePhoneNumberOrderResponsecreatePhoneNumberOrder(CreatePhoneNumberOrderRequest createPhoneNumberOrderRequest) Creates an order for phone numbers to be provisioned.default CreateRoomResponsecreateRoom(Consumer<CreateRoomRequest.Builder> createRoomRequest) Creates a chat room for the specified Amazon Chime Enterprise account.default CreateRoomResponsecreateRoom(CreateRoomRequest createRoomRequest) Creates a chat room for the specified Amazon Chime Enterprise account.default CreateRoomMembershipResponsecreateRoomMembership(Consumer<CreateRoomMembershipRequest.Builder> createRoomMembershipRequest) Adds a member to a chat room in an Amazon Chime Enterprise account.default CreateRoomMembershipResponsecreateRoomMembership(CreateRoomMembershipRequest createRoomMembershipRequest) Adds a member to a chat room in an Amazon Chime Enterprise account.default CreateUserResponsecreateUser(Consumer<CreateUserRequest.Builder> createUserRequest) Creates a user under the specified Amazon Chime account.default CreateUserResponsecreateUser(CreateUserRequest createUserRequest) Creates a user under the specified Amazon Chime account.default DeleteAccountResponsedeleteAccount(Consumer<DeleteAccountRequest.Builder> deleteAccountRequest) Deletes the specified Amazon Chime account.default DeleteAccountResponsedeleteAccount(DeleteAccountRequest deleteAccountRequest) Deletes the specified Amazon Chime account.deleteEventsConfiguration(Consumer<DeleteEventsConfigurationRequest.Builder> deleteEventsConfigurationRequest) Deletes the events configuration that allows a bot to receive outgoing events.deleteEventsConfiguration(DeleteEventsConfigurationRequest deleteEventsConfigurationRequest) Deletes the events configuration that allows a bot to receive outgoing events.default DeletePhoneNumberResponsedeletePhoneNumber(Consumer<DeletePhoneNumberRequest.Builder> deletePhoneNumberRequest) Moves the specified phone number into the Deletion queue.default DeletePhoneNumberResponsedeletePhoneNumber(DeletePhoneNumberRequest deletePhoneNumberRequest) Moves the specified phone number into the Deletion queue.default DeleteRoomResponsedeleteRoom(Consumer<DeleteRoomRequest.Builder> deleteRoomRequest) Deletes a chat room in an Amazon Chime Enterprise account.default DeleteRoomResponsedeleteRoom(DeleteRoomRequest deleteRoomRequest) Deletes a chat room in an Amazon Chime Enterprise account.default DeleteRoomMembershipResponsedeleteRoomMembership(Consumer<DeleteRoomMembershipRequest.Builder> deleteRoomMembershipRequest) Removes a member from a chat room in an Amazon Chime Enterprise account.default DeleteRoomMembershipResponsedeleteRoomMembership(DeleteRoomMembershipRequest deleteRoomMembershipRequest) Removes a member from a chat room in an Amazon Chime Enterprise account.disassociatePhoneNumberFromUser(Consumer<DisassociatePhoneNumberFromUserRequest.Builder> disassociatePhoneNumberFromUserRequest) Disassociates the primary provisioned phone number from the specified Amazon Chime user.disassociatePhoneNumberFromUser(DisassociatePhoneNumberFromUserRequest disassociatePhoneNumberFromUserRequest) Disassociates the primary provisioned phone number from the specified Amazon Chime user.disassociateSigninDelegateGroupsFromAccount(Consumer<DisassociateSigninDelegateGroupsFromAccountRequest.Builder> disassociateSigninDelegateGroupsFromAccountRequest) Disassociates the specified sign-in delegate groups from the specified Amazon Chime account.disassociateSigninDelegateGroupsFromAccount(DisassociateSigninDelegateGroupsFromAccountRequest disassociateSigninDelegateGroupsFromAccountRequest) Disassociates the specified sign-in delegate groups from the specified Amazon Chime account.default GetAccountResponsegetAccount(Consumer<GetAccountRequest.Builder> getAccountRequest) Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.default GetAccountResponsegetAccount(GetAccountRequest getAccountRequest) Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.default GetAccountSettingsResponsegetAccountSettings(Consumer<GetAccountSettingsRequest.Builder> getAccountSettingsRequest) Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dialout settings.default GetAccountSettingsResponsegetAccountSettings(GetAccountSettingsRequest getAccountSettingsRequest) Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dialout settings.default GetBotResponsegetBot(Consumer<GetBotRequest.Builder> getBotRequest) Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.default GetBotResponsegetBot(GetBotRequest getBotRequest) Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.default GetEventsConfigurationResponsegetEventsConfiguration(Consumer<GetEventsConfigurationRequest.Builder> getEventsConfigurationRequest) Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.default GetEventsConfigurationResponsegetEventsConfiguration(GetEventsConfigurationRequest getEventsConfigurationRequest) Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.default GetGlobalSettingsResponsegetGlobalSettings(Consumer<GetGlobalSettingsRequest.Builder> getGlobalSettingsRequest) Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.default GetGlobalSettingsResponsegetGlobalSettings(GetGlobalSettingsRequest getGlobalSettingsRequest) Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.default GetPhoneNumberResponsegetPhoneNumber(Consumer<GetPhoneNumberRequest.Builder> getPhoneNumberRequest) Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.default GetPhoneNumberResponsegetPhoneNumber(GetPhoneNumberRequest getPhoneNumberRequest) Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.default GetPhoneNumberOrderResponsegetPhoneNumberOrder(Consumer<GetPhoneNumberOrderRequest.Builder> getPhoneNumberOrderRequest) Retrieves details for the specified phone number order, such as the order creation timestamp, phone numbers in E.164 format, product type, and order status.default GetPhoneNumberOrderResponsegetPhoneNumberOrder(GetPhoneNumberOrderRequest getPhoneNumberOrderRequest) Retrieves details for the specified phone number order, such as the order creation timestamp, phone numbers in E.164 format, product type, and order status.default GetPhoneNumberSettingsResponsegetPhoneNumberSettings(Consumer<GetPhoneNumberSettingsRequest.Builder> getPhoneNumberSettingsRequest) Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.default GetPhoneNumberSettingsResponsegetPhoneNumberSettings(GetPhoneNumberSettingsRequest getPhoneNumberSettingsRequest) Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.default GetRetentionSettingsResponsegetRetentionSettings(Consumer<GetRetentionSettingsRequest.Builder> getRetentionSettingsRequest) Gets the retention settings for the specified Amazon Chime Enterprise account.default GetRetentionSettingsResponsegetRetentionSettings(GetRetentionSettingsRequest getRetentionSettingsRequest) Gets the retention settings for the specified Amazon Chime Enterprise account.default GetRoomResponsegetRoom(Consumer<GetRoomRequest.Builder> getRoomRequest) Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.default GetRoomResponsegetRoom(GetRoomRequest getRoomRequest) Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.default GetUserResponsegetUser(Consumer<GetUserRequest.Builder> getUserRequest) Retrieves details for the specified user ID, such as primary email address, license type,and personal meeting PIN.default GetUserResponsegetUser(GetUserRequest getUserRequest) Retrieves details for the specified user ID, such as primary email address, license type,and personal meeting PIN.default GetUserSettingsResponsegetUserSettings(Consumer<GetUserSettingsRequest.Builder> getUserSettingsRequest) Retrieves settings for the specified user ID, such as any associated phone number settings.default GetUserSettingsResponsegetUserSettings(GetUserSettingsRequest getUserSettingsRequest) Retrieves settings for the specified user ID, such as any associated phone number settings.default InviteUsersResponseinviteUsers(Consumer<InviteUsersRequest.Builder> inviteUsersRequest) Sends email to a maximum of 50 users, inviting them to the specified Amazon ChimeTeamaccount.default InviteUsersResponseinviteUsers(InviteUsersRequest inviteUsersRequest) Sends email to a maximum of 50 users, inviting them to the specified Amazon ChimeTeamaccount.default ListAccountsResponseLists the Amazon Chime accounts under the administrator's AWS account.default ListAccountsResponselistAccounts(Consumer<ListAccountsRequest.Builder> listAccountsRequest) Lists the Amazon Chime accounts under the administrator's AWS account.default ListAccountsResponselistAccounts(ListAccountsRequest listAccountsRequest) Lists the Amazon Chime accounts under the administrator's AWS account.default ListAccountsIterableThis is a variant oflistAccounts(software.amazon.awssdk.services.chime.model.ListAccountsRequest)operation.default ListAccountsIterablelistAccountsPaginator(Consumer<ListAccountsRequest.Builder> listAccountsRequest) This is a variant oflistAccounts(software.amazon.awssdk.services.chime.model.ListAccountsRequest)operation.default ListAccountsIterablelistAccountsPaginator(ListAccountsRequest listAccountsRequest) This is a variant oflistAccounts(software.amazon.awssdk.services.chime.model.ListAccountsRequest)operation.default ListBotsResponselistBots(Consumer<ListBotsRequest.Builder> listBotsRequest) Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.default ListBotsResponselistBots(ListBotsRequest listBotsRequest) Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.default ListBotsIterablelistBotsPaginator(Consumer<ListBotsRequest.Builder> listBotsRequest) This is a variant oflistBots(software.amazon.awssdk.services.chime.model.ListBotsRequest)operation.default ListBotsIterablelistBotsPaginator(ListBotsRequest listBotsRequest) This is a variant oflistBots(software.amazon.awssdk.services.chime.model.ListBotsRequest)operation.default ListPhoneNumberOrdersResponselistPhoneNumberOrders(Consumer<ListPhoneNumberOrdersRequest.Builder> listPhoneNumberOrdersRequest) Lists the phone number orders for the administrator's Amazon Chime account.default ListPhoneNumberOrdersResponselistPhoneNumberOrders(ListPhoneNumberOrdersRequest listPhoneNumberOrdersRequest) Lists the phone number orders for the administrator's Amazon Chime account.default ListPhoneNumberOrdersIterablelistPhoneNumberOrdersPaginator(Consumer<ListPhoneNumberOrdersRequest.Builder> listPhoneNumberOrdersRequest) This is a variant oflistPhoneNumberOrders(software.amazon.awssdk.services.chime.model.ListPhoneNumberOrdersRequest)operation.default ListPhoneNumberOrdersIterablelistPhoneNumberOrdersPaginator(ListPhoneNumberOrdersRequest listPhoneNumberOrdersRequest) This is a variant oflistPhoneNumberOrders(software.amazon.awssdk.services.chime.model.ListPhoneNumberOrdersRequest)operation.default ListPhoneNumbersResponselistPhoneNumbers(Consumer<ListPhoneNumbersRequest.Builder> listPhoneNumbersRequest) Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.default ListPhoneNumbersResponselistPhoneNumbers(ListPhoneNumbersRequest listPhoneNumbersRequest) Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.default ListPhoneNumbersIterablelistPhoneNumbersPaginator(Consumer<ListPhoneNumbersRequest.Builder> listPhoneNumbersRequest) This is a variant oflistPhoneNumbers(software.amazon.awssdk.services.chime.model.ListPhoneNumbersRequest)operation.default ListPhoneNumbersIterablelistPhoneNumbersPaginator(ListPhoneNumbersRequest listPhoneNumbersRequest) This is a variant oflistPhoneNumbers(software.amazon.awssdk.services.chime.model.ListPhoneNumbersRequest)operation.default ListRoomMembershipsResponselistRoomMemberships(Consumer<ListRoomMembershipsRequest.Builder> listRoomMembershipsRequest) Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members' IDs, email addresses, and names.default ListRoomMembershipsResponselistRoomMemberships(ListRoomMembershipsRequest listRoomMembershipsRequest) Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members' IDs, email addresses, and names.default ListRoomMembershipsIterablelistRoomMembershipsPaginator(Consumer<ListRoomMembershipsRequest.Builder> listRoomMembershipsRequest) This is a variant oflistRoomMemberships(software.amazon.awssdk.services.chime.model.ListRoomMembershipsRequest)operation.default ListRoomMembershipsIterablelistRoomMembershipsPaginator(ListRoomMembershipsRequest listRoomMembershipsRequest) This is a variant oflistRoomMemberships(software.amazon.awssdk.services.chime.model.ListRoomMembershipsRequest)operation.default ListRoomsResponselistRooms(Consumer<ListRoomsRequest.Builder> listRoomsRequest) Lists the room details for the specified Amazon Chime Enterprise account.default ListRoomsResponselistRooms(ListRoomsRequest listRoomsRequest) Lists the room details for the specified Amazon Chime Enterprise account.default ListRoomsIterablelistRoomsPaginator(Consumer<ListRoomsRequest.Builder> listRoomsRequest) This is a variant oflistRooms(software.amazon.awssdk.services.chime.model.ListRoomsRequest)operation.default ListRoomsIterablelistRoomsPaginator(ListRoomsRequest listRoomsRequest) This is a variant oflistRooms(software.amazon.awssdk.services.chime.model.ListRoomsRequest)operation.listSupportedPhoneNumberCountries(Consumer<ListSupportedPhoneNumberCountriesRequest.Builder> listSupportedPhoneNumberCountriesRequest) Lists supported phone number countries.listSupportedPhoneNumberCountries(ListSupportedPhoneNumberCountriesRequest listSupportedPhoneNumberCountriesRequest) Lists supported phone number countries.default ListUsersResponselistUsers(Consumer<ListUsersRequest.Builder> listUsersRequest) Lists the users that belong to the specified Amazon Chime account.default ListUsersResponselistUsers(ListUsersRequest listUsersRequest) Lists the users that belong to the specified Amazon Chime account.default ListUsersIterablelistUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest) This is a variant oflistUsers(software.amazon.awssdk.services.chime.model.ListUsersRequest)operation.default ListUsersIterablelistUsersPaginator(ListUsersRequest listUsersRequest) This is a variant oflistUsers(software.amazon.awssdk.services.chime.model.ListUsersRequest)operation.default LogoutUserResponselogoutUser(Consumer<LogoutUserRequest.Builder> logoutUserRequest) Logs out the specified user from all of the devices they are currently logged into.default LogoutUserResponselogoutUser(LogoutUserRequest logoutUserRequest) Logs out the specified user from all of the devices they are currently logged into.default PutEventsConfigurationResponseputEventsConfiguration(Consumer<PutEventsConfigurationRequest.Builder> putEventsConfigurationRequest) Creates an events configuration that allows a bot to receive outgoing events sent by Amazon Chime.default PutEventsConfigurationResponseputEventsConfiguration(PutEventsConfigurationRequest putEventsConfigurationRequest) Creates an events configuration that allows a bot to receive outgoing events sent by Amazon Chime.default PutRetentionSettingsResponseputRetentionSettings(Consumer<PutRetentionSettingsRequest.Builder> putRetentionSettingsRequest) Puts retention settings for the specified Amazon Chime Enterprise account.default PutRetentionSettingsResponseputRetentionSettings(PutRetentionSettingsRequest putRetentionSettingsRequest) Puts retention settings for the specified Amazon Chime Enterprise account.redactConversationMessage(Consumer<RedactConversationMessageRequest.Builder> redactConversationMessageRequest) Redacts the specified message from the specified Amazon Chime conversation.redactConversationMessage(RedactConversationMessageRequest redactConversationMessageRequest) Redacts the specified message from the specified Amazon Chime conversation.default RedactRoomMessageResponseredactRoomMessage(Consumer<RedactRoomMessageRequest.Builder> redactRoomMessageRequest) Redacts the specified message from the specified Amazon Chime channel.default RedactRoomMessageResponseredactRoomMessage(RedactRoomMessageRequest redactRoomMessageRequest) Redacts the specified message from the specified Amazon Chime channel.default RegenerateSecurityTokenResponseregenerateSecurityToken(Consumer<RegenerateSecurityTokenRequest.Builder> regenerateSecurityTokenRequest) Regenerates the security token for a bot.default RegenerateSecurityTokenResponseregenerateSecurityToken(RegenerateSecurityTokenRequest regenerateSecurityTokenRequest) Regenerates the security token for a bot.default ResetPersonalPinResponseresetPersonalPIN(Consumer<ResetPersonalPinRequest.Builder> resetPersonalPinRequest) Resets the personal meeting PIN for the specified user on an Amazon Chime account.default ResetPersonalPinResponseresetPersonalPIN(ResetPersonalPinRequest resetPersonalPinRequest) Resets the personal meeting PIN for the specified user on an Amazon Chime account.default RestorePhoneNumberResponserestorePhoneNumber(Consumer<RestorePhoneNumberRequest.Builder> restorePhoneNumberRequest) Moves a phone number from the Deletion queue back into the phone number Inventory.default RestorePhoneNumberResponserestorePhoneNumber(RestorePhoneNumberRequest restorePhoneNumberRequest) Moves a phone number from the Deletion queue back into the phone number Inventory.searchAvailablePhoneNumbers(Consumer<SearchAvailablePhoneNumbersRequest.Builder> searchAvailablePhoneNumbersRequest) Searches for phone numbers that can be ordered.searchAvailablePhoneNumbers(SearchAvailablePhoneNumbersRequest searchAvailablePhoneNumbersRequest) Searches for phone numbers that can be ordered.searchAvailablePhoneNumbersPaginator(Consumer<SearchAvailablePhoneNumbersRequest.Builder> searchAvailablePhoneNumbersRequest) This is a variant ofsearchAvailablePhoneNumbers(software.amazon.awssdk.services.chime.model.SearchAvailablePhoneNumbersRequest)operation.searchAvailablePhoneNumbersPaginator(SearchAvailablePhoneNumbersRequest searchAvailablePhoneNumbersRequest) This is a variant ofsearchAvailablePhoneNumbers(software.amazon.awssdk.services.chime.model.SearchAvailablePhoneNumbersRequest)operation.default ChimeServiceClientConfigurationThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadatadefault UpdateAccountResponseupdateAccount(Consumer<UpdateAccountRequest.Builder> updateAccountRequest) Updates account details for the specified Amazon Chime account.default UpdateAccountResponseupdateAccount(UpdateAccountRequest updateAccountRequest) Updates account details for the specified Amazon Chime account.default UpdateAccountSettingsResponseupdateAccountSettings(Consumer<UpdateAccountSettingsRequest.Builder> updateAccountSettingsRequest) Updates the settings for the specified Amazon Chime account.default UpdateAccountSettingsResponseupdateAccountSettings(UpdateAccountSettingsRequest updateAccountSettingsRequest) Updates the settings for the specified Amazon Chime account.default UpdateBotResponseupdateBot(Consumer<UpdateBotRequest.Builder> updateBotRequest) Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.default UpdateBotResponseupdateBot(UpdateBotRequest updateBotRequest) Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.default UpdateGlobalSettingsResponseupdateGlobalSettings(Consumer<UpdateGlobalSettingsRequest.Builder> updateGlobalSettingsRequest) Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.default UpdateGlobalSettingsResponseupdateGlobalSettings(UpdateGlobalSettingsRequest updateGlobalSettingsRequest) Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.default UpdatePhoneNumberResponseupdatePhoneNumber(Consumer<UpdatePhoneNumberRequest.Builder> updatePhoneNumberRequest) Updates phone number details, such as product type or calling name, for the specified phone number ID.default UpdatePhoneNumberResponseupdatePhoneNumber(UpdatePhoneNumberRequest updatePhoneNumberRequest) Updates phone number details, such as product type or calling name, for the specified phone number ID.updatePhoneNumberSettings(Consumer<UpdatePhoneNumberSettingsRequest.Builder> updatePhoneNumberSettingsRequest) Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name.updatePhoneNumberSettings(UpdatePhoneNumberSettingsRequest updatePhoneNumberSettingsRequest) Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name.default UpdateRoomResponseupdateRoom(Consumer<UpdateRoomRequest.Builder> updateRoomRequest) Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account.default UpdateRoomResponseupdateRoom(UpdateRoomRequest updateRoomRequest) Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account.default UpdateRoomMembershipResponseupdateRoomMembership(Consumer<UpdateRoomMembershipRequest.Builder> updateRoomMembershipRequest) Updates room membership details, such as the member role, for a room in an Amazon Chime Enterprise account.default UpdateRoomMembershipResponseupdateRoomMembership(UpdateRoomMembershipRequest updateRoomMembershipRequest) Updates room membership details, such as the member role, for a room in an Amazon Chime Enterprise account.default UpdateUserResponseupdateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest) Updates user details for a specified user ID.default UpdateUserResponseupdateUser(UpdateUserRequest updateUserRequest) Updates user details for a specified user ID.default UpdateUserSettingsResponseupdateUserSettings(Consumer<UpdateUserSettingsRequest.Builder> updateUserSettingsRequest) Updates the settings for the specified user, such as phone number settings.default UpdateUserSettingsResponseupdateUserSettings(UpdateUserSettingsRequest updateUserSettingsRequest) Updates the settings for the specified user, such as phone number settings.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName 
- 
Field Details
- 
SERVICE_NAME
- See Also:
 
 - 
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
 
 
 - 
 - 
Method Details
- 
associatePhoneNumberWithUser
default AssociatePhoneNumberWithUserResponse associatePhoneNumberWithUser(AssociatePhoneNumberWithUserRequest associatePhoneNumberWithUserRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, AccessDeniedException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Associates a phone number with the specified Amazon Chime user.
- Parameters:
 associatePhoneNumberWithUserRequest-- Returns:
 - Result of the AssociatePhoneNumberWithUser operation returned by the service.
 - See Also:
 
 - 
associatePhoneNumberWithUser
default AssociatePhoneNumberWithUserResponse associatePhoneNumberWithUser(Consumer<AssociatePhoneNumberWithUserRequest.Builder> associatePhoneNumberWithUserRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, AccessDeniedException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Associates a phone number with the specified Amazon Chime user.
This is a convenience which creates an instance of the
AssociatePhoneNumberWithUserRequest.Builderavoiding the need to create one manually viaAssociatePhoneNumberWithUserRequest.builder()- Parameters:
 associatePhoneNumberWithUserRequest- AConsumerthat will call methods onAssociatePhoneNumberWithUserRequest.Builderto create a request.- Returns:
 - Result of the AssociatePhoneNumberWithUser operation returned by the service.
 - See Also:
 
 - 
associateSigninDelegateGroupsWithAccount
default AssociateSigninDelegateGroupsWithAccountResponse associateSigninDelegateGroupsWithAccount(AssociateSigninDelegateGroupsWithAccountRequest associateSigninDelegateGroupsWithAccountRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Associates the specified sign-in delegate groups with the specified Amazon Chime account.
- Parameters:
 associateSigninDelegateGroupsWithAccountRequest-- Returns:
 - Result of the AssociateSigninDelegateGroupsWithAccount operation returned by the service.
 - See Also:
 
 - 
associateSigninDelegateGroupsWithAccount
default AssociateSigninDelegateGroupsWithAccountResponse associateSigninDelegateGroupsWithAccount(Consumer<AssociateSigninDelegateGroupsWithAccountRequest.Builder> associateSigninDelegateGroupsWithAccountRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Associates the specified sign-in delegate groups with the specified Amazon Chime account.
This is a convenience which creates an instance of the
AssociateSigninDelegateGroupsWithAccountRequest.Builderavoiding the need to create one manually viaAssociateSigninDelegateGroupsWithAccountRequest.builder()- Parameters:
 associateSigninDelegateGroupsWithAccountRequest- AConsumerthat will call methods onAssociateSigninDelegateGroupsWithAccountRequest.Builderto create a request.- Returns:
 - Result of the AssociateSigninDelegateGroupsWithAccount operation returned by the service.
 - See Also:
 
 - 
batchCreateRoomMembership
default BatchCreateRoomMembershipResponse batchCreateRoomMembership(BatchCreateRoomMembershipRequest batchCreateRoomMembershipRequest) throws UnauthorizedClientException, NotFoundException, BadRequestException, ForbiddenException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Adds up to 50 members to a chat room in an Amazon Chime Enterprise account. Members can be users or bots. The member role designates whether the member is a chat room administrator or a general chat room member.
- Parameters:
 batchCreateRoomMembershipRequest-- Returns:
 - Result of the BatchCreateRoomMembership operation returned by the service.
 - See Also:
 
 - 
batchCreateRoomMembership
default BatchCreateRoomMembershipResponse batchCreateRoomMembership(Consumer<BatchCreateRoomMembershipRequest.Builder> batchCreateRoomMembershipRequest) throws UnauthorizedClientException, NotFoundException, BadRequestException, ForbiddenException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Adds up to 50 members to a chat room in an Amazon Chime Enterprise account. Members can be users or bots. The member role designates whether the member is a chat room administrator or a general chat room member.
This is a convenience which creates an instance of the
BatchCreateRoomMembershipRequest.Builderavoiding the need to create one manually viaBatchCreateRoomMembershipRequest.builder()- Parameters:
 batchCreateRoomMembershipRequest- AConsumerthat will call methods onBatchCreateRoomMembershipRequest.Builderto create a request.- Returns:
 - Result of the BatchCreateRoomMembership operation returned by the service.
 - See Also:
 
 - 
batchDeletePhoneNumber
default BatchDeletePhoneNumberResponse batchDeletePhoneNumber(BatchDeletePhoneNumberRequest batchDeletePhoneNumberRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Moves phone numbers into the Deletion queue. Phone numbers must be disassociated from any users or Amazon Chime Voice Connectors before they can be deleted.
Phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.
- Parameters:
 batchDeletePhoneNumberRequest-- Returns:
 - Result of the BatchDeletePhoneNumber operation returned by the service.
 - See Also:
 
 - 
batchDeletePhoneNumber
default BatchDeletePhoneNumberResponse batchDeletePhoneNumber(Consumer<BatchDeletePhoneNumberRequest.Builder> batchDeletePhoneNumberRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Moves phone numbers into the Deletion queue. Phone numbers must be disassociated from any users or Amazon Chime Voice Connectors before they can be deleted.
Phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.
This is a convenience which creates an instance of the
BatchDeletePhoneNumberRequest.Builderavoiding the need to create one manually viaBatchDeletePhoneNumberRequest.builder()- Parameters:
 batchDeletePhoneNumberRequest- AConsumerthat will call methods onBatchDeletePhoneNumberRequest.Builderto create a request.- Returns:
 - Result of the BatchDeletePhoneNumber operation returned by the service.
 - See Also:
 
 - 
batchSuspendUser
default BatchSuspendUserResponse batchSuspendUser(BatchSuspendUserRequest batchSuspendUserRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Suspends up to 50 users from a
TeamorEnterpriseLWAAmazon Chime account. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.Users suspended from a
Teamaccount are disassociated from the account,but they can continue to use Amazon Chime as free users. To remove the suspension from suspendedTeamaccount users, invite them to theTeamaccount again. You can use the InviteUsers action to do so.Users suspended from an
EnterpriseLWAaccount are immediately signed out of Amazon Chime and can no longer sign in. To remove the suspension from suspendedEnterpriseLWAaccount users, use the BatchUnsuspendUser action.To sign out users without suspending them, use the LogoutUser action.
- Parameters:
 batchSuspendUserRequest-- Returns:
 - Result of the BatchSuspendUser operation returned by the service.
 - See Also:
 
 - 
batchSuspendUser
default BatchSuspendUserResponse batchSuspendUser(Consumer<BatchSuspendUserRequest.Builder> batchSuspendUserRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Suspends up to 50 users from a
TeamorEnterpriseLWAAmazon Chime account. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.Users suspended from a
Teamaccount are disassociated from the account,but they can continue to use Amazon Chime as free users. To remove the suspension from suspendedTeamaccount users, invite them to theTeamaccount again. You can use the InviteUsers action to do so.Users suspended from an
EnterpriseLWAaccount are immediately signed out of Amazon Chime and can no longer sign in. To remove the suspension from suspendedEnterpriseLWAaccount users, use the BatchUnsuspendUser action.To sign out users without suspending them, use the LogoutUser action.
This is a convenience which creates an instance of the
BatchSuspendUserRequest.Builderavoiding the need to create one manually viaBatchSuspendUserRequest.builder()- Parameters:
 batchSuspendUserRequest- AConsumerthat will call methods onBatchSuspendUserRequest.Builderto create a request.- Returns:
 - Result of the BatchSuspendUser operation returned by the service.
 - See Also:
 
 - 
batchUnsuspendUser
default BatchUnsuspendUserResponse batchUnsuspendUser(BatchUnsuspendUserRequest batchUnsuspendUserRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime
EnterpriseLWAaccount. Only users onEnterpriseLWAaccounts can be unsuspended using this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the account types, in the Amazon Chime Administration Guide.Previously suspended users who are unsuspended using this action are returned to
Registeredstatus. Users who are not previously suspended are ignored.- Parameters:
 batchUnsuspendUserRequest-- Returns:
 - Result of the BatchUnsuspendUser operation returned by the service.
 - See Also:
 
 - 
batchUnsuspendUser
default BatchUnsuspendUserResponse batchUnsuspendUser(Consumer<BatchUnsuspendUserRequest.Builder> batchUnsuspendUserRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime
EnterpriseLWAaccount. Only users onEnterpriseLWAaccounts can be unsuspended using this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the account types, in the Amazon Chime Administration Guide.Previously suspended users who are unsuspended using this action are returned to
Registeredstatus. Users who are not previously suspended are ignored.
This is a convenience which creates an instance of the
BatchUnsuspendUserRequest.Builderavoiding the need to create one manually viaBatchUnsuspendUserRequest.builder()- Parameters:
 batchUnsuspendUserRequest- AConsumerthat will call methods onBatchUnsuspendUserRequest.Builderto create a request.- Returns:
 - Result of the BatchUnsuspendUser operation returned by the service.
 - See Also:
 
 - 
batchUpdatePhoneNumber
default BatchUpdatePhoneNumberResponse batchUpdatePhoneNumber(BatchUpdatePhoneNumberRequest batchUpdatePhoneNumberRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Updates phone number product types or calling names. You can update one attribute at a time for each
UpdatePhoneNumberRequestItem. For example, you can update the product type or the calling name.For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type.
Updates to outbound calling names can take up to 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.
- Parameters:
 batchUpdatePhoneNumberRequest-- Returns:
 - Result of the BatchUpdatePhoneNumber operation returned by the service.
 - See Also:
 
 - 
batchUpdatePhoneNumber
default BatchUpdatePhoneNumberResponse batchUpdatePhoneNumber(Consumer<BatchUpdatePhoneNumberRequest.Builder> batchUpdatePhoneNumberRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Updates phone number product types or calling names. You can update one attribute at a time for each
UpdatePhoneNumberRequestItem. For example, you can update the product type or the calling name.For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type.
Updates to outbound calling names can take up to 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.
This is a convenience which creates an instance of the
BatchUpdatePhoneNumberRequest.Builderavoiding the need to create one manually viaBatchUpdatePhoneNumberRequest.builder()- Parameters:
 batchUpdatePhoneNumberRequest- AConsumerthat will call methods onBatchUpdatePhoneNumberRequest.Builderto create a request.- Returns:
 - Result of the BatchUpdatePhoneNumber operation returned by the service.
 - See Also:
 
 - 
batchUpdateUser
default BatchUpdateUserResponse batchUpdateUser(BatchUpdateUserRequest batchUpdateUserRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Updates user details within the UpdateUserRequestItem object for up to 20 users for the specified Amazon Chime account. Currently, only
LicenseTypeupdates are supported for this action.- Parameters:
 batchUpdateUserRequest-- Returns:
 - Result of the BatchUpdateUser operation returned by the service.
 - See Also:
 
 - 
batchUpdateUser
default BatchUpdateUserResponse batchUpdateUser(Consumer<BatchUpdateUserRequest.Builder> batchUpdateUserRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Updates user details within the UpdateUserRequestItem object for up to 20 users for the specified Amazon Chime account. Currently, only
LicenseTypeupdates are supported for this action.
This is a convenience which creates an instance of the
BatchUpdateUserRequest.Builderavoiding the need to create one manually viaBatchUpdateUserRequest.builder()- Parameters:
 batchUpdateUserRequest- AConsumerthat will call methods onBatchUpdateUserRequest.Builderto create a request.- Returns:
 - Result of the BatchUpdateUser operation returned by the service.
 - See Also:
 
 - 
createAccount
default CreateAccountResponse createAccount(CreateAccountRequest createAccountRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Creates an Amazon Chime account under the administrator's AWS account. Only
Teamaccount types are currently supported for this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.- Parameters:
 createAccountRequest-- Returns:
 - Result of the CreateAccount operation returned by the service.
 - See Also:
 
 - 
createAccount
default CreateAccountResponse createAccount(Consumer<CreateAccountRequest.Builder> createAccountRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Creates an Amazon Chime account under the administrator's AWS account. Only
Teamaccount types are currently supported for this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.
This is a convenience which creates an instance of the
CreateAccountRequest.Builderavoiding the need to create one manually viaCreateAccountRequest.builder()- Parameters:
 createAccountRequest- AConsumerthat will call methods onCreateAccountRequest.Builderto create a request.- Returns:
 - Result of the CreateAccount operation returned by the service.
 - See Also:
 
 - 
createBot
default CreateBotResponse createBot(CreateBotRequest createBotRequest) throws ServiceUnavailableException, ServiceFailureException, ForbiddenException, BadRequestException, UnauthorizedClientException, ResourceLimitExceededException, NotFoundException, ThrottledClientException, AwsServiceException, SdkClientException, ChimeException Creates a bot for an Amazon Chime Enterprise account.
- Parameters:
 createBotRequest-- Returns:
 - Result of the CreateBot operation returned by the service.
 - See Also:
 
 - 
createBot
default CreateBotResponse createBot(Consumer<CreateBotRequest.Builder> createBotRequest) throws ServiceUnavailableException, ServiceFailureException, ForbiddenException, BadRequestException, UnauthorizedClientException, ResourceLimitExceededException, NotFoundException, ThrottledClientException, AwsServiceException, SdkClientException, ChimeException Creates a bot for an Amazon Chime Enterprise account.
This is a convenience which creates an instance of the
CreateBotRequest.Builderavoiding the need to create one manually viaCreateBotRequest.builder()- Parameters:
 createBotRequest- AConsumerthat will call methods onCreateBotRequest.Builderto create a request.- Returns:
 - Result of the CreateBot operation returned by the service.
 - See Also:
 
 - 
createMeetingDialOut
default CreateMeetingDialOutResponse createMeetingDialOut(CreateMeetingDialOutRequest createMeetingDialOutRequest) throws BadRequestException, ForbiddenException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, AccessDeniedException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Uses the join token and call metadata in a meeting request (From number, To number, and so forth) to initiate an outbound call to a public switched telephone network (PSTN) and join them into a Chime meeting. Also ensures that the From number belongs to the customer.
To play welcome audio or implement an interactive voice response (IVR), use the
CreateSipMediaApplicationCallaction with the corresponding SIP media application ID.This API is not available in a dedicated namespace.
- Parameters:
 createMeetingDialOutRequest-- Returns:
 - Result of the CreateMeetingDialOut operation returned by the service.
 - See Also:
 
 - 
createMeetingDialOut
default CreateMeetingDialOutResponse createMeetingDialOut(Consumer<CreateMeetingDialOutRequest.Builder> createMeetingDialOutRequest) throws BadRequestException, ForbiddenException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, AccessDeniedException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Uses the join token and call metadata in a meeting request (From number, To number, and so forth) to initiate an outbound call to a public switched telephone network (PSTN) and join them into a Chime meeting. Also ensures that the From number belongs to the customer.
To play welcome audio or implement an interactive voice response (IVR), use the
CreateSipMediaApplicationCallaction with the corresponding SIP media application ID.This API is not available in a dedicated namespace.
This is a convenience which creates an instance of the
CreateMeetingDialOutRequest.Builderavoiding the need to create one manually viaCreateMeetingDialOutRequest.builder()- Parameters:
 createMeetingDialOutRequest- AConsumerthat will call methods onCreateMeetingDialOutRequest.Builderto create a request.- Returns:
 - Result of the CreateMeetingDialOut operation returned by the service.
 - See Also:
 
 - 
createPhoneNumberOrder
default CreatePhoneNumberOrderResponse createPhoneNumberOrder(CreatePhoneNumberOrderRequest createPhoneNumberOrderRequest) throws BadRequestException, ForbiddenException, AccessDeniedException, UnauthorizedClientException, ThrottledClientException, ResourceLimitExceededException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Creates an order for phone numbers to be provisioned. For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type.
- Parameters:
 createPhoneNumberOrderRequest-- Returns:
 - Result of the CreatePhoneNumberOrder operation returned by the service.
 - See Also:
 
 - 
createPhoneNumberOrder
default CreatePhoneNumberOrderResponse createPhoneNumberOrder(Consumer<CreatePhoneNumberOrderRequest.Builder> createPhoneNumberOrderRequest) throws BadRequestException, ForbiddenException, AccessDeniedException, UnauthorizedClientException, ThrottledClientException, ResourceLimitExceededException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Creates an order for phone numbers to be provisioned. For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type.
This is a convenience which creates an instance of the
CreatePhoneNumberOrderRequest.Builderavoiding the need to create one manually viaCreatePhoneNumberOrderRequest.builder()- Parameters:
 createPhoneNumberOrderRequest- AConsumerthat will call methods onCreatePhoneNumberOrderRequest.Builderto create a request.- Returns:
 - Result of the CreatePhoneNumberOrder operation returned by the service.
 - See Also:
 
 - 
createRoom
default CreateRoomResponse createRoom(CreateRoomRequest createRoomRequest) throws NotFoundException, BadRequestException, ForbiddenException, UnauthorizedClientException, ResourceLimitExceededException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Creates a chat room for the specified Amazon Chime Enterprise account.
- Parameters:
 createRoomRequest-- Returns:
 - Result of the CreateRoom operation returned by the service.
 - See Also:
 
 - 
createRoom
default CreateRoomResponse createRoom(Consumer<CreateRoomRequest.Builder> createRoomRequest) throws NotFoundException, BadRequestException, ForbiddenException, UnauthorizedClientException, ResourceLimitExceededException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Creates a chat room for the specified Amazon Chime Enterprise account.
This is a convenience which creates an instance of the
CreateRoomRequest.Builderavoiding the need to create one manually viaCreateRoomRequest.builder()- Parameters:
 createRoomRequest- AConsumerthat will call methods onCreateRoomRequest.Builderto create a request.- Returns:
 - Result of the CreateRoom operation returned by the service.
 - See Also:
 
 - 
createRoomMembership
default CreateRoomMembershipResponse createRoomMembership(CreateRoomMembershipRequest createRoomMembershipRequest) throws ConflictException, UnauthorizedClientException, NotFoundException, BadRequestException, ForbiddenException, ResourceLimitExceededException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Adds a member to a chat room in an Amazon Chime Enterprise account. A member can be either a user or a bot. The member role designates whether the member is a chat room administrator or a general chat room member.
- Parameters:
 createRoomMembershipRequest-- Returns:
 - Result of the CreateRoomMembership operation returned by the service.
 - See Also:
 
 - 
createRoomMembership
default CreateRoomMembershipResponse createRoomMembership(Consumer<CreateRoomMembershipRequest.Builder> createRoomMembershipRequest) throws ConflictException, UnauthorizedClientException, NotFoundException, BadRequestException, ForbiddenException, ResourceLimitExceededException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Adds a member to a chat room in an Amazon Chime Enterprise account. A member can be either a user or a bot. The member role designates whether the member is a chat room administrator or a general chat room member.
This is a convenience which creates an instance of the
CreateRoomMembershipRequest.Builderavoiding the need to create one manually viaCreateRoomMembershipRequest.builder()- Parameters:
 createRoomMembershipRequest- AConsumerthat will call methods onCreateRoomMembershipRequest.Builderto create a request.- Returns:
 - Result of the CreateRoomMembership operation returned by the service.
 - See Also:
 
 - 
createUser
default CreateUserResponse createUser(CreateUserRequest createUserRequest) throws UnauthorizedClientException, NotFoundException, ConflictException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Creates a user under the specified Amazon Chime account.
- Parameters:
 createUserRequest-- Returns:
 - Result of the CreateUser operation returned by the service.
 - See Also:
 
 - 
createUser
default CreateUserResponse createUser(Consumer<CreateUserRequest.Builder> createUserRequest) throws UnauthorizedClientException, NotFoundException, ConflictException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Creates a user under the specified Amazon Chime account.
This is a convenience which creates an instance of the
CreateUserRequest.Builderavoiding the need to create one manually viaCreateUserRequest.builder()- Parameters:
 createUserRequest- AConsumerthat will call methods onCreateUserRequest.Builderto create a request.- Returns:
 - Result of the CreateUser operation returned by the service.
 - See Also:
 
 - 
deleteAccount
default DeleteAccountResponse deleteAccount(DeleteAccountRequest deleteAccountRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, UnprocessableEntityException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Deletes the specified Amazon Chime account. You must suspend all users before deleting
Teamaccount. You can use the BatchSuspendUser action to dodo.For
EnterpriseLWAandEnterpriseADaccounts, you must release the claimed domains for your Amazon Chime account before deletion. As soon as you release the domain, all users under that account are suspended.Deleted accounts appear in your
Disabledaccounts list for 90 days. To restore deleted account from yourDisabledaccounts list, you must contact AWS Support.After 90 days, deleted accounts are permanently removed from your
Disabledaccounts list.- Parameters:
 deleteAccountRequest-- Returns:
 - Result of the DeleteAccount operation returned by the service.
 - See Also:
 
 - 
deleteAccount
default DeleteAccountResponse deleteAccount(Consumer<DeleteAccountRequest.Builder> deleteAccountRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, UnprocessableEntityException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Deletes the specified Amazon Chime account. You must suspend all users before deleting
Teamaccount. You can use the BatchSuspendUser action to dodo.For
EnterpriseLWAandEnterpriseADaccounts, you must release the claimed domains for your Amazon Chime account before deletion. As soon as you release the domain, all users under that account are suspended.Deleted accounts appear in your
Disabledaccounts list for 90 days. To restore deleted account from yourDisabledaccounts list, you must contact AWS Support.After 90 days, deleted accounts are permanently removed from your
Disabledaccounts list.
This is a convenience which creates an instance of the
DeleteAccountRequest.Builderavoiding the need to create one manually viaDeleteAccountRequest.builder()- Parameters:
 deleteAccountRequest- AConsumerthat will call methods onDeleteAccountRequest.Builderto create a request.- Returns:
 - Result of the DeleteAccount operation returned by the service.
 - See Also:
 
 - 
deleteEventsConfiguration
default DeleteEventsConfigurationResponse deleteEventsConfiguration(DeleteEventsConfigurationRequest deleteEventsConfigurationRequest) throws ServiceUnavailableException, ServiceFailureException, ForbiddenException, BadRequestException, UnauthorizedClientException, ResourceLimitExceededException, AwsServiceException, SdkClientException, ChimeException Deletes the events configuration that allows a bot to receive outgoing events.
- Parameters:
 deleteEventsConfigurationRequest-- Returns:
 - Result of the DeleteEventsConfiguration operation returned by the service.
 - See Also:
 
 - 
deleteEventsConfiguration
default DeleteEventsConfigurationResponse deleteEventsConfiguration(Consumer<DeleteEventsConfigurationRequest.Builder> deleteEventsConfigurationRequest) throws ServiceUnavailableException, ServiceFailureException, ForbiddenException, BadRequestException, UnauthorizedClientException, ResourceLimitExceededException, AwsServiceException, SdkClientException, ChimeException Deletes the events configuration that allows a bot to receive outgoing events.
This is a convenience which creates an instance of the
DeleteEventsConfigurationRequest.Builderavoiding the need to create one manually viaDeleteEventsConfigurationRequest.builder()- Parameters:
 deleteEventsConfigurationRequest- AConsumerthat will call methods onDeleteEventsConfigurationRequest.Builderto create a request.- Returns:
 - Result of the DeleteEventsConfiguration operation returned by the service.
 - See Also:
 
 - 
deletePhoneNumber
default DeletePhoneNumberResponse deletePhoneNumber(DeletePhoneNumberRequest deletePhoneNumberRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Moves the specified phone number into the Deletion queue. A phone number must be disassociated from any users or Amazon Chime Voice Connectors before it can be deleted.
Deleted phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.
- Parameters:
 deletePhoneNumberRequest-- Returns:
 - Result of the DeletePhoneNumber operation returned by the service.
 - See Also:
 
 - 
deletePhoneNumber
default DeletePhoneNumberResponse deletePhoneNumber(Consumer<DeletePhoneNumberRequest.Builder> deletePhoneNumberRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Moves the specified phone number into the Deletion queue. A phone number must be disassociated from any users or Amazon Chime Voice Connectors before it can be deleted.
Deleted phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.
This is a convenience which creates an instance of the
DeletePhoneNumberRequest.Builderavoiding the need to create one manually viaDeletePhoneNumberRequest.builder()- Parameters:
 deletePhoneNumberRequest- AConsumerthat will call methods onDeletePhoneNumberRequest.Builderto create a request.- Returns:
 - Result of the DeletePhoneNumber operation returned by the service.
 - See Also:
 
 - 
deleteRoom
default DeleteRoomResponse deleteRoom(DeleteRoomRequest deleteRoomRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Deletes a chat room in an Amazon Chime Enterprise account.
- Parameters:
 deleteRoomRequest-- Returns:
 - Result of the DeleteRoom operation returned by the service.
 - See Also:
 
 - 
deleteRoom
default DeleteRoomResponse deleteRoom(Consumer<DeleteRoomRequest.Builder> deleteRoomRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Deletes a chat room in an Amazon Chime Enterprise account.
This is a convenience which creates an instance of the
DeleteRoomRequest.Builderavoiding the need to create one manually viaDeleteRoomRequest.builder()- Parameters:
 deleteRoomRequest- AConsumerthat will call methods onDeleteRoomRequest.Builderto create a request.- Returns:
 - Result of the DeleteRoom operation returned by the service.
 - See Also:
 
 - 
deleteRoomMembership
default DeleteRoomMembershipResponse deleteRoomMembership(DeleteRoomMembershipRequest deleteRoomMembershipRequest) throws UnauthorizedClientException, NotFoundException, BadRequestException, ForbiddenException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Removes a member from a chat room in an Amazon Chime Enterprise account.
- Parameters:
 deleteRoomMembershipRequest-- Returns:
 - Result of the DeleteRoomMembership operation returned by the service.
 - See Also:
 
 - 
deleteRoomMembership
default DeleteRoomMembershipResponse deleteRoomMembership(Consumer<DeleteRoomMembershipRequest.Builder> deleteRoomMembershipRequest) throws UnauthorizedClientException, NotFoundException, BadRequestException, ForbiddenException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Removes a member from a chat room in an Amazon Chime Enterprise account.
This is a convenience which creates an instance of the
DeleteRoomMembershipRequest.Builderavoiding the need to create one manually viaDeleteRoomMembershipRequest.builder()- Parameters:
 deleteRoomMembershipRequest- AConsumerthat will call methods onDeleteRoomMembershipRequest.Builderto create a request.- Returns:
 - Result of the DeleteRoomMembership operation returned by the service.
 - See Also:
 
 - 
disassociatePhoneNumberFromUser
default DisassociatePhoneNumberFromUserResponse disassociatePhoneNumberFromUser(DisassociatePhoneNumberFromUserRequest disassociatePhoneNumberFromUserRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Disassociates the primary provisioned phone number from the specified Amazon Chime user.
- Parameters:
 disassociatePhoneNumberFromUserRequest-- Returns:
 - Result of the DisassociatePhoneNumberFromUser operation returned by the service.
 - See Also:
 
 - 
disassociatePhoneNumberFromUser
default DisassociatePhoneNumberFromUserResponse disassociatePhoneNumberFromUser(Consumer<DisassociatePhoneNumberFromUserRequest.Builder> disassociatePhoneNumberFromUserRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Disassociates the primary provisioned phone number from the specified Amazon Chime user.
This is a convenience which creates an instance of the
DisassociatePhoneNumberFromUserRequest.Builderavoiding the need to create one manually viaDisassociatePhoneNumberFromUserRequest.builder()- Parameters:
 disassociatePhoneNumberFromUserRequest- AConsumerthat will call methods onDisassociatePhoneNumberFromUserRequest.Builderto create a request.- Returns:
 - Result of the DisassociatePhoneNumberFromUser operation returned by the service.
 - See Also:
 
 - 
disassociateSigninDelegateGroupsFromAccount
default DisassociateSigninDelegateGroupsFromAccountResponse disassociateSigninDelegateGroupsFromAccount(DisassociateSigninDelegateGroupsFromAccountRequest disassociateSigninDelegateGroupsFromAccountRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Disassociates the specified sign-in delegate groups from the specified Amazon Chime account.
- Parameters:
 disassociateSigninDelegateGroupsFromAccountRequest-- Returns:
 - Result of the DisassociateSigninDelegateGroupsFromAccount operation returned by the service.
 - See Also:
 
 - 
disassociateSigninDelegateGroupsFromAccount
default DisassociateSigninDelegateGroupsFromAccountResponse disassociateSigninDelegateGroupsFromAccount(Consumer<DisassociateSigninDelegateGroupsFromAccountRequest.Builder> disassociateSigninDelegateGroupsFromAccountRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Disassociates the specified sign-in delegate groups from the specified Amazon Chime account.
This is a convenience which creates an instance of the
DisassociateSigninDelegateGroupsFromAccountRequest.Builderavoiding the need to create one manually viaDisassociateSigninDelegateGroupsFromAccountRequest.builder()- Parameters:
 disassociateSigninDelegateGroupsFromAccountRequest- AConsumerthat will call methods onDisassociateSigninDelegateGroupsFromAccountRequest.Builderto create a request.- Returns:
 - Result of the DisassociateSigninDelegateGroupsFromAccount operation returned by the service.
 - See Also:
 
 - 
getAccount
default GetAccountResponse getAccount(GetAccountRequest getAccountRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.
- Parameters:
 getAccountRequest-- Returns:
 - Result of the GetAccount operation returned by the service.
 - See Also:
 
 - 
getAccount
default GetAccountResponse getAccount(Consumer<GetAccountRequest.Builder> getAccountRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.
This is a convenience which creates an instance of the
GetAccountRequest.Builderavoiding the need to create one manually viaGetAccountRequest.builder()- Parameters:
 getAccountRequest- AConsumerthat will call methods onGetAccountRequest.Builderto create a request.- Returns:
 - Result of the GetAccount operation returned by the service.
 - See Also:
 
 - 
getAccountSettings
default GetAccountSettingsResponse getAccountSettings(GetAccountSettingsRequest getAccountSettingsRequest) throws UnauthorizedClientException, NotFoundException, BadRequestException, ForbiddenException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dialout settings. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.
- Parameters:
 getAccountSettingsRequest-- Returns:
 - Result of the GetAccountSettings operation returned by the service.
 - See Also:
 
 - 
getAccountSettings
default GetAccountSettingsResponse getAccountSettings(Consumer<GetAccountSettingsRequest.Builder> getAccountSettingsRequest) throws UnauthorizedClientException, NotFoundException, BadRequestException, ForbiddenException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dialout settings. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.
This is a convenience which creates an instance of the
GetAccountSettingsRequest.Builderavoiding the need to create one manually viaGetAccountSettingsRequest.builder()- Parameters:
 getAccountSettingsRequest- AConsumerthat will call methods onGetAccountSettingsRequest.Builderto create a request.- Returns:
 - Result of the GetAccountSettings operation returned by the service.
 - See Also:
 
 - 
getBot
default GetBotResponse getBot(GetBotRequest getBotRequest) throws ServiceUnavailableException, ServiceFailureException, ForbiddenException, UnauthorizedClientException, NotFoundException, BadRequestException, ThrottledClientException, AwsServiceException, SdkClientException, ChimeException Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.
- Parameters:
 getBotRequest-- Returns:
 - Result of the GetBot operation returned by the service.
 - See Also:
 
 - 
getBot
default GetBotResponse getBot(Consumer<GetBotRequest.Builder> getBotRequest) throws ServiceUnavailableException, ServiceFailureException, ForbiddenException, UnauthorizedClientException, NotFoundException, BadRequestException, ThrottledClientException, AwsServiceException, SdkClientException, ChimeException Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.
This is a convenience which creates an instance of the
GetBotRequest.Builderavoiding the need to create one manually viaGetBotRequest.builder()- Parameters:
 getBotRequest- AConsumerthat will call methods onGetBotRequest.Builderto create a request.- Returns:
 - Result of the GetBot operation returned by the service.
 - See Also:
 
 - 
getEventsConfiguration
default GetEventsConfigurationResponse getEventsConfiguration(GetEventsConfigurationRequest getEventsConfigurationRequest) throws ServiceUnavailableException, ServiceFailureException, ForbiddenException, BadRequestException, UnauthorizedClientException, ResourceLimitExceededException, NotFoundException, AwsServiceException, SdkClientException, ChimeException Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.
- Parameters:
 getEventsConfigurationRequest-- Returns:
 - Result of the GetEventsConfiguration operation returned by the service.
 - See Also:
 
 - 
getEventsConfiguration
default GetEventsConfigurationResponse getEventsConfiguration(Consumer<GetEventsConfigurationRequest.Builder> getEventsConfigurationRequest) throws ServiceUnavailableException, ServiceFailureException, ForbiddenException, BadRequestException, UnauthorizedClientException, ResourceLimitExceededException, NotFoundException, AwsServiceException, SdkClientException, ChimeException Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.
This is a convenience which creates an instance of the
GetEventsConfigurationRequest.Builderavoiding the need to create one manually viaGetEventsConfigurationRequest.builder()- Parameters:
 getEventsConfigurationRequest- AConsumerthat will call methods onGetEventsConfigurationRequest.Builderto create a request.- Returns:
 - Result of the GetEventsConfiguration operation returned by the service.
 - See Also:
 
 - 
getGlobalSettings
default GetGlobalSettingsResponse getGlobalSettings(GetGlobalSettingsRequest getGlobalSettingsRequest) throws UnauthorizedClientException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
- Parameters:
 getGlobalSettingsRequest-- Returns:
 - Result of the GetGlobalSettings operation returned by the service.
 - See Also:
 
 - 
getGlobalSettings
default GetGlobalSettingsResponse getGlobalSettings(Consumer<GetGlobalSettingsRequest.Builder> getGlobalSettingsRequest) throws UnauthorizedClientException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
This is a convenience which creates an instance of the
GetGlobalSettingsRequest.Builderavoiding the need to create one manually viaGetGlobalSettingsRequest.builder()- Parameters:
 getGlobalSettingsRequest- AConsumerthat will call methods onGetGlobalSettingsRequest.Builderto create a request.- Returns:
 - Result of the GetGlobalSettings operation returned by the service.
 - See Also:
 
 - 
getPhoneNumber
default GetPhoneNumberResponse getPhoneNumber(GetPhoneNumberRequest getPhoneNumberRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.
- Parameters:
 getPhoneNumberRequest-- Returns:
 - Result of the GetPhoneNumber operation returned by the service.
 - See Also:
 
 - 
getPhoneNumber
default GetPhoneNumberResponse getPhoneNumber(Consumer<GetPhoneNumberRequest.Builder> getPhoneNumberRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.
This is a convenience which creates an instance of the
GetPhoneNumberRequest.Builderavoiding the need to create one manually viaGetPhoneNumberRequest.builder()- Parameters:
 getPhoneNumberRequest- AConsumerthat will call methods onGetPhoneNumberRequest.Builderto create a request.- Returns:
 - Result of the GetPhoneNumber operation returned by the service.
 - See Also:
 
 - 
getPhoneNumberOrder
default GetPhoneNumberOrderResponse getPhoneNumberOrder(GetPhoneNumberOrderRequest getPhoneNumberOrderRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Retrieves details for the specified phone number order, such as the order creation timestamp, phone numbers in E.164 format, product type, and order status.
- Parameters:
 getPhoneNumberOrderRequest-- Returns:
 - Result of the GetPhoneNumberOrder operation returned by the service.
 - See Also:
 
 - 
getPhoneNumberOrder
default GetPhoneNumberOrderResponse getPhoneNumberOrder(Consumer<GetPhoneNumberOrderRequest.Builder> getPhoneNumberOrderRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Retrieves details for the specified phone number order, such as the order creation timestamp, phone numbers in E.164 format, product type, and order status.
This is a convenience which creates an instance of the
GetPhoneNumberOrderRequest.Builderavoiding the need to create one manually viaGetPhoneNumberOrderRequest.builder()- Parameters:
 getPhoneNumberOrderRequest- AConsumerthat will call methods onGetPhoneNumberOrderRequest.Builderto create a request.- Returns:
 - Result of the GetPhoneNumberOrder operation returned by the service.
 - See Also:
 
 - 
getPhoneNumberSettings
default GetPhoneNumberSettingsResponse getPhoneNumberSettings(GetPhoneNumberSettingsRequest getPhoneNumberSettingsRequest) throws UnauthorizedClientException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.
- Parameters:
 getPhoneNumberSettingsRequest-- Returns:
 - Result of the GetPhoneNumberSettings operation returned by the service.
 - See Also:
 
 - 
getPhoneNumberSettings
default GetPhoneNumberSettingsResponse getPhoneNumberSettings(Consumer<GetPhoneNumberSettingsRequest.Builder> getPhoneNumberSettingsRequest) throws UnauthorizedClientException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.
This is a convenience which creates an instance of the
GetPhoneNumberSettingsRequest.Builderavoiding the need to create one manually viaGetPhoneNumberSettingsRequest.builder()- Parameters:
 getPhoneNumberSettingsRequest- AConsumerthat will call methods onGetPhoneNumberSettingsRequest.Builderto create a request.- Returns:
 - Result of the GetPhoneNumberSettings operation returned by the service.
 - See Also:
 
 - 
getRetentionSettings
default GetRetentionSettingsResponse getRetentionSettings(GetRetentionSettingsRequest getRetentionSettingsRequest) throws UnauthorizedClientException, NotFoundException, BadRequestException, ForbiddenException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Gets the retention settings for the specified Amazon Chime Enterprise account. For more information about retention settings, see Managing Chat Retention Policies in the Amazon Chime Administration Guide.
- Parameters:
 getRetentionSettingsRequest-- Returns:
 - Result of the GetRetentionSettings operation returned by the service.
 - See Also:
 
 - 
getRetentionSettings
default GetRetentionSettingsResponse getRetentionSettings(Consumer<GetRetentionSettingsRequest.Builder> getRetentionSettingsRequest) throws UnauthorizedClientException, NotFoundException, BadRequestException, ForbiddenException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Gets the retention settings for the specified Amazon Chime Enterprise account. For more information about retention settings, see Managing Chat Retention Policies in the Amazon Chime Administration Guide.
This is a convenience which creates an instance of the
GetRetentionSettingsRequest.Builderavoiding the need to create one manually viaGetRetentionSettingsRequest.builder()- Parameters:
 getRetentionSettingsRequest- AConsumerthat will call methods onGetRetentionSettingsRequest.Builderto create a request.- Returns:
 - Result of the GetRetentionSettings operation returned by the service.
 - See Also:
 
 - 
getRoom
default GetRoomResponse getRoom(GetRoomRequest getRoomRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.
- Parameters:
 getRoomRequest-- Returns:
 - Result of the GetRoom operation returned by the service.
 - See Also:
 
 - 
getRoom
default GetRoomResponse getRoom(Consumer<GetRoomRequest.Builder> getRoomRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.
This is a convenience which creates an instance of the
GetRoomRequest.Builderavoiding the need to create one manually viaGetRoomRequest.builder()- Parameters:
 getRoomRequest- AConsumerthat will call methods onGetRoomRequest.Builderto create a request.- Returns:
 - Result of the GetRoom operation returned by the service.
 - See Also:
 
 - 
getUser
default GetUserResponse getUser(GetUserRequest getUserRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Retrieves details for the specified user ID, such as primary email address, license type,and personal meeting PIN.
To retrieve user details with an email address instead of a user ID, use the ListUsers action, and then filter by email address.
- Parameters:
 getUserRequest-- Returns:
 - Result of the GetUser operation returned by the service.
 - See Also:
 
 - 
getUser
default GetUserResponse getUser(Consumer<GetUserRequest.Builder> getUserRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Retrieves details for the specified user ID, such as primary email address, license type,and personal meeting PIN.
To retrieve user details with an email address instead of a user ID, use the ListUsers action, and then filter by email address.
This is a convenience which creates an instance of the
GetUserRequest.Builderavoiding the need to create one manually viaGetUserRequest.builder()- Parameters:
 getUserRequest- AConsumerthat will call methods onGetUserRequest.Builderto create a request.- Returns:
 - Result of the GetUser operation returned by the service.
 - See Also:
 
 - 
getUserSettings
default GetUserSettingsResponse getUserSettings(GetUserSettingsRequest getUserSettingsRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Retrieves settings for the specified user ID, such as any associated phone number settings.
- Parameters:
 getUserSettingsRequest-- Returns:
 - Result of the GetUserSettings operation returned by the service.
 - See Also:
 
 - 
getUserSettings
default GetUserSettingsResponse getUserSettings(Consumer<GetUserSettingsRequest.Builder> getUserSettingsRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Retrieves settings for the specified user ID, such as any associated phone number settings.
This is a convenience which creates an instance of the
GetUserSettingsRequest.Builderavoiding the need to create one manually viaGetUserSettingsRequest.builder()- Parameters:
 getUserSettingsRequest- AConsumerthat will call methods onGetUserSettingsRequest.Builderto create a request.- Returns:
 - Result of the GetUserSettings operation returned by the service.
 - See Also:
 
 - 
inviteUsers
default InviteUsersResponse inviteUsers(InviteUsersRequest inviteUsersRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Sends email to a maximum of 50 users, inviting them to the specified Amazon Chime
Teamaccount. OnlyTeamaccount types are currently supported for this action.- Parameters:
 inviteUsersRequest-- Returns:
 - Result of the InviteUsers operation returned by the service.
 - See Also:
 
 - 
inviteUsers
default InviteUsersResponse inviteUsers(Consumer<InviteUsersRequest.Builder> inviteUsersRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Sends email to a maximum of 50 users, inviting them to the specified Amazon Chime
Teamaccount. OnlyTeamaccount types are currently supported for this action.
This is a convenience which creates an instance of the
InviteUsersRequest.Builderavoiding the need to create one manually viaInviteUsersRequest.builder()- Parameters:
 inviteUsersRequest- AConsumerthat will call methods onInviteUsersRequest.Builderto create a request.- Returns:
 - Result of the InviteUsers operation returned by the service.
 - See Also:
 
 - 
listAccounts
default ListAccountsResponse listAccounts(ListAccountsRequest listAccountsRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Lists the Amazon Chime accounts under the administrator's AWS account. You can filter accounts by account name prefix. To find out which Amazon Chime account a user belongs to, you can filter by the user's email address, which returns one account result.
- Parameters:
 listAccountsRequest-- Returns:
 - Result of the ListAccounts operation returned by the service.
 - See Also:
 
 - 
listAccounts
default ListAccountsResponse listAccounts(Consumer<ListAccountsRequest.Builder> listAccountsRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Lists the Amazon Chime accounts under the administrator's AWS account. You can filter accounts by account name prefix. To find out which Amazon Chime account a user belongs to, you can filter by the user's email address, which returns one account result.
This is a convenience which creates an instance of the
ListAccountsRequest.Builderavoiding the need to create one manually viaListAccountsRequest.builder()- Parameters:
 listAccountsRequest- AConsumerthat will call methods onListAccountsRequest.Builderto create a request.- Returns:
 - Result of the ListAccounts operation returned by the service.
 - See Also:
 
 - 
listAccounts
default ListAccountsResponse listAccounts() throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeExceptionLists the Amazon Chime accounts under the administrator's AWS account. You can filter accounts by account name prefix. To find out which Amazon Chime account a user belongs to, you can filter by the user's email address, which returns one account result.
- Returns:
 - Result of the ListAccounts operation returned by the service.
 - See Also:
 
 - 
listAccountsPaginator
default ListAccountsIterable listAccountsPaginator() throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeExceptionThis is a variant of
listAccounts(software.amazon.awssdk.services.chime.model.ListAccountsRequest)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
2) Using For loopsoftware.amazon.awssdk.services.chime.paginators.ListAccountsIterable responses = client.listAccountsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.chime.paginators.ListAccountsIterable responses = client.listAccountsPaginator(request); for (software.amazon.awssdk.services.chime.model.ListAccountsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.chime.paginators.ListAccountsIterable responses = client.listAccountsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAccounts(software.amazon.awssdk.services.chime.model.ListAccountsRequest)operation.- Returns:
 - A custom iterable that can be used to iterate through all the response pages.
 - See Also:
 
 - 
listAccountsPaginator
default ListAccountsIterable listAccountsPaginator(ListAccountsRequest listAccountsRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException This is a variant of
listAccounts(software.amazon.awssdk.services.chime.model.ListAccountsRequest)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
2) Using For loopsoftware.amazon.awssdk.services.chime.paginators.ListAccountsIterable responses = client.listAccountsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.chime.paginators.ListAccountsIterable responses = client.listAccountsPaginator(request); for (software.amazon.awssdk.services.chime.model.ListAccountsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.chime.paginators.ListAccountsIterable responses = client.listAccountsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAccounts(software.amazon.awssdk.services.chime.model.ListAccountsRequest)operation.- Parameters:
 listAccountsRequest-- Returns:
 - A custom iterable that can be used to iterate through all the response pages.
 - See Also:
 
 - 
listAccountsPaginator
default ListAccountsIterable listAccountsPaginator(Consumer<ListAccountsRequest.Builder> listAccountsRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException This is a variant of
listAccounts(software.amazon.awssdk.services.chime.model.ListAccountsRequest)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
2) Using For loopsoftware.amazon.awssdk.services.chime.paginators.ListAccountsIterable responses = client.listAccountsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.chime.paginators.ListAccountsIterable responses = client.listAccountsPaginator(request); for (software.amazon.awssdk.services.chime.model.ListAccountsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.chime.paginators.ListAccountsIterable responses = client.listAccountsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAccounts(software.amazon.awssdk.services.chime.model.ListAccountsRequest)operation.
This is a convenience which creates an instance of the
ListAccountsRequest.Builderavoiding the need to create one manually viaListAccountsRequest.builder()- Parameters:
 listAccountsRequest- AConsumerthat will call methods onListAccountsRequest.Builderto create a request.- Returns:
 - A custom iterable that can be used to iterate through all the response pages.
 - See Also:
 
 - 
listBots
default ListBotsResponse listBots(ListBotsRequest listBotsRequest) throws ServiceUnavailableException, ServiceFailureException, ForbiddenException, UnauthorizedClientException, BadRequestException, NotFoundException, ThrottledClientException, AwsServiceException, SdkClientException, ChimeException Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.
- Parameters:
 listBotsRequest-- Returns:
 - Result of the ListBots operation returned by the service.
 - See Also:
 
 - 
listBots
default ListBotsResponse listBots(Consumer<ListBotsRequest.Builder> listBotsRequest) throws ServiceUnavailableException, ServiceFailureException, ForbiddenException, UnauthorizedClientException, BadRequestException, NotFoundException, ThrottledClientException, AwsServiceException, SdkClientException, ChimeException Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.
This is a convenience which creates an instance of the
ListBotsRequest.Builderavoiding the need to create one manually viaListBotsRequest.builder()- Parameters:
 listBotsRequest- AConsumerthat will call methods onListBotsRequest.Builderto create a request.- Returns:
 - Result of the ListBots operation returned by the service.
 - See Also:
 
 - 
listBotsPaginator
default ListBotsIterable listBotsPaginator(ListBotsRequest listBotsRequest) throws ServiceUnavailableException, ServiceFailureException, ForbiddenException, UnauthorizedClientException, BadRequestException, NotFoundException, ThrottledClientException, AwsServiceException, SdkClientException, ChimeException This is a variant of
listBots(software.amazon.awssdk.services.chime.model.ListBotsRequest)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
2) Using For loopsoftware.amazon.awssdk.services.chime.paginators.ListBotsIterable responses = client.listBotsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.chime.paginators.ListBotsIterable responses = client.listBotsPaginator(request); for (software.amazon.awssdk.services.chime.model.ListBotsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.chime.paginators.ListBotsIterable responses = client.listBotsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBots(software.amazon.awssdk.services.chime.model.ListBotsRequest)operation.- Parameters:
 listBotsRequest-- Returns:
 - A custom iterable that can be used to iterate through all the response pages.
 - See Also:
 
 - 
listBotsPaginator
default ListBotsIterable listBotsPaginator(Consumer<ListBotsRequest.Builder> listBotsRequest) throws ServiceUnavailableException, ServiceFailureException, ForbiddenException, UnauthorizedClientException, BadRequestException, NotFoundException, ThrottledClientException, AwsServiceException, SdkClientException, ChimeException This is a variant of
listBots(software.amazon.awssdk.services.chime.model.ListBotsRequest)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
2) Using For loopsoftware.amazon.awssdk.services.chime.paginators.ListBotsIterable responses = client.listBotsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.chime.paginators.ListBotsIterable responses = client.listBotsPaginator(request); for (software.amazon.awssdk.services.chime.model.ListBotsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.chime.paginators.ListBotsIterable responses = client.listBotsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBots(software.amazon.awssdk.services.chime.model.ListBotsRequest)operation.
This is a convenience which creates an instance of the
ListBotsRequest.Builderavoiding the need to create one manually viaListBotsRequest.builder()- Parameters:
 listBotsRequest- AConsumerthat will call methods onListBotsRequest.Builderto create a request.- Returns:
 - A custom iterable that can be used to iterate through all the response pages.
 - See Also:
 
 - 
listPhoneNumberOrders
default ListPhoneNumberOrdersResponse listPhoneNumberOrders(ListPhoneNumberOrdersRequest listPhoneNumberOrdersRequest) throws UnauthorizedClientException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Lists the phone number orders for the administrator's Amazon Chime account.
- Parameters:
 listPhoneNumberOrdersRequest-- Returns:
 - Result of the ListPhoneNumberOrders operation returned by the service.
 - See Also:
 
 - 
listPhoneNumberOrders
default ListPhoneNumberOrdersResponse listPhoneNumberOrders(Consumer<ListPhoneNumberOrdersRequest.Builder> listPhoneNumberOrdersRequest) throws UnauthorizedClientException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Lists the phone number orders for the administrator's Amazon Chime account.
This is a convenience which creates an instance of the
ListPhoneNumberOrdersRequest.Builderavoiding the need to create one manually viaListPhoneNumberOrdersRequest.builder()- Parameters:
 listPhoneNumberOrdersRequest- AConsumerthat will call methods onListPhoneNumberOrdersRequest.Builderto create a request.- Returns:
 - Result of the ListPhoneNumberOrders operation returned by the service.
 - See Also:
 
 - 
listPhoneNumberOrdersPaginator
default ListPhoneNumberOrdersIterable listPhoneNumberOrdersPaginator(ListPhoneNumberOrdersRequest listPhoneNumberOrdersRequest) throws UnauthorizedClientException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException This is a variant of
listPhoneNumberOrders(software.amazon.awssdk.services.chime.model.ListPhoneNumberOrdersRequest)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
2) Using For loopsoftware.amazon.awssdk.services.chime.paginators.ListPhoneNumberOrdersIterable responses = client.listPhoneNumberOrdersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.chime.paginators.ListPhoneNumberOrdersIterable responses = client .listPhoneNumberOrdersPaginator(request); for (software.amazon.awssdk.services.chime.model.ListPhoneNumberOrdersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.chime.paginators.ListPhoneNumberOrdersIterable responses = client.listPhoneNumberOrdersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPhoneNumberOrders(software.amazon.awssdk.services.chime.model.ListPhoneNumberOrdersRequest)operation.- Parameters:
 listPhoneNumberOrdersRequest-- Returns:
 - A custom iterable that can be used to iterate through all the response pages.
 - See Also:
 
 - 
listPhoneNumberOrdersPaginator
default ListPhoneNumberOrdersIterable listPhoneNumberOrdersPaginator(Consumer<ListPhoneNumberOrdersRequest.Builder> listPhoneNumberOrdersRequest) throws UnauthorizedClientException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException This is a variant of
listPhoneNumberOrders(software.amazon.awssdk.services.chime.model.ListPhoneNumberOrdersRequest)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
2) Using For loopsoftware.amazon.awssdk.services.chime.paginators.ListPhoneNumberOrdersIterable responses = client.listPhoneNumberOrdersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.chime.paginators.ListPhoneNumberOrdersIterable responses = client .listPhoneNumberOrdersPaginator(request); for (software.amazon.awssdk.services.chime.model.ListPhoneNumberOrdersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.chime.paginators.ListPhoneNumberOrdersIterable responses = client.listPhoneNumberOrdersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPhoneNumberOrders(software.amazon.awssdk.services.chime.model.ListPhoneNumberOrdersRequest)operation.
This is a convenience which creates an instance of the
ListPhoneNumberOrdersRequest.Builderavoiding the need to create one manually viaListPhoneNumberOrdersRequest.builder()- Parameters:
 listPhoneNumberOrdersRequest- AConsumerthat will call methods onListPhoneNumberOrdersRequest.Builderto create a request.- Returns:
 - A custom iterable that can be used to iterate through all the response pages.
 - See Also:
 
 - 
listPhoneNumbers
default ListPhoneNumbersResponse listPhoneNumbers(ListPhoneNumbersRequest listPhoneNumbersRequest) throws UnauthorizedClientException, ForbiddenException, BadRequestException, NotFoundException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.
- Parameters:
 listPhoneNumbersRequest-- Returns:
 - Result of the ListPhoneNumbers operation returned by the service.
 - See Also:
 
 - 
listPhoneNumbers
default ListPhoneNumbersResponse listPhoneNumbers(Consumer<ListPhoneNumbersRequest.Builder> listPhoneNumbersRequest) throws UnauthorizedClientException, ForbiddenException, BadRequestException, NotFoundException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.
This is a convenience which creates an instance of the
ListPhoneNumbersRequest.Builderavoiding the need to create one manually viaListPhoneNumbersRequest.builder()- Parameters:
 listPhoneNumbersRequest- AConsumerthat will call methods onListPhoneNumbersRequest.Builderto create a request.- Returns:
 - Result of the ListPhoneNumbers operation returned by the service.
 - See Also:
 
 - 
listPhoneNumbersPaginator
default ListPhoneNumbersIterable listPhoneNumbersPaginator(ListPhoneNumbersRequest listPhoneNumbersRequest) throws UnauthorizedClientException, ForbiddenException, BadRequestException, NotFoundException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException This is a variant of
listPhoneNumbers(software.amazon.awssdk.services.chime.model.ListPhoneNumbersRequest)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
2) Using For loopsoftware.amazon.awssdk.services.chime.paginators.ListPhoneNumbersIterable responses = client.listPhoneNumbersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.chime.paginators.ListPhoneNumbersIterable responses = client .listPhoneNumbersPaginator(request); for (software.amazon.awssdk.services.chime.model.ListPhoneNumbersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.chime.paginators.ListPhoneNumbersIterable responses = client.listPhoneNumbersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPhoneNumbers(software.amazon.awssdk.services.chime.model.ListPhoneNumbersRequest)operation.- Parameters:
 listPhoneNumbersRequest-- Returns:
 - A custom iterable that can be used to iterate through all the response pages.
 - See Also:
 
 - 
listPhoneNumbersPaginator
default ListPhoneNumbersIterable listPhoneNumbersPaginator(Consumer<ListPhoneNumbersRequest.Builder> listPhoneNumbersRequest) throws UnauthorizedClientException, ForbiddenException, BadRequestException, NotFoundException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException This is a variant of
listPhoneNumbers(software.amazon.awssdk.services.chime.model.ListPhoneNumbersRequest)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
2) Using For loopsoftware.amazon.awssdk.services.chime.paginators.ListPhoneNumbersIterable responses = client.listPhoneNumbersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.chime.paginators.ListPhoneNumbersIterable responses = client .listPhoneNumbersPaginator(request); for (software.amazon.awssdk.services.chime.model.ListPhoneNumbersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.chime.paginators.ListPhoneNumbersIterable responses = client.listPhoneNumbersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPhoneNumbers(software.amazon.awssdk.services.chime.model.ListPhoneNumbersRequest)operation.
This is a convenience which creates an instance of the
ListPhoneNumbersRequest.Builderavoiding the need to create one manually viaListPhoneNumbersRequest.builder()- Parameters:
 listPhoneNumbersRequest- AConsumerthat will call methods onListPhoneNumbersRequest.Builderto create a request.- Returns:
 - A custom iterable that can be used to iterate through all the response pages.
 - See Also:
 
 - 
listRoomMemberships
default ListRoomMembershipsResponse listRoomMemberships(ListRoomMembershipsRequest listRoomMembershipsRequest) throws NotFoundException, BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members' IDs, email addresses, and names.
- Parameters:
 listRoomMembershipsRequest-- Returns:
 - Result of the ListRoomMemberships operation returned by the service.
 - See Also:
 
 - 
listRoomMemberships
default ListRoomMembershipsResponse listRoomMemberships(Consumer<ListRoomMembershipsRequest.Builder> listRoomMembershipsRequest) throws NotFoundException, BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members' IDs, email addresses, and names.
This is a convenience which creates an instance of the
ListRoomMembershipsRequest.Builderavoiding the need to create one manually viaListRoomMembershipsRequest.builder()- Parameters:
 listRoomMembershipsRequest- AConsumerthat will call methods onListRoomMembershipsRequest.Builderto create a request.- Returns:
 - Result of the ListRoomMemberships operation returned by the service.
 - See Also:
 
 - 
listRoomMembershipsPaginator
default ListRoomMembershipsIterable listRoomMembershipsPaginator(ListRoomMembershipsRequest listRoomMembershipsRequest) throws NotFoundException, BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException This is a variant of
listRoomMemberships(software.amazon.awssdk.services.chime.model.ListRoomMembershipsRequest)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
2) Using For loopsoftware.amazon.awssdk.services.chime.paginators.ListRoomMembershipsIterable responses = client.listRoomMembershipsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.chime.paginators.ListRoomMembershipsIterable responses = client .listRoomMembershipsPaginator(request); for (software.amazon.awssdk.services.chime.model.ListRoomMembershipsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.chime.paginators.ListRoomMembershipsIterable responses = client.listRoomMembershipsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRoomMemberships(software.amazon.awssdk.services.chime.model.ListRoomMembershipsRequest)operation.- Parameters:
 listRoomMembershipsRequest-- Returns:
 - A custom iterable that can be used to iterate through all the response pages.
 - See Also:
 
 - 
listRoomMembershipsPaginator
default ListRoomMembershipsIterable listRoomMembershipsPaginator(Consumer<ListRoomMembershipsRequest.Builder> listRoomMembershipsRequest) throws NotFoundException, BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException This is a variant of
listRoomMemberships(software.amazon.awssdk.services.chime.model.ListRoomMembershipsRequest)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
2) Using For loopsoftware.amazon.awssdk.services.chime.paginators.ListRoomMembershipsIterable responses = client.listRoomMembershipsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.chime.paginators.ListRoomMembershipsIterable responses = client .listRoomMembershipsPaginator(request); for (software.amazon.awssdk.services.chime.model.ListRoomMembershipsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.chime.paginators.ListRoomMembershipsIterable responses = client.listRoomMembershipsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRoomMemberships(software.amazon.awssdk.services.chime.model.ListRoomMembershipsRequest)operation.
This is a convenience which creates an instance of the
ListRoomMembershipsRequest.Builderavoiding the need to create one manually viaListRoomMembershipsRequest.builder()- Parameters:
 listRoomMembershipsRequest- AConsumerthat will call methods onListRoomMembershipsRequest.Builderto create a request.- Returns:
 - A custom iterable that can be used to iterate through all the response pages.
 - See Also:
 
 - 
listRooms
default ListRoomsResponse listRooms(ListRoomsRequest listRoomsRequest) throws NotFoundException, BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Lists the room details for the specified Amazon Chime Enterprise account. Optionally, filter the results by a member ID (user ID or bot ID) to see a list of rooms that the member belongs to.
- Parameters:
 listRoomsRequest-- Returns:
 - Result of the ListRooms operation returned by the service.
 - See Also:
 
 - 
listRooms
default ListRoomsResponse listRooms(Consumer<ListRoomsRequest.Builder> listRoomsRequest) throws NotFoundException, BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Lists the room details for the specified Amazon Chime Enterprise account. Optionally, filter the results by a member ID (user ID or bot ID) to see a list of rooms that the member belongs to.
This is a convenience which creates an instance of the
ListRoomsRequest.Builderavoiding the need to create one manually viaListRoomsRequest.builder()- Parameters:
 listRoomsRequest- AConsumerthat will call methods onListRoomsRequest.Builderto create a request.- Returns:
 - Result of the ListRooms operation returned by the service.
 - See Also:
 
 - 
listRoomsPaginator
default ListRoomsIterable listRoomsPaginator(ListRoomsRequest listRoomsRequest) throws NotFoundException, BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException This is a variant of
listRooms(software.amazon.awssdk.services.chime.model.ListRoomsRequest)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
2) Using For loopsoftware.amazon.awssdk.services.chime.paginators.ListRoomsIterable responses = client.listRoomsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.chime.paginators.ListRoomsIterable responses = client.listRoomsPaginator(request); for (software.amazon.awssdk.services.chime.model.ListRoomsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.chime.paginators.ListRoomsIterable responses = client.listRoomsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRooms(software.amazon.awssdk.services.chime.model.ListRoomsRequest)operation.- Parameters:
 listRoomsRequest-- Returns:
 - A custom iterable that can be used to iterate through all the response pages.
 - See Also:
 
 - 
listRoomsPaginator
default ListRoomsIterable listRoomsPaginator(Consumer<ListRoomsRequest.Builder> listRoomsRequest) throws NotFoundException, BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException This is a variant of
listRooms(software.amazon.awssdk.services.chime.model.ListRoomsRequest)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
2) Using For loopsoftware.amazon.awssdk.services.chime.paginators.ListRoomsIterable responses = client.listRoomsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.chime.paginators.ListRoomsIterable responses = client.listRoomsPaginator(request); for (software.amazon.awssdk.services.chime.model.ListRoomsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.chime.paginators.ListRoomsIterable responses = client.listRoomsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRooms(software.amazon.awssdk.services.chime.model.ListRoomsRequest)operation.
This is a convenience which creates an instance of the
ListRoomsRequest.Builderavoiding the need to create one manually viaListRoomsRequest.builder()- Parameters:
 listRoomsRequest- AConsumerthat will call methods onListRoomsRequest.Builderto create a request.- Returns:
 - A custom iterable that can be used to iterate through all the response pages.
 - See Also:
 
 - 
listSupportedPhoneNumberCountries
default ListSupportedPhoneNumberCountriesResponse listSupportedPhoneNumberCountries(ListSupportedPhoneNumberCountriesRequest listSupportedPhoneNumberCountriesRequest) throws BadRequestException, ForbiddenException, AccessDeniedException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Lists supported phone number countries.
- Parameters:
 listSupportedPhoneNumberCountriesRequest-- Returns:
 - Result of the ListSupportedPhoneNumberCountries operation returned by the service.
 - See Also:
 
 - 
listSupportedPhoneNumberCountries
default ListSupportedPhoneNumberCountriesResponse listSupportedPhoneNumberCountries(Consumer<ListSupportedPhoneNumberCountriesRequest.Builder> listSupportedPhoneNumberCountriesRequest) throws BadRequestException, ForbiddenException, AccessDeniedException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Lists supported phone number countries.
This is a convenience which creates an instance of the
ListSupportedPhoneNumberCountriesRequest.Builderavoiding the need to create one manually viaListSupportedPhoneNumberCountriesRequest.builder()- Parameters:
 listSupportedPhoneNumberCountriesRequest- AConsumerthat will call methods onListSupportedPhoneNumberCountriesRequest.Builderto create a request.- Returns:
 - Result of the ListSupportedPhoneNumberCountries operation returned by the service.
 - See Also:
 
 - 
listUsers
default ListUsersResponse listUsers(ListUsersRequest listUsersRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Lists the users that belong to the specified Amazon Chime account. You can specify an email address to list only the user that the email address belongs to.
- Parameters:
 listUsersRequest-- Returns:
 - Result of the ListUsers operation returned by the service.
 - See Also:
 
 - 
listUsers
default ListUsersResponse listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Lists the users that belong to the specified Amazon Chime account. You can specify an email address to list only the user that the email address belongs to.
This is a convenience which creates an instance of the
ListUsersRequest.Builderavoiding the need to create one manually viaListUsersRequest.builder()- Parameters:
 listUsersRequest- AConsumerthat will call methods onListUsersRequest.Builderto create a request.- Returns:
 - Result of the ListUsers operation returned by the service.
 - See Also:
 
 - 
listUsersPaginator
default ListUsersIterable listUsersPaginator(ListUsersRequest listUsersRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException This is a variant of
listUsers(software.amazon.awssdk.services.chime.model.ListUsersRequest)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
2) Using For loopsoftware.amazon.awssdk.services.chime.paginators.ListUsersIterable responses = client.listUsersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.chime.paginators.ListUsersIterable responses = client.listUsersPaginator(request); for (software.amazon.awssdk.services.chime.model.ListUsersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.chime.paginators.ListUsersIterable responses = client.listUsersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listUsers(software.amazon.awssdk.services.chime.model.ListUsersRequest)operation.- Parameters:
 listUsersRequest-- Returns:
 - A custom iterable that can be used to iterate through all the response pages.
 - See Also:
 
 - 
listUsersPaginator
default ListUsersIterable listUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException This is a variant of
listUsers(software.amazon.awssdk.services.chime.model.ListUsersRequest)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
2) Using For loopsoftware.amazon.awssdk.services.chime.paginators.ListUsersIterable responses = client.listUsersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.chime.paginators.ListUsersIterable responses = client.listUsersPaginator(request); for (software.amazon.awssdk.services.chime.model.ListUsersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.chime.paginators.ListUsersIterable responses = client.listUsersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listUsers(software.amazon.awssdk.services.chime.model.ListUsersRequest)operation.
This is a convenience which creates an instance of the
ListUsersRequest.Builderavoiding the need to create one manually viaListUsersRequest.builder()- Parameters:
 listUsersRequest- AConsumerthat will call methods onListUsersRequest.Builderto create a request.- Returns:
 - A custom iterable that can be used to iterate through all the response pages.
 - See Also:
 
 - 
logoutUser
default LogoutUserResponse logoutUser(LogoutUserRequest logoutUserRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Logs out the specified user from all of the devices they are currently logged into.
- Parameters:
 logoutUserRequest-- Returns:
 - Result of the LogoutUser operation returned by the service.
 - See Also:
 
 - 
logoutUser
default LogoutUserResponse logoutUser(Consumer<LogoutUserRequest.Builder> logoutUserRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Logs out the specified user from all of the devices they are currently logged into.
This is a convenience which creates an instance of the
LogoutUserRequest.Builderavoiding the need to create one manually viaLogoutUserRequest.builder()- Parameters:
 logoutUserRequest- AConsumerthat will call methods onLogoutUserRequest.Builderto create a request.- Returns:
 - Result of the LogoutUser operation returned by the service.
 - See Also:
 
 - 
putEventsConfiguration
default PutEventsConfigurationResponse putEventsConfiguration(PutEventsConfigurationRequest putEventsConfigurationRequest) throws ServiceUnavailableException, ServiceFailureException, ForbiddenException, BadRequestException, UnauthorizedClientException, ResourceLimitExceededException, NotFoundException, AwsServiceException, SdkClientException, ChimeException Creates an events configuration that allows a bot to receive outgoing events sent by Amazon Chime. Choose either an HTTPS endpoint or a Lambda function ARN. For more information, see Bot.
- Parameters:
 putEventsConfigurationRequest-- Returns:
 - Result of the PutEventsConfiguration operation returned by the service.
 - See Also:
 
 - 
putEventsConfiguration
default PutEventsConfigurationResponse putEventsConfiguration(Consumer<PutEventsConfigurationRequest.Builder> putEventsConfigurationRequest) throws ServiceUnavailableException, ServiceFailureException, ForbiddenException, BadRequestException, UnauthorizedClientException, ResourceLimitExceededException, NotFoundException, AwsServiceException, SdkClientException, ChimeException Creates an events configuration that allows a bot to receive outgoing events sent by Amazon Chime. Choose either an HTTPS endpoint or a Lambda function ARN. For more information, see Bot.
This is a convenience which creates an instance of the
PutEventsConfigurationRequest.Builderavoiding the need to create one manually viaPutEventsConfigurationRequest.builder()- Parameters:
 putEventsConfigurationRequest- AConsumerthat will call methods onPutEventsConfigurationRequest.Builderto create a request.- Returns:
 - Result of the PutEventsConfiguration operation returned by the service.
 - See Also:
 
 - 
putRetentionSettings
default PutRetentionSettingsResponse putRetentionSettings(PutRetentionSettingsRequest putRetentionSettingsRequest) throws UnauthorizedClientException, NotFoundException, BadRequestException, ForbiddenException, ConflictException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Puts retention settings for the specified Amazon Chime Enterprise account. We recommend using AWS CloudTrail to monitor usage of this API for your account. For more information, see Logging Amazon Chime API Calls with AWS CloudTrail in the Amazon Chime Administration Guide.
To turn off existing retention settings, remove the number of days from the corresponding RetentionDays field in the RetentionSettings object. For more information about retention settings, see Managing Chat Retention Policies in the Amazon Chime Administration Guide.
- Parameters:
 putRetentionSettingsRequest-- Returns:
 - Result of the PutRetentionSettings operation returned by the service.
 - See Also:
 
 - 
putRetentionSettings
default PutRetentionSettingsResponse putRetentionSettings(Consumer<PutRetentionSettingsRequest.Builder> putRetentionSettingsRequest) throws UnauthorizedClientException, NotFoundException, BadRequestException, ForbiddenException, ConflictException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Puts retention settings for the specified Amazon Chime Enterprise account. We recommend using AWS CloudTrail to monitor usage of this API for your account. For more information, see Logging Amazon Chime API Calls with AWS CloudTrail in the Amazon Chime Administration Guide.
To turn off existing retention settings, remove the number of days from the corresponding RetentionDays field in the RetentionSettings object. For more information about retention settings, see Managing Chat Retention Policies in the Amazon Chime Administration Guide.
This is a convenience which creates an instance of the
PutRetentionSettingsRequest.Builderavoiding the need to create one manually viaPutRetentionSettingsRequest.builder()- Parameters:
 putRetentionSettingsRequest- AConsumerthat will call methods onPutRetentionSettingsRequest.Builderto create a request.- Returns:
 - Result of the PutRetentionSettings operation returned by the service.
 - See Also:
 
 - 
redactConversationMessage
default RedactConversationMessageResponse redactConversationMessage(RedactConversationMessageRequest redactConversationMessageRequest) throws NotFoundException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, BadRequestException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Redacts the specified message from the specified Amazon Chime conversation.
- Parameters:
 redactConversationMessageRequest-- Returns:
 - Result of the RedactConversationMessage operation returned by the service.
 - See Also:
 
 - 
redactConversationMessage
default RedactConversationMessageResponse redactConversationMessage(Consumer<RedactConversationMessageRequest.Builder> redactConversationMessageRequest) throws NotFoundException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, BadRequestException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Redacts the specified message from the specified Amazon Chime conversation.
This is a convenience which creates an instance of the
RedactConversationMessageRequest.Builderavoiding the need to create one manually viaRedactConversationMessageRequest.builder()- Parameters:
 redactConversationMessageRequest- AConsumerthat will call methods onRedactConversationMessageRequest.Builderto create a request.- Returns:
 - Result of the RedactConversationMessage operation returned by the service.
 - See Also:
 
 - 
redactRoomMessage
default RedactRoomMessageResponse redactRoomMessage(RedactRoomMessageRequest redactRoomMessageRequest) throws NotFoundException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, BadRequestException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Redacts the specified message from the specified Amazon Chime channel.
- Parameters:
 redactRoomMessageRequest-- Returns:
 - Result of the RedactRoomMessage operation returned by the service.
 - See Also:
 
 - 
redactRoomMessage
default RedactRoomMessageResponse redactRoomMessage(Consumer<RedactRoomMessageRequest.Builder> redactRoomMessageRequest) throws NotFoundException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, BadRequestException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Redacts the specified message from the specified Amazon Chime channel.
This is a convenience which creates an instance of the
RedactRoomMessageRequest.Builderavoiding the need to create one manually viaRedactRoomMessageRequest.builder()- Parameters:
 redactRoomMessageRequest- AConsumerthat will call methods onRedactRoomMessageRequest.Builderto create a request.- Returns:
 - Result of the RedactRoomMessage operation returned by the service.
 - See Also:
 
 - 
regenerateSecurityToken
default RegenerateSecurityTokenResponse regenerateSecurityToken(RegenerateSecurityTokenRequest regenerateSecurityTokenRequest) throws ServiceUnavailableException, ServiceFailureException, ForbiddenException, BadRequestException, UnauthorizedClientException, NotFoundException, ThrottledClientException, AwsServiceException, SdkClientException, ChimeException Regenerates the security token for a bot.
- Parameters:
 regenerateSecurityTokenRequest-- Returns:
 - Result of the RegenerateSecurityToken operation returned by the service.
 - See Also:
 
 - 
regenerateSecurityToken
default RegenerateSecurityTokenResponse regenerateSecurityToken(Consumer<RegenerateSecurityTokenRequest.Builder> regenerateSecurityTokenRequest) throws ServiceUnavailableException, ServiceFailureException, ForbiddenException, BadRequestException, UnauthorizedClientException, NotFoundException, ThrottledClientException, AwsServiceException, SdkClientException, ChimeException Regenerates the security token for a bot.
This is a convenience which creates an instance of the
RegenerateSecurityTokenRequest.Builderavoiding the need to create one manually viaRegenerateSecurityTokenRequest.builder()- Parameters:
 regenerateSecurityTokenRequest- AConsumerthat will call methods onRegenerateSecurityTokenRequest.Builderto create a request.- Returns:
 - Result of the RegenerateSecurityToken operation returned by the service.
 - See Also:
 
 - 
resetPersonalPIN
default ResetPersonalPinResponse resetPersonalPIN(ResetPersonalPinRequest resetPersonalPinRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Resets the personal meeting PIN for the specified user on an Amazon Chime account. Returns the User object with the updated personal meeting PIN.
- Parameters:
 resetPersonalPinRequest-- Returns:
 - Result of the ResetPersonalPIN operation returned by the service.
 - See Also:
 
 - 
resetPersonalPIN
default ResetPersonalPinResponse resetPersonalPIN(Consumer<ResetPersonalPinRequest.Builder> resetPersonalPinRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Resets the personal meeting PIN for the specified user on an Amazon Chime account. Returns the User object with the updated personal meeting PIN.
This is a convenience which creates an instance of the
ResetPersonalPinRequest.Builderavoiding the need to create one manually viaResetPersonalPinRequest.builder()- Parameters:
 resetPersonalPinRequest- AConsumerthat will call methods onResetPersonalPinRequest.Builderto create a request.- Returns:
 - Result of the ResetPersonalPIN operation returned by the service.
 - See Also:
 
 - 
restorePhoneNumber
default RestorePhoneNumberResponse restorePhoneNumber(RestorePhoneNumberRequest restorePhoneNumberRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ResourceLimitExceededException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Moves a phone number from the Deletion queue back into the phone number Inventory.
- Parameters:
 restorePhoneNumberRequest-- Returns:
 - Result of the RestorePhoneNumber operation returned by the service.
 - See Also:
 
 - 
restorePhoneNumber
default RestorePhoneNumberResponse restorePhoneNumber(Consumer<RestorePhoneNumberRequest.Builder> restorePhoneNumberRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ResourceLimitExceededException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Moves a phone number from the Deletion queue back into the phone number Inventory.
This is a convenience which creates an instance of the
RestorePhoneNumberRequest.Builderavoiding the need to create one manually viaRestorePhoneNumberRequest.builder()- Parameters:
 restorePhoneNumberRequest- AConsumerthat will call methods onRestorePhoneNumberRequest.Builderto create a request.- Returns:
 - Result of the RestorePhoneNumber operation returned by the service.
 - See Also:
 
 - 
searchAvailablePhoneNumbers
default SearchAvailablePhoneNumbersResponse searchAvailablePhoneNumbers(SearchAvailablePhoneNumbersRequest searchAvailablePhoneNumbersRequest) throws BadRequestException, ForbiddenException, AccessDeniedException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Searches for phone numbers that can be ordered. For US numbers, provide at least one of the following search filters:
AreaCode,City,State, orTollFreePrefix. If you provideCity, you must also provideState. Numbers outside the US only support thePhoneNumberTypefilter, which you must use.- Parameters:
 searchAvailablePhoneNumbersRequest-- Returns:
 - Result of the SearchAvailablePhoneNumbers operation returned by the service.
 - See Also:
 
 - 
searchAvailablePhoneNumbers
default SearchAvailablePhoneNumbersResponse searchAvailablePhoneNumbers(Consumer<SearchAvailablePhoneNumbersRequest.Builder> searchAvailablePhoneNumbersRequest) throws BadRequestException, ForbiddenException, AccessDeniedException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Searches for phone numbers that can be ordered. For US numbers, provide at least one of the following search filters:
AreaCode,City,State, orTollFreePrefix. If you provideCity, you must also provideState. Numbers outside the US only support thePhoneNumberTypefilter, which you must use.
This is a convenience which creates an instance of the
SearchAvailablePhoneNumbersRequest.Builderavoiding the need to create one manually viaSearchAvailablePhoneNumbersRequest.builder()- Parameters:
 searchAvailablePhoneNumbersRequest- AConsumerthat will call methods onSearchAvailablePhoneNumbersRequest.Builderto create a request.- Returns:
 - Result of the SearchAvailablePhoneNumbers operation returned by the service.
 - See Also:
 
 - 
searchAvailablePhoneNumbersPaginator
default SearchAvailablePhoneNumbersIterable searchAvailablePhoneNumbersPaginator(SearchAvailablePhoneNumbersRequest searchAvailablePhoneNumbersRequest) throws BadRequestException, ForbiddenException, AccessDeniedException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException This is a variant of
searchAvailablePhoneNumbers(software.amazon.awssdk.services.chime.model.SearchAvailablePhoneNumbersRequest)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
2) Using For loopsoftware.amazon.awssdk.services.chime.paginators.SearchAvailablePhoneNumbersIterable responses = client.searchAvailablePhoneNumbersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.chime.paginators.SearchAvailablePhoneNumbersIterable responses = client .searchAvailablePhoneNumbersPaginator(request); for (software.amazon.awssdk.services.chime.model.SearchAvailablePhoneNumbersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.chime.paginators.SearchAvailablePhoneNumbersIterable responses = client.searchAvailablePhoneNumbersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchAvailablePhoneNumbers(software.amazon.awssdk.services.chime.model.SearchAvailablePhoneNumbersRequest)operation.- Parameters:
 searchAvailablePhoneNumbersRequest-- Returns:
 - A custom iterable that can be used to iterate through all the response pages.
 - See Also:
 
 - 
searchAvailablePhoneNumbersPaginator
default SearchAvailablePhoneNumbersIterable searchAvailablePhoneNumbersPaginator(Consumer<SearchAvailablePhoneNumbersRequest.Builder> searchAvailablePhoneNumbersRequest) throws BadRequestException, ForbiddenException, AccessDeniedException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException This is a variant of
searchAvailablePhoneNumbers(software.amazon.awssdk.services.chime.model.SearchAvailablePhoneNumbersRequest)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
2) Using For loopsoftware.amazon.awssdk.services.chime.paginators.SearchAvailablePhoneNumbersIterable responses = client.searchAvailablePhoneNumbersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.chime.paginators.SearchAvailablePhoneNumbersIterable responses = client .searchAvailablePhoneNumbersPaginator(request); for (software.amazon.awssdk.services.chime.model.SearchAvailablePhoneNumbersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.chime.paginators.SearchAvailablePhoneNumbersIterable responses = client.searchAvailablePhoneNumbersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchAvailablePhoneNumbers(software.amazon.awssdk.services.chime.model.SearchAvailablePhoneNumbersRequest)operation.
This is a convenience which creates an instance of the
SearchAvailablePhoneNumbersRequest.Builderavoiding the need to create one manually viaSearchAvailablePhoneNumbersRequest.builder()- Parameters:
 searchAvailablePhoneNumbersRequest- AConsumerthat will call methods onSearchAvailablePhoneNumbersRequest.Builderto create a request.- Returns:
 - A custom iterable that can be used to iterate through all the response pages.
 - See Also:
 
 - 
updateAccount
default UpdateAccountResponse updateAccount(UpdateAccountRequest updateAccountRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Updates account details for the specified Amazon Chime account. Currently, only account name and default license updates are supported for this action.
- Parameters:
 updateAccountRequest-- Returns:
 - Result of the UpdateAccount operation returned by the service.
 - See Also:
 
 - 
updateAccount
default UpdateAccountResponse updateAccount(Consumer<UpdateAccountRequest.Builder> updateAccountRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Updates account details for the specified Amazon Chime account. Currently, only account name and default license updates are supported for this action.
This is a convenience which creates an instance of the
UpdateAccountRequest.Builderavoiding the need to create one manually viaUpdateAccountRequest.builder()- Parameters:
 updateAccountRequest- AConsumerthat will call methods onUpdateAccountRequest.Builderto create a request.- Returns:
 - Result of the UpdateAccount operation returned by the service.
 - See Also:
 
 - 
updateAccountSettings
default UpdateAccountSettingsResponse updateAccountSettings(UpdateAccountSettingsRequest updateAccountSettingsRequest) throws UnauthorizedClientException, NotFoundException, BadRequestException, ForbiddenException, ConflictException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Updates the settings for the specified Amazon Chime account. You can update settings for remote control of shared screens, or for the dial-out option. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.
- Parameters:
 updateAccountSettingsRequest-- Returns:
 - Result of the UpdateAccountSettings operation returned by the service.
 - See Also:
 
 - 
updateAccountSettings
default UpdateAccountSettingsResponse updateAccountSettings(Consumer<UpdateAccountSettingsRequest.Builder> updateAccountSettingsRequest) throws UnauthorizedClientException, NotFoundException, BadRequestException, ForbiddenException, ConflictException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Updates the settings for the specified Amazon Chime account. You can update settings for remote control of shared screens, or for the dial-out option. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.
This is a convenience which creates an instance of the
UpdateAccountSettingsRequest.Builderavoiding the need to create one manually viaUpdateAccountSettingsRequest.builder()- Parameters:
 updateAccountSettingsRequest- AConsumerthat will call methods onUpdateAccountSettingsRequest.Builderto create a request.- Returns:
 - Result of the UpdateAccountSettings operation returned by the service.
 - See Also:
 
 - 
updateBot
default UpdateBotResponse updateBot(UpdateBotRequest updateBotRequest) throws ServiceUnavailableException, ServiceFailureException, ForbiddenException, BadRequestException, UnauthorizedClientException, NotFoundException, ThrottledClientException, AwsServiceException, SdkClientException, ChimeException Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.
- Parameters:
 updateBotRequest-- Returns:
 - Result of the UpdateBot operation returned by the service.
 - See Also:
 
 - 
updateBot
default UpdateBotResponse updateBot(Consumer<UpdateBotRequest.Builder> updateBotRequest) throws ServiceUnavailableException, ServiceFailureException, ForbiddenException, BadRequestException, UnauthorizedClientException, NotFoundException, ThrottledClientException, AwsServiceException, SdkClientException, ChimeException Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.
This is a convenience which creates an instance of the
UpdateBotRequest.Builderavoiding the need to create one manually viaUpdateBotRequest.builder()- Parameters:
 updateBotRequest- AConsumerthat will call methods onUpdateBotRequest.Builderto create a request.- Returns:
 - Result of the UpdateBot operation returned by the service.
 - See Also:
 
 - 
updateGlobalSettings
default UpdateGlobalSettingsResponse updateGlobalSettings(UpdateGlobalSettingsRequest updateGlobalSettingsRequest) throws UnauthorizedClientException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
- Parameters:
 updateGlobalSettingsRequest-- Returns:
 - Result of the UpdateGlobalSettings operation returned by the service.
 - See Also:
 
 - 
updateGlobalSettings
default UpdateGlobalSettingsResponse updateGlobalSettings(Consumer<UpdateGlobalSettingsRequest.Builder> updateGlobalSettingsRequest) throws UnauthorizedClientException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
This is a convenience which creates an instance of the
UpdateGlobalSettingsRequest.Builderavoiding the need to create one manually viaUpdateGlobalSettingsRequest.builder()- Parameters:
 updateGlobalSettingsRequest- AConsumerthat will call methods onUpdateGlobalSettingsRequest.Builderto create a request.- Returns:
 - Result of the UpdateGlobalSettings operation returned by the service.
 - See Also:
 
 - 
updatePhoneNumber
default UpdatePhoneNumberResponse updatePhoneNumber(UpdatePhoneNumberRequest updatePhoneNumberRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ConflictException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Updates phone number details, such as product type or calling name, for the specified phone number ID. You can update one phone number detail at a time. For example, you can update either the product type or the calling name in one action.
For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type.
Updates to outbound calling names can take 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.
- Parameters:
 updatePhoneNumberRequest-- Returns:
 - Result of the UpdatePhoneNumber operation returned by the service.
 - See Also:
 
 - 
updatePhoneNumber
default UpdatePhoneNumberResponse updatePhoneNumber(Consumer<UpdatePhoneNumberRequest.Builder> updatePhoneNumberRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ConflictException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Updates phone number details, such as product type or calling name, for the specified phone number ID. You can update one phone number detail at a time. For example, you can update either the product type or the calling name in one action.
For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type.
Updates to outbound calling names can take 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.
This is a convenience which creates an instance of the
UpdatePhoneNumberRequest.Builderavoiding the need to create one manually viaUpdatePhoneNumberRequest.builder()- Parameters:
 updatePhoneNumberRequest- AConsumerthat will call methods onUpdatePhoneNumberRequest.Builderto create a request.- Returns:
 - Result of the UpdatePhoneNumber operation returned by the service.
 - See Also:
 
 - 
updatePhoneNumberSettings
default UpdatePhoneNumberSettingsResponse updatePhoneNumberSettings(UpdatePhoneNumberSettingsRequest updatePhoneNumberSettingsRequest) throws UnauthorizedClientException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name. You can update the default outbound calling name once every seven days. Outbound calling names can take up to 72 hours to update.
- Parameters:
 updatePhoneNumberSettingsRequest-- Returns:
 - Result of the UpdatePhoneNumberSettings operation returned by the service.
 - See Also:
 
 - 
updatePhoneNumberSettings
default UpdatePhoneNumberSettingsResponse updatePhoneNumberSettings(Consumer<UpdatePhoneNumberSettingsRequest.Builder> updatePhoneNumberSettingsRequest) throws UnauthorizedClientException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name. You can update the default outbound calling name once every seven days. Outbound calling names can take up to 72 hours to update.
This is a convenience which creates an instance of the
UpdatePhoneNumberSettingsRequest.Builderavoiding the need to create one manually viaUpdatePhoneNumberSettingsRequest.builder()- Parameters:
 updatePhoneNumberSettingsRequest- AConsumerthat will call methods onUpdatePhoneNumberSettingsRequest.Builderto create a request.- Returns:
 - Result of the UpdatePhoneNumberSettings operation returned by the service.
 - See Also:
 
 - 
updateRoom
default UpdateRoomResponse updateRoom(UpdateRoomRequest updateRoomRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account.
- Parameters:
 updateRoomRequest-- Returns:
 - Result of the UpdateRoom operation returned by the service.
 - See Also:
 
 - 
updateRoom
default UpdateRoomResponse updateRoom(Consumer<UpdateRoomRequest.Builder> updateRoomRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account.
This is a convenience which creates an instance of the
UpdateRoomRequest.Builderavoiding the need to create one manually viaUpdateRoomRequest.builder()- Parameters:
 updateRoomRequest- AConsumerthat will call methods onUpdateRoomRequest.Builderto create a request.- Returns:
 - Result of the UpdateRoom operation returned by the service.
 - See Also:
 
 - 
updateRoomMembership
default UpdateRoomMembershipResponse updateRoomMembership(UpdateRoomMembershipRequest updateRoomMembershipRequest) throws UnauthorizedClientException, NotFoundException, BadRequestException, ForbiddenException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Updates room membership details, such as the member role, for a room in an Amazon Chime Enterprise account. The member role designates whether the member is a chat room administrator or a general chat room member. The member role can be updated only for user IDs.
- Parameters:
 updateRoomMembershipRequest-- Returns:
 - Result of the UpdateRoomMembership operation returned by the service.
 - See Also:
 
 - 
updateRoomMembership
default UpdateRoomMembershipResponse updateRoomMembership(Consumer<UpdateRoomMembershipRequest.Builder> updateRoomMembershipRequest) throws UnauthorizedClientException, NotFoundException, BadRequestException, ForbiddenException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Updates room membership details, such as the member role, for a room in an Amazon Chime Enterprise account. The member role designates whether the member is a chat room administrator or a general chat room member. The member role can be updated only for user IDs.
This is a convenience which creates an instance of the
UpdateRoomMembershipRequest.Builderavoiding the need to create one manually viaUpdateRoomMembershipRequest.builder()- Parameters:
 updateRoomMembershipRequest- AConsumerthat will call methods onUpdateRoomMembershipRequest.Builderto create a request.- Returns:
 - Result of the UpdateRoomMembership operation returned by the service.
 - See Also:
 
 - 
updateUser
default UpdateUserResponse updateUser(UpdateUserRequest updateUserRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Updates user details for a specified user ID. Currently, only
LicenseTypeupdates are supported for this action.- Parameters:
 updateUserRequest-- Returns:
 - Result of the UpdateUser operation returned by the service.
 - See Also:
 
 - 
updateUser
default UpdateUserResponse updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Updates user details for a specified user ID. Currently, only
LicenseTypeupdates are supported for this action.
This is a convenience which creates an instance of the
UpdateUserRequest.Builderavoiding the need to create one manually viaUpdateUserRequest.builder()- Parameters:
 updateUserRequest- AConsumerthat will call methods onUpdateUserRequest.Builderto create a request.- Returns:
 - Result of the UpdateUser operation returned by the service.
 - See Also:
 
 - 
updateUserSettings
default UpdateUserSettingsResponse updateUserSettings(UpdateUserSettingsRequest updateUserSettingsRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Updates the settings for the specified user, such as phone number settings.
- Parameters:
 updateUserSettingsRequest-- Returns:
 - Result of the UpdateUserSettings operation returned by the service.
 - See Also:
 
 - 
updateUserSettings
default UpdateUserSettingsResponse updateUserSettings(Consumer<UpdateUserSettingsRequest.Builder> updateUserSettingsRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException Updates the settings for the specified user, such as phone number settings.
This is a convenience which creates an instance of the
UpdateUserSettingsRequest.Builderavoiding the need to create one manually viaUpdateUserSettingsRequest.builder()- Parameters:
 updateUserSettingsRequest- AConsumerthat will call methods onUpdateUserSettingsRequest.Builderto create a request.- Returns:
 - Result of the UpdateUserSettings operation returned by the service.
 - See Also:
 
 - 
create
Create aChimeClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. - 
builder
Create a builder that can be used to configure and create aChimeClient. - 
serviceMetadata
 - 
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
 serviceClientConfigurationin interfaceAwsClient- Specified by:
 serviceClientConfigurationin interfaceSdkClient- Returns:
 - SdkServiceClientConfiguration
 
 
 -