Interface ChimeAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface ChimeAsyncClient extends AwsClient
Service client for accessing Amazon Chime asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.

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 chime and REST endpoint https://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 Details

  • Method Details

    • associatePhoneNumberWithUser

      default CompletableFuture<AssociatePhoneNumberWithUserResponse> associatePhoneNumberWithUser(AssociatePhoneNumberWithUserRequest associatePhoneNumberWithUserRequest)

      Associates a phone number with the specified Amazon Chime user.

      Parameters:
      associatePhoneNumberWithUserRequest -
      Returns:
      A Java Future containing the result of the AssociatePhoneNumberWithUser operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • AccessDeniedException You don't have permissions to perform the requested operation.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associatePhoneNumberWithUser

      default CompletableFuture<AssociatePhoneNumberWithUserResponse> associatePhoneNumberWithUser(Consumer<AssociatePhoneNumberWithUserRequest.Builder> associatePhoneNumberWithUserRequest)

      Associates a phone number with the specified Amazon Chime user.


      This is a convenience which creates an instance of the AssociatePhoneNumberWithUserRequest.Builder avoiding the need to create one manually via AssociatePhoneNumberWithUserRequest.builder()

      Parameters:
      associatePhoneNumberWithUserRequest - A Consumer that will call methods on AssociatePhoneNumberWithUserRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssociatePhoneNumberWithUser operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • AccessDeniedException You don't have permissions to perform the requested operation.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateSigninDelegateGroupsWithAccount

      default CompletableFuture<AssociateSigninDelegateGroupsWithAccountResponse> associateSigninDelegateGroupsWithAccount(AssociateSigninDelegateGroupsWithAccountRequest associateSigninDelegateGroupsWithAccountRequest)

      Associates the specified sign-in delegate groups with the specified Amazon Chime account.

      Parameters:
      associateSigninDelegateGroupsWithAccountRequest -
      Returns:
      A Java Future containing the result of the AssociateSigninDelegateGroupsWithAccount operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateSigninDelegateGroupsWithAccount

      default CompletableFuture<AssociateSigninDelegateGroupsWithAccountResponse> associateSigninDelegateGroupsWithAccount(Consumer<AssociateSigninDelegateGroupsWithAccountRequest.Builder> associateSigninDelegateGroupsWithAccountRequest)

      Associates the specified sign-in delegate groups with the specified Amazon Chime account.


      This is a convenience which creates an instance of the AssociateSigninDelegateGroupsWithAccountRequest.Builder avoiding the need to create one manually via AssociateSigninDelegateGroupsWithAccountRequest.builder()

      Parameters:
      associateSigninDelegateGroupsWithAccountRequest - A Consumer that will call methods on AssociateSigninDelegateGroupsWithAccountRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssociateSigninDelegateGroupsWithAccount operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchCreateRoomMembership

      default CompletableFuture<BatchCreateRoomMembershipResponse> batchCreateRoomMembership(BatchCreateRoomMembershipRequest batchCreateRoomMembershipRequest)

      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:
      A Java Future containing the result of the BatchCreateRoomMembership operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ForbiddenException The client is permanently forbidden from making the request.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchCreateRoomMembership

      default CompletableFuture<BatchCreateRoomMembershipResponse> batchCreateRoomMembership(Consumer<BatchCreateRoomMembershipRequest.Builder> batchCreateRoomMembershipRequest)

      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.Builder avoiding the need to create one manually via BatchCreateRoomMembershipRequest.builder()

      Parameters:
      batchCreateRoomMembershipRequest - A Consumer that will call methods on BatchCreateRoomMembershipRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the BatchCreateRoomMembership operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ForbiddenException The client is permanently forbidden from making the request.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchDeletePhoneNumber

      default CompletableFuture<BatchDeletePhoneNumberResponse> batchDeletePhoneNumber(BatchDeletePhoneNumberRequest batchDeletePhoneNumberRequest)

      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:
      A Java Future containing the result of the BatchDeletePhoneNumber operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchDeletePhoneNumber

      default CompletableFuture<BatchDeletePhoneNumberResponse> batchDeletePhoneNumber(Consumer<BatchDeletePhoneNumberRequest.Builder> batchDeletePhoneNumberRequest)

      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.Builder avoiding the need to create one manually via BatchDeletePhoneNumberRequest.builder()

      Parameters:
      batchDeletePhoneNumberRequest - A Consumer that will call methods on BatchDeletePhoneNumberRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the BatchDeletePhoneNumber operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchSuspendUser

      default CompletableFuture<BatchSuspendUserResponse> batchSuspendUser(BatchSuspendUserRequest batchSuspendUserRequest)

      Suspends up to 50 users from a Team or EnterpriseLWA Amazon 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 Team account are disassociated from the account,but they can continue to use Amazon Chime as free users. To remove the suspension from suspended Team account users, invite them to the Team account again. You can use the InviteUsers action to do so.

      Users suspended from an EnterpriseLWA account are immediately signed out of Amazon Chime and can no longer sign in. To remove the suspension from suspended EnterpriseLWA account users, use the BatchUnsuspendUser action.

      To sign out users without suspending them, use the LogoutUser action.

      Parameters:
      batchSuspendUserRequest -
      Returns:
      A Java Future containing the result of the BatchSuspendUser operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchSuspendUser

      default CompletableFuture<BatchSuspendUserResponse> batchSuspendUser(Consumer<BatchSuspendUserRequest.Builder> batchSuspendUserRequest)

      Suspends up to 50 users from a Team or EnterpriseLWA Amazon 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 Team account are disassociated from the account,but they can continue to use Amazon Chime as free users. To remove the suspension from suspended Team account users, invite them to the Team account again. You can use the InviteUsers action to do so.

      Users suspended from an EnterpriseLWA account are immediately signed out of Amazon Chime and can no longer sign in. To remove the suspension from suspended EnterpriseLWA account 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.Builder avoiding the need to create one manually via BatchSuspendUserRequest.builder()

      Parameters:
      batchSuspendUserRequest - A Consumer that will call methods on BatchSuspendUserRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the BatchSuspendUser operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchUnsuspendUser

      default CompletableFuture<BatchUnsuspendUserResponse> batchUnsuspendUser(BatchUnsuspendUserRequest batchUnsuspendUserRequest)

      Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime EnterpriseLWA account. Only users on EnterpriseLWA accounts 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 Registered status. Users who are not previously suspended are ignored.

      Parameters:
      batchUnsuspendUserRequest -
      Returns:
      A Java Future containing the result of the BatchUnsuspendUser operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchUnsuspendUser

      default CompletableFuture<BatchUnsuspendUserResponse> batchUnsuspendUser(Consumer<BatchUnsuspendUserRequest.Builder> batchUnsuspendUserRequest)

      Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime EnterpriseLWA account. Only users on EnterpriseLWA accounts 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 Registered status. Users who are not previously suspended are ignored.


      This is a convenience which creates an instance of the BatchUnsuspendUserRequest.Builder avoiding the need to create one manually via BatchUnsuspendUserRequest.builder()

      Parameters:
      batchUnsuspendUserRequest - A Consumer that will call methods on BatchUnsuspendUserRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the BatchUnsuspendUser operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchUpdatePhoneNumber

      default CompletableFuture<BatchUpdatePhoneNumberResponse> batchUpdatePhoneNumber(BatchUpdatePhoneNumberRequest batchUpdatePhoneNumberRequest)

      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:
      A Java Future containing the result of the BatchUpdatePhoneNumber operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchUpdatePhoneNumber

      default CompletableFuture<BatchUpdatePhoneNumberResponse> batchUpdatePhoneNumber(Consumer<BatchUpdatePhoneNumberRequest.Builder> batchUpdatePhoneNumberRequest)

      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.Builder avoiding the need to create one manually via BatchUpdatePhoneNumberRequest.builder()

      Parameters:
      batchUpdatePhoneNumberRequest - A Consumer that will call methods on BatchUpdatePhoneNumberRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the BatchUpdatePhoneNumber operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchUpdateUser

      default CompletableFuture<BatchUpdateUserResponse> batchUpdateUser(BatchUpdateUserRequest batchUpdateUserRequest)

      Updates user details within the UpdateUserRequestItem object for up to 20 users for the specified Amazon Chime account. Currently, only LicenseType updates are supported for this action.

      Parameters:
      batchUpdateUserRequest -
      Returns:
      A Java Future containing the result of the BatchUpdateUser operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchUpdateUser

      default CompletableFuture<BatchUpdateUserResponse> batchUpdateUser(Consumer<BatchUpdateUserRequest.Builder> batchUpdateUserRequest)

      Updates user details within the UpdateUserRequestItem object for up to 20 users for the specified Amazon Chime account. Currently, only LicenseType updates are supported for this action.


      This is a convenience which creates an instance of the BatchUpdateUserRequest.Builder avoiding the need to create one manually via BatchUpdateUserRequest.builder()

      Parameters:
      batchUpdateUserRequest - A Consumer that will call methods on BatchUpdateUserRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the BatchUpdateUser operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAccount

      default CompletableFuture<CreateAccountResponse> createAccount(CreateAccountRequest createAccountRequest)

      Creates an Amazon Chime account under the administrator's AWS account. Only Team account 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:
      A Java Future containing the result of the CreateAccount operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAccount

      default CompletableFuture<CreateAccountResponse> createAccount(Consumer<CreateAccountRequest.Builder> createAccountRequest)

      Creates an Amazon Chime account under the administrator's AWS account. Only Team account 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.Builder avoiding the need to create one manually via CreateAccountRequest.builder()

      Parameters:
      createAccountRequest - A Consumer that will call methods on CreateAccountRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateAccount operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createBot

      default CompletableFuture<CreateBotResponse> createBot(CreateBotRequest createBotRequest)

      Creates a bot for an Amazon Chime Enterprise account.

      Parameters:
      createBotRequest -
      Returns:
      A Java Future containing the result of the CreateBot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • ResourceLimitExceededException The request exceeds the resource limit.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ThrottledClientException The client exceeded its request rate limit.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createBot

      default CompletableFuture<CreateBotResponse> createBot(Consumer<CreateBotRequest.Builder> createBotRequest)

      Creates a bot for an Amazon Chime Enterprise account.


      This is a convenience which creates an instance of the CreateBotRequest.Builder avoiding the need to create one manually via CreateBotRequest.builder()

      Parameters:
      createBotRequest - A Consumer that will call methods on CreateBotRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateBot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • ResourceLimitExceededException The request exceeds the resource limit.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ThrottledClientException The client exceeded its request rate limit.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createMeetingDialOut

      default CompletableFuture<CreateMeetingDialOutResponse> createMeetingDialOut(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. Also ensures that the From number belongs to the customer.

      To play welcome audio or implement an interactive voice response (IVR), use the CreateSipMediaApplicationCall action with the corresponding SIP media application ID.

      This API is not available in a dedicated namespace.

      Parameters:
      createMeetingDialOutRequest -
      Returns:
      A Java Future containing the result of the CreateMeetingDialOut operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ForbiddenException The client is permanently forbidden from making the request.
      • ResourceLimitExceededException The request exceeds the resource limit.
      • ThrottledClientException The client exceeded its request rate limit.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • AccessDeniedException You don't have permissions to perform the requested operation.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createMeetingDialOut

      default CompletableFuture<CreateMeetingDialOutResponse> createMeetingDialOut(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. Also ensures that the From number belongs to the customer.

      To play welcome audio or implement an interactive voice response (IVR), use the CreateSipMediaApplicationCall action 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.Builder avoiding the need to create one manually via CreateMeetingDialOutRequest.builder()

      Parameters:
      createMeetingDialOutRequest - A Consumer that will call methods on CreateMeetingDialOutRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateMeetingDialOut operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ForbiddenException The client is permanently forbidden from making the request.
      • ResourceLimitExceededException The request exceeds the resource limit.
      • ThrottledClientException The client exceeded its request rate limit.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • AccessDeniedException You don't have permissions to perform the requested operation.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createPhoneNumberOrder

      default CompletableFuture<CreatePhoneNumberOrderResponse> createPhoneNumberOrder(CreatePhoneNumberOrderRequest createPhoneNumberOrderRequest)

      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:
      A Java Future containing the result of the CreatePhoneNumberOrder operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ForbiddenException The client is permanently forbidden from making the request.
      • AccessDeniedException You don't have permissions to perform the requested operation.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • ThrottledClientException The client exceeded its request rate limit.
      • ResourceLimitExceededException The request exceeds the resource limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createPhoneNumberOrder

      default CompletableFuture<CreatePhoneNumberOrderResponse> createPhoneNumberOrder(Consumer<CreatePhoneNumberOrderRequest.Builder> createPhoneNumberOrderRequest)

      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.Builder avoiding the need to create one manually via CreatePhoneNumberOrderRequest.builder()

      Parameters:
      createPhoneNumberOrderRequest - A Consumer that will call methods on CreatePhoneNumberOrderRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreatePhoneNumberOrder operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ForbiddenException The client is permanently forbidden from making the request.
      • AccessDeniedException You don't have permissions to perform the requested operation.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • ThrottledClientException The client exceeded its request rate limit.
      • ResourceLimitExceededException The request exceeds the resource limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createRoom

      default CompletableFuture<CreateRoomResponse> createRoom(CreateRoomRequest createRoomRequest)

      Creates a chat room for the specified Amazon Chime Enterprise account.

      Parameters:
      createRoomRequest -
      Returns:
      A Java Future containing the result of the CreateRoom operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ForbiddenException The client is permanently forbidden from making the request.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • ResourceLimitExceededException The request exceeds the resource limit.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createRoom

      default CompletableFuture<CreateRoomResponse> createRoom(Consumer<CreateRoomRequest.Builder> createRoomRequest)

      Creates a chat room for the specified Amazon Chime Enterprise account.


      This is a convenience which creates an instance of the CreateRoomRequest.Builder avoiding the need to create one manually via CreateRoomRequest.builder()

      Parameters:
      createRoomRequest - A Consumer that will call methods on CreateRoomRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateRoom operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ForbiddenException The client is permanently forbidden from making the request.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • ResourceLimitExceededException The request exceeds the resource limit.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createRoomMembership

      default CompletableFuture<CreateRoomMembershipResponse> createRoomMembership(CreateRoomMembershipRequest createRoomMembershipRequest)

      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:
      A Java Future containing the result of the CreateRoomMembership operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException The request could not be processed because of conflict in the current state of the resource.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ForbiddenException The client is permanently forbidden from making the request.
      • ResourceLimitExceededException The request exceeds the resource limit.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createRoomMembership

      default CompletableFuture<CreateRoomMembershipResponse> createRoomMembership(Consumer<CreateRoomMembershipRequest.Builder> createRoomMembershipRequest)

      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.Builder avoiding the need to create one manually via CreateRoomMembershipRequest.builder()

      Parameters:
      createRoomMembershipRequest - A Consumer that will call methods on CreateRoomMembershipRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateRoomMembership operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException The request could not be processed because of conflict in the current state of the resource.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ForbiddenException The client is permanently forbidden from making the request.
      • ResourceLimitExceededException The request exceeds the resource limit.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createUser

      default CompletableFuture<CreateUserResponse> createUser(CreateUserRequest createUserRequest)

      Creates a user under the specified Amazon Chime account.

      Parameters:
      createUserRequest -
      Returns:
      A Java Future containing the result of the CreateUser operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ConflictException The request could not be processed because of conflict in the current state of the resource.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createUser

      default CompletableFuture<CreateUserResponse> createUser(Consumer<CreateUserRequest.Builder> createUserRequest)

      Creates a user under the specified Amazon Chime account.


      This is a convenience which creates an instance of the CreateUserRequest.Builder avoiding the need to create one manually via CreateUserRequest.builder()

      Parameters:
      createUserRequest - A Consumer that will call methods on CreateUserRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateUser operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ConflictException The request could not be processed because of conflict in the current state of the resource.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAccount

      default CompletableFuture<DeleteAccountResponse> deleteAccount(DeleteAccountRequest deleteAccountRequest)

      Deletes the specified Amazon Chime account. You must suspend all users before deleting Team account. You can use the BatchSuspendUser action to dodo.

      For EnterpriseLWA and EnterpriseAD accounts, 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 Disabled accounts list for 90 days. To restore deleted account from your Disabled accounts list, you must contact AWS Support.

      After 90 days, deleted accounts are permanently removed from your Disabled accounts list.

      Parameters:
      deleteAccountRequest -
      Returns:
      A Java Future containing the result of the DeleteAccount operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • UnprocessableEntityException The request was well-formed but was unable to be followed due to semantic errors.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAccount

      default CompletableFuture<DeleteAccountResponse> deleteAccount(Consumer<DeleteAccountRequest.Builder> deleteAccountRequest)

      Deletes the specified Amazon Chime account. You must suspend all users before deleting Team account. You can use the BatchSuspendUser action to dodo.

      For EnterpriseLWA and EnterpriseAD accounts, 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 Disabled accounts list for 90 days. To restore deleted account from your Disabled accounts list, you must contact AWS Support.

      After 90 days, deleted accounts are permanently removed from your Disabled accounts list.


      This is a convenience which creates an instance of the DeleteAccountRequest.Builder avoiding the need to create one manually via DeleteAccountRequest.builder()

      Parameters:
      deleteAccountRequest - A Consumer that will call methods on DeleteAccountRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteAccount operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • UnprocessableEntityException The request was well-formed but was unable to be followed due to semantic errors.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteEventsConfiguration

      default CompletableFuture<DeleteEventsConfigurationResponse> deleteEventsConfiguration(DeleteEventsConfigurationRequest deleteEventsConfigurationRequest)

      Deletes the events configuration that allows a bot to receive outgoing events.

      Parameters:
      deleteEventsConfigurationRequest -
      Returns:
      A Java Future containing the result of the DeleteEventsConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • ResourceLimitExceededException The request exceeds the resource limit.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteEventsConfiguration

      default CompletableFuture<DeleteEventsConfigurationResponse> deleteEventsConfiguration(Consumer<DeleteEventsConfigurationRequest.Builder> deleteEventsConfigurationRequest)

      Deletes the events configuration that allows a bot to receive outgoing events.


      This is a convenience which creates an instance of the DeleteEventsConfigurationRequest.Builder avoiding the need to create one manually via DeleteEventsConfigurationRequest.builder()

      Parameters:
      deleteEventsConfigurationRequest - A Consumer that will call methods on DeleteEventsConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteEventsConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • ResourceLimitExceededException The request exceeds the resource limit.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deletePhoneNumber

      default CompletableFuture<DeletePhoneNumberResponse> deletePhoneNumber(DeletePhoneNumberRequest deletePhoneNumberRequest)

      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:
      A Java Future containing the result of the DeletePhoneNumber operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deletePhoneNumber

      default CompletableFuture<DeletePhoneNumberResponse> deletePhoneNumber(Consumer<DeletePhoneNumberRequest.Builder> deletePhoneNumberRequest)

      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.Builder avoiding the need to create one manually via DeletePhoneNumberRequest.builder()

      Parameters:
      deletePhoneNumberRequest - A Consumer that will call methods on DeletePhoneNumberRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeletePhoneNumber operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteRoom

      default CompletableFuture<DeleteRoomResponse> deleteRoom(DeleteRoomRequest deleteRoomRequest)

      Deletes a chat room in an Amazon Chime Enterprise account.

      Parameters:
      deleteRoomRequest -
      Returns:
      A Java Future containing the result of the DeleteRoom operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ForbiddenException The client is permanently forbidden from making the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteRoom

      default CompletableFuture<DeleteRoomResponse> deleteRoom(Consumer<DeleteRoomRequest.Builder> deleteRoomRequest)

      Deletes a chat room in an Amazon Chime Enterprise account.


      This is a convenience which creates an instance of the DeleteRoomRequest.Builder avoiding the need to create one manually via DeleteRoomRequest.builder()

      Parameters:
      deleteRoomRequest - A Consumer that will call methods on DeleteRoomRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteRoom operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ForbiddenException The client is permanently forbidden from making the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteRoomMembership

      default CompletableFuture<DeleteRoomMembershipResponse> deleteRoomMembership(DeleteRoomMembershipRequest deleteRoomMembershipRequest)

      Removes a member from a chat room in an Amazon Chime Enterprise account.

      Parameters:
      deleteRoomMembershipRequest -
      Returns:
      A Java Future containing the result of the DeleteRoomMembership operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ForbiddenException The client is permanently forbidden from making the request.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteRoomMembership

      default CompletableFuture<DeleteRoomMembershipResponse> deleteRoomMembership(Consumer<DeleteRoomMembershipRequest.Builder> deleteRoomMembershipRequest)

      Removes a member from a chat room in an Amazon Chime Enterprise account.


      This is a convenience which creates an instance of the DeleteRoomMembershipRequest.Builder avoiding the need to create one manually via DeleteRoomMembershipRequest.builder()

      Parameters:
      deleteRoomMembershipRequest - A Consumer that will call methods on DeleteRoomMembershipRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteRoomMembership operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ForbiddenException The client is permanently forbidden from making the request.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociatePhoneNumberFromUser

      default CompletableFuture<DisassociatePhoneNumberFromUserResponse> disassociatePhoneNumberFromUser(DisassociatePhoneNumberFromUserRequest disassociatePhoneNumberFromUserRequest)

      Disassociates the primary provisioned phone number from the specified Amazon Chime user.

      Parameters:
      disassociatePhoneNumberFromUserRequest -
      Returns:
      A Java Future containing the result of the DisassociatePhoneNumberFromUser operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociatePhoneNumberFromUser

      default CompletableFuture<DisassociatePhoneNumberFromUserResponse> disassociatePhoneNumberFromUser(Consumer<DisassociatePhoneNumberFromUserRequest.Builder> disassociatePhoneNumberFromUserRequest)

      Disassociates the primary provisioned phone number from the specified Amazon Chime user.


      This is a convenience which creates an instance of the DisassociatePhoneNumberFromUserRequest.Builder avoiding the need to create one manually via DisassociatePhoneNumberFromUserRequest.builder()

      Parameters:
      disassociatePhoneNumberFromUserRequest - A Consumer that will call methods on DisassociatePhoneNumberFromUserRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisassociatePhoneNumberFromUser operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateSigninDelegateGroupsFromAccount

      default CompletableFuture<DisassociateSigninDelegateGroupsFromAccountResponse> disassociateSigninDelegateGroupsFromAccount(DisassociateSigninDelegateGroupsFromAccountRequest disassociateSigninDelegateGroupsFromAccountRequest)

      Disassociates the specified sign-in delegate groups from the specified Amazon Chime account.

      Parameters:
      disassociateSigninDelegateGroupsFromAccountRequest -
      Returns:
      A Java Future containing the result of the DisassociateSigninDelegateGroupsFromAccount operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateSigninDelegateGroupsFromAccount

      default CompletableFuture<DisassociateSigninDelegateGroupsFromAccountResponse> disassociateSigninDelegateGroupsFromAccount(Consumer<DisassociateSigninDelegateGroupsFromAccountRequest.Builder> disassociateSigninDelegateGroupsFromAccountRequest)

      Disassociates the specified sign-in delegate groups from the specified Amazon Chime account.


      This is a convenience which creates an instance of the DisassociateSigninDelegateGroupsFromAccountRequest.Builder avoiding the need to create one manually via DisassociateSigninDelegateGroupsFromAccountRequest.builder()

      Parameters:
      disassociateSigninDelegateGroupsFromAccountRequest - A Consumer that will call methods on DisassociateSigninDelegateGroupsFromAccountRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisassociateSigninDelegateGroupsFromAccount operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAccount

      default CompletableFuture<GetAccountResponse> getAccount(GetAccountRequest getAccountRequest)

      Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.

      Parameters:
      getAccountRequest -
      Returns:
      A Java Future containing the result of the GetAccount operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAccount

      default CompletableFuture<GetAccountResponse> getAccount(Consumer<GetAccountRequest.Builder> getAccountRequest)

      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.Builder avoiding the need to create one manually via GetAccountRequest.builder()

      Parameters:
      getAccountRequest - A Consumer that will call methods on GetAccountRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetAccount operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAccountSettings

      default CompletableFuture<GetAccountSettingsResponse> getAccountSettings(GetAccountSettingsRequest getAccountSettingsRequest)

      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:
      A Java Future containing the result of the GetAccountSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ForbiddenException The client is permanently forbidden from making the request.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAccountSettings

      default CompletableFuture<GetAccountSettingsResponse> getAccountSettings(Consumer<GetAccountSettingsRequest.Builder> getAccountSettingsRequest)

      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.Builder avoiding the need to create one manually via GetAccountSettingsRequest.builder()

      Parameters:
      getAccountSettingsRequest - A Consumer that will call methods on GetAccountSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetAccountSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ForbiddenException The client is permanently forbidden from making the request.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBot

      default CompletableFuture<GetBotResponse> getBot(GetBotRequest getBotRequest)

      Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.

      Parameters:
      getBotRequest -
      Returns:
      A Java Future containing the result of the GetBot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • ForbiddenException The client is permanently forbidden from making the request.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBot

      default CompletableFuture<GetBotResponse> getBot(Consumer<GetBotRequest.Builder> getBotRequest)

      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.Builder avoiding the need to create one manually via GetBotRequest.builder()

      Parameters:
      getBotRequest - A Consumer that will call methods on GetBotRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetBot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • ForbiddenException The client is permanently forbidden from making the request.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getEventsConfiguration

      default CompletableFuture<GetEventsConfigurationResponse> getEventsConfiguration(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.

      Parameters:
      getEventsConfigurationRequest -
      Returns:
      A Java Future containing the result of the GetEventsConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • ResourceLimitExceededException The request exceeds the resource limit.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getEventsConfiguration

      default CompletableFuture<GetEventsConfigurationResponse> getEventsConfiguration(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.


      This is a convenience which creates an instance of the GetEventsConfigurationRequest.Builder avoiding the need to create one manually via GetEventsConfigurationRequest.builder()

      Parameters:
      getEventsConfigurationRequest - A Consumer that will call methods on GetEventsConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetEventsConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • ResourceLimitExceededException The request exceeds the resource limit.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getGlobalSettings

      default CompletableFuture<GetGlobalSettingsResponse> getGlobalSettings(GetGlobalSettingsRequest getGlobalSettingsRequest)

      Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.

      Parameters:
      getGlobalSettingsRequest -
      Returns:
      A Java Future containing the result of the GetGlobalSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getGlobalSettings

      default CompletableFuture<GetGlobalSettingsResponse> getGlobalSettings(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.


      This is a convenience which creates an instance of the GetGlobalSettingsRequest.Builder avoiding the need to create one manually via GetGlobalSettingsRequest.builder()

      Parameters:
      getGlobalSettingsRequest - A Consumer that will call methods on GetGlobalSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetGlobalSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getPhoneNumber

      default CompletableFuture<GetPhoneNumberResponse> getPhoneNumber(GetPhoneNumberRequest getPhoneNumberRequest)

      Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.

      Parameters:
      getPhoneNumberRequest -
      Returns:
      A Java Future containing the result of the GetPhoneNumber operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getPhoneNumber

      default CompletableFuture<GetPhoneNumberResponse> getPhoneNumber(Consumer<GetPhoneNumberRequest.Builder> getPhoneNumberRequest)

      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.Builder avoiding the need to create one manually via GetPhoneNumberRequest.builder()

      Parameters:
      getPhoneNumberRequest - A Consumer that will call methods on GetPhoneNumberRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetPhoneNumber operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getPhoneNumberOrder

      default CompletableFuture<GetPhoneNumberOrderResponse> getPhoneNumberOrder(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.

      Parameters:
      getPhoneNumberOrderRequest -
      Returns:
      A Java Future containing the result of the GetPhoneNumberOrder operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getPhoneNumberOrder

      default CompletableFuture<GetPhoneNumberOrderResponse> getPhoneNumberOrder(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.


      This is a convenience which creates an instance of the GetPhoneNumberOrderRequest.Builder avoiding the need to create one manually via GetPhoneNumberOrderRequest.builder()

      Parameters:
      getPhoneNumberOrderRequest - A Consumer that will call methods on GetPhoneNumberOrderRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetPhoneNumberOrder operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getPhoneNumberSettings

      default CompletableFuture<GetPhoneNumberSettingsResponse> getPhoneNumberSettings(GetPhoneNumberSettingsRequest getPhoneNumberSettingsRequest)

      Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.

      Parameters:
      getPhoneNumberSettingsRequest -
      Returns:
      A Java Future containing the result of the GetPhoneNumberSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getPhoneNumberSettings

      default CompletableFuture<GetPhoneNumberSettingsResponse> getPhoneNumberSettings(Consumer<GetPhoneNumberSettingsRequest.Builder> getPhoneNumberSettingsRequest)

      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.Builder avoiding the need to create one manually via GetPhoneNumberSettingsRequest.builder()

      Parameters:
      getPhoneNumberSettingsRequest - A Consumer that will call methods on GetPhoneNumberSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetPhoneNumberSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRetentionSettings

      default CompletableFuture<GetRetentionSettingsResponse> getRetentionSettings(GetRetentionSettingsRequest getRetentionSettingsRequest)

      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:
      A Java Future containing the result of the GetRetentionSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ForbiddenException The client is permanently forbidden from making the request.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRetentionSettings

      default CompletableFuture<GetRetentionSettingsResponse> getRetentionSettings(Consumer<GetRetentionSettingsRequest.Builder> getRetentionSettingsRequest)

      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.Builder avoiding the need to create one manually via GetRetentionSettingsRequest.builder()

      Parameters:
      getRetentionSettingsRequest - A Consumer that will call methods on GetRetentionSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetRetentionSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ForbiddenException The client is permanently forbidden from making the request.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRoom

      default CompletableFuture<GetRoomResponse> getRoom(GetRoomRequest getRoomRequest)

      Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.

      Parameters:
      getRoomRequest -
      Returns:
      A Java Future containing the result of the GetRoom operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ForbiddenException The client is permanently forbidden from making the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRoom

      default CompletableFuture<GetRoomResponse> getRoom(Consumer<GetRoomRequest.Builder> getRoomRequest)

      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.Builder avoiding the need to create one manually via GetRoomRequest.builder()

      Parameters:
      getRoomRequest - A Consumer that will call methods on GetRoomRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetRoom operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ForbiddenException The client is permanently forbidden from making the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getUser

      default CompletableFuture<GetUserResponse> getUser(GetUserRequest getUserRequest)

      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:
      A Java Future containing the result of the GetUser operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getUser

      default CompletableFuture<GetUserResponse> getUser(Consumer<GetUserRequest.Builder> getUserRequest)

      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.Builder avoiding the need to create one manually via GetUserRequest.builder()

      Parameters:
      getUserRequest - A Consumer that will call methods on GetUserRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetUser operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getUserSettings

      default CompletableFuture<GetUserSettingsResponse> getUserSettings(GetUserSettingsRequest getUserSettingsRequest)

      Retrieves settings for the specified user ID, such as any associated phone number settings.

      Parameters:
      getUserSettingsRequest -
      Returns:
      A Java Future containing the result of the GetUserSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getUserSettings

      default CompletableFuture<GetUserSettingsResponse> getUserSettings(Consumer<GetUserSettingsRequest.Builder> getUserSettingsRequest)

      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.Builder avoiding the need to create one manually via GetUserSettingsRequest.builder()

      Parameters:
      getUserSettingsRequest - A Consumer that will call methods on GetUserSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetUserSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • inviteUsers

      default CompletableFuture<InviteUsersResponse> inviteUsers(InviteUsersRequest inviteUsersRequest)

      Sends email to a maximum of 50 users, inviting them to the specified Amazon Chime Team account. Only Team account types are currently supported for this action.

      Parameters:
      inviteUsersRequest -
      Returns:
      A Java Future containing the result of the InviteUsers operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • inviteUsers

      default CompletableFuture<InviteUsersResponse> inviteUsers(Consumer<InviteUsersRequest.Builder> inviteUsersRequest)

      Sends email to a maximum of 50 users, inviting them to the specified Amazon Chime Team account. Only Team account types are currently supported for this action.


      This is a convenience which creates an instance of the InviteUsersRequest.Builder avoiding the need to create one manually via InviteUsersRequest.builder()

      Parameters:
      inviteUsersRequest - A Consumer that will call methods on InviteUsersRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the InviteUsers operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAccounts

      default CompletableFuture<ListAccountsResponse> listAccounts(ListAccountsRequest listAccountsRequest)

      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:
      A Java Future containing the result of the ListAccounts operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAccounts

      default CompletableFuture<ListAccountsResponse> listAccounts(Consumer<ListAccountsRequest.Builder> listAccountsRequest)

      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.Builder avoiding the need to create one manually via ListAccountsRequest.builder()

      Parameters:
      listAccountsRequest - A Consumer that will call methods on ListAccountsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAccounts operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAccounts

      default CompletableFuture<ListAccountsResponse> listAccounts()

      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.

      Returns:
      A Java Future containing the result of the ListAccounts operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAccountsPaginator

      default ListAccountsPublisher listAccountsPaginator()

      This is a variant of listAccounts(software.amazon.awssdk.services.chime.model.ListAccountsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.chime.paginators.ListAccountsPublisher publisher = client.listAccountsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.chime.paginators.ListAccountsPublisher publisher = client.listAccountsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListAccountsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.chime.model.ListAccountsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAccountsPaginator

      default ListAccountsPublisher listAccountsPaginator(ListAccountsRequest listAccountsRequest)

      This is a variant of listAccounts(software.amazon.awssdk.services.chime.model.ListAccountsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.chime.paginators.ListAccountsPublisher publisher = client.listAccountsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.chime.paginators.ListAccountsPublisher publisher = client.listAccountsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListAccountsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.chime.model.ListAccountsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAccountsPaginator

      default ListAccountsPublisher listAccountsPaginator(Consumer<ListAccountsRequest.Builder> listAccountsRequest)

      This is a variant of listAccounts(software.amazon.awssdk.services.chime.model.ListAccountsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.chime.paginators.ListAccountsPublisher publisher = client.listAccountsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.chime.paginators.ListAccountsPublisher publisher = client.listAccountsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListAccountsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.chime.model.ListAccountsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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.Builder avoiding the need to create one manually via ListAccountsRequest.builder()

      Parameters:
      listAccountsRequest - A Consumer that will call methods on ListAccountsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBots

      default CompletableFuture<ListBotsResponse> listBots(ListBotsRequest listBotsRequest)

      Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.

      Parameters:
      listBotsRequest -
      Returns:
      A Java Future containing the result of the ListBots operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • ForbiddenException The client is permanently forbidden from making the request.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ThrottledClientException The client exceeded its request rate limit.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBots

      default CompletableFuture<ListBotsResponse> listBots(Consumer<ListBotsRequest.Builder> listBotsRequest)

      Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.


      This is a convenience which creates an instance of the ListBotsRequest.Builder avoiding the need to create one manually via ListBotsRequest.builder()

      Parameters:
      listBotsRequest - A Consumer that will call methods on ListBotsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListBots operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • ForbiddenException The client is permanently forbidden from making the request.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ThrottledClientException The client exceeded its request rate limit.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBotsPaginator

      default ListBotsPublisher listBotsPaginator(ListBotsRequest listBotsRequest)

      This is a variant of listBots(software.amazon.awssdk.services.chime.model.ListBotsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.chime.paginators.ListBotsPublisher publisher = client.listBotsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.chime.paginators.ListBotsPublisher publisher = client.listBotsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListBotsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.chime.model.ListBotsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • ForbiddenException The client is permanently forbidden from making the request.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ThrottledClientException The client exceeded its request rate limit.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBotsPaginator

      default ListBotsPublisher listBotsPaginator(Consumer<ListBotsRequest.Builder> listBotsRequest)

      This is a variant of listBots(software.amazon.awssdk.services.chime.model.ListBotsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.chime.paginators.ListBotsPublisher publisher = client.listBotsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.chime.paginators.ListBotsPublisher publisher = client.listBotsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListBotsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.chime.model.ListBotsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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.Builder avoiding the need to create one manually via ListBotsRequest.builder()

      Parameters:
      listBotsRequest - A Consumer that will call methods on ListBotsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • ForbiddenException The client is permanently forbidden from making the request.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ThrottledClientException The client exceeded its request rate limit.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPhoneNumberOrders

      default CompletableFuture<ListPhoneNumberOrdersResponse> listPhoneNumberOrders(ListPhoneNumberOrdersRequest listPhoneNumberOrdersRequest)

      Lists the phone number orders for the administrator's Amazon Chime account.

      Parameters:
      listPhoneNumberOrdersRequest -
      Returns:
      A Java Future containing the result of the ListPhoneNumberOrders operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPhoneNumberOrders

      default CompletableFuture<ListPhoneNumberOrdersResponse> listPhoneNumberOrders(Consumer<ListPhoneNumberOrdersRequest.Builder> listPhoneNumberOrdersRequest)

      Lists the phone number orders for the administrator's Amazon Chime account.


      This is a convenience which creates an instance of the ListPhoneNumberOrdersRequest.Builder avoiding the need to create one manually via ListPhoneNumberOrdersRequest.builder()

      Parameters:
      listPhoneNumberOrdersRequest - A Consumer that will call methods on ListPhoneNumberOrdersRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListPhoneNumberOrders operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPhoneNumberOrdersPaginator

      default ListPhoneNumberOrdersPublisher listPhoneNumberOrdersPaginator(ListPhoneNumberOrdersRequest listPhoneNumberOrdersRequest)

      This is a variant of listPhoneNumberOrders(software.amazon.awssdk.services.chime.model.ListPhoneNumberOrdersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.chime.paginators.ListPhoneNumberOrdersPublisher publisher = client.listPhoneNumberOrdersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.chime.paginators.ListPhoneNumberOrdersPublisher publisher = client.listPhoneNumberOrdersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListPhoneNumberOrdersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.chime.model.ListPhoneNumberOrdersResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPhoneNumberOrdersPaginator

      default ListPhoneNumberOrdersPublisher listPhoneNumberOrdersPaginator(Consumer<ListPhoneNumberOrdersRequest.Builder> listPhoneNumberOrdersRequest)

      This is a variant of listPhoneNumberOrders(software.amazon.awssdk.services.chime.model.ListPhoneNumberOrdersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.chime.paginators.ListPhoneNumberOrdersPublisher publisher = client.listPhoneNumberOrdersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.chime.paginators.ListPhoneNumberOrdersPublisher publisher = client.listPhoneNumberOrdersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListPhoneNumberOrdersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.chime.model.ListPhoneNumberOrdersResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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.Builder avoiding the need to create one manually via ListPhoneNumberOrdersRequest.builder()

      Parameters:
      listPhoneNumberOrdersRequest - A Consumer that will call methods on ListPhoneNumberOrdersRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPhoneNumbers

      default CompletableFuture<ListPhoneNumbersResponse> listPhoneNumbers(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.

      Parameters:
      listPhoneNumbersRequest -
      Returns:
      A Java Future containing the result of the ListPhoneNumbers operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPhoneNumbers

      default CompletableFuture<ListPhoneNumbersResponse> listPhoneNumbers(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.


      This is a convenience which creates an instance of the ListPhoneNumbersRequest.Builder avoiding the need to create one manually via ListPhoneNumbersRequest.builder()

      Parameters:
      listPhoneNumbersRequest - A Consumer that will call methods on ListPhoneNumbersRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListPhoneNumbers operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPhoneNumbersPaginator

      default ListPhoneNumbersPublisher listPhoneNumbersPaginator(ListPhoneNumbersRequest listPhoneNumbersRequest)

      This is a variant of listPhoneNumbers(software.amazon.awssdk.services.chime.model.ListPhoneNumbersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.chime.paginators.ListPhoneNumbersPublisher publisher = client.listPhoneNumbersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.chime.paginators.ListPhoneNumbersPublisher publisher = client.listPhoneNumbersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListPhoneNumbersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.chime.model.ListPhoneNumbersResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPhoneNumbersPaginator

      default ListPhoneNumbersPublisher listPhoneNumbersPaginator(Consumer<ListPhoneNumbersRequest.Builder> listPhoneNumbersRequest)

      This is a variant of listPhoneNumbers(software.amazon.awssdk.services.chime.model.ListPhoneNumbersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.chime.paginators.ListPhoneNumbersPublisher publisher = client.listPhoneNumbersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.chime.paginators.ListPhoneNumbersPublisher publisher = client.listPhoneNumbersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListPhoneNumbersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.chime.model.ListPhoneNumbersResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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.Builder avoiding the need to create one manually via ListPhoneNumbersRequest.builder()

      Parameters:
      listPhoneNumbersRequest - A Consumer that will call methods on ListPhoneNumbersRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRoomMemberships

      default CompletableFuture<ListRoomMembershipsResponse> listRoomMemberships(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.

      Parameters:
      listRoomMembershipsRequest -
      Returns:
      A Java Future containing the result of the ListRoomMemberships operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ForbiddenException The client is permanently forbidden from making the request.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRoomMemberships

      default CompletableFuture<ListRoomMembershipsResponse> listRoomMemberships(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.


      This is a convenience which creates an instance of the ListRoomMembershipsRequest.Builder avoiding the need to create one manually via ListRoomMembershipsRequest.builder()

      Parameters:
      listRoomMembershipsRequest - A Consumer that will call methods on ListRoomMembershipsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListRoomMemberships operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ForbiddenException The client is permanently forbidden from making the request.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRoomMembershipsPaginator

      default ListRoomMembershipsPublisher listRoomMembershipsPaginator(ListRoomMembershipsRequest listRoomMembershipsRequest)

      This is a variant of listRoomMemberships(software.amazon.awssdk.services.chime.model.ListRoomMembershipsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.chime.paginators.ListRoomMembershipsPublisher publisher = client.listRoomMembershipsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.chime.paginators.ListRoomMembershipsPublisher publisher = client.listRoomMembershipsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListRoomMembershipsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.chime.model.ListRoomMembershipsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ForbiddenException The client is permanently forbidden from making the request.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRoomMembershipsPaginator

      default ListRoomMembershipsPublisher listRoomMembershipsPaginator(Consumer<ListRoomMembershipsRequest.Builder> listRoomMembershipsRequest)

      This is a variant of listRoomMemberships(software.amazon.awssdk.services.chime.model.ListRoomMembershipsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.chime.paginators.ListRoomMembershipsPublisher publisher = client.listRoomMembershipsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.chime.paginators.ListRoomMembershipsPublisher publisher = client.listRoomMembershipsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListRoomMembershipsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.chime.model.ListRoomMembershipsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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.Builder avoiding the need to create one manually via ListRoomMembershipsRequest.builder()

      Parameters:
      listRoomMembershipsRequest - A Consumer that will call methods on ListRoomMembershipsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ForbiddenException The client is permanently forbidden from making the request.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRooms

      default CompletableFuture<ListRoomsResponse> listRooms(ListRoomsRequest listRoomsRequest)

      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:
      A Java Future containing the result of the ListRooms operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ForbiddenException The client is permanently forbidden from making the request.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRooms

      default CompletableFuture<ListRoomsResponse> listRooms(Consumer<ListRoomsRequest.Builder> listRoomsRequest)

      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.Builder avoiding the need to create one manually via ListRoomsRequest.builder()

      Parameters:
      listRoomsRequest - A Consumer that will call methods on ListRoomsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListRooms operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ForbiddenException The client is permanently forbidden from making the request.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRoomsPaginator

      default ListRoomsPublisher listRoomsPaginator(ListRoomsRequest listRoomsRequest)

      This is a variant of listRooms(software.amazon.awssdk.services.chime.model.ListRoomsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.chime.paginators.ListRoomsPublisher publisher = client.listRoomsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.chime.paginators.ListRoomsPublisher publisher = client.listRoomsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListRoomsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.chime.model.ListRoomsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ForbiddenException The client is permanently forbidden from making the request.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRoomsPaginator

      default ListRoomsPublisher listRoomsPaginator(Consumer<ListRoomsRequest.Builder> listRoomsRequest)

      This is a variant of listRooms(software.amazon.awssdk.services.chime.model.ListRoomsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.chime.paginators.ListRoomsPublisher publisher = client.listRoomsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.chime.paginators.ListRoomsPublisher publisher = client.listRoomsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListRoomsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.chime.model.ListRoomsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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.Builder avoiding the need to create one manually via ListRoomsRequest.builder()

      Parameters:
      listRoomsRequest - A Consumer that will call methods on ListRoomsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ForbiddenException The client is permanently forbidden from making the request.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSupportedPhoneNumberCountries

      default CompletableFuture<ListSupportedPhoneNumberCountriesResponse> listSupportedPhoneNumberCountries(ListSupportedPhoneNumberCountriesRequest listSupportedPhoneNumberCountriesRequest)

      Lists supported phone number countries.

      Parameters:
      listSupportedPhoneNumberCountriesRequest -
      Returns:
      A Java Future containing the result of the ListSupportedPhoneNumberCountries operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ForbiddenException The client is permanently forbidden from making the request.
      • AccessDeniedException You don't have permissions to perform the requested operation.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSupportedPhoneNumberCountries

      default CompletableFuture<ListSupportedPhoneNumberCountriesResponse> listSupportedPhoneNumberCountries(Consumer<ListSupportedPhoneNumberCountriesRequest.Builder> listSupportedPhoneNumberCountriesRequest)

      Lists supported phone number countries.


      This is a convenience which creates an instance of the ListSupportedPhoneNumberCountriesRequest.Builder avoiding the need to create one manually via ListSupportedPhoneNumberCountriesRequest.builder()

      Parameters:
      listSupportedPhoneNumberCountriesRequest - A Consumer that will call methods on ListSupportedPhoneNumberCountriesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListSupportedPhoneNumberCountries operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ForbiddenException The client is permanently forbidden from making the request.
      • AccessDeniedException You don't have permissions to perform the requested operation.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listUsers

      default CompletableFuture<ListUsersResponse> listUsers(ListUsersRequest listUsersRequest)

      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:
      A Java Future containing the result of the ListUsers operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listUsers

      default CompletableFuture<ListUsersResponse> listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest)

      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.Builder avoiding the need to create one manually via ListUsersRequest.builder()

      Parameters:
      listUsersRequest - A Consumer that will call methods on ListUsersRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListUsers operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listUsersPaginator

      default ListUsersPublisher listUsersPaginator(ListUsersRequest listUsersRequest)

      This is a variant of listUsers(software.amazon.awssdk.services.chime.model.ListUsersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.chime.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.chime.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListUsersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.chime.model.ListUsersResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listUsersPaginator

      default ListUsersPublisher listUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest)

      This is a variant of listUsers(software.amazon.awssdk.services.chime.model.ListUsersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.chime.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.chime.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListUsersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.chime.model.ListUsersResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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.Builder avoiding the need to create one manually via ListUsersRequest.builder()

      Parameters:
      listUsersRequest - A Consumer that will call methods on ListUsersRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • logoutUser

      default CompletableFuture<LogoutUserResponse> logoutUser(LogoutUserRequest logoutUserRequest)

      Logs out the specified user from all of the devices they are currently logged into.

      Parameters:
      logoutUserRequest -
      Returns:
      A Java Future containing the result of the LogoutUser operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • logoutUser

      default CompletableFuture<LogoutUserResponse> logoutUser(Consumer<LogoutUserRequest.Builder> logoutUserRequest)

      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.Builder avoiding the need to create one manually via LogoutUserRequest.builder()

      Parameters:
      logoutUserRequest - A Consumer that will call methods on LogoutUserRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the LogoutUser operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putEventsConfiguration

      default CompletableFuture<PutEventsConfigurationResponse> putEventsConfiguration(PutEventsConfigurationRequest putEventsConfigurationRequest)

      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:
      A Java Future containing the result of the PutEventsConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • ResourceLimitExceededException The request exceeds the resource limit.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putEventsConfiguration

      default CompletableFuture<PutEventsConfigurationResponse> putEventsConfiguration(Consumer<PutEventsConfigurationRequest.Builder> putEventsConfigurationRequest)

      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.Builder avoiding the need to create one manually via PutEventsConfigurationRequest.builder()

      Parameters:
      putEventsConfigurationRequest - A Consumer that will call methods on PutEventsConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutEventsConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • ResourceLimitExceededException The request exceeds the resource limit.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putRetentionSettings

      default CompletableFuture<PutRetentionSettingsResponse> putRetentionSettings(PutRetentionSettingsRequest putRetentionSettingsRequest)

      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:
      A Java Future containing the result of the PutRetentionSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ForbiddenException The client is permanently forbidden from making the request.
      • ConflictException The request could not be processed because of conflict in the current state of the resource.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putRetentionSettings

      default CompletableFuture<PutRetentionSettingsResponse> putRetentionSettings(Consumer<PutRetentionSettingsRequest.Builder> putRetentionSettingsRequest)

      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.Builder avoiding the need to create one manually via PutRetentionSettingsRequest.builder()

      Parameters:
      putRetentionSettingsRequest - A Consumer that will call methods on PutRetentionSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutRetentionSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ForbiddenException The client is permanently forbidden from making the request.
      • ConflictException The request could not be processed because of conflict in the current state of the resource.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • redactConversationMessage

      default CompletableFuture<RedactConversationMessageResponse> redactConversationMessage(RedactConversationMessageRequest redactConversationMessageRequest)

      Redacts the specified message from the specified Amazon Chime conversation.

      Parameters:
      redactConversationMessageRequest -
      Returns:
      A Java Future containing the result of the RedactConversationMessage operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • ThrottledClientException The client exceeded its request rate limit.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • redactConversationMessage

      default CompletableFuture<RedactConversationMessageResponse> redactConversationMessage(Consumer<RedactConversationMessageRequest.Builder> redactConversationMessageRequest)

      Redacts the specified message from the specified Amazon Chime conversation.


      This is a convenience which creates an instance of the RedactConversationMessageRequest.Builder avoiding the need to create one manually via RedactConversationMessageRequest.builder()

      Parameters:
      redactConversationMessageRequest - A Consumer that will call methods on RedactConversationMessageRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RedactConversationMessage operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • ThrottledClientException The client exceeded its request rate limit.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • redactRoomMessage

      default CompletableFuture<RedactRoomMessageResponse> redactRoomMessage(RedactRoomMessageRequest redactRoomMessageRequest)

      Redacts the specified message from the specified Amazon Chime channel.

      Parameters:
      redactRoomMessageRequest -
      Returns:
      A Java Future containing the result of the RedactRoomMessage operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • ThrottledClientException The client exceeded its request rate limit.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • redactRoomMessage

      default CompletableFuture<RedactRoomMessageResponse> redactRoomMessage(Consumer<RedactRoomMessageRequest.Builder> redactRoomMessageRequest)

      Redacts the specified message from the specified Amazon Chime channel.


      This is a convenience which creates an instance of the RedactRoomMessageRequest.Builder avoiding the need to create one manually via RedactRoomMessageRequest.builder()

      Parameters:
      redactRoomMessageRequest - A Consumer that will call methods on RedactRoomMessageRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RedactRoomMessage operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • ThrottledClientException The client exceeded its request rate limit.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • regenerateSecurityToken

      default CompletableFuture<RegenerateSecurityTokenResponse> regenerateSecurityToken(RegenerateSecurityTokenRequest regenerateSecurityTokenRequest)

      Regenerates the security token for a bot.

      Parameters:
      regenerateSecurityTokenRequest -
      Returns:
      A Java Future containing the result of the RegenerateSecurityToken operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ThrottledClientException The client exceeded its request rate limit.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • regenerateSecurityToken

      default CompletableFuture<RegenerateSecurityTokenResponse> regenerateSecurityToken(Consumer<RegenerateSecurityTokenRequest.Builder> regenerateSecurityTokenRequest)

      Regenerates the security token for a bot.


      This is a convenience which creates an instance of the RegenerateSecurityTokenRequest.Builder avoiding the need to create one manually via RegenerateSecurityTokenRequest.builder()

      Parameters:
      regenerateSecurityTokenRequest - A Consumer that will call methods on RegenerateSecurityTokenRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RegenerateSecurityToken operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ThrottledClientException The client exceeded its request rate limit.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • resetPersonalPIN

      default CompletableFuture<ResetPersonalPinResponse> resetPersonalPIN(ResetPersonalPinRequest resetPersonalPinRequest)

      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:
      A Java Future containing the result of the ResetPersonalPIN operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • resetPersonalPIN

      default CompletableFuture<ResetPersonalPinResponse> resetPersonalPIN(Consumer<ResetPersonalPinRequest.Builder> resetPersonalPinRequest)

      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.Builder avoiding the need to create one manually via ResetPersonalPinRequest.builder()

      Parameters:
      resetPersonalPinRequest - A Consumer that will call methods on ResetPersonalPinRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ResetPersonalPIN operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • restorePhoneNumber

      default CompletableFuture<RestorePhoneNumberResponse> restorePhoneNumber(RestorePhoneNumberRequest restorePhoneNumberRequest)

      Moves a phone number from the Deletion queue back into the phone number Inventory.

      Parameters:
      restorePhoneNumberRequest -
      Returns:
      A Java Future containing the result of the RestorePhoneNumber operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ResourceLimitExceededException The request exceeds the resource limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • restorePhoneNumber

      default CompletableFuture<RestorePhoneNumberResponse> restorePhoneNumber(Consumer<RestorePhoneNumberRequest.Builder> restorePhoneNumberRequest)

      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.Builder avoiding the need to create one manually via RestorePhoneNumberRequest.builder()

      Parameters:
      restorePhoneNumberRequest - A Consumer that will call methods on RestorePhoneNumberRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RestorePhoneNumber operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ResourceLimitExceededException The request exceeds the resource limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchAvailablePhoneNumbers

      default CompletableFuture<SearchAvailablePhoneNumbersResponse> searchAvailablePhoneNumbers(SearchAvailablePhoneNumbersRequest searchAvailablePhoneNumbersRequest)

      Searches for phone numbers that can be ordered. For US numbers, provide at least one of the following search filters: AreaCode, City, State, or TollFreePrefix. If you provide City, you must also provide State. Numbers outside the US only support the PhoneNumberType filter, which you must use.

      Parameters:
      searchAvailablePhoneNumbersRequest -
      Returns:
      A Java Future containing the result of the SearchAvailablePhoneNumbers operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ForbiddenException The client is permanently forbidden from making the request.
      • AccessDeniedException You don't have permissions to perform the requested operation.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchAvailablePhoneNumbers

      default CompletableFuture<SearchAvailablePhoneNumbersResponse> searchAvailablePhoneNumbers(Consumer<SearchAvailablePhoneNumbersRequest.Builder> searchAvailablePhoneNumbersRequest)

      Searches for phone numbers that can be ordered. For US numbers, provide at least one of the following search filters: AreaCode, City, State, or TollFreePrefix. If you provide City, you must also provide State. Numbers outside the US only support the PhoneNumberType filter, which you must use.


      This is a convenience which creates an instance of the SearchAvailablePhoneNumbersRequest.Builder avoiding the need to create one manually via SearchAvailablePhoneNumbersRequest.builder()

      Parameters:
      searchAvailablePhoneNumbersRequest - A Consumer that will call methods on SearchAvailablePhoneNumbersRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SearchAvailablePhoneNumbers operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ForbiddenException The client is permanently forbidden from making the request.
      • AccessDeniedException You don't have permissions to perform the requested operation.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchAvailablePhoneNumbersPaginator

      default SearchAvailablePhoneNumbersPublisher searchAvailablePhoneNumbersPaginator(SearchAvailablePhoneNumbersRequest searchAvailablePhoneNumbersRequest)

      This is a variant of searchAvailablePhoneNumbers(software.amazon.awssdk.services.chime.model.SearchAvailablePhoneNumbersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.chime.paginators.SearchAvailablePhoneNumbersPublisher publisher = client.searchAvailablePhoneNumbersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.chime.paginators.SearchAvailablePhoneNumbersPublisher publisher = client.searchAvailablePhoneNumbersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.SearchAvailablePhoneNumbersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.chime.model.SearchAvailablePhoneNumbersResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ForbiddenException The client is permanently forbidden from making the request.
      • AccessDeniedException You don't have permissions to perform the requested operation.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchAvailablePhoneNumbersPaginator

      default SearchAvailablePhoneNumbersPublisher searchAvailablePhoneNumbersPaginator(Consumer<SearchAvailablePhoneNumbersRequest.Builder> searchAvailablePhoneNumbersRequest)

      This is a variant of searchAvailablePhoneNumbers(software.amazon.awssdk.services.chime.model.SearchAvailablePhoneNumbersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.chime.paginators.SearchAvailablePhoneNumbersPublisher publisher = client.searchAvailablePhoneNumbersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.chime.paginators.SearchAvailablePhoneNumbersPublisher publisher = client.searchAvailablePhoneNumbersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.SearchAvailablePhoneNumbersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.chime.model.SearchAvailablePhoneNumbersResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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.Builder avoiding the need to create one manually via SearchAvailablePhoneNumbersRequest.builder()

      Parameters:
      searchAvailablePhoneNumbersRequest - A Consumer that will call methods on SearchAvailablePhoneNumbersRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ForbiddenException The client is permanently forbidden from making the request.
      • AccessDeniedException You don't have permissions to perform the requested operation.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAccount

      default CompletableFuture<UpdateAccountResponse> updateAccount(UpdateAccountRequest updateAccountRequest)

      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:
      A Java Future containing the result of the UpdateAccount operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAccount

      default CompletableFuture<UpdateAccountResponse> updateAccount(Consumer<UpdateAccountRequest.Builder> updateAccountRequest)

      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.Builder avoiding the need to create one manually via UpdateAccountRequest.builder()

      Parameters:
      updateAccountRequest - A Consumer that will call methods on UpdateAccountRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateAccount operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAccountSettings

      default CompletableFuture<UpdateAccountSettingsResponse> updateAccountSettings(UpdateAccountSettingsRequest updateAccountSettingsRequest)

      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:
      A Java Future containing the result of the UpdateAccountSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ForbiddenException The client is permanently forbidden from making the request.
      • ConflictException The request could not be processed because of conflict in the current state of the resource.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAccountSettings

      default CompletableFuture<UpdateAccountSettingsResponse> updateAccountSettings(Consumer<UpdateAccountSettingsRequest.Builder> updateAccountSettingsRequest)

      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.Builder avoiding the need to create one manually via UpdateAccountSettingsRequest.builder()

      Parameters:
      updateAccountSettingsRequest - A Consumer that will call methods on UpdateAccountSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateAccountSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ForbiddenException The client is permanently forbidden from making the request.
      • ConflictException The request could not be processed because of conflict in the current state of the resource.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateBot

      default CompletableFuture<UpdateBotResponse> updateBot(UpdateBotRequest updateBotRequest)

      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:
      A Java Future containing the result of the UpdateBot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ThrottledClientException The client exceeded its request rate limit.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateBot

      default CompletableFuture<UpdateBotResponse> updateBot(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.


      This is a convenience which creates an instance of the UpdateBotRequest.Builder avoiding the need to create one manually via UpdateBotRequest.builder()

      Parameters:
      updateBotRequest - A Consumer that will call methods on UpdateBotRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateBot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ThrottledClientException The client exceeded its request rate limit.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateGlobalSettings

      default CompletableFuture<UpdateGlobalSettingsResponse> updateGlobalSettings(UpdateGlobalSettingsRequest updateGlobalSettingsRequest)

      Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.

      Parameters:
      updateGlobalSettingsRequest -
      Returns:
      A Java Future containing the result of the UpdateGlobalSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateGlobalSettings

      default CompletableFuture<UpdateGlobalSettingsResponse> updateGlobalSettings(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.


      This is a convenience which creates an instance of the UpdateGlobalSettingsRequest.Builder avoiding the need to create one manually via UpdateGlobalSettingsRequest.builder()

      Parameters:
      updateGlobalSettingsRequest - A Consumer that will call methods on UpdateGlobalSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateGlobalSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updatePhoneNumber

      default CompletableFuture<UpdatePhoneNumberResponse> updatePhoneNumber(UpdatePhoneNumberRequest updatePhoneNumberRequest)

      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:
      A Java Future containing the result of the UpdatePhoneNumber operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ConflictException The request could not be processed because of conflict in the current state of the resource.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updatePhoneNumber

      default CompletableFuture<UpdatePhoneNumberResponse> updatePhoneNumber(Consumer<UpdatePhoneNumberRequest.Builder> updatePhoneNumberRequest)

      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.Builder avoiding the need to create one manually via UpdatePhoneNumberRequest.builder()

      Parameters:
      updatePhoneNumberRequest - A Consumer that will call methods on UpdatePhoneNumberRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdatePhoneNumber operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ConflictException The request could not be processed because of conflict in the current state of the resource.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updatePhoneNumberSettings

      default CompletableFuture<UpdatePhoneNumberSettingsResponse> updatePhoneNumberSettings(UpdatePhoneNumberSettingsRequest updatePhoneNumberSettingsRequest)

      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:
      A Java Future containing the result of the UpdatePhoneNumberSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updatePhoneNumberSettings

      default CompletableFuture<UpdatePhoneNumberSettingsResponse> updatePhoneNumberSettings(Consumer<UpdatePhoneNumberSettingsRequest.Builder> updatePhoneNumberSettingsRequest)

      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.Builder avoiding the need to create one manually via UpdatePhoneNumberSettingsRequest.builder()

      Parameters:
      updatePhoneNumberSettingsRequest - A Consumer that will call methods on UpdatePhoneNumberSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdatePhoneNumberSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateRoom

      default CompletableFuture<UpdateRoomResponse> updateRoom(UpdateRoomRequest updateRoomRequest)

      Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account.

      Parameters:
      updateRoomRequest -
      Returns:
      A Java Future containing the result of the UpdateRoom operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ForbiddenException The client is permanently forbidden from making the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateRoom

      default CompletableFuture<UpdateRoomResponse> updateRoom(Consumer<UpdateRoomRequest.Builder> updateRoomRequest)

      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.Builder avoiding the need to create one manually via UpdateRoomRequest.builder()

      Parameters:
      updateRoomRequest - A Consumer that will call methods on UpdateRoomRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateRoom operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ForbiddenException The client is permanently forbidden from making the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateRoomMembership

      default CompletableFuture<UpdateRoomMembershipResponse> updateRoomMembership(UpdateRoomMembershipRequest updateRoomMembershipRequest)

      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:
      A Java Future containing the result of the UpdateRoomMembership operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ForbiddenException The client is permanently forbidden from making the request.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateRoomMembership

      default CompletableFuture<UpdateRoomMembershipResponse> updateRoomMembership(Consumer<UpdateRoomMembershipRequest.Builder> updateRoomMembershipRequest)

      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.Builder avoiding the need to create one manually via UpdateRoomMembershipRequest.builder()

      Parameters:
      updateRoomMembershipRequest - A Consumer that will call methods on UpdateRoomMembershipRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateRoomMembership operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ForbiddenException The client is permanently forbidden from making the request.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateUser

      default CompletableFuture<UpdateUserResponse> updateUser(UpdateUserRequest updateUserRequest)

      Updates user details for a specified user ID. Currently, only LicenseType updates are supported for this action.

      Parameters:
      updateUserRequest -
      Returns:
      A Java Future containing the result of the UpdateUser operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateUser

      default CompletableFuture<UpdateUserResponse> updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest)

      Updates user details for a specified user ID. Currently, only LicenseType updates are supported for this action.


      This is a convenience which creates an instance of the UpdateUserRequest.Builder avoiding the need to create one manually via UpdateUserRequest.builder()

      Parameters:
      updateUserRequest - A Consumer that will call methods on UpdateUserRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateUser operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateUserSettings

      default CompletableFuture<UpdateUserSettingsResponse> updateUserSettings(UpdateUserSettingsRequest updateUserSettingsRequest)

      Updates the settings for the specified user, such as phone number settings.

      Parameters:
      updateUserSettingsRequest -
      Returns:
      A Java Future containing the result of the UpdateUserSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateUserSettings

      default CompletableFuture<UpdateUserSettingsResponse> updateUserSettings(Consumer<UpdateUserSettingsRequest.Builder> updateUserSettingsRequest)

      Updates the settings for the specified user, such as phone number settings.


      This is a convenience which creates an instance of the UpdateUserSettingsRequest.Builder avoiding the need to create one manually via UpdateUserSettingsRequest.builder()

      Parameters:
      updateUserSettingsRequest - A Consumer that will call methods on UpdateUserSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateUserSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnauthorizedClientException The client is not currently authorized to make the request.
      • NotFoundException One or more of the resources in the request does not exist in the system.
      • ForbiddenException The client is permanently forbidden from making the request.
      • BadRequestException The input parameters don't match the service's restrictions.
      • ThrottledClientException The client exceeded its request rate limit.
      • ServiceUnavailableException The service is currently unavailable.
      • ServiceFailureException The service encountered an unexpected error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ChimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default ChimeServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • create

      static ChimeAsyncClient create()
      Create a ChimeAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static ChimeAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a ChimeAsyncClient.