com.amazonaws.services.chime

Class AmazonChimeAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.chime.AmazonChimeClient

com.amazonaws.services.chime.AmazonChimeAsyncClient

All Implemented Interfaces:

AmazonChime, AmazonChimeAsync

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonChimeAsyncClient
extends AmazonChimeClient
implements AmazonChimeAsync

Client for accessing Amazon Chime asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

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.

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 API

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.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.chime.AmazonChime

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonChimeAsyncClientBuilder	asyncBuilder()
Future<BatchSuspendUserResult>	batchSuspendUserAsync(BatchSuspendUserRequest request) Suspends up to 50 users from a Team or EnterpriseLWA Amazon Chime account.
Future<BatchSuspendUserResult>	batchSuspendUserAsync(BatchSuspendUserRequest request, AsyncHandler<BatchSuspendUserRequest,BatchSuspendUserResult> asyncHandler) Suspends up to 50 users from a Team or EnterpriseLWA Amazon Chime account.
Future<BatchUnsuspendUserResult>	batchUnsuspendUserAsync(BatchUnsuspendUserRequest request) Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime EnterpriseLWA account.
Future<BatchUnsuspendUserResult>	batchUnsuspendUserAsync(BatchUnsuspendUserRequest request, AsyncHandler<BatchUnsuspendUserRequest,BatchUnsuspendUserResult> asyncHandler) Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime EnterpriseLWA account.
Future<BatchUpdateUserResult>	batchUpdateUserAsync(BatchUpdateUserRequest request) Updates user details within the UpdateUserRequestItem object for up to 20 users for the specified Amazon Chime account.
Future<BatchUpdateUserResult>	batchUpdateUserAsync(BatchUpdateUserRequest request, AsyncHandler<BatchUpdateUserRequest,BatchUpdateUserResult> asyncHandler) Updates user details within the UpdateUserRequestItem object for up to 20 users for the specified Amazon Chime account.
Future<CreateAccountResult>	createAccountAsync(CreateAccountRequest request) Creates an Amazon Chime account under the administrator's AWS account.
Future<CreateAccountResult>	createAccountAsync(CreateAccountRequest request, AsyncHandler<CreateAccountRequest,CreateAccountResult> asyncHandler) Creates an Amazon Chime account under the administrator's AWS account.
Future<DeleteAccountResult>	deleteAccountAsync(DeleteAccountRequest request) Deletes the specified Amazon Chime account.
Future<DeleteAccountResult>	deleteAccountAsync(DeleteAccountRequest request, AsyncHandler<DeleteAccountRequest,DeleteAccountResult> asyncHandler) Deletes the specified Amazon Chime account.
Future<GetAccountResult>	getAccountAsync(GetAccountRequest request) Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.
Future<GetAccountResult>	getAccountAsync(GetAccountRequest request, AsyncHandler<GetAccountRequest,GetAccountResult> asyncHandler) Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.
Future<GetAccountSettingsResult>	getAccountSettingsAsync(GetAccountSettingsRequest request) Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dial out settings.
Future<GetAccountSettingsResult>	getAccountSettingsAsync(GetAccountSettingsRequest request, AsyncHandler<GetAccountSettingsRequest,GetAccountSettingsResult> asyncHandler) Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dial out settings.
ExecutorService	getExecutorService() Returns the executor service used by this client to execute async requests.
Future<GetUserResult>	getUserAsync(GetUserRequest request) Retrieves details for the specified user ID, such as primary email address, license type, and personal meeting PIN.
Future<GetUserResult>	getUserAsync(GetUserRequest request, AsyncHandler<GetUserRequest,GetUserResult> asyncHandler) Retrieves details for the specified user ID, such as primary email address, license type, and personal meeting PIN.
Future<InviteUsersResult>	inviteUsersAsync(InviteUsersRequest request) Sends email invites to as many as 50 users, inviting them to the specified Amazon Chime Team account.
Future<InviteUsersResult>	inviteUsersAsync(InviteUsersRequest request, AsyncHandler<InviteUsersRequest,InviteUsersResult> asyncHandler) Sends email invites to as many as 50 users, inviting them to the specified Amazon Chime Team account.
Future<ListAccountsResult>	listAccountsAsync(ListAccountsRequest request) Lists the Amazon Chime accounts under the administrator's AWS account.
Future<ListAccountsResult>	listAccountsAsync(ListAccountsRequest request, AsyncHandler<ListAccountsRequest,ListAccountsResult> asyncHandler) Lists the Amazon Chime accounts under the administrator's AWS account.
Future<ListUsersResult>	listUsersAsync(ListUsersRequest request) Lists the users that belong to the specified Amazon Chime account.
Future<ListUsersResult>	listUsersAsync(ListUsersRequest request, AsyncHandler<ListUsersRequest,ListUsersResult> asyncHandler) Lists the users that belong to the specified Amazon Chime account.
Future<LogoutUserResult>	logoutUserAsync(LogoutUserRequest request) Logs out the specified user from all of the devices they are currently logged into.
Future<LogoutUserResult>	logoutUserAsync(LogoutUserRequest request, AsyncHandler<LogoutUserRequest,LogoutUserResult> asyncHandler) Logs out the specified user from all of the devices they are currently logged into.
Future<ResetPersonalPINResult>	resetPersonalPINAsync(ResetPersonalPINRequest request) Resets the personal meeting PIN for the specified user on an Amazon Chime account.
Future<ResetPersonalPINResult>	resetPersonalPINAsync(ResetPersonalPINRequest request, AsyncHandler<ResetPersonalPINRequest,ResetPersonalPINResult> asyncHandler) Resets the personal meeting PIN for the specified user on an Amazon Chime account.
void	shutdown() Shuts down the client, releasing all managed resources.
Future<UpdateAccountResult>	updateAccountAsync(UpdateAccountRequest request) Updates account details for the specified Amazon Chime account.
Future<UpdateAccountResult>	updateAccountAsync(UpdateAccountRequest request, AsyncHandler<UpdateAccountRequest,UpdateAccountResult> asyncHandler) Updates account details for the specified Amazon Chime account.
Future<UpdateAccountSettingsResult>	updateAccountSettingsAsync(UpdateAccountSettingsRequest request) Updates the settings for the specified Amazon Chime account.
Future<UpdateAccountSettingsResult>	updateAccountSettingsAsync(UpdateAccountSettingsRequest request, AsyncHandler<UpdateAccountSettingsRequest,UpdateAccountSettingsResult> asyncHandler) Updates the settings for the specified Amazon Chime account.
Future<UpdateUserResult>	updateUserAsync(UpdateUserRequest request) Updates user details for a specified user ID.
Future<UpdateUserResult>	updateUserAsync(UpdateUserRequest request, AsyncHandler<UpdateUserRequest,UpdateUserResult> asyncHandler) Updates user details for a specified user ID.

