AWS SDK for JavaScript
Developer Guide for SDK v2.212.1

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 AWS Elemental MediaConvert

You need to create a custom endpoint to use with AWS Elemental 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 AWS Elemental MediaConvert.

// Create MediaConvert service object using custom endpoint var mcClient = new AWS.MediaConvert({endpoint: ''}); 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 cals to fail.

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