コマンドラインオプション - AWS Command Line Interface

このドキュメントはバージョン 1 の AWS CLI のみを対象としています。AWS CLI のバージョン 2 に関連するドキュメントについては、バージョン 2 用ユーザーガイドを参照してください。

コマンドラインオプション

AWS CLI で、コマンドラインオプションはグローバルパラメータであり、デフォルトの設定、対応するプロファイル設定、単一のコマンドの環境変数設定を上書きできます。使用するプロファイルを指定することはできますが、コマンドラインオプションを使用して認証情報を直接指定することはできません。

コマンドラインオプションの使用方法

ほとんどのコマンドラインオプションは、次の例のプロファイル名 profile1 などの単純な文字列です。

$ aws s3 ls --profile profile1 example-bucket-1 example-bucket-2 ...

引数を使用する各オプションには、オプション名から引数を分離するスペースまたは等号 (=) が必要です。引数値にスペースが含まれている文字列がある場合は、引数を引用符で囲む必要があります。引数の型とパラメータの書式設定の詳細については、「AWS CLI のパラメータ値の指定 AWS CLI の一般的なパラメータタイプ」を参照してください。

AWS CLI でサポートされているグローバルコマンドラインオプション

AWS CLI では、次のコマンドラインオプションを使用して、デフォルトの構成設定、対応するプロファイル設定、またはその単一のコマンドの環境変数設定を上書きできます。

--ca-bundle <string>

SSL 証明書の検証時に使用する証明機関 (CA) 証明書バンドルを指定します。

定義されている場合、このオプションはプロファイル設定 ca_bundle の値および AWS_CA_BUNDLE 環境変数よりも優先されます。

--cli-connect-timeout <integer>

ソケットの最大接続時間を秒単位で指定します。この値をゼロ (0) に設定すると、ソケットの接続は無期限に待機し (ブロックされ)、タイムアウトになりません。

--cli-read-timeout <integer>

ソケットの最大読み込み時間を秒単位で指定します。この値をゼロ (0) に設定すると、ソケットの読み込みは無期限に待機し (ブロックされ)、タイムアウトになりません。

--color <string>

色出力のサポートを指定します。有効な値は、onoffauto です。デフォルト値は auto です。

--debug

デバッグログ記録を有効にするブールスイッチ。デフォルトでは、AWS CLI は、コマンド出力のコマンド結果に関する成功または失敗に関するクリーンアップ情報を提供します。--debug このオプションでは、完全な Python ログが提供されます。これには、コマンドが予期しない結果を提供する原因をトラブルシューティングするときに使用できるコマンドのオペレーションに関する追加の stderr 診断情報が含まれています。デバッグログを簡単に表示するには、ログをファイルに送信して、情報をより簡単に検索することをお勧めします。これを行うには、次のいずれかを使用します。

stderr の診断情報のみを送信するには、2> debug.txt を追加します。ここで、debug.txt はデバッグファイルに使用する名前です。

$ aws servicename commandname options --debug 2> debug.txt

出力情報と stderr 診断情報の両方を送信するには、&> debug.txt を追加します。ここで、debug.txt はデバッグファイルに使用する名前です。

$ aws servicename commandname options --debug &> debug.txt
--endpoint-url <string>

リクエストを送信する URL を指定します。ほとんどのコマンドでは、AWS CLI により、選択したサービスと AWS リージョンに基づいて URL が自動的に決定されます。ただし、一部のコマンドでは、アカウント固有の URL を指定する必要があります。一部の AWS サービスでは、プライベート VPC 内で直接エンドポイントをホストすることもできますが、URL を指定する必要がある場合があります。

各リージョンで利用可能な標準サービスエンドポイントのリストについては、Amazon Web Services 全般のリファレンスの「AWS リージョンとエンドポイント」を参照してください。

--no-paginate

出力のページ分割を作成するすべてのコマンド結果を受け取るために AWS CLI が自動的に行う複数の呼び出しを無効にするブール型スイッチ。つまり、出力の最初のページのみが表示されます。

--no-sign-request

AWS サービスエンドポイントに対する HTTP リクエストへの署名を無効にするブールスイッチ。これにより、認証情報がロードされることを防ぎます。

--output <string>

このコマンドに使用する出力形式を指定します。次の値のいずれかを指定できます。

  • json - 出力は JSON 文字列としてフォーマットされます。

  • text - 出力は、複数行のタブ区切りの文字列値としてフォーマットされます。これは、grepsed、または awk などのテキストプロセッサに出力を渡すのに役立ちます。

  • table - 出力は、テーブルとしてフォーマットされ、文字の「+|-」を使用してセルの境界を形成します。通常、情報は他の形式よりも読みやすい「わかりやすい」形式で表示されますが、プログラムとしては役立ちません。

--profile <string>

このコマンドに使用する named profile を指定します。追加の名前付きプロファイルを設定するには、aws configure オプションを指定して --profile コマンドを使用します。

$ aws configure --profile <profilename>
--query <string>

JMESPath クエリを指定して、レスポンスデータのフィルタリングに使用します。詳細については、「AWS CLI 出力をフィルタリングする」を参照してください。

--region <string>

このコマンドの AWS リクエストを送信する AWS リージョンを指定します。指定できるすべてのリージョンのリストについては、Amazon Web Services 全般のリファレンスの「AWS リージョンとエンドポイント」を参照してください。

--version

実行している AWS CLI プログラムの現在バージョンを表示するブールスイッチ。

コマンドラインオプションの一般的な用途

コマンドラインオプションの一般的な使用方法には、複数の AWS リージョンでのリソースの確認、および、スクリプティングでの読みやすさや使いやすさのための出力形式の変更が含まれます。次の例では、インスタンスがどのリージョンにあるかを見つけるまで、各リージョンに対して describe-instances コマンドを実行します。

$ aws ec2 describe-instances --output table --region us-west-1 ------------------- |DescribeInstances| +-----------------+ $ aws ec2 describe-instances --output table --region us-west-2 ------------------------------------------------------------------------------ | DescribeInstances | +----------------------------------------------------------------------------+ || Reservations || |+-------------------------------------+------------------------------------+| || OwnerId | 012345678901 || || ReservationId | r-abcdefgh || |+-------------------------------------+------------------------------------+| ||| Instances ||| ||+------------------------+-----------------------------------------------+|| ||| AmiLaunchIndex | 0 ||| ||| Architecture | x86_64 ||| ...