設定 的環境變數 AWS CLI - AWS Command Line Interface
如何設定環境變數AWS CLI 支援的環境變數

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

設定 的環境變數 AWS CLI

環境變數提供另一種指定組態選項和憑證的方法，對於指令碼很有用。

選項的優先順序

  • 如果您使用本主題中所述的其中一個環境變數來指定選項，它將覆寫從組態檔中描述檔載入的任何數值。

  • 如果您在 AWS CLI 命令列上使用 參數來指定選項，它會從對應的環境變數或組態檔案中的設定檔覆寫任何值。

如需優先順序以及 如何 AWS CLI 決定要使用哪些憑證的詳細資訊，請參閱 設定 的設定 AWS CLI。

如何設定環境變數

下列範例說明如何為預設使用者設定環境變數。

Linux or macOS
$ export AWS_ACCESS_KEY_ID=AKIAIOSFODNN7EXAMPLE
$ export AWS_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
$ export AWS_DEFAULT_REGION=us-west-2

設定環境變數會變更使用的數值，直到 Shell 工作階段結束或直到您將該變數設為其他數值。您可以在 Shell 的啟動指令碼中設定變數，讓它們跨未來的工作階段持續生效。

Windows Command Prompt

為所有工作階段設定

C:\> setx AWS_ACCESS_KEY_ID AKIAIOSFODNN7EXAMPLE
C:\> setx AWS_SECRET_ACCESS_KEY wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
C:\> setx AWS_DEFAULT_REGION us-west-2

使用 setx 設定環境變數時，將會變更在目前命令提示工作階段及您在執行命令後建立的所有命令提示工作階段中使用的數值。不會影響您執行命令當時已執行的其他命令 Shell。您可能需要重新啟動終端機才能載入設定。

僅針對目前工作階段設定

使用 set 設定環境變數會變更使用的數值，直到目前命令提示工作階段結束或直到您將該變數設為其他數值。

C:\> set AWS_ACCESS_KEY_ID=AKIAIOSFODNN7EXAMPLE
C:\> set AWS_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
C:\> set AWS_DEFAULT_REGION=us-west-2
PowerShell
PS C:\> $Env:AWS_ACCESS_KEY_ID="AKIAIOSFODNN7EXAMPLE"
PS C:\> $Env:AWS_SECRET_ACCESS_KEY="wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
PS C:\> $Env:AWS_DEFAULT_REGION="us-west-2"

如果您在 PowerShell 提示中設定環境變數，如先前範例所示，它只會在目前工作階段的持續時間內儲存該值。若要讓環境變數設定在所有 PowerShell 和 命令提示工作階段中持續存在，請使用 控制面板 中的系統應用程式來存放它。或者，您可以將變數新增至您的 PowerShell 設定檔，以設定所有未來 PowerShell 工作階段的變數。如需儲存環境變數或跨工作階段保留它們的詳細資訊，請參閱 PowerShell 文件。

AWS CLI 支援的環境變數

AWS CLI 支援下列環境變數。

AWS_ACCESS_KEY_ID

指定與IAM帳戶相關聯的 AWS 存取金鑰。

如果已定義，此環境變數會覆寫設定檔設定 aws_access_key_id 的數值。您無法使用命令列選項來指定存取金鑰 ID。

AWS_CA_BUNDLE

指定憑證套件的路徑，以用於HTTPS憑證驗證。

如果已定義，此環境變數會覆寫設定檔設定 ca_bundle 的數值。您可以使用 --ca-bundle 命令列參數來覆寫此環境變數。

AWS_CLI_AUTO_PROMPT

啟用 AWS CLI 版本 2 的自動提示。有兩種設定可以使用：

  • 在您每次嘗試執行 aws 命令時，on 都會使用完整的自動提示模式。這包括在完整命令或不完整命令ENTER之後按下 。

  • on-partial 使用部分自動提示模式。如果命令不完整或因用戶端驗證錯誤而無法執行，則會使用自動提示。如果您有預先存在的指令碼、 Runbook，或者您只想要對不熟悉的命令自動提示，而不是在每個命令上提示，則此模式很有用。

如果已定義，此環境變數會覆寫 cli_auto_prompt 設定檔設定的數值。您可以使用 --cli-auto-prompt 及 --no-cli-auto-prompt 命令列參數來覆寫此環境變數。

