AWS SDK for PHP バージョン 3 の設定

クライアントコンストラクタは、クライアントコンストラクタまたは Aws\Sdk クラスで指定できます。特定のタイプのクライアントに指定されるオプションの配列は、作成するクライアントによって異なります。これらのカスタムクライアント設定オプションについては、各クライアントの API ドキュメントに記載されています。

一部の設定オプションでは、環境変数または AWS 設定ファイルに基づいてデフォルト値がチェックおよび使用されることに注意してください。デフォルトでは、チェックされる設定ファイルは、ホームディレクトリの .aws/configで、通常、~/.aws/config です。ただし、環境変数 AWS_CONFIG_FILE を使用して、デフォルトの設定ファイルの場所を設定できます。例えば、これは open_basedir などで特定のディレクトリへのファイルアクセスを制限する場合に便利です。

共有 AWS configファイルとcredentialsファイルの場所とフォーマットの詳細については、AWS SDKs and Tools リファレンスガイド」の「設定」を参照してください。

設定ファイルまたは環境変数として設定 AWS できるすべてのグローバル設定の詳細については、AWS SDKs and Tools リファレンスガイドの「設定と認証設定のリファレンス」を参照してください。

以下の例では、Amazon S3 のクライアントコンストラクタにオプションを渡す方法を示しています。

use Aws\S3\S3Client;

$options = [
    'region'            => 'us-west-2',
    'version'           => '2006-03-01',
    'signature_version' => 'v4'
];

$s3Client = new S3Client($options);

クライアントの作成の詳細については、「基本使用法ガイド」を参照してください。

api_provider

タイプ、サービス、バージョン引数を受け入れ、対応する設定データの配列を返す呼び出し可能な PHP。タイプの値は api、waiter、paginator のいずれかです。

デフォルトでは、SDK は、API の src/dataフォルダから Word ファイルをロードAws\Api\FileSystemApiProviderする のインスタンスを使用しますSDK。

認証情報

特定の認証情報インスタンスを使用するための Aws\Credentials\CredentialsInterface オブジェクトを渡します。以下は、IAM Identity Center 認証情報プロバイダーを使用する必要があることを指定します。このプロバイダーは SSO 認証情報プロバイダーとも呼ばれます。

$credentials = Aws\Credentials\CredentialProvider::sso('profile default');

$s3 = new Aws\S3\S3Client([
    'region'      => 'us-west-2',
    'credentials' => $credentials
]);

名前付きプロファイルを使用する場合は、前の例の「default」をプロファイル名に置き換えてください。名前付きプロファイルの設定の詳細については、「 AWS SDKs and Tools リファレンスガイド」の「共有ファイルconfig」とcredentials「ファイル」を参照してください。

使用する認証情報プロバイダを指定せず、認証情報プロバイダチェーンに依存している場合、認証失敗によるエラーメッセージは通常一般的なものです。有効な認証情報を確認しているソースのリストの最後のプロバイダから生成されますが、そのプロバイダは使用しようとしているプロバイダではない可能性があります。どの認証情報プロバイダを使用するかを指定すると、表示されるエラーメッセージはそのプロバイダのみから出力されるため、より有用で関連性の高いものになります。認証情報をチェックしたソースチェーンの詳細については、AWS SDKs and Tools リファレンスガイドの「認証情報プロバイダーチェーン」を参照してください。

Null 認証情報を使用し、リクエストに署名しないように、false を渡します。

$s3 = new Aws\S3\S3Client([
    'region'      => 'us-west-2',
    'credentials' => false
]);

関数を使用して認証情報を作成するために、呼び出し可能な認証情報プロバイダ関数を渡します。

use Aws\Credentials\CredentialProvider;

// Only load credentials from environment variables
$provider = CredentialProvider::env();

$s3 = new Aws\S3\S3Client([
    'region'      => 'us-west-2',
    'credentials' => $provider
]);

複数のプロセスにわたってデフォルトプロバイダーチェーンで返される値をキャッシュするために、Aws\CacheInterface のインスタンスにキャッシュされた認証情報を渡します。

use Aws\Credentials\CredentialProvider;
use Aws\PsrCacheAdapter;
use Symfony\Component\Cache\Adapter\FilesystemAdapter;


$cache = new PsrCacheAdapter(new FilesystemAdapter);
$provider = CredentialProvider::defaultProvider();
$cachedProvider = CredentialProvider::cache($provider, $cache);

