View Source aws_chime (aws v1.0.4)
Most of these APIs are no longer supported and will not be updated.
We recommend using the latest versions in the Amazon Chime SDK API reference: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/welcome.html, in the Amazon Chime SDK.
Using the latest versions requires migrating to dedicated namespaces. For more information, refer to Migrating from the Amazon Chime namespace: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.
The Amazon Chime application programming interface (API) is designed so administrators can perform key tasks, such as creating and managing Amazon Chime accounts, users, and Voice Connectors. This guide provides detailed information about the Amazon Chime API, including operations, types, inputs and outputs, and error codes.
You can use an AWS SDK, the AWS Command Line Interface (AWS CLI), or the REST API to make API calls for Amazon Chime. We recommend using an AWS SDK or the AWS CLI. The page for each API action contains a See Also section that includes links to information about using the action with a language-specific AWS SDK or the AWS CLI.
- Using an AWS SDK
You don't need to write code to calculate a signature for request authentication. The SDK clients authenticate your requests by using access keys that you provide. For more information about AWS SDKs, see the AWS Developer Center: http://aws.amazon.com/developer/.
- Using the AWS CLI
Use your access keys with the AWS CLI to make API calls. For information about setting up the AWS CLI, see Installing the AWS Command Line Interface: https://docs.aws.amazon.com/cli/latest/userguide/installing.html in the AWS Command Line Interface User Guide. For a list of available Amazon Chime commands, see the Amazon Chime commands: https://docs.aws.amazon.com/cli/latest/reference/chime/index.html in the AWS CLI Command Reference.
- Using REST APIs
If you use REST to make API calls, you must authenticate your request by providing a signature. Amazon Chime supports Signature Version 4. For more information, see Signature Version 4 Signing Process: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html in the Amazon Web Services General Reference.
When making REST API calls, use the service name
chime
and REST endpointhttps://service.chime.aws.amazon.com
.
Summary
Functions
Associates phone numbers with the specified Amazon Chime Voice Connector.
Associates phone numbers with the specified Amazon Chime Voice Connector group.
Creates up to 100 new attendees for an active Amazon Chime SDK meeting.
Adds a specified number of users to a channel.
Adds up to 50 members to a chat room in an Amazon Chime Enterprise account.
Moves phone numbers into the Deletion queue.
Suspends up to 50 users from a Team
or EnterpriseLWA
Amazon Chime account.
Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime EnterpriseLWA
account.
Updates phone number product types or calling names.
Updates user details within the UpdateUserRequestItem
object for up to 20 users for the specified Amazon Chime account.
Creates an Amazon Chime account under the administrator's AWS account.
Creates an Amazon Chime SDK messaging AppInstance
under an AWS account.
Promotes an AppInstanceUser
to an AppInstanceAdmin
.
Creates a user under an Amazon Chime AppInstance
.
Creates a new attendee for an active Amazon Chime SDK meeting.
Creates a channel to which you can add users and send messages.
Permanently bans a member from a channel.
Adds a user to a channel.
Creates a new ChannelModerator
.
Creates a media capture pipeline.
Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees.
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.
Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees.
Creates an order for phone numbers to be provisioned.
Creates a proxy session on the specified Amazon Chime Voice Connector for the specified participant phone numbers.
Adds a member to a chat room in an Amazon Chime Enterprise account.
Creates a SIP media application.
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
.
Creates a SIP rule which can be used to run a SIP media application as a target for a specific trigger type.
Creates an Amazon Chime Voice Connector under the administrator's AWS account.
Creates an Amazon Chime Voice Connector group under the administrator's AWS account.
Deletes the specified Amazon Chime account.
Deletes an AppInstance
and all associated data asynchronously.
Demotes an AppInstanceAdmin
to an AppInstanceUser
.
Deletes the streaming configurations of an AppInstance
.
Deletes an AppInstanceUser
.
Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their JoinToken
.
Immediately makes a channel and its memberships inaccessible and marks them for deletion.
Removes a user from a channel's ban list.
Removes a member from a channel.
Deletes a channel message.
Deletes a channel moderator.
Deletes the media capture pipeline.
Deletes the specified Amazon Chime SDK meeting.
Moves the specified phone number into the Deletion queue.
Deletes the specified proxy session from the specified Amazon Chime Voice Connector.
Deletes a SIP media application.
Deletes a SIP rule.
Deletes the specified Amazon Chime Voice Connector.
Deletes the emergency calling configuration details from the specified Amazon Chime Voice Connector.
Deletes the specified Amazon Chime Voice Connector group.
Deletes the origination settings for the specified Amazon Chime Voice Connector.
Deletes the proxy configuration from the specified Amazon Chime Voice Connector.
Deletes the streaming configuration for the specified Amazon Chime Voice Connector.
Deletes the termination settings for the specified Amazon Chime Voice Connector.
Deletes the specified SIP credentials used by your equipment to authenticate during call termination.
Returns the full details of an AppInstance
.
Returns the full details of an AppInstanceAdmin
.
Returns the full details of an AppInstanceUser
.
Returns the full details of a channel in an Amazon Chime AppInstance
.
Returns the full details of a channel ban.
Returns the full details of a user's channel membership.
Returns the details of a channel based on the membership of the specified AppInstanceUser
.
Returns the full details of a channel moderated by the specified AppInstanceUser
.
Returns the full details of a single ChannelModerator.
Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector.
Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector group.
Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dialout settings.
Gets the retention settings for an AppInstance
.
Gets the streaming settings for an AppInstance
.
Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID.
Gets the full details of a channel message.
Gets an existing media capture pipeline.
This API is is no longer supported and will not be updated.
The details of the endpoint for the messaging session.
Gets the specified proxy session details for the specified Amazon Chime Voice Connector.
Gets the retention settings for the specified Amazon Chime Enterprise account.
Retrieves the information for a SIP media application, including name, AWS Region, and endpoints.
Returns the logging configuration for the specified SIP media application.
Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.
Retrieves details for the specified user ID, such as primary email address, license type,and personal meeting PIN.
Retrieves details for the specified Amazon Chime Voice Connector, such as timestamps,name, outbound host, and encryption requirements.
Gets the emergency calling configuration details for the specified Amazon Chime Voice Connector.
Retrieves details for the specified Amazon Chime Voice Connector group, such as timestamps,name, and associated VoiceConnectorItems
.
Retrieves the logging configuration details for the specified Amazon Chime Voice Connector.
Retrieves origination setting details for the specified Amazon Chime Voice Connector.
Gets the proxy configuration details for the specified Amazon Chime Voice Connector.
Retrieves the streaming configuration details for the specified Amazon Chime Voice Connector.
Retrieves termination setting details for the specified Amazon Chime Voice Connector.
This API is is no longer supported and will not be updated.
Sends email to a maximum of 50 users, inviting them to the specified Amazon Chime Team
account.
Lists the Amazon Chime accounts under the administrator's AWS account.
Returns a list of the administrators in the AppInstance
.
List all AppInstanceUsers
created under a single AppInstance
.
Lists all Amazon Chime AppInstance
s created under a single AWS account.
Lists the tags applied to an Amazon Chime SDK attendee resource.
Lists the attendees for the specified Amazon Chime SDK meeting.
Lists all the users banned from a particular channel.
Lists all channel memberships in a channel.
Lists all channels that a particular AppInstanceUser
is a part of.
List all the messages in a channel.
Lists all the moderators for a channel.
Lists all Channels created under a single Chime App as a paginated list.
A list of the channels moderated by an AppInstanceUser
.
Returns a list of media capture pipelines.
Lists the tags applied to an Amazon Chime SDK meeting resource.
Lists up to 100 active Amazon Chime SDK meetings.
Lists the proxy sessions for the specified Amazon Chime Voice Connector.
Lists the room details for the specified Amazon Chime Enterprise account.
Lists the SIP media applications under the administrator's AWS account.
Lists the SIP rules under the administrator's AWS account.
Lists the tags applied to an Amazon Chime SDK meeting and messaging resources.
Lists the users that belong to the specified Amazon Chime account.
Lists the Amazon Chime Voice Connector groups for the administrator's AWS account.
Lists the SIP credentials for the specified Amazon Chime Voice Connector.
Lists the Amazon Chime Voice Connectors for the administrator's AWS account.
Sets the amount of time in days that a given AppInstance
retains data.
The data streaming configurations of an AppInstance
.
Creates an events configuration that allows a bot to receive outgoing events sent by Amazon Chime.
Puts retention settings for the specified Amazon Chime Enterprise account.
Updates the logging configuration for the specified SIP media application.
Puts emergency calling configuration details to the specified Amazon Chime Voice Connector, such as emergency phone numbers and calling countries.
Adds a logging configuration for the specified Amazon Chime Voice Connector.
Adds origination settings for the specified Amazon Chime Voice Connector.
Puts the specified proxy configuration to the specified Amazon Chime Voice Connector.
Adds a streaming configuration for the specified Amazon Chime Voice Connector.
Adds termination settings for the specified Amazon Chime Voice Connector.
Adds termination SIP credentials for the specified Amazon Chime Voice Connector.
Redacts message content, but not metadata.
Resets the personal meeting PIN for the specified user on an Amazon Chime account.
Searches for phone numbers that can be ordered.
Sends a message to a particular channel that the member is a part of.
Starts transcription for the specified meetingId
.
Stops transcription for the specified meetingId
.
Applies the specified tags to the specified Amazon Chime attendee.
Applies the specified tags to the specified Amazon Chime SDK meeting.
Applies the specified tags to the specified Amazon Chime SDK meeting resource.
Untags the specified tags from the specified Amazon Chime SDK attendee.
Untags the specified tags from the specified Amazon Chime SDK meeting.
Untags the specified tags from the specified Amazon Chime SDK meeting resource.
Updates account details for the specified Amazon Chime account.
Updates the settings for the specified Amazon Chime account.
Updates AppInstance
metadata.
Updates the details of an AppInstanceUser
.
Update a channel's attributes.
Updates the content of a message.
The details of the time when a user last read messages in a channel.
Updates phone number details, such as product type or calling name, for the specified phone number ID.
Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name.
Updates the specified proxy session details, such as voice or SMS capabilities.
Updates room membership details, such as the member role, for a room in an Amazon Chime Enterprise account.
Updates the details of the specified SIP media application.
Invokes the AWS Lambda function associated with the SIP media application and transaction ID in an update request.
Updates the details of the specified SIP rule.
Updates user details for a specified user ID.
Updates details for the specified Amazon Chime Voice Connector.
Updates details of the specified Amazon Chime Voice Connector group, such as the name and Amazon Chime Voice Connector priority ranking.
Validates an address to be used for 911 calls made with Amazon Chime Voice Connectors.
Functions
associate_phone_number_with_user(Client, AccountId, UserId, Input)
View Sourceassociate_phone_number_with_user(Client, AccountId, UserId, Input0, Options0)
View Sourceassociate_phone_numbers_with_voice_connector(Client, VoiceConnectorId, Input)
View SourceAssociates 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_AssociatePhoneNumbersWithVoiceConnector.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.associate_phone_numbers_with_voice_connector(Client, VoiceConnectorId, Input0, Options0)
View Sourceassociate_phone_numbers_with_voice_connector_group(Client, VoiceConnectorGroupId, Input)
View SourceAssociates 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_AssociatePhoneNumbersWithVoiceConnectorGroup.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.associate_phone_numbers_with_voice_connector_group(Client, VoiceConnectorGroupId, Input0, Options0)
View Sourceassociate_signin_delegate_groups_with_account(Client, AccountId, Input)
View Sourceassociate_signin_delegate_groups_with_account(Client, AccountId, Input0, Options0)
View SourceCreates 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_BatchCreateAttendee.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.
For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK: https://docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html in the Amazon Chime SDK Developer Guide.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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_BatchCreateChannelMembership.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.batch_create_channel_membership(Client, ChannelArn, Input0, Options0)
View SourceAdds 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.batch_create_room_membership(Client, AccountId, RoomId, Input0, Options0)
View SourceMoves 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.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: https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html 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.
LogoutUser
action.
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 : https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html in the account types, in the Amazon Chime Administration Guide.
Registered
status. Users who are not previously suspended are ignored.
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.Updates user details within the UpdateUserRequestItem
object for up to 20 users for the specified Amazon Chime account.
LicenseType
updates are supported for this action.
Creates an Amazon Chime account under the administrator's AWS account.
OnlyTeam
account types are currently supported for this action. For more information about different account types, see Managing Your Amazon Chime Accounts: https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html in the Amazon Chime Administration Guide.
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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_CreateAppInstance.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_CreateAppInstanceAdmin.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.
ChannelModerator
actions across all channels in theAppInstance
.DeleteChannelMessage
actions.
AppInstanceUser
can be promoted to an AppInstanceAdmin
role.
create_app_instance_admin(Client, AppInstanceArn, Input0, Options0)
View SourceCreates 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_CreateAppInstanceUser.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.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: https://docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_CreateAttendee.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.Creates a channel to which you can add users and send messages.
Restriction: You can't change a channel's privacy.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the user that makes the API call as the value in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateChannel: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_CreateChannel.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_CreateChannelBan.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_CreateChannelMembership.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_CreateChannelModerator.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.Creates a media capture pipeline.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateMediaCapturePipeline: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_media-pipelines-chime_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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.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: https://docs.aws.amazon.com/chime-sdk/latest/dg/chime-sdk-meetings-regions.html in the Amazon Chime SDK Developer Guide . For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK: https://docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_CreateMeeting.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.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.
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: https://docs.aws.amazon.com/chime-sdk/latest/dg/chime-sdk-meetings-regions.html in the Amazon Chime SDK Developer Guide . For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK: https://docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_CreateMeetingWithAttendees.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.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.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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_CreateProxySession.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.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.create_room_membership(Client, AccountId, RoomId, Input0, Options0)
View SourceCreates a SIP media application.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateSipMediaApplication: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_CreateSipMediaApplication.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.create_sip_media_application_call(Client, SipMediaApplicationId, Input)
View SourceCreates 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_CreateSipMediaApplicationCall.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.create_sip_media_application_call(Client, SipMediaApplicationId, Input0, Options0)
View SourceCreates 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_CreateSipRule.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_CreateVoiceConnector.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_CreateVoiceConnectorGroup.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.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.
Disabled
accounts list.
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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_DeleteAppInstance.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.delete_app_instance_admin(Client, AppInstanceAdminArn, AppInstanceArn, Input)
View SourceDemotes 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_DeleteAppInstanceAdmin.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.delete_app_instance_admin(Client, AppInstanceAdminArn, AppInstanceArn, Input0, Options0)
View Sourcedelete_app_instance_streaming_configurations(Client, AppInstanceArn, Input)
View SourceDeletes 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_DeleteAppInstanceStreamingConfigurations.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.delete_app_instance_streaming_configurations(Client, AppInstanceArn, Input0, Options0)
View SourceDeletes an AppInstanceUser
.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteAppInstanceUser: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_DeleteAppInstanceUser.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.delete_app_instance_user(Client, AppInstanceUserArn, Input0, Options0)
View SourceDeletes 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_DeleteAttendee.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.Immediately makes a channel and its memberships inaccessible and marks them for deletion.
This is an irreversible process.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the user that makes the API call as the value in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteChannel: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_DeleteChannel.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.Removes a user from a channel's ban list.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the user that makes the API call as the value in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteChannelBan: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_DeleteChannelBan.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.delete_channel_ban(Client, ChannelArn, MemberArn, Input0, Options0)
View SourceRemoves 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_DeleteChannelMembership.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.delete_channel_membership(Client, ChannelArn, MemberArn, Input0, Options0)
View SourceDeletes 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_DeleteChannelMessage.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.delete_channel_message(Client, ChannelArn, MessageId, Input0, Options0)
View Sourcedelete_channel_moderator(Client, ChannelArn, ChannelModeratorArn, Input)
View SourceDeletes 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_DeleteChannelModerator.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.delete_channel_moderator(Client, ChannelArn, ChannelModeratorArn, Input0, Options0)
View Sourcedelete_events_configuration(Client, AccountId, BotId, Input0, Options0)
View SourceDeletes the media capture pipeline.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteMediaCapturePipeline: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_media-pipelines-chime_DeleteMediaCapturePipeline.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.delete_media_capture_pipeline(Client, MediaPipelineId, Input0, Options0)
View SourceDeletes 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_DeleteMeeting.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.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.delete_proxy_session(Client, ProxySessionId, VoiceConnectorId, Input)
View SourceDeletes 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_DeleteProxySession.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.delete_proxy_session(Client, ProxySessionId, VoiceConnectorId, Input0, Options0)
View Sourcedelete_room_membership(Client, AccountId, MemberId, RoomId, Input)
View Sourcedelete_room_membership(Client, AccountId, MemberId, RoomId, Input0, Options0)
View Sourcedelete_sip_media_application(Client, SipMediaApplicationId, Input)
View SourceDeletes a SIP media application.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteSipMediaApplication: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_DeleteSipMediaApplication.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.delete_sip_media_application(Client, SipMediaApplicationId, Input0, Options0)
View SourceDeletes 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_DeleteSipRule.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_DeleteVoiceConnector.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.delete_voice_connector(Client, VoiceConnectorId, Input0, Options0)
View Sourcedelete_voice_connector_emergency_calling_configuration(Client, VoiceConnectorId, Input)
View SourceDeletes 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_DeleteVoiceConnectorEmergencyCallingConfiguration.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.delete_voice_connector_emergency_calling_configuration(Client, VoiceConnectorId, Input0, Options0)
View Sourcedelete_voice_connector_group(Client, VoiceConnectorGroupId, Input)
View SourceDeletes 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_DeleteVoiceConnectorGroup.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.delete_voice_connector_group(Client, VoiceConnectorGroupId, Input0, Options0)
View Sourcedelete_voice_connector_origination(Client, VoiceConnectorId, Input)
View SourceDeletes 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_DeleteVoiceConnectorOrigination.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.delete_voice_connector_origination(Client, VoiceConnectorId, Input0, Options0)
View SourceDeletes 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_DeleteVoiceConnectorProxy.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.delete_voice_connector_proxy(Client, VoiceConnectorId, Input0, Options0)
View Sourcedelete_voice_connector_streaming_configuration(Client, VoiceConnectorId, Input)
View SourceDeletes 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_DeleteVoiceConnectorStreamingConfiguration.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.delete_voice_connector_streaming_configuration(Client, VoiceConnectorId, Input0, Options0)
View Sourcedelete_voice_connector_termination(Client, VoiceConnectorId, Input)
View SourceDeletes 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_DeleteVoiceConnectorTermination.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.delete_voice_connector_termination(Client, VoiceConnectorId, Input0, Options0)
View Sourcedelete_voice_connector_termination_credentials(Client, VoiceConnectorId, Input)
View SourceDeletes 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_DeleteVoiceConnectorTerminationCredentials.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.delete_voice_connector_termination_credentials(Client, VoiceConnectorId, Input0, Options0)
View SourceReturns 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_DescribeAppInstance.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.describe_app_instance(Client, AppInstanceArn, QueryMap, HeadersMap)
View Sourcedescribe_app_instance(Client, AppInstanceArn, QueryMap, HeadersMap, Options0)
View Sourcedescribe_app_instance_admin(Client, AppInstanceAdminArn, AppInstanceArn)
View SourceReturns 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_DescribeAppInstanceAdmin.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.describe_app_instance_admin(Client, AppInstanceAdminArn, AppInstanceArn, QueryMap, HeadersMap)
View Sourcedescribe_app_instance_admin(Client, AppInstanceAdminArn, AppInstanceArn, QueryMap, HeadersMap, Options0)
View SourceReturns 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_DescribeAppInstanceUser.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.describe_app_instance_user(Client, AppInstanceUserArn, QueryMap, HeadersMap)
View Sourcedescribe_app_instance_user(Client, AppInstanceUserArn, QueryMap, HeadersMap, Options0)
View SourceReturns 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_DescribeChannel.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.describe_channel(Client, ChannelArn, QueryMap, HeadersMap, Options0)
View SourceReturns 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_DescribeChannelBan.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.describe_channel_ban(Client, ChannelArn, MemberArn, QueryMap, HeadersMap)
View Sourcedescribe_channel_ban(Client, ChannelArn, MemberArn, QueryMap, HeadersMap, Options0)
View SourceReturns 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_DescribeChannelMembership.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.describe_channel_membership(Client, ChannelArn, MemberArn, QueryMap, HeadersMap)
View Sourcedescribe_channel_membership(Client, ChannelArn, MemberArn, QueryMap, HeadersMap, Options0)
View Sourcedescribe_channel_membership_for_app_instance_user(Client, ChannelArn, AppInstanceUserArn)
View SourceReturns 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_DescribeChannelMembershipForAppInstanceUser.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.describe_channel_membership_for_app_instance_user(Client, ChannelArn, AppInstanceUserArn, QueryMap, HeadersMap)
View Sourcedescribe_channel_membership_for_app_instance_user(Client, ChannelArn, AppInstanceUserArn, QueryMap, HeadersMap, Options0)
View Sourcedescribe_channel_moderated_by_app_instance_user(Client, ChannelArn, AppInstanceUserArn)
View SourceReturns 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_DescribeChannelModeratedByAppInstanceUser.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.describe_channel_moderated_by_app_instance_user(Client, ChannelArn, AppInstanceUserArn, QueryMap, HeadersMap)
View Sourcedescribe_channel_moderated_by_app_instance_user(Client, ChannelArn, AppInstanceUserArn, QueryMap, HeadersMap, Options0)
View Sourcedescribe_channel_moderator(Client, ChannelArn, ChannelModeratorArn)
View SourceReturns 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_DescribeChannelModerator.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.describe_channel_moderator(Client, ChannelArn, ChannelModeratorArn, QueryMap, HeadersMap)
View Sourcedescribe_channel_moderator(Client, ChannelArn, ChannelModeratorArn, QueryMap, HeadersMap, Options0)
View Sourcedisassociate_phone_number_from_user(Client, AccountId, UserId, Input)
View Sourcedisassociate_phone_number_from_user(Client, AccountId, UserId, Input0, Options0)
View Sourcedisassociate_phone_numbers_from_voice_connector(Client, VoiceConnectorId, Input)
View SourceDisassociates 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_DisassociatePhoneNumbersFromVoiceConnector.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.disassociate_phone_numbers_from_voice_connector(Client, VoiceConnectorId, Input0, Options0)
View Sourcedisassociate_phone_numbers_from_voice_connector_group(Client, VoiceConnectorGroupId, Input)
View SourceDisassociates 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_DisassociatePhoneNumbersFromVoiceConnectorGroup.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.disassociate_phone_numbers_from_voice_connector_group(Client, VoiceConnectorGroupId, Input0, Options0)
View Sourcedisassociate_signin_delegate_groups_from_account(Client, AccountId, Input)
View Sourcedisassociate_signin_delegate_groups_from_account(Client, AccountId, Input0, Options0)
View SourceRetrieves 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: https://docs.aws.amazon.com/chime/latest/ag/policies.html in the Amazon Chime Administration Guide.get_account_settings(Client, AccountId, QueryMap, HeadersMap, Options0)
View SourceGets 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_GetAppInstanceRetentionSettings.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.get_app_instance_retention_settings(Client, AppInstanceArn, QueryMap, HeadersMap)
View Sourceget_app_instance_retention_settings(Client, AppInstanceArn, QueryMap, HeadersMap, Options0)
View SourceGets 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_GetMessagingStreamingConfigurations.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.get_app_instance_streaming_configurations(Client, AppInstanceArn, QueryMap, HeadersMap)
View Sourceget_app_instance_streaming_configurations(Client, AppInstanceArn, QueryMap, HeadersMap, Options0)
View SourceGets 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_GetAttendee.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.get_attendee(Client, AttendeeId, MeetingId, QueryMap, HeadersMap, Options0)
View SourceGets 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_GetChannelMessage.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.get_channel_message(Client, ChannelArn, MessageId, QueryMap, HeadersMap)
View Sourceget_channel_message(Client, ChannelArn, MessageId, QueryMap, HeadersMap, Options0)
View Sourceget_events_configuration(Client, AccountId, BotId, QueryMap, HeadersMap)
View Sourceget_events_configuration(Client, AccountId, BotId, QueryMap, HeadersMap, Options0)
View SourceGets an existing media capture pipeline.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetMediaCapturePipeline: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_media-pipelines-chime_GetMediaCapturePipeline.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.get_media_capture_pipeline(Client, MediaPipelineId, QueryMap, HeadersMap)
View Sourceget_media_capture_pipeline(Client, MediaPipelineId, QueryMap, HeadersMap, Options0)
View SourceThis API is is no longer supported and will not be updated.
We recommend using the latest version, GetMeeting: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_GetMeeting.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html in the Amazon Chime SDK Developer Guide .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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_GetMessagingSessionEndpoint.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.get_messaging_session_endpoint(Client, QueryMap, HeadersMap, Options0)
View Sourceget_phone_number(Client, PhoneNumberId, QueryMap, HeadersMap, Options0)
View Sourceget_phone_number_order(Client, PhoneNumberOrderId, QueryMap, HeadersMap)
View Sourceget_phone_number_order(Client, PhoneNumberOrderId, QueryMap, HeadersMap, Options0)
View SourceGets 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_GetProxySession.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.get_proxy_session(Client, ProxySessionId, VoiceConnectorId, QueryMap, HeadersMap)
View Sourceget_proxy_session(Client, ProxySessionId, VoiceConnectorId, QueryMap, HeadersMap, Options0)
View SourceGets the retention settings for the specified Amazon Chime Enterprise account.
For more information about retention settings, see Managing Chat Retention Policies: https://docs.aws.amazon.com/chime/latest/ag/chat-retention.html in the Amazon Chime Administration Guide.get_retention_settings(Client, AccountId, QueryMap, HeadersMap, Options0)
View Sourceget_room(Client, AccountId, RoomId, QueryMap, HeadersMap, Options0)
View SourceRetrieves 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_GetSipMediaApplication.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.get_sip_media_application(Client, SipMediaApplicationId, QueryMap, HeadersMap)
View Sourceget_sip_media_application(Client, SipMediaApplicationId, QueryMap, HeadersMap, Options0)
View Sourceget_sip_media_application_logging_configuration(Client, SipMediaApplicationId)
View SourceReturns 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_GetSipMediaApplicationLoggingConfiguration.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.get_sip_media_application_logging_configuration(Client, SipMediaApplicationId, QueryMap, HeadersMap)
View Sourceget_sip_media_application_logging_configuration(Client, SipMediaApplicationId, QueryMap, HeadersMap, Options0)
View SourceRetrieves 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_GetSipRule.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.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 theListUsers
action, and then filter by email address.
get_user(Client, AccountId, UserId, QueryMap, HeadersMap, Options0)
View Sourceget_user_settings(Client, AccountId, UserId, QueryMap, HeadersMap)
View Sourceget_user_settings(Client, AccountId, UserId, QueryMap, HeadersMap, Options0)
View SourceRetrieves 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_GetVoiceConnector.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.get_voice_connector(Client, VoiceConnectorId, QueryMap, HeadersMap)
View Sourceget_voice_connector(Client, VoiceConnectorId, QueryMap, HeadersMap, Options0)
View Sourceget_voice_connector_emergency_calling_configuration(Client, VoiceConnectorId)
View SourceGets 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_GetVoiceConnectorEmergencyCallingConfiguration.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.get_voice_connector_emergency_calling_configuration(Client, VoiceConnectorId, QueryMap, HeadersMap)
View Sourceget_voice_connector_emergency_calling_configuration(Client, VoiceConnectorId, QueryMap, HeadersMap, Options0)
View SourceRetrieves 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_GetVoiceConnectorGroup.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.get_voice_connector_group(Client, VoiceConnectorGroupId, QueryMap, HeadersMap)
View Sourceget_voice_connector_group(Client, VoiceConnectorGroupId, QueryMap, HeadersMap, Options0)
View Sourceget_voice_connector_logging_configuration(Client, VoiceConnectorId)
View SourceRetrieves 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_GetVoiceConnectorLoggingConfiguration.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.get_voice_connector_logging_configuration(Client, VoiceConnectorId, QueryMap, HeadersMap)
View Sourceget_voice_connector_logging_configuration(Client, VoiceConnectorId, QueryMap, HeadersMap, Options0)
View SourceRetrieves 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_GetVoiceConnectorOrigination.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.get_voice_connector_origination(Client, VoiceConnectorId, QueryMap, HeadersMap)
View Sourceget_voice_connector_origination(Client, VoiceConnectorId, QueryMap, HeadersMap, Options0)
View SourceGets 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_GetVoiceConnectorProxy.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.get_voice_connector_proxy(Client, VoiceConnectorId, QueryMap, HeadersMap)
View Sourceget_voice_connector_proxy(Client, VoiceConnectorId, QueryMap, HeadersMap, Options0)
View Sourceget_voice_connector_streaming_configuration(Client, VoiceConnectorId)
View SourceRetrieves 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_GetVoiceConnectorStreamingConfiguration.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.get_voice_connector_streaming_configuration(Client, VoiceConnectorId, QueryMap, HeadersMap)
View Sourceget_voice_connector_streaming_configuration(Client, VoiceConnectorId, QueryMap, HeadersMap, Options0)
View SourceRetrieves 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_GetVoiceConnectorTermination.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.get_voice_connector_termination(Client, VoiceConnectorId, QueryMap, HeadersMap)
View Sourceget_voice_connector_termination(Client, VoiceConnectorId, QueryMap, HeadersMap, Options0)
View SourceThis API is is no longer supported and will not be updated.
We recommend using the latest version, GetVoiceConnectorTerminationHealth: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_GetVoiceConnectorTerminationHealth.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.
Retrieves information about the last time a SIPOPTIONS
ping was received from your SIP infrastructure for the specified Amazon Chime Voice Connector.
get_voice_connector_termination_health(Client, VoiceConnectorId, QueryMap, HeadersMap)
View Sourceget_voice_connector_termination_health(Client, VoiceConnectorId, QueryMap, HeadersMap, Options0)
View SourceSends email to a maximum of 50 users, inviting them to the specified Amazon Chime Team
account.
Team
account types are currently supported for this action.
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.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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_ListAppInstanceAdmins.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.list_app_instance_admins(Client, AppInstanceArn, QueryMap, HeadersMap)
View Sourcelist_app_instance_admins(Client, AppInstanceArn, QueryMap, HeadersMap, Options0)
View SourceList 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_ListAppInstanceUsers.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.list_app_instance_users(Client, AppInstanceArn, QueryMap, HeadersMap)
View Sourcelist_app_instance_users(Client, AppInstanceArn, QueryMap, HeadersMap, Options0)
View SourceLists 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_ListAppInstances.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.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.list_attendee_tags(Client, AttendeeId, MeetingId, QueryMap, HeadersMap)
View Sourcelist_attendee_tags(Client, AttendeeId, MeetingId, QueryMap, HeadersMap, Options0)
View SourceLists the attendees for the specified Amazon Chime SDK meeting.
For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK: https://docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_ListAttendees.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.Lists all the users banned from a particular channel.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the user that makes the API call as the value in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelBans: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_ListChannelBans.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.list_channel_bans(Client, ChannelArn, QueryMap, HeadersMap, Options0)
View SourceLists 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_ListChannelMemberships.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.list_channel_memberships(Client, ChannelArn, QueryMap, HeadersMap)
View Sourcelist_channel_memberships(Client, ChannelArn, QueryMap, HeadersMap, Options0)
View SourceLists 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_ListChannelMembershipsForAppInstanceUser.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.list_channel_memberships_for_app_instance_user(Client, QueryMap, HeadersMap)
View Sourcelist_channel_memberships_for_app_instance_user(Client, QueryMap, HeadersMap, Options0)
View SourceList 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_ListChannelMessages.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.list_channel_messages(Client, ChannelArn, QueryMap, HeadersMap, Options0)
View SourceLists 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_ListChannelModerators.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.list_channel_moderators(Client, ChannelArn, QueryMap, HeadersMap, Options0)
View SourceLists 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_ListChannels.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.list_channels(Client, AppInstanceArn, QueryMap, HeadersMap, Options0)
View SourceA 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_ListChannelsModeratedByAppInstanceUser.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.list_channels_moderated_by_app_instance_user(Client, QueryMap, HeadersMap)
View Sourcelist_channels_moderated_by_app_instance_user(Client, QueryMap, HeadersMap, Options0)
View SourceReturns 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_media-pipelines-chime_ListMediaCapturePipelines.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.list_media_capture_pipelines(Client, QueryMap, HeadersMap, Options0)
View SourceLists 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_ListTagsForResource.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.list_meeting_tags(Client, MeetingId, QueryMap, HeadersMap, Options0)
View SourceLists 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html in the Amazon Chime SDK Developer Guide.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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_ListProxySessions.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.list_proxy_sessions(Client, VoiceConnectorId, QueryMap, HeadersMap)
View Sourcelist_proxy_sessions(Client, VoiceConnectorId, QueryMap, HeadersMap, Options0)
View Sourcelist_room_memberships(Client, AccountId, RoomId, QueryMap, HeadersMap)
View Sourcelist_room_memberships(Client, AccountId, RoomId, QueryMap, HeadersMap, Options0)
View SourceLists 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.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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_ListSipMediaApplications.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.list_sip_media_applications(Client, QueryMap, HeadersMap, Options0)
View SourceLists 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_ListSipRules.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.list_supported_phone_number_countries(Client, ProductType, QueryMap, HeadersMap)
View Sourcelist_supported_phone_number_countries(Client, ProductType, QueryMap, HeadersMap, Options0)
View SourceLists 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_ListTagsForResource.html.
For messaging: ListTagsForResource: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_ListTagsForResource.html.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.list_tags_for_resource(Client, ResourceARN, QueryMap, HeadersMap, Options0)
View SourceLists 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.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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_ListVoiceConnectorGroups.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.list_voice_connector_groups(Client, QueryMap, HeadersMap, Options0)
View Sourcelist_voice_connector_termination_credentials(Client, VoiceConnectorId)
View SourceLists 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_ListVoiceConnectorTerminationCredentials.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.list_voice_connector_termination_credentials(Client, VoiceConnectorId, QueryMap, HeadersMap)
View Sourcelist_voice_connector_termination_credentials(Client, VoiceConnectorId, QueryMap, HeadersMap, Options0)
View SourceLists 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_ListVoiceConnectors.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.put_app_instance_retention_settings(Client, AppInstanceArn, Input)
View SourceSets 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_PutAppInstanceRetentionSettings.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.put_app_instance_retention_settings(Client, AppInstanceArn, Input0, Options0)
View Sourceput_app_instance_streaming_configurations(Client, AppInstanceArn, Input)
View SourceThe 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_PutMessagingStreamingConfigurations.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.put_app_instance_streaming_configurations(Client, AppInstanceArn, Input0, Options0)
View SourceCreates 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, seeBot
.
put_events_configuration(Client, AccountId, BotId, Input0, Options0)
View SourcePuts 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: https://docs.aws.amazon.com/chime/latest/ag/cloudtrail.html 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: https://docs.aws.amazon.com/chime/latest/ag/chat-retention.html in the Amazon Chime Administration Guide.put_sip_media_application_logging_configuration(Client, SipMediaApplicationId, Input)
View SourceUpdates 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_PutSipMediaApplicationLoggingConfiguration.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.put_sip_media_application_logging_configuration(Client, SipMediaApplicationId, Input0, Options0)
View Sourceput_voice_connector_emergency_calling_configuration(Client, VoiceConnectorId, Input)
View SourcePuts 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_PutVoiceConnectorEmergencyCallingConfiguration.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.put_voice_connector_emergency_calling_configuration(Client, VoiceConnectorId, Input0, Options0)
View Sourceput_voice_connector_logging_configuration(Client, VoiceConnectorId, Input)
View SourceAdds 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_PutVoiceConnectorLoggingConfiguration.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.put_voice_connector_logging_configuration(Client, VoiceConnectorId, Input0, Options0)
View SourceAdds 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_PutVoiceConnectorOrigination.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.put_voice_connector_origination(Client, VoiceConnectorId, Input0, Options0)
View SourcePuts 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_PutVoiceConnectorProxy.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.put_voice_connector_proxy(Client, VoiceConnectorId, Input0, Options0)
View Sourceput_voice_connector_streaming_configuration(Client, VoiceConnectorId, Input)
View SourceAdds 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_PutVoiceConnectorStreamingConfiguration.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.put_voice_connector_streaming_configuration(Client, VoiceConnectorId, Input0, Options0)
View SourceAdds 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_PutVoiceConnectorTermination.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.put_voice_connector_termination(Client, VoiceConnectorId, Input0, Options0)
View Sourceput_voice_connector_termination_credentials(Client, VoiceConnectorId, Input)
View SourceAdds 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_PutVoiceConnectorTerminationCredentials.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.put_voice_connector_termination_credentials(Client, VoiceConnectorId, Input0, Options0)
View SourceRedacts 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_RedactChannelMessage.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.redact_channel_message(Client, ChannelArn, MessageId, Input0, Options0)
View Sourceredact_conversation_message(Client, AccountId, ConversationId, MessageId, Input)
View Sourceredact_conversation_message(Client, AccountId, ConversationId, MessageId, Input0, Options0)
View Sourceredact_room_message(Client, AccountId, MessageId, RoomId, Input0, Options0)
View Sourceregenerate_security_token(Client, AccountId, BotId, Input0, Options0)
View SourceResets the personal meeting PIN for the specified user on an Amazon Chime account.
Returns theUser
object with the updated personal meeting PIN.
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.
search_available_phone_numbers(Client, QueryMap, HeadersMap, Options0)
View SourceSends 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_SendChannelMessage.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.Starts transcription for the specified meetingId
.
For more information, refer to Using Amazon Chime SDK live transcription : https://docs.aws.amazon.com/chime-sdk/latest/dg/meeting-transcription.html 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: https://docs.aws.amazon.com/transcribe/latest/APIReference/API_streaming_StartStreamTranscription.html 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: https://aws.amazon.com/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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_StartMeetingTranscription.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_StopMeetingTranscription.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.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.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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_TagResource.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_TagResource.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.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.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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_UntagResource.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_UntagResource.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.Updates account details for the specified Amazon Chime account.
Currently, only account name and default license updates are supported for this action.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: https://docs.aws.amazon.com/chime/latest/ag/policies.html in the Amazon Chime Administration Guide.Updates AppInstance
metadata.
This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateAppInstance: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_UpdateAppInstance.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_UpdateAppInstanceUser.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.update_app_instance_user(Client, AppInstanceUserArn, Input0, Options0)
View SourceUpdate 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_UpdateChannel.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.Updates the content of a message.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the user that makes the API call as the value in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateChannelMessage: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_UpdateChannelMessage.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.update_channel_message(Client, ChannelArn, MessageId, Input0, Options0)
View SourceThe 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_UpdateChannelReadMarker.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.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.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.update_proxy_session(Client, ProxySessionId, VoiceConnectorId, Input)
View SourceUpdates 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_UpdateProxySession.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.update_proxy_session(Client, ProxySessionId, VoiceConnectorId, Input0, Options0)
View Sourceupdate_room_membership(Client, AccountId, MemberId, RoomId, Input)
View SourceUpdates 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.update_room_membership(Client, AccountId, MemberId, RoomId, Input0, Options0)
View Sourceupdate_sip_media_application(Client, SipMediaApplicationId, Input)
View SourceUpdates 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_UpdateSipMediaApplication.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.update_sip_media_application(Client, SipMediaApplicationId, Input0, Options0)
View Sourceupdate_sip_media_application_call(Client, SipMediaApplicationId, TransactionId, Input)
View SourceInvokes 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_UpdateSipMediaApplicationCall.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.update_sip_media_application_call(Client, SipMediaApplicationId, TransactionId, Input0, Options0)
View SourceUpdates 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_UpdateSipRule.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.Updates user details for a specified user ID.
Currently, onlyLicenseType
updates are supported for this action.
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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_UpdateVoiceConnector.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.update_voice_connector(Client, VoiceConnectorId, Input0, Options0)
View Sourceupdate_voice_connector_group(Client, VoiceConnectorGroupId, Input)
View SourceUpdates 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_UpdateVoiceConnectorGroup.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.update_voice_connector_group(Client, VoiceConnectorGroupId, Input0, Options0)
View SourceValidates 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: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_ValidateE911Address.html, 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: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html in the Amazon Chime SDK Developer Guide.