如需第 2 AWS CLI 版自動提示功能的資訊，請參閱 在 中啟用和使用命令提示字元 AWS CLI。

AWS_CLI_FILE_ENCODING

指定用於文字檔的編碼。預設情況下，編碼會與您的語言環境相符。若要設定與地區設定不同的編碼，請使用 aws_cli_file_encoding 環境變數。例如，如果您使用 Windows 搭配預設編碼 CP1252，設定 CLI會將 aws_cli_file_encoding=UTF-8 設定為使用 開啟文字檔案UTF-8。

AWS_CLI_S3_MV_VALIDATE_SAME_S3_PATHS

如果使用自訂s3 mv命令時來源和目的地儲存貯體相同，則來源檔案或物件可以移至其本身，這可能會導致意外刪除來源檔案或物件。AWS_CLI_S3_MV_VALIDATE_SAME_S3_PATHS 環境變數 和 --validate-same-s3-paths選項指定是否要驗證 Amazon S3 來源ARNs或目的地 中的存取點或存取點別名URIs。

注意

的路徑驗證s3 mv需要額外API的呼叫。

AWS_CONFIG_FILE

指定 AWS CLI 用來存放組態設定檔的檔案位置。預設路徑為 ~/.aws/config。

您無法在具名設定檔設定中或使用命令列參數來指定此數值。

AWS_DATA_PATH

在載入 AWS CLI 資料~/.aws/models時，要在內建搜尋路徑 之外檢查的其他目錄清單。設定此環境變數會指出回復內建搜尋路徑前需要先檢查的額外目錄。多個項目應使用 os.pathsep 字元分隔，在 Linux 或 macOS 上為 :，在 Windows 上則為 ;。

AWS_DEFAULT_OUTPUT

指定要使用的輸出格式。

如果已定義，此環境變數會覆寫設定檔設定 output 的數值。您可以使用 --output 命令列參數來覆寫此環境變數。

AWS_DEFAULT_REGION

根據預設， 會Default region name識別您要將請求傳送至其伺服器的 AWS 區域。這通常是最接近您的區域，但它可以是任何區域。例如，您可以輸入 us-west-2 來使用美國西部 (奧勒岡)。除非您在個別命令中另外指定，否則此為所有後續請求傳送到的區域。

注意

使用 時 AWS CLI，您必須明確或透過設定預設 AWS 區域來指定區域。如需可用區域的清單，請參閱區域和端點。所使用的區域代號 AWS CLI 與您在 和服務端點中 AWS Management Console URLs看到的名稱相同。

如果已定義，此環境變數會覆寫設定檔設定 region 的數值。您可以使用--region命令列參數 和 AWS SDK相容的環境變數 來覆寫此AWS_REGION環境變數。

AWS_EC2_METADATA_DISABLED

停用 Amazon EC2執行個體中繼資料服務 （IMDS）。

如果設定為 true，則不會向 請求使用者憑證或組態 （例如區域）IMDS。

AWS_ENDPOINT_URL

指定用於所有服務要求的端點。

端點組態設定位於多個位置，例如系統或使用者環境變數、本機 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. 最後 AWS 服務 會使用URL個別 的任何預設端點。如需每個區域可用的標準服務端點清單，請參閱 Amazon Web Services 一般參考 中的 AWS 區域與端點。

AWS_ENDPOINT_URL_<SERVICE>

指定用於特定服務的自訂端點，其中 <SERVICE> 會取代為 AWS 服務 識別碼。例如， Amazon DynamoDB 的 serviceId DynamoDB。對於此服務，端點URL環境變數為 AWS_ENDPOINT_URL_DYNAMODB。

如需所有服務特定環境變數的清單，請參閱 服務特定識別碼清單。

端點組態設定位於多個位置，例如系統或使用者環境變數、本機 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. 最後 AWS 服務 會使用URL個別 的任何預設端點。如需每個區域可用的標準服務端點清單，請參閱 Amazon Web Services 一般參考 中的 AWS 區域與端點。

AWS_IGNORE_CONFIGURED_ENDPOINT_URLS

如果啟用， 會 AWS CLI 忽略所有自訂端點組態。有效值為 true 和 false。

