のコマンドラインオプション AWS CLI - AWS Command Line Interface
コマンドラインオプションの使用方法AWS CLI サポートされているグローバルコマンドラインオプションコマンドラインオプションの一般的な用途

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

のコマンドラインオプション AWS CLI

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

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

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

$ aws s3 ls --profile profile1
amzn-s3-demo-bucket1
amzn-s3-demo-bucket2
...

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

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

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

--ca-bundle <string>

証明書を検証するときに使用する認証局 (CA) SSL証明書バンドルを指定します。

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

--cli-auto-prompt

単一のコマンドに対して自動プロンプトモードを有効にします。以下の例にあるように、これは任意の場所で指定できます。

$ aws --cli-auto-prompt
$ aws dynamodb --cli-auto-prompt
$ aws dynamodb describe-table --cli-auto-prompt

このオプションは、aws_cli_auto_prompt 環境変数と cli_auto_prompt プロファイル設定を上書きします。

AWS CLI バージョン 2 自動プロンプト機能の詳細については、「」を参照してくださいでのコマンドプロンプトの有効化と使用 AWS CLI。

--cli-binary-format

AWS CLI バージョン 2 がバイナリ入力パラメータをどのように解釈するかを指定します。これには、次のいずれかの値を指定できます。

  • base64 - これはデフォルト値です。バイナリラージオブジェクト (BLOB) として入力される入力パラメータは、base64 でエンコードされた文字列を受け入れます。真のバイナリコンテンツを渡すには、コンテンツをファイルに置き、ファイルのパスと名前をパラメータの値として fileb:// プレフィックスを付けて指定します。ファイルに含まれる base64 エンコードされたテキストを渡すには、ファイルのパスと名前をパラメータの値として file:// プレフィックスを付けて指定します。

  • raw-in-base64-out – AWS CLI バージョン 1 のデフォルト。設定の値が の場合raw-in-base64-out、file://プレフィックスを使用して参照されるファイルはテキストとして読み取られ、 はそれをバイナリにエンコード AWS CLI しようとします。

これは cli_binary_format ファイル設定を上書きします。

$ aws lambda invoke \
    --cli-binary-format raw-in-base64-out \
    --function-name my-function \
    --invocation-type Event \
    --payload '{ "name": "Bob" }' \
    response.json

fileb:// プレフィックス表記を使用してファイル内のバイナリ値を参照する場合、 はファイルに raw バイナリコンテンツが含まれていることを AWS CLI 常に想定し、値を変換しようとしません。

file:// プレフィックス表記を使用してファイル内のバイナリ値を参照する場合、 は現在のcli_binary_format設定に従ってファイルを AWS CLI 処理します。この設定の値が base64 (明示的に設定されていない場合はデフォルト) の場合、 はファイルに base64 でエンコードされたテキストが含まれていることを AWS CLI 期待します。設定の値が raw-in-base64-out の場合、 AWS CLI はファイルに raw バイナリコンテンツが含まれていることを期待します。

--cli-connect-timeout <integer>

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

--cli-read-timeout <integer>

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

--color <string>

色出力のサポートを指定します。有効な値は、on、off、auto です。デフォルト値は 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 リージョンURLに基づいて AWS CLI を自動的に決定します。ただし、一部のコマンドでは、アカウント固有の を指定する必要がありますURL。プライベート 内でエンドポイントを直接ホストVPCするように一部の AWS サービスを設定することもできます。この場合は、指定が必要になる場合があります。

次のコマンド例では、カスタム Amazon S3 エンドポイント を使用しますURL。

$ aws s3 ls --endpoint-url http://localhost:4567

エンドポイント設定は、システム環境変数やユーザー環境変数、ローカル AWS 設定ファイルなど複数の場所に配置され、コマンドラインでパラメータとして明示的に宣言されます。 AWS CLI エンドポイント構成設定は、次の順序で優先されます。

  1. --endpoint-url コマンドラインオプション。

  2. 有効にすると、AWS_IGNORE_CONFIGURED_ENDPOINT_URLS グローバルエンドポイント環境変数またはプロファイル設定 ignore_configure_endpoint_urls はカスタムエンドポイントを無視します。

  3. サービス固有の環境変数 AWS_ENDPOINT_URL_<SERVICE> (AWS_ENDPOINT_URL_DYNAMODB など) によって提供される値。

  4. AWS_USE_DUALSTACK_ENDPOINT、AWS_USE_FIPS_ENDPOINT、および AWS_ENDPOINT_URL 環境変数によって提供される値。

  5. 共有 config ファイルの services セクション内の endpoint_url 設定によって提供されるサービス固有のエンドポイント値。

  6. 共有 config ファイルの profile 内の endpoint_url 設定によって提供される値。

  7. use_dualstack_endpoint、use_fips_endpoint、および endpoint_url の設定。

  8. それぞれの URLのデフォルトエンドポイント AWS のサービス が最後に使用されます。各リージョンで使用できる標準的なサービスエンドポイントについては、「Amazon Web Services 全般のリファレンス」の「AWS リージョンとエンドポイント」を参照してください。

--no-cli-auto-prompt

単一のコマンドに対して自動プロンプトモードを無効にします。

$ aws dynamodb describe-table --table-name Table1 --no-cli-auto-prompt

このオプションは、aws_cli_auto_prompt 環境変数と cli_auto_prompt プロファイル設定を上書きします。

AWS CLI バージョン 2 自動プロンプト機能の詳細については、「」を参照してくださいでのコマンドプロンプトの有効化と使用 AWS CLI。

--no-cli-pager

コマンドの出力に対するページャーの使用を無効にするブール型スイッチ。

--no-paginate

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

--no-sign-request

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

--no-verify-ssl

デフォルトでは、 は AWS サービスと通信SSLするときに AWS CLI を使用します。SSL 接続と呼び出しごとに、 はSSL証明書 AWS CLI を検証します。このオプションを使用すると、SSL証明書を検証するデフォルトの動作が上書きされます。

警告

このオプションは、ベストプラクティスではありません。を使用する場合--no-verify-ssl、クライアントと AWS サービス間のトラフィックは保護されなくなります。つまり、トラフィックはセキュリティリスクであり、 man-in-the-middleエクスプロイトに対して脆弱です。証明書に問題がある場合は、代わりに問題を解決するのが最善です。証明書のトラブルシューティング手順については、「SSL 証明書エラー」を参照してください。

--output <string>

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

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

  • yaml – 出力はYAML文字列としてフォーマットされます。

  • yaml-stream – 出力はストリーミングされ、YAML文字列としてフォーマットされます。ストリーミングにより、大きなデータタイプの処理を高速化できます。

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

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

--profile <string>

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

$ aws configure --profile <profilename>
-- クエリ <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                                       |||
...