$s3 = new Aws\S3\S3Client([
    'region' => 'us-west-2',
    'credentials' => $cachedProvider
]);

クライアントへの認証情報の提供の詳細については、AWS SDK for PHP バージョン 3 の認証情報ガイドを参照してください。

デバッグ

各転送に関するデバッグ情報を出力します。デバッグ情報には、トランザクションが準備されネットワーク経由で送信されるときの、トランザクションの状態の変更に関する情報が含まれています。デバッグ出力には、クライアントが使用する特定の HTTP ハンドラーに関する情報も含まれています (デバッグ cURL 出力など）。

true に設定すると、リクエストの送信時にデバッグ情報が表示されます。

$s3 = new Aws\S3\S3Client([
    'region'  => 'us-west-2',
    'debug'   => true
]);

// Perform an operation to see the debug output
$s3->listBuckets();

または、以下のキーを持つ連想配列を指定できます。

$s3 = new Aws\S3\S3Client([
    'region'  => 'us-west-2',
    'debug'   => [
        'logfn'        => function ($msg) { echo $msg . "\n"; },
        'stream_size'  => 0,
        'scrub_auth'   => true,
        'http'         => true,
        'auth_headers' => [
            'X-My-Secret-Header' => '[REDACTED]',
        ],
        'auth_strings' => [
            '/SuperSecret=[A-Za-z0-9]{20}/i' => 'SuperSecret=[REDACTED]',
        ],
    ]
]);

// Perform an operation to see the debug output
$s3->listBuckets();

stats

転送統計を SDK オペレーションによって返されるエラーと結果にバインドします。

true に設定すると、送信されたリクエストに関する統計情報が収集されます。

$s3 = new Aws\S3\S3Client([
    'region'  => 'us-west-2',
    'stats'   => true
]);

// Perform an operation
$result = $s3->listBuckets();
// Inspect the stats
$stats = $result['@metadata']['transferStats'];

または、以下のキーを持つ連想配列を指定できます。

$s3 = new Aws\S3\S3Client([
    'region'  => 'us-west-2',
    'stats'   => [
        'retries'      => true,
        'timer'        => false,
        'http'         => true,
    ]
]);

// Perform an operation
$result = $s3->listBuckets();
// Inspect the HTTP transfer stats
$stats = $result['@metadata']['transferStats']['http'];
// Inspect the number of retries attempted
$stats = $result['@metadata']['transferStats']['retries_attempted'];
// Inspect the total backoff delay inserted between retries
$stats = $result['@metadata']['transferStats']['total_retry_delay'];

エンドポイント

ウェブサービスの完全な URI。これは、アカウント固有のエンドポイントを使用する AWS Elemental MediaConvert などのサービスに必須です。これらのサービスについては、describeEndpoints メソッドを使用してこのエンドポイントをリクエストしてください。

これは、カスタムエンドポイント (例: Amazon S3 または Amazon DynamoDB Local のローカルバージョン) に接続する場合にのみ必要です。

Amazon DynamoDB ローカルへの接続の例を次に示します。

$client = new Aws\DynamoDb\DynamoDbClient([
    'version'  => '2012-08-10',
    'region'   => 'us-east-1',
    'endpoint' => 'http://localhost:8000'
]);

使用可能なAWS リージョンとエンドポイントのリストについては、 AWS リージョンとエンドポイントを参照してください。

endpoint_provider

「サービス」や「リージョン」キーなど、オプションのハッシュを受け入れる EndpointProviderV2 または PHP callable のオプションインスタンス。NULL またはエンドポイントデータのハッシュ (「エンドポイント」キーが必要) を返します。

最小限のエンドポイントプロバイダーを作成する方法の例を次に示します。

$provider = function (array $params) {
    if ($params['service'] == 'foo') {
        return ['endpoint' => $params['region'] . '.example.com'];
    }
    // Return null when the provider cannot handle the parameters
    return null;
});

endpoint_discovery

エンドポイント検出は、エンドポイント検出をサポートするサービス API の正しいエンドポイントを識別して接続します。エンドポイント検出をサポートするが、これを必要としないサービスの場合、クライアントの作成中に endpoint_discovery を有効にします。サービスがエンドポイント検出をサポートしていない場合、この設定は無視されます。

Aws\EndpointDiscovery\ConfigurationInterface

サービスが指定するオペレーションのために、サービス API の適切なエンドポイントへの自動接続を有効にするオプションの設定プロバイダー。

