← Back to Skills Marketplace
mickmicksh

Lap Amazon Chime

by mickmicksh · GitHub ↗ · v1.0.0 · MIT-0
cross-platform ⚠ suspicious
49
Downloads
0
Stars
0
Active Installs
1
Versions
Install in OpenClaw
/install lap-amazon-chime
Description
Amazon Chime API skill. Use when working with Amazon Chime for accounts, voice-connectors, voice-connector-groups. Covers 191 endpoints.
README (SKILL.md)

Amazon Chime

API version: 2018-05-01

Auth

AWS SigV4

Base URL

Not specified.

Setup

  1. Configure auth: AWS SigV4
  2. GET /settings -- verify access
  3. POST /accounts/{accountId}/users/{userId}?operation=associate-phone-number -- create first users

Endpoints

191 endpoints across 25 groups. See references/api-spec.lap for full details.

accounts

Method Path Description
POST /accounts/{accountId}/users/{userId}?operation=associate-phone-number Associates a phone number with the specified Amazon Chime user.
POST /accounts/{accountId}?operation=associate-signin-delegate-groups Associates the specified sign-in delegate groups with the specified Amazon Chime account.
POST /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.
POST /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.
POST /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.
POST /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.
POST /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.
POST /accounts/{accountId}/bots Creates a bot for an Amazon Chime Enterprise account.
POST /accounts/{accountId}/rooms Creates a chat room for the specified Amazon Chime Enterprise account.
POST /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.
POST /accounts/{accountId}/users?operation=create Creates a user under the specified Amazon Chime account.
DELETE /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.
DELETE /accounts/{accountId}/bots/{botId}/events-configuration Deletes the events configuration that allows a bot to receive outgoing events.
DELETE /accounts/{accountId}/rooms/{roomId} Deletes a chat room in an Amazon Chime Enterprise account.
DELETE /accounts/{accountId}/rooms/{roomId}/memberships/{memberId} Removes a member from a chat room in an Amazon Chime Enterprise account.
POST /accounts/{accountId}/users/{userId}?operation=disassociate-phone-number Disassociates the primary provisioned phone number from the specified Amazon Chime user.
POST /accounts/{accountId}?operation=disassociate-signin-delegate-groups Disassociates the specified sign-in delegate groups from the specified Amazon Chime account.
GET /accounts/{accountId} Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.
GET /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.
GET /accounts/{accountId}/bots/{botId} Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.
GET /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.
GET /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.
GET /accounts/{accountId}/rooms/{roomId} Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.
GET /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.
GET /accounts/{accountId}/users/{userId}/settings Retrieves settings for the specified user ID, such as any associated phone number settings.
POST /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.
GET /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.
GET /accounts/{accountId}/bots Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.
GET /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.
GET /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.
GET /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.
POST /accounts/{accountId}/users/{userId}?operation=logout Logs out the specified user from all of the devices they are currently logged into.
PUT /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.
PUT /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.
POST /accounts/{accountId}/conversations/{conversationId}/messages/{messageId}?operation=redact Redacts the specified message from the specified Amazon Chime conversation.
POST /accounts/{accountId}/rooms/{roomId}/messages/{messageId}?operation=redact Redacts the specified message from the specified Amazon Chime channel.
POST /accounts/{accountId}/bots/{botId}?operation=regenerate-security-token Regenerates the security token for a bot.
POST /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.
POST /accounts/{accountId} Updates account details for the specified Amazon Chime account. Currently, only account name and default license updates are supported for this action.
PUT /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.
POST /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.
POST /accounts/{accountId}/rooms/{roomId} Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account.
POST /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.
POST /accounts/{accountId}/users/{userId} Updates user details for a specified user ID. Currently, only LicenseType updates are supported for this action.
PUT /accounts/{accountId}/users/{userId}/settings Updates the settings for the specified user, such as phone number settings.

voice-connectors