Methods inherited from class com.amazonaws.services.chime.AmazonChimeClient

batchSuspendUser, batchUnsuspendUser, batchUpdateUser, builder, createAccount, deleteAccount, getAccount, getAccountSettings, getCachedResponseMetadata, getUser, inviteUsers, listAccounts, listUsers, logoutUser, resetPersonalPIN, updateAccount, updateAccountSettings, updateUser

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.chime.AmazonChime

batchSuspendUser, batchUnsuspendUser, batchUpdateUser, createAccount, deleteAccount, getAccount, getAccountSettings, getCachedResponseMetadata, getUser, inviteUsers, listAccounts, listUsers, logoutUser, resetPersonalPIN, updateAccount, updateAccountSettings, updateUser

Method Detail

asyncBuilder

public static AmazonChimeAsyncClientBuilder asyncBuilder()

getExecutorService

public ExecutorService getExecutorService()

Returns the executor service used by this client to execute async requests.

Returns:

The executor service used by this client to execute async requests.

batchSuspendUserAsync

public Future<BatchSuspendUserResult> batchSuspendUserAsync(BatchSuspendUserRequest request)

Description copied from interface: AmazonChimeAsync

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.

Specified by:

batchSuspendUserAsync in interface AmazonChimeAsync

Returns:

A Java Future containing the result of the BatchSuspendUser operation returned by the service.

See Also:

AWS API Documentation

batchSuspendUserAsync