Aws\EndpointDiscovery\Configuration オブジェクトでは 2 つのオプションを使用できます。1 つはエンドポイント検出が有効な場合にそれを示すブール値「enabled」で、もう 1 つはエンドポイントキャッシュのキーの最大数を示す整数「cache_limit」です。

作成されるクライアントごとに、エンドポイント検出の特定の設定を使用するために Aws\EndpointDiscovery\Configuration オブジェクトを渡します。

use Aws\EndpointDiscovery\Configuration;
use Aws\S3\S3Client;

$enabled = true;
$cache_limit = 1000;

$config = new Aws\EndpointDiscovery\Configuration (
    $enabled,
    $cache_limit
);

$s3 = new Aws\S3\S3Client([
    'region' => 'us-east-2',
    'endpoint_discovery' => $config,

]);

複数のプロセスにわたってエンドポイント検出で返される値をキャッシュするために、Aws\CacheInterface のインスタンスを渡します。

use Aws\DoctrineCacheAdapter;
use Aws\S3\S3Client;
use Doctrine\Common\Cache\ApcuCache;

$s3 = new S3Client([
    'region'      => 'us-west-2',
    'endpoint_discovery' => new DoctrineCacheAdapter(new ApcuCache),
]);

エンドポイント検出に配列を渡します。

use Aws\S3\S3Client;

$s3 = new S3Client([
    'region'      => 'us-west-2',
    'endpoint_discovery' => [
        'enabled' => true,
        'cache_limit' => 1000
    ],
]);

handler

コマンドオブジェクトとリクエストオブジェクトを受け入れて、GuzzleHttp\Promise\PromiseInterface オブジェクトで満たすかまたは Aws\ResultInterface で拒否する promise (Aws\Exception\AwsException) を返すハンドラーです。ハンドラーはターミナルであり、コマンドを満たすことになっているため、ハンドラーは next ハンドラーを受け入れません。ハンドラーが指定されていない場合は、デフォルトの Guzzle ハンドラーが使用されます。

Aws\MockHandler を使用して、模擬結果を返すか、または Mock 例外をスローできます。結果または例外をキューに入れると、 MockHandler はそれらを FIFO 順にキューに入れます。

use Aws\Result;
use Aws\MockHandler;
use Aws\DynamoDb\DynamoDbClient;
use Aws\CommandInterface;
use Psr\Http\Message\RequestInterface;
use Aws\Exception\AwsException;

$mock = new MockHandler();

// Return a mocked result
$mock->append(new Result(['foo' => 'bar']));

// You can provide a function to invoke; here we throw a mock exception
$mock->append(function (CommandInterface $cmd, RequestInterface $req) {
    return new AwsException('Mock exception', $cmd);
});

// Create a client with the mock handler
$client = new DynamoDbClient([
    'region' => 'us-east-1',
    'handler' => $mock
]);

// Result object response will contain ['foo' => 'bar']
$result = $client->listTables();

// This will throw the exception that was enqueued
$client->listTables();

http

HTTP によって作成された HTTP リクエストと転送に適用される一連の SDK オプションに設定します。

SDK では、次の設定オプションがサポートされています。

cert

PEM 形式のクライアント側の証明書を指定します。

use Aws\S3\S3Client;

$client = new S3Client([
    'region'  => 'us-west-2',
    'http'    => ['cert' => '/path/to/cert.pem']
]);

use Aws\S3\S3Client;

$client = new S3Client([
    'region'  => 'us-west-2',
    'http'    => [
        'cert' => ['/path/to/cert.pem', 'password']
    ]
]);

connect_timeout

サーバーへの接続の試行時に待機する秒数を記述する浮動小数点。0 に設定すると、無期限に待機します (デフォルト動作)。

use Aws\DynamoDb\DynamoDbClient;

// Timeout after attempting to connect for 5 seconds
$client = new DynamoDbClient([
    'region'  => 'us-west-2',
    'http'    => [
        'connect_timeout' => 5
    ]
]);

デバッグ

基盤となる HTTP ハンドラーにデバッグ情報を出力するように指示します。Word HTTPハンドラーによって提供されるデバッグ情報は異なります。

decode_content

基盤となる HTTP ハンドラーに、圧縮レスポンスの本文を膨張させるよう指示します。有効になっていない場合、圧縮されたレスポンス本文は GuzzleHttp\Psr7\InflateStream を使用して解凍されます。

use Aws\S3\S3Client;
use GuzzleHttp\Psr7\InflateStream;

