このパッケージは、アマゾン ウェブ サービスへの統合コマンドライン インターフェイスを提供します。
ジャンプ先:
この README は AWS CLI バージョン 1 用です。AWS CLI バージョン 2 に関する情報をお探しの場合は、v2 ブランチにアクセスしてください。
aws-cli パッケージは Python バージョンで動作します。
2022 年 5 月 30 日に、Python 3.6 のサポートが終了しました。これは、2021 年 12 月 23 日に発生した Python Software Foundation のランタイムのサポート終了に続くものです。
2023 年 12 月 13 日に、Python 3.7 のサポートが終了しました。これは、2023 年 6 月 27 日に発生した Python Software Foundation のランタイムのサポート終了に続くものです。詳細については、このブログ投稿を参照してください。
注意!
すべてのお客様には、アマゾン ウェブ サービスのセキュリティ情報 Web サイトを定期的に監視し、aws-cli に関連する重要なセキュリティ情報がないか確認することをお勧めします。
AWS CLI バージョン 1 は、2013 年 9 月 2 日に一般提供され、現在、可用性ライフサイクルの完全サポート段階にあります。
SDK メジャー バージョンとその基礎となる依存関係のメンテナンスとサポートの詳細については、「 AWS SDK およびツールの共有設定および認証情報リファレンス ガイド」の「メンテナンス ポリシー」セクションを参照してください。
AWS CLI とその依存関係のインストールでは、 pip
およびsetuptools
によって提供されるさまざまなパッケージ化機能を使用します。スムーズなインストールを確保するには、次の使用をお勧めします。
pip
: 9.0.2 以降setuptools
: 36.2.0 以降AWS CLI をインストールする最も安全な方法は、 virtualenv
で pip を使用することです。
$ python -m pip install awscli
または、 virtualenv
にインストールしない場合は、グローバルにインストールします。
$ sudo python -m pip install awscli
またはユーザーの場合:
$ python -m pip install --user awscli
aws-cli パッケージがインストールされており、最新バージョンにアップグレードしたい場合は、以下を実行できます。
$ python -m pip install --upgrade awscli
これにより、aws-cli パッケージとすべての依存関係がインストールされます。
注記
macOS では、El Capitan のdistutils
に付属のsix
のバージョンに関するエラーが表示された場合は、 --ignore-installed
オプションを使用します。
$ sudo python -m pip install awscli --ignore-installed six
Linux および Mac OS では、バンドルされたインストーラーを使用して AWS CLI をインストールできます。 AWS CLI は、MSI インストーラーを介して Windows にインストールすることもできます。
AWS CLI のdevelop
ブランチを実行する場合は、寄稿ガイドの「開発バージョン」セクションを参照してください。
詳細については、AWS CLI ユーザーガイドのインストールセクションを参照してください。
AWS CLI を使用する前に、AWS 認証情報を設定する必要があります。これはいくつかの方法で行うことができます。
最も簡単に開始する方法は、 aws configure
コマンドを実行することです。
$ AWS 構成 AWS アクセスキー ID: MYACCESSKEY AWS シークレット アクセス キー: MYSECRETKEY デフォルトのリージョン名 [us-west-2]: us-west-2 デフォルトの出力形式 [なし]: json
環境変数を使用するには、次の手順を実行します。
$export AWS_ACCESS_KEY_ID=<アクセスキー> $export AWS_SECRET_ACCESS_KEY=<秘密キー>
共有認証情報ファイルを使用するには、次のような INI 形式のファイルを作成します。
[デフォルト] aws_access_key_id=MYACCESSKEY aws_secret_access_key=MYSECRETKEY [テスト] aws_access_key_id=MYACCESSKEY aws_secret_access_key=MYSECRETKEY
それを~/.aws/credentials
(Windows の場合は%UserProfile%.aws/credentials
) に配置します。共有認証情報ファイルを上記で指定した場所とは別の場所に置きたい場合は、その場所を aws-cli に指示する必要があります。これを行うには、適切な環境変数を設定します。
$export AWS_SHARED_CREDENTIALS_FILE=/path/to/shared_credentials_file
構成ファイルを使用するには、次のような INI 形式のファイルを作成します。
[デフォルト] aws_access_key_id=<デフォルトのアクセスキー> aws_secret_access_key=<デフォルトの秘密キー> # オプションで、このプロファイルのデフォルトのリージョンを定義します。 地域=米国西部-1 【プロファイルテスト】 aws_access_key_id=<テスト用アクセスキー> aws_secret_access_key=<テスト用秘密キー> 地域=米国西部-2
それを~/.aws/config
(または Windows の場合は%UserProfile%.awsconfig
) に配置します。設定ファイルを上記で指定した場所とは異なる場所に配置する場合は、その場所を AWS CLI に指示する必要があります。これを行うには、適切な環境変数を設定します。
$export AWS_CONFIG_FILE=/path/to/config_file
ご覧のとおり、共有資格情報ファイルと構成ファイルの両方で複数のprofiles
定義できます。その後、 --profile
オプションを使用して、使用するプロファイルを指定できます。プロファイルが指定されていない場合は、 default
プロファイルが使用されます。
構成ファイルでは、デフォルトのプロファイルを除き、プロファイル グループの各構成セクションの先頭にprofile
を付ける必要があります。たとえば、「testing」という名前のプロファイルがある場合、セクション ヘッダーは[profile testing]
になります。
EC2 インスタンスで AWS CLI を使用している場合は、認証情報の最後のオプションを強くお勧めします。 IAM ロールは、認証情報をインスタンスに自動的にインストールするための優れた方法です。 IAM ロールを使用している場合、AWS CLI はそれらを自動的に検索して使用します。
認証情報に加えて、他の多くの変数を環境変数、構成ファイル エントリ、またはその両方を使用して構成できます。詳細については、「AWS Tools and SDKs Shared Configuration and Credentials Reference Guide」を参照してください。
設定オプションの詳細については、「AWS CLI 設定変数」トピックを参照してください。このトピックには、AWS CLI からもaws help config-vars
実行してアクセスできます。
AWS CLI コマンドは次の構造になっています。
$ aws <コマンド> <サブコマンド> [オプションとパラメータ]
たとえば、S3 バケットをリストするには、コマンドは次のようになります。
$ aws s3 ls
ヘルプ ドキュメントを表示するには、次のいずれかを使用します。
$ AWS ヘルプ $ aws <コマンド> ヘルプ $ aws <コマンド> <サブコマンド> ヘルプ
AWS CLI のバージョンを取得するには:
$ aws --バージョン
デバッグ出力をオンにするには:
$ aws --debug <コマンド> <サブコマンド>
詳細については、AWS CLI ユーザーガイドの「AWS CLI の使用」の章を参照してください。
aws-cli パッケージには、Unix 系システム用のコマンド補完機能が含まれています。この機能は自動的にインストールされないため、手動で設定する必要があります。詳細については、「AWS CLI コマンドの完了」トピックを参照してください。
私たちのチームと対話する最良の方法は、GitHub を使用することです。問題を開き、ガイダンス、バグ レポート、または機能リクエスト用のテンプレートから 1 つを選択できます。
Stack Overflow のタグ aws-cli または AWS Discussion Forum for CLI のコミュニティからヘルプが見つかる場合があります。 AWS サポートのサポート プランがある場合は、新しいサポート ケースを作成することもできます。
別の問題を開く前に、同様の問題が発生していないか確認してください。
AWS CLI は AWS サービス API を実装します。サービスまたはその制限に関する一般的な問題については、アマゾン ウェブ サービスのディスカッション フォーラムが役立つ場合があります。