翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。 # AWS SDK for PHP バージョン 3 の開始方法 この章では、AWS SDK for PHP バージョン 3 の使用を開始する方法について説明します。 **Topics** + [前提条件](getting-started_requirements.md) + [インストール](getting-started_installation.md) + [による認証 AWS](credentials.md) + [シンプルなアプリケーションの作成](hello.md) + [SDK AWS Cloud9 で を使用する](cloud9.md) # AWS SDK for PHP バージョン 3 の要件と推奨事項 で最良の結果を得るには AWS SDK for PHP、環境が以下の要件と推奨事項をサポートしていることを確認してください。 ## 要件 を使用するには AWS SDK for PHP、[SimpleXML PHP 拡張機能が有効になっている PHP](https://www.php.net/manual/en/book.simplexml.php) バージョン 8.1 以降を使用する必要があります。Amazon CloudFront のプライベート URL に署名する必要がある場合は、[OpenSSL PHP 拡張機能](http://php.net/manual/en/book.openssl.php)も必要です。 ## 推奨事項 最小要件に加えて、以下をインストール、アンインストール、および使用することもお勧めします。 **** | | | | --- |--- | | [cURL](http://php.net/manual/en/book.curl.php) 7.16.2 以降をインストールする | OpenSSL/NSS および zlib でコンパイルされている最新バージョンの cURL を使用します。cURL がシステムにインストールされていなくて、クライアント用のカスタム http\$1handler を設定していない場合、SDK では PHP ストリームラッパーが使用されます。 | | [OPCache](http://php.net/manual/en/book.opcache.php) を使用する | OPcache 拡張機能を使用して、事前コンパイルされたスクリプトバイトコードを共有メモリに格納することによって、PHP のパフォーマンスが向上します。そうすることにより、各リクエストに対して PHP がスクリプトをロードして解析する必要がなくなります。この拡張機能は、通常はデフォルトで有効になっています。 Amazon Linux を実行している場合に OPCache 拡張機能を使用するには、php56-opcache または php55-opcache の yum パッケージをインストールする必要があります。 | | 実稼働環境で [Xdebug](http://xdebug.org/) をアンインストールする | Xdebug はパフォーマンスのボトルネックの特定に役立ちます。ただし、パフォーマンスを重視するアプリケーションの場合は、本稼働環境に Xdebug 拡張機能をインストールしないでください。この拡張機能をロードすると、SDK のパフォーマンスが大幅に低下します。 | | [Composer](http://getcomposer.org) の classmap 自動ローダーを使用する | 自動ローダーは、PHP スクリプトで必要になったときにクラスをロードします。Composer は、アプリケーションの PHP スクリプトおよびアプリケーションで必要な他のすべての PHP スクリプト ( AWS SDK for PHPを含む) を自動ロードできる自動ローダーを生成します。 本稼働環境では、自動ローダーのパフォーマンスを向上させるために classmap 自動ローダーを使用することをお勧めします。classmap 自動ローダーは、Composer のインストールコマンドに `-o` または `==optimize-autoloader` オプションを渡すことによって生成できます。 | ## 互換性テスト SDK コードベースにある [https://github.com/aws/aws-sdk-php/blob/master/compatibility-test.php](https://github.com/aws/aws-sdk-php/blob/master/compatibility-test.php) ファイルを実行して、使用するシステムで SDK を実行できることを確認します。互換性テストでは、SDK の最小システム要件を満たしていることだけでなく、オプションの設定もチェックされ、パフォーマンスを向上させるのに役立つ推奨事項が提示されます。互換性テストでは、コマンドラインまたはウェブブラウザのいずれかに結果が出力されます。テスト結果をブラウザで確認する場合、成功したチェックは緑色で、警告は紫色で、失敗は赤色で表示されます。コマンドラインで実行した場合は、項目ごとのチェック結果が個別の行に出力されます。 SDK に関する問題がレポートされている場合は、互換性テストの結果を共有すると、根本的な原因の特定に役立ちます。 # AWS SDK for PHP バージョン 3 のインストール AWS SDK for PHP バージョン 3 をインストールできます。 + Composer を介して依存関係として + SDK のパッケージ済み phar として + SDK の ZIP ファイルとして AWS SDK for PHP バージョン 3 をインストールする前に、環境が PHP バージョン 8.1 以降を使用していることを確認してください。[環境の要件と推奨事項](getting-started_requirements.md)の詳細を確認してください。 **注記** .phar および .zip 形式で SDK をインストールする場合は、[マルチバイト文字列 PHP 拡張機能](https://www.php.net/manual/en/book.mbstring.php)を別途インストールして有効にする必要があります。 ## Composer 経由で依存関係 AWS SDK for PHP として をインストールする AWS SDK for PHPをインストールするには Composer を使用する方法をお勧めします。Composer は、プロジェクトの依存関係を管理およびインストールする PHP 用のツールです。 Composer のインストール方法、自動ロードの設定方法、および依存関係定義の他のベストプラクティスに従う方法の詳細については、[getcomposer.org](http://getcomposer.org) を参照してください。 ### Composer をインストールする Composer がまだプロジェクトにない場合は、[Composer をダウンロードページ](http://getcomposer.org/download)で Composer をダウンロードしてインストールします。 + **Windows** の場合、Windows Installer の指示に従ってください。 + **Linux** の場合、コマンド行インストールの指示に従います。 ### Composer 経由で依存関係 AWS SDK for PHP として を追加する [Composer がシステムに既にグローバルにインストール](https://getcomposer.org/doc/00-intro.md#globally)されている場合は、プロジェクトのベースディレクトリで以下を実行して、依存関係 AWS SDK for PHP として をインストールします。 ``` $ composer require aws/aws-sdk-php ``` それ以外の場合は、この Composer コマンドを入力し、依存関係として AWS SDK for PHP の最新バージョンをインストールします。 ``` $ php -d memory_limit=-1 composer.phar require aws/aws-sdk-php ``` ### php スクリプトに自動ローダーを追加する Composer をインストールすると、複数のフォルダとファイルが環境に作成されます。最初に使用するファイルは `autoload.php` です。これは 環境 の `vendor` フォルダにあります。 スクリプト AWS SDK for PHP で を利用するには、次のようにスクリプトにオートローダーを含めます。 ``` ``` ## パッケージ済み phar を使用したインストール の各リリース AWS SDK for PHP には、SDK の実行に必要なすべてのクラスと依存関係を含むパッケージ化された phar (PHP アーカイブ) が含まれています。さらに、phar は AWS SDK for PHP とそのすべての依存関係のクラスオートローダーを自動的に登録します。 [パッケージ済み phar をダウンロード](https://docs.aws.amazon.com/aws-sdk-php/v3/download/aws.phar)して、スクリプトでインクルードすることができます。 ``` ``` **注記** Suhosin パッチで PHP を使用することはお勧めしませんが、Ubuntu や Debian ディストリビューションではよく使用されています。そうする場合は、suhosin.ini で phar の使用を有効にする必要があります。有効にしていない場合に、コード内で phar ファイルをインクルードすると、エラーが表示されずに失敗します。有効にするには、suhosin.ini に次の行を追加します。 ``` suhosin.executor.include.whitelist = phar ``` ## ZIP ファイルを使用したインストール には、SDK の実行に必要なすべてのクラスと依存関係を含む ZIP ファイル AWS SDK for PHP が含まれています。また、その ZIP ファイルには、 AWS SDK for PHP 用のクラスの自動ローダーとその依存関係が含まれています。 SDK をインストールするには、[.zip ファイルをダウンロード](https://docs.aws.amazon.com/aws-sdk-php/v3/download/aws.zip)し、プロジェクト内の任意の場所に展開します。次に、スクリプトで次のように自動ローダーをインクルードします。 ``` ``` # AWS SDK for PHP バージョン 3 AWS を使用した での認証 で開発 AWS するときに、コードが で認証される方法を確立する必要があります AWS のサービス。 AWS リソースへのプログラムによるアクセスは、環境と利用可能な AWS アクセスに応じてさまざまな方法で設定できます。 認証方法を選択して SDK 用に設定するには、*AWS SDK とツールのリファレンスガイド*の「[認証とアクセス](https://docs.aws.amazon.com/sdkref/latest/guide/access.html)」を参照してください。 ## ローカル開発用に IAM アイデンティティセンターで認証を設定する ローカルで開発中で、雇用主から認証方法が与えられていない新しいユーザーは、 を設定することをお勧めします AWS IAM アイデンティティセンター。この方法には、設定を容易に AWS CLI するために をインストールすることや、 AWS アクセスポータルに定期的にサインインすることが含まれます。この方法を選択した場合、*AWS SDK とツールのリファレンスガイド*の [IAM Identity Center 認証](https://docs.aws.amazon.com/sdkref/latest/guide/access-sso.html)の手順を完了したあと、環境には次の要素が含まれるはずです。 + アプリケーションを実行する前に AWS アクセスポータルセッションを開始 AWS CLIするために使用する 。 + SDK が参照できる、設定値のセットを含む `[default]` プロファイルがある[共有 AWS`config` ファイル](https://docs.aws.amazon.com/sdkref/latest/guide/file-format.html)。このファイルの場所を確認するには、「*AWS SDK とツールのリファレンスガイド*」の「[共有ファイルの場所](https://docs.aws.amazon.com/sdkref/latest/guide/file-location.html)」を参照してください。 + 共有 `config` ファイルには [https://docs.aws.amazon.com/sdkref/latest/guide/feature-region.html](https://docs.aws.amazon.com/sdkref/latest/guide/feature-region.html) 設定が含まれます。これにより、SDK AWS リージョン がリクエストに使用するデフォルトが設定されます。このリージョンは、`region` プロパティで明示的に設定されていない SDK サービスリクエストに使用されます。 + SDK は、リクエストを AWSに送信する前に、プロファイルの [SSO トークンプロバイダー設定](https://docs.aws.amazon.com/sdkref/latest/guide/feature-sso-credentials.html#feature-sso-credentials-profile)を使用して認証情報を取得します。`sso_role_name` 値は、IAM Identity Center アクセス許可セットに接続された IAM ロールであり、アプリケーションで AWS のサービス 使用されている へのアクセスを許可します。 次のサンプル `config` ファイルは、SSO トークンプロバイダー設定で設定されたデフォルトプロファイルを示しています。プロファイルの `sso_session` 設定は、指定された [`sso-session` セクション](https://docs.aws.amazon.com/sdkref/latest/guide/file-format.html#section-session)を参照します。`sso-session` セクションには、 AWS アクセスポータルセッションを開始するための設定が含まれています。 ``` [default] sso_session = my-sso sso_account_id = 111122223333 sso_role_name = SampleRole region = us-east-1 output = json [sso-session my-sso] sso_region = us-east-1 sso_start_url = https://provided-domain.awsapps.com/start sso_registration_scopes = sso:account:access ``` IAM Identity Center 認証を使用するには、アプリケーションに追加のパッケージ ( `SSO`や など`SSOOIDC`) AWS SDK for PHP は必要ありません。 ## AWS アクセスポータルセッションを開始する アクセスするアプリケーションを実行する前に AWS のサービス、SDK が IAM Identity Center 認証を使用して認証情報を解決するためのアクティブな AWS アクセスポータルセッションが必要です。設定したセッションの長さによっては、アクセスが最終的に期限切れになり、SDK で認証エラーが発生します。 AWS アクセスポータルにサインインするには、 で次のコマンドを実行します AWS CLI。 ``` aws sso login ``` ガイダンスに従い、デフォルトのプロファイルを設定している場合は、`--profile` オプションを指定してコマンドを呼び出す必要はありません。SSO トークンプロバイダー設定で名前付きプロファイルを使用している場合、コマンドは `aws sso login --profile named-profile` です。 アクティブなセッションが既にあるかどうかをオプションでテストするには、次の AWS CLI コマンドを実行します。 ``` aws sts get-caller-identity ``` セッションがアクティブな場合、このコマンドへの応答により、共有 `config` ファイルに設定されている IAM Identity Center アカウントとアクセス許可のセットが報告されます。 **注記** 既にアクティブな AWS アクセスポータルセッションがあり、 を実行している場合は`aws sso login`、認証情報を指定する必要はありません。 サインインプロセスにより、データ AWS CLI へのアクセスを許可するように求められる場合があります。 AWS CLI は SDK for Python 上に構築されているため、アクセス許可メッセージには`botocore`名前のバリエーションが含まれている可能性があります。 ## 認証の詳細 + 認証に IAM アイデンティティセンターを使用する方法の詳細については、「*AWS SDK とツールリファレンスガイド*[の「IAM アイデンティティセンター認証を理解する](https://docs.aws.amazon.com/sdkref/latest/guide/understanding-sso.html)」を参照してください。 + ベストプラクティスの詳細については、*IAM ユーザーガイド*の「[IAM でのセキュリティのベストプラクティス](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html)」を参照してください。 + 短期 AWS 認証情報を作成するには、*IAM ユーザーガイド*の[「一時的なセキュリティ認証情報](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html)」を参照してください。 + AWS SDK for PHP が使用できるその他の認証情報プロバイダーについては、「*AWS SDK とツールのリファレンスガイド*」の「[標準化された認証情報プロバイダー](https://docs.aws.amazon.com/sdkref/latest/guide/standardized-credentials.html)」を参照してください。 # AWS SDK for PHP バージョン 3 を使用したシンプルなアプリケーションの作成 AWS SDK for PHP を使用して Amazon S3 に挨拶してください。次の例では、すべての Amazon S3 バケットのリストを表示します。 ## 前提条件 + [SDK をダウンロードしてインストールする](getting-started_installation.md) + AWS SDK for PHP を使用する前に、AWS で認証を設定する必要があります。認証の設定の詳細については、「[AWS SDK for PHP バージョン 3 AWS を使用した での認証](credentials.md)」を参照してください。 ## コードで SDK をインクルードする どのような手法で SDK でインストールにしたかにかかわらず、1 つの `require` ステートメントだけで SDK をインクルードできます。インストール手法に最適な PHP コードについては、次の表を参照してください。`/path/to/` は、使用しているシステムでの実際のパスに置き換えます。 **** | インストール手法 | require ステートメント | | --- | --- | | Composer の使用 | `require '/path/to/vendor/autoload.php';` | | phar の使用 | `require '/path/to/aws.phar';` | | ZIP の使用 | `require '/path/to/aws-autoloader.php';` | このトピックでは、Composer のインストール方法を示します。別のインストール方法を使用している場合は、このセクションを参照して適切な `require` コードを見つけてください。 ## コードを書き込む 認証できることを確認します。 次のコードをコピーし、新しいソースファイルに貼り付けます。ファイルを保存して `hello-s3.php` という名前を付けます。 ``` 'default', 'region' => 'us-west-2', 'version' => '2006-03-01' ]); //Listing all S3 Bucket $buckets = $s3Client->listBuckets(); foreach ($buckets['Buckets'] as $bucket) { echo $bucket['Name'] . "\n"; } ``` ## プログラムの実行 PHP プログラムを実行するには、コマンドプロンプトを開きます。PHP プログラムを実行する一般的なコマンド構文は次のとおりです。 ``` php [source filename] [arguments...] ``` このサンプルコードは引数を使用しません。このコードを実行するには、コマンドプロンプトで以下を入力します。 ``` $ php hello-s3.php ``` ## 次のステップ その他の多くの Amazon S3 オペレーションをテストするには、GitHub で [AWS のコードサンプルリポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/blob/main/php/example_code/s3)を確認してください。 # AWS SDK for PHP バージョン 3 AWS Cloud9 で を使用する **注記** AWS Cloud9 は新規顧客には利用できなくなりました。の既存のお客様は、通常どおりサービスを AWS Cloud9 引き続き使用できます。[詳細はこちら](https://aws.amazon.com/blogs/devops/how-to-migrate-from-aws-cloud9-to-aws-ide-toolkits-or-aws-cloudshell/)。 AWS Cloud9 はウェブベースの統合開発環境 (IDE) であり、クラウド内のソフトウェアのコーディング、構築、実行、テスト、デバッグ、リリースに使用するツールのコレクションが含まれています。 AWS Cloud9 で を使用すると AWS SDK for PHP 、ブラウザを使用して PHP コードを記述して実行できます。 には、コードエディタやターミナルなどのツール AWS Cloud9 が含まれています。 AWS Cloud9 IDE はクラウドベースのため、インターネットに接続されたマシンを使用して、オフィス、自宅、またはどこからでもプロジェクトに取り組むことができます。の一般的な情報については AWS Cloud9、[AWS Cloud9 「 ユーザーガイド](https://docs.aws.amazon.com/cloud9/latest/user-guide/welcome.html)」を参照してください。 以下の手順に従って、 AWS Cloud9 で をセットアップします AWS SDK for PHP。 + [ステップ 1: を使用する AWS アカウント ように を設定する AWS Cloud9](#cloud9-php-account) + [ステップ 2: AWS Cloud9 開発環境を設定する](#cloud9-php-environment) + [ステップ 3: をセットアップする AWS SDK for PHP](#cloud9-php-sdk) + [ステップ 4: サンプルコードをダウンロードする](#cloud9-php-examples) + [ステップ 5: コード例を実行する](#cloud9-php-run) ## ステップ 1: を使用する AWS アカウント ように を設定する AWS Cloud9 を使用するには AWS Cloud9、 から AWS Cloud9 コンソールにサインインします AWS マネジメントコンソール。 **注記** 認証 AWS IAM アイデンティティセンター に を使用している場合は、IAM コンソールのユーザーアタッチポリシー`iam:ListInstanceProfilesForRole`に の必要なアクセス許可を追加する必要がある場合があります。 コンソールにアクセスしてサインインするように AWS アカウントで IAM エンティティをセットアップするには AWS Cloud9 、*AWS Cloud9 「 ユーザーガイド*」の AWS Cloud9 [「 のチームセットアップ AWS Cloud9](https://docs.aws.amazon.com/cloud9/latest/user-guide/setup.html)」を参照してください。 ## ステップ 2: AWS Cloud9 開発環境を設定する AWS Cloud9 コンソールにサインインしたら、 コンソールを使用して AWS Cloud9 開発環境を作成します。環境を作成すると、 はその環境の IDE AWS Cloud9 を開きます。 詳細については、*AWS Cloud9 ユーザーガイド*の「[AWS Cloud9での環境の作成](https://docs.aws.amazon.com/cloud9/latest/user-guide/create-environment.html)」を参照してください。 **注記** コンソールで始めて環境を作成する際に、[**Create a new instance for environment (EC2)**] (環境の新しいインスタンスを作成する) (EC2) オプションを選択することをお勧めします。このオプションは、 に環境を作成し、Amazon EC2 インスタンスを起動して、新しいインスタンスを新しい環境に接続する AWS Cloud9 ように指示します。これは、 の使用を開始する最も速い方法です AWS Cloud9。 IDE でターミナルが開いていない場合は開きます。IDE のメニューバーで、**[Window]、[New Terminal]** の順に選択します。ターミナルウィンドウでツールをインストールし、アプリケーションを構築できます。 ## ステップ 3: をセットアップする AWS SDK for PHP が開発環境の IDE を AWS Cloud9 開いたら、ターミナルウィンドウを使用して環境で をセットアップ AWS SDK for PHP します。 AWS SDK for PHPをインストールするには Composer を使用する方法をお勧めします。Composer は、プロジェクトの依存関係を管理およびインストールする PHP 用のツールです。 Composer のインストール方法、自動ロードの設定方法、および依存関係定義の他のベストプラクティスに従う方法の詳細については、[getcomposer.org](http://getcomposer.org) を参照してください。 ### Composer をインストールする Composer がまだプロジェクトにない場合は、[Composer をダウンロードページ](http://getcomposer.org/download)で Composer をダウンロードしてインストールします。 + **Windows** の場合、Windows Installer の指示に従ってください。 + **Linux** の場合、コマンド行インストールの指示に従います。 ### Composer 経由で依存関係 AWS SDK for PHP として を追加する [Composer がシステムに既にグローバルにインストール](https://getcomposer.org/doc/00-intro.md#globally)されている場合は、プロジェクトのベースディレクトリで以下を実行して、依存関係 AWS SDK for PHP として をインストールします。 ``` $ composer require aws/aws-sdk-php ``` それ以外の場合は、この Composer コマンドを入力し、依存関係として AWS SDK for PHP の最新バージョンをインストールします。 ``` $ php -d memory_limit=-1 composer.phar require aws/aws-sdk-php ``` ### php スクリプトに自動ローダーを追加する Composer をインストールすると、複数のフォルダとファイルが環境に作成されます。最初に使用するファイルは `autoload.php` です。これは 環境 の `vendor` フォルダにあります。 スクリプト AWS SDK for PHP で を利用するには、次のようにスクリプトにオートローダーを含めます。 ``` ``` ## ステップ 4: サンプルコードをダウンロードする ターミナルウィンドウを使用して、 のサンプルコードを 開発環境にダウンロード AWS SDK for PHP します AWS Cloud9 。 公式 AWS SDK ドキュメントで使用されているすべてのコード例のコピーを環境のルートディレクトリにダウンロードするには、次のコマンドを実行します。 ``` $ git clone https://github.com/awsdocs/aws-doc-sdk-examples.git ``` のコード例は `ENVIRONMENT_NAME/aws-doc-sdk-examples/php` ディレクトリにあります AWS SDK for PHP 。ここで、 `ENVIRONMENT_NAME`は開発環境の名前です。 Amazon S3 の例を使用して進めるには、コードサンプル `ENVIRONMENT_NAME/aws-doc-sdk-examples/php/example_code/s3/ListBuckets.php` から始めることをお勧めします。この例では、すべての Amazon S3 バケットを一覧表示します ターミナルウィンドウを使用して `s3` ディレクトリに移動し、ファイルを一覧表示します。 ``` $ cd aws-doc-sdk-examples/php/example_code/s3 $ ls ``` でファイルを開くには AWS Cloud9、ターミナルウィンドウで `ListBuckets.php`を直接クリックします。 コードサンプルについてさらに理解を深めるには、「[AWS SDK for PHP コードサンプル](examples_index.md)」を参照してください。 ## ステップ 5: コードサンプルの実行 AWS Cloud9 開発環境でコードを実行するには、上部のメニューバーにある**実行**ボタンを選択します。 は`.php`ファイル拡張子 AWS Cloud9 を自動的に検出し、**PHP (組み込みウェブサーバー)** ランナーを使用してコードを実行します。ただし、この例では実際には **PHP (`cli`)** オプションが必要です。 AWS Cloud9でコードを実行する際の詳細については、*AWS Cloud9 ユーザーガイド*の「[コードを実行する](https://docs.aws.amazon.com/cloud9/latest/user-guide/build-run-debug.html#build-run-debug-run)」を参照してください。 以下のスクリーンショットでは、次の基本的な点に注意してください。 + 1: 実行します。**[実行]** ボタンは上部のメニューバーにあります。新しいタブが開き、結果が表示されます。 **注記** 新しい実行設定を手動で作成することもできます。メニューバーで、［**Run (実行)**］、［**Run Configurations (実行設定)**］、［**New Run Configuration (新しい実行設定)**］の順に選択します。 + 2: Command. は、**コマンド**テキストボックスに、実行するファイルへのパスとファイル名 AWS Cloud9 を入力します。コードでコマンドラインパラメータを渡す必要がある場合は、ターミナルウィンドウからコードを実行する場合と同じ方法でコマンドラインにパラメータを追加できます。 + 3: Runner. は、ファイル拡張子が であることを AWS Cloud9 検出`.php`し、コードを実行する **PHP (組み込みウェブサーバー)** Runner を選択します。代わりにこの例を実行するには **PHP (`cli`)** を選択してください。 ![\[IDE AWS Cloud9 のトップメニューバーから実行を選択すると、コマンドボックスが入力され、PHP ランナーがすでに選択されている新しいタブが開きます。\]](http://docs.aws.amazon.com/ja_jp/sdk-for-php/v3/developer-guide/images/cloud9_runconfig.png) 実行中のコードから生成された出力はすべてタブに表示されます。