Migrating to the Amazon Chime SDK voice namespace

The Amazon Chime SDK Voice namespace is a dedicated place for the APIs that create and manage Amazon Chime SDK voice resources. You use the namespace to address Amazon Chime SDK voice API endpoints in any AWS Region that makes them available. If you're just starting to use the Amazon Chime SDK, use this namespace. For more information about Regions, refer to Available AWS Regions for the Amazon Chime SDK in this guide.

Existing applications that use the Amazon Chime namespace should plan to migrate to the dedicated namespace in order to use updated APIs and new features.

Reasons to migrate

We recommend migrating to the Amazon Chime SDK Voice namespace for the following reasons:

Before you migrate

Before you migrate, be aware of the differences between the namespaces. The following table lists and describes them.

For more information about the available Regions, refer to Voice Regions.

Differences between the namespaces

The following sections explain the differences between the Amazon Chime SDK Voice and Amazon Chime namespaces.

AWS namespace

The Amazon Chime SDK namespace uses the Chime formal name. The Amazon Chime SDK Voice namespace uses the ChimeSDKVoice 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 the following line of code to address the namespace.

const chimeVoice = AWS.Chime();

To migrate to the Amazon Chime SDK Voice namespace, update this line of code with the new namespace and the endpoint region.

const chimeVoice = AWS.ChimeSDKVoice({ region: "eu-central-1" });

Regions

The Amazon Chime namespace can only address API endpoints in the us-east-1 Region. The Amazon Chime SDK Voice namespace can address Amazon Chime SDK voice API endpoints in any Region they are available. For a current list of voice Regions, refer to Available AWS Regions for the Amazon Chime SDK in this guide.

Endpoints

The Amazon Chime SDK Voice namespace uses different API endpoints than the Amazon Chime namespace.

Only the endpoint used to create a voice action can be used to modify it. This means a voice action created via an endpoint in eu-central-1 can only be modified via eu-central-1. It also means you cannot address a voice action created via the Chime namespace with the ChimeSDKVoice namespace in us-east-1. For more information about the current endpoints, refer to API mapping in this guide.

Service principal

Both namespaces uses the chime.amazonaws.com service principal. If you have access policies that grant access to the service, you do not need to update those polices.

APIs

The Amazon Chime SDK Voice namespace only contains APIs to create and manage voice actions. The Amazon Chime namespace includes APIs for voice and other parts of the Amazon Chime service, such as meetings.

Tagging

Only the Amazon Chime SDK Voice namespace supports tags. For more information about tags, refer to TagResource and UntagResource.

Media Regions

If you use the Chime namespace to create resources such as Voice Connectors and SIP media application, you can only do so in us-east-1 and us-west-2, and you must use the us-east-1 endpoint.

In contrast, the ChimeSDKVoice namespace allows resource creation in all supported Regions, not just us-east-1 and us-west-2. For more information about regional coverage, refer to Available AWS Regions for the Amazon Chime SDK.