@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_PREFIXpublic AssociatePhoneNumberWithUserResult associatePhoneNumberWithUser(AssociatePhoneNumberWithUserRequest request)
AmazonChimeAssociates a phone number with the specified Amazon Chime user.
associatePhoneNumberWithUser in interface AmazonChime@Deprecated public AssociatePhoneNumbersWithVoiceConnectorResult associatePhoneNumbersWithVoiceConnector(AssociatePhoneNumbersWithVoiceConnectorRequest request)
AmazonChimeAssociates phone numbers with the specified Amazon Chime Voice Connector.
This API is is no longer supported and will not be updated. We recommend using the latest version, AssociatePhoneNumbersWithVoiceConnector, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
associatePhoneNumbersWithVoiceConnector in interface AmazonChime@Deprecated public AssociatePhoneNumbersWithVoiceConnectorGroupResult associatePhoneNumbersWithVoiceConnectorGroup(AssociatePhoneNumbersWithVoiceConnectorGroupRequest request)
AmazonChimeAssociates phone numbers with the specified Amazon Chime Voice Connector group.
This API is is no longer supported and will not be updated. We recommend using the latest version, AssociatePhoneNumbersWithVoiceConnectorGroup, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
associatePhoneNumbersWithVoiceConnectorGroup in interface AmazonChimepublic AssociateSigninDelegateGroupsWithAccountResult associateSigninDelegateGroupsWithAccount(AssociateSigninDelegateGroupsWithAccountRequest request)
AmazonChimeAssociates the specified sign-in delegate groups with the specified Amazon Chime account.
associateSigninDelegateGroupsWithAccount in interface AmazonChime@Deprecated public BatchCreateAttendeeResult batchCreateAttendee(BatchCreateAttendeeRequest request)
AmazonChimeCreates up to 100 new attendees for an active Amazon Chime SDK meeting.
This API is is no longer supported and will not be updated. We recommend using the latest version, BatchCreateAttendee, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace 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.
batchCreateAttendee in interface AmazonChime@Deprecated public BatchCreateChannelMembershipResult batchCreateChannelMembership(BatchCreateChannelMembershipRequest request)
AmazonChimeAdds a specified number of users to a channel.
This API is is no longer supported and will not be updated. We recommend using the latest version, BatchCreateChannelMembership, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
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 AmazonChime@Deprecated public CreateAppInstanceResult createAppInstance(CreateAppInstanceRequest request)
AmazonChime
Creates an Amazon Chime SDK messaging AppInstance under an AWS account. Only SDK messaging customers
use this API. CreateAppInstance supports idempotency behavior as described in the AWS API Standard.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateAppInstance, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
createAppInstance in interface AmazonChime@Deprecated public CreateAppInstanceAdminResult createAppInstanceAdmin(CreateAppInstanceAdminRequest request)
AmazonChime
Promotes an AppInstanceUser to an AppInstanceAdmin. The promoted user can perform the
following actions.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateAppInstanceAdmin, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
ChannelModerator actions across all channels in the AppInstance.
DeleteChannelMessage actions.
Only an AppInstanceUser can be promoted to an AppInstanceAdmin role.
createAppInstanceAdmin in interface AmazonChime@Deprecated public CreateAppInstanceUserResult createAppInstanceUser(CreateAppInstanceUserRequest request)
AmazonChime
Creates a user under an Amazon Chime AppInstance. The request consists of a unique
appInstanceUserId and Name for that user.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateAppInstanceUser, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
createAppInstanceUser in interface AmazonChime@Deprecated public 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.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateAttendee , in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace 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 AmazonChime@Deprecated public 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.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateChannel , in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
createChannel in interface AmazonChime@Deprecated public CreateChannelBanResult createChannelBan(CreateChannelBanRequest request)
AmazonChime
Permanently bans a member from a channel. Moderators can't add banned members to a channel. To undo a ban, you
first have to DeleteChannelBan, and then CreateChannelMembership. Bans are cleaned up
when you delete users or channels.
If you ban a user who is already part of a channel, that user is automatically kicked from the channel.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateChannelBan, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
createChannelBan in interface AmazonChime@Deprecated public CreateChannelMembershipResult createChannelMembership(CreateChannelMembershipRequest request)
AmazonChime
Adds a user to a channel. The InvitedBy response field is derived from the request header. A channel
member can:
List messages
Send messages
Receive messages
Edit their own messages
Leave the channel
Privacy settings impact this action as follows:
Public Channels: You do not need to be a member to list messages, but you must be a member to send messages.
Private Channels: You must be a member to list or send messages.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateChannelMembership, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
createChannelMembership in interface AmazonChime@Deprecated public CreateChannelModeratorResult createChannelModerator(CreateChannelModeratorRequest request)
AmazonChime
Creates a new ChannelModerator. A channel moderator can:
Add and remove other members of the channel.
Add and remove other moderators of the channel.
Add and remove user bans for the channel.
Redact messages in the channel.
List messages in the channel.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateChannelModerator, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
createChannelModerator in interface AmazonChime@Deprecated public CreateMediaCapturePipelineResult createMediaCapturePipeline(CreateMediaCapturePipelineRequest request)
AmazonChimeCreates a media capture pipeline.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateMediaCapturePipeline, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
createMediaCapturePipeline in interface AmazonChime@Deprecated public 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.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateMeeting , in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace 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.
This API is is not available in a dedicated namespace.
createMeetingDialOut in interface AmazonChime@Deprecated public 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 .
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateMeetingWithAttendees, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace 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 AmazonChime@Deprecated public CreateProxySessionResult createProxySession(CreateProxySessionRequest request)
AmazonChimeCreates a proxy session on the specified Amazon Chime Voice Connector for the specified participant phone numbers.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateProxySession, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
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 AmazonChime@Deprecated public CreateSipMediaApplicationResult createSipMediaApplication(CreateSipMediaApplicationRequest request)
AmazonChimeCreates a SIP media application.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateSipMediaApplication, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
createSipMediaApplication in interface AmazonChime@Deprecated public CreateSipMediaApplicationCallResult createSipMediaApplicationCall(CreateSipMediaApplicationCallRequest request)
AmazonChime
Creates an outbound call to a phone number from the phone number specified in the request, and it invokes the
endpoint of the specified sipMediaApplicationId.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateSipMediaApplicationCall, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
createSipMediaApplicationCall in interface AmazonChime@Deprecated public 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.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateSipRule, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
createSipRule in interface AmazonChimepublic CreateUserResult createUser(CreateUserRequest request)
AmazonChimeCreates a user under the specified Amazon Chime account.
createUser in interface AmazonChime@Deprecated public 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.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateVoiceConnector, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
createVoiceConnector in interface AmazonChime@Deprecated public CreateVoiceConnectorGroupResult createVoiceConnectorGroup(CreateVoiceConnectorGroupRequest request)
AmazonChime
Creates an Amazon Chime Voice Connector group under the administrator's AWS account. You can associate Amazon
Chime Voice Connectors with the Amazon Chime Voice Connector group by including VoiceConnectorItems
in the request.
You can include Amazon Chime Voice Connectors from different AWS Regions in your group. This creates a fault tolerant mechanism for fallback in case of availability events.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateVoiceConnectorGroup, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
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 AmazonChime@Deprecated public DeleteAppInstanceResult deleteAppInstance(DeleteAppInstanceRequest request)
AmazonChime
Deletes an AppInstance and all associated data asynchronously.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteAppInstance, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
deleteAppInstance in interface AmazonChime@Deprecated public DeleteAppInstanceAdminResult deleteAppInstanceAdmin(DeleteAppInstanceAdminRequest request)
AmazonChime
Demotes an AppInstanceAdmin to an AppInstanceUser. This action does not delete the
user.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteAppInstanceAdmin, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
deleteAppInstanceAdmin in interface AmazonChime@Deprecated public DeleteAppInstanceStreamingConfigurationsResult deleteAppInstanceStreamingConfigurations(DeleteAppInstanceStreamingConfigurationsRequest request)
AmazonChime
Deletes the streaming configurations of an AppInstance.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteAppInstanceStreamingConfigurations, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
deleteAppInstanceStreamingConfigurations in interface AmazonChime@Deprecated public DeleteAppInstanceUserResult deleteAppInstanceUser(DeleteAppInstanceUserRequest request)
AmazonChime
Deletes an AppInstanceUser.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteAppInstanceUser, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
deleteAppInstanceUser in interface AmazonChime@Deprecated public DeleteAttendeeResult deleteAttendee(DeleteAttendeeRequest request)
AmazonChime
Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their JoinToken.
Attendees are automatically deleted when a Amazon Chime SDK meeting is deleted. For more information about the
Amazon Chime SDK, see Using the
Amazon Chime SDK in the Amazon Chime SDK Developer Guide.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteAttendee , in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
deleteAttendee in interface AmazonChime@Deprecated public 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.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteChannel , in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
deleteChannel in interface AmazonChime@Deprecated public 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.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteChannelBan, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
deleteChannelBan in interface AmazonChime@Deprecated public 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.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteChannelMembership, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
deleteChannelMembership in interface AmazonChime@Deprecated public DeleteChannelMessageResult deleteChannelMessage(DeleteChannelMessageRequest request)
AmazonChime
Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately.
A background process deletes any revisions created by UpdateChannelMessage.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteChannelMessage, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
deleteChannelMessage in interface AmazonChime@Deprecated public 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.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteChannelModerator, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
deleteChannelModerator in interface AmazonChimepublic DeleteEventsConfigurationResult deleteEventsConfiguration(DeleteEventsConfigurationRequest request)
AmazonChimeDeletes the events configuration that allows a bot to receive outgoing events.
deleteEventsConfiguration in interface AmazonChime@Deprecated public DeleteMediaCapturePipelineResult deleteMediaCapturePipeline(DeleteMediaCapturePipelineRequest request)
AmazonChimeDeletes the media capture pipeline.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteMediaCapturePipeline, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
deleteMediaCapturePipeline in interface AmazonChime@Deprecated public 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.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteMeeting , in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace 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 AmazonChime@Deprecated public DeleteProxySessionResult deleteProxySession(DeleteProxySessionRequest request)
AmazonChimeDeletes the specified proxy session from the specified Amazon Chime Voice Connector.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteProxySession, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
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 AmazonChime@Deprecated public DeleteSipMediaApplicationResult deleteSipMediaApplication(DeleteSipMediaApplicationRequest request)
AmazonChimeDeletes a SIP media application.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteSipMediaApplication, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
deleteSipMediaApplication in interface AmazonChime@Deprecated public DeleteSipRuleResult deleteSipRule(DeleteSipRuleRequest request)
AmazonChimeDeletes a SIP rule. You must disable a SIP rule before you can delete it.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteSipRule, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
deleteSipRule in interface AmazonChime@Deprecated public 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.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnector, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
deleteVoiceConnector in interface AmazonChime@Deprecated public DeleteVoiceConnectorEmergencyCallingConfigurationResult deleteVoiceConnectorEmergencyCallingConfiguration(DeleteVoiceConnectorEmergencyCallingConfigurationRequest request)
AmazonChimeDeletes the emergency calling configuration details from the specified Amazon Chime Voice Connector.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnectorEmergencyCallingConfiguration, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
deleteVoiceConnectorEmergencyCallingConfiguration in interface AmazonChime@Deprecated public DeleteVoiceConnectorGroupResult deleteVoiceConnectorGroup(DeleteVoiceConnectorGroupRequest request)
AmazonChime
Deletes the specified Amazon Chime Voice Connector group. Any VoiceConnectorItems and phone numbers
associated with the group must be removed before it can be deleted.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnectorGroup, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
deleteVoiceConnectorGroup in interface AmazonChime@Deprecated public 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.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnectorOrigination, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
deleteVoiceConnectorOrigination in interface AmazonChime@Deprecated public DeleteVoiceConnectorProxyResult deleteVoiceConnectorProxy(DeleteVoiceConnectorProxyRequest request)
AmazonChimeDeletes the proxy configuration from the specified Amazon Chime Voice Connector.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceProxy, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
deleteVoiceConnectorProxy in interface AmazonChime@Deprecated public DeleteVoiceConnectorStreamingConfigurationResult deleteVoiceConnectorStreamingConfiguration(DeleteVoiceConnectorStreamingConfigurationRequest request)
AmazonChimeDeletes the streaming configuration for the specified Amazon Chime Voice Connector.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnectorStreamingConfiguration, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
deleteVoiceConnectorStreamingConfiguration in interface AmazonChime@Deprecated public 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.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnectorTermination, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
deleteVoiceConnectorTermination in interface AmazonChime@Deprecated public DeleteVoiceConnectorTerminationCredentialsResult deleteVoiceConnectorTerminationCredentials(DeleteVoiceConnectorTerminationCredentialsRequest request)
AmazonChimeDeletes the specified SIP credentials used by your equipment to authenticate during call termination.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnectorTerminationCredentials, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
deleteVoiceConnectorTerminationCredentials in interface AmazonChime@Deprecated public DescribeAppInstanceResult describeAppInstance(DescribeAppInstanceRequest request)
AmazonChime
Returns the full details of an AppInstance.
This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeAppInstance, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
describeAppInstance in interface AmazonChime@Deprecated public DescribeAppInstanceAdminResult describeAppInstanceAdmin(DescribeAppInstanceAdminRequest request)
AmazonChime
Returns the full details of an AppInstanceAdmin.
This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeAppInstanceAdmin, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
describeAppInstanceAdmin in interface AmazonChime@Deprecated public DescribeAppInstanceUserResult describeAppInstanceUser(DescribeAppInstanceUserRequest request)
AmazonChime
Returns the full details of an AppInstanceUser.
This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeAppInstanceUser, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
describeAppInstanceUser in interface AmazonChime@Deprecated public DescribeChannelResult describeChannel(DescribeChannelRequest request)
AmazonChime
Returns the full details of a channel in an Amazon Chime AppInstance.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannel, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
describeChannel in interface AmazonChime@Deprecated public 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.
This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannelBan, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
describeChannelBan in interface AmazonChime@Deprecated public 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.
This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannelMembership, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
describeChannelMembership in interface AmazonChime@Deprecated public DescribeChannelMembershipForAppInstanceUserResult describeChannelMembershipForAppInstanceUser(DescribeChannelMembershipForAppInstanceUserRequest request)
AmazonChime
Returns the details of a channel based on the membership of the specified AppInstanceUser.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannelMembershipForAppInstanceUser, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
describeChannelMembershipForAppInstanceUser in interface AmazonChime@Deprecated public DescribeChannelModeratedByAppInstanceUserResult describeChannelModeratedByAppInstanceUser(DescribeChannelModeratedByAppInstanceUserRequest request)
AmazonChime
Returns the full details of a channel moderated by the specified AppInstanceUser.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannelModeratedByAppInstanceUser, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
describeChannelModeratedByAppInstanceUser in interface AmazonChime@Deprecated public 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.
This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannelModerator, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
describeChannelModerator in interface AmazonChimepublic DisassociatePhoneNumberFromUserResult disassociatePhoneNumberFromUser(DisassociatePhoneNumberFromUserRequest request)
AmazonChimeDisassociates the primary provisioned phone number from the specified Amazon Chime user.
disassociatePhoneNumberFromUser in interface AmazonChime@Deprecated public DisassociatePhoneNumbersFromVoiceConnectorResult disassociatePhoneNumbersFromVoiceConnector(DisassociatePhoneNumbersFromVoiceConnectorRequest request)
AmazonChimeDisassociates the specified phone numbers from the specified Amazon Chime Voice Connector.
This API is is no longer supported and will not be updated. We recommend using the latest version, DisassociatePhoneNumbersFromVoiceConnector, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
disassociatePhoneNumbersFromVoiceConnector in interface AmazonChime@Deprecated public DisassociatePhoneNumbersFromVoiceConnectorGroupResult disassociatePhoneNumbersFromVoiceConnectorGroup(DisassociatePhoneNumbersFromVoiceConnectorGroupRequest request)
AmazonChimeDisassociates the specified phone numbers from the specified Amazon Chime Voice Connector group.
This API is is no longer supported and will not be updated. We recommend using the latest version, DisassociatePhoneNumbersFromVoiceConnectorGroup, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
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 AmazonChime@Deprecated public GetAppInstanceRetentionSettingsResult getAppInstanceRetentionSettings(GetAppInstanceRetentionSettingsRequest request)
AmazonChime
Gets the retention settings for an AppInstance.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetMessagingRetentionSettings, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
getAppInstanceRetentionSettings in interface AmazonChime@Deprecated public GetAppInstanceStreamingConfigurationsResult getAppInstanceStreamingConfigurations(GetAppInstanceStreamingConfigurationsRequest request)
AmazonChime
Gets the streaming settings for an AppInstance.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetMessagingStreamingConfigurations, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
getAppInstanceStreamingConfigurations in interface AmazonChime@Deprecated public 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.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetAttendee, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace 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 AmazonChime@Deprecated public 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.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetChannelMessage, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
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 AmazonChime@Deprecated public GetMediaCapturePipelineResult getMediaCapturePipeline(GetMediaCapturePipelineRequest request)
AmazonChimeGets an existing media capture pipeline.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetMediaCapturePipeline, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
getMediaCapturePipeline in interface AmazonChime@Deprecated public GetMeetingResult getMeeting(GetMeetingRequest request)
AmazonChimeThis API is is no longer supported and will not be updated. We recommend using the latest version, GetMeeting, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Gets the Amazon Chime SDK meeting details for the specified meeting ID. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide .
getMeeting in interface AmazonChime@Deprecated public GetMessagingSessionEndpointResult getMessagingSessionEndpoint(GetMessagingSessionEndpointRequest request)
AmazonChimeThe details of the endpoint for the messaging session.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetMessagingSessionEndpoint, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
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 AmazonChime@Deprecated public GetProxySessionResult getProxySession(GetProxySessionRequest request)
AmazonChimeGets the specified proxy session details for the specified Amazon Chime Voice Connector.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetProxySession , in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
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 AmazonChime@Deprecated public GetSipMediaApplicationResult getSipMediaApplication(GetSipMediaApplicationRequest request)
AmazonChimeRetrieves the information for a SIP media application, including name, AWS Region, and endpoints.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetSipMediaApplication, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
getSipMediaApplication in interface AmazonChime@Deprecated public GetSipMediaApplicationLoggingConfigurationResult getSipMediaApplicationLoggingConfiguration(GetSipMediaApplicationLoggingConfigurationRequest request)
AmazonChimeReturns the logging configuration for the specified SIP media application.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetSipMediaApplicationLoggingConfiguration, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
getSipMediaApplicationLoggingConfiguration in interface AmazonChime@Deprecated public GetSipRuleResult getSipRule(GetSipRuleRequest request)
AmazonChimeRetrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetSipRule, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
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 AmazonChime@Deprecated public GetVoiceConnectorResult getVoiceConnector(GetVoiceConnectorRequest request)
AmazonChimeRetrieves details for the specified Amazon Chime Voice Connector, such as timestamps,name, outbound host, and encryption requirements.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnector, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
getVoiceConnector in interface AmazonChime@Deprecated public GetVoiceConnectorEmergencyCallingConfigurationResult getVoiceConnectorEmergencyCallingConfiguration(GetVoiceConnectorEmergencyCallingConfigurationRequest request)
AmazonChimeGets the emergency calling configuration details for the specified Amazon Chime Voice Connector.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorEmergencyCallingConfiguration, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
getVoiceConnectorEmergencyCallingConfiguration in interface AmazonChime@Deprecated public GetVoiceConnectorGroupResult getVoiceConnectorGroup(GetVoiceConnectorGroupRequest request)
AmazonChime
Retrieves details for the specified Amazon Chime Voice Connector group, such as timestamps,name, and associated
VoiceConnectorItems.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorGroup, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
getVoiceConnectorGroup in interface AmazonChime@Deprecated public 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.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorLoggingConfiguration, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
getVoiceConnectorLoggingConfiguration in interface AmazonChime@Deprecated public GetVoiceConnectorOriginationResult getVoiceConnectorOrigination(GetVoiceConnectorOriginationRequest request)
AmazonChimeRetrieves origination setting details for the specified Amazon Chime Voice Connector.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorOrigination, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
getVoiceConnectorOrigination in interface AmazonChime@Deprecated public GetVoiceConnectorProxyResult getVoiceConnectorProxy(GetVoiceConnectorProxyRequest request)
AmazonChimeGets the proxy configuration details for the specified Amazon Chime Voice Connector.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorProxy, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
getVoiceConnectorProxy in interface AmazonChime@Deprecated public 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.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorStreamingConfiguration, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
getVoiceConnectorStreamingConfiguration in interface AmazonChime@Deprecated public GetVoiceConnectorTerminationResult getVoiceConnectorTermination(GetVoiceConnectorTerminationRequest request)
AmazonChimeRetrieves termination setting details for the specified Amazon Chime Voice Connector.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorTermination, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
getVoiceConnectorTermination in interface AmazonChime@Deprecated public GetVoiceConnectorTerminationHealthResult getVoiceConnectorTerminationHealth(GetVoiceConnectorTerminationHealthRequest request)
AmazonChimeThis API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorTerminationHealth, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
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 AmazonChime@Deprecated public ListAppInstanceAdminsResult listAppInstanceAdmins(ListAppInstanceAdminsRequest request)
AmazonChime
Returns a list of the administrators in the AppInstance.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListAppInstanceAdmins, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
listAppInstanceAdmins in interface AmazonChime@Deprecated public ListAppInstanceUsersResult listAppInstanceUsers(ListAppInstanceUsersRequest request)
AmazonChime
List all AppInstanceUsers created under a single AppInstance.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListAppInstanceUsers, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
listAppInstanceUsers in interface AmazonChime@Deprecated public ListAppInstancesResult listAppInstances(ListAppInstancesRequest request)
AmazonChime
Lists all Amazon Chime AppInstances created under a single AWS account.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListAppInstances, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
listAppInstances in interface AmazonChime@Deprecated public ListAttendeeTagsResult listAttendeeTags(ListAttendeeTagsRequest request)
AmazonChimeLists the tags applied to an Amazon Chime SDK attendee resource.
ListAttendeeTags is not supported in the Amazon Chime SDK Meetings Namespace. Update your application to remove calls to this API.
listAttendeeTags in interface AmazonChime@Deprecated public 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.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListAttendees , in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace 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 AmazonChime@Deprecated public 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.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelBans, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
listChannelBans in interface AmazonChime@Deprecated public 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.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelMemberships, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
listChannelMemberships in interface AmazonChime@Deprecated public ListChannelMembershipsForAppInstanceUserResult listChannelMembershipsForAppInstanceUser(ListChannelMembershipsForAppInstanceUserRequest request)
AmazonChime
Lists all channels that a particular AppInstanceUser is a part of. Only an
AppInstanceAdmin can call the API with a user ARN that is not their own.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelMembershipsForAppInstanceUser, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
listChannelMembershipsForAppInstanceUser in interface AmazonChime@Deprecated public ListChannelMessagesResult listChannelMessages(ListChannelMessagesRequest request)
AmazonChime
List all the messages in a channel. Returns a paginated list of ChannelMessages. By default, sorted
by creation timestamp in descending order.
Redacted messages appear in the results as empty, since they are only redacted, not deleted. Deleted messages do not appear in the results. This action always returns the latest version of an edited message.
Also, the x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user
that makes the API call as the value in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelMessages, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
listChannelMessages in interface AmazonChime@Deprecated public 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.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelModerators, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
listChannelModerators in interface AmazonChime@Deprecated public 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.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannels , in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
listChannels in interface AmazonChime@Deprecated public ListChannelsModeratedByAppInstanceUserResult listChannelsModeratedByAppInstanceUser(ListChannelsModeratedByAppInstanceUserRequest request)
AmazonChime
A list of the channels moderated by an AppInstanceUser.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the
user that makes the API call as the value in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelsModeratedByAppInstanceUser, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
listChannelsModeratedByAppInstanceUser in interface AmazonChime@Deprecated public ListMediaCapturePipelinesResult listMediaCapturePipelines(ListMediaCapturePipelinesRequest request)
AmazonChimeReturns a list of media capture pipelines.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListMediaCapturePipelines, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
listMediaCapturePipelines in interface AmazonChime@Deprecated public ListMeetingTagsResult listMeetingTags(ListMeetingTagsRequest request)
AmazonChimeLists the tags applied to an Amazon Chime SDK meeting resource.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListTagsForResource, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
listMeetingTags in interface AmazonChime@Deprecated public ListMeetingsResult listMeetings(ListMeetingsRequest request)
AmazonChimeLists up to 100 active Amazon Chime SDK meetings.
ListMeetings is not supported in the Amazon Chime SDK Meetings Namespace. Update your application to remove calls to this API.
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 AmazonChime@Deprecated public ListProxySessionsResult listProxySessions(ListProxySessionsRequest request)
AmazonChimeLists the proxy sessions for the specified Amazon Chime Voice Connector.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListProxySessions, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
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 AmazonChime@Deprecated public ListSipMediaApplicationsResult listSipMediaApplications(ListSipMediaApplicationsRequest request)
AmazonChimeLists the SIP media applications under the administrator's AWS account.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListSipMediaApplications, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
listSipMediaApplications in interface AmazonChime@Deprecated public ListSipRulesResult listSipRules(ListSipRulesRequest request)
AmazonChimeLists the SIP rules under the administrator's AWS account.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListSipRules, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
listSipRules in interface AmazonChimepublic ListSupportedPhoneNumberCountriesResult listSupportedPhoneNumberCountries(ListSupportedPhoneNumberCountriesRequest request)
AmazonChimeLists supported phone number countries.
listSupportedPhoneNumberCountries in interface AmazonChime@Deprecated public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AmazonChimeLists the tags applied to an Amazon Chime SDK meeting and messaging resources.
This API is is no longer supported and will not be updated. We recommend using the applicable latest version in the Amazon Chime SDK.
For meetings: ListTagsForResource.
For messaging: ListTagsForResource.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
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 AmazonChime@Deprecated public ListVoiceConnectorGroupsResult listVoiceConnectorGroups(ListVoiceConnectorGroupsRequest request)
AmazonChimeLists the Amazon Chime Voice Connector groups for the administrator's AWS account.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListVoiceConnectorGroups, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
listVoiceConnectorGroups in interface AmazonChime@Deprecated public ListVoiceConnectorTerminationCredentialsResult listVoiceConnectorTerminationCredentials(ListVoiceConnectorTerminationCredentialsRequest request)
AmazonChimeLists the SIP credentials for the specified Amazon Chime Voice Connector.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListVoiceConnectorTerminationCredentials, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
listVoiceConnectorTerminationCredentials in interface AmazonChime@Deprecated public ListVoiceConnectorsResult listVoiceConnectors(ListVoiceConnectorsRequest request)
AmazonChimeLists the Amazon Chime Voice Connectors for the administrator's AWS account.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListVoiceConnectors, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
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 AmazonChime@Deprecated public PutAppInstanceRetentionSettingsResult putAppInstanceRetentionSettings(PutAppInstanceRetentionSettingsRequest request)
AmazonChime
Sets the amount of time in days that a given AppInstance retains data.
This API is is no longer supported and will not be updated. We recommend using the latest version, PutAppInstanceRetentionSettings, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
putAppInstanceRetentionSettings in interface AmazonChime@Deprecated public PutAppInstanceStreamingConfigurationsResult putAppInstanceStreamingConfigurations(PutAppInstanceStreamingConfigurationsRequest request)
AmazonChime
The data streaming configurations of an AppInstance.
This API is is no longer supported and will not be updated. We recommend using the latest version, PutMessagingStreamingConfigurations, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
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 AmazonChime@Deprecated public PutSipMediaApplicationLoggingConfigurationResult putSipMediaApplicationLoggingConfiguration(PutSipMediaApplicationLoggingConfigurationRequest request)
AmazonChimeUpdates the logging configuration for the specified SIP media application.
This API is is no longer supported and will not be updated. We recommend using the latest version, PutSipMediaApplicationLoggingConfiguration, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
putSipMediaApplicationLoggingConfiguration in interface AmazonChime@Deprecated public 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.
This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorEmergencyCallingConfiguration, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
putVoiceConnectorEmergencyCallingConfiguration in interface AmazonChime@Deprecated public 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.
This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorLoggingConfiguration, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
putVoiceConnectorLoggingConfiguration in interface AmazonChime@Deprecated public 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.
This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorOrigination, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
putVoiceConnectorOrigination in interface AmazonChime@Deprecated public PutVoiceConnectorProxyResult putVoiceConnectorProxy(PutVoiceConnectorProxyRequest request)
AmazonChimePuts the specified proxy configuration to the specified Amazon Chime Voice Connector.
This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorProxy, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
putVoiceConnectorProxy in interface AmazonChime@Deprecated public 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.
This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorStreamingConfiguration, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
putVoiceConnectorStreamingConfiguration in interface AmazonChime@Deprecated public 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.
This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorTermination, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
putVoiceConnectorTermination in interface AmazonChime@Deprecated public PutVoiceConnectorTerminationCredentialsResult putVoiceConnectorTerminationCredentials(PutVoiceConnectorTerminationCredentialsRequest request)
AmazonChimeAdds termination SIP credentials for the specified Amazon Chime Voice Connector.
This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorTerminationCredentials, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
putVoiceConnectorTerminationCredentials in interface AmazonChime@Deprecated public 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.
This API is is no longer supported and will not be updated. We recommend using the latest version, RedactChannelMessage, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
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 AmazonChime@Deprecated public 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.
This API is is no longer supported and will not be updated. We recommend using the latest version, SendChannelMessage, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
sendChannelMessage in interface AmazonChime@Deprecated public 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.
This API is is no longer supported and will not be updated. We recommend using the latest version, StartMeetingTranscription, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
startMeetingTranscription in interface AmazonChime@Deprecated public StopMeetingTranscriptionResult stopMeetingTranscription(StopMeetingTranscriptionRequest request)
AmazonChime
Stops transcription for the specified meetingId.
This API is is no longer supported and will not be updated. We recommend using the latest version, StopMeetingTranscription, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
stopMeetingTranscription in interface AmazonChime@Deprecated public TagAttendeeResult tagAttendee(TagAttendeeRequest request)
AmazonChimeApplies the specified tags to the specified Amazon Chime attendee.
TagAttendee is not supported in the Amazon Chime SDK Meetings Namespace. Update your application to remove calls to this API.
tagAttendee in interface AmazonChime@Deprecated public TagMeetingResult tagMeeting(TagMeetingRequest request)
AmazonChimeApplies the specified tags to the specified Amazon Chime SDK meeting.
This API is is no longer supported and will not be updated. We recommend using the latest version, TagResource, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
tagMeeting in interface AmazonChime@Deprecated public TagResourceResult tagResource(TagResourceRequest request)
AmazonChimeApplies the specified tags to the specified Amazon Chime SDK meeting resource.
This API is is no longer supported and will not be updated. We recommend using the latest version, TagResource, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
tagResource in interface AmazonChime@Deprecated public UntagAttendeeResult untagAttendee(UntagAttendeeRequest request)
AmazonChimeUntags the specified tags from the specified Amazon Chime SDK attendee.
UntagAttendee is not supported in the Amazon Chime SDK Meetings Namespace. Update your application to remove calls to this API.
untagAttendee in interface AmazonChime@Deprecated public UntagMeetingResult untagMeeting(UntagMeetingRequest request)
AmazonChimeUntags the specified tags from the specified Amazon Chime SDK meeting.
This API is is no longer supported and will not be updated. We recommend using the latest version, UntagResource , in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
untagMeeting in interface AmazonChime@Deprecated public UntagResourceResult untagResource(UntagResourceRequest request)
AmazonChimeUntags the specified tags from the specified Amazon Chime SDK meeting resource.
Applies the specified tags to the specified Amazon Chime SDK meeting resource.
This API is is no longer supported and will not be updated. We recommend using the latest version, UntagResource , in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
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 AmazonChime@Deprecated public UpdateAppInstanceResult updateAppInstance(UpdateAppInstanceRequest request)
AmazonChime
Updates AppInstance metadata.
This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateAppInstance, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
updateAppInstance in interface AmazonChime@Deprecated public UpdateAppInstanceUserResult updateAppInstanceUser(UpdateAppInstanceUserRequest request)
AmazonChime
Updates the details of an AppInstanceUser. You can update names and metadata.
This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateAppInstanceUser, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
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 AmazonChime@Deprecated public 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.
This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateChannel , in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
updateChannel in interface AmazonChime@Deprecated public 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.
This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateChannelMessage, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
updateChannelMessage in interface AmazonChime@Deprecated public 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.
This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateChannelReadMarker, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
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 AmazonChime@Deprecated public UpdateProxySessionResult updateProxySession(UpdateProxySessionRequest request)
AmazonChimeUpdates the specified proxy session details, such as voice or SMS capabilities.
This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateProxySession, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
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 AmazonChime@Deprecated public UpdateSipMediaApplicationResult updateSipMediaApplication(UpdateSipMediaApplicationRequest request)
AmazonChimeUpdates the details of the specified SIP media application.
This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateSipMediaApplication, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
updateSipMediaApplication in interface AmazonChime@Deprecated public 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.
This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateSipMediaApplicationCall, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
updateSipMediaApplicationCall in interface AmazonChime@Deprecated public UpdateSipRuleResult updateSipRule(UpdateSipRuleRequest request)
AmazonChimeUpdates the details of the specified SIP rule.
This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateSipRule, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
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 AmazonChime@Deprecated public UpdateVoiceConnectorResult updateVoiceConnector(UpdateVoiceConnectorRequest request)
AmazonChimeUpdates details for the specified Amazon Chime Voice Connector.
This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateVoiceConnector, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
updateVoiceConnector in interface AmazonChime@Deprecated public 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.
This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateVoiceConnectorGroup, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
updateVoiceConnectorGroup in interface AmazonChime@Deprecated public 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.
This API is is no longer supported and will not be updated. We recommend using the latest version, ValidateE911Address, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
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.