Method Path Description
POST /voice-connectors/{voiceConnectorId}?operation=associate-phone-numbers Associates phone numbers with the specified Amazon Chime Voice Connector. This API is is no longer supported and will not be updated. We recommend using the latest version, AssociatePhoneNumbersWithVoiceConnector, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
POST /voice-connectors/{voiceConnectorId}/proxy-sessions Creates a proxy session on the specified Amazon Chime Voice Connector for the specified participant phone numbers. This API is is no longer supported and will not be updated. We recommend using the latest version, CreateProxySession, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
POST /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. This API is is no longer supported and will not be updated. We recommend using the latest version, CreateVoiceConnector, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
DELETE /voice-connectors/{voiceConnectorId}/proxy-sessions/{proxySessionId} Deletes the specified proxy session from the specified Amazon Chime Voice Connector. This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteProxySession, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
DELETE /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. This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnector, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
DELETE /voice-connectors/{voiceConnectorId}/emergency-calling-configuration Deletes the emergency calling configuration details from the specified Amazon Chime Voice Connector. This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnectorEmergencyCallingConfiguration, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
DELETE /voice-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. This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnectorOrigination, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
DELETE /voice-connectors/{voiceConnectorId}/programmable-numbers/proxy Deletes the proxy configuration from the specified Amazon Chime Voice Connector. This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceProxy, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
DELETE /voice-connectors/{voiceConnectorId}/streaming-configuration Deletes the streaming configuration for the specified Amazon Chime Voice Connector. This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnectorStreamingConfiguration, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
DELETE /voice-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. This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnectorTermination, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
POST /voice-connectors/{voiceConnectorId}/termination/credentials?operation=delete Deletes the specified SIP credentials used by your equipment to authenticate during call termination. This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnectorTerminationCredentials, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
POST /voice-connectors/{voiceConnectorId}?operation=disassociate-phone-numbers Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector. This API is is no longer supported and will not be updated. We recommend using the latest version, DisassociatePhoneNumbersFromVoiceConnector, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
GET /voice-connectors/{voiceConnectorId}/proxy-sessions/{proxySessionId} Gets the specified proxy session details for the specified Amazon Chime Voice Connector. This API is is no longer supported and will not be updated. We recommend using the latest version, GetProxySession, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
GET /voice-connectors/{voiceConnectorId} Retrieves details for the specified Amazon Chime Voice Connector, such as timestamps,name, outbound host, and encryption requirements. This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnector, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
GET /voice-connectors/{voiceConnectorId}/emergency-calling-configuration Gets the emergency calling configuration details for the specified Amazon Chime Voice Connector. This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorEmergencyCallingConfiguration, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
GET /voice-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. This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorLoggingConfiguration, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
GET /voice-connectors/{voiceConnectorId}/origination Retrieves origination setting details for the specified Amazon Chime Voice Connector. This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorOrigination, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
GET /voice-connectors/{voiceConnectorId}/programmable-numbers/proxy Gets the proxy configuration details for the specified Amazon Chime Voice Connector. This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorProxy, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
GET /voice-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. This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorStreamingConfiguration, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
GET /voice-connectors/{voiceConnectorId}/termination Retrieves termination setting details for the specified Amazon Chime Voice Connector. This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorTermination, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
GET /voice-connectors/{voiceConnectorId}/termination/health This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorTerminationHealth, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. Retrieves information about the last time a SIP OPTIONS ping was received from your SIP infrastructure for the specified Amazon Chime Voice Connector.
GET /voice-connectors/{voiceConnectorId}/proxy-sessions Lists the proxy sessions for the specified Amazon Chime Voice Connector. This API is is no longer supported and will not be updated. We recommend using the latest version, ListProxySessions, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
GET /voice-connectors/{voiceConnectorId}/termination/credentials Lists the SIP credentials for the specified Amazon Chime Voice Connector. This API is is no longer supported and will not be updated. We recommend using the latest version, ListVoiceConnectorTerminationCredentials, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
GET /voice-connectors Lists the Amazon Chime Voice Connectors for the administrator's AWS account. This API is is no longer supported and will not be updated. We recommend using the latest version, ListVoiceConnectors, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
PUT /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. This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorEmergencyCallingConfiguration, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
PUT /voice-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. This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorLoggingConfiguration, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
PUT /voice-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. This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorOrigination, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
PUT /voice-connectors/{voiceConnectorId}/programmable-numbers/proxy Puts the specified proxy configuration to the specified Amazon Chime Voice Connector. This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorProxy, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
PUT /voice-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. This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorStreamingConfiguration, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
PUT /voice-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. This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorTermination, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
POST /voice-connectors/{voiceConnectorId}/termination/credentials?operation=put Adds termination SIP credentials for the specified Amazon Chime Voice Connector. This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorTerminationCredentials, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
POST /voice-connectors/{voiceConnectorId}/proxy-sessions/{proxySessionId} Updates the specified proxy session details, such as voice or SMS capabilities. This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateProxySession, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
PUT /voice-connectors/{voiceConnectorId} Updates details for the specified Amazon Chime Voice Connector. This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateVoiceConnector, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

voice-connector-groups

Method Path Description
POST /voice-connector-groups/{voiceConnectorGroupId}?operation=associate-phone-numbers Associates phone numbers with the specified Amazon Chime Voice Connector group. This API is is no longer supported and will not be updated. We recommend using the latest version, AssociatePhoneNumbersWithVoiceConnectorGroup, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
POST /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. This API is is no longer supported and will not be updated. We recommend using the latest version, CreateVoiceConnectorGroup, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
DELETE /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. This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnectorGroup, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
POST /voice-connector-groups/{voiceConnectorGroupId}?operation=disassociate-phone-numbers Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector group. This API is is no longer supported and will not be updated. We recommend using the latest version, DisassociatePhoneNumbersFromVoiceConnectorGroup, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
GET /voice-connector-groups/{voiceConnectorGroupId} Retrieves details for the specified Amazon Chime Voice Connector group, such as timestamps,name, and associated VoiceConnectorItems. This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorGroup, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
GET /voice-connector-groups Lists the Amazon Chime Voice Connector groups for the administrator's AWS account. This API is is no longer supported and will not be updated. We recommend using the latest version, ListVoiceConnectorGroups, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
PUT /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. This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateVoiceConnectorGroup, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