public Future<BatchSuspendUserResult> batchSuspendUserAsync(BatchSuspendUserRequest request,
                                                            AsyncHandler<BatchSuspendUserRequest,BatchSuspendUserResult> asyncHandler)

Description copied from interface: AmazonChimeAsync

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.

Specified by:

batchSuspendUserAsync in interface AmazonChimeAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the BatchSuspendUser operation returned by the service.

See Also:

AWS API Documentation

batchUnsuspendUserAsync

public Future<BatchUnsuspendUserResult> batchUnsuspendUserAsync(BatchUnsuspendUserRequest request)

Description copied from interface: AmazonChimeAsync

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.

Specified by:

batchUnsuspendUserAsync in interface AmazonChimeAsync

Returns:

A Java Future containing the result of the BatchUnsuspendUser operation returned by the service.

See Also:

AWS API Documentation

batchUnsuspendUserAsync

public Future<BatchUnsuspendUserResult> batchUnsuspendUserAsync(BatchUnsuspendUserRequest request,
                                                                AsyncHandler<BatchUnsuspendUserRequest,BatchUnsuspendUserResult> asyncHandler)

Description copied from interface: AmazonChimeAsync

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.

Specified by:

batchUnsuspendUserAsync in interface AmazonChimeAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the BatchUnsuspendUser operation returned by the service.

See Also:

AWS API Documentation

batchUpdateUserAsync

public Future<BatchUpdateUserResult> batchUpdateUserAsync(BatchUpdateUserRequest request)

Description copied from interface: AmazonChimeAsync

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.

Specified by:

batchUpdateUserAsync in interface AmazonChimeAsync

Returns:

A Java Future containing the result of the BatchUpdateUser operation returned by the service.

See Also:

AWS API Documentation

batchUpdateUserAsync

public Future<BatchUpdateUserResult> batchUpdateUserAsync(BatchUpdateUserRequest request,
                                                          AsyncHandler<BatchUpdateUserRequest,BatchUpdateUserResult> asyncHandler)

Description copied from interface: AmazonChimeAsync

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.

Specified by:

batchUpdateUserAsync in interface AmazonChimeAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the BatchUpdateUser operation returned by the service.

See Also:

AWS API Documentation

createAccountAsync

public Future<CreateAccountResult> createAccountAsync(CreateAccountRequest request)

Description copied from interface: AmazonChimeAsync

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.

Specified by:

createAccountAsync in interface AmazonChimeAsync

Returns:

A Java Future containing the result of the CreateAccount operation returned by the service.

See Also:

AWS API Documentation

createAccountAsync

public Future<CreateAccountResult> createAccountAsync(CreateAccountRequest request,
                                                      AsyncHandler<CreateAccountRequest,CreateAccountResult> asyncHandler)

Description copied from interface: AmazonChimeAsync

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.

Specified by:

createAccountAsync in interface AmazonChimeAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the CreateAccount operation returned by the service.

See Also:

AWS API Documentation

deleteAccountAsync

public Future<DeleteAccountResult> deleteAccountAsync(DeleteAccountRequest request)

Description copied from interface: AmazonChimeAsync

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.

Specified by:

deleteAccountAsync in interface AmazonChimeAsync

Returns:

A Java Future containing the result of the DeleteAccount operation returned by the service.

See Also:

AWS API Documentation

deleteAccountAsync

public Future<DeleteAccountResult> deleteAccountAsync(DeleteAccountRequest request,
                                                      AsyncHandler<DeleteAccountRequest,DeleteAccountResult> asyncHandler)

Description copied from interface: AmazonChimeAsync

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.

Specified by:

deleteAccountAsync in interface AmazonChimeAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DeleteAccount operation returned by the service.

See Also:

AWS API Documentation

getAccountAsync

public Future<GetAccountResult> getAccountAsync(GetAccountRequest request)

Description copied from interface: AmazonChimeAsync

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

Specified by:

getAccountAsync in interface AmazonChimeAsync

Returns:

A Java Future containing the result of the GetAccount operation returned by the service.

See Also:

AWS API Documentation

getAccountAsync

public Future<GetAccountResult> getAccountAsync(GetAccountRequest request,
                                                AsyncHandler<GetAccountRequest,GetAccountResult> asyncHandler)

