View Source aws_chime (aws v0.7.14)
The Amazon Chime API (application programming interface) is designed for developers to 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. It also includes API actions for use with the Amazon Chime SDK, which developers use to build their own communication applications. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
You can use an AWS SDK, the AWS Command Line Interface (AWS CLI), or the REST API to make API calls. We recommend using an AWS SDK or the AWS CLI. Each API operation includes links to information about using it 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.
- 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 in the AWS Command Line Interface User Guide. For a list of available Amazon Chime commands, see the Amazon Chime commands 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 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
.
Link to this section Summary
Functions
Creates up to 100 new attendees for an active Amazon Chime SDK meeting.
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 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.
Adds a member to a chat room in an Amazon Chime Enterprise account.
sipMediaApplicationId
.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.
AppInstance
and all associated data asynchronously.Demotes an AppInstanceAdmin
to an AppInstanceUser
.
AppInstance
.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 specified Amazon Chime SDK meeting.
Moves the specified phone number into the Deletion queue.
Deletes a SIP rule.
Deletes 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 termination settings for the specified Amazon Chime Voice Connector.
AppInstance
.AppInstanceAdmin
.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.
Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dialout settings.
AppInstance
.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 the Amazon Chime SDK meeting details for the specified meeting ID.
Gets the retention settings for the specified Amazon Chime Enterprise account.
Retrieves details for the specified user ID, such as primary email address, license type,and personal meeting PIN.
VoiceConnectorItems
.Retrieves the logging configuration details for the specified Amazon Chime Voice Connector.
Retrieves the streaming configuration details for the specified Amazon Chime Voice Connector.
OPTIONS
ping was received from your SIP infrastructure for the specified Amazon Chime Voice Connector.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.
AppInstance
.AppInstanceUsers
created under a single AppInstance
.AppInstance
s created under a single AWS account.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
.
Lists up to 100 active Amazon Chime SDK meetings.
Lists the room details for the specified Amazon Chime Enterprise account.
Lists the users that belong to the specified Amazon Chime account.
AppInstance
retains data.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.
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.
Adds a streaming configuration for the specified Amazon Chime Voice Connector.
Adds termination settings 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.
meetingId
.meetingId
.Updates account details for the specified Amazon Chime account.
Updates the settings for the specified Amazon Chime account.
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 room membership details, such as the member role, for a room in an Amazon Chime Enterprise account.
Invokes the AWS Lambda function associated with the SIP media application and transaction ID in an update request.
Updates user details for a specified user ID.
Validates an address to be used for 911 calls made with Amazon Chime Voice Connectors.
Link to this section 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 Sourceassociate_phone_numbers_with_voice_connector(Client, VoiceConnectorId, Input0, Options0)
View Sourceassociate_phone_numbers_with_voice_connector_group(Client, VoiceConnectorGroupId, Input)
View Sourceassociate_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.
For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime 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 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 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 in the Amazon Chime Administration Guide.
Creates an Amazon Chime SDK messaging AppInstance
under an AWS account.
CreateAppInstance
supports idempotency behavior as described in the AWS API Standard.
Promotes an AppInstanceUser
to an AppInstanceAdmin
.
The promoted user can perform the following actions.
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
.
appInstanceUserId
and Name
for that user.
Creates a new attendee for an active Amazon Chime SDK meeting.
For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.Creates a channel to which you can add users and send messages.
Restriction: You can't change a channel's privacy.
Thex-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the user that makes the API call as the value in the header.
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.
Thex-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the user that makes the API call as the value in the header.
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.
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.
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.
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.
Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees.
For more information about specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon Chime Developer Guide . For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .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 theCreateSipMediaApplicationCall
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 in the Amazon Chime Developer Guide . For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .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.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 Sourcecreate_sip_media_application_call(Client, SipMediaApplicationId, Input)
View SourcesipMediaApplicationId
.
create_sip_media_application_call(Client, SipMediaApplicationId, Input0, Options0)
View SourceCreates 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.
EnablingCreateVoiceConnectorRequest$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.
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.
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.
AppInstance
and all associated data asynchronously.
delete_app_instance_admin(Client, AppInstanceAdminArn, AppInstanceArn, Input)
View SourceDemotes an AppInstanceAdmin
to an AppInstanceUser
.
delete_app_instance_admin(Client, AppInstanceAdminArn, AppInstanceArn, Input0, Options0)
View Sourcedelete_app_instance_streaming_configurations(Client, AppInstanceArn, Input)
View SourceAppInstance
.
delete_app_instance_streaming_configurations(Client, AppInstanceArn, Input0, Options0)
View SourceAppInstanceUser
.
delete_app_instance_user(Client, AppInstanceUserArn, Input0, Options0)
View SourceDeletes 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.
This is an irreversible process.
Thex-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the user that makes the API call as the value in the header.
Removes a user from a channel's ban list.
Thex-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the user that makes the API call as the value in the header.
delete_channel_ban(Client, ChannelArn, MemberArn, Input0, Options0)
View SourceRemoves a member from a channel.
Thex-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the user that makes the API call as the value in the header.
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
.
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.
delete_channel_message(Client, ChannelArn, MessageId, Input0, Options0)
View Sourcedelete_channel_moderator(Client, ChannelArn, ChannelModeratorArn, Input)
View SourceDeletes a channel moderator.
Thex-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the user that makes the API call as the value in the header.
delete_channel_moderator(Client, ChannelArn, ChannelModeratorArn, Input0, Options0)
View Sourcedelete_events_configuration(Client, AccountId, BotId, Input0, Options0)
View Sourcedelete_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 in the Amazon Chime 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 Sourcedelete_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 Sourcedelete_sip_media_application(Client, SipMediaApplicationId, Input0, Options0)
View SourceDeletes a SIP rule.
You must disable a SIP rule before you can delete it.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.delete_voice_connector(Client, VoiceConnectorId, Input0, Options0)
View Sourcedelete_voice_connector_emergency_calling_configuration(Client, VoiceConnectorId, Input)
View Sourcedelete_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.
AnyVoiceConnectorItems
and phone numbers associated with the group must be removed before it can be deleted.
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.delete_voice_connector_origination(Client, VoiceConnectorId, Input0, Options0)
View Sourcedelete_voice_connector_proxy(Client, VoiceConnectorId, Input0, Options0)
View Sourcedelete_voice_connector_streaming_configuration(Client, VoiceConnectorId, Input)
View Sourcedelete_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.delete_voice_connector_termination(Client, VoiceConnectorId, Input0, Options0)
View Sourcedelete_voice_connector_termination_credentials(Client, VoiceConnectorId, Input)
View Sourcedelete_voice_connector_termination_credentials(Client, VoiceConnectorId, Input0, Options0)
View SourceAppInstance
.
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 SourceAppInstanceAdmin
.
describe_app_instance_admin(Client, AppInstanceAdminArn, AppInstanceArn, QueryMap, HeadersMap)
View Sourcedescribe_app_instance_admin(Client, AppInstanceAdminArn, AppInstanceArn, QueryMap, HeadersMap, Options0)
View SourceAppInstanceUser
.
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
.
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.
describe_channel(Client, ChannelArn, QueryMap, HeadersMap, Options0)
View SourceReturns the full details of a channel ban.
Thex-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the user that makes the API call as the value in the header.
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.
Thex-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the user that makes the API call as the value in the header.
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
.
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.
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
.
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.
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.
Thex-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the user that makes the API call as the value in the header.
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 Sourcedisassociate_phone_numbers_from_voice_connector(Client, VoiceConnectorId, Input0, Options0)
View Sourcedisassociate_phone_numbers_from_voice_connector_group(Client, VoiceConnectorGroupId, Input)
View Sourcedisassociate_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 in the Amazon Chime Administration Guide.get_account_settings(Client, AccountId, QueryMap, HeadersMap, Options0)
View SourceAppInstance
.
get_app_instance_retention_settings(Client, AppInstanceArn, QueryMap, HeadersMap)
View Sourceget_app_instance_retention_settings(Client, AppInstanceArn, QueryMap, HeadersMap, Options0)
View SourceAppInstance
.
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 in the Amazon Chime 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 theAppInstanceUserArn
of the user that makes the API call as the value in the header.
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 Sourceget_media_capture_pipeline(Client, MediaPipelineId, QueryMap, HeadersMap)
View Sourceget_media_capture_pipeline(Client, MediaPipelineId, QueryMap, HeadersMap, Options0)
View SourceGets the Amazon Chime SDK meeting details for the specified meeting ID.
For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .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 Sourceget_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 in the Amazon Chime Administration Guide.get_retention_settings(Client, AccountId, QueryMap, HeadersMap, Options0)
View Sourceget_room(Client, AccountId, RoomId, QueryMap, HeadersMap, Options0)
View Sourceget_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 Sourceget_sip_media_application_logging_configuration(Client, SipMediaApplicationId, QueryMap, HeadersMap)
View Sourceget_sip_media_application_logging_configuration(Client, SipMediaApplicationId, QueryMap, HeadersMap, Options0)
View SourceRetrieves 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 Sourceget_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 Sourceget_voice_connector_emergency_calling_configuration(Client, VoiceConnectorId, QueryMap, HeadersMap)
View Sourceget_voice_connector_emergency_calling_configuration(Client, VoiceConnectorId, QueryMap, HeadersMap, Options0)
View SourceVoiceConnectorItems
.
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.get_voice_connector_logging_configuration(Client, VoiceConnectorId, QueryMap, HeadersMap)
View Sourceget_voice_connector_logging_configuration(Client, VoiceConnectorId, QueryMap, HeadersMap, Options0)
View Sourceget_voice_connector_origination(Client, VoiceConnectorId, QueryMap, HeadersMap)
View Sourceget_voice_connector_origination(Client, VoiceConnectorId, QueryMap, HeadersMap, Options0)
View Sourceget_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.get_voice_connector_streaming_configuration(Client, VoiceConnectorId, QueryMap, HeadersMap)
View Sourceget_voice_connector_streaming_configuration(Client, VoiceConnectorId, QueryMap, HeadersMap, Options0)
View Sourceget_voice_connector_termination(Client, VoiceConnectorId, QueryMap, HeadersMap)
View Sourceget_voice_connector_termination(Client, VoiceConnectorId, QueryMap, HeadersMap, Options0)
View SourceOPTIONS
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.AppInstance
.
list_app_instance_admins(Client, AppInstanceArn, QueryMap, HeadersMap)
View Sourcelist_app_instance_admins(Client, AppInstanceArn, QueryMap, HeadersMap, Options0)
View SourceAppInstanceUsers
created under a single AppInstance
.
list_app_instance_users(Client, AppInstanceArn, QueryMap, HeadersMap)
View Sourcelist_app_instance_users(Client, AppInstanceArn, QueryMap, HeadersMap, Options0)
View SourceAppInstance
s created under a single AWS account.
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 in the Amazon Chime Developer Guide.Lists all the users banned from a particular channel.
Thex-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the user that makes the API call as the value in the header.
list_channel_bans(Client, ChannelArn, QueryMap, HeadersMap, Options0)
View SourceLists all channel memberships in a channel.
Thex-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the user that makes the API call as the value in the header.
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.
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.
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 theAppInstanceUserArn
of the user that makes the API call as the value in the header.
list_channel_messages(Client, ChannelArn, QueryMap, HeadersMap, Options0)
View SourceLists all the moderators for a channel.
Thex-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the user that makes the API call as the value in the header.
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
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.
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.
list_channels(Client, AppInstanceArn, QueryMap, HeadersMap, Options0)
View SourceA list of the channels moderated by an AppInstanceUser
.
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.
list_channels_moderated_by_app_instance_user(Client, QueryMap, HeadersMap)
View Sourcelist_channels_moderated_by_app_instance_user(Client, QueryMap, HeadersMap, Options0)
View Sourcelist_media_capture_pipelines(Client, QueryMap, HeadersMap, Options0)
View Sourcelist_meeting_tags(Client, MeetingId, QueryMap, HeadersMap, Options0)
View SourceLists up to 100 active Amazon Chime SDK meetings.
For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.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.list_sip_media_applications(Client, QueryMap, HeadersMap, Options0)
View Sourcelist_supported_phone_number_countries(Client, ProductType, QueryMap, HeadersMap)
View Sourcelist_supported_phone_number_countries(Client, ProductType, QueryMap, HeadersMap, Options0)
View Sourcelist_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.list_voice_connector_groups(Client, QueryMap, HeadersMap, Options0)
View Sourcelist_voice_connector_termination_credentials(Client, VoiceConnectorId)
View Sourcelist_voice_connector_termination_credentials(Client, VoiceConnectorId, QueryMap, HeadersMap)
View Sourcelist_voice_connector_termination_credentials(Client, VoiceConnectorId, QueryMap, HeadersMap, Options0)
View Sourceput_app_instance_retention_settings(Client, AppInstanceArn, Input)
View SourceAppInstance
retains data.
put_app_instance_retention_settings(Client, AppInstanceArn, Input0, Options0)
View Sourceput_app_instance_streaming_configurations(Client, AppInstanceArn, Input)
View SourceAppInstance
.
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 in the Amazon Chime Administration Guide.
To turn off existing retention settings, remove the number of days from the corresponding RetentionDays field in the RetentionSettings object. For more information about retention settings, see Managing Chat Retention Policies in the Amazon Chime Administration Guide.put_sip_media_application_logging_configuration(Client, SipMediaApplicationId, Input)
View Sourceput_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.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.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.put_voice_connector_origination(Client, VoiceConnectorId, Input0, Options0)
View Sourceput_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.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.put_voice_connector_termination(Client, VoiceConnectorId, Input0, Options0)
View Sourceput_voice_connector_termination_credentials(Client, VoiceConnectorId, Input)
View Sourceput_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.
Thex-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the user that makes the API call as the value in the header.
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.
STANDARD
messages can contain 4KB of data and the 1KB of metadata. CONTROL
messages can contain 30 bytes of data and no metadata.
meetingId
.
meetingId
.
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 in the Amazon Chime Administration Guide.AppInstance
metadata.
Updates the details of an AppInstanceUser
.
update_app_instance_user(Client, AppInstanceUserArn, Input0, Options0)
View SourceUpdate a channel's attributes.
Restriction: You can't change a channel's privacy.
Thex-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the user that makes the API call as the value in the header.
Updates the content of a message.
Thex-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the user that makes the API call as the value in the header.
update_channel_message(Client, ChannelArn, MessageId, Input0, Options0)
View SourceThe details of the time when a user last read messages in a channel.
Thex-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the user that makes the API call as the value in the header.
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 Sourceupdate_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 Sourceupdate_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.update_sip_media_application_call(Client, SipMediaApplicationId, TransactionId, Input0, Options0)
View SourceUpdates user details for a specified user ID.
Currently, onlyLicenseType
updates are supported for this action.
update_voice_connector(Client, VoiceConnectorId, Input0, Options0)
View Sourceupdate_voice_connector_group(Client, VoiceConnectorGroupId, Input)
View Sourceupdate_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.