View Source AWS.Chime (aws-elixir v0.13.3)
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
Associates a phone number with the specified Amazon Chime user.
Associates phone numbers with the specified Amazon Chime Voice Connector.
Associates phone numbers with the specified Amazon Chime Voice Connector group.
Associates the specified sign-in delegate groups with the specified Amazon Chime account.
Creates up to 100 new attendees for an active Amazon Chime SDK meeting.
Adds a specified number of users to a channel.
Adds up to 50 members to a chat room in an Amazon Chime Enterprise account.
Moves phone numbers into the Deletion queue.
Suspends up to 50 users from a Team
or EnterpriseLWA
Amazon Chime account.
Removes the suspension from up to 50 previously suspended users for the
specified Amazon Chime EnterpriseLWA
account.
Updates phone number product types or calling names.
Updates user details within the UpdateUserRequestItem
object for up to 20
users for the specified Amazon Chime account.
Creates an Amazon Chime account under the administrator's AWS account.
Creates an Amazon Chime SDK messaging AppInstance
under an AWS account.
Promotes an AppInstanceUser
to an AppInstanceAdmin
.
Creates a user under an Amazon Chime AppInstance
.
Creates a new attendee for an active Amazon Chime SDK meeting.
Creates a bot for an Amazon Chime Enterprise account.
Creates a channel to which you can add users and send messages.
Permanently bans a member from a channel.
Adds a user to a channel.
Creates a new ChannelModerator
.
Creates a media capture pipeline.
Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees.
Uses the join token and call metadata in a meeting request (From number, To number, and so forth) to initiate an outbound call to a public switched telephone network (PSTN) and join them into a Chime meeting.
Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees.
Creates an order for phone numbers to be provisioned.
Creates a proxy session on the specified Amazon Chime Voice Connector for the specified participant phone numbers.
Creates a chat room for the specified Amazon Chime Enterprise account.
Adds a member to a chat room in an Amazon Chime Enterprise account.
Creates a SIP media application.
Creates an outbound call to a phone number from the phone number specified in
the request, and it invokes the endpoint of the specified
sipMediaApplicationId
.
Creates a SIP rule which can be used to run a SIP media application as a target for a specific trigger type.
Creates a user under the specified Amazon Chime account.
Creates an Amazon Chime Voice Connector under the administrator's AWS account.
Creates an Amazon Chime Voice Connector group under the administrator's AWS account.
Deletes the specified Amazon Chime account.
Deletes an AppInstance
and all associated data asynchronously.
Demotes an AppInstanceAdmin
to an AppInstanceUser
.
Deletes the streaming configurations of an AppInstance
.
Deletes an AppInstanceUser
.
Deletes an attendee from the specified Amazon Chime SDK meeting and deletes
their JoinToken
.
Immediately makes a channel and its memberships inaccessible and marks them for deletion.
Removes a user from a channel's ban list.
Removes a member from a channel.
Deletes a channel message.
Deletes a channel moderator.
Deletes the events configuration that allows a bot to receive outgoing events.
Deletes the media capture pipeline.
Deletes the specified Amazon Chime SDK meeting.
Moves the specified phone number into the Deletion queue.
Deletes the specified proxy session from the specified Amazon Chime Voice Connector.
Deletes a chat room in an Amazon Chime Enterprise account.
Removes a member from a chat room in an Amazon Chime Enterprise account.
Deletes a SIP media application.
Deletes a SIP rule.
Deletes the specified Amazon Chime Voice Connector.
Deletes the emergency calling configuration details from the specified Amazon Chime Voice Connector.
Deletes the specified Amazon Chime Voice Connector group.
Deletes the origination settings for the specified Amazon Chime Voice Connector.
Deletes the proxy configuration from the specified Amazon Chime Voice Connector.
Deletes the streaming configuration for the specified Amazon Chime Voice Connector.
Deletes the termination settings for the specified Amazon Chime Voice Connector.
Deletes the specified SIP credentials used by your equipment to authenticate during call termination.
Returns the full details of an AppInstance
.
Returns the full details of an AppInstanceAdmin
.
Returns the full details of an AppInstanceUser
.
Returns the full details of a channel in an Amazon Chime AppInstance
.
Returns the full details of a channel ban.
Returns the full details of a user's channel membership.
Returns the details of a channel based on the membership of the specified
AppInstanceUser
.
Returns the full details of a channel moderated by the specified
AppInstanceUser
.
Returns the full details of a single ChannelModerator.
Disassociates the primary provisioned phone number from the specified Amazon Chime user.
Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector.
Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector group.
Disassociates the specified sign-in delegate groups from the specified Amazon Chime account.
Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.
Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dialout settings.
Gets the retention settings for an AppInstance
.
Gets the streaming settings for an AppInstance
.
Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID.
Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.
Gets the full details of a channel message.
Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.
Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
Gets an existing media capture pipeline.
Gets the Amazon Chime SDK meeting details for the specified meeting ID.
The details of the endpoint for the messaging session.
Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.
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.
Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.
Gets the specified proxy session details for the specified Amazon Chime Voice Connector.
Gets the retention settings for the specified Amazon Chime Enterprise account.
Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.
Retrieves the information for a SIP media application, including name, AWS Region, and endpoints.
Returns the logging configuration for the specified SIP media application.
Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.
Retrieves details for the specified user ID, such as primary email address, license type,and personal meeting PIN.
Retrieves settings for the specified user ID, such as any associated phone number settings.
Retrieves details for the specified Amazon Chime Voice Connector, such as timestamps,name, outbound host, and encryption requirements.
Gets the emergency calling configuration details for the specified Amazon Chime Voice Connector.
Retrieves details for the specified Amazon Chime Voice Connector group, such as
timestamps,name, and associated VoiceConnectorItems
.
Retrieves the logging configuration details for the specified Amazon Chime Voice Connector.
Retrieves origination setting details for the specified Amazon Chime Voice Connector.
Gets the proxy configuration details for the specified Amazon Chime Voice Connector.
Retrieves the streaming configuration details for the specified Amazon Chime Voice Connector.
Retrieves termination setting details for the specified Amazon Chime Voice Connector.
Retrieves information about the last time a SIP OPTIONS
ping was received from
your SIP infrastructure for the specified Amazon Chime Voice Connector.
Sends email to a maximum of 50 users, inviting them to the specified Amazon
Chime Team
account.
Lists the Amazon Chime accounts under the administrator's AWS account.
Returns a list of the administrators in the AppInstance
.
List all AppInstanceUsers
created under a single AppInstance
.
Lists all Amazon Chime AppInstance
s created under a single AWS account.
Lists the tags applied to an Amazon Chime SDK attendee resource.
Lists the attendees for the specified Amazon Chime SDK meeting.
Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.
Lists all the users banned from a particular channel.
Lists all channel memberships in a channel.
Lists all channels that a particular AppInstanceUser
is a part of.
List all the messages in a channel.
Lists all the moderators for a channel.
Lists all Channels created under a single Chime App as a paginated list.
A list of the channels moderated by an AppInstanceUser
.
Returns a list of media capture pipelines.
Lists the tags applied to an Amazon Chime SDK meeting resource.
Lists up to 100 active Amazon Chime SDK meetings.
Lists the phone number orders for the administrator's Amazon Chime account.
Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.
Lists the proxy sessions for the specified Amazon Chime Voice Connector.
Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members' IDs, email addresses, and names.
Lists the room details for the specified Amazon Chime Enterprise account.
Lists the SIP media applications under the administrator's AWS account.
Lists the SIP rules under the administrator's AWS account.
Lists supported phone number countries.
Lists the tags applied to an Amazon Chime SDK meeting resource.
Lists the users that belong to the specified Amazon Chime account.
Lists the Amazon Chime Voice Connector groups for the administrator's AWS account.
Lists the SIP credentials for the specified Amazon Chime Voice Connector.
Lists the Amazon Chime Voice Connectors for the administrator's AWS account.
Logs out the specified user from all of the devices they are currently logged into.
Sets the amount of time in days that a given AppInstance
retains data.
The data streaming configurations of an AppInstance
.
Creates an events configuration that allows a bot to receive outgoing events sent by Amazon Chime.
Puts retention settings for the specified Amazon Chime Enterprise account.
Updates the logging configuration for the specified SIP media application.
Puts emergency calling configuration details to the specified Amazon Chime Voice Connector, such as emergency phone numbers and calling countries.
Adds a logging configuration for the specified Amazon Chime Voice Connector.
Adds origination settings for the specified Amazon Chime Voice Connector.
Puts the specified proxy configuration to the specified Amazon Chime Voice Connector.
Adds a streaming configuration for the specified Amazon Chime Voice Connector.
Adds termination settings for the specified Amazon Chime Voice Connector.
Adds termination SIP credentials for the specified Amazon Chime Voice Connector.
Redacts message content, but not metadata.
Redacts the specified message from the specified Amazon Chime conversation.
Redacts the specified message from the specified Amazon Chime channel.
Regenerates the security token for a bot.
Resets the personal meeting PIN for the specified user on an Amazon Chime account.
Moves a phone number from the Deletion queue back into the phone number Inventory.
Searches for phone numbers that can be ordered.
Sends a message to a particular channel that the member is a part of.
Starts transcription for the specified meetingId
.
Stops transcription for the specified meetingId
.
Applies the specified tags to the specified Amazon Chime SDK attendee.
Applies the specified tags to the specified Amazon Chime SDK meeting.
Applies the specified tags to the specified Amazon Chime SDK meeting resource.
Untags the specified tags from the specified Amazon Chime SDK attendee.
Untags the specified tags from the specified Amazon Chime SDK meeting.
Untags the specified tags from the specified Amazon Chime SDK meeting resource.
Updates account details for the specified Amazon Chime account.
Updates the settings for the specified Amazon Chime account.
Updates AppInstance
metadata.
Updates the details of an AppInstanceUser
.
Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.
Update a channel's attributes.
Updates the content of a message.
The details of the time when a user last read messages in a channel.
Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
Updates phone number details, such as product type or calling name, for the specified phone number ID.
Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name.
Updates the specified proxy session details, such as voice or SMS capabilities.
Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account.
Updates room membership details, such as the member role, for a room in an Amazon Chime Enterprise account.
Updates the details of the specified SIP media application.
Invokes the AWS Lambda function associated with the SIP media application and transaction ID in an update request.
Updates the details of the specified SIP rule.
Updates user details for a specified user ID.
Updates the settings for the specified user, such as phone number settings.
Updates details for the specified Amazon Chime Voice Connector.
Updates details of the specified Amazon Chime Voice Connector group, such as the name and Amazon Chime Voice Connector priority ranking.
Validates an address to be used for 911 calls made with Amazon Chime Voice Connectors.
Link to this section Functions
associate_phone_number_with_user(client, account_id, user_id, input, options \\ [])
View SourceAssociates a phone number with the specified Amazon Chime user.
associate_phone_numbers_with_voice_connector(client, voice_connector_id, input, options \\ [])
View SourceAssociates phone numbers with the specified Amazon Chime Voice Connector.
associate_phone_numbers_with_voice_connector_group(client, voice_connector_group_id, input, options \\ [])
View SourceAssociates phone numbers with the specified Amazon Chime Voice Connector group.
associate_signin_delegate_groups_with_account(client, account_id, input, options \\ [])
View SourceAssociates the specified sign-in delegate groups with the specified Amazon Chime account.
Creates up to 100 new attendees for an active Amazon Chime SDK meeting.
For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.
batch_create_channel_membership(client, channel_arn, input, options \\ [])
View SourceAdds a specified number of users to a channel.
batch_create_room_membership(client, account_id, room_id, input, options \\ [])
View SourceAdds up to 50 members to a chat room in an Amazon Chime Enterprise account.
Members can be users or bots. The member role designates whether the member is a chat room administrator or a general chat room member.
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.
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.
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.
Updates phone number product types or calling names.
You can update one attribute at a time for each UpdatePhoneNumberRequestItem
.
For example, you can update the product type or the calling name.
For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type.
Updates to outbound calling names can take up to 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.
Updates user details within the UpdateUserRequestItem
object for up to 20
users for the specified Amazon Chime account.
Currently, only LicenseType
updates are supported for this action.
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.
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.
create_app_instance_admin(client, app_instance_arn, input, options \\ [])
View SourcePromotes an AppInstanceUser
to an AppInstanceAdmin
.
The promoted user can perform the following actions.
ChannelModerator
actions across all channels in theAppInstance
.DeleteChannelMessage
actions.
Only an AppInstanceUser
can be promoted to an AppInstanceAdmin
role.
Creates a user under an Amazon Chime AppInstance
.
The request consists of a unique appInstanceUserId
and Name
for that user.
Creates a new attendee for an active Amazon Chime SDK meeting.
For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.
Creates a bot for an Amazon Chime Enterprise account.
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.
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.
create_channel_membership(client, channel_arn, input, options \\ [])
View SourceAdds 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.
create_channel_moderator(client, channel_arn, input, options \\ [])
View SourceCreates 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.
Creates a media capture pipeline.
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 .
Uses the join token and call metadata in a meeting request (From number, To number, and so forth) to initiate an outbound call to a public switched telephone network (PSTN) and join them into a Chime meeting.
Also ensures that the From number belongs to the customer.
To play welcome audio or implement an interactive voice response (IVR), use the
CreateSipMediaApplicationCall
action with the corresponding SIP media
application ID.
Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees.
For more information about specifying media Regions, see Amazon Chime SDK Media Regions 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 .
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 \\ [])
View SourceCreates a proxy session on the specified Amazon Chime Voice Connector for the specified participant phone numbers.
Creates a chat room for the specified Amazon Chime Enterprise account.
create_room_membership(client, account_id, room_id, input, options \\ [])
View SourceAdds 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.
Creates a SIP media application.
create_sip_media_application_call(client, sip_media_application_id, input, options \\ [])
View SourceCreates an outbound call to a phone number from the phone number specified in
the request, and it invokes the endpoint of the specified
sipMediaApplicationId
.
Creates a SIP rule which can be used to run a SIP media application as a target for a specific trigger type.
Creates a user under the specified Amazon Chime account.
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.
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.
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 \\ [])
View SourceDeletes an AppInstance
and all associated data asynchronously.
delete_app_instance_admin(client, app_instance_admin_arn, app_instance_arn, input, options \\ [])
View SourceDemotes an AppInstanceAdmin
to an AppInstanceUser
.
This action does not delete the user.
delete_app_instance_streaming_configurations(client, app_instance_arn, input, options \\ [])
View SourceDeletes the streaming configurations of an AppInstance
.
delete_app_instance_user(client, app_instance_user_arn, input, options \\ [])
View SourceDeletes an AppInstanceUser
.
delete_attendee(client, attendee_id, meeting_id, input, options \\ [])
View SourceDeletes an attendee from the specified Amazon Chime SDK meeting and deletes
their JoinToken
.
Attendees are automatically deleted when a Amazon Chime SDK meeting is deleted. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.
Immediately makes a channel and its memberships inaccessible and marks them for deletion.
This is an irreversible process.
The x-amz-chime-bearer
request header is mandatory. Use the
AppInstanceUserArn
of the user that makes the API call as the value in the
header.
delete_channel_ban(client, channel_arn, member_arn, input, options \\ [])
View SourceRemoves 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.
delete_channel_membership(client, channel_arn, member_arn, input, options \\ [])
View SourceRemoves a member from a channel.
The x-amz-chime-bearer
request header is mandatory. Use the
AppInstanceUserArn
of the user that makes the API call as the value in the
header.
delete_channel_message(client, channel_arn, message_id, input, options \\ [])
View SourceDeletes a channel message.
Only admins can perform this action. Deletion makes messages inaccessible
immediately. A background process deletes any revisions created by
UpdateChannelMessage
.
The x-amz-chime-bearer
request header is mandatory. Use the
AppInstanceUserArn
of the user that makes the API call as the value in the
header.
delete_channel_moderator(client, channel_arn, channel_moderator_arn, input, options \\ [])
View SourceDeletes a channel moderator.
The x-amz-chime-bearer
request header is mandatory. Use the
AppInstanceUserArn
of the user that makes the API call as the value in the
header.
delete_events_configuration(client, account_id, bot_id, input, options \\ [])
View SourceDeletes the events configuration that allows a bot to receive outgoing events.
delete_media_capture_pipeline(client, media_pipeline_id, input, options \\ [])
View SourceDeletes the media capture pipeline.
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.
delete_phone_number(client, phone_number_id, input, options \\ [])
View SourceMoves the specified phone number into the Deletion queue.
A phone number must be disassociated from any users or Amazon Chime Voice Connectors before it can be deleted.
Deleted phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.
delete_proxy_session(client, proxy_session_id, voice_connector_id, input, options \\ [])
View SourceDeletes the specified proxy session from the specified Amazon Chime Voice Connector.
Deletes a chat room in an Amazon Chime Enterprise account.
delete_room_membership(client, account_id, member_id, room_id, input, options \\ [])
View SourceRemoves a member from a chat room in an Amazon Chime Enterprise account.
delete_sip_media_application(client, sip_media_application_id, input, options \\ [])
View SourceDeletes a SIP media application.
Deletes a SIP rule.
You must disable a SIP rule before you can delete it.
delete_voice_connector(client, voice_connector_id, input, options \\ [])
View SourceDeletes the specified Amazon Chime Voice Connector.
Any phone numbers associated with the Amazon Chime Voice Connector must be disassociated from it before it can be deleted.
delete_voice_connector_emergency_calling_configuration(client, voice_connector_id, input, options \\ [])
View SourceDeletes the emergency calling configuration details from the specified Amazon Chime Voice Connector.
delete_voice_connector_group(client, voice_connector_group_id, input, options \\ [])
View SourceDeletes the specified Amazon Chime Voice Connector group.
Any VoiceConnectorItems
and phone numbers associated with the group must be
removed before it can be deleted.
delete_voice_connector_origination(client, voice_connector_id, input, options \\ [])
View SourceDeletes the origination settings for the specified Amazon Chime Voice Connector.
If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to deleting the origination settings.
delete_voice_connector_proxy(client, voice_connector_id, input, options \\ [])
View SourceDeletes the proxy configuration from the specified Amazon Chime Voice Connector.
delete_voice_connector_streaming_configuration(client, voice_connector_id, input, options \\ [])
View SourceDeletes the streaming configuration for the specified Amazon Chime Voice Connector.
delete_voice_connector_termination(client, voice_connector_id, input, options \\ [])
View SourceDeletes the termination settings for the specified Amazon Chime Voice Connector.
If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to deleting the termination settings.
delete_voice_connector_termination_credentials(client, voice_connector_id, input, options \\ [])
View SourceDeletes the specified SIP credentials used by your equipment to authenticate during call termination.
Returns the full details of an AppInstance
.
describe_app_instance_admin(client, app_instance_admin_arn, app_instance_arn, options \\ [])
View SourceReturns the full details of an AppInstanceAdmin
.
describe_app_instance_user(client, app_instance_user_arn, options \\ [])
View SourceReturns the full details of an AppInstanceUser
.
describe_channel(client, channel_arn, chime_bearer \\ nil, options \\ [])
View SourceReturns the full details of a channel in an Amazon Chime AppInstance
.
The x-amz-chime-bearer
request header is mandatory. Use the
AppInstanceUserArn
of the user that makes the API call as the value in the
header.
describe_channel_ban(client, channel_arn, member_arn, chime_bearer \\ nil, options \\ [])
View SourceReturns the full details of a channel ban.
The x-amz-chime-bearer
request header is mandatory. Use the
AppInstanceUserArn
of the user that makes the API call as the value in the
header.
describe_channel_membership(client, channel_arn, member_arn, chime_bearer \\ nil, options \\ [])
View SourceReturns the full details of a user's channel membership.
The x-amz-chime-bearer
request header is mandatory. Use the
AppInstanceUserArn
of the user that makes the API call as the value in the
header.
describe_channel_membership_for_app_instance_user(client, channel_arn, app_instance_user_arn, chime_bearer \\ nil, options \\ [])
View SourceReturns the details of a channel based on the membership of the specified
AppInstanceUser
.
The x-amz-chime-bearer
request header is mandatory. Use the
AppInstanceUserArn
of the user that makes the API call as the value in the
header.
describe_channel_moderated_by_app_instance_user(client, channel_arn, app_instance_user_arn, chime_bearer \\ nil, options \\ [])
View SourceReturns the full details of a channel moderated by the specified
AppInstanceUser
.
The x-amz-chime-bearer
request header is mandatory. Use the
AppInstanceUserArn
of the user that makes the API call as the value in the
header.
describe_channel_moderator(client, channel_arn, channel_moderator_arn, chime_bearer \\ nil, options \\ [])
View SourceReturns the full details of a single ChannelModerator.
The x-amz-chime-bearer
request header is mandatory. Use the
AppInstanceUserArn
of the user that makes the API call as the value in the
header.
disassociate_phone_number_from_user(client, account_id, user_id, input, options \\ [])
View SourceDisassociates the primary provisioned phone number from the specified Amazon Chime user.
disassociate_phone_numbers_from_voice_connector(client, voice_connector_id, input, options \\ [])
View SourceDisassociates 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 \\ [])
View SourceDisassociates the specified phone numbers from the specified Amazon Chime Voice Connector group.
disassociate_signin_delegate_groups_from_account(client, account_id, input, options \\ [])
View SourceDisassociates the specified sign-in delegate groups from the specified Amazon Chime account.
Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.
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 \\ [])
View SourceGets the retention settings for an AppInstance
.
get_app_instance_streaming_configurations(client, app_instance_arn, options \\ [])
View SourceGets the streaming settings for an AppInstance
.
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 .
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 \\ [])
View SourceGets the full details of a channel message.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn
of the user that makes the API call as the value in the header.
get_events_configuration(client, account_id, bot_id, options \\ [])
View SourceGets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.
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 \\ [])
View SourceGets an existing media capture pipeline.
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 .
The details of the endpoint for the messaging session.
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 \\ [])
View SourceRetrieves details for the specified phone number order, such as the order creation timestamp, phone numbers in E.164 format, product type, and order status.
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 \\ [])
View SourceGets the specified proxy session details for the specified Amazon Chime Voice Connector.
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.
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 \\ [])
View SourceRetrieves 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 \\ [])
View SourceReturns the logging configuration for the specified SIP media application.
Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.
Retrieves details for the specified user ID, such as primary email address, license type,and personal meeting PIN.
To retrieve user details with an email address instead of a user ID, use the
ListUsers
action, and then filter by email address.
Retrieves settings for the specified user ID, such as any associated phone number settings.
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 \\ [])
View SourceGets the emergency calling configuration details for the specified Amazon Chime Voice Connector.
get_voice_connector_group(client, voice_connector_group_id, options \\ [])
View SourceRetrieves 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 \\ [])
View SourceRetrieves the logging configuration details for the specified Amazon Chime Voice Connector.
Shows whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.
get_voice_connector_origination(client, voice_connector_id, options \\ [])
View SourceRetrieves origination setting details for the specified Amazon Chime Voice Connector.
get_voice_connector_proxy(client, voice_connector_id, options \\ [])
View SourceGets the proxy configuration details for the specified Amazon Chime Voice Connector.
get_voice_connector_streaming_configuration(client, voice_connector_id, options \\ [])
View SourceRetrieves the streaming configuration details for the specified Amazon Chime Voice Connector.
Shows whether media streaming is enabled for sending to Amazon Kinesis. It also shows the retention period, in hours, for the Amazon Kinesis data.
get_voice_connector_termination(client, voice_connector_id, options \\ [])
View SourceRetrieves termination setting details for the specified Amazon Chime Voice Connector.
get_voice_connector_termination_health(client, voice_connector_id, options \\ [])
View SourceRetrieves information about the last time a SIP OPTIONS
ping was received from
your SIP infrastructure for the specified Amazon Chime Voice Connector.
Sends email to a maximum of 50 users, inviting them to the specified Amazon
Chime Team
account.
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 \\ [])
View SourceLists 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 \\ [])
View SourceReturns a list of the administrators in the AppInstance
.
list_app_instance_users(client, app_instance_arn, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceList all AppInstanceUsers
created under a single AppInstance
.
list_app_instances(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists all Amazon Chime AppInstance
s created under a single AWS account.
list_attendee_tags(client, attendee_id, meeting_id, options \\ [])
View SourceLists the tags applied to an Amazon Chime SDK attendee resource.
list_attendees(client, meeting_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists the attendees for the specified Amazon Chime SDK meeting.
For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.
list_bots(client, account_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists 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 \\ [])
View SourceLists 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.
list_channel_memberships(client, channel_arn, max_results \\ nil, next_token \\ nil, type \\ nil, chime_bearer \\ nil, options \\ [])
View SourceLists all channel memberships in a channel.
The x-amz-chime-bearer
request header is mandatory. Use the
AppInstanceUserArn
of the user that makes the API call as the value in the
header.
list_channel_memberships_for_app_instance_user(client, app_instance_user_arn \\ nil, max_results \\ nil, next_token \\ nil, chime_bearer \\ nil, options \\ [])
View SourceLists all channels that a particular AppInstanceUser
is a part of.
Only an AppInstanceAdmin
can call the API with a user ARN that is not their
own.
The x-amz-chime-bearer
request header is mandatory. Use the
AppInstanceUserArn
of the user that makes the API call as the value in the
header.
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 \\ [])
View SourceList all the messages in a channel.
Returns a paginated list of ChannelMessages
. By default, sorted by creation
timestamp in descending order.
Redacted messages appear in the results as empty, since they are only redacted, not deleted. Deleted messages do not appear in the results. This action always returns the latest version of an edited message.
Also, the x-amz-chime-bearer request header is mandatory. Use the
AppInstanceUserArn
of the user that makes the API call as the value in the
header.
list_channel_moderators(client, channel_arn, max_results \\ nil, next_token \\ nil, chime_bearer \\ nil, options \\ [])
View SourceLists all the moderators for a channel.
The x-amz-chime-bearer
request header is mandatory. Use the
AppInstanceUserArn
of the user that makes the API call as the value in the
header.
list_channels(client, app_instance_arn, max_results \\ nil, next_token \\ nil, privacy \\ nil, chime_bearer \\ nil, options \\ [])
View SourceLists all Channels created under a single Chime App as a paginated list.
You can specify filters to narrow results.
functionality-restrictions
Functionality & restrictions
Use privacy =
PUBLIC
to retrieve all public channels in the account.Only an
AppInstanceAdmin
can set privacy =PRIVATE
to list the private channels in an account.
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.
list_channels_moderated_by_app_instance_user(client, app_instance_user_arn \\ nil, max_results \\ nil, next_token \\ nil, chime_bearer \\ nil, options \\ [])
View SourceA list of the channels moderated by an AppInstanceUser
.
The x-amz-chime-bearer
request header is mandatory. Use the
AppInstanceUserArn
of the user that makes the API call as the value in the
header.
list_media_capture_pipelines(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceReturns a list of media capture pipelines.
Lists the tags applied to an Amazon Chime SDK meeting resource.
list_meetings(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists up to 100 active Amazon Chime SDK meetings.
For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.
list_phone_number_orders(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists 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 \\ [])
View SourceLists 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 \\ [])
View SourceLists 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 \\ [])
View SourceLists 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 \\ [])
View SourceLists the room details for the specified Amazon Chime Enterprise account.
Optionally, filter the results by a member ID (user ID or bot ID) to see a list of rooms that the member belongs to.
list_sip_media_applications(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists 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 \\ [])
View SourceLists the SIP rules under the administrator's AWS account.
list_supported_phone_number_countries(client, product_type, options \\ [])
View SourceLists supported phone number countries.
Lists the tags applied to an Amazon Chime SDK meeting resource.
list_users(client, account_id, max_results \\ nil, next_token \\ nil, user_email \\ nil, user_type \\ nil, options \\ [])
View SourceLists the users that belong to the specified Amazon Chime account.
You can specify an email address to list only the user that the email address belongs to.
list_voice_connector_groups(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists the Amazon Chime Voice Connector groups for the administrator's AWS account.
list_voice_connector_termination_credentials(client, voice_connector_id, options \\ [])
View SourceLists the SIP credentials for the specified Amazon Chime Voice Connector.
list_voice_connectors(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists the Amazon Chime Voice Connectors for the administrator's AWS account.
Logs out the specified user from all of the devices they are currently logged into.
put_app_instance_retention_settings(client, app_instance_arn, input, options \\ [])
View SourceSets the amount of time in days that a given AppInstance
retains data.
put_app_instance_streaming_configurations(client, app_instance_arn, input, options \\ [])
View SourceThe data streaming configurations of an AppInstance
.
put_events_configuration(client, account_id, bot_id, input, options \\ [])
View SourceCreates an events configuration that allows a bot to receive outgoing events sent by Amazon Chime.
Choose either an HTTPS endpoint or a Lambda function ARN. For more information,
see Bot
.
Puts retention settings for the specified Amazon Chime Enterprise account.
We recommend using AWS CloudTrail to monitor usage of this API for your account. For more information, see Logging Amazon Chime API Calls with AWS CloudTrail in the Amazon Chime Administration Guide.
To turn off existing retention settings, remove the number of days from the corresponding RetentionDays field in the RetentionSettings object. For more information about retention settings, see Managing Chat Retention Policies in the Amazon Chime Administration Guide.
put_sip_media_application_logging_configuration(client, sip_media_application_id, input, options \\ [])
View SourceUpdates the logging configuration for the specified SIP media application.
put_voice_connector_emergency_calling_configuration(client, voice_connector_id, input, options \\ [])
View SourcePuts emergency calling configuration details to the specified Amazon Chime Voice Connector, such as emergency phone numbers and calling countries.
Origination and termination settings must be enabled for the Amazon Chime Voice Connector before emergency calling can be configured.
put_voice_connector_logging_configuration(client, voice_connector_id, input, options \\ [])
View SourceAdds a logging configuration for the specified Amazon Chime Voice Connector.
The logging configuration specifies whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.
put_voice_connector_origination(client, voice_connector_id, input, options \\ [])
View SourceAdds origination settings for the specified Amazon Chime Voice Connector.
If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to turning off origination settings.
put_voice_connector_proxy(client, voice_connector_id, input, options \\ [])
View SourcePuts the specified proxy configuration to the specified Amazon Chime Voice Connector.
put_voice_connector_streaming_configuration(client, voice_connector_id, input, options \\ [])
View SourceAdds a streaming configuration for the specified Amazon Chime Voice Connector.
The streaming configuration specifies whether media streaming is enabled for sending to Kinesis. It also sets the retention period, in hours, for the Amazon Kinesis data.
put_voice_connector_termination(client, voice_connector_id, input, options \\ [])
View SourceAdds termination settings for the specified Amazon Chime Voice Connector.
If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to turning off termination settings.
put_voice_connector_termination_credentials(client, voice_connector_id, input, options \\ [])
View SourceAdds termination SIP credentials for the specified Amazon Chime Voice Connector.
redact_channel_message(client, channel_arn, message_id, input, options \\ [])
View SourceRedacts message content, but not metadata.
The message exists in the back end, but the action returns null content, and the state shows as redacted.
The x-amz-chime-bearer
request header is mandatory. Use the
AppInstanceUserArn
of the user that makes the API call as the value in the
header.
redact_conversation_message(client, account_id, conversation_id, message_id, input, options \\ [])
View SourceRedacts the specified message from the specified Amazon Chime conversation.
redact_room_message(client, account_id, message_id, room_id, input, options \\ [])
View SourceRedacts the specified message from the specified Amazon Chime channel.
regenerate_security_token(client, account_id, bot_id, input, options \\ [])
View SourceRegenerates the security token for a bot.
reset_personal_pin(client, account_id, user_id, input, options \\ [])
View SourceResets 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 \\ [])
View SourceMoves 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 \\ [])
View SourceSearches 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.
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.
start_meeting_transcription(client, meeting_id, input, options \\ [])
View SourceStarts 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.
stop_meeting_transcription(client, meeting_id, input, options \\ [])
View SourceStops transcription for the specified meetingId
.
tag_attendee(client, attendee_id, meeting_id, input, options \\ [])
View SourceApplies the specified tags to the specified Amazon Chime SDK attendee.
Applies the specified tags to the specified Amazon Chime SDK meeting.
Applies the specified tags to the specified Amazon Chime SDK meeting resource.
untag_attendee(client, attendee_id, meeting_id, input, options \\ [])
View SourceUntags the specified tags from the specified Amazon Chime SDK attendee.
Untags the specified tags from the specified Amazon Chime SDK meeting.
Untags the specified tags from the specified Amazon Chime SDK meeting resource.
Updates account details for the specified Amazon Chime account.
Currently, only account name and default license updates are supported for this action.
Updates the settings for the specified Amazon Chime account.
You can update settings for remote control of shared screens, or for the dial-out option. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.
update_app_instance(client, app_instance_arn, input, options \\ [])
View SourceUpdates AppInstance
metadata.
update_app_instance_user(client, app_instance_user_arn, input, options \\ [])
View SourceUpdates the details of an AppInstanceUser
.
You can update names and metadata.
Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.
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.
update_channel_message(client, channel_arn, message_id, input, options \\ [])
View SourceUpdates 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.
update_channel_read_marker(client, channel_arn, input, options \\ [])
View SourceThe details of the time when a user last read messages in a channel.
The x-amz-chime-bearer
request header is mandatory. Use the
AppInstanceUserArn
of the user that makes the API call as the value in the
header.
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 \\ [])
View SourceUpdates phone number details, such as product type or calling name, for the specified phone number ID.
You can update one phone number detail at a time. For example, you can update either the product type or the calling name in one action.
For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type.
Updates to outbound calling names can take 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.
Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name.
You can update the default outbound calling name once every seven days. Outbound calling names can take up to 72 hours to update.
update_proxy_session(client, proxy_session_id, voice_connector_id, input, options \\ [])
View SourceUpdates the specified proxy session details, such as voice or SMS capabilities.
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 \\ [])
View SourceUpdates room membership details, such as the member role, for a room in an Amazon Chime Enterprise account.
The member role designates whether the member is a chat room administrator or a general chat room member. The member role can be updated only for user IDs.
update_sip_media_application(client, sip_media_application_id, input, options \\ [])
View SourceUpdates the details of the specified SIP media application.
update_sip_media_application_call(client, sip_media_application_id, transaction_id, input, options \\ [])
View SourceInvokes the AWS Lambda function associated with the SIP media application and transaction ID in an update request.
The Lambda function can then return a new set of actions.
Updates the details of the specified SIP rule.
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 \\ [])
View SourceUpdates the settings for the specified user, such as phone number settings.
update_voice_connector(client, voice_connector_id, input, options \\ [])
View SourceUpdates details for the specified Amazon Chime Voice Connector.
update_voice_connector_group(client, voice_connector_group_id, input, options \\ [])
View SourceUpdates details of the specified Amazon Chime Voice Connector group, such as the name and Amazon Chime Voice Connector priority ranking.
Validates an address to be used for 911 calls made with Amazon Chime Voice Connectors.
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.