Migrating from the Amazon Chime namespace - Amazon Chime SDK

Migrating from the Amazon Chime namespace

The Amazon Chime SDK exposes APIs on a set of endpoints. Although you can make HTTPS requests directly to the endpoints, many customers use the AWS SDK in their applications to call the service APIs. The AWS SDK is available in different languages, and it simplifies API calling by encapsulating request signing and retry logic. The AWS SDK includes a namespace for each service endpoint.

When first launched, the Amazon Chime SDK shared a single endpoint with the Amazon Chime application. As a result, solutions used the Chime namespace in the AWS SDK to call the Amazon Chime application and the Amazon Chime SDK APIs.

The Amazon Chime SDK now provides dedicated endpoints for each sub-service, such as meetings and PSTN Audio. Each endpoint is addressable through a dedicated namespace in the AWS SDK.

The following topics list the services, namespaces, and endpoints, and describe how to use them in code and with the AWS CLI.

Endpoints, namespaces, and CLI commands

The following table lists the dedicated Amazon Chime SDK namespaces, endpoints, and CLI commands. The links take you to more information about each service.

Endpoint

AWS SDK Namespace

AWS SDK CLI

identity-chime

ChimeSDKIdentity

chime-sdk-identity

media-pipelines-chime

ChimeSDKMediaPipelines

chime-sdk-media-pipelines

meetings-chime

ChimeSDKMeetings

chime-sdk-meetings

messaging-chime

ChimeSDKMessaging

chime-sdk-messaging

voice-chime

ChimeSDKVoice

chime-sdk-voice

Migration help for each service

All customers should consider using the dedicated Amazon Chime SDK endpoints for access to the latest Amazon Chime SDK features, APIs, and AWS Regions. If you use the shared endpoint with the Chime namespace, the following migration guides can help understand the technical differences before migrating.

API mapping

The following table lists the APIs in the Chime namespace, and their corresponding dedicated namespaces and APIs. Some of the dedicated APIs differ from the Chime APIs, and the table indicates those instances.

