AWS.Chime — AWS SDK for JavaScript (original) (raw)
Property Details
endpoint ⇒ AWS.Endpoint
Returns an Endpoint object representing the endpoint URL for service requests.
Method Details
associatePhoneNumbersWithVoiceConnector(params = {}, callback) ⇒ AWS.Request
Associates 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.
associatePhoneNumbersWithVoiceConnectorGroup(params = {}, callback) ⇒ AWS.Request
Associates 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.
associatePhoneNumberWithUser(params = {}, callback) ⇒ AWS.Request
Associates a phone number with the specified Amazon Chime user.
associateSigninDelegateGroupsWithAccount(params = {}, callback) ⇒ AWS.Request
Associates the specified sign-in delegate groups with the specified Amazon Chime account.
batchCreateAttendee(params = {}, callback) ⇒ AWS.Request
Creates 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.
batchCreateChannelMembership(params = {}, callback) ⇒ AWS.Request
Adds 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.
batchCreateRoomMembership(params = {}, callback) ⇒ AWS.Request
Adds up to 50 members to a chat room in an Amazon Chime Enterprise account. Members can be users or bots. The member role designates whether the member is a chat room administrator or a general chat room member.
batchDeletePhoneNumber(params = {}, callback) ⇒ AWS.Request
Moves phone numbers into the Deletion queue. Phone numbers must be disassociated from any users or Amazon Chime Voice Connectors before they can be deleted.
Phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.
batchSuspendUser(params = {}, callback) ⇒ AWS.Request
Suspends up to 50 users from a Team
or EnterpriseLWA
Amazon Chime account. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.
Users suspended from a Team
account are disassociated from the account,but they can continue to use Amazon Chime as free users. To remove the suspension from suspended Team
account users, invite them to the Team
account again. You can use the InviteUsers action to do so.
Users suspended from an EnterpriseLWA
account are immediately signed out of Amazon Chime and can no longer sign in. To remove the suspension from suspended EnterpriseLWA
account users, use the BatchUnsuspendUser action.
To sign out users without suspending them, use the LogoutUser action.
batchUnsuspendUser(params = {}, callback) ⇒ AWS.Request
Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime EnterpriseLWA
account. Only users on EnterpriseLWA
accounts can be unsuspended using this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the 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.
batchUpdatePhoneNumber(params = {}, callback) ⇒ AWS.Request
Updates phone number product types or calling names. You can update one attribute at a time for each UpdatePhoneNumberRequestItem
. For example, you can update 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.
batchUpdateUser(params = {}, callback) ⇒ AWS.Request
Updates user details within the UpdateUserRequestItem object for up to 20 users for the specified Amazon Chime account. Currently, only LicenseType
updates are supported for this action.
createAccount(params = {}, callback) ⇒ AWS.Request
Creates an Amazon Chime account under the administrator's AWS account. Only Team
account types are currently supported for this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.
createAppInstance(params = {}, callback) ⇒ AWS.Request
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.
createAppInstanceAdmin(params = {}, callback) ⇒ AWS.Request
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 theAppInstance
.DeleteChannelMessage
actions.
Only an AppInstanceUser
can be promoted to an AppInstanceAdmin
role.
createAppInstanceUser(params = {}, callback) ⇒ AWS.Request
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.
createAttendee(params = {}, callback) ⇒ AWS.Request
Creates a new attendee for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime 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.
createBot(params = {}, callback) ⇒ AWS.Request
Creates a bot for an Amazon Chime Enterprise account.
createChannel(params = {}, callback) ⇒ AWS.Request
Creates a channel to which you can add users and send messages.
Restriction: You can't change a channel's privacy.
Note: 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.
createChannelBan(params = {}, callback) ⇒ AWS.Request
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.
Note: 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.
createChannelMembership(params = {}, callback) ⇒ AWS.Request
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.
Note: 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.
createChannelModerator(params = {}, callback) ⇒ AWS.Request
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.
Note: 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.
createMediaCapturePipeline(params = {}, callback) ⇒ AWS.Request
Creates 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.
createMeeting(params = {}, callback) ⇒ AWS.Request
Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees. For more information about specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon Chime 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.
createMeetingDialOut(params = {}, callback) ⇒ AWS.Request
Uses the join token and call metadata in a meeting request (From number, To number, and so forth) to initiate an outbound call to a public switched telephone network (PSTN) and join them into a Chime meeting. 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.
createMeetingWithAttendees(params = {}, callback) ⇒ AWS.Request
Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees. For more information about specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon Chime 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.
createPhoneNumberOrder(params = {}, callback) ⇒ AWS.Request
Creates an order for phone numbers to be provisioned. For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type.
createProxySession(params = {}, callback) ⇒ AWS.Request
Creates 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.
createRoom(params = {}, callback) ⇒ AWS.Request
Creates a chat room for the specified Amazon Chime Enterprise account.
createRoomMembership(params = {}, callback) ⇒ AWS.Request
Adds a member to a chat room in an Amazon Chime Enterprise account. A member can be either a user or a bot. The member role designates whether the member is a chat room administrator or a general chat room member.
createSipMediaApplication(params = {}, callback) ⇒ AWS.Request
Creates 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.
createSipMediaApplicationCall(params = {}, callback) ⇒ AWS.Request
Creates an outbound call to a phone number from the phone number specified in the request, and it invokes the endpoint of the specified sipMediaApplicationId
.
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.
createSipRule(params = {}, callback) ⇒ AWS.Request
Creates 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.
createUser(params = {}, callback) ⇒ AWS.Request
Creates a user under the specified Amazon Chime account.
createVoiceConnector(params = {}, callback) ⇒ AWS.Request
Creates an Amazon Chime Voice Connector under the administrator's AWS account. You can choose to create an Amazon Chime Voice Connector in a specific AWS Region.
Enabling CreateVoiceConnectorRequest$RequireEncryption configures your Amazon Chime Voice Connector to use TLS transport for SIP signaling and Secure RTP (SRTP) for media. Inbound calls use TLS transport, and unencrypted outbound calls are blocked.
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.
createVoiceConnectorGroup(params = {}, callback) ⇒ AWS.Request
Creates an Amazon Chime Voice Connector group under the administrator's AWS account. You can associate Amazon Chime Voice Connectors with the Amazon Chime Voice Connector group by including VoiceConnectorItems
in the request.
You can include Amazon Chime Voice Connectors from different AWS Regions in your group. This creates a fault tolerant mechanism for fallback in case of availability events.
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.
deleteAccount(params = {}, callback) ⇒ AWS.Request
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.
deleteAppInstance(params = {}, callback) ⇒ AWS.Request
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.
deleteAppInstanceAdmin(params = {}, callback) ⇒ AWS.Request
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.
deleteAppInstanceStreamingConfigurations(params = {}, callback) ⇒ AWS.Request
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.
deleteAppInstanceUser(params = {}, callback) ⇒ AWS.Request
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.
deleteAttendee(params = {}, callback) ⇒ AWS.Request
Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their JoinToken
. Attendees are automatically deleted when a Amazon Chime SDK meeting is deleted. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime 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.
deleteChannel(params = {}, callback) ⇒ AWS.Request
Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process.
Note: 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.
deleteChannelBan(params = {}, callback) ⇒ AWS.Request
Removes a user from a channel's ban list.
Note: 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.
deleteChannelMembership(params = {}, callback) ⇒ AWS.Request
Removes a member from a channel.
Note: 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.
deleteChannelMessage(params = {}, callback) ⇒ AWS.Request
Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately. A background process deletes any revisions created by UpdateChannelMessage
.
Note: 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.
deleteChannelModerator(params = {}, callback) ⇒ AWS.Request
Deletes a channel moderator.
Note: 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.
deleteEventsConfiguration(params = {}, callback) ⇒ AWS.Request
Deletes the events configuration that allows a bot to receive outgoing events.
deleteMediaCapturePipeline(params = {}, callback) ⇒ AWS.Request
Deletes 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.
deleteMeeting(params = {}, callback) ⇒ AWS.Request
Deletes the specified Amazon Chime SDK meeting. The operation deletes all attendees, disconnects all clients, and prevents new clients from joining the meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime 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.
deletePhoneNumber(params = {}, callback) ⇒ AWS.Request
Moves the specified phone number into the Deletion queue. A phone number must be disassociated from any users or Amazon Chime Voice Connectors before it can be deleted.
Deleted phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.
deleteProxySession(params = {}, callback) ⇒ AWS.Request
Deletes 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.
deleteRoom(params = {}, callback) ⇒ AWS.Request
Deletes a chat room in an Amazon Chime Enterprise account.
deleteRoomMembership(params = {}, callback) ⇒ AWS.Request
Removes a member from a chat room in an Amazon Chime Enterprise account.
deleteSipMediaApplication(params = {}, callback) ⇒ AWS.Request
Deletes 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.
deleteSipRule(params = {}, callback) ⇒ AWS.Request
Deletes 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.
deleteVoiceConnector(params = {}, callback) ⇒ AWS.Request
Deletes the specified Amazon Chime Voice Connector. Any phone numbers associated with the Amazon Chime Voice Connector must be disassociated from it before it can be deleted.
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.
deleteVoiceConnectorEmergencyCallingConfiguration(params = {}, callback) ⇒ AWS.Request
Deletes 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.
deleteVoiceConnectorGroup(params = {}, callback) ⇒ AWS.Request
Deletes the specified Amazon Chime Voice Connector group. Any VoiceConnectorItems
and phone numbers associated with the group must be removed before it can be deleted.
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.
deleteVoiceConnectorOrigination(params = {}, callback) ⇒ AWS.Request
Deletes the origination settings for the specified Amazon Chime Voice Connector.
Note: 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.
deleteVoiceConnectorProxy(params = {}, callback) ⇒ AWS.Request
Deletes 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.
deleteVoiceConnectorStreamingConfiguration(params = {}, callback) ⇒ AWS.Request
Deletes 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.
deleteVoiceConnectorTermination(params = {}, callback) ⇒ AWS.Request
Deletes the termination settings for the specified Amazon Chime Voice Connector.
Note: 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.
deleteVoiceConnectorTerminationCredentials(params = {}, callback) ⇒ AWS.Request
Deletes 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.
describeAppInstance(params = {}, callback) ⇒ AWS.Request
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.
describeAppInstanceAdmin(params = {}, callback) ⇒ AWS.Request
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.
describeAppInstanceUser(params = {}, callback) ⇒ AWS.Request
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.
describeChannel(params = {}, callback) ⇒ AWS.Request
Returns the full details of a channel in an Amazon Chime AppInstance
.
Note: 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.
describeChannelBan(params = {}, callback) ⇒ AWS.Request
Returns the full details of a channel ban.
Note: 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.
describeChannelMembership(params = {}, callback) ⇒ AWS.Request
Returns the full details of a user's channel membership.
Note: 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.
describeChannelMembershipForAppInstanceUser(params = {}, callback) ⇒ AWS.Request
Returns the details of a channel based on the membership of the specified AppInstanceUser
.
Note: 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.
describeChannelModeratedByAppInstanceUser(params = {}, callback) ⇒ AWS.Request
Returns the full details of a channel moderated by the specified AppInstanceUser
.
Note: 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.
describeChannelModerator(params = {}, callback) ⇒ AWS.Request
Returns the full details of a single ChannelModerator.
Note: 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.
disassociatePhoneNumberFromUser(params = {}, callback) ⇒ AWS.Request
Disassociates the primary provisioned phone number from the specified Amazon Chime user.
disassociatePhoneNumbersFromVoiceConnector(params = {}, callback) ⇒ AWS.Request
Disassociates 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.
disassociatePhoneNumbersFromVoiceConnectorGroup(params = {}, callback) ⇒ AWS.Request
Disassociates 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.
disassociateSigninDelegateGroupsFromAccount(params = {}, callback) ⇒ AWS.Request
Disassociates the specified sign-in delegate groups from the specified Amazon Chime account.
getAccount(params = {}, callback) ⇒ AWS.Request
Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.
getAccountSettings(params = {}, callback) ⇒ AWS.Request
Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dialout settings. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.
getAppInstanceRetentionSettings(params = {}, callback) ⇒ AWS.Request
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.
getAppInstanceStreamingConfigurations(params = {}, callback) ⇒ AWS.Request
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.
getAttendee(params = {}, callback) ⇒ AWS.Request
Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime 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.
getBot(params = {}, callback) ⇒ AWS.Request
Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.
getChannelMessage(params = {}, callback) ⇒ AWS.Request
Gets the full details of a channel message.
Note: 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.
getEventsConfiguration(params = {}, callback) ⇒ AWS.Request
Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.
getGlobalSettings(params = {}, callback) ⇒ AWS.Request
Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
getMediaCapturePipeline(params = {}, callback) ⇒ AWS.Request
Gets 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.
getMeeting(params = {}, callback) ⇒ AWS.Request
This 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 .
getMessagingSessionEndpoint(params = {}, callback) ⇒ AWS.Request
The 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.
getPhoneNumber(params = {}, callback) ⇒ AWS.Request
Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.
getPhoneNumberOrder(params = {}, callback) ⇒ AWS.Request
Retrieves details for the specified phone number order, such as the order creation timestamp, phone numbers in E.164 format, product type, and order status.
getPhoneNumberSettings(params = {}, callback) ⇒ AWS.Request
Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.
getProxySession(params = {}, callback) ⇒ AWS.Request
Gets 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.
getRetentionSettings(params = {}, callback) ⇒ AWS.Request
Gets the retention settings for the specified Amazon Chime Enterprise account. For more information about retention settings, see Managing Chat Retention Policies in the Amazon Chime Administration Guide.
getRoom(params = {}, callback) ⇒ AWS.Request
Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.
getSipMediaApplication(params = {}, callback) ⇒ AWS.Request
Retrieves 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.
getSipMediaApplicationLoggingConfiguration(params = {}, callback) ⇒ AWS.Request
Returns 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.
getSipRule(params = {}, callback) ⇒ AWS.Request
Retrieves 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.
getUser(params = {}, callback) ⇒ AWS.Request
Retrieves details for the specified user ID, such as primary email address, license type,and personal meeting PIN.
To retrieve user details with an email address instead of a user ID, use the ListUsers action, and then filter by email address.
getUserSettings(params = {}, callback) ⇒ AWS.Request
Retrieves settings for the specified user ID, such as any associated phone number settings.
getVoiceConnector(params = {}, callback) ⇒ AWS.Request
Retrieves 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.
getVoiceConnectorEmergencyCallingConfiguration(params = {}, callback) ⇒ AWS.Request
Gets 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.
getVoiceConnectorGroup(params = {}, callback) ⇒ AWS.Request
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.
getVoiceConnectorLoggingConfiguration(params = {}, callback) ⇒ AWS.Request
Retrieves the logging configuration details for the specified Amazon Chime Voice Connector. Shows whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.
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.
getVoiceConnectorOrigination(params = {}, callback) ⇒ AWS.Request
Retrieves 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.
getVoiceConnectorProxy(params = {}, callback) ⇒ AWS.Request
Gets 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.
getVoiceConnectorStreamingConfiguration(params = {}, callback) ⇒ AWS.Request
Retrieves the streaming configuration details for the specified Amazon Chime Voice Connector. Shows whether media streaming is enabled for sending to Amazon Kinesis. It also shows the retention period, in hours, for the Amazon Kinesis data.
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.
getVoiceConnectorTermination(params = {}, callback) ⇒ AWS.Request
Retrieves 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.
getVoiceConnectorTerminationHealth(params = {}, callback) ⇒ AWS.Request
This 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.
inviteUsers(params = {}, callback) ⇒ AWS.Request
Sends email to a maximum of 50 users, inviting them to the specified Amazon Chime Team
account. Only Team
account types are currently supported for this action.
listAccounts(params = {}, callback) ⇒ AWS.Request
Lists the Amazon Chime accounts under the administrator's AWS account. You can filter accounts by account name prefix. To find out which Amazon Chime account a user belongs to, you can filter by the user's email address, which returns one account result.
listAppInstanceAdmins(params = {}, callback) ⇒ AWS.Request
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.
listAppInstances(params = {}, callback) ⇒ AWS.Request
Lists all Amazon Chime AppInstance
s 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.
listAppInstanceUsers(params = {}, callback) ⇒ AWS.Request
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.
listAttendees(params = {}, callback) ⇒ AWS.Request
Lists the attendees for the specified Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime 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.
listAttendeeTags(params = {}, callback) ⇒ AWS.Request
Lists 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.
listBots(params = {}, callback) ⇒ AWS.Request
Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.
listChannelBans(params = {}, callback) ⇒ AWS.Request
Lists all the users banned from a particular channel.
Note: 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.
listChannelMemberships(params = {}, callback) ⇒ AWS.Request
Lists all channel memberships in a channel.
Note: 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.
listChannelMembershipsForAppInstanceUser(params = {}, callback) ⇒ AWS.Request
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.
Note: 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.
listChannelMessages(params = {}, callback) ⇒ AWS.Request
List all the messages in a channel. Returns a paginated list of ChannelMessages
. By default, sorted by creation timestamp in descending order.
Note: 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.
listChannelModerators(params = {}, callback) ⇒ AWS.Request
Lists all the moderators for a channel.
Note: 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.
listChannels(params = {}, callback) ⇒ AWS.Request
Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results.
Functionality & restrictions
- Use privacy =
PUBLIC
to retrieve all public channels in the account. - Only an
AppInstanceAdmin
can set privacy =PRIVATE
to list the private channels in an account.
Note: 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.
listChannelsModeratedByAppInstanceUser(params = {}, callback) ⇒ AWS.Request
A list of the channels moderated by an AppInstanceUser
.
Note: 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.
listMediaCapturePipelines(params = {}, callback) ⇒ AWS.Request
Returns 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.
listMeetings(params = {}, callback) ⇒ AWS.Request
Lists 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.
listMeetingTags(params = {}, callback) ⇒ AWS.Request
Lists 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.
listPhoneNumberOrders(params = {}, callback) ⇒ AWS.Request
Lists the phone number orders for the administrator's Amazon Chime account.
listPhoneNumbers(params = {}, callback) ⇒ AWS.Request
Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.
listProxySessions(params = {}, callback) ⇒ AWS.Request
Lists 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.
listRoomMemberships(params = {}, callback) ⇒ AWS.Request
Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members' IDs, email addresses, and names.
listRooms(params = {}, callback) ⇒ AWS.Request
Lists the room details for the specified Amazon Chime Enterprise account. Optionally, filter the results by a member ID (user ID or bot ID) to see a list of rooms that the member belongs to.
listSipMediaApplications(params = {}, callback) ⇒ AWS.Request
Lists 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.
listSipRules(params = {}, callback) ⇒ AWS.Request
Lists 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.
listSupportedPhoneNumberCountries(params = {}, callback) ⇒ AWS.Request
Lists supported phone number countries.
listTagsForResource(params = {}, callback) ⇒ AWS.Request
Lists 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.
listUsers(params = {}, callback) ⇒ AWS.Request
Lists the users that belong to the specified Amazon Chime account. You can specify an email address to list only the user that the email address belongs to.
listVoiceConnectorGroups(params = {}, callback) ⇒ AWS.Request
Lists 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.
listVoiceConnectors(params = {}, callback) ⇒ AWS.Request
Lists 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.
listVoiceConnectorTerminationCredentials(params = {}, callback) ⇒ AWS.Request
Lists 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.
logoutUser(params = {}, callback) ⇒ AWS.Request
Logs out the specified user from all of the devices they are currently logged into.
putAppInstanceRetentionSettings(params = {}, callback) ⇒ AWS.Request
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.
putAppInstanceStreamingConfigurations(params = {}, callback) ⇒ AWS.Request
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.
putEventsConfiguration(params = {}, callback) ⇒ AWS.Request
Creates an events configuration that allows a bot to receive outgoing events sent by Amazon Chime. Choose either an HTTPS endpoint or a Lambda function ARN. For more information, see Bot.
putRetentionSettings(params = {}, callback) ⇒ AWS.Request
Puts retention settings for the specified Amazon Chime Enterprise account. We recommend using AWS CloudTrail to monitor usage of this API for your account. For more information, see Logging Amazon Chime API Calls with AWS CloudTrail in the Amazon Chime Administration Guide.
To turn off existing retention settings, remove the number of days from the corresponding RetentionDays field in the RetentionSettings object. For more information about retention settings, see Managing Chat Retention Policies in the Amazon Chime Administration Guide.
putSipMediaApplicationLoggingConfiguration(params = {}, callback) ⇒ AWS.Request
Updates 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.
putVoiceConnectorEmergencyCallingConfiguration(params = {}, callback) ⇒ AWS.Request
Puts emergency calling configuration details to the specified Amazon Chime Voice Connector, such as emergency phone numbers and calling countries. Origination and termination settings must be enabled for the Amazon Chime Voice Connector before emergency calling can be configured.
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.
putVoiceConnectorLoggingConfiguration(params = {}, callback) ⇒ AWS.Request
Adds a logging configuration for the specified Amazon Chime Voice Connector. The logging configuration specifies whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.
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.
putVoiceConnectorOrigination(params = {}, callback) ⇒ AWS.Request
Adds origination settings for the specified Amazon Chime Voice Connector.
Note: 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.
putVoiceConnectorProxy(params = {}, callback) ⇒ AWS.Request
Puts 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.
putVoiceConnectorStreamingConfiguration(params = {}, callback) ⇒ AWS.Request
Adds a streaming configuration for the specified Amazon Chime Voice Connector. The streaming configuration specifies whether media streaming is enabled for sending to Kinesis. It also sets the retention period, in hours, for the Amazon Kinesis data.
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.
putVoiceConnectorTermination(params = {}, callback) ⇒ AWS.Request
Adds termination settings for the specified Amazon Chime Voice Connector.
Note: 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.
putVoiceConnectorTerminationCredentials(params = {}, callback) ⇒ AWS.Request
Adds 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.
redactChannelMessage(params = {}, callback) ⇒ AWS.Request
Redacts message content, but not metadata. The message exists in the back end, but the action returns null content, and the state shows as redacted.
Note: 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.
redactConversationMessage(params = {}, callback) ⇒ AWS.Request
Redacts the specified message from the specified Amazon Chime conversation.
redactRoomMessage(params = {}, callback) ⇒ AWS.Request
Redacts the specified message from the specified Amazon Chime channel.
regenerateSecurityToken(params = {}, callback) ⇒ AWS.Request
Regenerates the security token for a bot.
resetPersonalPIN(params = {}, callback) ⇒ AWS.Request
Resets the personal meeting PIN for the specified user on an Amazon Chime account. Returns the User object with the updated personal meeting PIN.
restorePhoneNumber(params = {}, callback) ⇒ AWS.Request
Moves a phone number from the Deletion queue back into the phone number Inventory.
searchAvailablePhoneNumbers(params = {}, callback) ⇒ AWS.Request
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.
sendChannelMessage(params = {}, callback) ⇒ AWS.Request
Sends a message to a particular channel that the member is a part of.
Note: 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.
startMeetingTranscription(params = {}, callback) ⇒ AWS.Request
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.
Note: 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.
stopMeetingTranscription(params = {}, callback) ⇒ AWS.Request
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.
tagAttendee(params = {}, callback) ⇒ AWS.Request
Applies 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.
tagMeeting(params = {}, callback) ⇒ AWS.Request
Applies 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.
tagResource(params = {}, callback) ⇒ AWS.Request
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, 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.
untagAttendee(params = {}, callback) ⇒ AWS.Request
Untags 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.
untagMeeting(params = {}, callback) ⇒ AWS.Request
Untags 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.
untagResource(params = {}, callback) ⇒ AWS.Request
Untags 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.
updateAccount(params = {}, callback) ⇒ AWS.Request
Updates account details for the specified Amazon Chime account. Currently, only account name and default license updates are supported for this action.
updateAccountSettings(params = {}, callback) ⇒ AWS.Request
Updates the settings for the specified Amazon Chime account. You can update settings for remote control of shared screens, or for the dial-out option. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.
updateAppInstance(params = {}, callback) ⇒ AWS.Request
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.
updateAppInstanceUser(params = {}, callback) ⇒ AWS.Request
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.
updateBot(params = {}, callback) ⇒ AWS.Request
Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.
updateChannel(params = {}, callback) ⇒ AWS.Request
Update a channel's attributes.
Restriction: You can't change a channel's privacy.
Note: 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.
updateChannelMessage(params = {}, callback) ⇒ AWS.Request
Updates the content of a message.
Note: 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.
updateChannelReadMarker(params = {}, callback) ⇒ AWS.Request
The details of the time when a user last read messages in a channel.
Note: 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.
updateGlobalSettings(params = {}, callback) ⇒ AWS.Request
Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
updatePhoneNumber(params = {}, callback) ⇒ AWS.Request
Updates phone number details, such as product type or calling name, for the specified phone number ID. You can update one phone number detail at a time. For example, you can update either the product type or the calling name in one action.
For toll-free numbers, you 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.
updatePhoneNumberSettings(params = {}, callback) ⇒ AWS.Request
Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name. You can update the default outbound calling name once every seven days. Outbound calling names can take up to 72 hours to update.
updateProxySession(params = {}, callback) ⇒ AWS.Request
Updates 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.
updateRoom(params = {}, callback) ⇒ AWS.Request
Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account.
updateRoomMembership(params = {}, callback) ⇒ AWS.Request
Updates room membership details, such as the member role, for a room in an Amazon Chime Enterprise account. The member role designates whether the member is a chat room administrator or a general chat room member. The member role can be updated only for user IDs.
updateSipMediaApplication(params = {}, callback) ⇒ AWS.Request
Updates 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.
updateSipMediaApplicationCall(params = {}, callback) ⇒ AWS.Request
Invokes the AWS Lambda function associated with the SIP media application and transaction ID in an update request. The Lambda function can then return a new set of actions.
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.
updateSipRule(params = {}, callback) ⇒ AWS.Request
Updates 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.
updateUser(params = {}, callback) ⇒ AWS.Request
Updates user details for a specified user ID. Currently, only LicenseType
updates are supported for this action.
updateUserSettings(params = {}, callback) ⇒ AWS.Request
Updates the settings for the specified user, such as phone number settings.
updateVoiceConnector(params = {}, callback) ⇒ AWS.Request
Updates 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.
updateVoiceConnectorGroup(params = {}, callback) ⇒ AWS.Request
Updates 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.
validateE911Address(params = {}, callback) ⇒ AWS.Request
Validates an address to be used for 911 calls made with Amazon Chime Voice Connectors. You can use validated addresses in a Presence Information Data Format Location Object file that you include in SIP requests. That helps ensure that addresses are routed to the appropriate Public Safety Answering Point.
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.