@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonChime
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonChime
instead.
The Amazon Chime API (application programming interface) is designed for administrators to use to perform key tasks, such as creating and managing Amazon Chime accounts and users. This guide provides detailed information about the Amazon Chime API, including operations, types, inputs and outputs, and error codes.
You can use an AWS SDK, the AWS Command Line Interface (AWS CLI), or the REST API to make API calls. We recommend using an AWS SDK or the AWS CLI. Each API operation includes links to information about using it with a language-specific AWS SDK or the AWS CLI.
You don't need to write code to calculate a signature for request authentication. The SDK clients authenticate your requests by using access keys that you provide. For more information about AWS SDKs, see the AWS Developer Center.
Use your access keys with the AWS CLI to make API calls. For information about setting up the AWS CLI, see Installing the AWS Command Line Interface in the AWS Command Line Interface User Guide. For a list of available Amazon Chime commands, see the Amazon Chime commands in the AWS CLI Command Reference.
If you use REST to make API calls, you must authenticate your request by providing a signature. Amazon Chime supports signature version 4. For more information, see Signature Version 4 Signing Process in the Amazon Web Services General Reference.
When making REST API calls, use the service name chime
and REST endpoint
https://service.chime.aws.amazon.com
.
Administrative permissions are controlled using AWS Identity and Access Management (IAM). For more information, see Control Access to the Amazon Chime Console in the Amazon Chime Administration Guide.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
Modifier and Type | Method and Description |
---|---|
AssociatePhoneNumbersWithVoiceConnectorResult |
associatePhoneNumbersWithVoiceConnector(AssociatePhoneNumbersWithVoiceConnectorRequest associatePhoneNumbersWithVoiceConnectorRequest)
Associates a phone number with the specified Amazon Chime Voice Connector.
|
AssociatePhoneNumberWithUserResult |
associatePhoneNumberWithUser(AssociatePhoneNumberWithUserRequest associatePhoneNumberWithUserRequest)
Associates a phone number with the specified Amazon Chime user.
|
BatchDeletePhoneNumberResult |
batchDeletePhoneNumber(BatchDeletePhoneNumberRequest batchDeletePhoneNumberRequest)
Moves phone numbers into the Deletion queue.
|
BatchSuspendUserResult |
batchSuspendUser(BatchSuspendUserRequest batchSuspendUserRequest)
Suspends up to 50 users from a
Team or EnterpriseLWA Amazon Chime account. |
BatchUnsuspendUserResult |
batchUnsuspendUser(BatchUnsuspendUserRequest batchUnsuspendUserRequest)
Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime
EnterpriseLWA account. |
BatchUpdatePhoneNumberResult |
batchUpdatePhoneNumber(BatchUpdatePhoneNumberRequest batchUpdatePhoneNumberRequest)
Updates phone number product types.
|
BatchUpdateUserResult |
batchUpdateUser(BatchUpdateUserRequest batchUpdateUserRequest)
Updates user details within the UpdateUserRequestItem object for up to 20 users for the specified Amazon
Chime account.
|
CreateAccountResult |
createAccount(CreateAccountRequest createAccountRequest)
Creates an Amazon Chime account under the administrator's AWS account.
|
CreateBotResult |
createBot(CreateBotRequest createBotRequest)
Creates a bot for an Amazon Chime Enterprise account.
|
CreatePhoneNumberOrderResult |
createPhoneNumberOrder(CreatePhoneNumberOrderRequest createPhoneNumberOrderRequest)
Creates an order for phone numbers to be provisioned.
|
CreateVoiceConnectorResult |
createVoiceConnector(CreateVoiceConnectorRequest createVoiceConnectorRequest)
Creates an Amazon Chime Voice Connector under the administrator's AWS account.
|
DeleteAccountResult |
deleteAccount(DeleteAccountRequest deleteAccountRequest)
Deletes the specified Amazon Chime account.
|
DeleteEventsConfigurationResult |
deleteEventsConfiguration(DeleteEventsConfigurationRequest deleteEventsConfigurationRequest)
Deletes the events configuration that allows a bot to receive outgoing events.
|
DeletePhoneNumberResult |
deletePhoneNumber(DeletePhoneNumberRequest deletePhoneNumberRequest)
Moves the specified phone number into the Deletion queue.
|
DeleteVoiceConnectorResult |
deleteVoiceConnector(DeleteVoiceConnectorRequest deleteVoiceConnectorRequest)
Deletes the specified Amazon Chime Voice Connector.
|
DeleteVoiceConnectorOriginationResult |
deleteVoiceConnectorOrigination(DeleteVoiceConnectorOriginationRequest deleteVoiceConnectorOriginationRequest)
Deletes the origination settings for the specified Amazon Chime Voice Connector.
|
DeleteVoiceConnectorTerminationResult |
deleteVoiceConnectorTermination(DeleteVoiceConnectorTerminationRequest deleteVoiceConnectorTerminationRequest)
Deletes the termination settings for the specified Amazon Chime Voice Connector.
|
DeleteVoiceConnectorTerminationCredentialsResult |
deleteVoiceConnectorTerminationCredentials(DeleteVoiceConnectorTerminationCredentialsRequest deleteVoiceConnectorTerminationCredentialsRequest)
Deletes the specified SIP credentials used by your equipment to authenticate during call termination.
|
DisassociatePhoneNumberFromUserResult |
disassociatePhoneNumberFromUser(DisassociatePhoneNumberFromUserRequest disassociatePhoneNumberFromUserRequest)
Disassociates the primary provisioned phone number from the specified Amazon Chime user.
|
DisassociatePhoneNumbersFromVoiceConnectorResult |
disassociatePhoneNumbersFromVoiceConnector(DisassociatePhoneNumbersFromVoiceConnectorRequest disassociatePhoneNumbersFromVoiceConnectorRequest)
Disassociates the specified phone number from the specified Amazon Chime Voice Connector.
|
GetAccountResult |
getAccount(GetAccountRequest getAccountRequest)
Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.
|
GetAccountSettingsResult |
getAccountSettings(GetAccountSettingsRequest getAccountSettingsRequest)
Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dial out
settings.
|
GetBotResult |
getBot(GetBotRequest getBotRequest)
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 getEventsConfigurationRequest)
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 getGlobalSettingsRequest)
Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon
Chime Voice Connector settings.
|
GetPhoneNumberResult |
getPhoneNumber(GetPhoneNumberRequest getPhoneNumberRequest)
Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.
|
GetPhoneNumberOrderResult |
getPhoneNumberOrder(GetPhoneNumberOrderRequest getPhoneNumberOrderRequest)
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 getUserRequest)
Retrieves details for the specified user ID, such as primary email address, license type, and personal meeting
PIN.
|
GetUserSettingsResult |
getUserSettings(GetUserSettingsRequest getUserSettingsRequest)
Retrieves settings for the specified user ID, such as any associated phone number settings.
|
GetVoiceConnectorResult |
getVoiceConnector(GetVoiceConnectorRequest getVoiceConnectorRequest)
Retrieves details for the specified Amazon Chime Voice Connector, such as timestamps, name, outbound host, and
encryption requirements.
|
GetVoiceConnectorOriginationResult |
getVoiceConnectorOrigination(GetVoiceConnectorOriginationRequest getVoiceConnectorOriginationRequest)
Retrieves origination setting details for the specified Amazon Chime Voice Connector.
|
GetVoiceConnectorTerminationResult |
getVoiceConnectorTermination(GetVoiceConnectorTerminationRequest getVoiceConnectorTerminationRequest)
Retrieves termination setting details for the specified Amazon Chime Voice Connector.
|
GetVoiceConnectorTerminationHealthResult |
getVoiceConnectorTerminationHealth(GetVoiceConnectorTerminationHealthRequest getVoiceConnectorTerminationHealthRequest)
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 inviteUsersRequest)
Sends email invites to as many as 50 users, inviting them to the specified Amazon Chime
Team
account. |
ListAccountsResult |
listAccounts(ListAccountsRequest listAccountsRequest)
Lists the Amazon Chime accounts under the administrator's AWS account.
|
ListBotsResult |
listBots(ListBotsRequest listBotsRequest)
Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.
|
ListPhoneNumberOrdersResult |
listPhoneNumberOrders(ListPhoneNumberOrdersRequest listPhoneNumberOrdersRequest)
Lists the phone number orders for the administrator's Amazon Chime account.
|
ListPhoneNumbersResult |
listPhoneNumbers(ListPhoneNumbersRequest listPhoneNumbersRequest)
Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, or Amazon Chime Voice
Connector.
|
ListUsersResult |
listUsers(ListUsersRequest listUsersRequest)
Lists the users that belong to the specified Amazon Chime account.
|
ListVoiceConnectorsResult |
listVoiceConnectors(ListVoiceConnectorsRequest listVoiceConnectorsRequest)
Lists the Amazon Chime Voice Connectors for the administrator's AWS account.
|
ListVoiceConnectorTerminationCredentialsResult |
listVoiceConnectorTerminationCredentials(ListVoiceConnectorTerminationCredentialsRequest listVoiceConnectorTerminationCredentialsRequest)
Lists the SIP credentials for the specified Amazon Chime Voice Connector.
|
LogoutUserResult |
logoutUser(LogoutUserRequest logoutUserRequest)
Logs out the specified user from all of the devices they are currently logged into.
|
PutEventsConfigurationResult |
putEventsConfiguration(PutEventsConfigurationRequest putEventsConfigurationRequest)
Creates an events configuration that allows a bot to receive outgoing events sent by Amazon Chime.
|
PutVoiceConnectorOriginationResult |
putVoiceConnectorOrigination(PutVoiceConnectorOriginationRequest putVoiceConnectorOriginationRequest)
Adds origination settings for the specified Amazon Chime Voice Connector.
|
PutVoiceConnectorTerminationResult |
putVoiceConnectorTermination(PutVoiceConnectorTerminationRequest putVoiceConnectorTerminationRequest)
Adds termination settings for the specified Amazon Chime Voice Connector.
|
PutVoiceConnectorTerminationCredentialsResult |
putVoiceConnectorTerminationCredentials(PutVoiceConnectorTerminationCredentialsRequest putVoiceConnectorTerminationCredentialsRequest)
Adds termination SIP credentials for the specified Amazon Chime Voice Connector.
|
RegenerateSecurityTokenResult |
regenerateSecurityToken(RegenerateSecurityTokenRequest regenerateSecurityTokenRequest)
Regenerates the security token for a bot.
|
ResetPersonalPINResult |
resetPersonalPIN(ResetPersonalPINRequest resetPersonalPINRequest)
Resets the personal meeting PIN for the specified user on an Amazon Chime account.
|
RestorePhoneNumberResult |
restorePhoneNumber(RestorePhoneNumberRequest restorePhoneNumberRequest)
Moves a phone number from the Deletion queue back into the phone number Inventory.
|
SearchAvailablePhoneNumbersResult |
searchAvailablePhoneNumbers(SearchAvailablePhoneNumbersRequest searchAvailablePhoneNumbersRequest)
Searches phone numbers that can be ordered.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
UpdateAccountResult |
updateAccount(UpdateAccountRequest updateAccountRequest)
Updates account details for the specified Amazon Chime account.
|
UpdateAccountSettingsResult |
updateAccountSettings(UpdateAccountSettingsRequest updateAccountSettingsRequest)
Updates the settings for the specified Amazon Chime account.
|
UpdateBotResult |
updateBot(UpdateBotRequest updateBotRequest)
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 updateGlobalSettingsRequest)
Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon
Chime Voice Connector settings.
|
UpdatePhoneNumberResult |
updatePhoneNumber(UpdatePhoneNumberRequest updatePhoneNumberRequest)
Updates phone number details, such as product type, for the specified phone number ID.
|
UpdateUserResult |
updateUser(UpdateUserRequest updateUserRequest)
Updates user details for a specified user ID.
|
UpdateUserSettingsResult |
updateUserSettings(UpdateUserSettingsRequest updateUserSettingsRequest)
Updates the settings for the specified user, such as phone number settings.
|
UpdateVoiceConnectorResult |
updateVoiceConnector(UpdateVoiceConnectorRequest updateVoiceConnectorRequest)
Updates details for the specified Amazon Chime Voice Connector.
|
static final String ENDPOINT_PREFIX
AssociatePhoneNumberWithUserResult associatePhoneNumberWithUser(AssociatePhoneNumberWithUserRequest associatePhoneNumberWithUserRequest)
Associates a phone number with the specified Amazon Chime user.
associatePhoneNumberWithUserRequest
- 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.AssociatePhoneNumbersWithVoiceConnectorResult associatePhoneNumbersWithVoiceConnector(AssociatePhoneNumbersWithVoiceConnectorRequest associatePhoneNumbersWithVoiceConnectorRequest)
Associates a phone number with the specified Amazon Chime Voice Connector.
associatePhoneNumbersWithVoiceConnectorRequest
- 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.BatchDeletePhoneNumberResult batchDeletePhoneNumber(BatchDeletePhoneNumberRequest batchDeletePhoneNumberRequest)
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.
batchDeletePhoneNumberRequest
- 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.BatchSuspendUserResult batchSuspendUser(BatchSuspendUserRequest batchSuspendUserRequest)
Suspends up to 50 users from a Team
or EnterpriseLWA
Amazon Chime account. For more
information about different account types, see Managing Your Amazon Chime
Accounts in the Amazon Chime Administration Guide.
Users suspended from a Team
account are 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.
batchSuspendUserRequest
- 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.BatchUnsuspendUserResult batchUnsuspendUser(BatchUnsuspendUserRequest batchUnsuspendUserRequest)
Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime
EnterpriseLWA
account. Only users on EnterpriseLWA
accounts can be unsuspended using
this action. For more information about different account types, see Managing Your Amazon Chime
Accounts in the Amazon Chime Administration Guide.
Previously suspended users who are unsuspended using this action are returned to Registered
status.
Users who are not previously suspended are ignored.
batchUnsuspendUserRequest
- 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.BatchUpdatePhoneNumberResult batchUpdatePhoneNumber(BatchUpdatePhoneNumberRequest batchUpdatePhoneNumberRequest)
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.
batchUpdatePhoneNumberRequest
- 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.BatchUpdateUserResult batchUpdateUser(BatchUpdateUserRequest batchUpdateUserRequest)
Updates user details within the UpdateUserRequestItem object for up to 20 users for the specified Amazon
Chime account. Currently, only LicenseType
updates are supported for this action.
batchUpdateUserRequest
- 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.CreateAccountResult createAccount(CreateAccountRequest createAccountRequest)
Creates an Amazon Chime account under the administrator's AWS account. Only Team
account types are
currently supported for this action. For more information about different account types, see Managing Your Amazon Chime
Accounts in the Amazon Chime Administration Guide.
createAccountRequest
- 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.CreateBotResult createBot(CreateBotRequest createBotRequest)
Creates a bot for an Amazon Chime Enterprise account.
createBotRequest
- 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.CreatePhoneNumberOrderResult createPhoneNumberOrder(CreatePhoneNumberOrderRequest createPhoneNumberOrderRequest)
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.
createPhoneNumberOrderRequest
- 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.CreateVoiceConnectorResult createVoiceConnector(CreateVoiceConnectorRequest createVoiceConnectorRequest)
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.
createVoiceConnectorRequest
- 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.DeleteAccountResult deleteAccount(DeleteAccountRequest deleteAccountRequest)
Deletes the specified Amazon Chime account. You must suspend all users before deleting a Team
account. You can use the BatchSuspendUser action to do so.
For EnterpriseLWA
and EnterpriseAD
accounts, you must release the claimed domains for
your Amazon Chime account before deletion. As soon as you release the domain, all users under that account are
suspended.
Deleted accounts appear in your Disabled
accounts list for 90 days. To restore a deleted account
from your Disabled
accounts list, you must contact AWS Support.
After 90 days, deleted accounts are permanently removed from your Disabled
accounts list.
deleteAccountRequest
- 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.DeleteEventsConfigurationResult deleteEventsConfiguration(DeleteEventsConfigurationRequest deleteEventsConfigurationRequest)
Deletes the events configuration that allows a bot to receive outgoing events.
deleteEventsConfigurationRequest
- 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.DeletePhoneNumberResult deletePhoneNumber(DeletePhoneNumberRequest deletePhoneNumberRequest)
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.
deletePhoneNumberRequest
- 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.DeleteVoiceConnectorResult deleteVoiceConnector(DeleteVoiceConnectorRequest deleteVoiceConnectorRequest)
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.
deleteVoiceConnectorRequest
- 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.DeleteVoiceConnectorOriginationResult deleteVoiceConnectorOrigination(DeleteVoiceConnectorOriginationRequest deleteVoiceConnectorOriginationRequest)
Deletes the origination settings for the specified Amazon Chime Voice Connector.
deleteVoiceConnectorOriginationRequest
- 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.DeleteVoiceConnectorTerminationResult deleteVoiceConnectorTermination(DeleteVoiceConnectorTerminationRequest deleteVoiceConnectorTerminationRequest)
Deletes the termination settings for the specified Amazon Chime Voice Connector.
deleteVoiceConnectorTerminationRequest
- 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.DeleteVoiceConnectorTerminationCredentialsResult deleteVoiceConnectorTerminationCredentials(DeleteVoiceConnectorTerminationCredentialsRequest deleteVoiceConnectorTerminationCredentialsRequest)
Deletes the specified SIP credentials used by your equipment to authenticate during call termination.
deleteVoiceConnectorTerminationCredentialsRequest
- 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.DisassociatePhoneNumberFromUserResult disassociatePhoneNumberFromUser(DisassociatePhoneNumberFromUserRequest disassociatePhoneNumberFromUserRequest)
Disassociates the primary provisioned phone number from the specified Amazon Chime user.
disassociatePhoneNumberFromUserRequest
- 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.DisassociatePhoneNumbersFromVoiceConnectorResult disassociatePhoneNumbersFromVoiceConnector(DisassociatePhoneNumbersFromVoiceConnectorRequest disassociatePhoneNumbersFromVoiceConnectorRequest)
Disassociates the specified phone number from the specified Amazon Chime Voice Connector.
disassociatePhoneNumbersFromVoiceConnectorRequest
- 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.GetAccountResult getAccount(GetAccountRequest getAccountRequest)
Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.
getAccountRequest
- 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.GetAccountSettingsResult getAccountSettings(GetAccountSettingsRequest getAccountSettingsRequest)
Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dial out settings. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.
getAccountSettingsRequest
- 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.GetBotResult getBot(GetBotRequest getBotRequest)
Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.
getBotRequest
- 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.GetEventsConfigurationResult getEventsConfiguration(GetEventsConfigurationRequest getEventsConfigurationRequest)
Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.
getEventsConfigurationRequest
- 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.GetGlobalSettingsResult getGlobalSettings(GetGlobalSettingsRequest getGlobalSettingsRequest)
Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
getGlobalSettingsRequest
- 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.GetPhoneNumberResult getPhoneNumber(GetPhoneNumberRequest getPhoneNumberRequest)
Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.
getPhoneNumberRequest
- 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.GetPhoneNumberOrderResult getPhoneNumberOrder(GetPhoneNumberOrderRequest getPhoneNumberOrderRequest)
Retrieves details for the specified phone number order, such as order creation timestamp, phone numbers in E.164 format, product type, and order status.
getPhoneNumberOrderRequest
- 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.GetUserResult getUser(GetUserRequest getUserRequest)
Retrieves details for the specified user ID, such as primary email address, license type, and personal meeting PIN.
To retrieve user details with an email address instead of a user ID, use the ListUsers action, and then filter by email address.
getUserRequest
- 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.GetUserSettingsResult getUserSettings(GetUserSettingsRequest getUserSettingsRequest)
Retrieves settings for the specified user ID, such as any associated phone number settings.
getUserSettingsRequest
- 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.GetVoiceConnectorResult getVoiceConnector(GetVoiceConnectorRequest getVoiceConnectorRequest)
Retrieves details for the specified Amazon Chime Voice Connector, such as timestamps, name, outbound host, and encryption requirements.
getVoiceConnectorRequest
- 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.GetVoiceConnectorOriginationResult getVoiceConnectorOrigination(GetVoiceConnectorOriginationRequest getVoiceConnectorOriginationRequest)
Retrieves origination setting details for the specified Amazon Chime Voice Connector.
getVoiceConnectorOriginationRequest
- 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.GetVoiceConnectorTerminationResult getVoiceConnectorTermination(GetVoiceConnectorTerminationRequest getVoiceConnectorTerminationRequest)
Retrieves termination setting details for the specified Amazon Chime Voice Connector.
getVoiceConnectorTerminationRequest
- 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.GetVoiceConnectorTerminationHealthResult getVoiceConnectorTerminationHealth(GetVoiceConnectorTerminationHealthRequest getVoiceConnectorTerminationHealthRequest)
Retrieves information about the last time a SIP OPTIONS
ping was received from your SIP
infrastructure for the specified Amazon Chime Voice Connector.
getVoiceConnectorTerminationHealthRequest
- 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.InviteUsersResult inviteUsers(InviteUsersRequest inviteUsersRequest)
Sends email invites to as many as 50 users, inviting them to the specified Amazon Chime Team
account. Only Team
account types are currently supported for this action.
inviteUsersRequest
- 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.ListAccountsResult listAccounts(ListAccountsRequest listAccountsRequest)
Lists the Amazon Chime accounts under the administrator's AWS account. You can filter accounts by account name prefix. To find out which Amazon Chime account a user belongs to, you can filter by the user's email address, which returns one account result.
listAccountsRequest
- 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.ListBotsResult listBots(ListBotsRequest listBotsRequest)
Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.
listBotsRequest
- 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.ListPhoneNumberOrdersResult listPhoneNumberOrders(ListPhoneNumberOrdersRequest listPhoneNumberOrdersRequest)
Lists the phone number orders for the administrator's Amazon Chime account.
listPhoneNumberOrdersRequest
- 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.ListPhoneNumbersResult listPhoneNumbers(ListPhoneNumbersRequest listPhoneNumbersRequest)
Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, or Amazon Chime Voice Connector.
listPhoneNumbersRequest
- 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.ListUsersResult listUsers(ListUsersRequest listUsersRequest)
Lists the users that belong to the specified Amazon Chime account. You can specify an email address to list only the user that the email address belongs to.
listUsersRequest
- 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.ListVoiceConnectorTerminationCredentialsResult listVoiceConnectorTerminationCredentials(ListVoiceConnectorTerminationCredentialsRequest listVoiceConnectorTerminationCredentialsRequest)
Lists the SIP credentials for the specified Amazon Chime Voice Connector.
listVoiceConnectorTerminationCredentialsRequest
- 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.ListVoiceConnectorsResult listVoiceConnectors(ListVoiceConnectorsRequest listVoiceConnectorsRequest)
Lists the Amazon Chime Voice Connectors for the administrator's AWS account.
listVoiceConnectorsRequest
- 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.LogoutUserResult logoutUser(LogoutUserRequest logoutUserRequest)
Logs out the specified user from all of the devices they are currently logged into.
logoutUserRequest
- 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.PutEventsConfigurationResult putEventsConfiguration(PutEventsConfigurationRequest putEventsConfigurationRequest)
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.
putEventsConfigurationRequest
- 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.PutVoiceConnectorOriginationResult putVoiceConnectorOrigination(PutVoiceConnectorOriginationRequest putVoiceConnectorOriginationRequest)
Adds origination settings for the specified Amazon Chime Voice Connector.
putVoiceConnectorOriginationRequest
- 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.PutVoiceConnectorTerminationResult putVoiceConnectorTermination(PutVoiceConnectorTerminationRequest putVoiceConnectorTerminationRequest)
Adds termination settings for the specified Amazon Chime Voice Connector.
putVoiceConnectorTerminationRequest
- 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.PutVoiceConnectorTerminationCredentialsResult putVoiceConnectorTerminationCredentials(PutVoiceConnectorTerminationCredentialsRequest putVoiceConnectorTerminationCredentialsRequest)
Adds termination SIP credentials for the specified Amazon Chime Voice Connector.
putVoiceConnectorTerminationCredentialsRequest
- 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.RegenerateSecurityTokenResult regenerateSecurityToken(RegenerateSecurityTokenRequest regenerateSecurityTokenRequest)
Regenerates the security token for a bot.
regenerateSecurityTokenRequest
- 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.ResetPersonalPINResult resetPersonalPIN(ResetPersonalPINRequest resetPersonalPINRequest)
Resets the personal meeting PIN for the specified user on an Amazon Chime account. Returns the User object with the updated personal meeting PIN.
resetPersonalPINRequest
- 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.RestorePhoneNumberResult restorePhoneNumber(RestorePhoneNumberRequest restorePhoneNumberRequest)
Moves a phone number from the Deletion queue back into the phone number Inventory.
restorePhoneNumberRequest
- 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.SearchAvailablePhoneNumbersResult searchAvailablePhoneNumbers(SearchAvailablePhoneNumbersRequest searchAvailablePhoneNumbersRequest)
Searches phone numbers that can be ordered.
searchAvailablePhoneNumbersRequest
- 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.UpdateAccountResult updateAccount(UpdateAccountRequest updateAccountRequest)
Updates account details for the specified Amazon Chime account. Currently, only account name updates are supported for this action.
updateAccountRequest
- 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.UpdateAccountSettingsResult updateAccountSettings(UpdateAccountSettingsRequest updateAccountSettingsRequest)
Updates the settings for the specified Amazon Chime account. You can update settings for remote control of shared screens, or for the dial-out option. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.
updateAccountSettingsRequest
- 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.UpdateBotResult updateBot(UpdateBotRequest updateBotRequest)
Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.
updateBotRequest
- 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.UpdateGlobalSettingsResult updateGlobalSettings(UpdateGlobalSettingsRequest updateGlobalSettingsRequest)
Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
updateGlobalSettingsRequest
- 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.UpdatePhoneNumberResult updatePhoneNumber(UpdatePhoneNumberRequest updatePhoneNumberRequest)
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.
updatePhoneNumberRequest
- 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.UpdateUserResult updateUser(UpdateUserRequest updateUserRequest)
Updates user details for a specified user ID. Currently, only LicenseType
updates are supported for
this action.
updateUserRequest
- 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.UpdateUserSettingsResult updateUserSettings(UpdateUserSettingsRequest updateUserSettingsRequest)
Updates the settings for the specified user, such as phone number settings.
updateUserSettingsRequest
- 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.UpdateVoiceConnectorResult updateVoiceConnector(UpdateVoiceConnectorRequest updateVoiceConnectorRequest)
Updates details for the specified Amazon Chime Voice Connector.
updateVoiceConnectorRequest
- 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.void shutdown()
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 a request.
request
- The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.