/app-instances/{appInstanceArn}

Deletes an AppInstance and all associated data asynchronously.

/app-instances/{appInstanceArn}

Updates AppInstance metadata.

/app-instances

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.

/app-instances

Lists all Amazon Chime AppInstance s created under a single AWS account.

/app-instances/{appInstanceArn}/admins

Promotes an AppInstanceUser to an AppInstanceAdmin . The promoted user can perform the following actions. ChannelModerator actions across all channels in the AppInstance . DeleteChannelMessage actions. Only an AppInstanceUser can be promoted to an AppInstanceAdmin role.

/app-instances/{appInstanceArn}/admins

Returns a list of the administrators in the AppInstance .

/app-instances/{appInstanceArn}/admins/{appInstanceAdminArn}

Demotes an AppInstanceAdmin to an AppInstanceUser . This action does not delete the user.

/app-instances/{appInstanceArn}/admins/{appInstanceAdminArn}

Returns the full details of an AppInstanceAdmin .

/app-instances/{appInstanceArn}/streaming-configurations

Deletes the streaming configurations of an AppInstance .

/app-instances/{appInstanceArn}/streaming-configurations

Gets the streaming settings for an AppInstance .

/app-instances/{appInstanceArn}/streaming-configurations

The data streaming configurations of an AppInstance .

/app-instances/{appInstanceArn}/retention-settings

Gets the retention settings for an AppInstance .

/app-instances/{appInstanceArn}/retention-settings

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

/accounts/{accountId}/users/{userId}#operation=associate-phone-number

Associates a phone number with the specified Amazon Chime user.

/accounts/{accountId}#operation=associate-signin-delegate-groups

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

/accounts/{accountId}/rooms/{roomId}/memberships#operation=batch-create

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.

/accounts/{accountId}/users#operation=suspend

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.

/accounts/{accountId}/users#operation=unsuspend

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.

/accounts/{accountId}/users

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.

/accounts/{accountId}/users

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.

/accounts

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 .

/accounts

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.

/accounts/{accountId}/bots

Creates a bot for an Amazon Chime Enterprise account.

/accounts/{accountId}/bots

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

/accounts/{accountId}/rooms/{roomId}/memberships

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.

/accounts/{accountId}/rooms

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

/accounts/{accountId}/rooms

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.

/accounts/{accountId}

Updates account details for the specified Amazon Chime account. Currently, only account name and default license updates are supported for this action.

/accounts/{accountId}/rooms/{roomId}/memberships

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

/accounts/{accountId}/users#operation=create

Creates a user under the specified Amazon Chime account.

/accounts/{accountId}

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.

/accounts/{accountId}

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

/accounts/{accountId}/bots/{botId}/events-configuration

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

/accounts/{accountId}/bots/{botId}/events-configuration

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

/accounts/{accountId}/bots/{botId}/events-configuration

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 .

/accounts/{accountId}/rooms/{roomId}

Deletes a chat room in an Amazon Chime Enterprise account.

/accounts/{accountId}/rooms/{roomId}

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

/accounts/{accountId}/rooms/{roomId}

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

/accounts/{accountId}/rooms/{roomId}/memberships/{memberId}

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

/accounts/{accountId}/rooms/{roomId}/memberships/{memberId}

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.

/accounts/{accountId}/users/{userId}#operation=disassociate-phone-number

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

/accounts/{accountId}#operation=disassociate-signin-delegate-groups

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

/accounts/{accountId}/settings

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 .

/accounts/{accountId}/settings

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 .

/accounts/{accountId}/bots/{botId}

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

/accounts/{accountId}/bots/{botId}

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

/accounts/{accountId}/retention-settings

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 .

/accounts/{accountId}/retention-settings

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 .

/accounts/{accountId}/users/{userId}

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.

/accounts/{accountId}/users/{userId}

Updates user details for a specified user ID. Currently, only LicenseType updates are supported for this action.

/accounts/{accountId}/users/{userId}/settings

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

/accounts/{accountId}/users/{userId}/settings

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

/accounts/{accountId}/users#operation=add

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.

/accounts/{accountId}/users/{userId}#operation=logout

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

/accounts/{accountId}/conversations/{conversationId}/messages/{messageId}#operation=redact

Redacts the specified message from the specified Amazon Chime conversation.

/accounts/{accountId}/rooms/{roomId}/messages/{messageId}#operation=redact

Redacts the specified message from the specified Amazon Chime channel.

