@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonChime extends Object implements AmazonChime
AmazonChime. Convenient method forms pass through to the corresponding overload
that takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIX| Modifier | Constructor and Description |
|---|---|
protected |
AbstractAmazonChime() |
| Modifier and Type | Method and Description |
|---|---|
AssociatePhoneNumbersWithVoiceConnectorResult |
associatePhoneNumbersWithVoiceConnector(AssociatePhoneNumbersWithVoiceConnectorRequest request)
Associates phone numbers with the specified Amazon Chime Voice Connector.
|
AssociatePhoneNumbersWithVoiceConnectorGroupResult |
associatePhoneNumbersWithVoiceConnectorGroup(AssociatePhoneNumbersWithVoiceConnectorGroupRequest request)
Associates phone numbers with the specified Amazon Chime Voice Connector group.
|
AssociatePhoneNumberWithUserResult |
associatePhoneNumberWithUser(AssociatePhoneNumberWithUserRequest request)
Associates a phone number with the specified Amazon Chime user.
|
AssociateSigninDelegateGroupsWithAccountResult |
associateSigninDelegateGroupsWithAccount(AssociateSigninDelegateGroupsWithAccountRequest request)
Associates the specified sign-in delegate groups with the specified Amazon Chime account.
|
BatchCreateAttendeeResult |
batchCreateAttendee(BatchCreateAttendeeRequest request)
Creates up to 100 new attendees for an active Amazon Chime SDK meeting.
|
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
AppInstances 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)
AmazonChimeAssociates a phone number with the specified Amazon Chime user.
associatePhoneNumberWithUser in interface AmazonChimepublic AssociatePhoneNumbersWithVoiceConnectorResult associatePhoneNumbersWithVoiceConnector(AssociatePhoneNumbersWithVoiceConnectorRequest request)
AmazonChimeAssociates phone numbers with the specified Amazon Chime Voice Connector.
associatePhoneNumbersWithVoiceConnector in interface AmazonChimepublic AssociatePhoneNumbersWithVoiceConnectorGroupResult associatePhoneNumbersWithVoiceConnectorGroup(AssociatePhoneNumbersWithVoiceConnectorGroupRequest request)
AmazonChimeAssociates phone numbers with the specified Amazon Chime Voice Connector group.
associatePhoneNumbersWithVoiceConnectorGroup in interface AmazonChimepublic AssociateSigninDelegateGroupsWithAccountResult associateSigninDelegateGroupsWithAccount(AssociateSigninDelegateGroupsWithAccountRequest request)
AmazonChimeAssociates the specified sign-in delegate groups with the specified Amazon Chime account.
associateSigninDelegateGroupsWithAccount in interface AmazonChimepublic BatchCreateAttendeeResult batchCreateAttendee(BatchCreateAttendeeRequest request)
AmazonChimeCreates 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 SDK Developer Guide.
batchCreateAttendee in interface AmazonChimepublic BatchCreateChannelMembershipResult batchCreateChannelMembership(BatchCreateChannelMembershipRequest request)
AmazonChimeAdds a specified number of users to a channel.
batchCreateChannelMembership in interface AmazonChimepublic BatchCreateRoomMembershipResult batchCreateRoomMembership(BatchCreateRoomMembershipRequest request)
AmazonChimeAdds 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 AmazonChimepublic BatchDeletePhoneNumberResult batchDeletePhoneNumber(BatchDeletePhoneNumberRequest request)
AmazonChimeMoves 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 AmazonChimepublic 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 AmazonChimepublic 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 AmazonChimepublic 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 AmazonChimepublic 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 AmazonChimepublic 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 AmazonChimepublic 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 AmazonChimepublic 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 AmazonChimepublic 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 AmazonChimepublic CreateAttendeeResult createAttendee(CreateAttendeeRequest request)
AmazonChimeCreates 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 SDK Developer Guide.
createAttendee in interface AmazonChimepublic CreateBotResult createBot(CreateBotRequest request)
AmazonChimeCreates a bot for an Amazon Chime Enterprise account.
createBot in interface AmazonChimepublic CreateChannelResult createChannel(CreateChannelRequest request)
AmazonChimeCreates 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 AmazonChimepublic 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 AmazonChimepublic 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 AmazonChimepublic 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 AmazonChimepublic CreateMediaCapturePipelineResult createMediaCapturePipeline(CreateMediaCapturePipelineRequest request)
AmazonChimeCreates a media capture pipeline.
createMediaCapturePipeline in interface AmazonChimepublic CreateMeetingResult createMeeting(CreateMeetingRequest request)
AmazonChimeCreates 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 SDK Developer Guide . For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide .
createMeeting in interface AmazonChimepublic CreateMeetingDialOutResult createMeetingDialOut(CreateMeetingDialOutRequest request)
AmazonChimeUses 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 AmazonChimepublic CreateMeetingWithAttendeesResult createMeetingWithAttendees(CreateMeetingWithAttendeesRequest request)
AmazonChimeCreates 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 SDK Developer Guide . For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide .
createMeetingWithAttendees in interface AmazonChimepublic CreatePhoneNumberOrderResult createPhoneNumberOrder(CreatePhoneNumberOrderRequest request)
AmazonChimeCreates 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 AmazonChimepublic CreateProxySessionResult createProxySession(CreateProxySessionRequest request)
AmazonChimeCreates a proxy session on the specified Amazon Chime Voice Connector for the specified participant phone numbers.
createProxySession in interface AmazonChimepublic CreateRoomResult createRoom(CreateRoomRequest request)
AmazonChimeCreates a chat room for the specified Amazon Chime Enterprise account.
createRoom in interface AmazonChimepublic CreateRoomMembershipResult createRoomMembership(CreateRoomMembershipRequest request)
AmazonChimeAdds 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 AmazonChimepublic CreateSipMediaApplicationResult createSipMediaApplication(CreateSipMediaApplicationRequest request)
AmazonChimeCreates a SIP media application.
createSipMediaApplication in interface AmazonChimepublic 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 AmazonChimepublic CreateSipRuleResult createSipRule(CreateSipRuleRequest request)
AmazonChimeCreates a SIP rule which can be used to run a SIP media application as a target for a specific trigger type.
createSipRule in interface AmazonChimepublic CreateUserResult createUser(CreateUserRequest request)
AmazonChimeCreates a user under the specified Amazon Chime account.
createUser in interface AmazonChimepublic CreateVoiceConnectorResult createVoiceConnector(CreateVoiceConnectorRequest request)
AmazonChimeCreates 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 AmazonChimepublic 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 AmazonChimepublic 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 AmazonChimepublic DeleteAppInstanceResult deleteAppInstance(DeleteAppInstanceRequest request)
AmazonChime
Deletes an AppInstance and all associated data asynchronously.
deleteAppInstance in interface AmazonChimepublic DeleteAppInstanceAdminResult deleteAppInstanceAdmin(DeleteAppInstanceAdminRequest request)
AmazonChime
Demotes an AppInstanceAdmin to an AppInstanceUser. This action does not delete the
user.
deleteAppInstanceAdmin in interface AmazonChimepublic DeleteAppInstanceStreamingConfigurationsResult deleteAppInstanceStreamingConfigurations(DeleteAppInstanceStreamingConfigurationsRequest request)
AmazonChime
Deletes the streaming configurations of an AppInstance.
deleteAppInstanceStreamingConfigurations in interface AmazonChimepublic DeleteAppInstanceUserResult deleteAppInstanceUser(DeleteAppInstanceUserRequest request)
AmazonChime
Deletes an AppInstanceUser.
deleteAppInstanceUser in interface AmazonChimepublic 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 SDK Developer Guide.
deleteAttendee in interface AmazonChimepublic DeleteChannelResult deleteChannel(DeleteChannelRequest request)
AmazonChimeImmediately 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 AmazonChimepublic DeleteChannelBanResult deleteChannelBan(DeleteChannelBanRequest request)
AmazonChimeRemoves 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 AmazonChimepublic DeleteChannelMembershipResult deleteChannelMembership(DeleteChannelMembershipRequest request)
AmazonChimeRemoves 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 AmazonChimepublic 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 AmazonChimepublic DeleteChannelModeratorResult deleteChannelModerator(DeleteChannelModeratorRequest request)
AmazonChimeDeletes 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 AmazonChimepublic DeleteEventsConfigurationResult deleteEventsConfiguration(DeleteEventsConfigurationRequest request)
AmazonChimeDeletes the events configuration that allows a bot to receive outgoing events.
deleteEventsConfiguration in interface AmazonChimepublic DeleteMediaCapturePipelineResult deleteMediaCapturePipeline(DeleteMediaCapturePipelineRequest request)
AmazonChimeDeletes the media capture pipeline.
deleteMediaCapturePipeline in interface AmazonChimepublic DeleteMeetingResult deleteMeeting(DeleteMeetingRequest request)
AmazonChimeDeletes 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 SDK Developer Guide.
deleteMeeting in interface AmazonChimepublic DeletePhoneNumberResult deletePhoneNumber(DeletePhoneNumberRequest request)
AmazonChimeMoves 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 AmazonChimepublic DeleteProxySessionResult deleteProxySession(DeleteProxySessionRequest request)
AmazonChimeDeletes the specified proxy session from the specified Amazon Chime Voice Connector.
deleteProxySession in interface AmazonChimepublic DeleteRoomResult deleteRoom(DeleteRoomRequest request)
AmazonChimeDeletes a chat room in an Amazon Chime Enterprise account.
deleteRoom in interface AmazonChimepublic DeleteRoomMembershipResult deleteRoomMembership(DeleteRoomMembershipRequest request)
AmazonChimeRemoves a member from a chat room in an Amazon Chime Enterprise account.
deleteRoomMembership in interface AmazonChimepublic DeleteSipMediaApplicationResult deleteSipMediaApplication(DeleteSipMediaApplicationRequest request)
AmazonChimeDeletes a SIP media application.
deleteSipMediaApplication in interface AmazonChimepublic DeleteSipRuleResult deleteSipRule(DeleteSipRuleRequest request)
AmazonChimeDeletes a SIP rule. You must disable a SIP rule before you can delete it.
deleteSipRule in interface AmazonChimepublic DeleteVoiceConnectorResult deleteVoiceConnector(DeleteVoiceConnectorRequest request)
AmazonChimeDeletes 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 AmazonChimepublic DeleteVoiceConnectorEmergencyCallingConfigurationResult deleteVoiceConnectorEmergencyCallingConfiguration(DeleteVoiceConnectorEmergencyCallingConfigurationRequest request)
AmazonChimeDeletes the emergency calling configuration details from the specified Amazon Chime Voice Connector.
deleteVoiceConnectorEmergencyCallingConfiguration in interface AmazonChimepublic 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 AmazonChimepublic DeleteVoiceConnectorOriginationResult deleteVoiceConnectorOrigination(DeleteVoiceConnectorOriginationRequest request)
AmazonChimeDeletes 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 AmazonChimepublic DeleteVoiceConnectorProxyResult deleteVoiceConnectorProxy(DeleteVoiceConnectorProxyRequest request)
AmazonChimeDeletes the proxy configuration from the specified Amazon Chime Voice Connector.
deleteVoiceConnectorProxy in interface AmazonChimepublic DeleteVoiceConnectorStreamingConfigurationResult deleteVoiceConnectorStreamingConfiguration(DeleteVoiceConnectorStreamingConfigurationRequest request)
AmazonChimeDeletes the streaming configuration for the specified Amazon Chime Voice Connector.
deleteVoiceConnectorStreamingConfiguration in interface AmazonChimepublic DeleteVoiceConnectorTerminationResult deleteVoiceConnectorTermination(DeleteVoiceConnectorTerminationRequest request)
AmazonChimeDeletes 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 AmazonChimepublic DeleteVoiceConnectorTerminationCredentialsResult deleteVoiceConnectorTerminationCredentials(DeleteVoiceConnectorTerminationCredentialsRequest request)
AmazonChimeDeletes the specified SIP credentials used by your equipment to authenticate during call termination.
deleteVoiceConnectorTerminationCredentials in interface AmazonChimepublic DescribeAppInstanceResult describeAppInstance(DescribeAppInstanceRequest request)
AmazonChime
Returns the full details of an AppInstance.
describeAppInstance in interface AmazonChimepublic DescribeAppInstanceAdminResult describeAppInstanceAdmin(DescribeAppInstanceAdminRequest request)
AmazonChime
Returns the full details of an AppInstanceAdmin.
describeAppInstanceAdmin in interface AmazonChimepublic DescribeAppInstanceUserResult describeAppInstanceUser(DescribeAppInstanceUserRequest request)
AmazonChime
Returns the full details of an AppInstanceUser.
describeAppInstanceUser in interface AmazonChimepublic 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 AmazonChimepublic DescribeChannelBanResult describeChannelBan(DescribeChannelBanRequest request)
AmazonChimeReturns 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 AmazonChimepublic DescribeChannelMembershipResult describeChannelMembership(DescribeChannelMembershipRequest request)
AmazonChimeReturns 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 AmazonChimepublic 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 AmazonChimepublic 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 AmazonChimepublic DescribeChannelModeratorResult describeChannelModerator(DescribeChannelModeratorRequest request)
AmazonChimeReturns 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 AmazonChimepublic DisassociatePhoneNumberFromUserResult disassociatePhoneNumberFromUser(DisassociatePhoneNumberFromUserRequest request)
AmazonChimeDisassociates the primary provisioned phone number from the specified Amazon Chime user.
disassociatePhoneNumberFromUser in interface AmazonChimepublic DisassociatePhoneNumbersFromVoiceConnectorResult disassociatePhoneNumbersFromVoiceConnector(DisassociatePhoneNumbersFromVoiceConnectorRequest request)
AmazonChimeDisassociates the specified phone numbers from the specified Amazon Chime Voice Connector.
disassociatePhoneNumbersFromVoiceConnector in interface AmazonChimepublic DisassociatePhoneNumbersFromVoiceConnectorGroupResult disassociatePhoneNumbersFromVoiceConnectorGroup(DisassociatePhoneNumbersFromVoiceConnectorGroupRequest request)
AmazonChimeDisassociates the specified phone numbers from the specified Amazon Chime Voice Connector group.
disassociatePhoneNumbersFromVoiceConnectorGroup in interface AmazonChimepublic DisassociateSigninDelegateGroupsFromAccountResult disassociateSigninDelegateGroupsFromAccount(DisassociateSigninDelegateGroupsFromAccountRequest request)
AmazonChimeDisassociates the specified sign-in delegate groups from the specified Amazon Chime account.
disassociateSigninDelegateGroupsFromAccount in interface AmazonChimepublic GetAccountResult getAccount(GetAccountRequest request)
AmazonChimeRetrieves details for the specified Amazon Chime account, such as account type and supported licenses.
getAccount in interface AmazonChimepublic GetAccountSettingsResult getAccountSettings(GetAccountSettingsRequest request)
AmazonChimeRetrieves 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 AmazonChimepublic GetAppInstanceRetentionSettingsResult getAppInstanceRetentionSettings(GetAppInstanceRetentionSettingsRequest request)
AmazonChime
Gets the retention settings for an AppInstance.
getAppInstanceRetentionSettings in interface AmazonChimepublic GetAppInstanceStreamingConfigurationsResult getAppInstanceStreamingConfigurations(GetAppInstanceStreamingConfigurationsRequest request)
AmazonChime
Gets the streaming settings for an AppInstance.
getAppInstanceStreamingConfigurations in interface AmazonChimepublic GetAttendeeResult getAttendee(GetAttendeeRequest request)
AmazonChimeGets 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 SDK Developer Guide .
getAttendee in interface AmazonChimepublic GetBotResult getBot(GetBotRequest request)
AmazonChimeRetrieves details for the specified bot, such as bot email address, bot type, status, and display name.
getBot in interface AmazonChimepublic GetChannelMessageResult getChannelMessage(GetChannelMessageRequest request)
AmazonChimeGets 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 AmazonChimepublic GetEventsConfigurationResult getEventsConfiguration(GetEventsConfigurationRequest request)
AmazonChimeGets 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 AmazonChimepublic GetGlobalSettingsResult getGlobalSettings(GetGlobalSettingsRequest request)
AmazonChimeRetrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
getGlobalSettings in interface AmazonChimepublic GetMediaCapturePipelineResult getMediaCapturePipeline(GetMediaCapturePipelineRequest request)
AmazonChimeGets an existing media capture pipeline.
getMediaCapturePipeline in interface AmazonChimepublic GetMeetingResult getMeeting(GetMeetingRequest request)
AmazonChimeGets 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 SDK Developer Guide .
getMeeting in interface AmazonChimepublic GetMessagingSessionEndpointResult getMessagingSessionEndpoint(GetMessagingSessionEndpointRequest request)
AmazonChimeThe details of the endpoint for the messaging session.
getMessagingSessionEndpoint in interface AmazonChimepublic GetPhoneNumberResult getPhoneNumber(GetPhoneNumberRequest request)
AmazonChimeRetrieves details for the specified phone number ID, such as associations, capabilities, and product type.
getPhoneNumber in interface AmazonChimepublic GetPhoneNumberOrderResult getPhoneNumberOrder(GetPhoneNumberOrderRequest request)
AmazonChimeRetrieves 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 AmazonChimepublic GetPhoneNumberSettingsResult getPhoneNumberSettings(GetPhoneNumberSettingsRequest request)
AmazonChimeRetrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.
getPhoneNumberSettings in interface AmazonChimepublic GetProxySessionResult getProxySession(GetProxySessionRequest request)
AmazonChimeGets the specified proxy session details for the specified Amazon Chime Voice Connector.
getProxySession in interface AmazonChimepublic GetRetentionSettingsResult getRetentionSettings(GetRetentionSettingsRequest request)
AmazonChimeGets 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 AmazonChimepublic GetRoomResult getRoom(GetRoomRequest request)
AmazonChimeRetrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.
getRoom in interface AmazonChimepublic GetSipMediaApplicationResult getSipMediaApplication(GetSipMediaApplicationRequest request)
AmazonChimeRetrieves the information for a SIP media application, including name, AWS Region, and endpoints.
getSipMediaApplication in interface AmazonChimepublic GetSipMediaApplicationLoggingConfigurationResult getSipMediaApplicationLoggingConfiguration(GetSipMediaApplicationLoggingConfigurationRequest request)
AmazonChimeReturns the logging configuration for the specified SIP media application.
getSipMediaApplicationLoggingConfiguration in interface AmazonChimepublic GetSipRuleResult getSipRule(GetSipRuleRequest request)
AmazonChimeRetrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.
getSipRule in interface AmazonChimepublic GetUserResult getUser(GetUserRequest request)
AmazonChimeRetrieves 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 AmazonChimepublic GetUserSettingsResult getUserSettings(GetUserSettingsRequest request)
AmazonChimeRetrieves settings for the specified user ID, such as any associated phone number settings.
getUserSettings in interface AmazonChimepublic GetVoiceConnectorResult getVoiceConnector(GetVoiceConnectorRequest request)
AmazonChimeRetrieves details for the specified Amazon Chime Voice Connector, such as timestamps,name, outbound host, and encryption requirements.
getVoiceConnector in interface AmazonChimepublic GetVoiceConnectorEmergencyCallingConfigurationResult getVoiceConnectorEmergencyCallingConfiguration(GetVoiceConnectorEmergencyCallingConfigurationRequest request)
AmazonChimeGets the emergency calling configuration details for the specified Amazon Chime Voice Connector.
getVoiceConnectorEmergencyCallingConfiguration in interface AmazonChimepublic 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 AmazonChimepublic GetVoiceConnectorLoggingConfigurationResult getVoiceConnectorLoggingConfiguration(GetVoiceConnectorLoggingConfigurationRequest request)
AmazonChimeRetrieves 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 AmazonChimepublic GetVoiceConnectorOriginationResult getVoiceConnectorOrigination(GetVoiceConnectorOriginationRequest request)
AmazonChimeRetrieves origination setting details for the specified Amazon Chime Voice Connector.
getVoiceConnectorOrigination in interface AmazonChimepublic GetVoiceConnectorProxyResult getVoiceConnectorProxy(GetVoiceConnectorProxyRequest request)
AmazonChimeGets the proxy configuration details for the specified Amazon Chime Voice Connector.
getVoiceConnectorProxy in interface AmazonChimepublic GetVoiceConnectorStreamingConfigurationResult getVoiceConnectorStreamingConfiguration(GetVoiceConnectorStreamingConfigurationRequest request)
AmazonChimeRetrieves 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 AmazonChimepublic GetVoiceConnectorTerminationResult getVoiceConnectorTermination(GetVoiceConnectorTerminationRequest request)
AmazonChimeRetrieves termination setting details for the specified Amazon Chime Voice Connector.
getVoiceConnectorTermination in interface AmazonChimepublic 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 AmazonChimepublic 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 AmazonChimepublic ListAccountsResult listAccounts(ListAccountsRequest request)
AmazonChimeLists 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 AmazonChimepublic ListAppInstanceAdminsResult listAppInstanceAdmins(ListAppInstanceAdminsRequest request)
AmazonChime
Returns a list of the administrators in the AppInstance.
listAppInstanceAdmins in interface AmazonChimepublic ListAppInstanceUsersResult listAppInstanceUsers(ListAppInstanceUsersRequest request)
AmazonChime
List all AppInstanceUsers created under a single AppInstance.
listAppInstanceUsers in interface AmazonChimepublic ListAppInstancesResult listAppInstances(ListAppInstancesRequest request)
AmazonChime
Lists all Amazon Chime AppInstances created under a single AWS account.
listAppInstances in interface AmazonChimepublic ListAttendeeTagsResult listAttendeeTags(ListAttendeeTagsRequest request)
AmazonChimeLists the tags applied to an Amazon Chime SDK attendee resource.
listAttendeeTags in interface AmazonChimepublic ListAttendeesResult listAttendees(ListAttendeesRequest request)
AmazonChimeLists 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 SDK Developer Guide.
listAttendees in interface AmazonChimepublic ListBotsResult listBots(ListBotsRequest request)
AmazonChimeLists the bots associated with the administrator's Amazon Chime Enterprise account ID.
listBots in interface AmazonChimepublic ListChannelBansResult listChannelBans(ListChannelBansRequest request)
AmazonChimeLists 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 AmazonChimepublic ListChannelMembershipsResult listChannelMemberships(ListChannelMembershipsRequest request)
AmazonChimeLists 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 AmazonChimepublic 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 AmazonChimepublic 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 AmazonChimepublic ListChannelModeratorsResult listChannelModerators(ListChannelModeratorsRequest request)
AmazonChimeLists 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 AmazonChimepublic ListChannelsResult listChannels(ListChannelsRequest request)
AmazonChimeLists 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 AmazonChimepublic 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 AmazonChimepublic ListMediaCapturePipelinesResult listMediaCapturePipelines(ListMediaCapturePipelinesRequest request)
AmazonChimeReturns a list of media capture pipelines.
listMediaCapturePipelines in interface AmazonChimepublic ListMeetingTagsResult listMeetingTags(ListMeetingTagsRequest request)
AmazonChimeLists the tags applied to an Amazon Chime SDK meeting resource.
listMeetingTags in interface AmazonChimepublic ListMeetingsResult listMeetings(ListMeetingsRequest request)
AmazonChimeLists 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 SDK Developer Guide.
listMeetings in interface AmazonChimepublic ListPhoneNumberOrdersResult listPhoneNumberOrders(ListPhoneNumberOrdersRequest request)
AmazonChimeLists the phone number orders for the administrator's Amazon Chime account.
listPhoneNumberOrders in interface AmazonChimepublic ListPhoneNumbersResult listPhoneNumbers(ListPhoneNumbersRequest request)
AmazonChimeLists 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 AmazonChimepublic ListProxySessionsResult listProxySessions(ListProxySessionsRequest request)
AmazonChimeLists the proxy sessions for the specified Amazon Chime Voice Connector.
listProxySessions in interface AmazonChimepublic ListRoomMembershipsResult listRoomMemberships(ListRoomMembershipsRequest request)
AmazonChimeLists 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 AmazonChimepublic ListRoomsResult listRooms(ListRoomsRequest request)
AmazonChimeLists 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 AmazonChimepublic ListSipMediaApplicationsResult listSipMediaApplications(ListSipMediaApplicationsRequest request)
AmazonChimeLists the SIP media applications under the administrator's AWS account.
listSipMediaApplications in interface AmazonChimepublic ListSipRulesResult listSipRules(ListSipRulesRequest request)
AmazonChimeLists the SIP rules under the administrator's AWS account.
listSipRules in interface AmazonChimepublic ListSupportedPhoneNumberCountriesResult listSupportedPhoneNumberCountries(ListSupportedPhoneNumberCountriesRequest request)
AmazonChimeLists supported phone number countries.
listSupportedPhoneNumberCountries in interface AmazonChimepublic ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AmazonChimeLists the tags applied to an Amazon Chime SDK meeting resource.
listTagsForResource in interface AmazonChimepublic ListUsersResult listUsers(ListUsersRequest request)
AmazonChimeLists 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 AmazonChimepublic ListVoiceConnectorGroupsResult listVoiceConnectorGroups(ListVoiceConnectorGroupsRequest request)
AmazonChimeLists the Amazon Chime Voice Connector groups for the administrator's AWS account.
listVoiceConnectorGroups in interface AmazonChimepublic ListVoiceConnectorTerminationCredentialsResult listVoiceConnectorTerminationCredentials(ListVoiceConnectorTerminationCredentialsRequest request)
AmazonChimeLists the SIP credentials for the specified Amazon Chime Voice Connector.
listVoiceConnectorTerminationCredentials in interface AmazonChimepublic ListVoiceConnectorsResult listVoiceConnectors(ListVoiceConnectorsRequest request)
AmazonChimeLists the Amazon Chime Voice Connectors for the administrator's AWS account.
listVoiceConnectors in interface AmazonChimepublic LogoutUserResult logoutUser(LogoutUserRequest request)
AmazonChimeLogs out the specified user from all of the devices they are currently logged into.
logoutUser in interface AmazonChimepublic PutAppInstanceRetentionSettingsResult putAppInstanceRetentionSettings(PutAppInstanceRetentionSettingsRequest request)
AmazonChime
Sets the amount of time in days that a given AppInstance retains data.
putAppInstanceRetentionSettings in interface AmazonChimepublic PutAppInstanceStreamingConfigurationsResult putAppInstanceStreamingConfigurations(PutAppInstanceStreamingConfigurationsRequest request)
AmazonChime
The data streaming configurations of an AppInstance.
putAppInstanceStreamingConfigurations in interface AmazonChimepublic PutEventsConfigurationResult putEventsConfiguration(PutEventsConfigurationRequest request)
AmazonChimeCreates 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 AmazonChimepublic PutRetentionSettingsResult putRetentionSettings(PutRetentionSettingsRequest request)
AmazonChimePuts 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 AmazonChimepublic PutSipMediaApplicationLoggingConfigurationResult putSipMediaApplicationLoggingConfiguration(PutSipMediaApplicationLoggingConfigurationRequest request)
AmazonChimeUpdates the logging configuration for the specified SIP media application.
putSipMediaApplicationLoggingConfiguration in interface AmazonChimepublic PutVoiceConnectorEmergencyCallingConfigurationResult putVoiceConnectorEmergencyCallingConfiguration(PutVoiceConnectorEmergencyCallingConfigurationRequest request)
AmazonChimePuts 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 AmazonChimepublic PutVoiceConnectorLoggingConfigurationResult putVoiceConnectorLoggingConfiguration(PutVoiceConnectorLoggingConfigurationRequest request)
AmazonChimeAdds 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 AmazonChimepublic PutVoiceConnectorOriginationResult putVoiceConnectorOrigination(PutVoiceConnectorOriginationRequest request)
AmazonChimeAdds 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 AmazonChimepublic PutVoiceConnectorProxyResult putVoiceConnectorProxy(PutVoiceConnectorProxyRequest request)
AmazonChimePuts the specified proxy configuration to the specified Amazon Chime Voice Connector.
putVoiceConnectorProxy in interface AmazonChimepublic PutVoiceConnectorStreamingConfigurationResult putVoiceConnectorStreamingConfiguration(PutVoiceConnectorStreamingConfigurationRequest request)
AmazonChimeAdds 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 AmazonChimepublic PutVoiceConnectorTerminationResult putVoiceConnectorTermination(PutVoiceConnectorTerminationRequest request)
AmazonChimeAdds 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 AmazonChimepublic PutVoiceConnectorTerminationCredentialsResult putVoiceConnectorTerminationCredentials(PutVoiceConnectorTerminationCredentialsRequest request)
AmazonChimeAdds termination SIP credentials for the specified Amazon Chime Voice Connector.
putVoiceConnectorTerminationCredentials in interface AmazonChimepublic RedactChannelMessageResult redactChannelMessage(RedactChannelMessageRequest request)
AmazonChimeRedacts 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 AmazonChimepublic RedactConversationMessageResult redactConversationMessage(RedactConversationMessageRequest request)
AmazonChimeRedacts the specified message from the specified Amazon Chime conversation.
redactConversationMessage in interface AmazonChimepublic RedactRoomMessageResult redactRoomMessage(RedactRoomMessageRequest request)
AmazonChimeRedacts the specified message from the specified Amazon Chime channel.
redactRoomMessage in interface AmazonChimepublic RegenerateSecurityTokenResult regenerateSecurityToken(RegenerateSecurityTokenRequest request)
AmazonChimeRegenerates the security token for a bot.
regenerateSecurityToken in interface AmazonChimepublic ResetPersonalPINResult resetPersonalPIN(ResetPersonalPINRequest request)
AmazonChimeResets 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 AmazonChimepublic RestorePhoneNumberResult restorePhoneNumber(RestorePhoneNumberRequest request)
AmazonChimeMoves a phone number from the Deletion queue back into the phone number Inventory.
restorePhoneNumber in interface AmazonChimepublic 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 AmazonChimepublic SendChannelMessageResult sendChannelMessage(SendChannelMessageRequest request)
AmazonChimeSends 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 AmazonChimepublic StartMeetingTranscriptionResult startMeetingTranscription(StartMeetingTranscriptionRequest request)
AmazonChime
Starts transcription for the specified meetingId. For more information, refer to Using Amazon Chime SDK live
transcription in the Amazon Chime SDK Developer Guide.
If you specify an invalid configuration, a TranscriptFailed event will be sent with the contents of
the BadRequestException generated by Amazon Transcribe. For more information on each parameter and
which combinations are valid, refer to the StartStreamTranscription API in the Amazon Transcribe Developer Guide.
Amazon Chime SDK live transcription is powered by Amazon Transcribe. Use of Amazon Transcribe is subject to the AWS Service Terms, including the terms specific to the AWS Machine Learning and Artificial Intelligence Services.
startMeetingTranscription in interface AmazonChimepublic StopMeetingTranscriptionResult stopMeetingTranscription(StopMeetingTranscriptionRequest request)
AmazonChime
Stops transcription for the specified meetingId.
stopMeetingTranscription in interface AmazonChimepublic TagAttendeeResult tagAttendee(TagAttendeeRequest request)
AmazonChimeApplies the specified tags to the specified Amazon Chime SDK attendee.
tagAttendee in interface AmazonChimepublic TagMeetingResult tagMeeting(TagMeetingRequest request)
AmazonChimeApplies the specified tags to the specified Amazon Chime SDK meeting.
tagMeeting in interface AmazonChimepublic TagResourceResult tagResource(TagResourceRequest request)
AmazonChimeApplies the specified tags to the specified Amazon Chime SDK meeting resource.
tagResource in interface AmazonChimepublic UntagAttendeeResult untagAttendee(UntagAttendeeRequest request)
AmazonChimeUntags the specified tags from the specified Amazon Chime SDK attendee.
untagAttendee in interface AmazonChimepublic UntagMeetingResult untagMeeting(UntagMeetingRequest request)
AmazonChimeUntags the specified tags from the specified Amazon Chime SDK meeting.
untagMeeting in interface AmazonChimepublic UntagResourceResult untagResource(UntagResourceRequest request)
AmazonChimeUntags the specified tags from the specified Amazon Chime SDK meeting resource.
untagResource in interface AmazonChimepublic UpdateAccountResult updateAccount(UpdateAccountRequest request)
AmazonChimeUpdates account details for the specified Amazon Chime account. Currently, only account name and default license updates are supported for this action.
updateAccount in interface AmazonChimepublic UpdateAccountSettingsResult updateAccountSettings(UpdateAccountSettingsRequest request)
AmazonChimeUpdates 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 AmazonChimepublic UpdateAppInstanceResult updateAppInstance(UpdateAppInstanceRequest request)
AmazonChime
Updates AppInstance metadata.
updateAppInstance in interface AmazonChimepublic UpdateAppInstanceUserResult updateAppInstanceUser(UpdateAppInstanceUserRequest request)
AmazonChime
Updates the details of an AppInstanceUser. You can update names and metadata.
updateAppInstanceUser in interface AmazonChimepublic UpdateBotResult updateBot(UpdateBotRequest request)
AmazonChimeUpdates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.
updateBot in interface AmazonChimepublic UpdateChannelResult updateChannel(UpdateChannelRequest request)
AmazonChimeUpdate 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 AmazonChimepublic UpdateChannelMessageResult updateChannelMessage(UpdateChannelMessageRequest request)
AmazonChimeUpdates 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 AmazonChimepublic UpdateChannelReadMarkerResult updateChannelReadMarker(UpdateChannelReadMarkerRequest request)
AmazonChimeThe 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 AmazonChimepublic UpdateGlobalSettingsResult updateGlobalSettings(UpdateGlobalSettingsRequest request)
AmazonChimeUpdates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
updateGlobalSettings in interface AmazonChimepublic UpdatePhoneNumberResult updatePhoneNumber(UpdatePhoneNumberRequest request)
AmazonChimeUpdates 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 AmazonChimepublic UpdatePhoneNumberSettingsResult updatePhoneNumberSettings(UpdatePhoneNumberSettingsRequest request)
AmazonChimeUpdates 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 AmazonChimepublic UpdateProxySessionResult updateProxySession(UpdateProxySessionRequest request)
AmazonChimeUpdates the specified proxy session details, such as voice or SMS capabilities.
updateProxySession in interface AmazonChimepublic UpdateRoomResult updateRoom(UpdateRoomRequest request)
AmazonChimeUpdates room details, such as the room name, for a room in an Amazon Chime Enterprise account.
updateRoom in interface AmazonChimepublic UpdateRoomMembershipResult updateRoomMembership(UpdateRoomMembershipRequest request)
AmazonChimeUpdates 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 AmazonChimepublic UpdateSipMediaApplicationResult updateSipMediaApplication(UpdateSipMediaApplicationRequest request)
AmazonChimeUpdates the details of the specified SIP media application.
updateSipMediaApplication in interface AmazonChimepublic UpdateSipMediaApplicationCallResult updateSipMediaApplicationCall(UpdateSipMediaApplicationCallRequest request)
AmazonChimeInvokes 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 AmazonChimepublic UpdateSipRuleResult updateSipRule(UpdateSipRuleRequest request)
AmazonChimeUpdates the details of the specified SIP rule.
updateSipRule in interface AmazonChimepublic 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 AmazonChimepublic UpdateUserSettingsResult updateUserSettings(UpdateUserSettingsRequest request)
AmazonChimeUpdates the settings for the specified user, such as phone number settings.
updateUserSettings in interface AmazonChimepublic UpdateVoiceConnectorResult updateVoiceConnector(UpdateVoiceConnectorRequest request)
AmazonChimeUpdates details for the specified Amazon Chime Voice Connector.
updateVoiceConnector in interface AmazonChimepublic UpdateVoiceConnectorGroupResult updateVoiceConnectorGroup(UpdateVoiceConnectorGroupRequest request)
AmazonChimeUpdates details of the specified Amazon Chime Voice Connector group, such as the name and Amazon Chime Voice Connector priority ranking.
updateVoiceConnectorGroup in interface AmazonChimepublic ValidateE911AddressResult validateE911Address(ValidateE911AddressRequest request)
AmazonChimeValidates 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 AmazonChimepublic void shutdown()
AmazonChimeshutdown in interface AmazonChimepublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonChimeResponse 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 AmazonChimerequest - The originally executed request.Copyright © 2023. All rights reserved.