meetings

Method Path Description
POST /meetings/{meetingId}/attendees?operation=batch-create Creates up to 100 new attendees for an active Amazon Chime SDK meeting. This API is is no longer supported and will not be updated. We recommend using the latest version, BatchCreateAttendee, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.
POST /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. This API is is no longer supported and will not be updated. We recommend using the latest version, CreateAttendee, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
POST /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. This API is is no longer supported and will not be updated. We recommend using the latest version, CreateMeeting, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
POST /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. This API is is not available in a dedicated namespace.
DELETE /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. This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteAttendee, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
DELETE /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. This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteMeeting, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
GET /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. This API is is no longer supported and will not be updated. We recommend using the latest version, GetAttendee, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
GET /meetings/{meetingId} This API is is no longer supported and will not be updated. We recommend using the latest version, GetMeeting, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. Gets the Amazon Chime SDK meeting details for the specified meeting ID. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide .
GET /meetings/{meetingId}/attendees/{attendeeId}/tags Lists the tags applied to an Amazon Chime SDK attendee resource. ListAttendeeTags is not supported in the Amazon Chime SDK Meetings Namespace. Update your application to remove calls to this API.
GET /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. This API is is no longer supported and will not be updated. We recommend using the latest version, ListAttendees, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
GET /meetings/{meetingId}/tags Lists the tags applied to an Amazon Chime SDK meeting resource. This API is is no longer supported and will not be updated. We recommend using the latest version, ListTagsForResource, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
GET /meetings Lists up to 100 active Amazon Chime SDK meetings. ListMeetings is not supported in the Amazon Chime SDK Meetings Namespace. Update your application to remove calls to this API. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.
POST /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. This API is is no longer supported and will not be updated. We recommend using the latest version, StartMeetingTranscription, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
POST /meetings/{meetingId}/transcription?operation=stop Stops transcription for the specified meetingId. This API is is no longer supported and will not be updated. We recommend using the latest version, StopMeetingTranscription, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
POST /meetings/{meetingId}/attendees/{attendeeId}/tags?operation=add Applies the specified tags to the specified Amazon Chime attendee. TagAttendee is not supported in the Amazon Chime SDK Meetings Namespace. Update your application to remove calls to this API.
POST /meetings/{meetingId}/tags?operation=add Applies the specified tags to the specified Amazon Chime SDK meeting. This API is is no longer supported and will not be updated. We recommend using the latest version, TagResource, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
POST /meetings/{meetingId}/attendees/{attendeeId}/tags?operation=delete Untags the specified tags from the specified Amazon Chime SDK attendee. UntagAttendee is not supported in the Amazon Chime SDK Meetings Namespace. Update your application to remove calls to this API.
POST /meetings/{meetingId}/tags?operation=delete Untags the specified tags from the specified Amazon Chime SDK meeting. This API is is no longer supported and will not be updated. We recommend using the latest version, UntagResource, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

channels

Method Path Description
POST /channels/{channelArn}/memberships?operation=batch-create Adds a specified number of users to a channel. This API is is no longer supported and will not be updated. We recommend using the latest version, BatchCreateChannelMembership, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
POST /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. This API is is no longer supported and will not be updated. We recommend using the latest version, CreateChannel, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
POST /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. This API is is no longer supported and will not be updated. We recommend using the latest version, CreateChannelBan, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
POST /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. This API is is no longer supported and will not be updated. We recommend using the latest version, CreateChannelMembership, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
POST /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. This API is is no longer supported and will not be updated. We recommend using the latest version, CreateChannelModerator, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
DELETE /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. This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteChannel, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
DELETE /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. This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteChannelBan, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
DELETE /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. This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteChannelMembership, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
DELETE /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. This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteChannelMessage, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
DELETE /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. This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteChannelModerator, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
GET /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. This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannel, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
GET /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. This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannelBan, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
GET /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. This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannelMembership, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
GET /channels/{channelArn}?scope=app-instance-user-membership Returns the details of a channel based on the membership of the specified AppInstanceUser. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannelMembershipForAppInstanceUser, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
GET /channels/{channelArn}?scope=app-instance-user-moderated-channel Returns the full details of a channel moderated by the specified AppInstanceUser. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannelModeratedByAppInstanceUser, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
GET /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. This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannelModerator, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
GET /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. This API is is no longer supported and will not be updated. We recommend using the latest version, GetChannelMessage, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
GET /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. This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelBans, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
GET /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. This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelMemberships, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
GET /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. This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelMessages, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
GET /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. This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelModerators, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
GET /channels 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. This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannels, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
POST /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. This API is is no longer supported and will not be updated. We recommend using the latest version, RedactChannelMessage, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
POST /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. This API is is no longer supported and will not be updated. We recommend using the latest version, SendChannelMessage, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
PUT /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. This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateChannel, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
PUT /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. This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateChannelMessage, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
PUT /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. This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateChannelReadMarker, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