Description copied from interface: AmazonChimeAsync

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

Specified by:

getAccountAsync in interface AmazonChimeAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the GetAccount operation returned by the service.

See Also:

AWS API Documentation

getAccountSettingsAsync

public Future<GetAccountSettingsResult> getAccountSettingsAsync(GetAccountSettingsRequest request)

Description copied from interface: AmazonChimeAsync

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.

Specified by:

getAccountSettingsAsync in interface AmazonChimeAsync

Returns:

A Java Future containing the result of the GetAccountSettings operation returned by the service.

See Also:

AWS API Documentation

getAccountSettingsAsync

public Future<GetAccountSettingsResult> getAccountSettingsAsync(GetAccountSettingsRequest request,
                                                                AsyncHandler<GetAccountSettingsRequest,GetAccountSettingsResult> asyncHandler)

Description copied from interface: AmazonChimeAsync

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.

Specified by:

getAccountSettingsAsync in interface AmazonChimeAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the GetAccountSettings operation returned by the service.

See Also:

AWS API Documentation

getUserAsync

public Future<GetUserResult> getUserAsync(GetUserRequest request)

Description copied from interface: AmazonChimeAsync

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.

Specified by:

getUserAsync in interface AmazonChimeAsync

Returns:

A Java Future containing the result of the GetUser operation returned by the service.

See Also:

AWS API Documentation

getUserAsync

public Future<GetUserResult> getUserAsync(GetUserRequest request,
                                          AsyncHandler<GetUserRequest,GetUserResult> asyncHandler)

Description copied from interface: AmazonChimeAsync

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.

Specified by:

getUserAsync in interface AmazonChimeAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the GetUser operation returned by the service.

See Also:

AWS API Documentation

inviteUsersAsync

public Future<InviteUsersResult> inviteUsersAsync(InviteUsersRequest request)

Description copied from interface: AmazonChimeAsync

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.

Specified by:

inviteUsersAsync in interface AmazonChimeAsync

Returns:

A Java Future containing the result of the InviteUsers operation returned by the service.

See Also:

AWS API Documentation

inviteUsersAsync

public Future<InviteUsersResult> inviteUsersAsync(InviteUsersRequest request,
                                                  AsyncHandler<InviteUsersRequest,InviteUsersResult> asyncHandler)

Description copied from interface: AmazonChimeAsync

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.

Specified by:

inviteUsersAsync in interface AmazonChimeAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the InviteUsers operation returned by the service.

See Also:

AWS API Documentation

listAccountsAsync

public Future<ListAccountsResult> listAccountsAsync(ListAccountsRequest request)

Description copied from interface: AmazonChimeAsync

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.

Specified by:

listAccountsAsync in interface AmazonChimeAsync

Returns:

A Java Future containing the result of the ListAccounts operation returned by the service.

See Also:

AWS API Documentation

listAccountsAsync

public Future<ListAccountsResult> listAccountsAsync(ListAccountsRequest request,
                                                    AsyncHandler<ListAccountsRequest,ListAccountsResult> asyncHandler)

Description copied from interface: AmazonChimeAsync

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.

Specified by:

listAccountsAsync in interface AmazonChimeAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListAccounts operation returned by the service.

See Also:

AWS API Documentation

listUsersAsync

public Future<ListUsersResult> listUsersAsync(ListUsersRequest request)

Description copied from interface: AmazonChimeAsync

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.

Specified by:

listUsersAsync in interface AmazonChimeAsync

Returns:

A Java Future containing the result of the ListUsers operation returned by the service.

See Also:

AWS API Documentation

listUsersAsync

public Future<ListUsersResult> listUsersAsync(ListUsersRequest request,
                                              AsyncHandler<ListUsersRequest,ListUsersResult> asyncHandler)

Description copied from interface: AmazonChimeAsync

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.

Specified by:

listUsersAsync in interface AmazonChimeAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListUsers operation returned by the service.

See Also:

AWS API Documentation

logoutUserAsync

public Future<LogoutUserResult> logoutUserAsync(LogoutUserRequest request)

Description copied from interface: AmazonChimeAsync

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

Specified by:

logoutUserAsync in interface AmazonChimeAsync

Returns:

