AWS SDK for JavaScript v2 のサポート終了が間近に迫っていることが発表されています。AWS SDK for JavaScript v3 に移行することをお勧めします。日付、その他の詳細、移行方法については、リンク先の発表内容を参照してください。

API バージョンのロック

AWS サービスには、API の互換性を追跡するための API バージョン番号があります。AWS のサービスの API バージョンは、YYYY-mm-dd 形式の日付文字列で識別されます。例えば、Amazon S3 の現在の API バージョンは 2006-03-01 です。

本番稼働用コードでバージョンに頼っている場合は、特定のサービスの API バージョンをロックすることをお勧めします。これにより、SDK の更新によるサービスの変更からアプリケーションを分離することができます。サービスオブジェクトの作成時に API バージョンを指定しないと、SDK はデフォルトで最新の API バージョンを使用します。これにより、アプリケーションが更新された API を参照し、この更新がアプリケーションに悪影響を与える可能性があります。

サービスに使用する API バージョンをロックするには、サービスオブジェクトの構築の際に apiVersion パラメータを渡します。次の例では、新しく作成された AWS.DynamoDB サービスオブジェクトは 2011-12-05 API バージョンにロックされています。

var dynamodb = new AWS.DynamoDB({apiVersion: '2011-12-05'});

AWS.Config で apiVersions パラメータを指定することで、一連のサービス API バージョンをグローバルに設定できます。例えば、特定のバージョンの DynamoDB および Amazon EC2 API を現在の Amazon Redshift API と一緒に設定するには、 apiVersions を次のように設定します。

AWS.config.apiVersions = {
  dynamodb: '2011-12-05',
  ec2: '2013-02-01',
  redshift: 'latest'
};

API バージョンの取得

サービスの API バージョンを取得するには、Amazon S3 向け https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html など、サービスのリファレンスページの API バージョンのロックセクションを参照してください。