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

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

次のコマンドラインオプションを使用して、1 つのコマンドのデフォルトの設定を上書きできます。使用するプロファイルを指定することはできますが、コマンドラインオプションを使用して認証情報を直接指定することはできません。

--profile <string>

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

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

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

--output <string>

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

  • jsonJSON 文字列形式で出力されます。

  • yamlYAML 文字列形式で出力されます。(AWS CLI バージョン 2 でのみ利用できます。)

  • text – 複数行のタブ区切り文字列値の形式で出力されます。これは、grepsed、または awk などのテキストプロセッサに出力を渡すのに役立ちます。

  • table – セルの罫線を形成する文字列 +|- を使用して表形式で出力されます。通常、情報は他の形式よりも読みやすい「わかりやすい」形式で表示されますが、プログラムとしては役立ちません。

--endpoint-url <string>

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

各リージョンで使用できる標準的なサービスエンドポイントについては、『アマゾン ウェブ サービス全般のリファレンス』の「AWS リージョンとエンドポイント」を参照してください。

--debug

デバッグログ記録を有効にするブールスイッチ。これには、コマンドが予期しない結果を提供する原因をトラブルシューティングするときに使用できるコマンドのオペレーションに関する追加の診断情報が含まれています。

--no-paginate

出力の自動ページ分割を無効にするブールスイッチ。

--query <string>

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

--version

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

--color <string>

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

--no-sign-request

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

--ca-bundle <string>

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

--cli-read-timeout <integer>

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

--cli-connect-timeout <integer>

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

これらのオプションを 1 つ以上コマンドラインパラメータとして指定すると、デフォルト設定またはその 1 つのコマンドに対応するいずれかのプロファイル設定または環境変数設定が上書きされます。

引数を使用する各オプションには、オプション名から引数を分離するスペースまたは等号 (=) が必要です。引数値にスペースが含まれている文字列がある場合は、引数を引用符で囲む必要があります。

コマンドラインオプションの一般的な使用方法には、複数の AWS リージョンでのリソースの確認、および、スクリプティングでの読みやすさや使いやすさのための出力形式の変更が含まれます。たとえば、インスタンスが実行されているリージョンが不明な場合は、以下に示すように、わかるまで各リージョンに対して describe-instances コマンドを実行できます。

$ aws ec2 describe-instances --output table --region us-east-1 ------------------- |DescribeInstances| +-----------------+ $ 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 ||| ...

各コマンドラインオプションの引数の型 (文字列、ブールなど) については、「」で詳しく説明しています。