$client = new S3Client([
    'region'  => 'us-west-2',
    'http'    => ['decode_content' => false],
]);

$result = $client->getObject([
    'Bucket' => 'amzn-s3-demo-bucket',
    'Key'    => 'massize_gzipped_file.tgz'
]);

$compressedBody = $result['Body']; // This content is still gzipped
$inflatedBody = new InflateStream($result['Body']); // This is now readable

delay

リクエストを送信する前の遅延の時間数 (ミリ秒単位)。これは、リクエストを再試行する前に遅延するためによく使用されます。

expect

このオプションは、基盤となる HTTP ハンドラーに渡されます。デフォルトでは、リクエストの本文が 1 MB を超えたときに Expect: 100-Continue ヘッダーが設定されます。true または false により、すべてのリクエストでヘッダーが有効または無効になります。整数を使用する場合、この設定を超える本文を持つリクエストのみが、ヘッダーを使用します。整数として使用した場合、本文のサイズが不明なときは Expect ヘッダーが送信されます。

progress

転送の進行状況が作成されたときに呼び出す関数を定義します。この関数は以下の次の引数を受け入れます。

use Aws\S3\S3Client;

$client = new S3Client([
    'region'  => 'us-west-2'
]);

// Apply the http option to a specific command using the "@http"
// command parameter
$result = $client->getObject([
    'Bucket' => 'amzn-s3-demo-bucket',
    'Key'    => 'large.mov',
    '@http' => [
        'progress' => function ($expectedDl, $dl, $expectedUl, $ul) {
            printf(
                "%s of %s downloaded, %s of %s uploaded.\n",
                $expectedDl,
                $dl,
                $expectedUl,
                $ul
            );
        }
    ]
]);

proxy

proxy オプションを使用して、プロキシ経由で AWS サービスに接続できます。

use Aws\DynamoDb\DynamoDbClient;

// Send requests through a single proxy
$client = new DynamoDbClient([
    'region'  => 'us-west-2',
    'http'    => [
        'proxy' => 'http://192.168.16.1:10'
    ]
]);

// Send requests through a different proxy per scheme
$client = new DynamoDbClient([
    'region'  => 'us-west-2',
    'http'    => [
        'proxy' => [
            'http' => 'tcp://192.168.16.1:10',
            'https' => 'tcp://192.168.16.1:11',
        ]
    ]
]);

HTTP_PROXY 環境変数を使用して「http」プロトコル固有のプロキシを、HTTPS_PROXY 環境変数を使用して「https」固有のプロキシをそれぞれ設定できます。

sink

sink オプションは、オペレーションのレスポンスデータのダウンロード先を制御します。

synchronous

synchronous オプションは、結果をブロックする予定の基になる HTTP ハンドラーに通知します。

ストリーム

を trueに設定して、ウェブサービスからレスポンスのレスポンス本文を事前にダウンロードするのではなく、そのレスポンス本文をストリーミングするように基になる HTTP ハンドラーに指示します。例えば、Amazon S3 のストリームラッパークラスでは、データが確実にストリーミングされるように、このオプションを使用します。

timeout

リクエストのタイムアウトを秒数で記述する浮動小数点。0 に設定すると、無期限に待機します (デフォルト動作)。

use Aws\DynamoDb\DynamoDbClient;

// Timeout after 5 seconds
$client = new DynamoDbClient([
    'region'  => 'us-west-2',
    'http'    => [
        'timeout' => 5
    ]
]);

認証

verify http オプションを使用して、SDK のピア SSL/TLS 証明書の検証動作をカスタマイズできます。