Chime namespace API Dedicated namespace Dedicated namespace API
AssociatePhoneNumbersWithVoiceConnector voice-chime AssociatePhoneNumbersWithVoiceConnector
AssociatePhoneNumbersWithVoiceConnectorGroup voice-chime AssociatePhoneNumbersWithVoiceConnectorGroup
BatchCreateAttendee meetings-chime BatchCreateAttendee
BatchCreateChannelMembership messaging-chime BatchCreateChannelMembership
CreateAppInstance identity-chime CreateAppInstance
CreateAppInstanceAdmin identity-chime CreateAppInstanceAdmin
CreateAppInstanceUser identity-chime CreateAppInstanceUser
CreateAttendee meetings-chime CreateAttendee
CreateChannel messaging-chime CreateChannel
CreateChannelBan messaging-chime CreateChannelBan
CreateChannelMembership messaging-chime CreateChannelMembership
CreateChannelModerator messaging-chime CreateChannelModerator
CreateMediaCapturePipeline media-pipelines-chime CreateMediaCapturePipeline
CreateMeeting meetings-chime CreateMeeting
CreateMeetingWithAttendees meetings-chime CreateMeetingWithAttendees
CreateMeetingDialOut* n/a
CreateProxySession voice-chime CreateProxySession
CreateSipMediaApplication voice-chime CreateSipMediaApplication
CreateSipMediaApplicationCall voice-chime CreateSipMediaApplicationCall
CreateSipRule voice-chime CreateSipRule
CreateVoiceConnector voice-chime CreateVoiceConnector
CreateVoiceConnectorGroup voice-chime CreateVoiceConnectorGroup
DeleteAppInstance identity-chime DeleteAppInstance
DeleteAppInstanceAdmin identity-chime DeleteAppInstanceAdmin
DeleteAppInstanceStreamingConfigurations messaging-chime DeleteAppInstanceStreamingConfigurations
DeleteAppInstanceUser identity-chime DeleteAppInstanceUser
DeleteAttendee meetings-chime DeleteAttendee
DeleteChannel messaging-chime DeleteChannel
DeleteChannelBan messaging-chime DeleteChannelBan
DeleteChannelMembership messaging-chime DeleteChannelMembership
DeleteChannelMessage messaging-chime DeleteChannelMessage
DeleteChannelModerator messaging-chime DeleteChannelModerator
DeleteMediaCapturePipeline media-pipelines-chime DeleteMediaCapturePipeline
DeleteMeeting meetings-chime DeleteMeeting
DeleteProxySession voice-chime DeleteProxySession
DeleteSipMediaApplication voice-chime DeleteSipMediaApplication
DeleteSipRule voice-chime DeleteSipRule
DeleteVoiceConnector voice-chime DeleteVoiceConnector
DeleteVoiceConnectorEmergencyCallingConfiguration voice-chime DeleteVoiceConnectorEmergencyCallingConfiguration
DeleteVoiceConnectorGroup voice-chime DeleteVoiceConnectorGroup
DeleteVoiceConnectorOrigination voice-chime DeleteVoiceConnectorOrigination
DeleteVoiceConnectorProxy voice-chime DeleteVoiceConnectorProxy
DeleteVoiceConnectorStreamingConfiguration voice-chime DeleteVoiceConnectorStreamingConfiguration
DeleteVoiceConnectorTermination voice-chime DeleteVoiceConnectorTermination
DeleteVoiceConnectorTerminationCredentials voice-chime DeleteVoiceConnectorTerminationCredentials
DescribeAppInstance identity-chime DescribeAppInstance
DescribeAppInstanceAdmin identity-chime DescribeAppInstanceAdmin
DescribeAppInstanceUser identity-chime DescribeAppInstanceUser
DescribeChannel messaging-chime DescribeChannel
DescribeChannelBan messaging-chime DescribeChannelBan
DescribeChannelMembership messaging-chime DescribeChannelMembership
DescribeChannelMembershipForAppInstanceUser messaging-chime DescribeChannelMembershipForAppInstanceUser
DescribeChannelModeratedByAppInstanceUser messaging-chime DescribeChannelModeratedByAppInstanceUser
DescribeChannelModerator messaging-chime DescribeChannelModerator
DisassociatePhoneNumbersFromVoiceConnector voice-chime DisassociatePhoneNumbersFromVoiceConnector
DisassociatePhoneNumbersFromVoiceConnectorGroup voice-chime DisassociatePhoneNumbersFromVoiceConnectorGroup
GetAppInstanceRetentionSettings identity-chime GetAppInstanceRetentionSettings
GetAppInstanceStreamingConfigurations messaging-chime GetMessagingStreamingConfigurations
GetAttendee meetings-chime GetAttendee
GetChannelMessage messaging-chime GetChannelMessage
GetMediaCapturePipeline media-pipelines-chime GetMediaCapturePipeline
GetMeeting meetings-chime GetMeeting
GetMessagingSessionEndpoint messaging-chime GetMessagingSessionEndpoint
GetProxySession voice-chime GetProxySession
GetSipMediaApplication voice-chime GetSipMediaApplication
GetSipMediaApplicationLoggingConfiguration voice-chime GetSipMediaApplicationLoggingConfiguration
GetSipRule voice-chime GetSipRule
GetVoiceConnector voice-chime GetVoiceConnector
GetVoiceConnectorEmergencyCallingConfiguration voice-chime GetVoiceConnectorEmergencyCallingConfiguration
GetVoiceConnectorGroup voice-chime GetVoiceConnectorGroup
GetVoiceConnectorLoggingConfiguration voice-chime GetVoiceConnectorLoggingConfiguration
GetVoiceConnectorOrigination voice-chime GetVoiceConnectorOrigination
GetVoiceConnectorProxy voice-chime GetVoiceConnectorProxy
GetVoiceConnectorStreamingConfiguration voice-chime GetVoiceConnectorStreamingConfiguration
GetVoiceConnectorTermination voice-chime GetVoiceConnectorTermination
GetVoiceConnectorTerminationHealth voice-chime GetVoiceConnectorTerminationHealth
ListAppInstanceAdmins identity-chime ListAppInstanceAdmins
ListAppInstances identity-chime ListAppInstances
ListAppInstanceUsers identity-chime ListAppInstanceUsers
ListAttendees meetings-chime ListAttendees
ListAttendeeTags* n/a
ListChannelBans messaging-chime ListChannelBans
ListChannelMemberships messaging-chime ListChannelMemberships
ListChannelMembershipsForAppInstanceUser messaging-chime ListChannelMembershipsForAppInstanceUser
ListChannelMessages messaging-chime ListChannelMessages
ListChannelModerators messaging-chime ListChannelModerators
ListChannels messaging-chime ListChannels
ListChannelsModeratedByAppInstanceUser messaging-chime ListChannelsModeratedByAppInstanceUser
ListMediaCapturePipelines media-pipelines-chime ListMediaCapturePipelines
ListMeetings* n/a
ListMeetingTags+ meetings-chime ListTagsForResource
ListProxySessions voice-chime ListProxySessions
ListSipMediaApplications voice-chime ListSipMediaApplications
ListSipRules voice-chime ListSipRules
ListTagsForResource identity-chime ListTagsForResource
ListVoiceConnectorGroups voice-chime ListVoiceConnectorGroups
ListVoiceConnectors voice-chime ListVoiceConnectors
ListVoiceConnectorTerminationCredentials voice-chime ListVoiceConnectorTerminationCredentials
PutAppInstanceRetentionSettings identity-chime PutAppInstanceRetentionSettings
PutAppInstanceStreamingConfigurations messaging-chime PutMessagingStreamingConfigurations
PutSipMediaApplicationLoggingConfiguration voice-chime PutSipMediaApplicationLoggingConfiguration
PutVoiceConnectorEmergencyCallingConfiguration voice-chime PutVoiceConnectorEmergencyCallingConfiguration
PutVoiceConnectorLoggingConfiguration voice-chime PutVoiceConnectorLoggingConfiguration
PutVoiceConnectorOrigination voice-chime PutVoiceConnectorOrigination
PutVoiceConnectorProxy voice-chime PutVoiceConnectorProxy
PutVoiceConnectorStreamingConfiguration voice-chime PutVoiceConnectorStreamingConfiguration
PutVoiceConnectorTermination voice-chime PutVoiceConnectorTermination
PutVoiceConnectorTerminationCredentials voice-chime PutVoiceConnectorTerminationCredentials
RedactChannelMessage messaging-chime RedactChannelMessage
SendChannelMessage messaging-chime SendChannelMessage
StartMeetingTranscription meetings-chime StartMeetingTranscription
StopMeetingTranscription meetings-chime StopMeetingTranscription
TagAttendee* n/a
TagMeeting+ meetings-chime TagResource
TagResource identity-chime TagResource
media-pipelines-chime TagResource
meetings-chime TagResource
messaging-chime TagResource
voice-chime TagResource
UntagAttendee* n/a
UntagMeeting+ meetings-chime UntagResource
UntagResource identity-chime UntagResource
media-pipelines-chime UntagResource
meetings-chime UntagResource
messaging-chime UntagResource
voice-chime UntagResource
UpdateAppInstance identity-chime UpdateAppInstance
UpdateAppInstanceUser identity-chime UpdateAppInstanceUser
UpdateChannel messaging-chime UpdateChannel
UpdateChannelMessage messaging-chime UpdateChannelMessage
UpdateChannelReadMarker messaging-chime UpdateChannelReadMarker
UpdateProxySession voice-chime UpdateProxySession
UpdateSipMediaApplication voice-chime UpdateSipMediaApplication
UpdateSipMediaApplicationCall voice-chime UpdateSipMediaApplicationCall
UpdateSipRule voice-chime UpdateSipRule
UpdateVoiceConnector voice-chime UpdateVoiceConnector
UpdateVoiceConnectorGroup voice-chime UpdateVoiceConnectorGroup
ValidateE911Address voice-chime ValidateE911Address

+ API has been superseded by an API with another name.

* API is no longer available.