A Java Future containing the result of the LogoutUser operation returned by the service.

See Also:

AWS API Documentation

logoutUserAsync

public Future<LogoutUserResult> logoutUserAsync(LogoutUserRequest request,
                                                AsyncHandler<LogoutUserRequest,LogoutUserResult> asyncHandler)

Description copied from interface: AmazonChimeAsync

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

Specified by:

logoutUserAsync in interface AmazonChimeAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the LogoutUser operation returned by the service.

See Also:

AWS API Documentation

resetPersonalPINAsync

public Future<ResetPersonalPINResult> resetPersonalPINAsync(ResetPersonalPINRequest request)

Description copied from interface: AmazonChimeAsync

Resets the personal meeting PIN for the specified user on an Amazon Chime account. Returns the User object with the updated personal meeting PIN.

Specified by:

resetPersonalPINAsync in interface AmazonChimeAsync

Returns:

A Java Future containing the result of the ResetPersonalPIN operation returned by the service.

See Also:

AWS API Documentation

resetPersonalPINAsync

public Future<ResetPersonalPINResult> resetPersonalPINAsync(ResetPersonalPINRequest request,
                                                            AsyncHandler<ResetPersonalPINRequest,ResetPersonalPINResult> asyncHandler)

Description copied from interface: AmazonChimeAsync

Resets the personal meeting PIN for the specified user on an Amazon Chime account. Returns the User object with the updated personal meeting PIN.

Specified by:

resetPersonalPINAsync in interface AmazonChimeAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ResetPersonalPIN operation returned by the service.

See Also:

AWS API Documentation

updateAccountAsync

public Future<UpdateAccountResult> updateAccountAsync(UpdateAccountRequest request)

Description copied from interface: AmazonChimeAsync

Updates account details for the specified Amazon Chime account. Currently, only account name updates are supported for this action.

Specified by:

updateAccountAsync in interface AmazonChimeAsync

Returns:

A Java Future containing the result of the UpdateAccount operation returned by the service.

See Also:

AWS API Documentation

updateAccountAsync

public Future<UpdateAccountResult> updateAccountAsync(UpdateAccountRequest request,
                                                      AsyncHandler<UpdateAccountRequest,UpdateAccountResult> asyncHandler)

Description copied from interface: AmazonChimeAsync

Updates account details for the specified Amazon Chime account. Currently, only account name updates are supported for this action.

Specified by:

updateAccountAsync in interface AmazonChimeAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the UpdateAccount operation returned by the service.

See Also:

AWS API Documentation

updateAccountSettingsAsync

public Future<UpdateAccountSettingsResult> updateAccountSettingsAsync(UpdateAccountSettingsRequest request)

Description copied from interface: AmazonChimeAsync

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.

Specified by:

updateAccountSettingsAsync in interface AmazonChimeAsync

Returns:

A Java Future containing the result of the UpdateAccountSettings operation returned by the service.

See Also:

AWS API Documentation

updateAccountSettingsAsync

public Future<UpdateAccountSettingsResult> updateAccountSettingsAsync(UpdateAccountSettingsRequest request,
                                                                      AsyncHandler<UpdateAccountSettingsRequest,UpdateAccountSettingsResult> asyncHandler)

Description copied from interface: AmazonChimeAsync

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.

Specified by:

updateAccountSettingsAsync in interface AmazonChimeAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the UpdateAccountSettings operation returned by the service.

See Also:

AWS API Documentation

updateUserAsync

public Future<UpdateUserResult> updateUserAsync(UpdateUserRequest request)

Description copied from interface: AmazonChimeAsync

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

Specified by:

updateUserAsync in interface AmazonChimeAsync

Returns:

A Java Future containing the result of the UpdateUser operation returned by the service.

See Also:

AWS API Documentation

updateUserAsync

public Future<UpdateUserResult> updateUserAsync(UpdateUserRequest request,
                                                AsyncHandler<UpdateUserRequest,UpdateUserResult> asyncHandler)

Description copied from interface: AmazonChimeAsync

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

Specified by:

updateUserAsync in interface AmazonChimeAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the UpdateUser operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.

Specified by:

shutdown in interface AmazonChime

Overrides:

shutdown in class AmazonWebServiceClient