端點組態設定位於多個位置，例如系統或使用者環境變數、本機 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. 最後 AWS 服務 會使用URL個別 的任何預設端點。如需每個區域可用的標準服務端點清單，請參閱 Amazon Web Services 一般參考 中的 AWS 區域與端點。

AWS_MAX_ATTEMPTS

指定重試 AWS CLI 處理常式使用的最大重試次數值，其中初始呼叫會計入您提供的值。如需有關重試的詳細資訊，請參閱 AWS CLI 中的重試 AWS CLI。

如果已定義，此環境變數會覆寫設定檔設定 max_attempts 的數值。

AWS_METADATA_SERVICE_NUM_ATTEMPTS

嘗試擷取已設定 IAM角色的 Amazon EC2執行個體上的憑證時， 會 AWS CLI 嘗試在停止之前從執行個體中繼資料服務擷取一次憑證。如果您知道命令將在 Amazon EC2執行個體上執行，您可以增加此值，以便在放棄之前 AWS CLI 重試多次。

AWS_METADATA_SERVICE_TIMEOUT

執行個體中繼資料服務連線逾時前的秒數。當嘗試擷取使用 IAM角色設定的 Amazon EC2執行個體上的憑證時，連線到執行個體中繼資料服務依預設會在 1 秒後逾時。如果您知道您正在已設定IAM角色的 Amazon EC2執行個體上執行，您可以視需要增加此值。

AWS_PAGER

指定用於輸出的分頁程式。根據預設， AWS CLI 版本 2 會透過作業系統的預設呼叫器程式傳回所有輸出。

若要停用所有外部分頁程式，請將變數設定為空字串。

如果已定義，此環境變數會覆寫設定檔設定 cli_pager 的數值。

AWS_PROFILE

指定 AWS CLI 設定檔的名稱，其中包含要使用的憑證和選項。這可以是在 credentials 或 config 檔案中存放的描述檔名稱，或數值 default 以使用預設描述檔。

如果您定義此環境變數，它將覆寫使用組態檔中名為 [default] 之描述檔的行為。您可以使用 --profile 命令列參數來覆寫此環境變數。

AWS_REGION

指定 AWS 要傳送請求的區域之 AWS SDK相容環境變數。

如果已定義，此環境變數會覆寫環境變數 AWS_DEFAULT_REGION 及設定檔設定 region 的數值。您可以使用 --region 命令列參數來覆寫此環境變數。

AWS_RETRY_MODE

指定重試模式 AWS CLI 使用的 。有三種可用的重試模式：傳統 (預設)、標準和自適應。如需有關重試的詳細資訊，請參閱 AWS CLI 中的重試 AWS CLI。

如果已定義，此環境變數會覆寫設定檔設定 retry_mode 的數值。

AWS_ROLE_ARN

指定IAM角色的 Amazon Resource Name （ARN），其中包含您要用來執行 AWS CLI 命令的 Web 身分提供者。

與 AWS_WEB_IDENTITY_TOKEN_FILE 及 AWS_ROLE_SESSION_NAME 環境變數搭配使用。

如果已定義，此環境變數會覆寫設定檔設定 role_arn 的數值。您無法將角色工作階段名稱指定為命令列參數。

注意

此環境變數目前僅適用於具有 Web 身分提供者的擔任角色，並不適用一般擔任角色提供者組態。

如需使用 Web 身分的詳細資訊，請參閱 擔任具有 Web 身分的角色。

AWS_ROLE_SESSION_NAME

指定要連接到角色工作階段的名稱。當 AWS CLI 呼叫 AssumeRole 操作時，此值會提供給 RoleSessionName 參數，並成為擔任角色使用者 ARN： 的一部分 arn:aws:sts::123456789012:assumed-role/role_name/role_session_name。這是選擇性的參數。若您未提供此數值，將會自動產生工作階段名稱。此名稱會出現在與此工作階段相關聯的項目 AWS CloudTrail 日誌中。

如果已定義，此環境變數會覆寫設定檔設定 role_session_name 的數值。

與 AWS_ROLE_ARN 及 AWS_WEB_IDENTITY_TOKEN_FILE 環境變數搭配使用。

如需使用 Web 身分的詳細資訊，請參閱 擔任具有 Web 身分的角色。

注意

此環境變數目前僅適用於具有 Web 身分提供者的擔任角色，並不適用一般擔任角色提供者組態。