システムの CA バンドルが見つからず、エラーが表示された場合は、 SDK への CA バンドルへのパスを指定します。特定の CA バンドルが必要ない場合、Mozilla は一般的に使用される CA バンドルを提供しており、ここでダウンロードできます (これは cURL のメンテナーによって維持されます）。ディスクで CA バンドルを使用できるようになったら、ファイルへのパスを指すように openssl.cafile PHP .ini 設定を設定して、verifyリクエストオプションを省略できます。詳細については、cURL ウェブサイトの SSL 証明書を参照してください。

use Aws\DynamoDb\DynamoDbClient;

// Use a custom CA bundle
$client = new DynamoDbClient([
    'region'  => 'us-west-2',
    'http'    => [
        'verify' => '/path/to/my/cert.pem'
    ]
]);

// Disable SSL/TLS verification
$client = new DynamoDbClient([
    'region'  => 'us-west-2',
    'http'    => [
        'verify' => false
    ]
]);

http_handler

http_handler オプションは、SDK を他の HTTP クライアントと統合するために使用されます。http_handler オプションは、Psr\Http\Message\RequestInterface オブジェクトと、コマンドに適用する http オプションの配列を受け入れて、GuzzleHttp\Promise\PromiseInterface オブジェクトで満たすかまたは以下の例外データで拒否する Psr\Http\Message\ResponseInterface オブジェクトを返す関数です。

SDK は、提供された をAws\WrappedHttpHandlerオブジェクトhttp_handlerでラップすることで、指定された を通常のhandlerオプションhttp_handlerに自動的に変換します。

デフォルトでは、SDK は HTTP ハンドラーとして Guzzle を使用します。ここで別の HTTP ハンドラーを指定するか、独自のカスタム定義オプションを Guzzle クライアントに提供できます。

TLS バージョンの設定

1 つのユースケースは、Curl が環境にインストールされていると仮定して、Guzzle with Curl で使用される TLS バージョンを設定することです。サポートされている TLS のバージョンに関する Curl バージョンの制約に注意してください。デフォルトでは、最新バージョンが使用されます。TLS バージョンが明示的に設定されていて、リモートサーバーがこのバージョンをサポートしていない場合、以前の TLS バージョンを使用する代わりにエラーが発生します。

クライアントオプションを true に設定し、TLS 接続出力を調べることで、特定のdebugクライアントオペレーションに使用される SSL バージョンを決定できます。その行は次のようになります。SSL connection using TLSv1.2

Guzzle 6 での TLS 1.2 の設定例：

use Aws\DynamoDb\DynamoDbClient;
use Aws\Handler\GuzzleV6\GuzzleHandler;
use GuzzleHttp\Client;

$handler = new GuzzleHandler(
    new Client([
        'curl' => [
            CURLOPT_SSLVERSION => CURL_SSLVERSION_TLSv1_2
        ]
    ])
);

$client = new DynamoDbClient([
    'region'  => 'us-west-2',
    'http_handler' => $handler
]);

profile

「プロファイル」オプションは、HOME ディレクトリの認証情報ファイル (通常は ) から AWS 認証情報が作成されたときに使用するプロファイルを指定します~/.aws/credentials。この設定は AWS_PROFILE 環境変数をオーバーライドします。

// Use the "production" profile from your credentials file
$ec2 = new Aws\Ec2\Ec2Client([
    'version' => '2014-10-01',
    'region'  => 'us-west-2',
    'profile' => 'production'
]);

認証情報と .ini ファイル形式の設定の詳細については、 AWS SDK for PHP バージョン 3 の認証情報を参照してください。

region

AWS 接続先のリージョン。利用可能なリージョンのリストについては、「AWS のリージョンとエンドポイント」を参照してください。

// Set the Region to the EU (Frankfurt) Region
$s3 = new Aws\S3\S3Client([
    'region'  => 'eu-central-1',
    'version' => '2006-03-01'
]);

retries

クライアントに対して再試行モードと許可される最大再試行回数を設定します。0 を渡すと、再試行が無効になります。

次の 3 つの再試行モードがあります。

再試行の設定は、モードと各リクエストに使用される最大試行回数で構成されます。設定は、次の優先順位に従って、いくつかの異なる場所で設定できます。

優先順位

再試行設定の優先順位は次のとおりです (1 は 2-3 を上書きします)。

環境変数

共有 Config ファイルキー

クライアント設定

次の例では、Amazon DynamoDB クライアントの再試行を無効にしています。

// Disable retries by setting "retries" to 0
$client = new Aws\DynamoDb\DynamoDbClient([
    'version' => '2012-08-10',
    'region'  => 'us-west-2',
    'retries' => 0
]);

次の例では、整数を渡します。デフォルトでは、再試行回数が渡された状態で legacy モードになります。

// Disable retries by setting "retries" to 0
$client = new Aws\DynamoDb\DynamoDbClient([
    'version' => '2012-08-10',
    'region'  => 'us-west-2',
    'retries' => 6
]);

再試行設定の Aws\Retry\Configuration オブジェクトを渡します。

use Aws\EndpointDiscovery\Configuration;
use Aws\S3\S3Client;

$enabled = true;
$cache_limit = 1000;

$config = new Aws\Retry\Configuration('adaptive', 10);

$s3 = new Aws\S3\S3Client([
    'region' => 'us-east-2',
    'retries' => $config,
]);

この例では、再試行設定のために配列を渡します。

use Aws\S3\S3Client;

$s3 = new S3Client([
    'region' => 'us-west-2',
    'retries' => [
        'mode' => 'standard',
        'max_attempts' => 7
    ],
]);

この例では、Aws\CacheInterface のインスタンスを渡して、デフォルトの再試行設定プロバイダーから返された値をキャッシュします。

use Aws\DoctrineCacheAdapter;
use Aws\S3\S3Client;
use Doctrine\Common\Cache\ApcuCache;

$s3 = new S3Client([
    'region' => 'us-west-2',
    'endpoint_discovery' => new DoctrineCacheAdapter(new ApcuCache),
]);

scheme

接続時に使用するURIスキーム。SDK はデフォルトで「https」エンドポイントを使用します (つまり、SSL/TLS 接続を使用します）。scheme を「http」に設定することによって、暗号化されていない「http」エンドポイントでのサービスへの接続を試行できます。

$s3 = new Aws\S3\S3Client([
    'version' => '2006-03-01',
    'region'  => 'us-west-2',
    'scheme'  => 'http'
]);

エンドポイントの一覧と http スキームをサポートするサービスについては、「AWS のリージョンとエンドポイント」を参照してください。

service

使用するサービスの名前。この値は、SDK によって提供されるクライアント ( などAws\S3\S3Client) を使用する場合にデフォルトで提供されます。このオプションは、SDK でまだ公開されていないが、ディスクで利用可能なサービスをテストする場合に役立ちます。

signature_provider

署名バージョン名 (例: v4）、サービス名、 AWS リージョンを受け入れ、Aws\Signature\SignatureInterfaceオブジェクトを返すか、プロバイダーが特定のパラメータの署名者を作成できるNULL場合に呼び出せる。このプロバイダは、クライアントで使用される署名者を作成するために使用されます。

クラスには、カスタマイズされた署名プロバイダーの作成Aws\Signature\SignatureProviderに使用できる SDK によって提供されるさまざまな関数があります。

signature_version

サービスで使用されるカスタム署名バージョンを表す文字列 (例: v4)。オペレーションごとの署名バージョン MAY は、必要に応じて、このリクエストされた署名バージョンを上書きします。

次の例は、署名バージョン 4 を使用するように Amazon S3 クライアントを設定する方法を示しています。

// Set a preferred signature version
$s3 = new Aws\S3\S3Client([
    'version'           => '2006-03-01',
    'region'            => 'us-west-2',
    'signature_version' => 'v4'
]);

ua_append

HTTP ハンドラーに渡されるユーザーエージェント文字列に追加される文字列の文字列または配列。

use_aws_shared_config_files

false に設定して、「~/.aws/config’ and ‘~/.aws/credentials」で共有設定ファイルの確認を無効にします。これにより、AWS_CONFIG_FILE 環境変数が上書きされます。

validate

false に設定すると、クライアント側のパラメーター検証が無効になります。検証をオフにすると、クライアントのパフォーマンスがわずかに向上することがありますが、その違いは無視できる程度です。

// Disable client-side validation
$s3 = new Aws\S3\S3Client([
    'version'  => '2006-03-01',
    'region'   => 'eu-west-1',
    'validate' => false
]);

検証オプションの連想配列に設定すると、以下の特定の検証の制約が有効になります。

// Validate only that required values are present
$s3 = new Aws\S3\S3Client([
    'version'  => '2006-03-01',
    'region'   => 'eu-west-1',
    'validate' => ['required' => true]
]);

version

このオプションは、使用するウェブサービスのバージョン (例: 2006-03-01) を指定します。

SDK のバージョン 3.277.10 以降では、「バージョン」オプションは必要ありません。「バージョン」オプションを指定しない場合、SDK はサービスクライアントの最新バージョンを使用します。

サービスクライアントを作成するときに「version」パラメータが必要なのは 2 つの状況です。

例えば、次のスニペットは SDK のバージョン 3.279.7 を使用しますが、 の最新バージョンは使用しませんEc2Client。

$ec2Client = new \Aws\Ec2\Ec2Client([
    'version' => '2015-10-01',
    'region' => 'us-west-2'
]);

バージョン制約を指定すると、サービスに対して行われた互換性を破る変更の影響を受けないことが保証されます。

使用可能な API バージョンのリストは、各クライアントの API ドキュメントページにあります。特定の API バージョンをロードできない場合は、SDK のコピーを更新する必要がある場合があります。