用語集

サービスには、1 つ以上の API バージョンがあり、使用しているバージョンの種類で、有効なオペレーションとパラメーターの種類が決まります。API バージョンは、日付のようなフォーマットです。例えば、Amazon S3 の最新 API バージョンは、2006-03-01 となります。クライアントオブジェクトを設定するときに、バージョンを指定します。

クライアントオブジェクトは、サービスのオペレーションを実行するために使用されます。SDK でサポートされている各サービスには、対応するクライアントオブジェクトがあります。クライアントオブジェクトには、サービスのオペレーションと 1 対 1 で対応するメソッドがあります。クライアントオブジェクトの作成および使用方法の詳細については「基本使用法ガイド」を参照してください。

コマンドオブジェクトはオペレーションの実行をカプセル化します。SDK の基本使用パターンに従うと、コマンドオブジェクトを直接扱いません。同時リクエストとバッチ処理のような SDK の高度な機能を使用するには、クライアントの getCommand() メソッドを使用してコマンドオブジェクトにアクセスできます。詳細については、「AWS SDK for PHP バージョン 3 でのコマンドオブジェクト」ガイドを参照してください。

ハンドラーは、コマンドおよびリクエストから結果への実際の変換を実行する関数です。ハンドラーは、通常、HTTP リクエストを送信します。ハンドラーをミドルウェアで構成して動作を補強できます。ハンドラー関数は、Aws\CommandInterface と Psr\Http\Message\RequestInterface を受け入れて、Aws\ResultInterface で満たすかまたは Aws\Exception\AwsException 理由で拒否する promise を返します。

JMESPath は JSON 類似データ向けのクエリ言語です。AWS SDK for PHP は JMESPath 式を使用して PHP のデータ構造をクエリします。JMESPath 式は Aws\Result と Aws\ResultPaginator オブジェクトで search($expression) メソッドを介して直接使用できます。

ミドルウェアは、コマンドの転送動作を補強して「next」ハンドラーに委任する、特殊なタイプの高レベル関数です。ミドルウェア関数は Aws\CommandInterface と Psr\Http\Message\RequestInterface を受け入れて、Aws\ResultInterface で満たすかまたは Aws\Exception\AwsException 理由で拒否する promise を返します。

サービスの API にある単一のオペレーションを指します (DynamoDB では CreateTable、Amazon EC2 では RunInstances など)。SDK では、オペレーションは対応するサービスのクライアントオブジェクトで同じ名前のメソッドを呼び出すことによって実行されます。オペレーションの実行には、サービスへの HTTP リクエストの作成と送信、応答の解析があります。オペレーションのこの実行プロセスは、コマンドオブジェクト経由で SDK により抽象化されます。

一部の AWS サービスオペレーションではページ分割され、結果が一部切り捨てられて応答します。例えば、Amazon S3 の ListObjects オペレーションが一度に返せるのは、1000 個のオブジェクトまでです。このようなオペレーションでは後続のリクエストが必要になります。トークン (マーカー) パラメーターを指定して結果セット全体を取得します。ページネーターは SDK の機能で、開発者がページ分割 API を簡単に使用できるようにこのプロセスを抽象化します。クライアントの getPaginator() メソッドを使用してアクセスします。詳細については、「AWS SDK for PHP バージョン 3 でのページネーター」ガイドを参照してください。

promise は、非同期オペレーションの最終結果を表します。promise とのやり取りの主な手段は、メソッドを使用するもので、promise の最終結果の値、または promise が実行できない理由を受け取るコールバックを登録します。

サービスは、1 か所以上の地理的リージョンでサポートされています。サービスは各リージョンで異なるエンドポイント/URL を持つことができます。これはアプリケーションのデータレイテンシーを軽減するために存在します。クライアントオブジェクトを設定するときは、リージョンを指定します。これにより、SDK でサービスに使用するエンドポイントを特定できます。

「SDK」という用語は AWS SDK for PHP ライブラリ全体を指すこともありますが、Aws\Sdk クラス (docs) の場合もあります。各サービスのクライアントオブジェクトに対してファクトリとして機能します。Sdk クラスにより、それが作成するすべてのクライアントオブジェクトに適用されるグローバル設定値のセットが提供できます。

任意の AWS サービス (Amazon S3、Amazon DynamoDB、AWS OpsWorks など) を参照する一般的な方法です。各サービスには、対応するクライアントオブジェクトが SDK にあり、1 つ以上の API バージョンをサポートします。また各サービスには、その API を構成する 1 つ以上のオペレーションがあります。サービスは、1 か所以上のリージョンでサポートされています。

オペレーションを実行すると、SDK は認証情報を使用して、リクエストのデジタル署名を作成します。このサービスは、リクエストを処理する前に、署名を確認します。署名プロセスは、SDK でカプセル化され、クライアントに設定した認証情報を使用して自動的に実行されます。

ウェーターは SDK の機能で、これによりリソースの状態を変更する、事実上結果整合性があるまたは非同期であるオペレーションとの連携が簡単になります。例えば、Amazon DynamoDB CreateTable オペレーションはすぐに応答を返しますが、数秒経たないとテーブルにアクセスする準備ができていないことがあります。ウェーターを実行すると、リソースのステータスのポーリングおよびスリープにより、リソースが特定の状態になるまで待機できます。ウェーターは、クライアントの waitUntil() メソッドを使用してアクセスします。詳細については、「AWS SDK for PHP バージョン 3 でのウェーター」ガイドを参照してください。