View Source AWS.Chime (aws-elixir 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, 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 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.

definitions
Definitions

using-an-aws-sdk
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
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
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 endpoint https://service.chime.aws.amazon.com.

Administrative permissions are controlled using AWS Identity and Access Management (IAM). For more information, see Identity and Access Management for Amazon Chime in the Amazon Chime Administration Guide.

Link to this section Summary

Functions

associate_phone_number_with_user(client, account_id, user_id, input, options \\ [])

Associates a phone number with the specified Amazon Chime user.

associate_phone_numbers_with_voice_connector(client, voice_connector_id, input, options \\ [])

Associates phone numbers with the specified Amazon Chime Voice Connector.

associate_phone_numbers_with_voice_connector_group(client, voice_connector_group_id, input, options \\ [])

Associates phone numbers with the specified Amazon Chime Voice Connector group.

associate_signin_delegate_groups_with_account(client, account_id, input, options \\ [])

Associates the specified sign-in delegate groups with the specified Amazon Chime account.

batch_create_attendee(client, meeting_id, input, options \\ [])

Creates up to 100 new attendees for an active Amazon Chime SDK meeting.

batch_create_channel_membership(client, channel_arn, input, options \\ [])

Adds a specified number of users to a channel.

batch_create_room_membership(client, account_id, room_id, input, options \\ [])

Adds up to 50 members to a chat room in an Amazon Chime Enterprise account.

batch_delete_phone_number(client, input, options \\ [])

Moves phone numbers into the Deletion queue.

batch_suspend_user(client, account_id, input, options \\ [])

Suspends up to 50 users from a Team or EnterpriseLWA Amazon Chime account.

batch_unsuspend_user(client, account_id, input, options \\ [])

Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime EnterpriseLWA account.

batch_update_phone_number(client, input, options \\ [])

Updates phone number product types or calling names.

batch_update_user(client, account_id, input, options \\ [])

Updates user details within the UpdateUserRequestItem object for up to 20 users for the specified Amazon Chime account.

create_account(client, input, options \\ [])

Creates an Amazon Chime account under the administrator's AWS account.

create_app_instance(client, input, options \\ [])

Creates an Amazon Chime SDK messaging AppInstance under an AWS account.

create_app_instance_admin(client, app_instance_arn, input, options \\ [])

Promotes an AppInstanceUser to an AppInstanceAdmin.

create_app_instance_user(client, input, options \\ [])

Creates a user under an Amazon Chime AppInstance.

create_attendee(client, meeting_id, input, options \\ [])

Creates a new attendee for an active Amazon Chime SDK meeting.

create_bot(client, account_id, input, options \\ [])

Creates a bot for an Amazon Chime Enterprise account.

create_channel(client, input, options \\ [])

Creates a channel to which you can add users and send messages.

create_channel_ban(client, channel_arn, input, options \\ [])

Permanently bans a member from a channel.

create_channel_membership(client, channel_arn, input, options \\ [])

Adds a user to a channel.

create_channel_moderator(client, channel_arn, input, options \\ [])

Creates a new ChannelModerator.

create_media_capture_pipeline(client, input, options \\ [])

Creates a media capture pipeline.

create_meeting(client, input, options \\ [])

Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees.

create_meeting_dial_out(client, meeting_id, input, options \\ [])

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.

create_meeting_with_attendees(client, input, options \\ [])

Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees.

create_phone_number_order(client, input, options \\ [])

Creates an order for phone numbers to be provisioned.

create_proxy_session(client, voice_connector_id, input, options \\ [])

Creates a proxy session on the specified Amazon Chime Voice Connector for the specified participant phone numbers.

create_room(client, account_id, input, options \\ [])

Creates a chat room for the specified Amazon Chime Enterprise account.

create_room_membership(client, account_id, room_id, input, options \\ [])

Adds a member to a chat room in an Amazon Chime Enterprise account.

create_sip_media_application(client, input, options \\ [])

Creates a SIP media application.

create_sip_media_application_call(client, sip_media_application_id, input, options \\ [])

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.

create_sip_rule(client, input, options \\ [])

Creates a SIP rule which can be used to run a SIP media application as a target for a specific trigger type.

create_user(client, account_id, input, options \\ [])

Creates a user under the specified Amazon Chime account.

create_voice_connector(client, input, options \\ [])

Creates an Amazon Chime Voice Connector under the administrator's AWS account.

create_voice_connector_group(client, input, options \\ [])

Creates an Amazon Chime Voice Connector group under the administrator's AWS account.

delete_account(client, account_id, input, options \\ [])

Deletes the specified Amazon Chime account.

delete_app_instance(client, app_instance_arn, input, options \\ [])

Deletes an AppInstance and all associated data asynchronously.

delete_app_instance_admin(client, app_instance_admin_arn, app_instance_arn, input, options \\ [])

Demotes an AppInstanceAdmin to an AppInstanceUser.

delete_app_instance_streaming_configurations(client, app_instance_arn, input, options \\ [])

Deletes the streaming configurations of an AppInstance.

delete_app_instance_user(client, app_instance_user_arn, input, options \\ [])

Deletes an AppInstanceUser.

delete_attendee(client, attendee_id, meeting_id, input, options \\ [])

Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their JoinToken.

delete_channel(client, channel_arn, input, options \\ [])

Immediately makes a channel and its memberships inaccessible and marks them for deletion.

delete_channel_ban(client, channel_arn, member_arn, input, options \\ [])

Removes a user from a channel's ban list.

delete_channel_membership(client, channel_arn, member_arn, input, options \\ [])

Removes a member from a channel.

delete_channel_message(client, channel_arn, message_id, input, options \\ [])

Deletes a channel message.

delete_channel_moderator(client, channel_arn, channel_moderator_arn, input, options \\ [])

Deletes a channel moderator.

delete_events_configuration(client, account_id, bot_id, input, options \\ [])

Deletes the events configuration that allows a bot to receive outgoing events.

delete_media_capture_pipeline(client, media_pipeline_id, input, options \\ [])

Deletes the media capture pipeline.

delete_meeting(client, meeting_id, input, options \\ [])

Deletes the specified Amazon Chime SDK meeting.

delete_phone_number(client, phone_number_id, input, options \\ [])

Moves the specified phone number into the Deletion queue.

delete_proxy_session(client, proxy_session_id, voice_connector_id, input, options \\ [])

Deletes the specified proxy session from the specified Amazon Chime Voice Connector.

delete_room(client, account_id, room_id, input, options \\ [])

Deletes a chat room in an Amazon Chime Enterprise account.

delete_room_membership(client, account_id, member_id, room_id, input, options \\ [])

Removes a member from a chat room in an Amazon Chime Enterprise account.

delete_sip_media_application(client, sip_media_application_id, input, options \\ [])

Deletes a SIP media application.

delete_sip_rule(client, sip_rule_id, input, options \\ [])

Deletes a SIP rule.

delete_voice_connector(client, voice_connector_id, input, options \\ [])

Deletes the specified Amazon Chime Voice Connector.

delete_voice_connector_emergency_calling_configuration(client, voice_connector_id, input, options \\ [])

Deletes the emergency calling configuration details from the specified Amazon Chime Voice Connector.

delete_voice_connector_group(client, voice_connector_group_id, input, options \\ [])

Deletes the specified Amazon Chime Voice Connector group.

delete_voice_connector_origination(client, voice_connector_id, input, options \\ [])

Deletes the origination settings for the specified Amazon Chime Voice Connector.

delete_voice_connector_proxy(client, voice_connector_id, input, options \\ [])

Deletes the proxy configuration from the specified Amazon Chime Voice Connector.

delete_voice_connector_streaming_configuration(client, voice_connector_id, input, options \\ [])

Deletes the streaming configuration for the specified Amazon Chime Voice Connector.

delete_voice_connector_termination(client, voice_connector_id, input, options \\ [])

Deletes the termination settings for the specified Amazon Chime Voice Connector.

delete_voice_connector_termination_credentials(client, voice_connector_id, input, options \\ [])

Deletes the specified SIP credentials used by your equipment to authenticate during call termination.

describe_app_instance(client, app_instance_arn, options \\ [])

Returns the full details of an AppInstance.

describe_app_instance_admin(client, app_instance_admin_arn, app_instance_arn, options \\ [])

Returns the full details of an AppInstanceAdmin.

describe_app_instance_user(client, app_instance_user_arn, options \\ [])

Returns the full details of an AppInstanceUser.

describe_channel(client, channel_arn, chime_bearer \\ nil, options \\ [])

Returns the full details of a channel in an Amazon Chime AppInstance.

describe_channel_ban(client, channel_arn, member_arn, chime_bearer \\ nil, options \\ [])

Returns the full details of a channel ban.

describe_channel_membership(client, channel_arn, member_arn, chime_bearer \\ nil, options \\ [])

Returns the full details of a user's channel membership.

describe_channel_membership_for_app_instance_user(client, channel_arn, app_instance_user_arn, chime_bearer \\ nil, options \\ [])

Returns the details of a channel based on the membership of the specified AppInstanceUser.

describe_channel_moderated_by_app_instance_user(client, channel_arn, app_instance_user_arn, chime_bearer \\ nil, options \\ [])

Returns the full details of a channel moderated by the specified AppInstanceUser.

describe_channel_moderator(client, channel_arn, channel_moderator_arn, chime_bearer \\ nil, options \\ [])

Returns the full details of a single ChannelModerator.

disassociate_phone_number_from_user(client, account_id, user_id, input, options \\ [])

Disassociates the primary provisioned phone number from the specified Amazon Chime user.

disassociate_phone_numbers_from_voice_connector(client, voice_connector_id, input, options \\ [])

Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector.

disassociate_phone_numbers_from_voice_connector_group(client, voice_connector_group_id, input, options \\ [])

Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector group.

disassociate_signin_delegate_groups_from_account(client, account_id, input, options \\ [])

Disassociates the specified sign-in delegate groups from the specified Amazon Chime account.

get_account(client, account_id, options \\ [])

Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.

get_account_settings(client, account_id, options \\ [])

Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dialout settings.

get_app_instance_retention_settings(client, app_instance_arn, options \\ [])

Gets the retention settings for an AppInstance.

get_app_instance_streaming_configurations(client, app_instance_arn, options \\ [])

Gets the streaming settings for an AppInstance.

get_attendee(client, attendee_id, meeting_id, options \\ [])

Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID.

get_bot(client, account_id, bot_id, options \\ [])

Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.

get_channel_message(client, channel_arn, message_id, chime_bearer \\ nil, options \\ [])

Gets the full details of a channel message.

get_events_configuration(client, account_id, bot_id, options \\ [])

Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.

get_global_settings(client, options \\ [])

Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.

get_media_capture_pipeline(client, media_pipeline_id, options \\ [])

Gets an existing media capture pipeline.

get_meeting(client, meeting_id, options \\ [])

This API is is no longer supported and will not be updated. We recommend using the latest version, GetMeeting, in the Amazon Chime SDK.

get_messaging_session_endpoint(client, options \\ [])

The details of the endpoint for the messaging session.

get_phone_number(client, phone_number_id, options \\ [])

Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.

get_phone_number_order(client, phone_number_order_id, options \\ [])

Retrieves details for the specified phone number order, such as the order creation timestamp, phone numbers in E.164 format, product type, and order status.

get_phone_number_settings(client, options \\ [])

Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.

get_proxy_session(client, proxy_session_id, voice_connector_id, options \\ [])

Gets the specified proxy session details for the specified Amazon Chime Voice Connector.

get_retention_settings(client, account_id, options \\ [])

Gets the retention settings for the specified Amazon Chime Enterprise account.

get_room(client, account_id, room_id, options \\ [])

Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.

get_sip_media_application(client, sip_media_application_id, options \\ [])

Retrieves the information for a SIP media application, including name, AWS Region, and endpoints.

get_sip_media_application_logging_configuration(client, sip_media_application_id, options \\ [])

Returns the logging configuration for the specified SIP media application.

get_sip_rule(client, sip_rule_id, options \\ [])

Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.

get_user(client, account_id, user_id, options \\ [])

Retrieves details for the specified user ID, such as primary email address, license type,and personal meeting PIN.

get_user_settings(client, account_id, user_id, options \\ [])

Retrieves settings for the specified user ID, such as any associated phone number settings.

get_voice_connector(client, voice_connector_id, options \\ [])

Retrieves details for the specified Amazon Chime Voice Connector, such as timestamps,name, outbound host, and encryption requirements.

get_voice_connector_emergency_calling_configuration(client, voice_connector_id, options \\ [])

Gets the emergency calling configuration details for the specified Amazon Chime Voice Connector.

get_voice_connector_group(client, voice_connector_group_id, options \\ [])

Retrieves details for the specified Amazon Chime Voice Connector group, such as timestamps,name, and associated VoiceConnectorItems.

get_voice_connector_logging_configuration(client, voice_connector_id, options \\ [])

Retrieves the logging configuration details for the specified Amazon Chime Voice Connector.

get_voice_connector_origination(client, voice_connector_id, options \\ [])

Retrieves origination setting details for the specified Amazon Chime Voice Connector.

get_voice_connector_proxy(client, voice_connector_id, options \\ [])

Gets the proxy configuration details for the specified Amazon Chime Voice Connector.

get_voice_connector_streaming_configuration(client, voice_connector_id, options \\ [])

Retrieves the streaming configuration details for the specified Amazon Chime Voice Connector.

get_voice_connector_termination(client, voice_connector_id, options \\ [])

Retrieves termination setting details for the specified Amazon Chime Voice Connector.

get_voice_connector_termination_health(client, voice_connector_id, options \\ [])

This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorTerminationHealth, in the Amazon Chime SDK.

invite_users(client, account_id, input, options \\ [])

Sends email to a maximum of 50 users, inviting them to the specified Amazon Chime Team account.

list_accounts(client, max_results \\ nil, name \\ nil, next_token \\ nil, user_email \\ nil, options \\ [])

Lists the Amazon Chime accounts under the administrator's AWS account.

list_app_instance_admins(client, app_instance_arn, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of the administrators in the AppInstance.

list_app_instance_users(client, app_instance_arn, max_results \\ nil, next_token \\ nil, options \\ [])

List all AppInstanceUsers created under a single AppInstance.

list_app_instances(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists all Amazon Chime AppInstances created under a single AWS account.

list_attendee_tags(client, attendee_id, meeting_id, options \\ [])

Lists the tags applied to an Amazon Chime SDK attendee resource.

list_attendees(client, meeting_id, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the attendees for the specified Amazon Chime SDK meeting.

list_bots(client, account_id, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.

list_channel_bans(client, channel_arn, max_results \\ nil, next_token \\ nil, chime_bearer \\ nil, options \\ [])

Lists all the users banned from a particular channel.

list_channel_memberships(client, channel_arn, max_results \\ nil, next_token \\ nil, type \\ nil, chime_bearer \\ nil, options \\ [])

Lists all channel memberships in a channel.

list_channel_memberships_for_app_instance_user(client, app_instance_user_arn \\ nil, max_results \\ nil, next_token \\ nil, chime_bearer \\ nil, options \\ [])

Lists all channels that a particular AppInstanceUser is a part of.

list_channel_messages(client, channel_arn, max_results \\ nil, next_token \\ nil, not_after \\ nil, not_before \\ nil, sort_order \\ nil, chime_bearer \\ nil, options \\ [])

List all the messages in a channel.

list_channel_moderators(client, channel_arn, max_results \\ nil, next_token \\ nil, chime_bearer \\ nil, options \\ [])

Lists all the moderators for a channel.

list_channels(client, app_instance_arn, max_results \\ nil, next_token \\ nil, privacy \\ nil, chime_bearer \\ nil, options \\ [])

Lists all Channels created under a single Chime App as a paginated list.

list_channels_moderated_by_app_instance_user(client, app_instance_user_arn \\ nil, max_results \\ nil, next_token \\ nil, chime_bearer \\ nil, options \\ [])

A list of the channels moderated by an AppInstanceUser.

list_media_capture_pipelines(client, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of media capture pipelines.

list_meeting_tags(client, meeting_id, options \\ [])

Lists the tags applied to an Amazon Chime SDK meeting resource.

list_meetings(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists up to 100 active Amazon Chime SDK meetings.

list_phone_number_orders(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the phone number orders for the administrator's Amazon Chime account.

list_phone_numbers(client, filter_name \\ nil, filter_value \\ nil, max_results \\ nil, next_token \\ nil, product_type \\ nil, status \\ nil, options \\ [])

Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.

list_proxy_sessions(client, voice_connector_id, max_results \\ nil, next_token \\ nil, status \\ nil, options \\ [])

Lists the proxy sessions for the specified Amazon Chime Voice Connector.

list_room_memberships(client, account_id, room_id, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members' IDs, email addresses, and names.

list_rooms(client, account_id, max_results \\ nil, member_id \\ nil, next_token \\ nil, options \\ [])

Lists the room details for the specified Amazon Chime Enterprise account.

list_sip_media_applications(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the SIP media applications under the administrator's AWS account.

list_sip_rules(client, max_results \\ nil, next_token \\ nil, sip_media_application_id \\ nil, options \\ [])

Lists the SIP rules under the administrator's AWS account.

list_supported_phone_number_countries(client, product_type, options \\ [])

Lists supported phone number countries.

list_tags_for_resource(client, resource_arn, options \\ [])

Lists the tags applied to an Amazon Chime SDK meeting and messaging resources.

list_users(client, account_id, max_results \\ nil, next_token \\ nil, user_email \\ nil, user_type \\ nil, options \\ [])

Lists the users that belong to the specified Amazon Chime account.

list_voice_connector_groups(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the Amazon Chime Voice Connector groups for the administrator's AWS account.

list_voice_connector_termination_credentials(client, voice_connector_id, options \\ [])

Lists the SIP credentials for the specified Amazon Chime Voice Connector.

list_voice_connectors(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the Amazon Chime Voice Connectors for the administrator's AWS account.

logout_user(client, account_id, user_id, input, options \\ [])

Logs out the specified user from all of the devices they are currently logged into.

metadata()

put_app_instance_retention_settings(client, app_instance_arn, input, options \\ [])

Sets the amount of time in days that a given AppInstance retains data.

put_app_instance_streaming_configurations(client, app_instance_arn, input, options \\ [])

The data streaming configurations of an AppInstance.

put_events_configuration(client, account_id, bot_id, input, options \\ [])

Creates an events configuration that allows a bot to receive outgoing events sent by Amazon Chime.

put_retention_settings(client, account_id, input, options \\ [])

Puts retention settings for the specified Amazon Chime Enterprise account.

put_sip_media_application_logging_configuration(client, sip_media_application_id, input, options \\ [])

Updates the logging configuration for the specified SIP media application.

put_voice_connector_emergency_calling_configuration(client, voice_connector_id, input, options \\ [])

Puts emergency calling configuration details to the specified Amazon Chime Voice Connector, such as emergency phone numbers and calling countries.

put_voice_connector_logging_configuration(client, voice_connector_id, input, options \\ [])

Adds a logging configuration for the specified Amazon Chime Voice Connector.

put_voice_connector_origination(client, voice_connector_id, input, options \\ [])

Adds origination settings for the specified Amazon Chime Voice Connector.

put_voice_connector_proxy(client, voice_connector_id, input, options \\ [])

Puts the specified proxy configuration to the specified Amazon Chime Voice Connector.

put_voice_connector_streaming_configuration(client, voice_connector_id, input, options \\ [])

Adds a streaming configuration for the specified Amazon Chime Voice Connector.

put_voice_connector_termination(client, voice_connector_id, input, options \\ [])

Adds termination settings for the specified Amazon Chime Voice Connector.

put_voice_connector_termination_credentials(client, voice_connector_id, input, options \\ [])

Adds termination SIP credentials for the specified Amazon Chime Voice Connector.

redact_channel_message(client, channel_arn, message_id, input, options \\ [])

Redacts message content, but not metadata.

redact_conversation_message(client, account_id, conversation_id, message_id, input, options \\ [])

Redacts the specified message from the specified Amazon Chime conversation.

redact_room_message(client, account_id, message_id, room_id, input, options \\ [])

Redacts the specified message from the specified Amazon Chime channel.

regenerate_security_token(client, account_id, bot_id, input, options \\ [])

Regenerates the security token for a bot.

reset_personal_pin(client, account_id, user_id, input, options \\ [])

Resets the personal meeting PIN for the specified user on an Amazon Chime account.

restore_phone_number(client, phone_number_id, input, options \\ [])

Moves a phone number from the Deletion queue back into the phone number Inventory.

search_available_phone_numbers(client, area_code \\ nil, city \\ nil, country \\ nil, max_results \\ nil, next_token \\ nil, phone_number_type \\ nil, state \\ nil, toll_free_prefix \\ nil, options \\ [])

Searches for phone numbers that can be ordered.

send_channel_message(client, channel_arn, input, options \\ [])

Sends a message to a particular channel that the member is a part of.

start_meeting_transcription(client, meeting_id, input, options \\ [])

Starts transcription for the specified meetingId.

stop_meeting_transcription(client, meeting_id, input, options \\ [])

Stops transcription for the specified meetingId.

tag_attendee(client, attendee_id, meeting_id, input, options \\ [])

Applies the specified tags to the specified Amazon Chime attendee.

tag_meeting(client, meeting_id, input, options \\ [])

Applies the specified tags to the specified Amazon Chime SDK meeting.

tag_resource(client, input, options \\ [])

Applies the specified tags to the specified Amazon Chime SDK meeting resource.

untag_attendee(client, attendee_id, meeting_id, input, options \\ [])

Untags the specified tags from the specified Amazon Chime SDK attendee.

untag_meeting(client, meeting_id, input, options \\ [])

Untags the specified tags from the specified Amazon Chime SDK meeting.

untag_resource(client, input, options \\ [])

Untags the specified tags from the specified Amazon Chime SDK meeting resource.

update_account(client, account_id, input, options \\ [])

Updates account details for the specified Amazon Chime account.

update_account_settings(client, account_id, input, options \\ [])

Updates the settings for the specified Amazon Chime account.

update_app_instance(client, app_instance_arn, input, options \\ [])

Updates AppInstance metadata.

update_app_instance_user(client, app_instance_user_arn, input, options \\ [])

Updates the details of an AppInstanceUser.

update_bot(client, account_id, bot_id, input, options \\ [])

Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.

update_channel(client, channel_arn, input, options \\ [])

Update a channel's attributes.

update_channel_message(client, channel_arn, message_id, input, options \\ [])

Updates the content of a message.

update_channel_read_marker(client, channel_arn, input, options \\ [])

The details of the time when a user last read messages in a channel.

update_global_settings(client, input, options \\ [])

Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.

update_phone_number(client, phone_number_id, input, options \\ [])

Updates phone number details, such as product type or calling name, for the specified phone number ID.

update_phone_number_settings(client, input, options \\ [])

Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name.

update_proxy_session(client, proxy_session_id, voice_connector_id, input, options \\ [])

Updates the specified proxy session details, such as voice or SMS capabilities.

update_room(client, account_id, room_id, input, options \\ [])

Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account.

update_room_membership(client, account_id, member_id, room_id, input, options \\ [])

Updates room membership details, such as the member role, for a room in an Amazon Chime Enterprise account.

update_sip_media_application(client, sip_media_application_id, input, options \\ [])

Updates the details of the specified SIP media application.

update_sip_media_application_call(client, sip_media_application_id, transaction_id, input, options \\ [])

Invokes the AWS Lambda function associated with the SIP media application and transaction ID in an update request.

update_sip_rule(client, sip_rule_id, input, options \\ [])

Updates the details of the specified SIP rule.

update_user(client, account_id, user_id, input, options \\ [])

Updates user details for a specified user ID.

update_user_settings(client, account_id, user_id, input, options \\ [])

Updates the settings for the specified user, such as phone number settings.

update_voice_connector(client, voice_connector_id, input, options \\ [])

Updates details for the specified Amazon Chime Voice Connector.

update_voice_connector_group(client, voice_connector_group_id, input, options \\ [])

Updates details of the specified Amazon Chime Voice Connector group, such as the name and Amazon Chime Voice Connector priority ranking.

validate_e911_address(client, input, options \\ [])

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, account_id, user_id, input, options \\ [])

Associates a phone number with the specified Amazon Chime user.

associate_phone_numbers_with_voice_connector(client, voice_connector_id, input, options \\ [])

Associates phone numbers with the specified Amazon Chime Voice Connector.

This API is is no longer supported and will not be updated. We recommend using the latest version, AssociatePhoneNumbersWithVoiceConnector, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

associate_phone_numbers_with_voice_connector_group(client, voice_connector_group_id, input, options \\ [])

Associates phone numbers with the specified Amazon Chime Voice Connector group.

This API is is no longer supported and will not be updated. We recommend using the latest version, AssociatePhoneNumbersWithVoiceConnectorGroup, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

associate_signin_delegate_groups_with_account(client, account_id, input, options \\ [])

Associates the specified sign-in delegate groups with the specified Amazon Chime account.

batch_create_attendee(client, meeting_id, input, options \\ [])

Creates up to 100 new attendees for an active Amazon Chime SDK meeting.

This API is is no longer supported and will not be updated. We recommend using the latest version, BatchCreateAttendee, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.

batch_create_channel_membership(client, channel_arn, input, options \\ [])

Adds a specified number of users to a channel.

This API is is no longer supported and will not be updated. We recommend using the latest version, BatchCreateChannelMembership, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

batch_create_room_membership(client, account_id, room_id, input, options \\ [])

Adds up to 50 members to a chat room in an Amazon Chime Enterprise account.

Members can be users or bots. The member role designates whether the member is a chat room administrator or a general chat room member.

batch_delete_phone_number(client, input, options \\ [])

Moves phone numbers into the Deletion queue.

Phone numbers must be disassociated from any users or Amazon Chime Voice Connectors before they can be deleted.

Phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.

batch_suspend_user(client, account_id, input, options \\ [])

Suspends up to 50 users from a Team or EnterpriseLWA Amazon Chime account.

For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.

Users suspended from a Team account are disassociated from the account,but they can continue to use Amazon Chime as free users. To remove the suspension from suspended Team account users, invite them to the Team account again. You can use the InviteUsers action to do so.

Users suspended from an EnterpriseLWA account are immediately signed out of Amazon Chime and can no longer sign in. To remove the suspension from suspended EnterpriseLWA account users, use the BatchUnsuspendUser action.

To sign out users without suspending them, use the LogoutUser action.

batch_unsuspend_user(client, account_id, input, options \\ [])

Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime EnterpriseLWA account.

Only users on EnterpriseLWA accounts can be unsuspended using this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the account types, in the Amazon Chime Administration Guide.

Previously suspended users who are unsuspended using this action are returned to Registered status. Users who are not previously suspended are ignored.

batch_update_phone_number(client, input, options \\ [])

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.

batch_update_user(client, account_id, input, options \\ [])

Updates user details within the UpdateUserRequestItem object for up to 20 users for the specified Amazon Chime account.

Currently, only LicenseType updates are supported for this action.

create_account(client, input, options \\ [])

Creates an Amazon Chime account under the administrator's AWS account.

Only Team account types are currently supported for this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.

create_app_instance(client, input, options \\ [])

Creates an Amazon Chime SDK messaging AppInstance under an AWS account.

Only SDK messaging customers use this API. CreateAppInstance supports idempotency behavior as described in the AWS API Standard.

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateAppInstance, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

create_app_instance_admin(client, app_instance_arn, input, options \\ [])

Promotes an AppInstanceUser to an AppInstanceAdmin.

The promoted user can perform the following actions.

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateAppInstanceAdmin, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

ChannelModerator actions across all channels in the AppInstance.

DeleteChannelMessage actions.

Only an AppInstanceUser can be promoted to an AppInstanceAdmin role.

create_app_instance_user(client, input, options \\ [])

Creates a user under an Amazon Chime AppInstance.

The request consists of a unique appInstanceUserId and Name for that user.

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateAppInstanceUser, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

create_attendee(client, meeting_id, input, options \\ [])

Creates a new attendee for an active Amazon Chime SDK meeting.

For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateAttendee, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

create_bot(client, account_id, input, options \\ [])

Creates a bot for an Amazon Chime Enterprise account.

create_channel(client, input, options \\ [])

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, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

create_channel_ban(client, channel_arn, input, options \\ [])

Permanently bans a member from a channel.

Moderators can't add banned members to a channel. To undo a ban, you first have to DeleteChannelBan, and then CreateChannelMembership. Bans are cleaned up when you delete users or channels.

If you ban a user who is already part of a channel, that user is automatically kicked from the channel.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateChannelBan, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

create_channel_membership(client, channel_arn, input, options \\ [])

Adds a user to a channel.

The InvitedBy response field is derived from the request header. A channel member can:

* List messages

* Send messages

* Receive messages

* Edit their own messages

* Leave the channel

Privacy settings impact this action as follows:

* Public Channels: You do not need to be a member to list messages, but you must be a member to send messages.

* Private Channels: You must be a member to list or send messages.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateChannelMembership, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

create_channel_moderator(client, channel_arn, input, options \\ [])

Creates a new ChannelModerator.

A channel moderator can:

* Add and remove other members of the channel.

* Add and remove other moderators of the channel.

* Add and remove user bans for the channel.

* Redact messages in the channel.

* List messages in the channel.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateChannelModerator, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

create_media_capture_pipeline(client, input, options \\ [])

Creates a media capture pipeline.

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateMediaCapturePipeline, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

create_meeting(client, input, options \\ [])

Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees.

For more information about specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon Chime SDK Developer Guide . For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateMeeting, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

create_meeting_dial_out(client, meeting_id, input, options \\ [])

Also ensures that the From number belongs to the customer.

To play welcome audio or implement an interactive voice response (IVR), use the CreateSipMediaApplicationCall action with the corresponding SIP media application ID.

this-api-is-is-not-available-in-a-dedicated-namespace
This API is is not available in a dedicated namespace.

create_meeting_with_attendees(client, input, options \\ [])

Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees.

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateMeetingWithAttendees, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

create_phone_number_order(client, input, options \\ [])

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.

create_proxy_session(client, voice_connector_id, input, options \\ [])

Creates a proxy session on the specified Amazon Chime Voice Connector for the specified participant phone numbers.

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateProxySession, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

create_room(client, account_id, input, options \\ [])

Creates a chat room for the specified Amazon Chime Enterprise account.

create_room_membership(client, account_id, room_id, input, options \\ [])

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_sip_media_application(client, input, options \\ [])

Creates a SIP media application.

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateSipMediaApplication, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

create_sip_media_application_call(client, sip_media_application_id, input, options \\ [])

Creates an outbound call to a phone number from the phone number specified in the request, and it invokes the endpoint of the specified sipMediaApplicationId.

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateSipMediaApplicationCall, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

create_sip_rule(client, input, options \\ [])

Creates a SIP rule which can be used to run a SIP media application as a target for a specific trigger type.

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateSipRule, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

create_user(client, account_id, input, options \\ [])

Creates a user under the specified Amazon Chime account.

create_voice_connector(client, input, options \\ [])

Creates an Amazon Chime Voice Connector under the administrator's AWS account.

You can choose to create an Amazon Chime Voice Connector in a specific AWS Region.

Enabling CreateVoiceConnectorRequest$RequireEncryption configures your Amazon Chime Voice Connector to use TLS transport for SIP signaling and Secure RTP (SRTP) for media. Inbound calls use TLS transport, and unencrypted outbound calls are blocked.

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateVoiceConnector, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

create_voice_connector_group(client, input, options \\ [])

Creates an Amazon Chime Voice Connector group under the administrator's AWS account.

You can associate Amazon Chime Voice Connectors with the Amazon Chime Voice Connector group by including VoiceConnectorItems in the request.

You can include Amazon Chime Voice Connectors from different AWS Regions in your group. This creates a fault tolerant mechanism for fallback in case of availability events.

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateVoiceConnectorGroup, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

delete_account(client, account_id, input, options \\ [])

Deletes the specified Amazon Chime account.

You must suspend all users before deleting Team account. You can use the BatchSuspendUser action to dodo.

For EnterpriseLWA and EnterpriseAD accounts, you must release the claimed domains for your Amazon Chime account before deletion. As soon as you release the domain, all users under that account are suspended.

Deleted accounts appear in your Disabled accounts list for 90 days. To restore deleted account from your Disabled accounts list, you must contact AWS Support.

After 90 days, deleted accounts are permanently removed from your Disabled accounts list.

delete_app_instance(client, app_instance_arn, input, options \\ [])

Deletes an AppInstance and all associated data asynchronously.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteAppInstance, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

delete_app_instance_admin(client, app_instance_admin_arn, app_instance_arn, input, options \\ [])

Demotes an AppInstanceAdmin to an AppInstanceUser.

This action does not delete the user.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteAppInstanceAdmin, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

delete_app_instance_streaming_configurations(client, app_instance_arn, input, options \\ [])

Deletes the streaming configurations of an AppInstance.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteAppInstanceStreamingConfigurations, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

delete_app_instance_user(client, app_instance_user_arn, input, options \\ [])

Deletes an AppInstanceUser.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteAppInstanceUser, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

delete_attendee(client, attendee_id, meeting_id, input, options \\ [])

Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their JoinToken.

Attendees are automatically deleted when a Amazon Chime SDK meeting is deleted. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteAttendee, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

delete_channel(client, channel_arn, input, options \\ [])

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, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

delete_channel_ban(client, channel_arn, member_arn, input, options \\ [])

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, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

delete_channel_membership(client, channel_arn, member_arn, input, options \\ [])

Removes a member from a channel.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteChannelMembership, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

delete_channel_message(client, channel_arn, message_id, input, options \\ [])

Deletes a channel message.

Only admins can perform this action. Deletion makes messages inaccessible immediately. A background process deletes any revisions created by UpdateChannelMessage.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteChannelMessage, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

delete_channel_moderator(client, channel_arn, channel_moderator_arn, input, options \\ [])

Deletes a channel moderator.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteChannelModerator, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

delete_events_configuration(client, account_id, bot_id, input, options \\ [])

Deletes the events configuration that allows a bot to receive outgoing events.

delete_media_capture_pipeline(client, media_pipeline_id, input, options \\ [])

Deletes the media capture pipeline.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteMediaCapturePipeline, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

delete_meeting(client, meeting_id, input, options \\ [])

Deletes the specified Amazon Chime SDK meeting.

The operation deletes all attendees, disconnects all clients, and prevents new clients from joining the meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteMeeting, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

delete_phone_number(client, phone_number_id, input, options \\ [])

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
Deletion queue

for 7 days before they are deleted permanently.

delete_proxy_session(client, proxy_session_id, voice_connector_id, input, options \\ [])

Deletes the specified proxy session from the specified Amazon Chime Voice Connector.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteProxySession, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

delete_room(client, account_id, room_id, input, options \\ [])

Deletes a chat room in an Amazon Chime Enterprise account.

delete_room_membership(client, account_id, member_id, room_id, input, options \\ [])

Removes a member from a chat room in an Amazon Chime Enterprise account.

delete_sip_media_application(client, sip_media_application_id, input, options \\ [])

Deletes a SIP media application.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteSipMediaApplication, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

delete_sip_rule(client, sip_rule_id, input, options \\ [])

Deletes a SIP rule.

You must disable a SIP rule before you can delete it.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteSipRule, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

delete_voice_connector(client, voice_connector_id, input, options \\ [])

Deletes the specified Amazon Chime Voice Connector.

Any phone numbers associated with the Amazon Chime Voice Connector must be disassociated from it before it can be deleted.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnector, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

delete_voice_connector_emergency_calling_configuration(client, voice_connector_id, input, options \\ [])

Deletes the emergency calling configuration details from the specified Amazon Chime Voice Connector.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnectorEmergencyCallingConfiguration, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

delete_voice_connector_group(client, voice_connector_group_id, input, options \\ [])

Deletes the specified Amazon Chime Voice Connector group.

Any VoiceConnectorItems and phone numbers associated with the group must be removed before it can be deleted.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnectorGroup, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

delete_voice_connector_origination(client, voice_connector_id, input, options \\ [])

Deletes the origination settings for the specified Amazon Chime Voice Connector.

If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to deleting the origination settings.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnectorOrigination, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

delete_voice_connector_proxy(client, voice_connector_id, input, options \\ [])

Deletes the proxy configuration from the specified Amazon Chime Voice Connector.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceProxy, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

delete_voice_connector_streaming_configuration(client, voice_connector_id, input, options \\ [])

Deletes the streaming configuration for the specified Amazon Chime Voice Connector.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnectorStreamingConfiguration, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

delete_voice_connector_termination(client, voice_connector_id, input, options \\ [])

Deletes the termination settings for the specified Amazon Chime Voice Connector.

If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to deleting the termination settings.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnectorTermination, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

delete_voice_connector_termination_credentials(client, voice_connector_id, input, options \\ [])

Deletes the specified SIP credentials used by your equipment to authenticate during call termination.

This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnectorTerminationCredentials, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

describe_app_instance(client, app_instance_arn, options \\ [])

Returns the full details of an AppInstance.

This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeAppInstance, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

describe_app_instance_admin(client, app_instance_admin_arn, app_instance_arn, options \\ [])

Returns the full details of an AppInstanceAdmin.

This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeAppInstanceAdmin, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

describe_app_instance_user(client, app_instance_user_arn, options \\ [])

Returns the full details of an AppInstanceUser.

This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeAppInstanceUser, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

describe_channel(client, channel_arn, chime_bearer \\ nil, options \\ [])

Returns the full details of a channel in an Amazon Chime AppInstance.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannel, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

describe_channel_ban(client, channel_arn, member_arn, chime_bearer \\ nil, options \\ [])

Returns the full details of a channel ban.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannelBan, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

describe_channel_membership(client, channel_arn, member_arn, chime_bearer \\ nil, options \\ [])

Returns the full details of a user's channel membership.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannelMembership, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

describe_channel_membership_for_app_instance_user(client, channel_arn, app_instance_user_arn, chime_bearer \\ nil, options \\ [])

Returns the details of a channel based on the membership of the specified AppInstanceUser.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannelMembershipForAppInstanceUser, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

describe_channel_moderated_by_app_instance_user(client, channel_arn, app_instance_user_arn, chime_bearer \\ nil, options \\ [])

Returns the full details of a channel moderated by the specified AppInstanceUser.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannelModeratedByAppInstanceUser, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

describe_channel_moderator(client, channel_arn, channel_moderator_arn, chime_bearer \\ nil, options \\ [])

Returns the full details of a single ChannelModerator.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannelModerator, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

disassociate_phone_number_from_user(client, account_id, user_id, input, options \\ [])

Disassociates the primary provisioned phone number from the specified Amazon Chime user.

disassociate_phone_numbers_from_voice_connector(client, voice_connector_id, input, options \\ [])

Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector.

This API is is no longer supported and will not be updated. We recommend using the latest version, DisassociatePhoneNumbersFromVoiceConnector, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

disassociate_phone_numbers_from_voice_connector_group(client, voice_connector_group_id, input, options \\ [])

Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector group.

This API is is no longer supported and will not be updated. We recommend using the latest version, DisassociatePhoneNumbersFromVoiceConnectorGroup, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

disassociate_signin_delegate_groups_from_account(client, account_id, input, options \\ [])

Disassociates the specified sign-in delegate groups from the specified Amazon Chime account.

get_account(client, account_id, options \\ [])

Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.

get_account_settings(client, account_id, options \\ [])

Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dialout settings.

For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.

get_app_instance_retention_settings(client, app_instance_arn, options \\ [])

Gets the retention settings for an AppInstance.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetMessagingRetentionSettings, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

get_app_instance_streaming_configurations(client, app_instance_arn, options \\ [])

Gets the streaming settings for an AppInstance.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetMessagingStreamingConfigurations, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

get_attendee(client, attendee_id, meeting_id, options \\ [])

Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID.

For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetAttendee, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

get_bot(client, account_id, bot_id, options \\ [])

Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.

get_channel_message(client, channel_arn, message_id, chime_bearer \\ nil, options \\ [])

Gets the full details of a channel message.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetChannelMessage, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

get_events_configuration(client, account_id, bot_id, options \\ [])

Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.

get_global_settings(client, options \\ [])

Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.

get_media_capture_pipeline(client, media_pipeline_id, options \\ [])

Gets an existing media capture pipeline.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetMediaCapturePipeline, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

get_meeting(client, meeting_id, options \\ [])

This API is is no longer supported and will not be updated. We recommend using the latest version, GetMeeting, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Gets the Amazon Chime SDK meeting details for the specified meeting ID. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide .

get_messaging_session_endpoint(client, options \\ [])

The details of the endpoint for the messaging session.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetMessagingSessionEndpoint, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

get_phone_number(client, phone_number_id, options \\ [])

Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.

get_phone_number_order(client, phone_number_order_id, options \\ [])

Retrieves details for the specified phone number order, such as the order creation timestamp, phone numbers in E.164 format, product type, and order status.

get_phone_number_settings(client, options \\ [])

Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.

get_proxy_session(client, proxy_session_id, voice_connector_id, options \\ [])

Gets the specified proxy session details for the specified Amazon Chime Voice Connector.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetProxySession, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

get_retention_settings(client, account_id, options \\ [])

Gets the retention settings for the specified Amazon Chime Enterprise account.

For more information about retention settings, see Managing Chat Retention Policies in the Amazon Chime Administration Guide.

get_room(client, account_id, room_id, options \\ [])

Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.

get_sip_media_application(client, sip_media_application_id, options \\ [])

Retrieves the information for a SIP media application, including name, AWS Region, and endpoints.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetSipMediaApplication, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

get_sip_media_application_logging_configuration(client, sip_media_application_id, options \\ [])

Returns the logging configuration for the specified SIP media application.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetSipMediaApplicationLoggingConfiguration, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

get_sip_rule(client, sip_rule_id, options \\ [])

Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetSipRule, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

get_user(client, account_id, user_id, options \\ [])

Retrieves details for the specified user ID, such as primary email address, license type,and personal meeting PIN.

To retrieve user details with an email address instead of a user ID, use the ListUsers action, and then filter by email address.

get_user_settings(client, account_id, user_id, options \\ [])

Retrieves settings for the specified user ID, such as any associated phone number settings.

get_voice_connector(client, voice_connector_id, options \\ [])

Retrieves details for the specified Amazon Chime Voice Connector, such as timestamps,name, outbound host, and encryption requirements.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnector, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

get_voice_connector_emergency_calling_configuration(client, voice_connector_id, options \\ [])

Gets the emergency calling configuration details for the specified Amazon Chime Voice Connector.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorEmergencyCallingConfiguration, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

get_voice_connector_group(client, voice_connector_group_id, options \\ [])

Retrieves details for the specified Amazon Chime Voice Connector group, such as timestamps,name, and associated VoiceConnectorItems.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorGroup, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

get_voice_connector_logging_configuration(client, voice_connector_id, options \\ [])

Retrieves the logging configuration details for the specified Amazon Chime Voice Connector.

Shows whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorLoggingConfiguration, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

get_voice_connector_origination(client, voice_connector_id, options \\ [])

Retrieves origination setting details for the specified Amazon Chime Voice Connector.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorOrigination, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

get_voice_connector_proxy(client, voice_connector_id, options \\ [])

Gets the proxy configuration details for the specified Amazon Chime Voice Connector.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorProxy, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

get_voice_connector_streaming_configuration(client, voice_connector_id, options \\ [])

Retrieves the streaming configuration details for the specified Amazon Chime Voice Connector.

Shows whether media streaming is enabled for sending to Amazon Kinesis. It also shows the retention period, in hours, for the Amazon Kinesis data.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorStreamingConfiguration, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

get_voice_connector_termination(client, voice_connector_id, options \\ [])

Retrieves termination setting details for the specified Amazon Chime Voice Connector.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorTermination, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

get_voice_connector_termination_health(client, voice_connector_id, options \\ [])

This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorTerminationHealth, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Retrieves information about the last time a SIP OPTIONS ping was received from your SIP infrastructure for the specified Amazon Chime Voice Connector.

invite_users(client, account_id, input, options \\ [])

Sends email to a maximum of 50 users, inviting them to the specified Amazon Chime Team account.

Only Team account types are currently supported for this action.

list_accounts(client, max_results \\ nil, name \\ nil, next_token \\ nil, user_email \\ nil, options \\ [])

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.

list_app_instance_admins(client, app_instance_arn, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of the administrators in the AppInstance.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListAppInstanceAdmins, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

list_app_instance_users(client, app_instance_arn, max_results \\ nil, next_token \\ nil, options \\ [])

List all AppInstanceUsers created under a single AppInstance.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListAppInstanceUsers, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

list_app_instances(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists all Amazon Chime AppInstances created under a single AWS account.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListAppInstances, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

list_attendee_tags(client, attendee_id, meeting_id, options \\ [])

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_attendees(client, meeting_id, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the attendees for the specified Amazon Chime SDK meeting.

For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListAttendees, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

list_bots(client, account_id, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.

list_channel_bans(client, channel_arn, max_results \\ nil, next_token \\ nil, chime_bearer \\ nil, options \\ [])

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, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

list_channel_memberships(client, channel_arn, max_results \\ nil, next_token \\ nil, type \\ nil, chime_bearer \\ nil, options \\ [])

Lists all channel memberships in a channel.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelMemberships, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

list_channel_memberships_for_app_instance_user(client, app_instance_user_arn \\ nil, max_results \\ nil, next_token \\ nil, chime_bearer \\ nil, options \\ [])

Lists all channels that a particular AppInstanceUser is a part of.

Only an AppInstanceAdmin can call the API with a user ARN that is not their own.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelMembershipsForAppInstanceUser, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

list_channel_messages(client, channel_arn, max_results \\ nil, next_token \\ nil, not_after \\ nil, not_before \\ nil, sort_order \\ nil, chime_bearer \\ nil, options \\ [])

List all the messages in a channel.

Returns a paginated list of ChannelMessages. By default, sorted by creation timestamp in descending order.

Redacted messages appear in the results as empty, since they are only redacted, not deleted. Deleted messages do not appear in the results. This action always returns the latest version of an edited message.

Also, the x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelMessages, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

list_channel_moderators(client, channel_arn, max_results \\ nil, next_token \\ nil, chime_bearer \\ nil, options \\ [])

Lists all the moderators for a channel.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelModerators, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

list_channels(client, app_instance_arn, max_results \\ nil, next_token \\ nil, privacy \\ nil, chime_bearer \\ nil, options \\ [])

Lists 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.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannels, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

list_channels_moderated_by_app_instance_user(client, app_instance_user_arn \\ nil, max_results \\ nil, next_token \\ nil, chime_bearer \\ nil, options \\ [])

A list of the channels moderated by an AppInstanceUser.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelsModeratedByAppInstanceUser, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

list_media_capture_pipelines(client, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of media capture pipelines.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListMediaCapturePipelines, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

list_meeting_tags(client, meeting_id, options \\ [])

Lists the tags applied to an Amazon Chime SDK meeting resource.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListTagsForResource, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

list_meetings(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists up to 100 active Amazon Chime SDK meetings.

ListMeetings is not supported in the Amazon Chime SDK Meetings Namespace. Update your application to remove calls to this API.

For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.

list_phone_number_orders(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the phone number orders for the administrator's Amazon Chime account.

list_phone_numbers(client, filter_name \\ nil, filter_value \\ nil, max_results \\ nil, next_token \\ nil, product_type \\ nil, status \\ nil, options \\ [])

Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.

list_proxy_sessions(client, voice_connector_id, max_results \\ nil, next_token \\ nil, status \\ nil, options \\ [])

Lists the proxy sessions for the specified Amazon Chime Voice Connector.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListProxySessions, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

list_room_memberships(client, account_id, room_id, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members' IDs, email addresses, and names.

list_rooms(client, account_id, max_results \\ nil, member_id \\ nil, next_token \\ nil, options \\ [])

Lists the room details for the specified Amazon Chime Enterprise account.

Optionally, filter the results by a member ID (user ID or bot ID) to see a list of rooms that the member belongs to.

list_sip_media_applications(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the SIP media applications under the administrator's AWS account.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListSipMediaApplications, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

list_sip_rules(client, max_results \\ nil, next_token \\ nil, sip_media_application_id \\ nil, options \\ [])

Lists the SIP rules under the administrator's AWS account.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListSipRules, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

list_supported_phone_number_countries(client, product_type, options \\ [])

Lists supported phone number countries.

list_tags_for_resource(client, resource_arn, options \\ [])

Lists the tags applied to an Amazon Chime SDK meeting and messaging resources.

This API is is no longer supported and will not be updated. We recommend using the applicable latest version in the Amazon Chime SDK.

For meetings: ListTagsForResource.

For messaging: ListTagsForResource.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

list_users(client, account_id, max_results \\ nil, next_token \\ nil, user_email \\ nil, user_type \\ nil, options \\ [])

Lists the users that belong to the specified Amazon Chime account.

You can specify an email address to list only the user that the email address belongs to.

list_voice_connector_groups(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the Amazon Chime Voice Connector groups for the administrator's AWS account.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListVoiceConnectorGroups, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

list_voice_connector_termination_credentials(client, voice_connector_id, options \\ [])

Lists the SIP credentials for the specified Amazon Chime Voice Connector.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListVoiceConnectorTerminationCredentials, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

list_voice_connectors(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the Amazon Chime Voice Connectors for the administrator's AWS account.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListVoiceConnectors, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

logout_user(client, account_id, user_id, input, options \\ [])

Logs out the specified user from all of the devices they are currently logged into.

metadata()

put_app_instance_retention_settings(client, app_instance_arn, input, options \\ [])

Sets the amount of time in days that a given AppInstance retains data.

This API is is no longer supported and will not be updated. We recommend using the latest version, PutAppInstanceRetentionSettings, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

put_app_instance_streaming_configurations(client, app_instance_arn, input, options \\ [])

The data streaming configurations of an AppInstance.

This API is is no longer supported and will not be updated. We recommend using the latest version, PutMessagingStreamingConfigurations, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

put_events_configuration(client, account_id, bot_id, input, options \\ [])

Creates an events configuration that allows a bot to receive outgoing events sent by Amazon Chime.

Choose either an HTTPS endpoint or a Lambda function ARN. For more information, see Bot.

put_retention_settings(client, account_id, input, options \\ [])

Puts retention settings for the specified Amazon Chime Enterprise account.

We recommend using AWS CloudTrail to monitor usage of this API for your account. For more information, see Logging Amazon Chime API Calls with AWS CloudTrail in the Amazon Chime Administration Guide.

To turn off existing retention settings, remove the number of days from the corresponding

retentiondays
RetentionDays

field in the

retentionsettings
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, sip_media_application_id, input, options \\ [])

Updates the logging configuration for the specified SIP media application.

This API is is no longer supported and will not be updated. We recommend using the latest version, PutSipMediaApplicationLoggingConfiguration, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

put_voice_connector_emergency_calling_configuration(client, voice_connector_id, input, options \\ [])

Puts emergency calling configuration details to the specified Amazon Chime Voice Connector, such as emergency phone numbers and calling countries.

Origination and termination settings must be enabled for the Amazon Chime Voice Connector before emergency calling can be configured.

This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorEmergencyCallingConfiguration, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

put_voice_connector_logging_configuration(client, voice_connector_id, input, options \\ [])

Adds a logging configuration for the specified Amazon Chime Voice Connector.

The logging configuration specifies whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.

This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorLoggingConfiguration, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

put_voice_connector_origination(client, voice_connector_id, input, options \\ [])

Adds origination settings for the specified Amazon Chime Voice Connector.

If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to turning off origination settings.

This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorOrigination, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

put_voice_connector_proxy(client, voice_connector_id, input, options \\ [])

Puts the specified proxy configuration to the specified Amazon Chime Voice Connector.

This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorProxy, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

put_voice_connector_streaming_configuration(client, voice_connector_id, input, options \\ [])

Adds a streaming configuration for the specified Amazon Chime Voice Connector.

The streaming configuration specifies whether media streaming is enabled for sending to Kinesis. It also sets the retention period, in hours, for the Amazon Kinesis data.

This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorStreamingConfiguration, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

put_voice_connector_termination(client, voice_connector_id, input, options \\ [])

Adds termination settings for the specified Amazon Chime Voice Connector.

If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to turning off termination settings.

This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorTermination, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

put_voice_connector_termination_credentials(client, voice_connector_id, input, options \\ [])

Adds termination SIP credentials for the specified Amazon Chime Voice Connector.

This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorTerminationCredentials, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

redact_channel_message(client, channel_arn, message_id, input, options \\ [])

Redacts message content, but not metadata.

The message exists in the back end, but the action returns null content, and the state shows as redacted.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, RedactChannelMessage, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

redact_conversation_message(client, account_id, conversation_id, message_id, input, options \\ [])

Redacts the specified message from the specified Amazon Chime conversation.

redact_room_message(client, account_id, message_id, room_id, input, options \\ [])

Redacts the specified message from the specified Amazon Chime channel.

regenerate_security_token(client, account_id, bot_id, input, options \\ [])

Regenerates the security token for a bot.

reset_personal_pin(client, account_id, user_id, input, options \\ [])

Resets the personal meeting PIN for the specified user on an Amazon Chime account.

Returns the User object with the updated personal meeting PIN.

restore_phone_number(client, phone_number_id, input, options \\ [])

Moves a phone number from the Deletion queue back into the phone number Inventory.

search_available_phone_numbers(client, area_code \\ nil, city \\ nil, country \\ nil, max_results \\ nil, next_token \\ nil, phone_number_type \\ nil, state \\ nil, toll_free_prefix \\ nil, options \\ [])

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.

send_channel_message(client, channel_arn, input, options \\ [])

Sends a message to a particular channel that the member is a part of.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Also, STANDARD messages can contain 4KB of data and the 1KB of metadata. CONTROL messages can contain 30 bytes of data and no metadata.

This API is is no longer supported and will not be updated. We recommend using the latest version, SendChannelMessage, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

start_meeting_transcription(client, meeting_id, input, options \\ [])

Starts transcription for the specified meetingId.

For more information, refer to Using Amazon Chime SDK live transcription in the Amazon Chime SDK Developer Guide.

If you specify an invalid configuration, a TranscriptFailed event will be sent with the contents of the BadRequestException generated by Amazon Transcribe. For more information on each parameter and which combinations are valid, refer to the StartStreamTranscription API in the Amazon Transcribe Developer Guide.

Amazon Chime SDK live transcription is powered by Amazon Transcribe. Use of Amazon Transcribe is subject to the AWS Service Terms, including the terms specific to the AWS Machine Learning and Artificial Intelligence Services.

This API is is no longer supported and will not be updated. We recommend using the latest version, StartMeetingTranscription, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

stop_meeting_transcription(client, meeting_id, input, options \\ [])

Stops transcription for the specified meetingId.

This API is is no longer supported and will not be updated. We recommend using the latest version, StopMeetingTranscription, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

tag_attendee(client, attendee_id, meeting_id, input, options \\ [])

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.

tag_meeting(client, meeting_id, input, options \\ [])

Applies the specified tags to the specified Amazon Chime SDK meeting.

This API is is no longer supported and will not be updated. We recommend using the latest version, TagResource, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

tag_resource(client, input, options \\ [])

Applies the specified tags to the specified Amazon Chime SDK meeting resource.

This API is is no longer supported and will not be updated. We recommend using the latest version, TagResource, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

untag_attendee(client, attendee_id, meeting_id, input, options \\ [])

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.

untag_meeting(client, meeting_id, input, options \\ [])

Untags the specified tags from the specified Amazon Chime SDK meeting.

This API is is no longer supported and will not be updated. We recommend using the latest version, UntagResource, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

untag_resource(client, input, options \\ [])

Untags the specified tags from the specified Amazon Chime SDK meeting resource.

Applies the specified tags to the specified Amazon Chime SDK meeting resource.

This API is is no longer supported and will not be updated. We recommend using the latest version, UntagResource, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

update_account(client, account_id, input, options \\ [])

Updates account details for the specified Amazon Chime account.

Currently, only account name and default license updates are supported for this action.

update_account_settings(client, account_id, input, options \\ [])

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.

update_app_instance(client, app_instance_arn, input, options \\ [])

Updates AppInstance metadata.

This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateAppInstance, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

update_app_instance_user(client, app_instance_user_arn, input, options \\ [])

Updates the details of an AppInstanceUser.

You can update names and metadata.

This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateAppInstanceUser, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

update_bot(client, account_id, bot_id, input, options \\ [])

Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.

update_channel(client, channel_arn, input, options \\ [])

Update a channel's attributes.

Restriction: You can't change a channel's privacy.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateChannel, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

update_channel_message(client, channel_arn, message_id, input, options \\ [])

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, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

update_channel_read_marker(client, channel_arn, input, options \\ [])

The details of the time when a user last read messages in a channel.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateChannelReadMarker, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

update_global_settings(client, input, options \\ [])

Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.

update_phone_number(client, phone_number_id, input, options \\ [])

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.

update_phone_number_settings(client, input, options \\ [])

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, proxy_session_id, voice_connector_id, input, options \\ [])

Updates the specified proxy session details, such as voice or SMS capabilities.

This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateProxySession, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

update_room(client, account_id, room_id, input, options \\ [])

Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account.

update_room_membership(client, account_id, member_id, room_id, input, options \\ [])

Updates room membership details, such as the member role, for a room in an Amazon Chime Enterprise account.

The member role designates whether the member is a chat room administrator or a general chat room member. The member role can be updated only for user IDs.

update_sip_media_application(client, sip_media_application_id, input, options \\ [])

Updates the details of the specified SIP media application.

This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateSipMediaApplication, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

update_sip_media_application_call(client, sip_media_application_id, transaction_id, input, options \\ [])

Invokes the AWS Lambda function associated with the SIP media application and transaction ID in an update request.

The Lambda function can then return a new set of actions.

This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateSipMediaApplicationCall, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

update_sip_rule(client, sip_rule_id, input, options \\ [])

Updates the details of the specified SIP rule.

This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateSipRule, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

update_user(client, account_id, user_id, input, options \\ [])

Updates user details for a specified user ID.

Currently, only LicenseType updates are supported for this action.

update_user_settings(client, account_id, user_id, input, options \\ [])

Updates the settings for the specified user, such as phone number settings.

update_voice_connector(client, voice_connector_id, input, options \\ [])

Updates details for the specified Amazon Chime Voice Connector.

This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateVoiceConnector, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

update_voice_connector_group(client, voice_connector_group_id, input, options \\ [])

Updates details of the specified Amazon Chime Voice Connector group, such as the name and Amazon Chime Voice Connector priority ranking.

This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateVoiceConnectorGroup, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

validate_e911_address(client, input, options \\ [])

Validates an address to be used for 911 calls made with Amazon Chime Voice Connectors.

You can use validated addresses in a Presence Information Data Format Location Object file that you include in SIP requests. That helps ensure that addresses are routed to the appropriate Public Safety Answering Point.

This API is is no longer supported and will not be updated. We recommend using the latest version, ValidateE911Address, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Settings View Source AWS.Chime (aws-elixir v1.0.4)

definitions Definitions

using-an-aws-sdk Using an AWS SDK

using-the-aws-cli Using the AWS CLI

using-rest-apis Using REST APIs

Link to this section Summary

Functions

Link to this section Functions

associate_phone_number_with_user(client, account_id, user_id, input, options \\ [])

associate_phone_numbers_with_voice_connector(client, voice_connector_id, input, options \\ [])

associate_phone_numbers_with_voice_connector_group(client, voice_connector_group_id, input, options \\ [])

associate_signin_delegate_groups_with_account(client, account_id, input, options \\ [])

batch_create_attendee(client, meeting_id, input, options \\ [])

batch_create_channel_membership(client, channel_arn, input, options \\ [])

batch_create_room_membership(client, account_id, room_id, input, options \\ [])

batch_delete_phone_number(client, input, options \\ [])

batch_suspend_user(client, account_id, input, options \\ [])

batch_unsuspend_user(client, account_id, input, options \\ [])

batch_update_phone_number(client, input, options \\ [])

batch_update_user(client, account_id, input, options \\ [])

create_account(client, input, options \\ [])

create_app_instance(client, input, options \\ [])

create_app_instance_admin(client, app_instance_arn, input, options \\ [])

create_app_instance_user(client, input, options \\ [])

create_attendee(client, meeting_id, input, options \\ [])

create_bot(client, account_id, input, options \\ [])

create_channel(client, input, options \\ [])

create_channel_ban(client, channel_arn, input, options \\ [])

create_channel_membership(client, channel_arn, input, options \\ [])

create_channel_moderator(client, channel_arn, input, options \\ [])

create_media_capture_pipeline(client, input, options \\ [])

create_meeting(client, input, options \\ [])

create_meeting_dial_out(client, meeting_id, input, options \\ [])

this-api-is-is-not-available-in-a-dedicated-namespace This API is is not available in a dedicated namespace.

create_meeting_with_attendees(client, input, options \\ [])

create_phone_number_order(client, input, options \\ [])

create_proxy_session(client, voice_connector_id, input, options \\ [])

create_room(client, account_id, input, options \\ [])

create_room_membership(client, account_id, room_id, input, options \\ [])

create_sip_media_application(client, input, options \\ [])

create_sip_media_application_call(client, sip_media_application_id, input, options \\ [])

create_sip_rule(client, input, options \\ [])

create_user(client, account_id, input, options \\ [])

create_voice_connector(client, input, options \\ [])

create_voice_connector_group(client, input, options \\ [])

delete_account(client, account_id, input, options \\ [])

delete_app_instance(client, app_instance_arn, input, options \\ [])

delete_app_instance_admin(client, app_instance_admin_arn, app_instance_arn, input, options \\ [])

delete_app_instance_streaming_configurations(client, app_instance_arn, input, options \\ [])

delete_app_instance_user(client, app_instance_user_arn, input, options \\ [])

delete_attendee(client, attendee_id, meeting_id, input, options \\ [])

delete_channel(client, channel_arn, input, options \\ [])

delete_channel_ban(client, channel_arn, member_arn, input, options \\ [])

delete_channel_membership(client, channel_arn, member_arn, input, options \\ [])

delete_channel_message(client, channel_arn, message_id, input, options \\ [])

delete_channel_moderator(client, channel_arn, channel_moderator_arn, input, options \\ [])

delete_events_configuration(client, account_id, bot_id, input, options \\ [])

delete_media_capture_pipeline(client, media_pipeline_id, input, options \\ [])

delete_meeting(client, meeting_id, input, options \\ [])

delete_phone_number(client, phone_number_id, input, options \\ [])

deletion-queue Deletion queue

delete_proxy_session(client, proxy_session_id, voice_connector_id, input, options \\ [])

delete_room(client, account_id, room_id, input, options \\ [])

delete_room_membership(client, account_id, member_id, room_id, input, options \\ [])

delete_sip_media_application(client, sip_media_application_id, input, options \\ [])

delete_sip_rule(client, sip_rule_id, input, options \\ [])

delete_voice_connector(client, voice_connector_id, input, options \\ [])

delete_voice_connector_emergency_calling_configuration(client, voice_connector_id, input, options \\ [])

delete_voice_connector_group(client, voice_connector_group_id, input, options \\ [])

delete_voice_connector_origination(client, voice_connector_id, input, options \\ [])

delete_voice_connector_proxy(client, voice_connector_id, input, options \\ [])

delete_voice_connector_streaming_configuration(client, voice_connector_id, input, options \\ [])

delete_voice_connector_termination(client, voice_connector_id, input, options \\ [])

delete_voice_connector_termination_credentials(client, voice_connector_id, input, options \\ [])

describe_app_instance(client, app_instance_arn, options \\ [])

describe_app_instance_admin(client, app_instance_admin_arn, app_instance_arn, options \\ [])

describe_app_instance_user(client, app_instance_user_arn, options \\ [])

describe_channel(client, channel_arn, chime_bearer \\ nil, options \\ [])

describe_channel_ban(client, channel_arn, member_arn, chime_bearer \\ nil, options \\ [])

describe_channel_membership(client, channel_arn, member_arn, chime_bearer \\ nil, options \\ [])

View Source AWS.Chime (aws-elixir v1.0.4)

definitions
Definitions

using-an-aws-sdk
Using an AWS SDK

using-the-aws-cli
Using the AWS CLI

using-rest-apis
Using REST APIs

this-api-is-is-not-available-in-a-dedicated-namespace
This API is is not available in a dedicated namespace.

deletion-queue
Deletion queue

functionality-restrictions
Functionality & restrictions