phone-numbers?operation=batch-delete

Method Path Description
POST /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

Method Path Description
POST /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-instances

Method Path Description
POST /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. This API is is no longer supported and will not be updated. We recommend using the latest version, CreateAppInstance, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
POST /app-instances/{appInstanceArn}/admins Promotes an AppInstanceUser to an AppInstanceAdmin. The promoted user can perform the following actions. This API is is no longer supported and will not be updated. We recommend using the latest version, CreateAppInstanceAdmin, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide. ChannelModerator actions across all channels in the AppInstance. DeleteChannelMessage actions. Only an AppInstanceUser can be promoted to an AppInstanceAdmin role.
DELETE /app-instances/{appInstanceArn} Deletes an AppInstance and all associated data asynchronously. This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteAppInstance, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
DELETE /app-instances/{appInstanceArn}/admins/{appInstanceAdminArn} Demotes an AppInstanceAdmin to an AppInstanceUser. This action does not delete the user. This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteAppInstanceAdmin, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
DELETE /app-instances/{appInstanceArn}/streaming-configurations Deletes the streaming configurations of an AppInstance. This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteAppInstanceStreamingConfigurations, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
GET /app-instances/{appInstanceArn} Returns the full details of an AppInstance. This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeAppInstance, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
GET /app-instances/{appInstanceArn}/admins/{appInstanceAdminArn} Returns the full details of an AppInstanceAdmin. This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeAppInstanceAdmin, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
GET /app-instances/{appInstanceArn}/retention-settings Gets the retention settings for an AppInstance. This API is is no longer supported and will not be updated. We recommend using the latest version, GetMessagingRetentionSettings, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
GET /app-instances/{appInstanceArn}/streaming-configurations Gets the streaming settings for an AppInstance. This API is is no longer supported and will not be updated. We recommend using the latest version, GetMessagingStreamingConfigurations, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
GET /app-instances/{appInstanceArn}/admins Returns a list of the administrators in the AppInstance. This API is is no longer supported and will not be updated. We recommend using the latest version, ListAppInstanceAdmins, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
GET /app-instances Lists all Amazon Chime AppInstances created under a single AWS account. This API is is no longer supported and will not be updated. We recommend using the latest version, ListAppInstances, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
PUT /app-instances/{appInstanceArn}/retention-settings Sets the amount of time in days that a given AppInstance retains data. This API is is no longer supported and will not be updated. We recommend using the latest version, PutAppInstanceRetentionSettings, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
PUT /app-instances/{appInstanceArn}/streaming-configurations The data streaming configurations of an AppInstance. This API is is no longer supported and will not be updated. We recommend using the latest version, PutMessagingStreamingConfigurations, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
PUT /app-instances/{appInstanceArn} Updates AppInstance metadata. This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateAppInstance, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

app-instance-users

Method Path Description
POST /app-instance-users Creates a user under an Amazon Chime AppInstance. The request consists of a unique appInstanceUserId and Name for that user. This API is is no longer supported and will not be updated. We recommend using the latest version, CreateAppInstanceUser, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
DELETE /app-instance-users/{appInstanceUserArn} Deletes an AppInstanceUser. This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteAppInstanceUser, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
GET /app-instance-users/{appInstanceUserArn} Returns the full details of an AppInstanceUser. This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeAppInstanceUser, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
GET /app-instance-users List all AppInstanceUsers created under a single AppInstance. This API is is no longer supported and will not be updated. We recommend using the latest version, ListAppInstanceUsers, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
PUT /app-instance-users/{appInstanceUserArn} Updates the details of an AppInstanceUser. You can update names and metadata. This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateAppInstanceUser, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

media-capture-pipelines

Method Path Description
POST /media-capture-pipelines Creates a media capture pipeline. This API is is no longer supported and will not be updated. We recommend using the latest version, CreateMediaCapturePipeline, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
DELETE /media-capture-pipelines/{mediaPipelineId} Deletes the media capture pipeline. This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteMediaCapturePipeline, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
GET /media-capture-pipelines/{mediaPipelineId} Gets an existing media capture pipeline. This API is is no longer supported and will not be updated. We recommend using the latest version, GetMediaCapturePipeline, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
GET /media-capture-pipelines Returns a list of media capture pipelines. This API is is no longer supported and will not be updated. We recommend using the latest version, ListMediaCapturePipelines, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

meetings?operation=create-attendees

Method Path Description
POST /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 . This API is is no longer supported and will not be updated. We recommend using the latest version, CreateMeetingWithAttendees, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

phone-number-orders

Method Path Description
POST /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.
GET /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.
GET /phone-number-orders Lists the phone number orders for the administrator's Amazon Chime account.

sip-media-applications

