Migrating to the Amazon Chime SDK Meetings namespace
The Amazon Chime SDK Meetings namespace is a dedicated place for the APIs that create and manage Amazon Chime SDK meeting resources. You use the namespace to address Amazon Chime SDK meeting API endpoints in any AWS Region in which they're available. Use this namespace if you're just starting to use the Amazon Chime SDK. For more information about Regions, refer to Available Regions in this guide.
Existing applications that use the Amazon Chime namespace should plan to migrate to the dedicated namespace in order to use the latest APIs and features.
Reasons to migrate
We encourage you to migrate to the Amazon Chime SDK Meetings namespace for these reasons:
- Choice of API Endpoint
The Amazon Chime SDK Meetings namespace is the only API namespace which can use API endpoints in any region that makes them available. If you want to use API endpoints other than
us-east-1, you must use the Amazon Chime SDK Meetings namespace.For more information about how Amazon Chime SDK meetings use AWS Regions, refer to Meeting Regions in this guide.
- Updated and new meeting APIs
We only add or update meeting APIs in the Amazon Chime SDK Meetings namespace.
Before you migrate
Before you migrate, be aware of the differences between the namespaces. The following table lists and describes them.
| Amazon Chime SDK Meetings namespace | Amazon Chime namespace | |
|---|---|---|
| AWS SDK namespace | ChimeSDKMeetings | Chime |
| Regions | Multiple | us-east-1 only |
| Endpoints | https://meetings-chime.region.amazonaws.com | https://service.chime.aws.amazon.com |
| Service principal | meetings.chime.amazonaws.com | chime.amazonaws.com |
| APIs | Only APIs for meetings | APIs for meetings and other parts of Amazon Chime |
| CreateMeeting | ExternalMeetingId and MediaRegion are required. |
ExternalMeetingId and MediaRegion are optional. |
| CreateMeetingWithAttendees | ExternalMeetingId and MediaRegion are required. |
ExternalMeetingId and MediaRegion are optional. |
| ListMeetings | Not available | Available |
| ExternalMeetingId | Validation includes pattern matching | Available |
| ExternalUserId | Validation includes pattern matching | Available |
| Meeting Tags APIs | TagResource, UntagResource, ListTagsForResource | TagMeeting, UntagMeeting, ListMeetingTags |
| Attendee Tags | Not available | Available |
| Echo reduction | Available | Not available |
| Live transcription language identification | Available | Not available |
| Attendee capabilities | Available | Not available |
| Media replication | Available | Not available |
| AppKeys and TenantIds | Available | Not available |
| Media pipelines | Media pipelines support multiple regions in the Amazon Chime SDK Meetings namespace. For more information, see Migrating to the ChimeSdkMediaPipelines namespace. | Available via the us-east-1 endpoint |
| SIP media application | JoinChimeMeeting action requires MeetingId |
JoinChimeMeeting action does not require MeetingId |
|
Direct SIP integration |
Not available | Available |
Differences between the namespaces
The following sections explain the differences between the Amazon Chime and Amazon Chime SDK Meetings namespaces.
The Amazon Chime SDK namespace uses the Chime formal name. The Amazon Chime SDK Meetings namespace uses the ChimeSDKMeetings formal name. The precise
format of the name varies by platform.
For example, if you use the AWS SDK in Node.js to create meetings, you use a line of code to address the namespace.
const chimeMeetings = AWS.Chime();
To migrate to the Amazon Chime Meetings SDK, update this line of code with the new namespace and the endpoint region.
const chimeMeetings = AWS.ChimeSDKMeetings({ region: "eu-central-1" });
The Amazon Chime namespace can only address API endpoints in the us-east-1 Region. The Amazon Chime SDK Meetings namespace can address Amazon Chime SDK meeting API endpoints in any Region they are available. For a current list of meeting Regions, refer to Available Regions in this guide.
The Amazon Chime SDK Meetings namespace uses different API endpoints than the Amazon Chime namespace.
Only the endpoint used to create a meeting can be used to modify it. This means a meeting
created via an endpoint in EU-CENTRAL-1 can only be modified via EU-CENTRAL-1. It also means you
cannot address a meeting created via the Chime namespace with the
ChimeSDKMeetings namespace in US-EAST-1. For more information about
the current endpoints, refer to API mapping in
this guide.
The Amazon Chime SDK Meetings namespace uses a new service principal: meetings.chime.amazonaws.com. If you have SQS, SNS, or other IAM access policies that grant access
to the service, you need to update those polices to grant access to the new service principal.
The Amazon Chime SDK Meetings namespace only contains APIs for creating and managing meetings. The Amazon Chime namespace includes APIs for meetings and other parts of the Amazon Chime service.
In the Amazon Chime SDK Meetings namespace, the
CreateMeeting and
CreateMeetingWithAttendees
APIs require the ExternalMeetingId and MediaRegion fields to be specified.
The Amazon Chime SDK Meetings namespace enforces addition validation on the values that can be used for ExternalMeetingId and ExternalUserId.
Amazon Chime SDK Meetings namespace offers machine learning-based echo reduction to help remove noise and sound from the local loudspeaker from circulating back into the meeting. Refer to the guide on GitHub for more information.
Amazon Chime SDK Meetings namespace provides granular control over an attendees capabilities within a meeting to send and receive audio, video and content.
Amazon Chime SDK Meetings namespace offers media replication to link a primary meeting to replica meetings to bring together up to 10,000 people for a real-time session. Participants connected to a replica session receive the media of the presenters connected to the primary session, but they can be promoted to the primary meeting. For more information, refer to Using media replication in this guide.
Amazon Chime SDK Meetings namespace provides a way to limit access from a network to specific Amazon Chime SDK meetings. For more information, refer to Using AppKeys and TenantIDs in this guide.
Amazon Chime SDK media pipelines work with meetings created by any meetings endpoint, with either the Amazon Chime SDK Meetings or the Amazon Chime namespace. Refer to Available regions for the latest list of media pipeline regions.
Amazon Chime SDK SIP media applications work with meetings created by any meetings
endpoint, with either the Amazon Chime SDK Meetings or the Amazon Chime namespace. When using SIP media applications with a meeting created through the Amazon Chime
SDK Meetings namespace, the JoinChimeMeeting action requires the MeetingId parameter.
The Meetings namespace has a growing list of APIs that the Chime namespace does not have. If you are getting started with the Amazon Chime SDK, use the Meetings namespace to access the latest features.
