AbstractAmazonChime (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.chime.AbstractAmazonChime

All Implemented Interfaces:

AmazonChime

Direct Known Subclasses:

AbstractAmazonChimeAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonChime
extends Object
implements AmazonChime
```
Abstract implementation of AmazonChime. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.chime.AmazonChime
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BatchSuspendUserResult`	`batchSuspendUser(BatchSuspendUserRequest request)` Suspends up to 50 users from a `Team` or `EnterpriseLWA` Amazon Chime account.
`BatchUnsuspendUserResult`	`batchUnsuspendUser(BatchUnsuspendUserRequest request)` Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime `EnterpriseLWA` account.
`BatchUpdateUserResult`	`batchUpdateUser(BatchUpdateUserRequest request)` Updates user details within the UpdateUserRequestItem object for up to 20 users for the specified Amazon Chime account.
`CreateAccountResult`	`createAccount(CreateAccountRequest request)` Creates an Amazon Chime account under the administrator's AWS account.
`DeleteAccountResult`	`deleteAccount(DeleteAccountRequest request)` Deletes the specified Amazon Chime account.
`GetAccountResult`	`getAccount(GetAccountRequest request)` Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.
`GetAccountSettingsResult`	`getAccountSettings(GetAccountSettingsRequest request)` Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dial out settings.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetUserResult`	`getUser(GetUserRequest request)` Retrieves details for the specified user ID, such as primary email address, license type, and personal meeting PIN.
`InviteUsersResult`	`inviteUsers(InviteUsersRequest request)` Sends email invites to as many as 50 users, inviting them to the specified Amazon Chime `Team` account.
`ListAccountsResult`	`listAccounts(ListAccountsRequest request)` Lists the Amazon Chime accounts under the administrator's AWS account.
`ListUsersResult`	`listUsers(ListUsersRequest request)` Lists the users that belong to the specified Amazon Chime account.
`LogoutUserResult`	`logoutUser(LogoutUserRequest request)` Logs out the specified user from all of the devices they are currently logged into.
`ResetPersonalPINResult`	`resetPersonalPIN(ResetPersonalPINRequest request)` Resets the personal meeting PIN for the specified user on an Amazon Chime account.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`UpdateAccountResult`	`updateAccount(UpdateAccountRequest request)` Updates account details for the specified Amazon Chime account.
`UpdateAccountSettingsResult`	`updateAccountSettings(UpdateAccountSettingsRequest request)` Updates the settings for the specified Amazon Chime account.
`UpdateUserResult`	`updateUser(UpdateUserRequest request)` Updates user details for a specified user ID.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - batchSuspendUser
```
public BatchSuspendUserResult batchSuspendUser(BatchSuspendUserRequest request)
```
    Description copied from interface: AmazonChime
    
    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:
    
    batchSuspendUser in interface AmazonChime
    
    Returns:
    
    Result of the BatchSuspendUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - batchUnsuspendUser
```
public BatchUnsuspendUserResult batchUnsuspendUser(BatchUnsuspendUserRequest request)
```
    Description copied from interface: AmazonChime
    
    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:
    
    batchUnsuspendUser in interface AmazonChime
    
    Returns:
    
    Result of the BatchUnsuspendUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - batchUpdateUser
```
public BatchUpdateUserResult batchUpdateUser(BatchUpdateUserRequest request)
```
    Description copied from interface: AmazonChime
    
    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:
    
    batchUpdateUser in interface AmazonChime
    
    Returns:
    
    Result of the BatchUpdateUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createAccount
```
public CreateAccountResult createAccount(CreateAccountRequest request)
```
    Description copied from interface: AmazonChime
    
    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:
    
    createAccount in interface AmazonChime
    
    Returns:
    
    Result of the CreateAccount operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteAccount
```
public DeleteAccountResult deleteAccount(DeleteAccountRequest request)
```
    Description copied from interface: AmazonChime
    
    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:
    
    deleteAccount in interface AmazonChime
    
    Returns:
    
    Result of the DeleteAccount operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getAccount
```
public GetAccountResult getAccount(GetAccountRequest request)
```
    Description copied from interface: AmazonChime
    
    Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.
    
    Specified by:
    
    getAccount in interface AmazonChime
    
    Returns:
    
    Result of the GetAccount operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getAccountSettings
```
public GetAccountSettingsResult getAccountSettings(GetAccountSettingsRequest request)
```
    Description copied from interface: AmazonChime
    
    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:
    
    getAccountSettings in interface AmazonChime
    
    Returns:
    
    Result of the GetAccountSettings operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getUser
```
public GetUserResult getUser(GetUserRequest request)
```
    Description copied from interface: AmazonChime
    
    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:
    
    getUser in interface AmazonChime
    
    Returns:
    
    Result of the GetUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - inviteUsers
```
public InviteUsersResult inviteUsers(InviteUsersRequest request)
```
    Description copied from interface: AmazonChime
    
    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:
    
    inviteUsers in interface AmazonChime
    
    Returns:
    
    Result of the InviteUsers operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listAccounts
```
public ListAccountsResult listAccounts(ListAccountsRequest request)
```
    Description copied from interface: AmazonChime
    
    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:
    
    listAccounts in interface AmazonChime
    
    Returns:
    
    Result of the ListAccounts operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listUsers
```
public ListUsersResult listUsers(ListUsersRequest request)
```
    Description copied from interface: AmazonChime
    
    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:
    
    listUsers in interface AmazonChime
    
    Returns:
    
    Result of the ListUsers operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - logoutUser
```
public LogoutUserResult logoutUser(LogoutUserRequest request)
```
    Description copied from interface: AmazonChime
    
    Logs out the specified user from all of the devices they are currently logged into.
    
    Specified by:
    
    logoutUser in interface AmazonChime
    
    Returns:
    
    Result of the LogoutUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - resetPersonalPIN
```
public ResetPersonalPINResult resetPersonalPIN(ResetPersonalPINRequest request)
```
    Description copied from interface: AmazonChime
    
    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:
    
    resetPersonalPIN in interface AmazonChime
    
    Returns:
    
    Result of the ResetPersonalPIN operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateAccount
```
public UpdateAccountResult updateAccount(UpdateAccountRequest request)
```
    Description copied from interface: AmazonChime
    
    Updates account details for the specified Amazon Chime account. Currently, only account name updates are supported for this action.
    
    Specified by:
    
    updateAccount in interface AmazonChime
    
    Returns:
    
    Result of the UpdateAccount operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateAccountSettings
```
public UpdateAccountSettingsResult updateAccountSettings(UpdateAccountSettingsRequest request)
```
    Description copied from interface: AmazonChime
    
    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:
    
    updateAccountSettings in interface AmazonChime
    
    Returns:
    
    Result of the UpdateAccountSettings operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateUser
```
public UpdateUserResult updateUser(UpdateUserRequest request)
```
    Description copied from interface: AmazonChime
    
    Updates user details for a specified user ID. Currently, only LicenseType updates are supported for this action.
    
    Specified by:
    
    updateUser in interface AmazonChime
    
    Returns:
    
    Result of the UpdateUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AmazonChime
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AmazonChime
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AmazonChime
    
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AmazonChime
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Class AbstractAmazonChime

Field Summary

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

Method Summary

Methods inherited from class java.lang.Object

Method Detail

batchSuspendUser

batchUnsuspendUser

batchUpdateUser

createAccount

deleteAccount

getAccount

getAccountSettings

getUser

inviteUsers

listAccounts

listUsers

logoutUser

resetPersonalPIN

updateAccount

updateAccountSettings

updateUser

shutdown

getCachedResponseMetadata