Method Path Description
POST /sip-media-applications Creates a SIP media application. This API is is no longer supported and will not be updated. We recommend using the latest version, CreateSipMediaApplication, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
POST /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. This API is is no longer supported and will not be updated. We recommend using the latest version, CreateSipMediaApplicationCall, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
DELETE /sip-media-applications/{sipMediaApplicationId} Deletes a SIP media application. This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteSipMediaApplication, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
GET /sip-media-applications/{sipMediaApplicationId} Retrieves the information for a SIP media application, including name, AWS Region, and endpoints. This API is is no longer supported and will not be updated. We recommend using the latest version, GetSipMediaApplication, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
GET /sip-media-applications/{sipMediaApplicationId}/logging-configuration Returns the logging configuration for the specified SIP media application. This API is is no longer supported and will not be updated. We recommend using the latest version, GetSipMediaApplicationLoggingConfiguration, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
GET /sip-media-applications Lists the SIP media applications under the administrator's AWS account. This API is is no longer supported and will not be updated. We recommend using the latest version, ListSipMediaApplications, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
PUT /sip-media-applications/{sipMediaApplicationId}/logging-configuration Updates the logging configuration for the specified SIP media application. This API is is no longer supported and will not be updated. We recommend using the latest version, PutSipMediaApplicationLoggingConfiguration, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
PUT /sip-media-applications/{sipMediaApplicationId} Updates the details of the specified SIP media application. This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateSipMediaApplication, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
POST /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. This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateSipMediaApplicationCall, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

sip-rules

Method Path Description
POST /sip-rules Creates a SIP rule which can be used to run a SIP media application as a target for a specific trigger type. This API is is no longer supported and will not be updated. We recommend using the latest version, CreateSipRule, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
DELETE /sip-rules/{sipRuleId} Deletes a SIP rule. You must disable a SIP rule before you can delete it. This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteSipRule, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
GET /sip-rules/{sipRuleId} Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints. This API is is no longer supported and will not be updated. We recommend using the latest version, GetSipRule, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
GET /sip-rules Lists the SIP rules under the administrator's AWS account. This API is is no longer supported and will not be updated. We recommend using the latest version, ListSipRules, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
PUT /sip-rules/{sipRuleId} Updates the details of the specified SIP rule. This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateSipRule, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

phone-numbers

Method Path Description
DELETE /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.
GET /phone-numbers/{phoneNumberId} Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.
GET /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.
POST /phone-numbers/{phoneNumberId}?operation=restore Moves a phone number from the Deletion queue back into the phone number Inventory.
POST /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.

settings

Method Path Description
GET /settings Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
GET /settings/phone-number Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.
PUT /settings Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
PUT /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

Method Path Description
GET /endpoints/messaging-session The details of the endpoint for the messaging session. This API is is no longer supported and will not be updated. We recommend using the latest version, GetMessagingSessionEndpoint, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

channels?scope=app-instance-user-memberships

Method Path Description
GET /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. This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelMembershipsForAppInstanceUser, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

channels?scope=app-instance-user-moderated-channels

Method Path Description
GET /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. This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelsModeratedByAppInstanceUser, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

phone-number-countries

Method Path Description
GET /phone-number-countries Lists supported phone number countries.

tags

Method Path Description
GET /tags Lists the tags applied to an Amazon Chime SDK meeting and messaging resources. This API is is no longer supported and will not be updated. We recommend using the applicable latest version in the Amazon Chime SDK. For meetings: ListTagsForResource. For messaging: ListTagsForResource. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

search?type=phone-numbers

Method Path Description
GET /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

Method Path Description
POST /tags?operation=tag-resource Applies the specified tags to the specified Amazon Chime SDK meeting resource. This API is is no longer supported and will not be updated. We recommend using the latest version, TagResource, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

tags?operation=untag-resource

Method Path Description
POST /tags?operation=untag-resource Untags the specified tags from the specified Amazon Chime SDK meeting resource. Applies the specified tags to the specified Amazon Chime SDK meeting resource. This API is is no longer supported and will not be updated. We recommend using the latest version, UntagResource, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

emergency-calling

