@Generated(value="software.amazon.awssdk:codegen") public interface ChimeAsyncClient extends SdkClient
builder()
method.
The Amazon Chime API (application programming interface) is designed for administrators to use to perform key tasks, such as creating and managing Amazon Chime accounts and users. 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. We recommend using an AWS SDK or the AWS CLI. Each API operation includes links to information about using it with a language-specific AWS SDK or the AWS CLI.
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.
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.
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 Control Access to the Amazon Chime Console in the Amazon Chime Administration Guide.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
default CompletableFuture<BatchSuspendUserResponse> |
batchSuspendUser(BatchSuspendUserRequest batchSuspendUserRequest)
Suspends up to 50 users from a
Team or EnterpriseLWA Amazon Chime account. |
default CompletableFuture<BatchSuspendUserResponse> |
batchSuspendUser(Consumer<BatchSuspendUserRequest.Builder> batchSuspendUserRequest)
Suspends up to 50 users from a
Team or EnterpriseLWA Amazon Chime account. |
default CompletableFuture<BatchUnsuspendUserResponse> |
batchUnsuspendUser(BatchUnsuspendUserRequest batchUnsuspendUserRequest)
Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime
EnterpriseLWA account. |
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. |
default CompletableFuture<BatchUpdateUserResponse> |
batchUpdateUser(BatchUpdateUserRequest batchUpdateUserRequest)
Updates user details within the UpdateUserRequestItem object for up to 20 users for the specified Amazon
Chime account.
|
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.
|
static ChimeAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
ChimeAsyncClient . |
static ChimeAsyncClient |
create()
Create a
ChimeAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CompletableFuture<CreateAccountResponse> |
createAccount(Consumer<CreateAccountRequest.Builder> createAccountRequest)
Creates an Amazon Chime account under the administrator's AWS account.
|
default CompletableFuture<CreateAccountResponse> |
createAccount(CreateAccountRequest createAccountRequest)
Creates an Amazon Chime account under the administrator's AWS account.
|
default CompletableFuture<DeleteAccountResponse> |
deleteAccount(Consumer<DeleteAccountRequest.Builder> deleteAccountRequest)
Deletes the specified Amazon Chime account.
|
default CompletableFuture<DeleteAccountResponse> |
deleteAccount(DeleteAccountRequest deleteAccountRequest)
Deletes the specified Amazon Chime account.
|
default CompletableFuture<GetAccountResponse> |
getAccount(Consumer<GetAccountRequest.Builder> getAccountRequest)
Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.
|
default CompletableFuture<GetAccountResponse> |
getAccount(GetAccountRequest getAccountRequest)
Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.
|
default CompletableFuture<GetAccountSettingsResponse> |
getAccountSettings(Consumer<GetAccountSettingsRequest.Builder> getAccountSettingsRequest)
Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dial out
settings.
|
default CompletableFuture<GetAccountSettingsResponse> |
getAccountSettings(GetAccountSettingsRequest getAccountSettingsRequest)
Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dial out
settings.
|
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.
|
default CompletableFuture<GetUserResponse> |
getUser(GetUserRequest getUserRequest)
Retrieves details for the specified user ID, such as primary email address, license type, and personal meeting
PIN.
|
default CompletableFuture<InviteUsersResponse> |
inviteUsers(Consumer<InviteUsersRequest.Builder> inviteUsersRequest)
Sends email invites to as many as 50 users, inviting them to the specified Amazon Chime
Team
account. |
default CompletableFuture<InviteUsersResponse> |
inviteUsers(InviteUsersRequest inviteUsersRequest)
Sends email invites to as many as 50 users, inviting them to the specified Amazon Chime
Team
account. |
default CompletableFuture<ListAccountsResponse> |
listAccounts()
Lists the Amazon Chime accounts under the administrator's AWS account.
|
default CompletableFuture<ListAccountsResponse> |
listAccounts(Consumer<ListAccountsRequest.Builder> listAccountsRequest)
Lists the Amazon Chime accounts under the administrator's AWS account.
|
default CompletableFuture<ListAccountsResponse> |
listAccounts(ListAccountsRequest listAccountsRequest)
Lists the Amazon Chime accounts under the administrator's AWS account.
|
default ListAccountsPublisher |
listAccountsPaginator()
Lists the Amazon Chime accounts under the administrator's AWS account.
|
default ListAccountsPublisher |
listAccountsPaginator(Consumer<ListAccountsRequest.Builder> listAccountsRequest)
Lists the Amazon Chime accounts under the administrator's AWS account.
|
default ListAccountsPublisher |
listAccountsPaginator(ListAccountsRequest listAccountsRequest)
Lists the Amazon Chime accounts under the administrator's AWS account.
|
default CompletableFuture<ListUsersResponse> |
listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest)
Lists the users that belong to the specified Amazon Chime account.
|
default CompletableFuture<ListUsersResponse> |
listUsers(ListUsersRequest listUsersRequest)
Lists the users that belong to the specified Amazon Chime account.
|
default ListUsersPublisher |
listUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest)
Lists the users that belong to the specified Amazon Chime account.
|
default ListUsersPublisher |
listUsersPaginator(ListUsersRequest listUsersRequest)
Lists the users that belong to the specified Amazon Chime account.
|
default CompletableFuture<LogoutUserResponse> |
logoutUser(Consumer<LogoutUserRequest.Builder> logoutUserRequest)
Logs out the specified user from all of the devices they are currently logged into.
|
default CompletableFuture<LogoutUserResponse> |
logoutUser(LogoutUserRequest logoutUserRequest)
Logs out the specified user from all of the devices they are currently logged into.
|
default CompletableFuture<ResetPersonalPinResponse> |
resetPersonalPIN(Consumer<ResetPersonalPinRequest.Builder> resetPersonalPinRequest)
Resets the personal meeting PIN for the specified user on an Amazon Chime account.
|
default CompletableFuture<ResetPersonalPinResponse> |
resetPersonalPIN(ResetPersonalPinRequest resetPersonalPinRequest)
Resets the personal meeting PIN for the specified user on an Amazon Chime account.
|
default CompletableFuture<UpdateAccountResponse> |
updateAccount(Consumer<UpdateAccountRequest.Builder> updateAccountRequest)
Updates account details for the specified Amazon Chime account.
|
default CompletableFuture<UpdateAccountResponse> |
updateAccount(UpdateAccountRequest updateAccountRequest)
Updates account details for the specified Amazon Chime account.
|
default CompletableFuture<UpdateAccountSettingsResponse> |
updateAccountSettings(Consumer<UpdateAccountSettingsRequest.Builder> updateAccountSettingsRequest)
Updates the settings for the specified Amazon Chime account.
|
default CompletableFuture<UpdateAccountSettingsResponse> |
updateAccountSettings(UpdateAccountSettingsRequest updateAccountSettingsRequest)
Updates the settings for the specified Amazon Chime account.
|
default CompletableFuture<UpdateUserResponse> |
updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest)
Updates user details for a specified user ID.
|
default CompletableFuture<UpdateUserResponse> |
updateUser(UpdateUserRequest updateUserRequest)
Updates user details for a specified user ID.
|
serviceName
close
static final String SERVICE_NAME
static ChimeAsyncClient create()
ChimeAsyncClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static ChimeAsyncClientBuilder builder()
ChimeAsyncClient
.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 dissociated 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 are no
longer able to 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.
batchSuspendUserRequest
- 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 dissociated 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 are no
longer able to 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()
batchSuspendUserRequest
- A Consumer
that will call methods on BatchSuspendUserRequest.Builder
to create a request.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 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.
batchUnsuspendUserRequest
- 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 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()
batchUnsuspendUserRequest
- A Consumer
that will call methods on BatchUnsuspendUserRequest.Builder
to create a
request.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.
batchUpdateUserRequest
- 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()
batchUpdateUserRequest
- A Consumer
that will call methods on BatchUpdateUserRequest.Builder
to create a request.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.
createAccountRequest
- 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()
createAccountRequest
- A Consumer
that will call methods on CreateAccountRequest.Builder
to create a request.default CompletableFuture<DeleteAccountResponse> deleteAccount(DeleteAccountRequest deleteAccountRequest)
Deletes the specified Amazon Chime account. You must suspend all users before deleting a Team
account. You can use the BatchSuspendUser action to do so.
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 a 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.
deleteAccountRequest
- default CompletableFuture<DeleteAccountResponse> deleteAccount(Consumer<DeleteAccountRequest.Builder> deleteAccountRequest)
Deletes the specified Amazon Chime account. You must suspend all users before deleting a Team
account. You can use the BatchSuspendUser action to do so.
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 a 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()
deleteAccountRequest
- A Consumer
that will call methods on DeleteAccountRequest.Builder
to create a request.default CompletableFuture<GetAccountResponse> getAccount(GetAccountRequest getAccountRequest)
Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.
getAccountRequest
- 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()
getAccountRequest
- A Consumer
that will call methods on GetAccountRequest.Builder
to create a request.default CompletableFuture<GetAccountSettingsResponse> getAccountSettings(GetAccountSettingsRequest getAccountSettingsRequest)
Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dial out settings. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.
getAccountSettingsRequest
- default CompletableFuture<GetAccountSettingsResponse> getAccountSettings(Consumer<GetAccountSettingsRequest.Builder> getAccountSettingsRequest)
Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dial out 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()
getAccountSettingsRequest
- A Consumer
that will call methods on GetAccountSettingsRequest.Builder
to create a
request.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.
getUserRequest
- 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()
getUserRequest
- A Consumer
that will call methods on GetUserRequest.Builder
to create a request.default CompletableFuture<InviteUsersResponse> inviteUsers(InviteUsersRequest inviteUsersRequest)
Sends email invites to as many as 50 users, inviting them to the specified Amazon Chime Team
account. Only Team
account types are currently supported for this action.
inviteUsersRequest
- default CompletableFuture<InviteUsersResponse> inviteUsers(Consumer<InviteUsersRequest.Builder> inviteUsersRequest)
Sends email invites to as many as 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()
inviteUsersRequest
- A Consumer
that will call methods on InviteUsersRequest.Builder
to create a request.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.
listAccountsRequest
- 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()
listAccountsRequest
- A Consumer
that will call methods on ListAccountsRequest.Builder
to create a request.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.
default ListAccountsPublisher listAccountsPaginator()
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 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.
Note: If you prefer to have control on service calls, use the
listAccounts(software.amazon.awssdk.services.chime.model.ListAccountsRequest)
operation.
default ListAccountsPublisher listAccountsPaginator(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.
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.
Note: If you prefer to have control on service calls, use the
listAccounts(software.amazon.awssdk.services.chime.model.ListAccountsRequest)
operation.
listAccountsRequest
- default ListAccountsPublisher listAccountsPaginator(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 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.
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()
listAccountsRequest
- A Consumer
that will call methods on ListAccountsRequest.Builder
to create a request.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.
listUsersRequest
- 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()
listUsersRequest
- A Consumer
that will call methods on ListUsersRequest.Builder
to create a request.default ListUsersPublisher listUsersPaginator(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.
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.
Note: If you prefer to have control on service calls, use the
listUsers(software.amazon.awssdk.services.chime.model.ListUsersRequest)
operation.
listUsersRequest
- default ListUsersPublisher listUsersPaginator(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 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.
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()
listUsersRequest
- A Consumer
that will call methods on ListUsersRequest.Builder
to create a request.default CompletableFuture<LogoutUserResponse> logoutUser(LogoutUserRequest logoutUserRequest)
Logs out the specified user from all of the devices they are currently logged into.
logoutUserRequest
- 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()
logoutUserRequest
- A Consumer
that will call methods on LogoutUserRequest.Builder
to create a request.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.
resetPersonalPinRequest
- 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()
resetPersonalPinRequest
- A Consumer
that will call methods on ResetPersonalPINRequest.Builder
to create a request.default CompletableFuture<UpdateAccountResponse> updateAccount(UpdateAccountRequest updateAccountRequest)
Updates account details for the specified Amazon Chime account. Currently, only account name updates are supported for this action.
updateAccountRequest
- default CompletableFuture<UpdateAccountResponse> updateAccount(Consumer<UpdateAccountRequest.Builder> updateAccountRequest)
Updates account details for the specified Amazon Chime account. Currently, only account name 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()
updateAccountRequest
- A Consumer
that will call methods on UpdateAccountRequest.Builder
to create a request.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.
updateAccountSettingsRequest
- 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()
updateAccountSettingsRequest
- A Consumer
that will call methods on UpdateAccountSettingsRequest.Builder
to create a
request.default CompletableFuture<UpdateUserResponse> updateUser(UpdateUserRequest updateUserRequest)
Updates user details for a specified user ID. Currently, only LicenseType
updates are supported for
this action.
updateUserRequest
- 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()
updateUserRequest
- A Consumer
that will call methods on UpdateUserRequest.Builder
to create a request.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.