/accounts/{accountId}/bots/{botId}#operation=regenerate-security-token

Regenerates the security token for a bot.

/accounts/{accountId}/users/{userId}#operation=reset-personal-pin

Resets the personal meeting PIN for the specified user on an Amazon Chime account. Returns the User object with the updated personal meeting PIN.

/voice-connectors/{voiceConnectorId}#operation=associate-phone-numbers

Associates phone numbers with the specified Amazon Chime Voice Connector.

/voice-connectors/{voiceConnectorId}/proxy-sessions

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

/voice-connectors/{voiceConnectorId}/proxy-sessions

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

/voice-connectors

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.

/voice-connectors

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

/voice-connectors/{voiceConnectorId}/proxy-sessions/{proxySessionId}

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

/voice-connectors/{voiceConnectorId}/proxy-sessions/{proxySessionId}

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

/voice-connectors/{voiceConnectorId}/proxy-sessions/{proxySessionId}

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

/voice-connectors/{voiceConnectorId}

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.

/voice-connectors/{voiceConnectorId}

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

/voice-connectors/{voiceConnectorId}

Updates details for the specified Amazon Chime Voice Connector.

/voice-connectors/{voiceConnectorId}/emergency-calling-configuration

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

/voice-connectors/{voiceConnectorId}/emergency-calling-configuration

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

/voice-connectors/{voiceConnectorId}/emergency-calling-configuration

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.

/voice-connectors/{voiceConnectorId}/origination

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.

/voice-connectors/{voiceConnectorId}/origination

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

/voice-connectors/{voiceConnectorId}/origination

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.

/voice-connectors/{voiceConnectorId}/programmable-numbers/proxy

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

/voice-connectors/{voiceConnectorId}/programmable-numbers/proxy

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

/voice-connectors/{voiceConnectorId}/programmable-numbers/proxy

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

/voice-connectors/{voiceConnectorId}/streaming-configuration

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

/voice-connectors/{voiceConnectorId}/streaming-configuration

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.

/voice-connectors/{voiceConnectorId}/streaming-configuration

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.

/voice-connectors/{voiceConnectorId}/termination

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.

/voice-connectors/{voiceConnectorId}/termination

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

/voice-connectors/{voiceConnectorId}/termination

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.

/voice-connectors/{voiceConnectorId}/termination/credentials#operation=delete

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

/voice-connectors/{voiceConnectorId}#operation=disassociate-phone-numbers

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

/voice-connectors/{voiceConnectorId}/logging-configuration

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.

/voice-connectors/{voiceConnectorId}/logging-configuration

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.

/voice-connectors/{voiceConnectorId}/termination/health

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

/voice-connectors/{voiceConnectorId}/termination/credentials

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

/voice-connectors/{voiceConnectorId}/termination/credentials#operation=put

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

/voice-connector-groups/{voiceConnectorGroupId}#operation=associate-phone-numbers

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

/voice-connector-groups

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.

/voice-connector-groups

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

/voice-connector-groups/{voiceConnectorGroupId}

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.

/voice-connector-groups/{voiceConnectorGroupId}

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

/voice-connector-groups/{voiceConnectorGroupId}

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

/voice-connector-groups/{voiceConnectorGroupId}#operation=disassociate-phone-numbers

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

/meetings/{meetingId}/attendees#operation=batch-create

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 .

/meetings/{meetingId}/attendees

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 .

/meetings/{meetingId}/attendees

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 .

/meetings

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 .

/meetings

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

/meetings/{meetingId}/dial-outs

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.

/meetings/{meetingId}/attendees/{attendeeId}

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 .

/meetings/{meetingId}/attendees/{attendeeId}

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 .

/meetings/{meetingId}

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 .

/meetings/{meetingId}

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 .

/meetings/{meetingId}/attendees/{attendeeId}/tags

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

/meetings/{meetingId}/tags

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

/meetings/{meetingId}/transcription#operation=start

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.

/meetings/{meetingId}/transcription#operation=stop

Stops transcription for the specified meetingId .

/meetings/{meetingId}/attendees/{attendeeId}/tags#operation=add

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

/meetings/{meetingId}/tags#operation=add

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

/meetings/{meetingId}/attendees/{attendeeId}/tags#operation=delete

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

/meetings/{meetingId}/tags#operation=delete

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

/channels/{channelArn}/memberships#operation=batch-create

Adds a specified number of users to a channel.

/channels

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.

/channels/{channelArn}/bans

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.

