AWS SDK for JavaScript V3 APIリファレンスガイドでは、バージョン 3 (V3) のすべてのAPIオペレーションについて詳しく説明しています AWS SDK for JavaScript 。
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
クライアントコンストラクター
このリストは v2 設定パラメータ によってインデックス化されます。
-
-
v2: サービスがペイロードボディを受け入れるときに、ペイロードボディのMD5チェックサムを計算するかどうか (現在 S3 でのみサポートされています)。
-
v3: S3 の該当するコマンド ( など) はPutObject PutBucketCors、リクエストペイロードの のMD5チェックサムを自動的に計算します。コマンドの
ChecksumAlgorithm
パラメータで別のチェックサムアルゴリズムを指定して、別のチェックサムアルゴリズムを使用することもできます。詳細については、S3 機能のお知らせ」を参照してください。
-
-
-
v2: レスポンスデータを解析するときに型が変換されるかどうか。
-
v3: を廃止しました。このオプションは、タイムスタンプや base64 バイナリなどのタイプをJSONレスポンスから変換しないため、型安全ではないと見なされます。
-
-
-
v2: クライアントクロックが歪んでいるために失敗したクロックスキュー修正および再試行リクエストを適用するかどうか。
-
v3: を廃止しました。SDK は常にクロックスキュー補正を適用します。
-
-
-
v2: すべての署名時間に適用されるミリ秒単位のオフセット値。
-
v3: 変更なし。
-
-
-
v2: AWS リクエストに署名するための認証情報。
-
v3: 変更なし。認証情報を返す非同期関数にすることもできます。関数が を返す場合
expiration (Date)
、有効期限の日時が近づくと、関数は再び呼び出されます。AwsAuthInputConfig
認証情報については、「v3 APIリファレンス」を参照してください。
-
-
-
v2: エンドポイント検出オペレーションからエンドポイントを保存するグローバルキャッシュのサイズ。
-
v3: 変更なし。
-
-
-
v2: サービスによって指定されたエンドポイントを使用して オペレーションを動的に呼び出すかどうか。
-
v3: 変更なし。
-
-
-
v2: リクエストパラメータをホスト名のプレフィックスにマーシャリングするかどうか。
-
v3: を廃止しました。SDK 必要に応じて、 は常にホスト名プレフィックスを挿入します。
-
-
低レベル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: 上記の例
httpsAgent
に示すように、httpAgent
または を設定できます。
-
-
connectTimeout
-
v2:
connectTimeout
ミリ秒後にサーバーとの接続を確立できなかった後、ソケットをタイムアウトに設定します。 -
v3:
connectionTimeout
はNodeHttpHandler
オプション で使用できます。
-
-
timeout
-
v2: リクエストが自動的に終了するまでにかかるミリ秒数。
-
v3:
socketTimeout
はNodeHttpHandler
オプション で使用できます。
-
-
xhrAsync
-
v2: SDKが非同期HTTPリクエストを送信するかどうか。
-
v3: を廃止しました。リクエストは常に非同期です。
-
-
xhrWithCredentials
-
v2: XMLHttpRequest オブジェクトのwithCredentials「」プロパティを設定します。
-
v3: 使用できません。SDK はデフォルトのフェッチ設定 を継承します
。
-
-
-
-
v2: リクエストに関する情報をログに記録するために
.write()
(ストリームなど) または.log()
(コンソールオブジェクトなど) に応答するオブジェクト。 -
v3: 変更なし。より詳細なログは v3 で利用できます。
-
-
-
v2: サービスリクエストに従うリダイレクトの最大量。
-
v3: を廃止しました。SDK は、意図しないクロスリージョンリクエストを回避するためにリダイレクトに従いません。
-
-
-
v2: サービスリクエストに対して実行する最大再試行回数。
-
v3: を に変更しました
maxAttempts
。の詳細については、「 の v3 APIリファレンス RetryInputConfig」を参照してください。は にmaxAttempts
する必要がありますmaxRetries + 1
。
-
-
-
v2: リクエストを送信する前に、入力パラメータをオペレーションの説明に対して検証する必要があるかどうか。
-
v3: を廃止しました。SDK は、実行時にクライアント側で検証を行いません。
-
-
-
v2: サービスリクエストの送信先のリージョン。
-
v3: 変更なし。リージョン文字列を返す非同期関数にすることもできます。
-
-
-
v2: 再試行可能なエラーの再試行遅延を設定するための一連のオプション。
-
v3: を廃止しました。SDK は、
retryStrategy
クライアントコンストラクタオプションを使用して、より柔軟な再試行戦略をサポートします。詳細については、「v3 APIリファレンス」を参照してください。
-
-
-
v2: 指定されたエンドポイントが個々のバケットをアドレス指定しているかどうか (ルートAPIエンドポイントをアドレス指定している場合は失敗)。
-
v3: を に変更しました
bucketEndpoint
。の詳細については、「 の v3 APIリファレンスbucketEndpoint」を参照してください。に設定するとtrue
、リクエストパラメータでBucket
リクエストエンドポイントを指定すると、元のエンドポイントが上書きされることに注意してください。v2 では、クライアントコンストラクタのリクエストエンドポイントがBucket
リクエストパラメータを上書きします。
-
-
-
v2: 署名バージョン v4 の使用時に S3 本文署名を無効にするかどうか。
-
v3: の名前を に変更しました
applyChecksum
。
-
-
-
v2: S3 オブジェクトURLsのパススタイルを強制するかどうか。
-
v3: の名前を に変更しました
forcePathStyle
。
-
-
-
v2: リクエストリージョンを、リクエストされたリソースの から推測されたリージョンで上書きするかどうかARN。
-
v3: の名前を に変更しました
useArnRegion
。
-
-
-
v2: region が「us-east-1」に設定されている場合、s3 リクエストをグローバルエンドポイントに送信するか、「us-east-1」リージョンエンドポイントに送信するか。
-
v3: を廃止しました。region が に設定されている場合、S3 クライアントは常にリージョンエンドポイントを使用します
us-east-1
。リージョンを に設定aws-global
して、S3 グローバルエンドポイントにリクエストを送信できます。
-
-
-
v2: でリクエストに署名する署名 (API設定の上書き) がキャッシュされるかどうか。
-
v3: を廃止しました。SDK は常にハッシュされた署名キーをキャッシュします。
-
-
-
v2: リクエストに署名する署名バージョン (API設定を上書き)。
-
v3: を廃止しました。vV2サポートされている署名 V2 SDKは によって非推奨になりました AWS。v3 は署名 v4 のみをサポートしています。
-
-
-
v2: リクエストに対して SSL が有効になっているかどうか。
-
v3: の名前を に変更しました
tls
。
-
-
-
v2: グローバルエンドポイントまたはリージョンエンドポイントに sts リクエストを送信するかどうか。
-
v3: を廃止しました。STS クライアントは、特定のリージョンに設定されている場合、常にリージョンエンドポイントを使用します。リージョンを に設定
aws-global
して、STSグローバルエンドポイントにリクエストを送信できます。
-
-
-
v2: S3 サービスで Accelerate エンドポイントを使用するかどうか。
-
v3: 変更なし。
-