@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonChimeClient extends AmazonWebServiceClient implements AmazonChime
The Amazon Chime API (application programming interface) is designed for administrators to use to perform key tasks, such as creating and managing Amazon Chime accounts and users. This guide provides detailed information about the Amazon Chime API, including operations, types, inputs and outputs, and error codes.
You can use an AWS SDK, the AWS Command Line Interface (AWS CLI), or the REST API to make API calls. We recommend using an AWS SDK or the AWS CLI. Each API operation includes links to information about using it with a language-specific AWS SDK or the AWS CLI.
You don't need to write code to calculate a signature for request authentication. The SDK clients authenticate your requests by using access keys that you provide. For more information about AWS SDKs, see the AWS Developer Center.
Use your access keys with the AWS CLI to make API calls. For information about setting up the AWS CLI, see Installing the AWS Command Line Interface in the AWS Command Line Interface User Guide. For a list of available Amazon Chime commands, see the Amazon Chime commands in the AWS CLI Command Reference.
If you use REST to make API calls, you must authenticate your request by providing a signature. Amazon Chime supports signature version 4. For more information, see Signature Version 4 Signing Process in the Amazon Web Services General Reference.
When making REST API calls, use the service name chime and REST endpoint
https://service.chime.aws.amazon.com.
Administrative permissions are controlled using AWS Identity and Access Management (IAM). For more information, see Control Access to the Amazon Chime Console in the Amazon Chime Administration Guide.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| 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.
|
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, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitshutdownpublic static AmazonChimeClientBuilder builder()
public AssociatePhoneNumberWithUserResult associatePhoneNumberWithUser(AssociatePhoneNumberWithUserRequest request)
Associates a phone number with the specified Amazon Chime user.
associatePhoneNumberWithUser in interface AmazonChimeassociatePhoneNumberWithUserRequest - 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.public AssociatePhoneNumbersWithVoiceConnectorResult associatePhoneNumbersWithVoiceConnector(AssociatePhoneNumbersWithVoiceConnectorRequest request)
Associates a phone number with the specified Amazon Chime Voice Connector.
associatePhoneNumbersWithVoiceConnector in interface AmazonChimeassociatePhoneNumbersWithVoiceConnectorRequest - 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.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.
batchDeletePhoneNumber in interface AmazonChimebatchDeletePhoneNumberRequest - 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.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.
batchSuspendUser in interface AmazonChimebatchSuspendUserRequest - 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.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.
batchUnsuspendUser in interface AmazonChimebatchUnsuspendUserRequest - 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.public BatchUpdatePhoneNumberResult batchUpdatePhoneNumber(BatchUpdatePhoneNumberRequest request)
Updates phone number product types. Choose from Amazon Chime Business Calling and Amazon Chime Voice Connector product types.
batchUpdatePhoneNumber in interface AmazonChimebatchUpdatePhoneNumberRequest - 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.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.
batchUpdateUser in interface AmazonChimebatchUpdateUserRequest - 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.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.
createAccount in interface AmazonChimecreateAccountRequest - 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.public CreateBotResult createBot(CreateBotRequest request)
Creates a bot for an Amazon Chime Enterprise account.
createBot in interface AmazonChimecreateBotRequest - 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.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.
createPhoneNumberOrder in interface AmazonChimecreatePhoneNumberOrderRequest - 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.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.
createVoiceConnector in interface AmazonChimecreateVoiceConnectorRequest - 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.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.
deleteAccount in interface AmazonChimedeleteAccountRequest - 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.public DeleteEventsConfigurationResult deleteEventsConfiguration(DeleteEventsConfigurationRequest request)
Deletes the events configuration that allows a bot to receive outgoing events.
deleteEventsConfiguration in interface AmazonChimedeleteEventsConfigurationRequest - 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.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.
deletePhoneNumber in interface AmazonChimedeletePhoneNumberRequest - 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.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.
deleteVoiceConnector in interface AmazonChimedeleteVoiceConnectorRequest - 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.public DeleteVoiceConnectorOriginationResult deleteVoiceConnectorOrigination(DeleteVoiceConnectorOriginationRequest request)
Deletes the origination settings for the specified Amazon Chime Voice Connector.
deleteVoiceConnectorOrigination in interface AmazonChimedeleteVoiceConnectorOriginationRequest - 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.public DeleteVoiceConnectorTerminationResult deleteVoiceConnectorTermination(DeleteVoiceConnectorTerminationRequest request)
Deletes the termination settings for the specified Amazon Chime Voice Connector.
deleteVoiceConnectorTermination in interface AmazonChimedeleteVoiceConnectorTerminationRequest - 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.public DeleteVoiceConnectorTerminationCredentialsResult deleteVoiceConnectorTerminationCredentials(DeleteVoiceConnectorTerminationCredentialsRequest request)
Deletes the specified SIP credentials used by your equipment to authenticate during call termination.
deleteVoiceConnectorTerminationCredentials in interface AmazonChimedeleteVoiceConnectorTerminationCredentialsRequest - 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.public DisassociatePhoneNumberFromUserResult disassociatePhoneNumberFromUser(DisassociatePhoneNumberFromUserRequest request)
Disassociates the primary provisioned phone number from the specified Amazon Chime user.
disassociatePhoneNumberFromUser in interface AmazonChimedisassociatePhoneNumberFromUserRequest - 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.public DisassociatePhoneNumbersFromVoiceConnectorResult disassociatePhoneNumbersFromVoiceConnector(DisassociatePhoneNumbersFromVoiceConnectorRequest request)
Disassociates the specified phone number from the specified Amazon Chime Voice Connector.
disassociatePhoneNumbersFromVoiceConnector in interface AmazonChimedisassociatePhoneNumbersFromVoiceConnectorRequest - 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.public GetAccountResult getAccount(GetAccountRequest request)
Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.
getAccount in interface AmazonChimegetAccountRequest - 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.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.
getAccountSettings in interface AmazonChimegetAccountSettingsRequest - 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.public GetBotResult getBot(GetBotRequest request)
Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.
getBot in interface AmazonChimegetBotRequest - 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.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.
getEventsConfiguration in interface AmazonChimegetEventsConfigurationRequest - 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.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.
getGlobalSettings in interface AmazonChimegetGlobalSettingsRequest - 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.public GetPhoneNumberResult getPhoneNumber(GetPhoneNumberRequest request)
Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.
getPhoneNumber in interface AmazonChimegetPhoneNumberRequest - 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.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.
getPhoneNumberOrder in interface AmazonChimegetPhoneNumberOrderRequest - 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.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.
getUser in interface AmazonChimegetUserRequest - 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.public GetUserSettingsResult getUserSettings(GetUserSettingsRequest request)
Retrieves settings for the specified user ID, such as any associated phone number settings.
getUserSettings in interface AmazonChimegetUserSettingsRequest - 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.public GetVoiceConnectorResult getVoiceConnector(GetVoiceConnectorRequest request)
Retrieves details for the specified Amazon Chime Voice Connector, such as timestamps, name, outbound host, and encryption requirements.
getVoiceConnector in interface AmazonChimegetVoiceConnectorRequest - 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.public GetVoiceConnectorOriginationResult getVoiceConnectorOrigination(GetVoiceConnectorOriginationRequest request)
Retrieves origination setting details for the specified Amazon Chime Voice Connector.
getVoiceConnectorOrigination in interface AmazonChimegetVoiceConnectorOriginationRequest - 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.public GetVoiceConnectorTerminationResult getVoiceConnectorTermination(GetVoiceConnectorTerminationRequest request)
Retrieves termination setting details for the specified Amazon Chime Voice Connector.
getVoiceConnectorTermination in interface AmazonChimegetVoiceConnectorTerminationRequest - 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.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.
getVoiceConnectorTerminationHealth in interface AmazonChimegetVoiceConnectorTerminationHealthRequest - 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.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.
inviteUsers in interface AmazonChimeinviteUsersRequest - 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.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.
listAccounts in interface AmazonChimelistAccountsRequest - 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.public ListBotsResult listBots(ListBotsRequest request)
Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.
listBots in interface AmazonChimelistBotsRequest - 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.public ListPhoneNumberOrdersResult listPhoneNumberOrders(ListPhoneNumberOrdersRequest request)
Lists the phone number orders for the administrator's Amazon Chime account.
listPhoneNumberOrders in interface AmazonChimelistPhoneNumberOrdersRequest - 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.public ListPhoneNumbersResult listPhoneNumbers(ListPhoneNumbersRequest request)
Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, or Amazon Chime Voice Connector.
listPhoneNumbers in interface AmazonChimelistPhoneNumbersRequest - 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.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.
listUsers in interface AmazonChimelistUsersRequest - 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.public ListVoiceConnectorTerminationCredentialsResult listVoiceConnectorTerminationCredentials(ListVoiceConnectorTerminationCredentialsRequest request)
Lists the SIP credentials for the specified Amazon Chime Voice Connector.
listVoiceConnectorTerminationCredentials in interface AmazonChimelistVoiceConnectorTerminationCredentialsRequest - 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.public ListVoiceConnectorsResult listVoiceConnectors(ListVoiceConnectorsRequest request)
Lists the Amazon Chime Voice Connectors for the administrator's AWS account.
listVoiceConnectors in interface AmazonChimelistVoiceConnectorsRequest - 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.public LogoutUserResult logoutUser(LogoutUserRequest request)
Logs out the specified user from all of the devices they are currently logged into.
logoutUser in interface AmazonChimelogoutUserRequest - 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.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.
putEventsConfiguration in interface AmazonChimeputEventsConfigurationRequest - 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.public PutVoiceConnectorOriginationResult putVoiceConnectorOrigination(PutVoiceConnectorOriginationRequest request)
Adds origination settings for the specified Amazon Chime Voice Connector.
putVoiceConnectorOrigination in interface AmazonChimeputVoiceConnectorOriginationRequest - 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.public PutVoiceConnectorTerminationResult putVoiceConnectorTermination(PutVoiceConnectorTerminationRequest request)
Adds termination settings for the specified Amazon Chime Voice Connector.
putVoiceConnectorTermination in interface AmazonChimeputVoiceConnectorTerminationRequest - 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.public PutVoiceConnectorTerminationCredentialsResult putVoiceConnectorTerminationCredentials(PutVoiceConnectorTerminationCredentialsRequest request)
Adds termination SIP credentials for the specified Amazon Chime Voice Connector.
putVoiceConnectorTerminationCredentials in interface AmazonChimeputVoiceConnectorTerminationCredentialsRequest - 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.public RegenerateSecurityTokenResult regenerateSecurityToken(RegenerateSecurityTokenRequest request)
Regenerates the security token for a bot.
regenerateSecurityToken in interface AmazonChimeregenerateSecurityTokenRequest - 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.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.
resetPersonalPIN in interface AmazonChimeresetPersonalPINRequest - 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.public RestorePhoneNumberResult restorePhoneNumber(RestorePhoneNumberRequest request)
Moves a phone number from the Deletion queue back into the phone number Inventory.
restorePhoneNumber in interface AmazonChimerestorePhoneNumberRequest - 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.public SearchAvailablePhoneNumbersResult searchAvailablePhoneNumbers(SearchAvailablePhoneNumbersRequest request)
Searches phone numbers that can be ordered.
searchAvailablePhoneNumbers in interface AmazonChimesearchAvailablePhoneNumbersRequest - 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.public UpdateAccountResult updateAccount(UpdateAccountRequest request)
Updates account details for the specified Amazon Chime account. Currently, only account name updates are supported for this action.
updateAccount in interface AmazonChimeupdateAccountRequest - 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.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.
updateAccountSettings in interface AmazonChimeupdateAccountSettingsRequest - 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.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.
updateBot in interface AmazonChimeupdateBotRequest - 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.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.
updateGlobalSettings in interface AmazonChimeupdateGlobalSettingsRequest - 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.public UpdatePhoneNumberResult updatePhoneNumber(UpdatePhoneNumberRequest request)
Updates phone number details, such as product type, for the specified phone number ID.
updatePhoneNumber in interface AmazonChimeupdatePhoneNumberRequest - 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.public UpdateUserResult updateUser(UpdateUserRequest request)
Updates user details for a specified user ID. Currently, only LicenseType updates are supported for
this action.
updateUser in interface AmazonChimeupdateUserRequest - 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.public UpdateUserSettingsResult updateUserSettings(UpdateUserSettingsRequest request)
Updates the settings for the specified user, such as phone number settings.
updateUserSettings in interface AmazonChimeupdateUserSettingsRequest - 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.public UpdateVoiceConnectorResult updateVoiceConnector(UpdateVoiceConnectorRequest request)
Updates details for the specified Amazon Chime Voice Connector.
updateVoiceConnector in interface AmazonChimeupdateVoiceConnectorRequest - 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.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
getCachedResponseMetadata in interface AmazonChimerequest - The originally executed requestCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.