/channels/{channelArn}/bans

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.

/channels/{channelArn}/memberships

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.

/channels/{channelArn}/memberships

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.

/channels/{channelArn}/moderators

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.

/channels/{channelArn}/moderators

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.

/channels/{channelArn}

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.

/channels/{channelArn}

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.

/channels/{channelArn}

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.

/channels/{channelArn}/bans/{memberArn}

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.

/channels/{channelArn}/bans/{memberArn}

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.

/channels/{channelArn}/memberships/{memberArn}

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.

/channels/{channelArn}/memberships/{memberArn}

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.

/channels/{channelArn}/messages/{messageId}

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.

/channels/{channelArn}/messages/{messageId}

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.

/channels/{channelArn}/messages/{messageId}

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.

/channels/{channelArn}/moderators/{channelModeratorArn}

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.

/channels/{channelArn}/moderators/{channelModeratorArn}

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.

/channels/{channelArn}#scope=app-instance-user-membership&app-instance-user-arn

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.

/channels/{channelArn}#scope=app-instance-user-moderated-channel&app-instance-user-arn

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.

/channels/{channelArn}/messages

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.

/channels/{channelArn}/messages

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.

/channels/{channelArn}/messages/{messageId}#operation=redact

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.

/channels/{channelArn}/readMarker

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.

/phone-numbers#operation=batch-delete

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.

/phone-numbers#operation=batch-update

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.

/app-instance-users

Creates a user under an Amazon Chime AppInstance . The request consists of a unique appInstanceUserId and Name for that user.

/app-instance-users/{appInstanceUserArn}

Deletes an AppInstanceUser .

/app-instance-users/{appInstanceUserArn}

Returns the full details of an AppInstanceUser .

/app-instance-users/{appInstanceUserArn}

Updates the details of an AppInstanceUser . You can update names and metadata.

/media-capture-pipelines/{mediaPipelineId}

Deletes the media capture pipeline.

/media-capture-pipelines

Creates a media capture pipeline.

/media-capture-pipelines

Returns a list of media capture pipelines.

/media-capture-pipelines/{mediaPipelineId}

Gets an existing media capture pipeline.

/meetings#operation=create-attendees

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 .

/phone-number-orders

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.

/phone-number-orders

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

/phone-number-orders/{phoneNumberOrderId}

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.

/sip-media-applications

Creates a SIP media application.

/sip-media-applications

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

/sip-media-applications/{sipMediaApplicationId}/calls

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 .

/sip-media-applications/{sipMediaApplicationId}

Deletes a SIP media application.

/sip-media-applications/{sipMediaApplicationId}

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

/sip-media-applications/{sipMediaApplicationId}

Updates the details of the specified SIP media application.

/sip-media-applications/{sipMediaApplicationId}/logging-configuration

Returns the logging configuration for the specified SIP media application.

/sip-media-applications/{sipMediaApplicationId}/logging-configuration

Updates the logging configuration for the specified SIP media application.

/sip-media-applications/{sipMediaApplicationId}/calls/{transactionId}

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.

/sip-rules

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

/sip-rules

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

/sip-rules/{sipRuleId}

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

/sip-rules/{sipRuleId}

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

/sip-rules/{sipRuleId}

Updates the details of the specified SIP rule.

/phone-numbers/{phoneNumberId}

Moves the specified phone number into the Deletion queue . A phone number must be disassociated from any users or Amazon Chime Voice Connectors before it can be deleted. Deleted phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.

/phone-numbers/{phoneNumberId}

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

/phone-numbers/{phoneNumberId}

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.

/phone-numbers

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

/phone-numbers/{phoneNumberId}#operation=restore

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

/settings

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

/settings

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

/settings/phone-number

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

/settings/phone-number

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.

/endpoints/messaging-session

The details of the endpoint for the messaging session.

/app-instance-users#app-instance-arn

List all AppInstanceUsers created under a single AppInstance .

/channels#scope=app-instance-user-memberships

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.

/channels#app-instance-arn

Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results. Functionality & restrictions Use privacy = PUBLIC to retrieve all public channels in the account. Only an AppInstanceAdmin can set privacy = PRIVATE to list the private channels in an account. 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.

/channels#scope=app-instance-user-moderated-channels

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.

/phone-number-countries#product-type

Lists supported phone number countries.

/tags#arn

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

/search#type=phone-numbers

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.

/tags#operation=tag-resource

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

/tags#operation=untag-resource

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

/emergency-calling/address

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.