Configure proxies for Node.js - 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).

The Amazon SDK for JavaScript V3 API Reference Guide describes in detail all the API operations for the Amazon SDK for JavaScript version 3 (V3).

Configure proxies for Node.js

If you can't directly connect to the internet, the SDK for JavaScript supports use of HTTP or HTTPS proxies through a third-party HTTP agent.

To find a third-party HTTP agent, search for "HTTP proxy" at npm.

To install a third-party HTTP agent proxy, enter the following at the command prompt, where PROXY is the name of the npm package.

npm install PROXY --save

To use a proxy in your application, use the httpAgent and httpsAgent property, as shown in the following example for a DynamoDB client.

import { DynamoDBClient } from '@aws-sdk/client-dynamodb'; import { NodeHttpHandler } from "@smithy/node-http-handler"; import { HttpsProxyAgent } from "hpagent"; const agent = new HttpsProxyAgent({ proxy: "http://internal.proxy.com" }); const dynamodbClient = new DynamoDBClient({ requestHandler: new NodeHttpHandler({ httpAgent: agent, httpsAgent: agent }), });
Note

httpAgent is not the same as httpsAgent, and since most calls from the client will be to https, both should be set.