Specifying Custom Endpoints - Amazon SDK for JavaScript
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

We announced the upcoming end-of-support for Amazon SDK for JavaScript v2. We recommend that you migrate to Amazon SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Specifying Custom Endpoints

Calls to API methods in the SDK for JavaScript are made to service endpoint URIs. By default, these endpoints are built from the Region you have configured for your code. However, there are situations in which you need to specify a custom endpoint for your API calls.

Endpoint String Format

Endpoint values should be a string in the format:


Endpoints for the ap-northeast-3 Region

The ap-northeast-3 Region in Japan is not returned by Region enumeration APIs, such as EC2.describeRegions. To define endpoints for this Region, follow the format described previously. So the Amazon EC2 endpoint for this Region would be


Endpoints for MediaConvert

You need to create a custom endpoint to use with MediaConvert. Each customer account is assigned its own endpoint, which you must use. Here is an example of how to use a custom endpoint with MediaConvert.

// Create MediaConvert service object using custom endpoint var mcClient = new AWS.MediaConvert({endpoint: 'https://abcd1234.mediaconvert.us-west-1.amazonaws.com'}); var getJobParams = {Id: 'job_ID'}; mcClient.getJob(getJobParams, function(err, data)) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response };

To get your account API endpoint, see MediaConvert.describeEndpoints in the API Reference.

Make sure you specify the same Region in your code as the Region in the custom endpoint URI. A mismatch between the Region setting and the custom endpoint URI can cause API calls to fail.

For more information on MediaConvert, see the AWS.MediaConvert class in the API Reference or the AWS Elemental MediaConvert User Guide .