クライアントコンストラクタ - AWS SDK for JavaScript

AWS SDK for JavaScript V3 API リファレンスガイドでは、AWS SDK for JavaScript バージョン3 (V3) のすべての API オペレーションについて詳しく説明します。

クライアントコンストラクタ

このリストは v2 設定パラメータによってインデックス化されています。

  • computeChecksums

    • v2: サービスが対応している場合に、ペイロード本文の MD5 チェックサムを計算するかどうか (現在 S3 でのみサポートされています)。

    • v3: S3 の該当するコマンド (PutObject、PutBucketCors など) は、リクエストペイロードの MD5 チェックサムを自動的に計算します。コマンドの ChecksumAlgorithm パラメータで別のチェックサムアルゴリズムを指定して、異なるチェックサムアルゴリズムを使用することもできます。詳細については、S3 の機能に関する発表を参照してください。

  • convertResponseTypes

    • v2: レスポンスデータを解析するときに型が変換されるかどうか。

    • v3: 廃止。このオプションは、JSON レスポンスのタイムスタンプや base64 バイナリなどの型を変換しないため、型安全ではないと見なされます。

  • correctClockSkew

    • v2: クライアントのクロックスキューが原因で失敗したクロックスキュー修正リクエストと再試行リクエストを適用するかどうか。

    • v3: 廃止。SDK は常にクロックスキュー修正を適用します。

  • systemClockOffset

    • v2: すべての署名時刻に適用するミリ秒単位のオフセット値。

    • v3: 変更なし。

  • credentials

    • v2: リクエストに署名するための AWS 認証情報。

    • v3: 変更なし。また、認証情報を返す非同期関数を指定することもできます。関数が expiration (Date) を返す場合、有効期限の日時が近づくと関数が再度呼び出されます。v3 API リファレンスの AwsAuthInputConfig 認証情報の説明を参照してください。

  • endpointCacheSize

    • v2: エンドポイント検出オペレーションで検出されたエンドポイントを保存するグローバルキャッシュのサイズ。

    • v3: 変更なし。

  • endpointDiscoveryEnabled

    • v2: サービスによって指定されたエンドポイントを使用してオペレーションを動的に呼び出すかどうか。

    • v3: 変更なし。

  • hostPrefixEnabled

    • v2: リクエストパラメータをホスト名のプレフィックスにマーシャリングするかどうか。

    • v3: 廃止。SDK は、必要に応じて常にホスト名プレフィックスを挿入します。

  • httpOptions

    低レベルの HTTP リクエストに渡す一連のオプション。これらのオプションは v3 では異なる方法で集計されます。新しい requestHandler を指定することで設定できます。Node.js ランタイムで http オプションを設定する例を次に示します。詳細については、v3 API リファレンスのNodeHttpHandlerの説明を参照してください。

    すべての v3 リクエストはデフォルトで HTTPS を使用します。カスタム httpsAgent のみを指定する必要があります。

    const { Agent } = require("https");
const { Agent: HttpAgent } = require("http");
const { NodeHttpHandler } = require("@smithy/node-http-handler");
const dynamodbClient = new DynamoDBClient({
    requestHandler: new NodeHttpHandler({
        httpsAgent: new Agent({
            /*params*/
        }),
        connectionTimeout: /*number in milliseconds*/,
        socketTimeout: /*number in milliseconds*/
    }),
});

    http を使用するカスタムエンドポイントを渡す場合は、httpAgent を指定する必要があります。

    const { Agent } = require("http");
const { NodeHttpHandler } = require("@smithy/node-http-handler");

const dynamodbClient = new DynamoDBClient({
    requestHandler: new NodeHttpHandler({
        httpAgent: new Agent({
            /*params*/
        }),
    }),
    endpoint: "http://example.com",
});

    クライアントがブラウザで実行されている場合、別のオプションセットを使用できます。詳細については、v3 API リファレンスのFetchHttpHandlerの説明を参照してください。

    const { FetchHttpHandler } = require("@smithy/fetch-http-handler");
