@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonChimeAsync extends AmazonChime
AsyncHandler
can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonChimeAsync
instead.
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.
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
Future<BatchSuspendUserResult> |
batchSuspendUserAsync(BatchSuspendUserRequest batchSuspendUserRequest)
Suspends up to 50 users from a
Team or EnterpriseLWA Amazon Chime account. |
Future<BatchSuspendUserResult> |
batchSuspendUserAsync(BatchSuspendUserRequest batchSuspendUserRequest,
AsyncHandler<BatchSuspendUserRequest,BatchSuspendUserResult> asyncHandler)
Suspends up to 50 users from a
Team or EnterpriseLWA Amazon Chime account. |
Future<BatchUnsuspendUserResult> |
batchUnsuspendUserAsync(BatchUnsuspendUserRequest batchUnsuspendUserRequest)
Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime
EnterpriseLWA account. |
Future<BatchUnsuspendUserResult> |
batchUnsuspendUserAsync(BatchUnsuspendUserRequest batchUnsuspendUserRequest,
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 batchUpdateUserRequest)
Updates user details within the UpdateUserRequestItem object for up to 20 users for the specified Amazon
Chime account.
|
Future<BatchUpdateUserResult> |
batchUpdateUserAsync(BatchUpdateUserRequest batchUpdateUserRequest,
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 createAccountRequest)
Creates an Amazon Chime account under the administrator's AWS account.
|
Future<CreateAccountResult> |
createAccountAsync(CreateAccountRequest createAccountRequest,
AsyncHandler<CreateAccountRequest,CreateAccountResult> asyncHandler)
Creates an Amazon Chime account under the administrator's AWS account.
|
Future<DeleteAccountResult> |
deleteAccountAsync(DeleteAccountRequest deleteAccountRequest)
Deletes the specified Amazon Chime account.
|
Future<DeleteAccountResult> |
deleteAccountAsync(DeleteAccountRequest deleteAccountRequest,
AsyncHandler<DeleteAccountRequest,DeleteAccountResult> asyncHandler)
Deletes the specified Amazon Chime account.
|
Future<GetAccountResult> |
getAccountAsync(GetAccountRequest getAccountRequest)
Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.
|
Future<GetAccountResult> |
getAccountAsync(GetAccountRequest getAccountRequest,
AsyncHandler<GetAccountRequest,GetAccountResult> asyncHandler)
Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.
|
Future<GetAccountSettingsResult> |
getAccountSettingsAsync(GetAccountSettingsRequest getAccountSettingsRequest)
Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dial out
settings.
|
Future<GetAccountSettingsResult> |
getAccountSettingsAsync(GetAccountSettingsRequest getAccountSettingsRequest,
AsyncHandler<GetAccountSettingsRequest,GetAccountSettingsResult> asyncHandler)
Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dial out
settings.
|
Future<GetUserResult> |
getUserAsync(GetUserRequest getUserRequest)
Retrieves details for the specified user ID, such as primary email address, license type, and personal meeting
PIN.
|
Future<GetUserResult> |
getUserAsync(GetUserRequest getUserRequest,
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 inviteUsersRequest)
Sends email invites to as many as 50 users, inviting them to the specified Amazon Chime
Team
account. |
Future<InviteUsersResult> |
inviteUsersAsync(InviteUsersRequest inviteUsersRequest,
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 listAccountsRequest)
Lists the Amazon Chime accounts under the administrator's AWS account.
|
Future<ListAccountsResult> |
listAccountsAsync(ListAccountsRequest listAccountsRequest,
AsyncHandler<ListAccountsRequest,ListAccountsResult> asyncHandler)
Lists the Amazon Chime accounts under the administrator's AWS account.
|
Future<ListUsersResult> |
listUsersAsync(ListUsersRequest listUsersRequest)
Lists the users that belong to the specified Amazon Chime account.
|
Future<ListUsersResult> |
listUsersAsync(ListUsersRequest listUsersRequest,
AsyncHandler<ListUsersRequest,ListUsersResult> asyncHandler)
Lists the users that belong to the specified Amazon Chime account.
|
Future<LogoutUserResult> |
logoutUserAsync(LogoutUserRequest logoutUserRequest)
Logs out the specified user from all of the devices they are currently logged into.
|
Future<LogoutUserResult> |
logoutUserAsync(LogoutUserRequest logoutUserRequest,
AsyncHandler<LogoutUserRequest,LogoutUserResult> asyncHandler)
Logs out the specified user from all of the devices they are currently logged into.
|
Future<ResetPersonalPINResult> |
resetPersonalPINAsync(ResetPersonalPINRequest resetPersonalPINRequest)
Resets the personal meeting PIN for the specified user on an Amazon Chime account.
|
Future<ResetPersonalPINResult> |
resetPersonalPINAsync(ResetPersonalPINRequest resetPersonalPINRequest,
AsyncHandler<ResetPersonalPINRequest,ResetPersonalPINResult> asyncHandler)
Resets the personal meeting PIN for the specified user on an Amazon Chime account.
|
Future<UpdateAccountResult> |
updateAccountAsync(UpdateAccountRequest updateAccountRequest)
Updates account details for the specified Amazon Chime account.
|
Future<UpdateAccountResult> |
updateAccountAsync(UpdateAccountRequest updateAccountRequest,
AsyncHandler<UpdateAccountRequest,UpdateAccountResult> asyncHandler)
Updates account details for the specified Amazon Chime account.
|
Future<UpdateAccountSettingsResult> |
updateAccountSettingsAsync(UpdateAccountSettingsRequest updateAccountSettingsRequest)
Updates the settings for the specified Amazon Chime account.
|
Future<UpdateAccountSettingsResult> |
updateAccountSettingsAsync(UpdateAccountSettingsRequest updateAccountSettingsRequest,
AsyncHandler<UpdateAccountSettingsRequest,UpdateAccountSettingsResult> asyncHandler)
Updates the settings for the specified Amazon Chime account.
|
Future<UpdateUserResult> |
updateUserAsync(UpdateUserRequest updateUserRequest)
Updates user details for a specified user ID.
|
Future<UpdateUserResult> |
updateUserAsync(UpdateUserRequest updateUserRequest,
AsyncHandler<UpdateUserRequest,UpdateUserResult> asyncHandler)
Updates user details for a specified user ID.
|
batchSuspendUser, batchUnsuspendUser, batchUpdateUser, createAccount, deleteAccount, getAccount, getAccountSettings, getCachedResponseMetadata, getUser, inviteUsers, listAccounts, listUsers, logoutUser, resetPersonalPIN, shutdown, updateAccount, updateAccountSettings, updateUser
Future<BatchSuspendUserResult> batchSuspendUserAsync(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
- Future<BatchSuspendUserResult> batchSuspendUserAsync(BatchSuspendUserRequest batchSuspendUserRequest, AsyncHandler<BatchSuspendUserRequest,BatchSuspendUserResult> asyncHandler)
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
- 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.Future<BatchUnsuspendUserResult> batchUnsuspendUserAsync(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
- Future<BatchUnsuspendUserResult> batchUnsuspendUserAsync(BatchUnsuspendUserRequest batchUnsuspendUserRequest, AsyncHandler<BatchUnsuspendUserRequest,BatchUnsuspendUserResult> asyncHandler)
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
- 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.Future<BatchUpdateUserResult> batchUpdateUserAsync(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
- Future<BatchUpdateUserResult> batchUpdateUserAsync(BatchUpdateUserRequest batchUpdateUserRequest, AsyncHandler<BatchUpdateUserRequest,BatchUpdateUserResult> asyncHandler)
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
- 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.Future<CreateAccountResult> createAccountAsync(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
- Future<CreateAccountResult> createAccountAsync(CreateAccountRequest createAccountRequest, AsyncHandler<CreateAccountRequest,CreateAccountResult> asyncHandler)
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
- 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.Future<DeleteAccountResult> deleteAccountAsync(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
- Future<DeleteAccountResult> deleteAccountAsync(DeleteAccountRequest deleteAccountRequest, AsyncHandler<DeleteAccountRequest,DeleteAccountResult> asyncHandler)
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
- 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.Future<GetAccountResult> getAccountAsync(GetAccountRequest getAccountRequest)
Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.
getAccountRequest
- Future<GetAccountResult> getAccountAsync(GetAccountRequest getAccountRequest, AsyncHandler<GetAccountRequest,GetAccountResult> asyncHandler)
Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.
getAccountRequest
- 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.Future<GetAccountSettingsResult> getAccountSettingsAsync(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
- Future<GetAccountSettingsResult> getAccountSettingsAsync(GetAccountSettingsRequest getAccountSettingsRequest, AsyncHandler<GetAccountSettingsRequest,GetAccountSettingsResult> asyncHandler)
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
- 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.Future<GetUserResult> getUserAsync(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
- Future<GetUserResult> getUserAsync(GetUserRequest getUserRequest, AsyncHandler<GetUserRequest,GetUserResult> asyncHandler)
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
- 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.Future<InviteUsersResult> inviteUsersAsync(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
- Future<InviteUsersResult> inviteUsersAsync(InviteUsersRequest inviteUsersRequest, AsyncHandler<InviteUsersRequest,InviteUsersResult> asyncHandler)
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
- 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.Future<ListAccountsResult> listAccountsAsync(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
- Future<ListAccountsResult> listAccountsAsync(ListAccountsRequest listAccountsRequest, AsyncHandler<ListAccountsRequest,ListAccountsResult> asyncHandler)
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
- 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.Future<ListUsersResult> listUsersAsync(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
- Future<ListUsersResult> listUsersAsync(ListUsersRequest listUsersRequest, AsyncHandler<ListUsersRequest,ListUsersResult> asyncHandler)
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
- 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.Future<LogoutUserResult> logoutUserAsync(LogoutUserRequest logoutUserRequest)
Logs out the specified user from all of the devices they are currently logged into.
logoutUserRequest
- Future<LogoutUserResult> logoutUserAsync(LogoutUserRequest logoutUserRequest, AsyncHandler<LogoutUserRequest,LogoutUserResult> asyncHandler)
Logs out the specified user from all of the devices they are currently logged into.
logoutUserRequest
- 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.Future<ResetPersonalPINResult> resetPersonalPINAsync(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
- Future<ResetPersonalPINResult> resetPersonalPINAsync(ResetPersonalPINRequest resetPersonalPINRequest, AsyncHandler<ResetPersonalPINRequest,ResetPersonalPINResult> asyncHandler)
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
- 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.Future<UpdateAccountResult> updateAccountAsync(UpdateAccountRequest updateAccountRequest)
Updates account details for the specified Amazon Chime account. Currently, only account name updates are supported for this action.
updateAccountRequest
- Future<UpdateAccountResult> updateAccountAsync(UpdateAccountRequest updateAccountRequest, AsyncHandler<UpdateAccountRequest,UpdateAccountResult> asyncHandler)
Updates account details for the specified Amazon Chime account. Currently, only account name updates are supported for this action.
updateAccountRequest
- 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.Future<UpdateAccountSettingsResult> updateAccountSettingsAsync(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
- Future<UpdateAccountSettingsResult> updateAccountSettingsAsync(UpdateAccountSettingsRequest updateAccountSettingsRequest, AsyncHandler<UpdateAccountSettingsRequest,UpdateAccountSettingsResult> asyncHandler)
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
- 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.Future<UpdateUserResult> updateUserAsync(UpdateUserRequest updateUserRequest)
Updates user details for a specified user ID. Currently, only LicenseType
updates are supported for
this action.
updateUserRequest
- Future<UpdateUserResult> updateUserAsync(UpdateUserRequest updateUserRequest, AsyncHandler<UpdateUserRequest,UpdateUserResult> asyncHandler)
Updates user details for a specified user ID. Currently, only LicenseType
updates are supported for
this action.
updateUserRequest
- 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.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.