@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 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.
|
BatchCreateChannelMembershipResult |
batchCreateChannelMembership(BatchCreateChannelMembershipRequest request)
Adds a specified number of users to a channel.
|
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.
|
CreateAppInstanceResult |
createAppInstance(CreateAppInstanceRequest request)
Creates an Amazon Chime SDK messaging
AppInstance under an AWS account. |
CreateAppInstanceAdminResult |
createAppInstanceAdmin(CreateAppInstanceAdminRequest request)
Promotes an
AppInstanceUser to an AppInstanceAdmin . |
CreateAppInstanceUserResult |
createAppInstanceUser(CreateAppInstanceUserRequest request)
Creates a user under an Amazon Chime
AppInstance . |
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.
|
CreateChannelResult |
createChannel(CreateChannelRequest request)
Creates a channel to which you can add users and send messages.
|
CreateChannelBanResult |
createChannelBan(CreateChannelBanRequest request)
Permanently bans a member from a channel.
|
CreateChannelMembershipResult |
createChannelMembership(CreateChannelMembershipRequest request)
Adds a user to a channel.
|
CreateChannelModeratorResult |
createChannelModerator(CreateChannelModeratorRequest request)
Creates a new
ChannelModerator . |
CreateMediaCapturePipelineResult |
createMediaCapturePipeline(CreateMediaCapturePipelineRequest request)
Creates a media capture pipeline.
|
CreateMeetingResult |
createMeeting(CreateMeetingRequest request)
Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees.
|
CreateMeetingDialOutResult |
createMeetingDialOut(CreateMeetingDialOutRequest request)
Uses the join token and call metadata in a meeting request (From number, To number, and so forth) to initiate an
outbound call to a public switched telephone network (PSTN) and join them into a Chime meeting.
|
CreateMeetingWithAttendeesResult |
createMeetingWithAttendees(CreateMeetingWithAttendeesRequest request)
Creates a new Amazon Chime SDK meeting in the specified media Region, with 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.
|
CreateSipMediaApplicationResult |
createSipMediaApplication(CreateSipMediaApplicationRequest request)
Creates a SIP media application.
|
CreateSipMediaApplicationCallResult |
createSipMediaApplicationCall(CreateSipMediaApplicationCallRequest request)
Creates an outbound call to a phone number from the phone number specified in the request, and it invokes the
endpoint of the specified
sipMediaApplicationId . |
CreateSipRuleResult |
createSipRule(CreateSipRuleRequest request)
Creates a SIP rule which can be used to run a SIP media application as a target for a specific trigger type.
|
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.
|
DeleteAppInstanceResult |
deleteAppInstance(DeleteAppInstanceRequest request)
Deletes an
AppInstance and all associated data asynchronously. |
DeleteAppInstanceAdminResult |
deleteAppInstanceAdmin(DeleteAppInstanceAdminRequest request)
Demotes an
AppInstanceAdmin to an AppInstanceUser . |
DeleteAppInstanceStreamingConfigurationsResult |
deleteAppInstanceStreamingConfigurations(DeleteAppInstanceStreamingConfigurationsRequest request)
Deletes the streaming configurations of an
AppInstance . |
DeleteAppInstanceUserResult |
deleteAppInstanceUser(DeleteAppInstanceUserRequest request)
Deletes an
AppInstanceUser . |
DeleteAttendeeResult |
deleteAttendee(DeleteAttendeeRequest request)
Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their
JoinToken . |
DeleteChannelResult |
deleteChannel(DeleteChannelRequest request)
Immediately makes a channel and its memberships inaccessible and marks them for deletion.
|
DeleteChannelBanResult |
deleteChannelBan(DeleteChannelBanRequest request)
Removes a user from a channel's ban list.
|
DeleteChannelMembershipResult |
deleteChannelMembership(DeleteChannelMembershipRequest request)
Removes a member from a channel.
|
DeleteChannelMessageResult |
deleteChannelMessage(DeleteChannelMessageRequest request)
Deletes a channel message.
|
DeleteChannelModeratorResult |
deleteChannelModerator(DeleteChannelModeratorRequest request)
Deletes a channel moderator.
|
DeleteEventsConfigurationResult |
deleteEventsConfiguration(DeleteEventsConfigurationRequest request)
Deletes the events configuration that allows a bot to receive outgoing events.
|
DeleteMediaCapturePipelineResult |
deleteMediaCapturePipeline(DeleteMediaCapturePipelineRequest request)
Deletes the media capture pipeline.
|
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.
|
DeleteSipMediaApplicationResult |
deleteSipMediaApplication(DeleteSipMediaApplicationRequest request)
Deletes a SIP media application.
|
DeleteSipRuleResult |
deleteSipRule(DeleteSipRuleRequest request)
Deletes a SIP rule.
|
DeleteVoiceConnectorResult |
deleteVoiceConnector(DeleteVoiceConnectorRequest request)
Deletes the specified Amazon Chime Voice Connector.
|
DeleteVoiceConnectorEmergencyCallingConfigurationResult |
deleteVoiceConnectorEmergencyCallingConfiguration(DeleteVoiceConnectorEmergencyCallingConfigurationRequest request)
Deletes the emergency calling configuration details from 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.
|
DescribeAppInstanceResult |
describeAppInstance(DescribeAppInstanceRequest request)
Returns the full details of an
AppInstance . |
DescribeAppInstanceAdminResult |
describeAppInstanceAdmin(DescribeAppInstanceAdminRequest request)
Returns the full details of an
AppInstanceAdmin . |
DescribeAppInstanceUserResult |
describeAppInstanceUser(DescribeAppInstanceUserRequest request)
Returns the full details of an
AppInstanceUser . |
DescribeChannelResult |
describeChannel(DescribeChannelRequest request)
Returns the full details of a channel in an Amazon Chime
AppInstance . |
DescribeChannelBanResult |
describeChannelBan(DescribeChannelBanRequest request)
Returns the full details of a channel ban.
|
DescribeChannelMembershipResult |
describeChannelMembership(DescribeChannelMembershipRequest request)
Returns the full details of a user's channel membership.
|
DescribeChannelMembershipForAppInstanceUserResult |
describeChannelMembershipForAppInstanceUser(DescribeChannelMembershipForAppInstanceUserRequest request)
Returns the details of a channel based on the membership of the specified
AppInstanceUser . |
DescribeChannelModeratedByAppInstanceUserResult |
describeChannelModeratedByAppInstanceUser(DescribeChannelModeratedByAppInstanceUserRequest request)
Returns the full details of a channel moderated by the specified
AppInstanceUser . |
DescribeChannelModeratorResult |
describeChannelModerator(DescribeChannelModeratorRequest request)
Returns the full details of a single ChannelModerator.
|
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 dialout
settings.
|
GetAppInstanceRetentionSettingsResult |
getAppInstanceRetentionSettings(GetAppInstanceRetentionSettingsRequest request)
Gets the retention settings for an
AppInstance . |
GetAppInstanceStreamingConfigurationsResult |
getAppInstanceStreamingConfigurations(GetAppInstanceStreamingConfigurationsRequest request)
Gets the streaming settings for an
AppInstance . |
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.
|
GetChannelMessageResult |
getChannelMessage(GetChannelMessageRequest request)
Gets the full details of a channel message.
|
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.
|
GetMediaCapturePipelineResult |
getMediaCapturePipeline(GetMediaCapturePipelineRequest request)
Gets an existing media capture pipeline.
|
GetMeetingResult |
getMeeting(GetMeetingRequest request)
Gets the Amazon Chime SDK meeting details for the specified meeting ID.
|
GetMessagingSessionEndpointResult |
getMessagingSessionEndpoint(GetMessagingSessionEndpointRequest request)
The details of the endpoint for the messaging session.
|
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 the 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.
|
GetRetentionSettingsResult |
getRetentionSettings(GetRetentionSettingsRequest request)
Gets the retention settings for the specified Amazon Chime Enterprise account.
|
GetRoomResult |
getRoom(GetRoomRequest request)
Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.
|
GetSipMediaApplicationResult |
getSipMediaApplication(GetSipMediaApplicationRequest request)
Retrieves the information for a SIP media application, including name, AWS Region, and endpoints.
|
GetSipMediaApplicationLoggingConfigurationResult |
getSipMediaApplicationLoggingConfiguration(GetSipMediaApplicationLoggingConfigurationRequest request)
Returns the logging configuration for the specified SIP media application.
|
GetSipRuleResult |
getSipRule(GetSipRuleRequest request)
Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.
|
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.
|
GetVoiceConnectorEmergencyCallingConfigurationResult |
getVoiceConnectorEmergencyCallingConfiguration(GetVoiceConnectorEmergencyCallingConfigurationRequest request)
Gets the emergency calling configuration details for the specified Amazon Chime Voice Connector.
|
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.
|
ListAppInstanceAdminsResult |
listAppInstanceAdmins(ListAppInstanceAdminsRequest request)
Returns a list of the administrators in the
AppInstance . |
ListAppInstancesResult |
listAppInstances(ListAppInstancesRequest request)
Lists all Amazon Chime
AppInstance s created under a single AWS account. |
ListAppInstanceUsersResult |
listAppInstanceUsers(ListAppInstanceUsersRequest request)
List all
AppInstanceUsers created under a single AppInstance . |
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.
|
ListChannelBansResult |
listChannelBans(ListChannelBansRequest request)
Lists all the users banned from a particular channel.
|
ListChannelMembershipsResult |
listChannelMemberships(ListChannelMembershipsRequest request)
Lists all channel memberships in a channel.
|
ListChannelMembershipsForAppInstanceUserResult |
listChannelMembershipsForAppInstanceUser(ListChannelMembershipsForAppInstanceUserRequest request)
Lists all channels that a particular
AppInstanceUser is a part of. |
ListChannelMessagesResult |
listChannelMessages(ListChannelMessagesRequest request)
List all the messages in a channel.
|
ListChannelModeratorsResult |
listChannelModerators(ListChannelModeratorsRequest request)
Lists all the moderators for a channel.
|
ListChannelsResult |
listChannels(ListChannelsRequest request)
Lists all Channels created under a single Chime App as a paginated list.
|
ListChannelsModeratedByAppInstanceUserResult |
listChannelsModeratedByAppInstanceUser(ListChannelsModeratedByAppInstanceUserRequest request)
A list of the channels moderated by an
AppInstanceUser . |
ListMediaCapturePipelinesResult |
listMediaCapturePipelines(ListMediaCapturePipelinesRequest request)
Returns a list of media capture pipelines.
|
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.
|
ListSipMediaApplicationsResult |
listSipMediaApplications(ListSipMediaApplicationsRequest request)
Lists the SIP media applications under the administrator's AWS account.
|
ListSipRulesResult |
listSipRules(ListSipRulesRequest request)
Lists the SIP rules under the administrator's AWS account.
|
ListSupportedPhoneNumberCountriesResult |
listSupportedPhoneNumberCountries(ListSupportedPhoneNumberCountriesRequest request)
Lists supported phone number countries.
|
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.
|
PutAppInstanceRetentionSettingsResult |
putAppInstanceRetentionSettings(PutAppInstanceRetentionSettingsRequest request)
Sets the amount of time in days that a given
AppInstance retains data. |
PutAppInstanceStreamingConfigurationsResult |
putAppInstanceStreamingConfigurations(PutAppInstanceStreamingConfigurationsRequest request)
The data streaming configurations of an
AppInstance . |
PutEventsConfigurationResult |
putEventsConfiguration(PutEventsConfigurationRequest request)
Creates an events configuration that allows a bot to receive outgoing events sent by Amazon Chime.
|
PutRetentionSettingsResult |
putRetentionSettings(PutRetentionSettingsRequest request)
Puts retention settings for the specified Amazon Chime Enterprise account.
|
PutSipMediaApplicationLoggingConfigurationResult |
putSipMediaApplicationLoggingConfiguration(PutSipMediaApplicationLoggingConfigurationRequest request)
Updates the logging configuration for the specified SIP media application.
|
PutVoiceConnectorEmergencyCallingConfigurationResult |
putVoiceConnectorEmergencyCallingConfiguration(PutVoiceConnectorEmergencyCallingConfigurationRequest request)
Puts emergency calling configuration details to the specified Amazon Chime Voice Connector, such as emergency
phone numbers and calling countries.
|
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.
|
RedactChannelMessageResult |
redactChannelMessage(RedactChannelMessageRequest request)
Redacts message content, but not metadata.
|
RedactConversationMessageResult |
redactConversationMessage(RedactConversationMessageRequest request)
Redacts the specified message from the specified Amazon Chime conversation.
|
RedactRoomMessageResult |
redactRoomMessage(RedactRoomMessageRequest request)
Redacts the specified message from the specified Amazon Chime channel.
|
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 for phone numbers that can be ordered.
|
SendChannelMessageResult |
sendChannelMessage(SendChannelMessageRequest request)
Sends a message to a particular channel that the member is a part of.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartMeetingTranscriptionResult |
startMeetingTranscription(StartMeetingTranscriptionRequest request)
Starts transcription for the specified
meetingId . |
StopMeetingTranscriptionResult |
stopMeetingTranscription(StopMeetingTranscriptionRequest request)
Stops transcription for the specified
meetingId . |
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.
|
UpdateAppInstanceResult |
updateAppInstance(UpdateAppInstanceRequest request)
Updates
AppInstance metadata. |
UpdateAppInstanceUserResult |
updateAppInstanceUser(UpdateAppInstanceUserRequest request)
Updates the details of an
AppInstanceUser . |
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.
|
UpdateChannelResult |
updateChannel(UpdateChannelRequest request)
Update a channel's attributes.
|
UpdateChannelMessageResult |
updateChannelMessage(UpdateChannelMessageRequest request)
Updates the content of a message.
|
UpdateChannelReadMarkerResult |
updateChannelReadMarker(UpdateChannelReadMarkerRequest request)
The details of the time when a user last read messages in a channel.
|
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.
|
UpdateSipMediaApplicationResult |
updateSipMediaApplication(UpdateSipMediaApplicationRequest request)
Updates the details of the specified SIP media application.
|
UpdateSipMediaApplicationCallResult |
updateSipMediaApplicationCall(UpdateSipMediaApplicationCallRequest request)
Invokes the AWS Lambda function associated with the SIP media application and transaction ID in an update
request.
|
UpdateSipRuleResult |
updateSipRule(UpdateSipRuleRequest request)
Updates the details of the specified SIP rule.
|
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 of the specified Amazon Chime Voice Connector group, such as the name and Amazon Chime Voice
Connector priority ranking.
|
ValidateE911AddressResult |
validateE911Address(ValidateE911AddressRequest request)
Validates an address to be used for 911 calls made with Amazon Chime Voice Connectors.
|
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 BatchCreateChannelMembershipResult batchCreateChannelMembership(BatchCreateChannelMembershipRequest request)
AmazonChime
Adds a specified number of users to a channel.
batchCreateChannelMembership
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 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 account types, 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 the product type or the calling name.
For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In 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 CreateAppInstanceResult createAppInstance(CreateAppInstanceRequest request)
AmazonChime
Creates an Amazon Chime SDK messaging AppInstance
under an AWS account. Only SDK messaging customers
use this API. CreateAppInstance
supports idempotency behavior as described in the AWS API Standard.
createAppInstance
in interface AmazonChime
public CreateAppInstanceAdminResult createAppInstanceAdmin(CreateAppInstanceAdminRequest request)
AmazonChime
Promotes an AppInstanceUser
to an AppInstanceAdmin
. The promoted user can perform the
following actions.
ChannelModerator
actions across all channels in the AppInstance
.
DeleteChannelMessage
actions.
Only an AppInstanceUser
can be promoted to an AppInstanceAdmin
role.
createAppInstanceAdmin
in interface AmazonChime
public CreateAppInstanceUserResult createAppInstanceUser(CreateAppInstanceUserRequest request)
AmazonChime
Creates a user under an Amazon Chime AppInstance
. The request consists of a unique
appInstanceUserId
and Name
for that user.
createAppInstanceUser
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 CreateChannelResult createChannel(CreateChannelRequest request)
AmazonChime
Creates a channel to which you can add users and send messages.
Restriction: You can't change a channel's privacy.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
createChannel
in interface AmazonChime
public CreateChannelBanResult createChannelBan(CreateChannelBanRequest request)
AmazonChime
Permanently bans a member from a channel. Moderators can't add banned members to a channel. To undo a ban, you
first have to DeleteChannelBan
, and then CreateChannelMembership
. Bans are cleaned up
when you delete users or channels.
If you ban a user who is already part of a channel, that user is automatically kicked from the channel.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
createChannelBan
in interface AmazonChime
public CreateChannelMembershipResult createChannelMembership(CreateChannelMembershipRequest request)
AmazonChime
Adds a user to a channel. The InvitedBy
response field is derived from the request header. A channel
member can:
List messages
Send messages
Receive messages
Edit their own messages
Leave the channel
Privacy settings impact this action as follows:
Public Channels: You do not need to be a member to list messages, but you must be a member to send messages.
Private Channels: You must be a member to list or send messages.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
createChannelMembership
in interface AmazonChime
public CreateChannelModeratorResult createChannelModerator(CreateChannelModeratorRequest request)
AmazonChime
Creates a new ChannelModerator
. A channel moderator can:
Add and remove other members of the channel.
Add and remove other moderators of the channel.
Add and remove user bans for the channel.
Redact messages in the channel.
List messages in the channel.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
createChannelModerator
in interface AmazonChime
public CreateMediaCapturePipelineResult createMediaCapturePipeline(CreateMediaCapturePipelineRequest request)
AmazonChime
Creates a media capture pipeline.
createMediaCapturePipeline
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 specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon Chime Developer Guide . 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 CreateMeetingDialOutResult createMeetingDialOut(CreateMeetingDialOutRequest request)
AmazonChime
Uses the join token and call metadata in a meeting request (From number, To number, and so forth) to initiate an outbound call to a public switched telephone network (PSTN) and join them into a Chime meeting. Also ensures that the From number belongs to the customer.
To play welcome audio or implement an interactive voice response (IVR), use the
CreateSipMediaApplicationCall
action with the corresponding SIP media application ID.
createMeetingDialOut
in interface AmazonChime
public CreateMeetingWithAttendeesResult createMeetingWithAttendees(CreateMeetingWithAttendeesRequest request)
AmazonChime
Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees. For more information about specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon Chime Developer Guide . For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .
createMeetingWithAttendees
in interface AmazonChime
public CreatePhoneNumberOrderResult createPhoneNumberOrder(CreatePhoneNumberOrderRequest request)
AmazonChime
Creates an order for phone numbers to be provisioned. For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type.
createPhoneNumberOrder
in interface AmazonChime
public CreateProxySessionResult createProxySession(CreateProxySessionRequest request)
AmazonChime
Creates a proxy session on the specified Amazon Chime Voice Connector for the specified participant phone numbers.
createProxySession
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 CreateSipMediaApplicationResult createSipMediaApplication(CreateSipMediaApplicationRequest request)
AmazonChime
Creates a SIP media application.
createSipMediaApplication
in interface AmazonChime
public CreateSipMediaApplicationCallResult createSipMediaApplicationCall(CreateSipMediaApplicationCallRequest request)
AmazonChime
Creates an outbound call to a phone number from the phone number specified in the request, and it invokes the
endpoint of the specified sipMediaApplicationId
.
createSipMediaApplicationCall
in interface AmazonChime
public CreateSipRuleResult createSipRule(CreateSipRuleRequest request)
AmazonChime
Creates a SIP rule which can be used to run a SIP media application as a target for a specific trigger type.
createSipRule
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 Team
account.
You can use the BatchSuspendUser action to dodo.
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 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 DeleteAppInstanceResult deleteAppInstance(DeleteAppInstanceRequest request)
AmazonChime
Deletes an AppInstance
and all associated data asynchronously.
deleteAppInstance
in interface AmazonChime
public DeleteAppInstanceAdminResult deleteAppInstanceAdmin(DeleteAppInstanceAdminRequest request)
AmazonChime
Demotes an AppInstanceAdmin
to an AppInstanceUser
. This action does not delete the
user.
deleteAppInstanceAdmin
in interface AmazonChime
public DeleteAppInstanceStreamingConfigurationsResult deleteAppInstanceStreamingConfigurations(DeleteAppInstanceStreamingConfigurationsRequest request)
AmazonChime
Deletes the streaming configurations of an AppInstance
.
deleteAppInstanceStreamingConfigurations
in interface AmazonChime
public DeleteAppInstanceUserResult deleteAppInstanceUser(DeleteAppInstanceUserRequest request)
AmazonChime
Deletes an AppInstanceUser
.
deleteAppInstanceUser
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 DeleteChannelResult deleteChannel(DeleteChannelRequest request)
AmazonChime
Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
deleteChannel
in interface AmazonChime
public DeleteChannelBanResult deleteChannelBan(DeleteChannelBanRequest request)
AmazonChime
Removes a user from a channel's ban list.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
deleteChannelBan
in interface AmazonChime
public DeleteChannelMembershipResult deleteChannelMembership(DeleteChannelMembershipRequest request)
AmazonChime
Removes a member from a channel.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
deleteChannelMembership
in interface AmazonChime
public DeleteChannelMessageResult deleteChannelMessage(DeleteChannelMessageRequest request)
AmazonChime
Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately.
A background process deletes any revisions created by UpdateChannelMessage
.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
deleteChannelMessage
in interface AmazonChime
public DeleteChannelModeratorResult deleteChannelModerator(DeleteChannelModeratorRequest request)
AmazonChime
Deletes a channel moderator.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
deleteChannelModerator
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 DeleteMediaCapturePipelineResult deleteMediaCapturePipeline(DeleteMediaCapturePipelineRequest request)
AmazonChime
Deletes the media capture pipeline.
deleteMediaCapturePipeline
in interface AmazonChime
public DeleteMeetingResult deleteMeeting(DeleteMeetingRequest request)
AmazonChime
Deletes the specified Amazon Chime SDK meeting. The operation deletes all attendees, disconnects all clients, and prevents new clients from joining the meeting. 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 DeleteProxySessionResult deleteProxySession(DeleteProxySessionRequest request)
AmazonChime
Deletes the specified proxy session from the specified Amazon Chime Voice Connector.
deleteProxySession
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 DeleteSipMediaApplicationResult deleteSipMediaApplication(DeleteSipMediaApplicationRequest request)
AmazonChime
Deletes a SIP media application.
deleteSipMediaApplication
in interface AmazonChime
public DeleteSipRuleResult deleteSipRule(DeleteSipRuleRequest request)
AmazonChime
Deletes a SIP rule. You must disable a SIP rule before you can delete it.
deleteSipRule
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 DeleteVoiceConnectorEmergencyCallingConfigurationResult deleteVoiceConnectorEmergencyCallingConfiguration(DeleteVoiceConnectorEmergencyCallingConfigurationRequest request)
AmazonChime
Deletes the emergency calling configuration details from the specified Amazon Chime Voice Connector.
deleteVoiceConnectorEmergencyCallingConfiguration
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.
If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to deleting the origination settings.
deleteVoiceConnectorOrigination
in interface AmazonChime
public DeleteVoiceConnectorProxyResult deleteVoiceConnectorProxy(DeleteVoiceConnectorProxyRequest request)
AmazonChime
Deletes the proxy configuration from the specified Amazon Chime Voice Connector.
deleteVoiceConnectorProxy
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.
If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to deleting the termination settings.
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 DescribeAppInstanceResult describeAppInstance(DescribeAppInstanceRequest request)
AmazonChime
Returns the full details of an AppInstance
.
describeAppInstance
in interface AmazonChime
public DescribeAppInstanceAdminResult describeAppInstanceAdmin(DescribeAppInstanceAdminRequest request)
AmazonChime
Returns the full details of an AppInstanceAdmin
.
describeAppInstanceAdmin
in interface AmazonChime
public DescribeAppInstanceUserResult describeAppInstanceUser(DescribeAppInstanceUserRequest request)
AmazonChime
Returns the full details of an AppInstanceUser
.
describeAppInstanceUser
in interface AmazonChime
public DescribeChannelResult describeChannel(DescribeChannelRequest request)
AmazonChime
Returns the full details of a channel in an Amazon Chime AppInstance
.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
describeChannel
in interface AmazonChime
public DescribeChannelBanResult describeChannelBan(DescribeChannelBanRequest request)
AmazonChime
Returns the full details of a channel ban.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
describeChannelBan
in interface AmazonChime
public DescribeChannelMembershipResult describeChannelMembership(DescribeChannelMembershipRequest request)
AmazonChime
Returns the full details of a user's channel membership.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
describeChannelMembership
in interface AmazonChime
public DescribeChannelMembershipForAppInstanceUserResult describeChannelMembershipForAppInstanceUser(DescribeChannelMembershipForAppInstanceUserRequest request)
AmazonChime
Returns the details of a channel based on the membership of the specified AppInstanceUser
.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
describeChannelMembershipForAppInstanceUser
in interface AmazonChime
public DescribeChannelModeratedByAppInstanceUserResult describeChannelModeratedByAppInstanceUser(DescribeChannelModeratedByAppInstanceUserRequest request)
AmazonChime
Returns the full details of a channel moderated by the specified AppInstanceUser
.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
describeChannelModeratedByAppInstanceUser
in interface AmazonChime
public DescribeChannelModeratorResult describeChannelModerator(DescribeChannelModeratorRequest request)
AmazonChime
Returns the full details of a single ChannelModerator.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
describeChannelModerator
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 dialout settings. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.
getAccountSettings
in interface AmazonChime
public GetAppInstanceRetentionSettingsResult getAppInstanceRetentionSettings(GetAppInstanceRetentionSettingsRequest request)
AmazonChime
Gets the retention settings for an AppInstance
.
getAppInstanceRetentionSettings
in interface AmazonChime
public GetAppInstanceStreamingConfigurationsResult getAppInstanceStreamingConfigurations(GetAppInstanceStreamingConfigurationsRequest request)
AmazonChime
Gets the streaming settings for an AppInstance
.
getAppInstanceStreamingConfigurations
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 GetChannelMessageResult getChannelMessage(GetChannelMessageRequest request)
AmazonChime
Gets the full details of a channel message.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn
of the user that
makes the API call as the value in the header.
getChannelMessage
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 GetMediaCapturePipelineResult getMediaCapturePipeline(GetMediaCapturePipelineRequest request)
AmazonChime
Gets an existing media capture pipeline.
getMediaCapturePipeline
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 GetMessagingSessionEndpointResult getMessagingSessionEndpoint(GetMessagingSessionEndpointRequest request)
AmazonChime
The details of the endpoint for the messaging session.
getMessagingSessionEndpoint
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 the 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 GetProxySessionResult getProxySession(GetProxySessionRequest request)
AmazonChime
Gets the specified proxy session details for the specified Amazon Chime Voice Connector.
getProxySession
in interface AmazonChime
public GetRetentionSettingsResult getRetentionSettings(GetRetentionSettingsRequest request)
AmazonChime
Gets the retention settings for the specified Amazon Chime Enterprise account. For more information about retention settings, see Managing Chat Retention Policies in the Amazon Chime Administration Guide.
getRetentionSettings
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 GetSipMediaApplicationResult getSipMediaApplication(GetSipMediaApplicationRequest request)
AmazonChime
Retrieves the information for a SIP media application, including name, AWS Region, and endpoints.
getSipMediaApplication
in interface AmazonChime
public GetSipMediaApplicationLoggingConfigurationResult getSipMediaApplicationLoggingConfiguration(GetSipMediaApplicationLoggingConfigurationRequest request)
AmazonChime
Returns the logging configuration for the specified SIP media application.
getSipMediaApplicationLoggingConfiguration
in interface AmazonChime
public GetSipRuleResult getSipRule(GetSipRuleRequest request)
AmazonChime
Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.
getSipRule
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 GetVoiceConnectorEmergencyCallingConfigurationResult getVoiceConnectorEmergencyCallingConfiguration(GetVoiceConnectorEmergencyCallingConfigurationRequest request)
AmazonChime
Gets the emergency calling configuration details for the specified Amazon Chime Voice Connector.
getVoiceConnectorEmergencyCallingConfiguration
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 GetVoiceConnectorProxyResult getVoiceConnectorProxy(GetVoiceConnectorProxyRequest request)
AmazonChime
Gets the proxy configuration details for the specified Amazon Chime Voice Connector.
getVoiceConnectorProxy
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 ListAppInstanceAdminsResult listAppInstanceAdmins(ListAppInstanceAdminsRequest request)
AmazonChime
Returns a list of the administrators in the AppInstance
.
listAppInstanceAdmins
in interface AmazonChime
public ListAppInstanceUsersResult listAppInstanceUsers(ListAppInstanceUsersRequest request)
AmazonChime
List all AppInstanceUsers
created under a single AppInstance
.
listAppInstanceUsers
in interface AmazonChime
public ListAppInstancesResult listAppInstances(ListAppInstancesRequest request)
AmazonChime
Lists all Amazon Chime AppInstance
s created under a single AWS account.
listAppInstances
in interface AmazonChime
public ListAttendeeTagsResult listAttendeeTags(ListAttendeeTagsRequest request)
AmazonChime
Lists the tags applied to an Amazon Chime SDK attendee resource.
listAttendeeTags
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 ListChannelBansResult listChannelBans(ListChannelBansRequest request)
AmazonChime
Lists all the users banned from a particular channel.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
listChannelBans
in interface AmazonChime
public ListChannelMembershipsResult listChannelMemberships(ListChannelMembershipsRequest request)
AmazonChime
Lists all channel memberships in a channel.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
listChannelMemberships
in interface AmazonChime
public ListChannelMembershipsForAppInstanceUserResult listChannelMembershipsForAppInstanceUser(ListChannelMembershipsForAppInstanceUserRequest request)
AmazonChime
Lists all channels that a particular AppInstanceUser
is a part of. Only an
AppInstanceAdmin
can call the API with a user ARN that is not their own.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
listChannelMembershipsForAppInstanceUser
in interface AmazonChime
public ListChannelMessagesResult listChannelMessages(ListChannelMessagesRequest request)
AmazonChime
List all the messages in a channel. Returns a paginated list of ChannelMessages
. By default, sorted
by creation timestamp in descending order.
Redacted messages appear in the results as empty, since they are only redacted, not deleted. Deleted messages do not appear in the results. This action always returns the latest version of an edited message.
Also, the x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn
of the user
that makes the API call as the value in the header.
listChannelMessages
in interface AmazonChime
public ListChannelModeratorsResult listChannelModerators(ListChannelModeratorsRequest request)
AmazonChime
Lists all the moderators for a channel.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
listChannelModerators
in interface AmazonChime
public ListChannelsResult listChannels(ListChannelsRequest request)
AmazonChime
Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results.
Functionality & restrictions
Use privacy = PUBLIC
to retrieve all public channels in the account.
Only an AppInstanceAdmin
can set privacy = PRIVATE
to list the private channels in an
account.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
listChannels
in interface AmazonChime
public ListChannelsModeratedByAppInstanceUserResult listChannelsModeratedByAppInstanceUser(ListChannelsModeratedByAppInstanceUserRequest request)
AmazonChime
A list of the channels moderated by an AppInstanceUser
.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
listChannelsModeratedByAppInstanceUser
in interface AmazonChime
public ListMediaCapturePipelinesResult listMediaCapturePipelines(ListMediaCapturePipelinesRequest request)
AmazonChime
Returns a list of media capture pipelines.
listMediaCapturePipelines
in interface AmazonChime
public ListMeetingTagsResult listMeetingTags(ListMeetingTagsRequest request)
AmazonChime
Lists the tags applied to an Amazon Chime SDK meeting resource.
listMeetingTags
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 ListProxySessionsResult listProxySessions(ListProxySessionsRequest request)
AmazonChime
Lists the proxy sessions for the specified Amazon Chime Voice Connector.
listProxySessions
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 ListSipMediaApplicationsResult listSipMediaApplications(ListSipMediaApplicationsRequest request)
AmazonChime
Lists the SIP media applications under the administrator's AWS account.
listSipMediaApplications
in interface AmazonChime
public ListSipRulesResult listSipRules(ListSipRulesRequest request)
AmazonChime
Lists the SIP rules under the administrator's AWS account.
listSipRules
in interface AmazonChime
public ListSupportedPhoneNumberCountriesResult listSupportedPhoneNumberCountries(ListSupportedPhoneNumberCountriesRequest request)
AmazonChime
Lists supported phone number countries.
listSupportedPhoneNumberCountries
in interface AmazonChime
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AmazonChime
Lists the tags applied to an Amazon Chime SDK meeting resource.
listTagsForResource
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 PutAppInstanceRetentionSettingsResult putAppInstanceRetentionSettings(PutAppInstanceRetentionSettingsRequest request)
AmazonChime
Sets the amount of time in days that a given AppInstance
retains data.
putAppInstanceRetentionSettings
in interface AmazonChime
public PutAppInstanceStreamingConfigurationsResult putAppInstanceStreamingConfigurations(PutAppInstanceStreamingConfigurationsRequest request)
AmazonChime
The data streaming configurations of an AppInstance
.
putAppInstanceStreamingConfigurations
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 PutRetentionSettingsResult putRetentionSettings(PutRetentionSettingsRequest request)
AmazonChime
Puts retention settings for the specified Amazon Chime Enterprise account. We recommend using AWS CloudTrail to monitor usage of this API for your account. For more information, see Logging Amazon Chime API Calls with AWS CloudTrail in the Amazon Chime Administration Guide.
To turn off existing retention settings, remove the number of days from the corresponding RetentionDays field in the RetentionSettings object. For more information about retention settings, see Managing Chat Retention Policies in the Amazon Chime Administration Guide.
putRetentionSettings
in interface AmazonChime
public PutSipMediaApplicationLoggingConfigurationResult putSipMediaApplicationLoggingConfiguration(PutSipMediaApplicationLoggingConfigurationRequest request)
AmazonChime
Updates the logging configuration for the specified SIP media application.
putSipMediaApplicationLoggingConfiguration
in interface AmazonChime
public PutVoiceConnectorEmergencyCallingConfigurationResult putVoiceConnectorEmergencyCallingConfiguration(PutVoiceConnectorEmergencyCallingConfigurationRequest request)
AmazonChime
Puts emergency calling configuration details to the specified Amazon Chime Voice Connector, such as emergency phone numbers and calling countries. Origination and termination settings must be enabled for the Amazon Chime Voice Connector before emergency calling can be configured.
putVoiceConnectorEmergencyCallingConfiguration
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.
If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to turning off origination settings.
putVoiceConnectorOrigination
in interface AmazonChime
public PutVoiceConnectorProxyResult putVoiceConnectorProxy(PutVoiceConnectorProxyRequest request)
AmazonChime
Puts the specified proxy configuration to the specified Amazon Chime Voice Connector.
putVoiceConnectorProxy
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 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.
If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to turning off termination settings.
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 RedactChannelMessageResult redactChannelMessage(RedactChannelMessageRequest request)
AmazonChime
Redacts message content, but not metadata. The message exists in the back end, but the action returns null content, and the state shows as redacted.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
redactChannelMessage
in interface AmazonChime
public RedactConversationMessageResult redactConversationMessage(RedactConversationMessageRequest request)
AmazonChime
Redacts the specified message from the specified Amazon Chime conversation.
redactConversationMessage
in interface AmazonChime
public RedactRoomMessageResult redactRoomMessage(RedactRoomMessageRequest request)
AmazonChime
Redacts the specified message from the specified Amazon Chime channel.
redactRoomMessage
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 for phone numbers that can be ordered. For US numbers, provide at least one of the following search
filters: AreaCode
, City
, State
, or TollFreePrefix
. If you
provide City
, you must also provide State
. Numbers outside the US only support the
PhoneNumberType
filter, which you must use.
searchAvailablePhoneNumbers
in interface AmazonChime
public SendChannelMessageResult sendChannelMessage(SendChannelMessageRequest request)
AmazonChime
Sends a message to a particular channel that the member is a part of.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
Also, STANDARD
messages can contain 4KB of data and the 1KB of metadata. CONTROL
messages can contain 30 bytes of data and no metadata.
sendChannelMessage
in interface AmazonChime
public StartMeetingTranscriptionResult startMeetingTranscription(StartMeetingTranscriptionRequest request)
AmazonChime
Starts transcription for the specified meetingId
.
startMeetingTranscription
in interface AmazonChime
public StopMeetingTranscriptionResult stopMeetingTranscription(StopMeetingTranscriptionRequest request)
AmazonChime
Stops transcription for the specified meetingId
.
stopMeetingTranscription
in interface AmazonChime
public TagAttendeeResult tagAttendee(TagAttendeeRequest request)
AmazonChime
Applies the specified tags to the specified Amazon Chime SDK attendee.
tagAttendee
in interface AmazonChime
public TagMeetingResult tagMeeting(TagMeetingRequest request)
AmazonChime
Applies the specified tags to the specified Amazon Chime SDK meeting.
tagMeeting
in interface AmazonChime
public TagResourceResult tagResource(TagResourceRequest request)
AmazonChime
Applies the specified tags to the specified Amazon Chime SDK meeting resource.
tagResource
in interface AmazonChime
public UntagAttendeeResult untagAttendee(UntagAttendeeRequest request)
AmazonChime
Untags the specified tags from the specified Amazon Chime SDK attendee.
untagAttendee
in interface AmazonChime
public UntagMeetingResult untagMeeting(UntagMeetingRequest request)
AmazonChime
Untags the specified tags from the specified Amazon Chime SDK meeting.
untagMeeting
in interface AmazonChime
public UntagResourceResult untagResource(UntagResourceRequest request)
AmazonChime
Untags the specified tags from the specified Amazon Chime SDK meeting resource.
untagResource
in interface AmazonChime
public UpdateAccountResult updateAccount(UpdateAccountRequest request)
AmazonChime
Updates account details for the specified Amazon Chime account. Currently, only account name and default license 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 UpdateAppInstanceResult updateAppInstance(UpdateAppInstanceRequest request)
AmazonChime
Updates AppInstance
metadata.
updateAppInstance
in interface AmazonChime
public UpdateAppInstanceUserResult updateAppInstanceUser(UpdateAppInstanceUserRequest request)
AmazonChime
Updates the details of an AppInstanceUser
. You can update names and metadata.
updateAppInstanceUser
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 UpdateChannelResult updateChannel(UpdateChannelRequest request)
AmazonChime
Update a channel's attributes.
Restriction: You can't change a channel's privacy.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
updateChannel
in interface AmazonChime
public UpdateChannelMessageResult updateChannelMessage(UpdateChannelMessageRequest request)
AmazonChime
Updates the content of a message.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
updateChannelMessage
in interface AmazonChime
public UpdateChannelReadMarkerResult updateChannelReadMarker(UpdateChannelReadMarkerRequest request)
AmazonChime
The details of the time when a user last read messages in a channel.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
user that makes the API call as the value in the header.
updateChannelReadMarker
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 cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type.
Updates to outbound calling names can take 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 UpdateProxySessionResult updateProxySession(UpdateProxySessionRequest request)
AmazonChime
Updates the specified proxy session details, such as voice or SMS capabilities.
updateProxySession
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 UpdateSipMediaApplicationResult updateSipMediaApplication(UpdateSipMediaApplicationRequest request)
AmazonChime
Updates the details of the specified SIP media application.
updateSipMediaApplication
in interface AmazonChime
public UpdateSipMediaApplicationCallResult updateSipMediaApplicationCall(UpdateSipMediaApplicationCallRequest request)
AmazonChime
Invokes the AWS Lambda function associated with the SIP media application and transaction ID in an update request. The Lambda function can then return a new set of actions.
updateSipMediaApplicationCall
in interface AmazonChime
public UpdateSipRuleResult updateSipRule(UpdateSipRuleRequest request)
AmazonChime
Updates the details of the specified SIP rule.
updateSipRule
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 of the specified Amazon Chime Voice Connector group, such as the name and Amazon Chime Voice Connector priority ranking.
updateVoiceConnectorGroup
in interface AmazonChime
public ValidateE911AddressResult validateE911Address(ValidateE911AddressRequest request)
AmazonChime
Validates an address to be used for 911 calls made with Amazon Chime Voice Connectors. You can use validated addresses in a Presence Information Data Format Location Object file that you include in SIP requests. That helps ensure that addresses are routed to the appropriate Public Safety Answering Point.
validateE911Address
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.