中的命令列選項 AWS CLI - AWS Command Line Interface
如何使用命令列選項AWS CLI 支援的全域命令列選項命令列選項的常見用途

本文件 AWS CLI 僅適用於 第 1 版。如需 第 2 版的相關文件 AWS CLI，請參閱 第 2 版使用者指南。

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

中的命令列選項 AWS CLI

在 中 AWS CLI，命令列選項是全域參數，可用來覆寫該單一命令的預設組態設定、任何對應的設定檔設定或環境變數設定。您無法使用命令列選項來直接指定憑證，但可指定要使用的描述檔。

如何使用命令列選項

大多數命令列選項都是簡單的字串，例如下列範例中的設定檔名稱 profile1：

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

每個接受引數的選項需要有空格或等號 (=) 來隔開引數與選項名稱。如果引數值是包含空格的字串，則您必須使用引號括住引數。如需關於參數類型和參數格式的詳細資訊，請參閱 在 AWS CLI 中指定參數值。

AWS CLI 支援的全域命令列選項

在 中 AWS CLI ，您可以使用下列命令列選項來覆寫該單一命令的預設組態設定、任何對應的設定檔設定或環境變數設定。

--ca-bundle <string>

指定在驗證 SSL 憑證時使用的憑證授權機構 (CA) 憑證套件。

如果已定義，此選項會覆寫設定檔設定 ca_bundle 的數值及 AWS_CA_BUNDLE 環境變數。

--cli-connect-timeout <integer>

指定通訊端連線時間上限 (以秒為單位)。如果數值設為零 (0)，通訊端連線會無限期等待 (凍結) 且不逾時。預設值為 60 秒。

--cli-read-timeout <integer>

指定通訊端讀取時間上限 (以秒為單位)。如果數值設為零 (0)，通訊端讀取會無限期等待 (凍結) 且不逾時。預設值為 60 秒。

--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 區域 AWS CLI 自動判斷 URL。但部分命令需要您指定帳戶專屬的 URL。您也可以設定某些 AWS 服務直接在私有 VPC 中託管端點，然後可能需要指定。

下列命令範例使用自訂的 Amazon S3 端點 URL。

$ aws s3 ls --endpoint-url http://localhost:4567
端點優先順序

端點組態設定位於多個位置，例如系統或使用者環境變數、本機 AWS 組態檔案，或在命令列上明確宣告為參數。會依特定順序 AWS CLI 檢查這些端點設定，並使用優先順序最高的端點設定。如需端點優先順序清單，請參閱端點組態和設定優先順序。

--no-paginate

布林值開關，可停用 自動 AWS CLI 進行的多個呼叫，以接收建立輸出分頁的所有命令結果。這表示只會顯示輸出的第一頁。

--no-sign-request

停用對 AWS 服務端點簽署 HTTP 請求的布林值開關。這可防止載入憑證。

--no-verify-ssl

根據預設， AWS CLI 會在與 AWS 服務通訊時使用 SSL。對於每個 SSL 連線和呼叫， AWS CLI 會驗證 SSL 憑證。使用此選項會覆寫驗證 SSL 憑證的預設行為。

警告

此選項不是最佳作法。如果您使用 --no-verify-ssl，用戶端 AWS 和服務之間的流量將不再受到保護。這意味著您的流量存在安全風險，並且容易受到攔截式攻擊。如果您在憑證上遇到問題，最好改為解決這些問題。如需憑證疑難排解步驟，請參閱 SSL 憑證錯誤。

--output <string>

指定要用於此命令的輸出格式。您可以指定下列任何數值：

  • json – 輸出的格式為 JSON 字串。

  • text – 輸出的格式是多行以 Tab 分隔的字串值。這對於將輸出傳遞給文字處理器 (如 grep、sed 或 awk) 非常有用。

  • table – 輸出的格式為使用字元 +|- 形成儲存格框線的表格。它通常以「方便人類使用」的格式來呈現資訊，這種格式比其他格式更容易閱讀，但在編寫程式方面較不有用。

--profile <string>

指定要用於此命令的具名描述檔。若需設置額外的具名描述檔，您可以使用 aws configure 命令搭配 --profile 選項。

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

指定 JMESPath 查詢以用於篩選回應資料。如需詳細資訊，請參閱 在 AWS CLI 中篩選輸出。

--region <string>

指定 AWS 要傳送此命令 AWS 請求的區域。如需您可指定之所有區域和端點的清單，請參閱 Amazon Web Services 一般參考 中的 AWS 區域與端點。

--v2-偵錯

啟用 v1 到 v2 升級偵錯模式。在此模式下， AWS CLI 會偵測 AWS CLI v2 中因重大變更而更新的功能使用情況，以及每個偵測到可能受到影響之用量的輸出警告。您可以使用此模式來準備環境和 AWS CLI 用量，以升級至 v2。

此選項會覆寫AWS_CLI_UPGRADE_DEBUG_MODE環境變數。

如需 AWS CLI v1 至 v2 升級偵錯模式的資訊，請參閱使用升級偵錯模式將 AWS CLI 第 1 版升級至 AWS CLI 第 2 版。

--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                                       |||
...