@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonChime extends Object implements AmazonChime
AmazonChime
. Convenient method forms pass through to the corresponding overload
that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier | Constructor and Description |
---|---|
protected |
AbstractAmazonChime() |
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
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.
|
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.
|
public AssociatePhoneNumberWithUserResult associatePhoneNumberWithUser(AssociatePhoneNumberWithUserRequest request)
AmazonChime
Associates a phone number with the specified Amazon Chime user.
associatePhoneNumberWithUser
in interface AmazonChime
public AssociatePhoneNumbersWithVoiceConnectorResult associatePhoneNumbersWithVoiceConnector(AssociatePhoneNumbersWithVoiceConnectorRequest request)
AmazonChime
Associates phone numbers with the specified Amazon Chime Voice Connector.
associatePhoneNumbersWithVoiceConnector
in interface AmazonChime
public AssociatePhoneNumbersWithVoiceConnectorGroupResult associatePhoneNumbersWithVoiceConnectorGroup(AssociatePhoneNumbersWithVoiceConnectorGroupRequest request)
AmazonChime
Associates phone numbers with the specified Amazon Chime Voice Connector group.
associatePhoneNumbersWithVoiceConnectorGroup
in interface AmazonChime
public AssociateSigninDelegateGroupsWithAccountResult associateSigninDelegateGroupsWithAccount(AssociateSigninDelegateGroupsWithAccountRequest request)
AmazonChime
Associates the specified sign-in delegate groups with the specified Amazon Chime account.
associateSigninDelegateGroupsWithAccount
in interface AmazonChime
public BatchCreateAttendeeResult batchCreateAttendee(BatchCreateAttendeeRequest request)
AmazonChime
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
public BatchCreateRoomMembershipResult batchCreateRoomMembership(BatchCreateRoomMembershipRequest request)
AmazonChime
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
public BatchDeletePhoneNumberResult batchDeletePhoneNumber(BatchDeletePhoneNumberRequest request)
AmazonChime
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
public BatchSuspendUserResult batchSuspendUser(BatchSuspendUserRequest request)
AmazonChime
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
public BatchUnsuspendUserResult batchUnsuspendUser(BatchUnsuspendUserRequest request)
AmazonChime
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
public BatchUpdatePhoneNumberResult batchUpdatePhoneNumber(BatchUpdatePhoneNumberRequest request)
AmazonChime
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
public BatchUpdateUserResult batchUpdateUser(BatchUpdateUserRequest request)
AmazonChime
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
public CreateAccountResult createAccount(CreateAccountRequest request)
AmazonChime
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
public CreateAttendeeResult createAttendee(CreateAttendeeRequest request)
AmazonChime
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
public CreateBotResult createBot(CreateBotRequest request)
AmazonChime
Creates a bot for an Amazon Chime Enterprise account.
createBot
in interface AmazonChime
public CreateMeetingResult createMeeting(CreateMeetingRequest request)
AmazonChime
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
public CreatePhoneNumberOrderResult createPhoneNumberOrder(CreatePhoneNumberOrderRequest request)
AmazonChime
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
public CreateRoomResult createRoom(CreateRoomRequest request)
AmazonChime
Creates a chat room for the specified Amazon Chime Enterprise account.
createRoom
in interface AmazonChime
public CreateRoomMembershipResult createRoomMembership(CreateRoomMembershipRequest request)
AmazonChime
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
public CreateUserResult createUser(CreateUserRequest request)
AmazonChime
Creates a user under the specified Amazon Chime account.
createUser
in interface AmazonChime
public CreateVoiceConnectorResult createVoiceConnector(CreateVoiceConnectorRequest request)
AmazonChime
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
public CreateVoiceConnectorGroupResult createVoiceConnectorGroup(CreateVoiceConnectorGroupRequest request)
AmazonChime
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
public DeleteAccountResult deleteAccount(DeleteAccountRequest request)
AmazonChime
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
public DeleteAttendeeResult deleteAttendee(DeleteAttendeeRequest request)
AmazonChime
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
public DeleteEventsConfigurationResult deleteEventsConfiguration(DeleteEventsConfigurationRequest request)
AmazonChime
Deletes the events configuration that allows a bot to receive outgoing events.
deleteEventsConfiguration
in interface AmazonChime
public DeleteMeetingResult deleteMeeting(DeleteMeetingRequest request)
AmazonChime
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
public DeletePhoneNumberResult deletePhoneNumber(DeletePhoneNumberRequest request)
AmazonChime
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
public DeleteRoomResult deleteRoom(DeleteRoomRequest request)
AmazonChime
Deletes a chat room in an Amazon Chime Enterprise account.
deleteRoom
in interface AmazonChime
public DeleteRoomMembershipResult deleteRoomMembership(DeleteRoomMembershipRequest request)
AmazonChime
Removes a member from a chat room in an Amazon Chime Enterprise account.
deleteRoomMembership
in interface AmazonChime
public DeleteVoiceConnectorResult deleteVoiceConnector(DeleteVoiceConnectorRequest request)
AmazonChime
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
public DeleteVoiceConnectorGroupResult deleteVoiceConnectorGroup(DeleteVoiceConnectorGroupRequest request)
AmazonChime
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
public DeleteVoiceConnectorOriginationResult deleteVoiceConnectorOrigination(DeleteVoiceConnectorOriginationRequest request)
AmazonChime
Deletes the origination settings for the specified Amazon Chime Voice Connector.
deleteVoiceConnectorOrigination
in interface AmazonChime
public DeleteVoiceConnectorStreamingConfigurationResult deleteVoiceConnectorStreamingConfiguration(DeleteVoiceConnectorStreamingConfigurationRequest request)
AmazonChime
Deletes the streaming configuration for the specified Amazon Chime Voice Connector.
deleteVoiceConnectorStreamingConfiguration
in interface AmazonChime
public DeleteVoiceConnectorTerminationResult deleteVoiceConnectorTermination(DeleteVoiceConnectorTerminationRequest request)
AmazonChime
Deletes the termination settings for the specified Amazon Chime Voice Connector.
deleteVoiceConnectorTermination
in interface AmazonChime
public DeleteVoiceConnectorTerminationCredentialsResult deleteVoiceConnectorTerminationCredentials(DeleteVoiceConnectorTerminationCredentialsRequest request)
AmazonChime
Deletes the specified SIP credentials used by your equipment to authenticate during call termination.
deleteVoiceConnectorTerminationCredentials
in interface AmazonChime
public DisassociatePhoneNumberFromUserResult disassociatePhoneNumberFromUser(DisassociatePhoneNumberFromUserRequest request)
AmazonChime
Disassociates the primary provisioned phone number from the specified Amazon Chime user.
disassociatePhoneNumberFromUser
in interface AmazonChime
public DisassociatePhoneNumbersFromVoiceConnectorResult disassociatePhoneNumbersFromVoiceConnector(DisassociatePhoneNumbersFromVoiceConnectorRequest request)
AmazonChime
Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector.
disassociatePhoneNumbersFromVoiceConnector
in interface AmazonChime
public DisassociatePhoneNumbersFromVoiceConnectorGroupResult disassociatePhoneNumbersFromVoiceConnectorGroup(DisassociatePhoneNumbersFromVoiceConnectorGroupRequest request)
AmazonChime
Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector group.
disassociatePhoneNumbersFromVoiceConnectorGroup
in interface AmazonChime
public DisassociateSigninDelegateGroupsFromAccountResult disassociateSigninDelegateGroupsFromAccount(DisassociateSigninDelegateGroupsFromAccountRequest request)
AmazonChime
Disassociates the specified sign-in delegate groups from the specified Amazon Chime account.
disassociateSigninDelegateGroupsFromAccount
in interface AmazonChime
public GetAccountResult getAccount(GetAccountRequest request)
AmazonChime
Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.
getAccount
in interface AmazonChime
public GetAccountSettingsResult getAccountSettings(GetAccountSettingsRequest request)
AmazonChime
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
public GetAttendeeResult getAttendee(GetAttendeeRequest request)
AmazonChime
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
public GetBotResult getBot(GetBotRequest request)
AmazonChime
Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.
getBot
in interface AmazonChime
public GetEventsConfigurationResult getEventsConfiguration(GetEventsConfigurationRequest request)
AmazonChime
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
public GetGlobalSettingsResult getGlobalSettings(GetGlobalSettingsRequest request)
AmazonChime
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
public GetMeetingResult getMeeting(GetMeetingRequest request)
AmazonChime
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
public GetPhoneNumberResult getPhoneNumber(GetPhoneNumberRequest request)
AmazonChime
Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.
getPhoneNumber
in interface AmazonChime
public GetPhoneNumberOrderResult getPhoneNumberOrder(GetPhoneNumberOrderRequest request)
AmazonChime
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
public GetPhoneNumberSettingsResult getPhoneNumberSettings(GetPhoneNumberSettingsRequest request)
AmazonChime
Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.
getPhoneNumberSettings
in interface AmazonChime
public GetRoomResult getRoom(GetRoomRequest request)
AmazonChime
Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.
getRoom
in interface AmazonChime
public GetUserResult getUser(GetUserRequest request)
AmazonChime
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
public GetUserSettingsResult getUserSettings(GetUserSettingsRequest request)
AmazonChime
Retrieves settings for the specified user ID, such as any associated phone number settings.
getUserSettings
in interface AmazonChime
public GetVoiceConnectorResult getVoiceConnector(GetVoiceConnectorRequest request)
AmazonChime
Retrieves details for the specified Amazon Chime Voice Connector, such as timestamps, name, outbound host, and encryption requirements.
getVoiceConnector
in interface AmazonChime
public GetVoiceConnectorGroupResult getVoiceConnectorGroup(GetVoiceConnectorGroupRequest request)
AmazonChime
Retrieves details for the specified Amazon Chime Voice Connector group, such as timestamps, name, and associated
VoiceConnectorItems
.
getVoiceConnectorGroup
in interface AmazonChime
public GetVoiceConnectorLoggingConfigurationResult getVoiceConnectorLoggingConfiguration(GetVoiceConnectorLoggingConfigurationRequest request)
AmazonChime
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
public GetVoiceConnectorOriginationResult getVoiceConnectorOrigination(GetVoiceConnectorOriginationRequest request)
AmazonChime
Retrieves origination setting details for the specified Amazon Chime Voice Connector.
getVoiceConnectorOrigination
in interface AmazonChime
public GetVoiceConnectorStreamingConfigurationResult getVoiceConnectorStreamingConfiguration(GetVoiceConnectorStreamingConfigurationRequest request)
AmazonChime
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
public GetVoiceConnectorTerminationResult getVoiceConnectorTermination(GetVoiceConnectorTerminationRequest request)
AmazonChime
Retrieves termination setting details for the specified Amazon Chime Voice Connector.
getVoiceConnectorTermination
in interface AmazonChime
public GetVoiceConnectorTerminationHealthResult getVoiceConnectorTerminationHealth(GetVoiceConnectorTerminationHealthRequest request)
AmazonChime
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
public InviteUsersResult inviteUsers(InviteUsersRequest request)
AmazonChime
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
public ListAccountsResult listAccounts(ListAccountsRequest request)
AmazonChime
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
public ListAttendeesResult listAttendees(ListAttendeesRequest request)
AmazonChime
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
public ListBotsResult listBots(ListBotsRequest request)
AmazonChime
Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.
listBots
in interface AmazonChime
public ListMeetingsResult listMeetings(ListMeetingsRequest request)
AmazonChime
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
public ListPhoneNumberOrdersResult listPhoneNumberOrders(ListPhoneNumberOrdersRequest request)
AmazonChime
Lists the phone number orders for the administrator's Amazon Chime account.
listPhoneNumberOrders
in interface AmazonChime
public ListPhoneNumbersResult listPhoneNumbers(ListPhoneNumbersRequest request)
AmazonChime
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
public ListRoomMembershipsResult listRoomMemberships(ListRoomMembershipsRequest request)
AmazonChime
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
public ListRoomsResult listRooms(ListRoomsRequest request)
AmazonChime
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
public ListUsersResult listUsers(ListUsersRequest request)
AmazonChime
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
public ListVoiceConnectorGroupsResult listVoiceConnectorGroups(ListVoiceConnectorGroupsRequest request)
AmazonChime
Lists the Amazon Chime Voice Connector groups for the administrator's AWS account.
listVoiceConnectorGroups
in interface AmazonChime
public ListVoiceConnectorTerminationCredentialsResult listVoiceConnectorTerminationCredentials(ListVoiceConnectorTerminationCredentialsRequest request)
AmazonChime
Lists the SIP credentials for the specified Amazon Chime Voice Connector.
listVoiceConnectorTerminationCredentials
in interface AmazonChime
public ListVoiceConnectorsResult listVoiceConnectors(ListVoiceConnectorsRequest request)
AmazonChime
Lists the Amazon Chime Voice Connectors for the administrator's AWS account.
listVoiceConnectors
in interface AmazonChime
public LogoutUserResult logoutUser(LogoutUserRequest request)
AmazonChime
Logs out the specified user from all of the devices they are currently logged into.
logoutUser
in interface AmazonChime
public PutEventsConfigurationResult putEventsConfiguration(PutEventsConfigurationRequest request)
AmazonChime
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
public PutVoiceConnectorLoggingConfigurationResult putVoiceConnectorLoggingConfiguration(PutVoiceConnectorLoggingConfigurationRequest request)
AmazonChime
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
public PutVoiceConnectorOriginationResult putVoiceConnectorOrigination(PutVoiceConnectorOriginationRequest request)
AmazonChime
Adds origination settings for the specified Amazon Chime Voice Connector.
putVoiceConnectorOrigination
in interface AmazonChime
public PutVoiceConnectorStreamingConfigurationResult putVoiceConnectorStreamingConfiguration(PutVoiceConnectorStreamingConfigurationRequest request)
AmazonChime
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
public PutVoiceConnectorTerminationResult putVoiceConnectorTermination(PutVoiceConnectorTerminationRequest request)
AmazonChime
Adds termination settings for the specified Amazon Chime Voice Connector.
putVoiceConnectorTermination
in interface AmazonChime
public PutVoiceConnectorTerminationCredentialsResult putVoiceConnectorTerminationCredentials(PutVoiceConnectorTerminationCredentialsRequest request)
AmazonChime
Adds termination SIP credentials for the specified Amazon Chime Voice Connector.
putVoiceConnectorTerminationCredentials
in interface AmazonChime
public RegenerateSecurityTokenResult regenerateSecurityToken(RegenerateSecurityTokenRequest request)
AmazonChime
Regenerates the security token for a bot.
regenerateSecurityToken
in interface AmazonChime
public ResetPersonalPINResult resetPersonalPIN(ResetPersonalPINRequest request)
AmazonChime
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
public RestorePhoneNumberResult restorePhoneNumber(RestorePhoneNumberRequest request)
AmazonChime
Moves a phone number from the Deletion queue back into the phone number Inventory.
restorePhoneNumber
in interface AmazonChime
public SearchAvailablePhoneNumbersResult searchAvailablePhoneNumbers(SearchAvailablePhoneNumbersRequest request)
AmazonChime
Searches phone numbers that can be ordered.
searchAvailablePhoneNumbers
in interface AmazonChime
public UpdateAccountResult updateAccount(UpdateAccountRequest request)
AmazonChime
Updates account details for the specified Amazon Chime account. Currently, only account name updates are supported for this action.
updateAccount
in interface AmazonChime
public UpdateAccountSettingsResult updateAccountSettings(UpdateAccountSettingsRequest request)
AmazonChime
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
public UpdateBotResult updateBot(UpdateBotRequest request)
AmazonChime
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
public UpdateGlobalSettingsResult updateGlobalSettings(UpdateGlobalSettingsRequest request)
AmazonChime
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
public UpdatePhoneNumberResult updatePhoneNumber(UpdatePhoneNumberRequest request)
AmazonChime
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
public UpdatePhoneNumberSettingsResult updatePhoneNumberSettings(UpdatePhoneNumberSettingsRequest request)
AmazonChime
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
public UpdateRoomResult updateRoom(UpdateRoomRequest request)
AmazonChime
Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account.
updateRoom
in interface AmazonChime
public UpdateRoomMembershipResult updateRoomMembership(UpdateRoomMembershipRequest request)
AmazonChime
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
public UpdateUserResult updateUser(UpdateUserRequest request)
AmazonChime
Updates user details for a specified user ID. Currently, only LicenseType
updates are supported for
this action.
updateUser
in interface AmazonChime
public UpdateUserSettingsResult updateUserSettings(UpdateUserSettingsRequest request)
AmazonChime
Updates the settings for the specified user, such as phone number settings.
updateUserSettings
in interface AmazonChime
public UpdateVoiceConnectorResult updateVoiceConnector(UpdateVoiceConnectorRequest request)
AmazonChime
Updates details for the specified Amazon Chime Voice Connector.
updateVoiceConnector
in interface AmazonChime
public UpdateVoiceConnectorGroupResult updateVoiceConnectorGroup(UpdateVoiceConnectorGroupRequest request)
AmazonChime
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
public void shutdown()
AmazonChime
shutdown
in interface AmazonChime
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonChime
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata
in interface AmazonChime
request
- The originally executed request.Copyright © 2020. All rights reserved.