com.amazonaws.services.chime

Class AmazonChimeClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.chime.AmazonChimeClient

All Implemented Interfaces:

AmazonChime

Direct Known Subclasses:

AmazonChimeAsyncClient

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

Client for accessing Amazon Chime. All service calls made using this client are blocking, and will not return until the service call 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
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.
static AmazonChimeClientBuilder	builder()
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.
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 com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, 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

shutdown

Method Detail

builder

public static AmazonChimeClientBuilder builder()

batchSuspendUser

public BatchSuspendUserResult batchSuspendUser(BatchSuspendUserRequest request)

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

Parameters:

batchSuspendUserRequest -

Returns:

Result of the BatchSuspendUser operation returned by the service.

Throws:

UnauthorizedClientException - The client is not currently authorized to make the request.

NotFoundException - One or more of the resources in the request does not exist in the system.

ForbiddenException - The client is permanently forbidden from making the request. For example, when a user tries to create an account from an unsupported region.

BadRequestException - The input parameters don't match the service's restrictions.

ThrottledClientException - The client exceeded its request rate limit.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

See Also:

AWS API Documentation

batchUnsuspendUser

public BatchUnsuspendUserResult batchUnsuspendUser(BatchUnsuspendUserRequest request)

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

Parameters:

batchUnsuspendUserRequest -

Returns:

Result of the BatchUnsuspendUser operation returned by the service.

Throws:

UnauthorizedClientException - The client is not currently authorized to make the request.

NotFoundException - One or more of the resources in the request does not exist in the system.

ForbiddenException - The client is permanently forbidden from making the request. For example, when a user tries to create an account from an unsupported region.

BadRequestException - The input parameters don't match the service's restrictions.

ThrottledClientException - The client exceeded its request rate limit.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

See Also:

AWS API Documentation

batchUpdateUser

public BatchUpdateUserResult batchUpdateUser(BatchUpdateUserRequest request)

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

Parameters:

batchUpdateUserRequest -

Returns:

Result of the BatchUpdateUser operation returned by the service.

Throws:

UnauthorizedClientException - The client is not currently authorized to make the request.

NotFoundException - One or more of the resources in the request does not exist in the system.

ForbiddenException - The client is permanently forbidden from making the request. For example, when a user tries to create an account from an unsupported region.

BadRequestException - The input parameters don't match the service's restrictions.

ThrottledClientException - The client exceeded its request rate limit.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

See Also:

AWS API Documentation

createAccount

public CreateAccountResult createAccount(CreateAccountRequest request)

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

Parameters:

createAccountRequest -

Returns:

Result of the CreateAccount operation returned by the service.

Throws:

UnauthorizedClientException - The client is not currently authorized to make the request.

NotFoundException - One or more of the resources in the request does not exist in the system.

ForbiddenException - The client is permanently forbidden from making the request. For example, when a user tries to create an account from an unsupported region.

BadRequestException - The input parameters don't match the service's restrictions.

ThrottledClientException - The client exceeded its request rate limit.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

See Also:

AWS API Documentation

deleteAccount

public DeleteAccountResult deleteAccount(DeleteAccountRequest request)

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

Parameters:

deleteAccountRequest -

Returns:

Result of the DeleteAccount operation returned by the service.

Throws:

UnauthorizedClientException - The client is not currently authorized to make the request.

NotFoundException - One or more of the resources in the request does not exist in the system.

ForbiddenException - The client is permanently forbidden from making the request. For example, when a user tries to create an account from an unsupported region.

BadRequestException - The input parameters don't match the service's restrictions.

ThrottledClientException - The client exceeded its request rate limit.

UnprocessableEntityException - The request was well-formed but was unable to be followed due to semantic errors.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

See Also:

AWS API Documentation

getAccount

public GetAccountResult getAccount(GetAccountRequest request)

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

Specified by:

getAccount in interface AmazonChime

Parameters:

getAccountRequest -

Returns:

Result of the GetAccount operation returned by the service.

Throws:

UnauthorizedClientException - The client is not currently authorized to make the request.

NotFoundException - One or more of the resources in the request does not exist in the system.

ForbiddenException - The client is permanently forbidden from making the request. For example, when a user tries to create an account from an unsupported region.

BadRequestException - The input parameters don't match the service's restrictions.

ThrottledClientException - The client exceeded its request rate limit.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

See Also:

AWS API Documentation

getAccountSettings

public GetAccountSettingsResult getAccountSettings(GetAccountSettingsRequest request)

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

Parameters:

getAccountSettingsRequest -

Returns:

Result of the GetAccountSettings operation returned by the service.

Throws:

UnauthorizedClientException - The client is not currently authorized to make the request.

NotFoundException - One or more of the resources in the request does not exist in the system.

BadRequestException - The input parameters don't match the service's restrictions.

ForbiddenException - The client is permanently forbidden from making the request. For example, when a user tries to create an account from an unsupported region.

ThrottledClientException - The client exceeded its request rate limit.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

See Also:

AWS API Documentation

getUser

public GetUserResult getUser(GetUserRequest request)

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

Parameters:

getUserRequest -

Returns:

Result of the GetUser operation returned by the service.

Throws:

UnauthorizedClientException - The client is not currently authorized to make the request.

NotFoundException - One or more of the resources in the request does not exist in the system.