Method Path Description
POST /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. This API is is no longer supported and will not be updated. We recommend using the latest version, ValidateE911Address, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:

  • "Create a attendees?operation=batch-create?" -> POST /meetings/{meetingId}/attendees?operation=batch-create
  • "Create a memberships?operation=batch-create?" -> POST /channels/{channelArn}/memberships?operation=batch-create
  • "Create a memberships?operation=batch-create?" -> POST /accounts/{accountId}/rooms/{roomId}/memberships?operation=batch-create
  • "Create a phone-numbers?operation=batch-delete?" -> POST /phone-numbers?operation=batch-delete
  • "Create a users?operation=suspend?" -> POST /accounts/{accountId}/users?operation=suspend
  • "Create a users?operation=unsuspend?" -> POST /accounts/{accountId}/users?operation=unsuspend
  • "Create a phone-numbers?operation=batch-update?" -> POST /phone-numbers?operation=batch-update
  • "Create a user?" -> POST /accounts/{accountId}/users
  • "Create a account?" -> POST /accounts
  • "Create a app-instance?" -> POST /app-instances
  • "Create a admin?" -> POST /app-instances/{appInstanceArn}/admins
  • "Create a app-instance-user?" -> POST /app-instance-users
  • "Create a attendee?" -> POST /meetings/{meetingId}/attendees
  • "Create a bot?" -> POST /accounts/{accountId}/bots
  • "Create a channel?" -> POST /channels
  • "Create a ban?" -> POST /channels/{channelArn}/bans
  • "Create a membership?" -> POST /channels/{channelArn}/memberships
  • "Create a moderator?" -> POST /channels/{channelArn}/moderators
  • "Create a media-capture-pipeline?" -> POST /media-capture-pipelines
  • "Create a meeting?" -> POST /meetings
  • "Create a dial-out?" -> POST /meetings/{meetingId}/dial-outs
  • "Create a meetings?operation=create-attendee?" -> POST /meetings?operation=create-attendees
  • "Create a phone-number-order?" -> POST /phone-number-orders
  • "Create a proxy-session?" -> POST /voice-connectors/{voiceConnectorId}/proxy-sessions
  • "Create a room?" -> POST /accounts/{accountId}/rooms
  • "Create a membership?" -> POST /accounts/{accountId}/rooms/{roomId}/memberships
  • "Create a sip-media-application?" -> POST /sip-media-applications
  • "Create a call?" -> POST /sip-media-applications/{sipMediaApplicationId}/calls
  • "Create a sip-rule?" -> POST /sip-rules
  • "Create a users?operation=create?" -> POST /accounts/{accountId}/users?operation=create
  • "Create a voice-connector?" -> POST /voice-connectors
  • "Create a voice-connector-group?" -> POST /voice-connector-groups
  • "Delete a account?" -> DELETE /accounts/{accountId}
  • "Delete a app-instance?" -> DELETE /app-instances/{appInstanceArn}
  • "Delete a admin?" -> DELETE /app-instances/{appInstanceArn}/admins/{appInstanceAdminArn}
  • "Delete a app-instance-user?" -> DELETE /app-instance-users/{appInstanceUserArn}
  • "Delete a attendee?" -> DELETE /meetings/{meetingId}/attendees/{attendeeId}
  • "Delete a channel?" -> DELETE /channels/{channelArn}
  • "Delete a ban?" -> DELETE /channels/{channelArn}/bans/{memberArn}
  • "Delete a membership?" -> DELETE /channels/{channelArn}/memberships/{memberArn}
  • "Delete a message?" -> DELETE /channels/{channelArn}/messages/{messageId}
  • "Delete a moderator?" -> DELETE /channels/{channelArn}/moderators/{channelModeratorArn}
  • "Delete a media-capture-pipeline?" -> DELETE /media-capture-pipelines/{mediaPipelineId}
  • "Delete a meeting?" -> DELETE /meetings/{meetingId}
  • "Delete a phone-number?" -> DELETE /phone-numbers/{phoneNumberId}
  • "Delete a proxy-session?" -> DELETE /voice-connectors/{voiceConnectorId}/proxy-sessions/{proxySessionId}
  • "Delete a room?" -> DELETE /accounts/{accountId}/rooms/{roomId}
  • "Delete a membership?" -> DELETE /accounts/{accountId}/rooms/{roomId}/memberships/{memberId}
  • "Delete a sip-media-application?" -> DELETE /sip-media-applications/{sipMediaApplicationId}
  • "Delete a sip-rule?" -> DELETE /sip-rules/{sipRuleId}
  • "Delete a voice-connector?" -> DELETE /voice-connectors/{voiceConnectorId}
  • "Delete a voice-connector-group?" -> DELETE /voice-connector-groups/{voiceConnectorGroupId}
  • "Create a credentials?operation=delete?" -> POST /voice-connectors/{voiceConnectorId}/termination/credentials?operation=delete
  • "Get app-instance details?" -> GET /app-instances/{appInstanceArn}
  • "Get admin details?" -> GET /app-instances/{appInstanceArn}/admins/{appInstanceAdminArn}
  • "Get app-instance-user details?" -> GET /app-instance-users/{appInstanceUserArn}
  • "Get channel details?" -> GET /channels/{channelArn}
  • "Get ban details?" -> GET /channels/{channelArn}/bans/{memberArn}
  • "Get membership details?" -> GET /channels/{channelArn}/memberships/{memberArn}
  • "Get channel details?" -> GET /channels/{channelArn}?scope=app-instance-user-membership
  • "Get channel details?" -> GET /channels/{channelArn}?scope=app-instance-user-moderated-channel
  • "Get moderator details?" -> GET /channels/{channelArn}/moderators/{channelModeratorArn}
  • "Get account details?" -> GET /accounts/{accountId}
  • "List all settings?" -> GET /accounts/{accountId}/settings
  • "List all retention-settings?" -> GET /app-instances/{appInstanceArn}/retention-settings
  • "List all streaming-configurations?" -> GET /app-instances/{appInstanceArn}/streaming-configurations
  • "Get attendee details?" -> GET /meetings/{meetingId}/attendees/{attendeeId}
  • "Get bot details?" -> GET /accounts/{accountId}/bots/{botId}
  • "Get message details?" -> GET /channels/{channelArn}/messages/{messageId}
  • "List all events-configuration?" -> GET /accounts/{accountId}/bots/{botId}/events-configuration
  • "List all settings?" -> GET /settings
  • "Get media-capture-pipeline details?" -> GET /media-capture-pipelines/{mediaPipelineId}
  • "Get meeting details?" -> GET /meetings/{meetingId}
  • "List all messaging-session?" -> GET /endpoints/messaging-session
  • "Get phone-number details?" -> GET /phone-numbers/{phoneNumberId}
  • "Get phone-number-order details?" -> GET /phone-number-orders/{phoneNumberOrderId}
  • "List all phone-number?" -> GET /settings/phone-number
  • "Get proxy-session details?" -> GET /voice-connectors/{voiceConnectorId}/proxy-sessions/{proxySessionId}
  • "List all retention-settings?" -> GET /accounts/{accountId}/retention-settings
  • "Get room details?" -> GET /accounts/{accountId}/rooms/{roomId}
  • "Get sip-media-application details?" -> GET /sip-media-applications/{sipMediaApplicationId}
  • "List all logging-configuration?" -> GET /sip-media-applications/{sipMediaApplicationId}/logging-configuration
  • "Get sip-rule details?" -> GET /sip-rules/{sipRuleId}
  • "Get user details?" -> GET /accounts/{accountId}/users/{userId}
  • "List all settings?" -> GET /accounts/{accountId}/users/{userId}/settings
  • "Get voice-connector details?" -> GET /voice-connectors/{voiceConnectorId}
  • "List all emergency-calling-configuration?" -> GET /voice-connectors/{voiceConnectorId}/emergency-calling-configuration
  • "Get voice-connector-group details?" -> GET /voice-connector-groups/{voiceConnectorGroupId}
  • "List all logging-configuration?" -> GET /voice-connectors/{voiceConnectorId}/logging-configuration
  • "List all origination?" -> GET /voice-connectors/{voiceConnectorId}/origination
  • "List all proxy?" -> GET /voice-connectors/{voiceConnectorId}/programmable-numbers/proxy
  • "List all streaming-configuration?" -> GET /voice-connectors/{voiceConnectorId}/streaming-configuration
  • "List all termination?" -> GET /voice-connectors/{voiceConnectorId}/termination
  • "List all health?" -> GET /voice-connectors/{voiceConnectorId}/termination/health
  • "Create a users?operation=add?" -> POST /accounts/{accountId}/users?operation=add
  • "List all accounts?" -> GET /accounts
  • "List all admins?" -> GET /app-instances/{appInstanceArn}/admins
  • "List all app-instance-users?" -> GET /app-instance-users
  • "List all app-instances?" -> GET /app-instances
  • "List all tags?" -> GET /meetings/{meetingId}/attendees/{attendeeId}/tags
  • "List all attendees?" -> GET /meetings/{meetingId}/attendees
  • "List all bots?" -> GET /accounts/{accountId}/bots
  • "List all bans?" -> GET /channels/{channelArn}/bans
  • "List all memberships?" -> GET /channels/{channelArn}/memberships
  • "List all channels?scope=app-instance-user-memberships?" -> GET /channels?scope=app-instance-user-memberships
  • "List all messages?" -> GET /channels/{channelArn}/messages
  • "List all moderators?" -> GET /channels/{channelArn}/moderators
  • "List all channels?" -> GET /channels
  • "List all channels?scope=app-instance-user-moderated-channels?" -> GET /channels?scope=app-instance-user-moderated-channels
  • "List all media-capture-pipelines?" -> GET /media-capture-pipelines
  • "List all tags?" -> GET /meetings/{meetingId}/tags
  • "List all meetings?" -> GET /meetings
  • "List all phone-number-orders?" -> GET /phone-number-orders
  • "List all phone-numbers?" -> GET /phone-numbers
  • "List all proxy-sessions?" -> GET /voice-connectors/{voiceConnectorId}/proxy-sessions
  • "List all memberships?" -> GET /accounts/{accountId}/rooms/{roomId}/memberships
  • "List all rooms?" -> GET /accounts/{accountId}/rooms
  • "List all sip-media-applications?" -> GET /sip-media-applications
  • "List all sip-rules?" -> GET /sip-rules
  • "List all phone-number-countries?" -> GET /phone-number-countries
  • "List all tags?" -> GET /tags
  • "List all users?" -> GET /accounts/{accountId}/users
  • "List all voice-connector-groups?" -> GET /voice-connector-groups
  • "List all credentials?" -> GET /voice-connectors/{voiceConnectorId}/termination/credentials
  • "List all voice-connectors?" -> GET /voice-connectors
  • "Create a credentials?operation=put?" -> POST /voice-connectors/{voiceConnectorId}/termination/credentials?operation=put
  • "List all search?type=phone-numbers?" -> GET /search?type=phone-numbers
  • "Create a message?" -> POST /channels/{channelArn}/messages
  • "Create a transcription?operation=start?" -> POST /meetings/{meetingId}/transcription?operation=start
  • "Create a transcription?operation=stop?" -> POST /meetings/{meetingId}/transcription?operation=stop
  • "Create a tags?operation=add?" -> POST /meetings/{meetingId}/attendees/{attendeeId}/tags?operation=add
  • "Create a tags?operation=add?" -> POST /meetings/{meetingId}/tags?operation=add
  • "Create a tags?operation=tag-resource?" -> POST /tags?operation=tag-resource
  • "Create a tags?operation=delete?" -> POST /meetings/{meetingId}/attendees/{attendeeId}/tags?operation=delete
  • "Create a tags?operation=delete?" -> POST /meetings/{meetingId}/tags?operation=delete
  • "Create a tags?operation=untag-resource?" -> POST /tags?operation=untag-resource
  • "Update a app-instance?" -> PUT /app-instances/{appInstanceArn}
  • "Update a app-instance-user?" -> PUT /app-instance-users/{appInstanceUserArn}
  • "Update a channel?" -> PUT /channels/{channelArn}
  • "Update a message?" -> PUT /channels/{channelArn}/messages/{messageId}
  • "Update a sip-media-application?" -> PUT /sip-media-applications/{sipMediaApplicationId}
  • "Update a sip-rule?" -> PUT /sip-rules/{sipRuleId}
  • "Update a voice-connector?" -> PUT /voice-connectors/{voiceConnectorId}
  • "Update a voice-connector-group?" -> PUT /voice-connector-groups/{voiceConnectorGroupId}
  • "Create a address?" -> POST /emergency-calling/address
  • "How to authenticate?" -> See Auth section