AWS_SDK_UA_APP_ID

單一 AWS 帳戶 可由多個客戶應用程式用來呼叫 AWS 服務。應用程式 ID 會識別使用 進行一組呼叫的來源應用程式 AWS 服務。 AWS SDKs 和 服務不使用或解釋此值，但 會在客戶通訊中使其恢復。例如，此值可以包含在操作電子郵件中，以唯一識別哪些應用程式與通知相關聯。

根據預設，沒有值。

應用程式 ID 是長度上限為 50 個字元的字串。允許使用字母、數字和下列特殊字元：

! $ % & * + - . , ^ _ ` | ~

如果已定義，此環境變數會覆寫設定檔設定 sdk_ua_app_id 的數值。您無法將應用程式 ID 指定為命令列選項。

AWS_SECRET_ACCESS_KEY

指定與存取金鑰相關聯的私密金鑰。這基本上是存取金鑰的「密碼」。

如果已定義，此環境變數會覆寫設定檔設定 aws_secret_access_key 的數值。您不能將私密存取金鑰 ID 指定為命令列選項。

AWS_SESSION_TOKEN

指定當您直接從 AWS STS 作業擷取的暫時安全憑證時需要的工作階段字符值。如需詳細資訊，請參閱AWS CLI 命令參考中的擔任角色命令的輸出部分。

如果已定義，此環境變數會覆寫設定檔設定 aws_session_token 的數值。

AWS_SHARED_CREDENTIALS_FILE

指定 AWS CLI 用來存放存取金鑰的檔案位置。預設路徑為 ~/.aws/credentials。

您無法在具名設定檔設定中或使用命令列參數來指定此數值。

AWS_USE_DUALSTACK_ENDPOINT

啟用雙堆疊端點傳送 AWS 請求。若要進一步了解支援 IPv4和 IPv6流量的雙堆疊端點，請參閱Amazon Simple Storage Service 使用者指南中的使用 Amazon S3 雙堆疊端點。雙堆疊端點適用於部分區域的某些服務。如果 服務或 不存在雙堆疊端點 AWS 區域，則請求會失敗。此選項根據預設為停用。

端點組態設定位於多個位置，例如系統或使用者環境變數、本機 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. 最後 AWS 服務 會使用URL個別 的任何預設端點。如需每個區域可用的標準服務端點清單，請參閱 Amazon Web Services 一般參考 中的 AWS 區域與端點。

AWS_USE_FIPS_ENDPOINT

某些 AWS 服務提供某些 中支援聯邦資訊處理標準 （FIPS） 140-2 的端點 AWS 區域。當 AWS 服務支援 時FIPS，此設定會指定 AWS CLI 應使用 的FIPS端點。與標準 AWS 端點不同，FIPS端點使用符合 140-2 FIPS TLS的軟體程式庫。會與美國政府互動的企業可能需要這些端點。

如果啟用此設定，但 中的服務不存在FIPS端點 AWS 區域，則 AWS 命令可能會失敗。在此情況下，請使用 --endpoint-url 選項或使用服務特定端點手動指定要在命令中使用的端點。

如需依 指定FIPS端點的詳細資訊 AWS 區域，請參閱依FIPS服務 區分的端點。

端點組態設定位於多個位置，例如系統或使用者環境變數、本機 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. 最後 AWS 服務 會使用URL個別 的任何預設端點。如需每個區域可用的標準服務端點清單，請參閱 Amazon Web Services 一般參考 中的 AWS 區域與端點。

AWS_WEB_IDENTITY_TOKEN_FILE

指定檔案的路徑，其中包含身分提供者提供的 OAuth 2.0 存取權杖或 OpenID Connect ID 權杖。 AWS CLI 會載入此檔案的內容，並將其作為 WebIdentityToken 引數傳遞至 AssumeRoleWithWebIdentity 操作。

與 AWS_ROLE_ARN 及 AWS_ROLE_SESSION_NAME 環境變數搭配使用。

如果已定義，此環境變數會覆寫設定檔設定 web_identity_token_file 的數值。

如需使用 Web 身分的詳細資訊，請參閱 擔任具有 Web 身分的角色。

注意

此環境變數目前僅適用於具有 Web 身分提供者的擔任角色，並不適用一般擔任角色提供者組態。