@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 developers to perform key tasks, such as creating and managing Amazon Chime accounts, users, and Voice Connectors. This guide provides detailed information about the Amazon Chime API, including operations, types, inputs and outputs, and error codes. It also includes some server-side API actions to use with the Amazon Chime SDK. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
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 Identity and Access Management for Amazon Chime in the Amazon Chime Administration Guide.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
AssociatePhoneNumbersWithVoiceConnectorResult |
associatePhoneNumbersWithVoiceConnector(AssociatePhoneNumbersWithVoiceConnectorRequest request)
Associates phone numbers with the specified Amazon Chime Voice Connector.
|
AssociatePhoneNumbersWithVoiceConnectorGroupResult |
associatePhoneNumbersWithVoiceConnectorGroup(AssociatePhoneNumbersWithVoiceConnectorGroupRequest request)
Associates phone numbers with the specified Amazon Chime Voice Connector group.
|
AssociatePhoneNumberWithUserResult |
associatePhoneNumberWithUser(AssociatePhoneNumberWithUserRequest request)
Associates a phone number with the specified Amazon Chime user.
|
AssociateSigninDelegateGroupsWithAccountResult |
associateSigninDelegateGroupsWithAccount(AssociateSigninDelegateGroupsWithAccountRequest request)
Associates the specified sign-in delegate groups with the specified Amazon Chime account.
|
BatchCreateAttendeeResult |
batchCreateAttendee(BatchCreateAttendeeRequest request)
Creates up to 100 new attendees for an active Amazon Chime SDK meeting.
|
BatchCreateRoomMembershipResult |
batchCreateRoomMembership(BatchCreateRoomMembershipRequest request)
Adds up to 50 members to a chat room in an Amazon Chime Enterprise account.
|
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 or calling names.
|
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.
|
CreateAttendeeResult |
createAttendee(CreateAttendeeRequest request)
Creates a new attendee for an active Amazon Chime SDK meeting.
|
CreateBotResult |
createBot(CreateBotRequest request)
Creates a bot for an Amazon Chime Enterprise account.
|
CreateMeetingResult |
createMeeting(CreateMeetingRequest request)
Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees.
|
CreatePhoneNumberOrderResult |
createPhoneNumberOrder(CreatePhoneNumberOrderRequest request)
Creates an order for phone numbers to be provisioned.
|
CreateProxySessionResult |
createProxySession(CreateProxySessionRequest request)
Creates a proxy session on the specified Amazon Chime Voice Connector for the specified participant phone
numbers.
|
CreateRoomResult |
createRoom(CreateRoomRequest request)
Creates a chat room for the specified Amazon Chime Enterprise account.
|
CreateRoomMembershipResult |
createRoomMembership(CreateRoomMembershipRequest request)
Adds a member to a chat room in an Amazon Chime Enterprise account.
|
CreateUserResult |
createUser(CreateUserRequest request)
Creates a user under the specified Amazon Chime account.
|
CreateVoiceConnectorResult |
createVoiceConnector(CreateVoiceConnectorRequest request)
Creates an Amazon Chime Voice Connector under the administrator's AWS account.
|
CreateVoiceConnectorGroupResult |
createVoiceConnectorGroup(CreateVoiceConnectorGroupRequest request)
Creates an Amazon Chime Voice Connector group under the administrator's AWS account.
|
DeleteAccountResult |
deleteAccount(DeleteAccountRequest request)
Deletes the specified Amazon Chime account.
|
DeleteAttendeeResult |
deleteAttendee(DeleteAttendeeRequest request)
Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their
JoinToken . |
DeleteEventsConfigurationResult |
deleteEventsConfiguration(DeleteEventsConfigurationRequest request)
Deletes the events configuration that allows a bot to receive outgoing events.
|
DeleteMeetingResult |
deleteMeeting(DeleteMeetingRequest request)
Deletes the specified Amazon Chime SDK meeting.
|
DeletePhoneNumberResult |
deletePhoneNumber(DeletePhoneNumberRequest request)
Moves the specified phone number into the Deletion queue.
|
DeleteProxySessionResult |
deleteProxySession(DeleteProxySessionRequest request)
Deletes the specified proxy session from the specified Amazon Chime Voice Connector.
|
DeleteRoomResult |
deleteRoom(DeleteRoomRequest request)
Deletes a chat room in an Amazon Chime Enterprise account.
|
DeleteRoomMembershipResult |
deleteRoomMembership(DeleteRoomMembershipRequest request)
Removes a member from a chat room in an Amazon Chime Enterprise account.
|
DeleteVoiceConnectorResult |
deleteVoiceConnector(DeleteVoiceConnectorRequest request)
Deletes the specified Amazon Chime Voice Connector.
|
DeleteVoiceConnectorGroupResult |
deleteVoiceConnectorGroup(DeleteVoiceConnectorGroupRequest request)
Deletes the specified Amazon Chime Voice Connector group.
|
DeleteVoiceConnectorOriginationResult |
deleteVoiceConnectorOrigination(DeleteVoiceConnectorOriginationRequest request)
Deletes the origination settings for the specified Amazon Chime Voice Connector.
|
DeleteVoiceConnectorProxyResult |
deleteVoiceConnectorProxy(DeleteVoiceConnectorProxyRequest request)
Deletes the proxy configuration from the specified Amazon Chime Voice Connector.
|
DeleteVoiceConnectorStreamingConfigurationResult |
deleteVoiceConnectorStreamingConfiguration(DeleteVoiceConnectorStreamingConfigurationRequest request)
Deletes the streaming configuration 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 numbers from the specified Amazon Chime Voice Connector.
|
DisassociatePhoneNumbersFromVoiceConnectorGroupResult |
disassociatePhoneNumbersFromVoiceConnectorGroup(DisassociatePhoneNumbersFromVoiceConnectorGroupRequest request)
Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector group.
|
DisassociateSigninDelegateGroupsFromAccountResult |
disassociateSigninDelegateGroupsFromAccount(DisassociateSigninDelegateGroupsFromAccountRequest request)
Disassociates the specified sign-in delegate groups from the specified Amazon Chime account.
|
GetAccountResult |
getAccount(GetAccountRequest request)
Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.
|
GetAccountSettingsResult |
getAccountSettings(GetAccountSettingsRequest request)
Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dial out
settings.
|
GetAttendeeResult |
getAttendee(GetAttendeeRequest request)
Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID.
|
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.
|
GetMeetingResult |
getMeeting(GetMeetingRequest request)
Gets the Amazon Chime SDK meeting details for the specified meeting ID.
|
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.
|
GetPhoneNumberSettingsResult |
getPhoneNumberSettings(GetPhoneNumberSettingsRequest request)
Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling
name.
|
GetProxySessionResult |
getProxySession(GetProxySessionRequest request)
Gets the specified proxy session details for the specified Amazon Chime Voice Connector.
|
GetRoomResult |
getRoom(GetRoomRequest request)
Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.
|
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.
|
GetVoiceConnectorGroupResult |
getVoiceConnectorGroup(GetVoiceConnectorGroupRequest request)
Retrieves details for the specified Amazon Chime Voice Connector group, such as timestamps, name, and associated
VoiceConnectorItems . |
GetVoiceConnectorLoggingConfigurationResult |
getVoiceConnectorLoggingConfiguration(GetVoiceConnectorLoggingConfigurationRequest request)
Retrieves the logging configuration details for the specified Amazon Chime Voice Connector.
|
GetVoiceConnectorOriginationResult |
getVoiceConnectorOrigination(GetVoiceConnectorOriginationRequest request)
Retrieves origination setting details for the specified Amazon Chime Voice Connector.
|
GetVoiceConnectorProxyResult |
getVoiceConnectorProxy(GetVoiceConnectorProxyRequest request)
Gets the proxy configuration details for the specified Amazon Chime Voice Connector.
|
GetVoiceConnectorStreamingConfigurationResult |
getVoiceConnectorStreamingConfiguration(GetVoiceConnectorStreamingConfigurationRequest request)
Retrieves the streaming configuration 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 to a maximum of 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.
|
ListAttendeesResult |
listAttendees(ListAttendeesRequest request)
Lists the attendees for the specified Amazon Chime SDK meeting.
|
ListAttendeeTagsResult |
listAttendeeTags(ListAttendeeTagsRequest request)
Lists the tags applied to an Amazon Chime SDK attendee resource.
|
ListBotsResult |
listBots(ListBotsRequest request)
Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.
|
ListMeetingsResult |
listMeetings(ListMeetingsRequest request)
Lists up to 100 active Amazon Chime SDK meetings.
|
ListMeetingTagsResult |
listMeetingTags(ListMeetingTagsRequest request)
Lists the tags applied to an Amazon Chime SDK meeting resource.
|
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, Amazon Chime Voice Connector,
or Amazon Chime Voice Connector group.
|
ListProxySessionsResult |
listProxySessions(ListProxySessionsRequest request)
Lists the proxy sessions for the specified Amazon Chime Voice Connector.
|
ListRoomMembershipsResult |
listRoomMemberships(ListRoomMembershipsRequest request)
Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members'
IDs, email addresses, and names.
|
ListRoomsResult |
listRooms(ListRoomsRequest request)
Lists the room details for the specified Amazon Chime Enterprise account.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Lists the tags applied to an Amazon Chime SDK meeting resource.
|
ListUsersResult |
listUsers(ListUsersRequest request)
Lists the users that belong to the specified Amazon Chime account.
|
ListVoiceConnectorGroupsResult |
listVoiceConnectorGroups(ListVoiceConnectorGroupsRequest request)
Lists the Amazon Chime Voice Connector groups for the administrator's AWS 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.
|
PutVoiceConnectorLoggingConfigurationResult |
putVoiceConnectorLoggingConfiguration(PutVoiceConnectorLoggingConfigurationRequest request)
Adds a logging configuration for the specified Amazon Chime Voice Connector.
|
PutVoiceConnectorOriginationResult |
putVoiceConnectorOrigination(PutVoiceConnectorOriginationRequest request)
Adds origination settings for the specified Amazon Chime Voice Connector.
|
PutVoiceConnectorProxyResult |
putVoiceConnectorProxy(PutVoiceConnectorProxyRequest request)
Puts the specified proxy configuration to the specified Amazon Chime Voice Connector.
|
PutVoiceConnectorStreamingConfigurationResult |
putVoiceConnectorStreamingConfiguration(PutVoiceConnectorStreamingConfigurationRequest request)
Adds a streaming configuration 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.
|
TagAttendeeResult |
tagAttendee(TagAttendeeRequest request)
Applies the specified tags to the specified Amazon Chime SDK attendee.
|
TagMeetingResult |
tagMeeting(TagMeetingRequest request)
Applies the specified tags to the specified Amazon Chime SDK meeting.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Applies the specified tags to the specified Amazon Chime SDK meeting resource.
|
UntagAttendeeResult |
untagAttendee(UntagAttendeeRequest request)
Untags the specified tags from the specified Amazon Chime SDK attendee.
|
UntagMeetingResult |
untagMeeting(UntagMeetingRequest request)
Untags the specified tags from the specified Amazon Chime SDK meeting.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Untags the specified tags from the specified Amazon Chime SDK meeting resource.
|
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 or calling name, for the specified phone number ID.
|
UpdatePhoneNumberSettingsResult |
updatePhoneNumberSettings(UpdatePhoneNumberSettingsRequest request)
Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name.
|
UpdateProxySessionResult |
updateProxySession(UpdateProxySessionRequest request)
Updates the specified proxy session details, such as voice or SMS capabilities.
|
UpdateRoomResult |
updateRoom(UpdateRoomRequest request)
Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account.
|
UpdateRoomMembershipResult |
updateRoomMembership(UpdateRoomMembershipRequest request)
Updates room membership details, such as the member role, for a room in an Amazon Chime Enterprise account.
|
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.
|
UpdateVoiceConnectorGroupResult |
updateVoiceConnectorGroup(UpdateVoiceConnectorGroupRequest request)
Updates details for the specified Amazon Chime Voice Connector group, such as the name and Amazon Chime Voice
Connector priority ranking.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
shutdown
public static AmazonChimeClientBuilder builder()
public AssociatePhoneNumberWithUserResult associatePhoneNumberWithUser(AssociatePhoneNumberWithUserRequest request)
Associates a phone number with the specified Amazon Chime user.
associatePhoneNumberWithUser
in interface AmazonChime
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.AccessDeniedException
- You don't have permissions to perform the requested operation.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 phone numbers with the specified Amazon Chime Voice Connector.
associatePhoneNumbersWithVoiceConnector
in interface AmazonChime
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.AccessDeniedException
- You don't have permissions to perform the requested operation.ThrottledClientException
- The client exceeded its request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.public AssociatePhoneNumbersWithVoiceConnectorGroupResult associatePhoneNumbersWithVoiceConnectorGroup(AssociatePhoneNumbersWithVoiceConnectorGroupRequest request)
Associates phone numbers with the specified Amazon Chime Voice Connector group.
associatePhoneNumbersWithVoiceConnectorGroup
in interface AmazonChime
associatePhoneNumbersWithVoiceConnectorGroupRequest
- 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.AccessDeniedException
- You don't have permissions to perform the requested operation.ThrottledClientException
- The client exceeded its request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.public AssociateSigninDelegateGroupsWithAccountResult associateSigninDelegateGroupsWithAccount(AssociateSigninDelegateGroupsWithAccountRequest request)
Associates the specified sign-in delegate groups with the specified Amazon Chime account.
associateSigninDelegateGroupsWithAccount
in interface AmazonChime
associateSigninDelegateGroupsWithAccountRequest
- 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 BatchCreateAttendeeResult batchCreateAttendee(BatchCreateAttendeeRequest request)
Creates up to 100 new attendees for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
batchCreateAttendee
in interface AmazonChime
batchCreateAttendeeRequest
- 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.NotFoundException
- One or more of the resources in the request does not exist in the system.ResourceLimitExceededException
- The request exceeds the resource limit.ThrottledClientException
- The client exceeded its request rate limit.UnauthorizedClientException
- The client is not currently authorized to make the request.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.public BatchCreateRoomMembershipResult batchCreateRoomMembership(BatchCreateRoomMembershipRequest request)
Adds up to 50 members to a chat room in an Amazon Chime Enterprise account. Members can be either users or bots. The member role designates whether the member is a chat room administrator or a general chat room member.
batchCreateRoomMembership
in interface AmazonChime
batchCreateRoomMembershipRequest
- 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 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 AmazonChime
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.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 disassociated 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 AmazonChime
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.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 AmazonChime
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.public BatchUpdatePhoneNumberResult batchUpdatePhoneNumber(BatchUpdatePhoneNumberRequest request)
Updates phone number product types or calling names. You can update one attribute at a time for each
UpdatePhoneNumberRequestItem
. For example, you can update either the product type or the calling
name.
For product types, choose from Amazon Chime Business Calling and Amazon Chime Voice Connector. For toll-free numbers, you must use the Amazon Chime Voice Connector product type.
Updates to outbound calling names can take up to 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.
batchUpdatePhoneNumber
in interface AmazonChime
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.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 AmazonChime
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.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 AmazonChime
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.public CreateAttendeeResult createAttendee(CreateAttendeeRequest request)
Creates a new attendee for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
createAttendee
in interface AmazonChime
createAttendeeRequest
- 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.NotFoundException
- One or more of the resources in the request does not exist in the system.ResourceLimitExceededException
- The request exceeds the resource limit.ThrottledClientException
- The client exceeded its request rate limit.UnauthorizedClientException
- The client is not currently authorized to make the request.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 AmazonChime
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.ThrottledClientException
- The client exceeded its request rate limit.public CreateMeetingResult createMeeting(CreateMeetingRequest request)
Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
createMeeting
in interface AmazonChime
createMeetingRequest
- 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.ResourceLimitExceededException
- The request exceeds the resource limit.ThrottledClientException
- The client exceeded its request rate limit.UnauthorizedClientException
- The client is not currently authorized to make the request.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.public CreatePhoneNumberOrderResult createPhoneNumberOrder(CreatePhoneNumberOrderRequest request)
Creates an order for phone numbers to be provisioned. Choose from Amazon Chime Business Calling and Amazon Chime Voice Connector product types. For toll-free numbers, you must use the Amazon Chime Voice Connector product type.
createPhoneNumberOrder
in interface AmazonChime
createPhoneNumberOrderRequest
- 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.AccessDeniedException
- You don't have permissions to perform the requested operation.UnauthorizedClientException
- The client is not currently authorized to make the request.ThrottledClientException
- The client exceeded its request rate limit.ResourceLimitExceededException
- The request exceeds the resource limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.public CreateProxySessionResult createProxySession(CreateProxySessionRequest request)
Creates a proxy session on the specified Amazon Chime Voice Connector for the specified participant phone numbers.
createProxySession
in interface AmazonChime
createProxySessionRequest
- 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 CreateRoomResult createRoom(CreateRoomRequest request)
Creates a chat room for the specified Amazon Chime Enterprise account.
createRoom
in interface AmazonChime
createRoomRequest
- 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.UnauthorizedClientException
- The client is not currently authorized to make the request.ResourceLimitExceededException
- The request exceeds the resource limit.ThrottledClientException
- The client exceeded its request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.public CreateRoomMembershipResult createRoomMembership(CreateRoomMembershipRequest request)
Adds a member to a chat room in an Amazon Chime Enterprise account. A member can be either a user or a bot. The member role designates whether the member is a chat room administrator or a general chat room member.
createRoomMembership
in interface AmazonChime
createRoomMembershipRequest
- ConflictException
- The request could not be processed because of conflict in the current state of the resource.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.ResourceLimitExceededException
- The request exceeds the resource limit.ThrottledClientException
- The client exceeded its request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.public CreateUserResult createUser(CreateUserRequest request)
Creates a user under the specified Amazon Chime account.
createUser
in interface AmazonChime
createUserRequest
- 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.ConflictException
- The request could not be processed because of conflict in the current state of the resource.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. You can choose to create an Amazon Chime Voice Connector in a specific AWS Region.
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 AmazonChime
createVoiceConnectorRequest
- 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.AccessDeniedException
- You don't have permissions to perform the requested operation.UnauthorizedClientException
- The client is not currently authorized to make the request.ThrottledClientException
- The client exceeded its request rate limit.ResourceLimitExceededException
- The request exceeds the resource limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.public CreateVoiceConnectorGroupResult createVoiceConnectorGroup(CreateVoiceConnectorGroupRequest request)
Creates an Amazon Chime Voice Connector group under the administrator's AWS account. You can associate Amazon
Chime Voice Connectors with the Amazon Chime Voice Connector group by including VoiceConnectorItems
in the request.
You can include Amazon Chime Voice Connectors from different AWS Regions in your group. This creates a fault tolerant mechanism for fallback in case of availability events.
createVoiceConnectorGroup
in interface AmazonChime
createVoiceConnectorGroupRequest
- 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.AccessDeniedException
- You don't have permissions to perform the requested operation.UnauthorizedClientException
- The client is not currently authorized to make the request.ThrottledClientException
- The client exceeded its request rate limit.ResourceLimitExceededException
- The request exceeds the resource 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 AmazonChime
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.public DeleteAttendeeResult deleteAttendee(DeleteAttendeeRequest request)
Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their JoinToken
.
Attendees are automatically deleted when a Amazon Chime SDK meeting is deleted. For more information about the
Amazon Chime SDK, see Using the Amazon
Chime SDK in the Amazon Chime Developer Guide.
deleteAttendee
in interface AmazonChime
deleteAttendeeRequest
- 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.NotFoundException
- One or more of the resources in the request does not exist in the system.UnauthorizedClientException
- The client is not currently authorized to make the request.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 AmazonChime
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.public DeleteMeetingResult deleteMeeting(DeleteMeetingRequest request)
Deletes the specified Amazon Chime SDK meeting. When a meeting is deleted, its attendees are also deleted and clients can no longer join it. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
deleteMeeting
in interface AmazonChime
deleteMeetingRequest
- 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.NotFoundException
- One or more of the resources in the request does not exist in the system.UnauthorizedClientException
- The client is not currently authorized to make the request.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.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 AmazonChime
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.public DeleteProxySessionResult deleteProxySession(DeleteProxySessionRequest request)
Deletes the specified proxy session from the specified Amazon Chime Voice Connector.
deleteProxySession
in interface AmazonChime
deleteProxySessionRequest
- 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 DeleteRoomResult deleteRoom(DeleteRoomRequest request)
Deletes a chat room in an Amazon Chime Enterprise account.
deleteRoom
in interface AmazonChime
deleteRoomRequest
- 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.NotFoundException
- One or more of the resources in the request does not exist in the system.UnauthorizedClientException
- The client is not currently authorized to make the request.ThrottledClientException
- The client exceeded its request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.public DeleteRoomMembershipResult deleteRoomMembership(DeleteRoomMembershipRequest request)
Removes a member from a chat room in an Amazon Chime Enterprise account.
deleteRoomMembership
in interface AmazonChime
deleteRoomMembershipRequest
- 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 DeleteVoiceConnectorResult deleteVoiceConnector(DeleteVoiceConnectorRequest request)
Deletes the specified Amazon Chime Voice Connector. Any phone numbers associated with the Amazon Chime Voice Connector must be disassociated from it before it can be deleted.
deleteVoiceConnector
in interface AmazonChime
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.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 DeleteVoiceConnectorGroupResult deleteVoiceConnectorGroup(DeleteVoiceConnectorGroupRequest request)
Deletes the specified Amazon Chime Voice Connector group. Any VoiceConnectorItems
and phone numbers
associated with the group must be removed before it can be deleted.
deleteVoiceConnectorGroup
in interface AmazonChime
deleteVoiceConnectorGroupRequest
- 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.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 DeleteVoiceConnectorOriginationResult deleteVoiceConnectorOrigination(DeleteVoiceConnectorOriginationRequest request)
Deletes the origination settings for the specified Amazon Chime Voice Connector.
deleteVoiceConnectorOrigination
in interface AmazonChime
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.public DeleteVoiceConnectorProxyResult deleteVoiceConnectorProxy(DeleteVoiceConnectorProxyRequest request)
Deletes the proxy configuration from the specified Amazon Chime Voice Connector.
deleteVoiceConnectorProxy
in interface AmazonChime
deleteVoiceConnectorProxyRequest
- 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 DeleteVoiceConnectorStreamingConfigurationResult deleteVoiceConnectorStreamingConfiguration(DeleteVoiceConnectorStreamingConfigurationRequest request)
Deletes the streaming configuration for the specified Amazon Chime Voice Connector.
deleteVoiceConnectorStreamingConfiguration
in interface AmazonChime
deleteVoiceConnectorStreamingConfigurationRequest
- 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 AmazonChime
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.public DeleteVoiceConnectorTerminationCredentialsResult deleteVoiceConnectorTerminationCredentials(DeleteVoiceConnectorTerminationCredentialsRequest request)
Deletes the specified SIP credentials used by your equipment to authenticate during call termination.
deleteVoiceConnectorTerminationCredentials
in interface AmazonChime
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.public DisassociatePhoneNumberFromUserResult disassociatePhoneNumberFromUser(DisassociatePhoneNumberFromUserRequest request)
Disassociates the primary provisioned phone number from the specified Amazon Chime user.
disassociatePhoneNumberFromUser
in interface AmazonChime
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.public DisassociatePhoneNumbersFromVoiceConnectorResult disassociatePhoneNumbersFromVoiceConnector(DisassociatePhoneNumbersFromVoiceConnectorRequest request)
Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector.
disassociatePhoneNumbersFromVoiceConnector
in interface AmazonChime
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.public DisassociatePhoneNumbersFromVoiceConnectorGroupResult disassociatePhoneNumbersFromVoiceConnectorGroup(DisassociatePhoneNumbersFromVoiceConnectorGroupRequest request)
Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector group.
disassociatePhoneNumbersFromVoiceConnectorGroup
in interface AmazonChime
disassociatePhoneNumbersFromVoiceConnectorGroupRequest
- 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 DisassociateSigninDelegateGroupsFromAccountResult disassociateSigninDelegateGroupsFromAccount(DisassociateSigninDelegateGroupsFromAccountRequest request)
Disassociates the specified sign-in delegate groups from the specified Amazon Chime account.
disassociateSigninDelegateGroupsFromAccount
in interface AmazonChime
disassociateSigninDelegateGroupsFromAccountRequest
- 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 AmazonChime
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.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 AmazonChime
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.public GetAttendeeResult getAttendee(GetAttendeeRequest request)
Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
getAttendee
in interface AmazonChime
getAttendeeRequest
- 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.NotFoundException
- One or more of the resources in the request does not exist in the system.ThrottledClientException
- The client exceeded its request rate limit.UnauthorizedClientException
- The client is not currently authorized to make the request.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 AmazonChime
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.ThrottledClientException
- The client exceeded its request rate limit.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 AmazonChime
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.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 AmazonChime
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.public GetMeetingResult getMeeting(GetMeetingRequest request)
Gets the Amazon Chime SDK meeting details for the specified meeting ID. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
getMeeting
in interface AmazonChime
getMeetingRequest
- 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.NotFoundException
- One or more of the resources in the request does not exist in the system.ThrottledClientException
- The client exceeded its request rate limit.UnauthorizedClientException
- The client is not currently authorized to make the request.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 AmazonChime
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.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 AmazonChime
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.public GetPhoneNumberSettingsResult getPhoneNumberSettings(GetPhoneNumberSettingsRequest request)
Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.
getPhoneNumberSettings
in interface AmazonChime
getPhoneNumberSettingsRequest
- 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 GetProxySessionResult getProxySession(GetProxySessionRequest request)
Gets the specified proxy session details for the specified Amazon Chime Voice Connector.
getProxySession
in interface AmazonChime
getProxySessionRequest
- 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 GetRoomResult getRoom(GetRoomRequest request)
Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.
getRoom
in interface AmazonChime
getRoomRequest
- 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.NotFoundException
- One or more of the resources in the request does not exist in the system.UnauthorizedClientException
- The client is not currently authorized to make the request.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 AmazonChime
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.public GetUserSettingsResult getUserSettings(GetUserSettingsRequest request)
Retrieves settings for the specified user ID, such as any associated phone number settings.
getUserSettings
in interface AmazonChime
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.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 AmazonChime
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.public GetVoiceConnectorGroupResult getVoiceConnectorGroup(GetVoiceConnectorGroupRequest request)
Retrieves details for the specified Amazon Chime Voice Connector group, such as timestamps, name, and associated
VoiceConnectorItems
.
getVoiceConnectorGroup
in interface AmazonChime
getVoiceConnectorGroupRequest
- 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 GetVoiceConnectorLoggingConfigurationResult getVoiceConnectorLoggingConfiguration(GetVoiceConnectorLoggingConfigurationRequest request)
Retrieves the logging configuration details for the specified Amazon Chime Voice Connector. Shows whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.
getVoiceConnectorLoggingConfiguration
in interface AmazonChime
getVoiceConnectorLoggingConfigurationRequest
- 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 AmazonChime
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.public GetVoiceConnectorProxyResult getVoiceConnectorProxy(GetVoiceConnectorProxyRequest request)
Gets the proxy configuration details for the specified Amazon Chime Voice Connector.
getVoiceConnectorProxy
in interface AmazonChime
getVoiceConnectorProxyRequest
- 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 GetVoiceConnectorStreamingConfigurationResult getVoiceConnectorStreamingConfiguration(GetVoiceConnectorStreamingConfigurationRequest request)
Retrieves the streaming configuration details for the specified Amazon Chime Voice Connector. Shows whether media streaming is enabled for sending to Amazon Kinesis. It also shows the retention period, in hours, for the Amazon Kinesis data.
getVoiceConnectorStreamingConfiguration
in interface AmazonChime
getVoiceConnectorStreamingConfigurationRequest
- 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 AmazonChime
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.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 AmazonChime
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.public InviteUsersResult inviteUsers(InviteUsersRequest request)
Sends email to a maximum of 50 users, inviting them to the specified Amazon Chime Team
account. Only
Team
account types are currently supported for this action.
inviteUsers
in interface AmazonChime
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.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 AmazonChime
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.public ListAttendeeTagsResult listAttendeeTags(ListAttendeeTagsRequest request)
Lists the tags applied to an Amazon Chime SDK attendee resource.
listAttendeeTags
in interface AmazonChime
listAttendeeTagsRequest
- 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.NotFoundException
- One or more of the resources in the request does not exist in the system.ThrottledClientException
- The client exceeded its request rate limit.UnauthorizedClientException
- The client is not currently authorized to make the request.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.public ListAttendeesResult listAttendees(ListAttendeesRequest request)
Lists the attendees for the specified Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
listAttendees
in interface AmazonChime
listAttendeesRequest
- 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.NotFoundException
- One or more of the resources in the request does not exist in the system.ThrottledClientException
- The client exceeded its request rate limit.UnauthorizedClientException
- The client is not currently authorized to make the request.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 AmazonChime
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.ThrottledClientException
- The client exceeded its request rate limit.public ListMeetingTagsResult listMeetingTags(ListMeetingTagsRequest request)
Lists the tags applied to an Amazon Chime SDK meeting resource.
listMeetingTags
in interface AmazonChime
listMeetingTagsRequest
- 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.NotFoundException
- One or more of the resources in the request does not exist in the system.ThrottledClientException
- The client exceeded its request rate limit.UnauthorizedClientException
- The client is not currently authorized to make the request.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.public ListMeetingsResult listMeetings(ListMeetingsRequest request)
Lists up to 100 active Amazon Chime SDK meetings. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
listMeetings
in interface AmazonChime
listMeetingsRequest
- 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.UnauthorizedClientException
- The client is not currently authorized to make the request.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.public ListPhoneNumberOrdersResult listPhoneNumberOrders(ListPhoneNumberOrdersRequest request)
Lists the phone number orders for the administrator's Amazon Chime account.
listPhoneNumberOrders
in interface AmazonChime
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.public ListPhoneNumbersResult listPhoneNumbers(ListPhoneNumbersRequest request)
Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.
listPhoneNumbers
in interface AmazonChime
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.public ListProxySessionsResult listProxySessions(ListProxySessionsRequest request)
Lists the proxy sessions for the specified Amazon Chime Voice Connector.
listProxySessions
in interface AmazonChime
listProxySessionsRequest
- 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 ListRoomMembershipsResult listRoomMemberships(ListRoomMembershipsRequest request)
Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members' IDs, email addresses, and names.
listRoomMemberships
in interface AmazonChime
listRoomMembershipsRequest
- 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.UnauthorizedClientException
- The client is not currently authorized to make the request.ThrottledClientException
- The client exceeded its request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.public ListRoomsResult listRooms(ListRoomsRequest request)
Lists the room details for the specified Amazon Chime Enterprise account. Optionally, filter the results by a member ID (user ID or bot ID) to see a list of rooms that the member belongs to.
listRooms
in interface AmazonChime
listRoomsRequest
- 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.UnauthorizedClientException
- The client is not currently authorized to make the request.ThrottledClientException
- The client exceeded its request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Lists the tags applied to an Amazon Chime SDK meeting resource.
listTagsForResource
in interface AmazonChime
listTagsForResourceRequest
- 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.NotFoundException
- One or more of the resources in the request does not exist in the system.UnauthorizedClientException
- The client is not currently authorized to make the request.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 AmazonChime
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.public ListVoiceConnectorGroupsResult listVoiceConnectorGroups(ListVoiceConnectorGroupsRequest request)
Lists the Amazon Chime Voice Connector groups for the administrator's AWS account.
listVoiceConnectorGroups
in interface AmazonChime
listVoiceConnectorGroupsRequest
- 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 ListVoiceConnectorTerminationCredentialsResult listVoiceConnectorTerminationCredentials(ListVoiceConnectorTerminationCredentialsRequest request)
Lists the SIP credentials for the specified Amazon Chime Voice Connector.
listVoiceConnectorTerminationCredentials
in interface AmazonChime
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.public ListVoiceConnectorsResult listVoiceConnectors(ListVoiceConnectorsRequest request)
Lists the Amazon Chime Voice Connectors for the administrator's AWS account.
listVoiceConnectors
in interface AmazonChime
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.public LogoutUserResult logoutUser(LogoutUserRequest request)
Logs out the specified user from all of the devices they are currently logged into.
logoutUser
in interface AmazonChime
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.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 AmazonChime
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.public PutVoiceConnectorLoggingConfigurationResult putVoiceConnectorLoggingConfiguration(PutVoiceConnectorLoggingConfigurationRequest request)
Adds a logging configuration for the specified Amazon Chime Voice Connector. The logging configuration specifies whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.
putVoiceConnectorLoggingConfiguration
in interface AmazonChime
putVoiceConnectorLoggingConfigurationRequest
- 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 PutVoiceConnectorOriginationResult putVoiceConnectorOrigination(PutVoiceConnectorOriginationRequest request)
Adds origination settings for the specified Amazon Chime Voice Connector.
putVoiceConnectorOrigination
in interface AmazonChime
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.public PutVoiceConnectorProxyResult putVoiceConnectorProxy(PutVoiceConnectorProxyRequest request)
Puts the specified proxy configuration to the specified Amazon Chime Voice Connector.
putVoiceConnectorProxy
in interface AmazonChime
putVoiceConnectorProxyRequest
- UnauthorizedClientException
- The client is not currently authorized to make the request.AccessDeniedException
- You don't have permissions to perform the requested operation.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 PutVoiceConnectorStreamingConfigurationResult putVoiceConnectorStreamingConfiguration(PutVoiceConnectorStreamingConfigurationRequest request)
Adds a streaming configuration for the specified Amazon Chime Voice Connector. The streaming configuration specifies whether media streaming is enabled for sending to Amazon Kinesis. It also sets the retention period, in hours, for the Amazon Kinesis data.
putVoiceConnectorStreamingConfiguration
in interface AmazonChime
putVoiceConnectorStreamingConfigurationRequest
- 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 AmazonChime
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.AccessDeniedException
- You don't have permissions to perform the requested operation.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 AmazonChime
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.public RegenerateSecurityTokenResult regenerateSecurityToken(RegenerateSecurityTokenRequest request)
Regenerates the security token for a bot.
regenerateSecurityToken
in interface AmazonChime
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.ThrottledClientException
- The client exceeded its request rate limit.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 AmazonChime
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.public RestorePhoneNumberResult restorePhoneNumber(RestorePhoneNumberRequest request)
Moves a phone number from the Deletion queue back into the phone number Inventory.
restorePhoneNumber
in interface AmazonChime
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.ResourceLimitExceededException
- The request exceeds the resource 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 AmazonChime
searchAvailablePhoneNumbersRequest
- 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.AccessDeniedException
- You don't have permissions to perform the requested operation.UnauthorizedClientException
- The client is not currently authorized to make the request.ThrottledClientException
- The client exceeded its request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.public TagAttendeeResult tagAttendee(TagAttendeeRequest request)
Applies the specified tags to the specified Amazon Chime SDK attendee.
tagAttendee
in interface AmazonChime
tagAttendeeRequest
- 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.NotFoundException
- One or more of the resources in the request does not exist in the system.ResourceLimitExceededException
- The request exceeds the resource limit.ThrottledClientException
- The client exceeded its request rate limit.UnauthorizedClientException
- The client is not currently authorized to make the request.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.public TagMeetingResult tagMeeting(TagMeetingRequest request)
Applies the specified tags to the specified Amazon Chime SDK meeting.
tagMeeting
in interface AmazonChime
tagMeetingRequest
- 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.NotFoundException
- One or more of the resources in the request does not exist in the system.ResourceLimitExceededException
- The request exceeds the resource limit.ThrottledClientException
- The client exceeded its request rate limit.UnauthorizedClientException
- The client is not currently authorized to make the request.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.public TagResourceResult tagResource(TagResourceRequest request)
Applies the specified tags to the specified Amazon Chime SDK meeting resource.
tagResource
in interface AmazonChime
tagResourceRequest
- 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.NotFoundException
- One or more of the resources in the request does not exist in the system.UnauthorizedClientException
- The client is not currently authorized to make the request.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.public UntagAttendeeResult untagAttendee(UntagAttendeeRequest request)
Untags the specified tags from the specified Amazon Chime SDK attendee.
untagAttendee
in interface AmazonChime
untagAttendeeRequest
- 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.NotFoundException
- One or more of the resources in the request does not exist in the system.UnauthorizedClientException
- The client is not currently authorized to make the request.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.public UntagMeetingResult untagMeeting(UntagMeetingRequest request)
Untags the specified tags from the specified Amazon Chime SDK meeting.
untagMeeting
in interface AmazonChime
untagMeetingRequest
- 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.NotFoundException
- One or more of the resources in the request does not exist in the system.UnauthorizedClientException
- The client is not currently authorized to make the request.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.public UntagResourceResult untagResource(UntagResourceRequest request)
Untags the specified tags from the specified Amazon Chime SDK meeting resource.
untagResource
in interface AmazonChime
untagResourceRequest
- 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.NotFoundException
- One or more of the resources in the request does not exist in the system.UnauthorizedClientException
- The client is not currently authorized to make the request.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 AmazonChime
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.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 AmazonChime
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.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 AmazonChime
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.ThrottledClientException
- The client exceeded its request rate limit.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 AmazonChime
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.public UpdatePhoneNumberResult updatePhoneNumber(UpdatePhoneNumberRequest request)
Updates phone number details, such as product type or calling name, for the specified phone number ID. You can update one phone number detail at a time. For example, you can update either the product type or the calling name in one action.
For toll-free numbers, you must use the Amazon Chime Voice Connector product type.
Updates to outbound calling names can take up to 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.
updatePhoneNumber
in interface AmazonChime
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.public UpdatePhoneNumberSettingsResult updatePhoneNumberSettings(UpdatePhoneNumberSettingsRequest request)
Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name. You can update the default outbound calling name once every seven days. Outbound calling names can take up to 72 hours to update.
updatePhoneNumberSettings
in interface AmazonChime
updatePhoneNumberSettingsRequest
- 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 UpdateProxySessionResult updateProxySession(UpdateProxySessionRequest request)
Updates the specified proxy session details, such as voice or SMS capabilities.
updateProxySession
in interface AmazonChime
updateProxySessionRequest
- 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 UpdateRoomResult updateRoom(UpdateRoomRequest request)
Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account.
updateRoom
in interface AmazonChime
updateRoomRequest
- 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.NotFoundException
- One or more of the resources in the request does not exist in the system.UnauthorizedClientException
- The client is not currently authorized to make the request.ThrottledClientException
- The client exceeded its request rate limit.ServiceUnavailableException
- The service is currently unavailable.ServiceFailureException
- The service encountered an unexpected error.public UpdateRoomMembershipResult updateRoomMembership(UpdateRoomMembershipRequest request)
Updates room membership details, such as the member role, for a room in an Amazon Chime Enterprise account. The member role designates whether the member is a chat room administrator or a general chat room member. The member role can be updated only for user IDs.
updateRoomMembership
in interface AmazonChime
updateRoomMembershipRequest
- 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 UpdateUserResult updateUser(UpdateUserRequest request)
Updates user details for a specified user ID. Currently, only LicenseType
updates are supported for
this action.
updateUser
in interface AmazonChime
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.public UpdateUserSettingsResult updateUserSettings(UpdateUserSettingsRequest request)
Updates the settings for the specified user, such as phone number settings.
updateUserSettings
in interface AmazonChime
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.public UpdateVoiceConnectorResult updateVoiceConnector(UpdateVoiceConnectorRequest request)
Updates details for the specified Amazon Chime Voice Connector.
updateVoiceConnector
in interface AmazonChime
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.public UpdateVoiceConnectorGroupResult updateVoiceConnectorGroup(UpdateVoiceConnectorGroupRequest request)
Updates details for the specified Amazon Chime Voice Connector group, such as the name and Amazon Chime Voice Connector priority ranking.
updateVoiceConnectorGroup
in interface AmazonChime
updateVoiceConnectorGroupRequest
- 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.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 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 AmazonChime
request
- The originally executed requestCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.