ForbiddenException - The client is permanently forbidden from making the request. For example, when a user tries to create an account from an unsupported region.

BadRequestException - The input parameters don't match the service's restrictions.

ThrottledClientException - The client exceeded its request rate limit.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

See Also:

AWS API Documentation

inviteUsers

public InviteUsersResult inviteUsers(InviteUsersRequest request)

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

Parameters:

inviteUsersRequest -

Returns:

Result of the InviteUsers operation returned by the service.

Throws:

UnauthorizedClientException - The client is not currently authorized to make the request.

NotFoundException - One or more of the resources in the request does not exist in the system.

ForbiddenException - The client is permanently forbidden from making the request. For example, when a user tries to create an account from an unsupported region.

BadRequestException - The input parameters don't match the service's restrictions.

ThrottledClientException - The client exceeded its request rate limit.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

See Also:

AWS API Documentation

listAccounts

public ListAccountsResult listAccounts(ListAccountsRequest request)

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

Parameters:

listAccountsRequest -

Returns:

Result of the ListAccounts operation returned by the service.

Throws:

UnauthorizedClientException - The client is not currently authorized to make the request.

NotFoundException - One or more of the resources in the request does not exist in the system.

ForbiddenException - The client is permanently forbidden from making the request. For example, when a user tries to create an account from an unsupported region.

BadRequestException - The input parameters don't match the service's restrictions.

ThrottledClientException - The client exceeded its request rate limit.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

See Also:

AWS API Documentation

listUsers

public ListUsersResult listUsers(ListUsersRequest request)

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

Parameters:

listUsersRequest -

Returns:

Result of the ListUsers operation returned by the service.

Throws:

UnauthorizedClientException - The client is not currently authorized to make the request.

NotFoundException - One or more of the resources in the request does not exist in the system.

ForbiddenException - The client is permanently forbidden from making the request. For example, when a user tries to create an account from an unsupported region.

BadRequestException - The input parameters don't match the service's restrictions.

ThrottledClientException - The client exceeded its request rate limit.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

See Also:

AWS API Documentation

logoutUser

public LogoutUserResult logoutUser(LogoutUserRequest request)

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

Specified by:

logoutUser in interface AmazonChime

Parameters:

logoutUserRequest -

Returns:

Result of the LogoutUser operation returned by the service.

Throws:

UnauthorizedClientException - The client is not currently authorized to make the request.

NotFoundException - One or more of the resources in the request does not exist in the system.

ForbiddenException - The client is permanently forbidden from making the request. For example, when a user tries to create an account from an unsupported region.

BadRequestException - The input parameters don't match the service's restrictions.

ThrottledClientException - The client exceeded its request rate limit.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

See Also:

AWS API Documentation

resetPersonalPIN

public ResetPersonalPINResult resetPersonalPIN(ResetPersonalPINRequest request)

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

Parameters:

resetPersonalPINRequest -

Returns:

Result of the ResetPersonalPIN operation returned by the service.

Throws:

UnauthorizedClientException - The client is not currently authorized to make the request.

NotFoundException - One or more of the resources in the request does not exist in the system.

ForbiddenException - The client is permanently forbidden from making the request. For example, when a user tries to create an account from an unsupported region.

BadRequestException - The input parameters don't match the service's restrictions.

ThrottledClientException - The client exceeded its request rate limit.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

See Also:

AWS API Documentation

updateAccount

public UpdateAccountResult updateAccount(UpdateAccountRequest request)

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

Parameters:

updateAccountRequest -

Returns:

Result of the UpdateAccount operation returned by the service.

Throws:

UnauthorizedClientException - The client is not currently authorized to make the request.

NotFoundException - One or more of the resources in the request does not exist in the system.

ForbiddenException - The client is permanently forbidden from making the request. For example, when a user tries to create an account from an unsupported region.

BadRequestException - The input parameters don't match the service's restrictions.

ThrottledClientException - The client exceeded its request rate limit.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

See Also:

AWS API Documentation

updateAccountSettings

public UpdateAccountSettingsResult updateAccountSettings(UpdateAccountSettingsRequest request)

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

Parameters:

updateAccountSettingsRequest -

Returns:

Result of the UpdateAccountSettings operation returned by the service.

Throws:

UnauthorizedClientException - The client is not currently authorized to make the request.

NotFoundException - One or more of the resources in the request does not exist in the system.

BadRequestException - The input parameters don't match the service's restrictions.

ForbiddenException - The client is permanently forbidden from making the request. For example, when a user tries to create an account from an unsupported region.

ConflictException - The request could not be processed because of conflict in the current state of the resource.

ThrottledClientException - The client exceeded its request rate limit.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

See Also:

AWS API Documentation

updateUser

public UpdateUserResult updateUser(UpdateUserRequest request)

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

Specified by:

updateUser in interface AmazonChime

Parameters:

updateUserRequest -

Returns:

Result of the UpdateUser operation returned by the service.

Throws:

UnauthorizedClientException - The client is not currently authorized to make the request.

NotFoundException - One or more of the resources in the request does not exist in the system.

ForbiddenException - The client is permanently forbidden from making the request. For example, when a user tries to create an account from an unsupported region.

BadRequestException - The input parameters don't match the service's restrictions.

ThrottledClientException - The client exceeded its request rate limit.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

See Also:

AWS API Documentation

getCachedResponseMetadata

public 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. 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 the 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.