Response Tips

  • Check response schemas in references/api-spec.lap for field details
  • Create/update endpoints typically return the created/updated object

CLI

# Update this spec to the latest version
npx @lap-platform/lapsh get amazon-chime -o references/api-spec.lap

# Search for related APIs
npx @lap-platform/lapsh search amazon-chime

References

  • Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

Generated from the official API spec by LAP

Usage Guidance
Install only if you intend to let an agent work with Amazon Chime administration APIs. Use a least-privileged AWS/IAM credential, require explicit confirmation before any suspend, delete, create, phone-number, or delegate-group change, and avoid testing first with production administrator credentials.
Capability Analysis
Type: OpenClaw Skill Name: lap-amazon-chime Version: 1.0.0 The skill bundle is a comprehensive API wrapper for Amazon Chime, containing metadata and instructions (SKILL.md) for an AI agent to interact with 191 standard AWS Chime endpoints. It includes a mapping of natural language queries to specific API paths and methods, and requires standard AWS authentication (SigV4). No evidence of malicious intent, data exfiltration, or prompt injection was found; the content is consistent with a generated API documentation tool (lapsh).
Capability Tags
requires-sensitive-credentials
Capability Assessment
Purpose & Capability
The skill coherently describes an Amazon Chime administration API reference, but the provided endpoint list includes high-impact account and user mutations, not just read-only Chime help.
Instruction Scope
The visible instructions list broad POST/DELETE/bulk administrative operations and a setup POST without visible confirmation, dry-run, or approval guidance for destructive changes.
Install Mechanism
There is no install spec or executable code and the static scan is clean, but the SKILL.md references a detailed API spec file that is not present in the one-file manifest.
Credentials
AWS SigV4 / AMAZON_CHIME_API_KEY is expected for an Amazon Chime API skill, but it is a sensitive credential and the artifacts do not define a narrow IAM scope.
Persistence & Privilege
No persistence or background behavior is shown; privilege risk depends on the supplied AWS/Chime credential, which could allow account-level changes.
How to Use
  1. Make sure OpenClaw is installed (local or Docker)
  2. Run the install command in chat: /install lap-amazon-chime
  3. After installation, invoke the skill by name or use /lap-amazon-chime
  4. Provide required inputs per the skill's parameter spec and get structured output
Version History
v1.0.0
Initial release with Amazon Chime API integration. - Provides access to 191 Amazon Chime API endpoints across 25 groups. - Supports AWS SigV4 authentication. - Allows management of accounts, users, voice connectors, rooms, and bots. - Requires an AMAZON_CHIME_API_KEY environment variable. - Includes setup and usage instructions in the documentation.
Metadata
Slug lap-amazon-chime
Version 1.0.0
License MIT-0
All-time Installs 0
Active Installs 0
Total Versions 1
Frequently Asked Questions

What is Lap Amazon Chime?

Amazon Chime API skill. Use when working with Amazon Chime for accounts, voice-connectors, voice-connector-groups. Covers 191 endpoints. It is an AI Agent Skill for Claude Code / OpenClaw, with 49 downloads so far.

How do I install Lap Amazon Chime?

Run "/install lap-amazon-chime" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.

Is Lap Amazon Chime free?

Yes, Lap Amazon Chime is completely free, licensed under MIT-0. You can download, install and use it at no cost.

Which platforms does Lap Amazon Chime support?

Lap Amazon Chime is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).

Who created Lap Amazon Chime?

It is built and maintained by mickmicksh (@mickmicksh); the current version is v1.0.0.

💬 Comments