const dynamodbClient = new DynamoDBClient({
    requestHandler: new FetchHttpHandler({
        requestTimeout: /* number in milliseconds */
    }),
});

    httpOptions の各オプションを以下に示します。

    • proxy

      • v2: リクエストをプロキシ経由で送信するための URL。

      • v3: Node.js のプロキシの設定に従って、 エージェントでプロキシを設定できます。

    • agent

      • v2: HTTP リクエストを実行するエージェントオブジェクト。接続プーリング用に使用されます。

      • v3: 上記の例に示すように、httpAgent または httpsAgent を設定できます。

    • connectTimeout

      • v2: connectTimeout ミリ秒以内にサーバーとの接続を確立できなかった場合、ソケットをタイムアウトするよう設定します。

      • v3: connectionTimeout は NodeHttpHandler オプションで使用できます。

    • timeout

      • v2: リクエストが自動的に終了するまでにかかるミリ秒数。

      • v3: socketTimeout は NodeHttpHandler オプションで使用できます。

    • xhrAsync

      • v2: SDK が非同期 HTTP リクエストを送信するかどうか。

      • v3: 廃止。リクエストは常に非同期です。

    • xhrWithCredentials

      • v2: XMLHttpRequest オブジェクトの「withCredentials」プロパティを設定します。

      • v3: 利用できません。SDK はデフォルトのフェッチ設定を継承します。

  • logger

    • v2: リクエストに関する情報をログに記録するために、.write() (ストリームなど) または .log() (コンソールオブジェクトなど) に応答するオブジェクト。

    • v3: 変更なし。v3 では、より詳細なログを利用できます。

  • maxRedirects

    • v2: サービスリクエストで従うリダイレクトの最大回数。

    • v3: 廃止。SDK は、意図しないクロスリージョンリクエストを回避するために、リダイレクトに従いません。

  • maxRetries

    • v2: サービスリクエストに対して実行する再試行の最大回数。

    • v3: maxAttempts に変更されました。詳細については、v3 API リファレンスの RetryInputConfig の説明を参照してください。maxAttempts は maxRetries + 1 である必要があります。

  • paramValidation

    • v2: リクエストを送信する前に、入力パラメータをオペレーションの説明に対して検証するかどうか。

    • v3: 廃止。SDK は、実行時にクライアント側で検証を行いません。

  • region

    • v2: サービスリクエストの送信先のリージョン。

    • v3: 変更なし。また、リージョン文字列を返す非同期関数を指定することもできます。

  • retryDelayOptions

    • v2: 再試行可能なエラーが発生した際に再試行までの遅延を設定するための一連のオプション。

    • v3: 廃止。SDK は、retryStrategy クライアントコンストラクタオプションを使用して、より柔軟な再試行戦略をサポートします。詳細については、「v3 API リファレンス」を参照してください。

  • s3BucketEndpoint

    • v2: 指定されたエンドポイントが個々のバケットを対象としているかどうか (ルート API エンドポイントを対象としている場合は失敗)。

    • v3: bucketEndpoint に変更されました。詳細については、v3 API リファレンスのbucketEndpointの説明を参照してください。true に設定し、リクエストパラメータで Bucket リクエストエンドポイントを指定すると、元のエンドポイントは上書きされることに注意してください。v2 では、クライアントコンストラクタのリクエストエンドポイントが Bucket リクエストパラメータを上書きします。

  • s3DisableBodySigning

    • v2: 署名バージョン v4 の使用時に、S3 本文署名を無効にするかどうか。

    • v3: applyChecksum に名前が変更されました。

  • s3ForcePathStyle

    • v2: S3 オブジェクトのパススタイルの URL を強制するかどうか。

    • v3: forcePathStyle に名前が変更されました。

  • s3UseArnRegion

    • v2: リクエストされたリソースの ARN から推測されたリージョンでリクエストリージョンを上書きするかどうか。

    • v3: useArnRegion に名前が変更されました。

  • s3UsEast1RegionalEndpoint

    • v2: region が「us-east-1」に設定されている場合、s3 リクエストをグローバルエンドポイントに送信するか、「us-east-1」リージョンエンドポイントに送信するか。

    • v3: 廃止。リージョンが us-east-1 に設定されている場合、S3 クライアントは常にリージョンエンドポイントを使用します。リージョンを aws-global に設定することで、S3 グローバルエンドポイントにリクエストを送信できます。

  • signatureCache

    • v2: リクエストに使用するする署名 (API の設定を上書き) がキャッシュされるかどうか。

    • v3: 廃止。SDK は常にハッシュされた署名キーをキャッシュします。

  • signatureVersion

    • v2: リクエストに使用する署名のバージョン (API の設定を上書き)。

    • v3: 廃止。v2 SDK でサポートされている署名 V2 は AWS によって廃止されました。v3 は署名 v4 のみをサポートしています。

  • sslEnabled

    • v2: SSL がリクエストに対して有効になっているかどうか。

    • v3: tls に名前が変更されました。

  • stsRegionalEndpoints

    • v2: sts リクエストをグローバルエンドポイントに送信するか、リージョンエンドポイントに送信するか。

    • v3: 廃止。STS クライアントは、特定のリージョンに設定されている場合、常にリージョンエンドポイントを使用します。リージョンを aws-global に設定することで、STS グローバルエンドポイントにリクエストを送信できます。

  • useAccelerateEndpoint

    • v2: S3 サービスで Accelerate エンドポイントを使用するかどうか。

    • v3: 変更なし。