AmazonChimeClient (AWS SDK for Java

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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AssociatePhoneNumbersWithVoiceConnectorResult`	`associatePhoneNumbersWithVoiceConnector(AssociatePhoneNumbersWithVoiceConnectorRequest request)` Associates a phone number with the specified Amazon Chime Voice Connector.
`AssociatePhoneNumberWithUserResult`	`associatePhoneNumberWithUser(AssociatePhoneNumberWithUserRequest request)` Associates a phone number with the specified Amazon Chime user.
`BatchDeletePhoneNumberResult`	`batchDeletePhoneNumber(BatchDeletePhoneNumberRequest request)` Moves phone numbers into the Deletion queue.
`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.
`BatchUpdatePhoneNumberResult`	`batchUpdatePhoneNumber(BatchUpdatePhoneNumberRequest request)` Updates phone number product types.
`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.
`CreateBotResult`	`createBot(CreateBotRequest request)` Creates a bot for an Amazon Chime Enterprise account.
`CreatePhoneNumberOrderResult`	`createPhoneNumberOrder(CreatePhoneNumberOrderRequest request)` Creates an order for phone numbers to be provisioned.
`CreateVoiceConnectorResult`	`createVoiceConnector(CreateVoiceConnectorRequest request)` Creates an Amazon Chime Voice Connector under the administrator's AWS account.
`DeleteAccountResult`	`deleteAccount(DeleteAccountRequest request)` Deletes the specified Amazon Chime account.
`DeleteEventsConfigurationResult`	`deleteEventsConfiguration(DeleteEventsConfigurationRequest request)` Deletes the events configuration that allows a bot to receive outgoing events.
`DeletePhoneNumberResult`	`deletePhoneNumber(DeletePhoneNumberRequest request)` Moves the specified phone number into the Deletion queue.
`DeleteVoiceConnectorResult`	`deleteVoiceConnector(DeleteVoiceConnectorRequest request)` Deletes the specified Amazon Chime Voice Connector.
`DeleteVoiceConnectorOriginationResult`	`deleteVoiceConnectorOrigination(DeleteVoiceConnectorOriginationRequest request)` Deletes the origination settings for the specified Amazon Chime Voice Connector.
`DeleteVoiceConnectorTerminationResult`	`deleteVoiceConnectorTermination(DeleteVoiceConnectorTerminationRequest request)` Deletes the termination settings for the specified Amazon Chime Voice Connector.
`DeleteVoiceConnectorTerminationCredentialsResult`	`deleteVoiceConnectorTerminationCredentials(DeleteVoiceConnectorTerminationCredentialsRequest request)` Deletes the specified SIP credentials used by your equipment to authenticate during call termination.
`DisassociatePhoneNumberFromUserResult`	`disassociatePhoneNumberFromUser(DisassociatePhoneNumberFromUserRequest request)` Disassociates the primary provisioned phone number from the specified Amazon Chime user.
`DisassociatePhoneNumbersFromVoiceConnectorResult`	`disassociatePhoneNumbersFromVoiceConnector(DisassociatePhoneNumbersFromVoiceConnectorRequest request)` Disassociates the specified phone number from the specified Amazon Chime Voice Connector.
`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.
`GetBotResult`	`getBot(GetBotRequest request)` Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.
`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.
`GetEventsConfigurationResult`	`getEventsConfiguration(GetEventsConfigurationRequest request)` Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.
`GetGlobalSettingsResult`	`getGlobalSettings(GetGlobalSettingsRequest request)` Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
`GetPhoneNumberResult`	`getPhoneNumber(GetPhoneNumberRequest request)` Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.
`GetPhoneNumberOrderResult`	`getPhoneNumberOrder(GetPhoneNumberOrderRequest request)` Retrieves details for the specified phone number order, such as order creation timestamp, phone numbers in E.164 format, product type, and order status.
`GetUserResult`	`getUser(GetUserRequest request)` Retrieves details for the specified user ID, such as primary email address, license type, and personal meeting PIN.
`GetUserSettingsResult`	`getUserSettings(GetUserSettingsRequest request)` Retrieves settings for the specified user ID, such as any associated phone number settings.
`GetVoiceConnectorResult`	`getVoiceConnector(GetVoiceConnectorRequest request)` Retrieves details for the specified Amazon Chime Voice Connector, such as timestamps, name, outbound host, and encryption requirements.
`GetVoiceConnectorOriginationResult`	`getVoiceConnectorOrigination(GetVoiceConnectorOriginationRequest request)` Retrieves origination setting details for the specified Amazon Chime Voice Connector.
`GetVoiceConnectorTerminationResult`	`getVoiceConnectorTermination(GetVoiceConnectorTerminationRequest request)` Retrieves termination setting details for the specified Amazon Chime Voice Connector.
`GetVoiceConnectorTerminationHealthResult`	`getVoiceConnectorTerminationHealth(GetVoiceConnectorTerminationHealthRequest request)` Retrieves information about the last time a SIP `OPTIONS` ping was received from your SIP infrastructure for the specified Amazon Chime Voice Connector.
`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.
`ListBotsResult`	`listBots(ListBotsRequest request)` Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.
`ListPhoneNumberOrdersResult`	`listPhoneNumberOrders(ListPhoneNumberOrdersRequest request)` Lists the phone number orders for the administrator's Amazon Chime account.
`ListPhoneNumbersResult`	`listPhoneNumbers(ListPhoneNumbersRequest request)` Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, or Amazon Chime Voice Connector.
`ListUsersResult`	`listUsers(ListUsersRequest request)` Lists the users that belong to the specified Amazon Chime account.
`ListVoiceConnectorsResult`	`listVoiceConnectors(ListVoiceConnectorsRequest request)` Lists the Amazon Chime Voice Connectors for the administrator's AWS account.
`ListVoiceConnectorTerminationCredentialsResult`	`listVoiceConnectorTerminationCredentials(ListVoiceConnectorTerminationCredentialsRequest request)` Lists the SIP credentials for the specified Amazon Chime Voice Connector.
`LogoutUserResult`	`logoutUser(LogoutUserRequest request)` Logs out the specified user from all of the devices they are currently logged into.
`PutEventsConfigurationResult`	`putEventsConfiguration(PutEventsConfigurationRequest request)` Creates an events configuration that allows a bot to receive outgoing events sent by Amazon Chime.
`PutVoiceConnectorOriginationResult`	`putVoiceConnectorOrigination(PutVoiceConnectorOriginationRequest request)` Adds origination settings for the specified Amazon Chime Voice Connector.
`PutVoiceConnectorTerminationResult`	`putVoiceConnectorTermination(PutVoiceConnectorTerminationRequest request)` Adds termination settings for the specified Amazon Chime Voice Connector.
`PutVoiceConnectorTerminationCredentialsResult`	`putVoiceConnectorTerminationCredentials(PutVoiceConnectorTerminationCredentialsRequest request)` Adds termination SIP credentials for the specified Amazon Chime Voice Connector.
`RegenerateSecurityTokenResult`	`regenerateSecurityToken(RegenerateSecurityTokenRequest request)` Regenerates the security token for a bot.
`ResetPersonalPINResult`	`resetPersonalPIN(ResetPersonalPINRequest request)` Resets the personal meeting PIN for the specified user on an Amazon Chime account.
`RestorePhoneNumberResult`	`restorePhoneNumber(RestorePhoneNumberRequest request)` Moves a phone number from the Deletion queue back into the phone number Inventory.
`SearchAvailablePhoneNumbersResult`	`searchAvailablePhoneNumbers(SearchAvailablePhoneNumbersRequest request)` Searches phone numbers that can be ordered.
`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.
`UpdateBotResult`	`updateBot(UpdateBotRequest request)` Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.
`UpdateGlobalSettingsResult`	`updateGlobalSettings(UpdateGlobalSettingsRequest request)` Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
`UpdatePhoneNumberResult`	`updatePhoneNumber(UpdatePhoneNumberRequest request)` Updates phone number details, such as product type, for the specified phone number ID.
`UpdateUserResult`	`updateUser(UpdateUserRequest request)` Updates user details for a specified user ID.
`UpdateUserSettingsResult`	`updateUserSettings(UpdateUserSettingsRequest request)` Updates the settings for the specified user, such as phone number settings.
`UpdateVoiceConnectorResult`	`updateVoiceConnector(UpdateVoiceConnectorRequest request)` Updates details for the specified Amazon Chime Voice Connector.

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()
```
  - associatePhoneNumberWithUser
```
public AssociatePhoneNumberWithUserResult associatePhoneNumberWithUser(AssociatePhoneNumberWithUserRequest request)
```
    Associates a phone number with the specified Amazon Chime user.
    
    Specified by:
    
    associatePhoneNumberWithUser in interface AmazonChime
    
    Parameters:
    
    associatePhoneNumberWithUserRequest -
    
    Returns:
    
    Result of the AssociatePhoneNumberWithUser 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
  - associatePhoneNumbersWithVoiceConnector
```
public AssociatePhoneNumbersWithVoiceConnectorResult associatePhoneNumbersWithVoiceConnector(AssociatePhoneNumbersWithVoiceConnectorRequest request)
```
    Associates a phone number with the specified Amazon Chime Voice Connector.
    
    Specified by:
    
    associatePhoneNumbersWithVoiceConnector in interface AmazonChime
    
    Parameters:
    
    associatePhoneNumbersWithVoiceConnectorRequest -
    
    Returns:
    
    Result of the AssociatePhoneNumbersWithVoiceConnector 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
  - batchDeletePhoneNumber
```
public BatchDeletePhoneNumberResult batchDeletePhoneNumber(BatchDeletePhoneNumberRequest request)
```
    Moves phone numbers into the Deletion queue. Phone numbers must be disassociated from any users or Amazon Chime Voice Connectors before they can be deleted.
    
    Phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.
    
    Specified by:
    
    batchDeletePhoneNumber in interface AmazonChime
    
    Parameters:
    
    batchDeletePhoneNumberRequest -
    
    Returns:
    
    Result of the BatchDeletePhoneNumber 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
  - 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 dissasociated 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 can no longer 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
  - batchUpdatePhoneNumber
```
public BatchUpdatePhoneNumberResult batchUpdatePhoneNumber(BatchUpdatePhoneNumberRequest request)
```
    Updates phone number product types. Choose from Amazon Chime Business Calling and Amazon Chime Voice Connector product types. For toll-free numbers, you can use only the Amazon Chime Voice Connector product type.
    
    Specified by:
    
    batchUpdatePhoneNumber in interface AmazonChime
    
    Parameters:
    
    batchUpdatePhoneNumberRequest -
    
    Returns:
    
    Result of the BatchUpdatePhoneNumber 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
  - createBot
```
public CreateBotResult createBot(CreateBotRequest request)
```
    Creates a bot for an Amazon Chime Enterprise account.
    
    Specified by:
    
    createBot in interface AmazonChime
    
    Parameters:
    
    createBotRequest -
    
    Returns:
    
    Result of the CreateBot operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The service is currently unavailable.
    
    ServiceFailureException - The service encountered an unexpected error.
    
    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.
    
    UnauthorizedClientException - The client is not currently authorized to make the request.
    
    ResourceLimitExceededException - The request exceeds the resource limit.
    
    NotFoundException - One or more of the resources in the request does not exist in the system.
    
    See Also:
    
    AWS API Documentation
  - createPhoneNumberOrder
```
public CreatePhoneNumberOrderResult createPhoneNumberOrder(CreatePhoneNumberOrderRequest request)
```
    Creates an order for phone numbers to be provisioned. Choose from Amazon Chime Business Calling and Amazon Chime Voice Connector product types. For toll-free numbers, you can use only the Amazon Chime Voice Connector product type.
    
    Specified by:
    
    createPhoneNumberOrder in interface AmazonChime
    
    Parameters:
    
    createPhoneNumberOrderRequest -
    
    Returns:
    
    Result of the CreatePhoneNumberOrder operation returned by the service.
    
    Throws:
    
    UnauthorizedClientException - The client is not currently authorized to make the request.
    
    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
  - createVoiceConnector
```
public CreateVoiceConnectorResult createVoiceConnector(CreateVoiceConnectorRequest request)
```
    Creates an Amazon Chime Voice Connector under the administrator's AWS account. Enabling CreateVoiceConnectorRequest$RequireEncryption configures your Amazon Chime Voice Connector to use TLS transport for SIP signaling and Secure RTP (SRTP) for media. Inbound calls use TLS transport, and unencrypted outbound calls are blocked.
    
    Specified by:
    
    createVoiceConnector in interface AmazonChime
    
    Parameters:
    
    createVoiceConnectorRequest -
    
    Returns:
    
    Result of the CreateVoiceConnector operation returned by the service.
    
    Throws:
    
    UnauthorizedClientException - The client is not currently authorized to make the request.
    
    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
  - deleteEventsConfiguration
```
public DeleteEventsConfigurationResult deleteEventsConfiguration(DeleteEventsConfigurationRequest request)
```
    Deletes the events configuration that allows a bot to receive outgoing events.
    
    Specified by:
    
    deleteEventsConfiguration in interface AmazonChime
    
    Parameters:
    
    deleteEventsConfigurationRequest -
    
    Returns:
    
    Result of the DeleteEventsConfiguration operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The service is currently unavailable.
    
    ServiceFailureException - The service encountered an unexpected error.
    
    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.
    
    UnauthorizedClientException - The client is not currently authorized to make the request.
    
    ResourceLimitExceededException - The request exceeds the resource limit.
    
    See Also:
    
    AWS API Documentation
  - deletePhoneNumber
```
public DeletePhoneNumberResult deletePhoneNumber(DeletePhoneNumberRequest request)
```
    Moves the specified phone number into the Deletion queue. A phone number must be disassociated from any users or Amazon Chime Voice Connectors before it can be deleted.
    
    Deleted phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.
    
    Specified by:
    
    deletePhoneNumber in interface AmazonChime
    
    Parameters:
    
    deletePhoneNumberRequest -
    
    Returns:
    
    Result of the DeletePhoneNumber 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
  - deleteVoiceConnector
```
public DeleteVoiceConnectorResult deleteVoiceConnector(DeleteVoiceConnectorRequest request)
```
    Deletes the specified Amazon Chime Voice Connector. Any phone numbers assigned to the Amazon Chime Voice Connector must be unassigned from it before it can be deleted.
    
    Specified by:
    
    deleteVoiceConnector in interface AmazonChime
    
    Parameters:
    
    deleteVoiceConnectorRequest -
    
    Returns:
    
    Result of the DeleteVoiceConnector 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
  - deleteVoiceConnectorOrigination
```
public DeleteVoiceConnectorOriginationResult deleteVoiceConnectorOrigination(DeleteVoiceConnectorOriginationRequest request)
```
    Deletes the origination settings for the specified Amazon Chime Voice Connector.
    
    Specified by:
    
    deleteVoiceConnectorOrigination in interface AmazonChime
    
    Parameters:
    
    deleteVoiceConnectorOriginationRequest -
    
    Returns:
    
    Result of the DeleteVoiceConnectorOrigination 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
  - deleteVoiceConnectorTermination
```
public DeleteVoiceConnectorTerminationResult deleteVoiceConnectorTermination(DeleteVoiceConnectorTerminationRequest request)
```
    Deletes the termination settings for the specified Amazon Chime Voice Connector.
    
    Specified by:
    
    deleteVoiceConnectorTermination in interface AmazonChime
    
    Parameters:
    
    deleteVoiceConnectorTerminationRequest -
    
    Returns:
    
    Result of the DeleteVoiceConnectorTermination 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
  - deleteVoiceConnectorTerminationCredentials
```
public DeleteVoiceConnectorTerminationCredentialsResult deleteVoiceConnectorTerminationCredentials(DeleteVoiceConnectorTerminationCredentialsRequest request)
```
    Deletes the specified SIP credentials used by your equipment to authenticate during call termination.
    
    Specified by:
    
    deleteVoiceConnectorTerminationCredentials in interface AmazonChime
    
    Parameters:
    
    deleteVoiceConnectorTerminationCredentialsRequest -
    
    Returns:
    
    Result of the DeleteVoiceConnectorTerminationCredentials 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
  - disassociatePhoneNumberFromUser
```
public DisassociatePhoneNumberFromUserResult disassociatePhoneNumberFromUser(DisassociatePhoneNumberFromUserRequest request)
```
    Disassociates the primary provisioned phone number from the specified Amazon Chime user.
    
    Specified by:
    
    disassociatePhoneNumberFromUser in interface AmazonChime
    
    Parameters:
    
    disassociatePhoneNumberFromUserRequest -
    
    Returns:
    
    Result of the DisassociatePhoneNumberFromUser 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
  - disassociatePhoneNumbersFromVoiceConnector
```
public DisassociatePhoneNumbersFromVoiceConnectorResult disassociatePhoneNumbersFromVoiceConnector(DisassociatePhoneNumbersFromVoiceConnectorRequest request)
```
    Disassociates the specified phone number from the specified Amazon Chime Voice Connector.
    
    Specified by:
    
    disassociatePhoneNumbersFromVoiceConnector in interface AmazonChime
    
    Parameters:
    
    disassociatePhoneNumbersFromVoiceConnectorRequest -
    
    Returns:
    
    Result of the DisassociatePhoneNumbersFromVoiceConnector 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
  - 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
  - getBot
```
public GetBotResult getBot(GetBotRequest request)
```
    Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.
    
    Specified by:
    
    getBot in interface AmazonChime
    
    Parameters:
    
    getBotRequest -
    
    Returns:
    
    Result of the GetBot operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The service is currently unavailable.
    
    ServiceFailureException - The service encountered an unexpected error.
    
    ForbiddenException - The client is permanently forbidden from making the request. For example, when a user tries to create an account from an unsupported Region.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getEventsConfiguration
```
public GetEventsConfigurationResult getEventsConfiguration(GetEventsConfigurationRequest request)
```
    Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.
    
    Specified by:
    
    getEventsConfiguration in interface AmazonChime
    
    Parameters:
    
    getEventsConfigurationRequest -
    
    Returns:
    
    Result of the GetEventsConfiguration operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The service is currently unavailable.
    
    ServiceFailureException - The service encountered an unexpected error.
    
    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.
    
    UnauthorizedClientException - The client is not currently authorized to make the request.
    
    ResourceLimitExceededException - The request exceeds the resource limit.
    
    NotFoundException - One or more of the resources in the request does not exist in the system.
    
    See Also:
    
    AWS API Documentation
  - getGlobalSettings
```
public GetGlobalSettingsResult getGlobalSettings(GetGlobalSettingsRequest request)
```
    Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
    
    Specified by:
    
    getGlobalSettings in interface AmazonChime
    
    Parameters:
    
    getGlobalSettingsRequest -
    
    Returns:
    
    Result of the GetGlobalSettings operation returned by the service.
    
    Throws:
    
    UnauthorizedClientException - The client is not currently authorized to make the request.
    
    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
  - getPhoneNumber
```
public GetPhoneNumberResult getPhoneNumber(GetPhoneNumberRequest request)
```
    Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.
    
    Specified by:
    
    getPhoneNumber in interface AmazonChime
    
    Parameters:
    
    getPhoneNumberRequest -
    
    Returns:
    
    Result of the GetPhoneNumber 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
  - getPhoneNumberOrder
```
public GetPhoneNumberOrderResult getPhoneNumberOrder(GetPhoneNumberOrderRequest request)
```
    Retrieves details for the specified phone number order, such as order creation timestamp, phone numbers in E.164 format, product type, and order status.
    
    Specified by:
    
    getPhoneNumberOrder in interface AmazonChime
    
    Parameters:
    
    getPhoneNumberOrderRequest -
    
    Returns:
    
    Result of the GetPhoneNumberOrder 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
  - 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
  - getUserSettings
```
public GetUserSettingsResult getUserSettings(GetUserSettingsRequest request)
```
    Retrieves settings for the specified user ID, such as any associated phone number settings.
    
    Specified by:
    
    getUserSettings in interface AmazonChime
    
    Parameters:
    
    getUserSettingsRequest -
    
    Returns:
    
    Result of the GetUserSettings 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
  - getVoiceConnector
```
public GetVoiceConnectorResult getVoiceConnector(GetVoiceConnectorRequest request)
```
    Retrieves details for the specified Amazon Chime Voice Connector, such as timestamps, name, outbound host, and encryption requirements.
    
    Specified by:
    
    getVoiceConnector in interface AmazonChime
    
    Parameters:
    
    getVoiceConnectorRequest -
    
    Returns:
    
    Result of the GetVoiceConnector 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
  - getVoiceConnectorOrigination
```
public GetVoiceConnectorOriginationResult getVoiceConnectorOrigination(GetVoiceConnectorOriginationRequest request)
```
    Retrieves origination setting details for the specified Amazon Chime Voice Connector.
    
    Specified by:
    
    getVoiceConnectorOrigination in interface AmazonChime
    
    Parameters:
    
    getVoiceConnectorOriginationRequest -
    
    Returns:
    
    Result of the GetVoiceConnectorOrigination 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
  - getVoiceConnectorTermination
```
public GetVoiceConnectorTerminationResult getVoiceConnectorTermination(GetVoiceConnectorTerminationRequest request)
```
    Retrieves termination setting details for the specified Amazon Chime Voice Connector.
    
    Specified by:
    
    getVoiceConnectorTermination in interface AmazonChime
    
    Parameters:
    
    getVoiceConnectorTerminationRequest -
    
    Returns:
    
    Result of the GetVoiceConnectorTermination 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
  - getVoiceConnectorTerminationHealth
```
public GetVoiceConnectorTerminationHealthResult getVoiceConnectorTerminationHealth(GetVoiceConnectorTerminationHealthRequest request)
```
    Retrieves information about the last time a SIP OPTIONS ping was received from your SIP infrastructure for the specified Amazon Chime Voice Connector.
    
    Specified by:
    
    getVoiceConnectorTerminationHealth in interface AmazonChime
    
    Parameters:
    
    getVoiceConnectorTerminationHealthRequest -
    
    Returns:
    
    Result of the GetVoiceConnectorTerminationHealth 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
  - listBots
```
public ListBotsResult listBots(ListBotsRequest request)
```
    Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.
    
    Specified by:
    
    listBots in interface AmazonChime
    
    Parameters:
    
    listBotsRequest -
    
    Returns:
    
    Result of the ListBots operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The service is currently unavailable.
    
    ServiceFailureException - The service encountered an unexpected error.
    
    ForbiddenException - The client is permanently forbidden from making the request. For example, when a user tries to create an account from an unsupported Region.
    
    UnauthorizedClientException - The client is not currently authorized to make the request.
    
    BadRequestException - The input parameters don't match the service's restrictions.
    
    NotFoundException - One or more of the resources in the request does not exist in the system.
    
    See Also:
    
    AWS API Documentation
  - listPhoneNumberOrders
```
public ListPhoneNumberOrdersResult listPhoneNumberOrders(ListPhoneNumberOrdersRequest request)
```
    Lists the phone number orders for the administrator's Amazon Chime account.
    
    Specified by:
    
    listPhoneNumberOrders in interface AmazonChime
    
    Parameters:
    
    listPhoneNumberOrdersRequest -
    
    Returns:
    
    Result of the ListPhoneNumberOrders operation returned by the service.
    
    Throws:
    
    UnauthorizedClientException - The client is not currently authorized to make the request.
    
    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
  - listPhoneNumbers
```
public ListPhoneNumbersResult listPhoneNumbers(ListPhoneNumbersRequest request)
```
    Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, or Amazon Chime Voice Connector.
    
    Specified by:
    
    listPhoneNumbers in interface AmazonChime
    
    Parameters:
    
    listPhoneNumbersRequest -
    
    Returns:
    
    Result of the ListPhoneNumbers operation returned by the service.
    
    Throws:
    
    UnauthorizedClientException - The client is not currently authorized to make the request.
    
    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
  - listVoiceConnectorTerminationCredentials
```
public ListVoiceConnectorTerminationCredentialsResult listVoiceConnectorTerminationCredentials(ListVoiceConnectorTerminationCredentialsRequest request)
```
    Lists the SIP credentials for the specified Amazon Chime Voice Connector.
    
    Specified by:
    
    listVoiceConnectorTerminationCredentials in interface AmazonChime
    
    Parameters:
    
    listVoiceConnectorTerminationCredentialsRequest -
    
    Returns:
    
    Result of the ListVoiceConnectorTerminationCredentials 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
  - listVoiceConnectors
```
public ListVoiceConnectorsResult listVoiceConnectors(ListVoiceConnectorsRequest request)
```
    Lists the Amazon Chime Voice Connectors for the administrator's AWS account.
    
    Specified by:
    
    listVoiceConnectors in interface AmazonChime
    
    Parameters:
    
    listVoiceConnectorsRequest -
    
    Returns:
    
    Result of the ListVoiceConnectors operation returned by the service.
    
    Throws:
    
    UnauthorizedClientException - The client is not currently authorized to make the request.
    
    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
  - putEventsConfiguration
```
public PutEventsConfigurationResult putEventsConfiguration(PutEventsConfigurationRequest request)
```
    Creates an events configuration that allows a bot to receive outgoing events sent by Amazon Chime. Choose either an HTTPS endpoint or a Lambda function ARN. For more information, see Bot.
    
    Specified by:
    
    putEventsConfiguration in interface AmazonChime
    
    Parameters:
    
    putEventsConfigurationRequest -
    
    Returns:
    
    Result of the PutEventsConfiguration operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The service is currently unavailable.
    
    ServiceFailureException - The service encountered an unexpected error.
    
    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.
    
    UnauthorizedClientException - The client is not currently authorized to make the request.
    
    ResourceLimitExceededException - The request exceeds the resource limit.
    
    NotFoundException - One or more of the resources in the request does not exist in the system.
    
    See Also:
    
    AWS API Documentation
  - putVoiceConnectorOrigination
```
public PutVoiceConnectorOriginationResult putVoiceConnectorOrigination(PutVoiceConnectorOriginationRequest request)
```
    Adds origination settings for the specified Amazon Chime Voice Connector.
    
    Specified by:
    
    putVoiceConnectorOrigination in interface AmazonChime
    
    Parameters:
    
    putVoiceConnectorOriginationRequest -
    
    Returns:
    
    Result of the PutVoiceConnectorOrigination 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
  - putVoiceConnectorTermination
```
public PutVoiceConnectorTerminationResult putVoiceConnectorTermination(PutVoiceConnectorTerminationRequest request)
```
    Adds termination settings for the specified Amazon Chime Voice Connector.
    
    Specified by:
    
    putVoiceConnectorTermination in interface AmazonChime
    
    Parameters:
    
    putVoiceConnectorTerminationRequest -
    
    Returns:
    
    Result of the PutVoiceConnectorTermination 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
  - putVoiceConnectorTerminationCredentials
```
public PutVoiceConnectorTerminationCredentialsResult putVoiceConnectorTerminationCredentials(PutVoiceConnectorTerminationCredentialsRequest request)
```
    Adds termination SIP credentials for the specified Amazon Chime Voice Connector.
    
    Specified by:
    
    putVoiceConnectorTerminationCredentials in interface AmazonChime
    
    Parameters:
    
    putVoiceConnectorTerminationCredentialsRequest -
    
    Returns:
    
    Result of the PutVoiceConnectorTerminationCredentials 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
  - regenerateSecurityToken
```
public RegenerateSecurityTokenResult regenerateSecurityToken(RegenerateSecurityTokenRequest request)
```
    Regenerates the security token for a bot.
    
    Specified by:
    
    regenerateSecurityToken in interface AmazonChime
    
    Parameters:
    
    regenerateSecurityTokenRequest -
    
    Returns:
    
    Result of the RegenerateSecurityToken operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The service is currently unavailable.
    
    ServiceFailureException - The service encountered an unexpected error.
    
    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.
    
    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.
    
    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
  - restorePhoneNumber
```
public RestorePhoneNumberResult restorePhoneNumber(RestorePhoneNumberRequest request)
```
    Moves a phone number from the Deletion queue back into the phone number Inventory.
    
    Specified by:
    
    restorePhoneNumber in interface AmazonChime
    
    Parameters:
    
    restorePhoneNumberRequest -
    
    Returns:
    
    Result of the RestorePhoneNumber 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
  - searchAvailablePhoneNumbers
```
public SearchAvailablePhoneNumbersResult searchAvailablePhoneNumbers(SearchAvailablePhoneNumbersRequest request)
```
    Searches phone numbers that can be ordered.
    
    Specified by:
    
    searchAvailablePhoneNumbers in interface AmazonChime
    
    Parameters:
    
    searchAvailablePhoneNumbersRequest -
    
    Returns:
    
    Result of the SearchAvailablePhoneNumbers operation returned by the service.
    
    Throws:
    
    UnauthorizedClientException - The client is not currently authorized to make the request.
    
    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
  - updateBot
```
public UpdateBotResult updateBot(UpdateBotRequest request)
```
    Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.
    
    Specified by:
    
    updateBot in interface AmazonChime
    
    Parameters:
    
    updateBotRequest -
    
    Returns:
    
    Result of the UpdateBot operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The service is currently unavailable.
    
    ServiceFailureException - The service encountered an unexpected error.
    
    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.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - updateGlobalSettings
```
public UpdateGlobalSettingsResult updateGlobalSettings(UpdateGlobalSettingsRequest request)
```
    Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
    
    Specified by:
    
    updateGlobalSettings in interface AmazonChime
    
    Parameters:
    
    updateGlobalSettingsRequest -
    
    Returns:
    
    Result of the UpdateGlobalSettings operation returned by the service.
    
    Throws:
    
    UnauthorizedClientException - The client is not currently authorized to make the request.
    
    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
  - updatePhoneNumber
```
public UpdatePhoneNumberResult updatePhoneNumber(UpdatePhoneNumberRequest request)
```
    Updates phone number details, such as product type, for the specified phone number ID. For toll-free numbers, you can use only the Amazon Chime Voice Connector product type.
    
    Specified by:
    
    updatePhoneNumber in interface AmazonChime
    
    Parameters:
    
    updatePhoneNumberRequest -
    
    Returns:
    
    Result of the UpdatePhoneNumber 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
  - 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
  - updateUserSettings
```
public UpdateUserSettingsResult updateUserSettings(UpdateUserSettingsRequest request)
```
    Updates the settings for the specified user, such as phone number settings.
    
    Specified by:
    
    updateUserSettings in interface AmazonChime
    
    Parameters:
    
    updateUserSettingsRequest -
    
    Returns:
    
    Result of the UpdateUserSettings 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
  - updateVoiceConnector
```
public UpdateVoiceConnectorResult updateVoiceConnector(UpdateVoiceConnectorRequest request)
```
    Updates details for the specified Amazon Chime Voice Connector.
    
    Specified by:
    
    updateVoiceConnector in interface AmazonChime
    
    Parameters:
    
    updateVoiceConnectorRequest -
    
    Returns:
    
    Result of the UpdateVoiceConnector 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.

Did this page help you?

Class AmazonChimeClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

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

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

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

Method Detail

builder

associatePhoneNumberWithUser

associatePhoneNumbersWithVoiceConnector

batchDeletePhoneNumber

batchSuspendUser

batchUnsuspendUser

batchUpdatePhoneNumber

batchUpdateUser

createAccount

createBot

createPhoneNumberOrder

createVoiceConnector

deleteAccount

deleteEventsConfiguration

deletePhoneNumber

deleteVoiceConnector

deleteVoiceConnectorOrigination

deleteVoiceConnectorTermination

deleteVoiceConnectorTerminationCredentials

disassociatePhoneNumberFromUser

disassociatePhoneNumbersFromVoiceConnector

getAccount

getAccountSettings

getBot

getEventsConfiguration

getGlobalSettings

getPhoneNumber

getPhoneNumberOrder

getUser

getUserSettings

getVoiceConnector

getVoiceConnectorOrigination

getVoiceConnectorTermination

getVoiceConnectorTerminationHealth

inviteUsers

listAccounts

listBots

listPhoneNumberOrders

listPhoneNumbers

listUsers

listVoiceConnectorTerminationCredentials

listVoiceConnectors

logoutUser

putEventsConfiguration

putVoiceConnectorOrigination

putVoiceConnectorTermination

putVoiceConnectorTerminationCredentials

regenerateSecurityToken

resetPersonalPIN

restorePhoneNumber

searchAvailablePhoneNumbers

updateAccount

updateAccountSettings

updateBot

updateGlobalSettings

updatePhoneNumber

updateUser

updateUserSettings

updateVoiceConnector

getCachedResponseMetadata