为 Amazon CLI 配置环境变量

Amazon CLI 支持以下环境变量。

AWS_ACCESS_KEY_ID

指定与 IAM 账户关联的 Amazon 访问密钥。

如果已定义此环境变量，它将覆盖配置文件设置 aws_access_key_id 的值。您不能使用命令行选项来指定访问密钥 ID。

AWS_ACCOUNT_ID

指定要用于调用受支持的 Amazon Web Services 服务的基于 Amazon 账户的端点 ID。有关基于账户的端点的更多信息，请参阅基于账户的端点。

该设置会覆盖 aws_account_id 设置。AWS_ACCOUNT_ID_ENDPOINT_MODE 环境变量或 account_id_endpoint_mode 设置必须设置为 preferred 或 required，才能使用此设置。

端点优先级

端点配置设置位于多个位置（例如，系统变量或用户环境变量、本地 Amazon 配置文件），或者在命令行上显式声明为参数。Amazon CLI 按特定顺序检查这些端点设置，并使用优先级最高的端点设置。有关端点优先级列表，请参阅端点配置和设置优先级。

AWS_ACCOUNT_ID_ENDPOINT_MODE

指定是否使用基于 Amazon 账户的端点 ID 来调用受支持的 Amazon Web Services 服务。有关基于账户的端点的更多信息，请参阅基于账户的端点。

此设置可以设为以下值：

• （默认）preferred：端点应包含账户 ID（如果有）。

• disabled：已解析的端点不包含账户 ID。

• required：端点必须包含账户 ID。如果账户 ID 不可用，SDK 会引发错误。

该设置会覆盖 account_id_endpoint_mode 设置。要使用基于账户的端点，必须在 AWS_ACCOUNT_ID 环境变量或 aws_account_id 设置中设置 ID。

端点优先级

端点配置设置位于多个位置（例如，系统变量或用户环境变量、本地 Amazon 配置文件），或者在命令行上显式声明为参数。Amazon CLI 按特定顺序检查这些端点设置，并使用优先级最高的端点设置。有关端点优先级列表，请参阅端点配置和设置优先级。

AWS_CA_BUNDLE

指定要用于 HTTPS 证书验证的证书捆绑包的路径。

如果已定义此环境变量，它将覆盖配置文件设置 ca_bundle 的值。您可以使用 --ca-bundle 命令行参数覆盖此环境变量。

AWS_CLI_AUTO_PROMPT

为 Amazon CLI 版本 2 启用自动提示。可以使用两种设置：

• on 每次尝试运行 aws 命令时都会使用完整的自动提示模式。这包括在完整或不完整的命令之后按 ENTER 键。

• on-partial 使用部分自动提示模式。如果命令不完整或由于客户端验证错误而无法运行，则使用自动提示。如果您已经拥有脚本、运行手册，或者如果您希望仅针对不熟悉的命令，而不是针对每个命令都收到自动提示，则此模式很有用。

如果已定义此环境变量，它将覆盖 cli_auto_prompt 配置文件设置的值。您可以使用 --cli-auto-prompt 和 --no-cli-auto-prompt 命令行参数覆盖此环境变量。

有关 Amazon CLI 版本 2 自动提示特征的信息，请参阅 在 Amazon CLI 中启用和使用命令提示符。

AWS_CLI_FILE_ENCODING

指定用于文本文件的编码。默认情况下，编码与您的区域设置匹配。要设置与区域设置不同的编码，请使用 aws_cli_file_encoding 环境变量。例如，如果您使用 Windows 以及默认编码 CP1252，则 aws_cli_file_encoding=UTF-8 设置会将 CLI 设置为使用 UTF-8 打开文本文件。

AWS_CLI_S3_MV_VALIDATE_SAME_S3_PATHS

如果在使用 s3 mv 命令时源存储桶和目标存储桶相同，则可以将源文件或对象移到其自身上，这可能导致源文件或对象被意外删除。AWS_CLI_S3_MV_VALIDATE_SAME_S3_PATHS 环境变量和 --validate-same-s3-paths 选项指定是验证接入点 ARN 还是验证您的 Amazon S3 源或目标 URI 中的接入点别名。

注意

针对 s3 mv 的路径验证需要额外的 API 调用。

AWS_CONFIG_FILE

指定 Amazon CLI 用于存储配置文件的文件的位置。默认路径为 ~/.aws/config。

您不能在命名配置文件设置中或使用命令行参数来指定此值。

AWS_DATA_PATH

加载 Amazon CLI 数据时要在 ~/.aws/models 的内置搜索路径之外检查的其他目录的列表。设置此环境变量将指示在回滚到内置搜索路径前要先检查的其他目录。应使用 os.pathsep 字符（在 Linux 上为 :，在 Windows 上为 ;）隔开多个条目。

AWS_DEFAULT_OUTPUT

指定要使用的输出格式。

如果已定义此环境变量，它将覆盖配置文件设置 output 的值。您可以使用 --output 命令行参数覆盖此环境变量。

AWS_DEFAULT_REGION

Default region name 标识默认情况下您要将请求发送到的服务器所在的 Amazon 区域。通常是离您最近的区域，但可以是任意区域。例如，您可以键入 us-west-2 以使用美国西部（俄勒冈）。除非在命令中另行指定，否则这是所有后续请求将发送到的区域。

注意

使用 Amazon 时，必须明确指定或通过设置原定设置区域来指定 Amazon CLI 区域。有关可用区域的列表，请参阅区域和端点。Amazon CLI 使用的区域指示符与您在 Amazon Web Services Management Console URL 和服务端点中看到的名称相同。

如果已定义此环境变量，它将覆盖 region 配置文件设置的值。您可以使用 --region 命令行参数 和与 Amazon SDK 兼容的 AWS_REGION 环境变量来覆盖此环境变量。

AWS_EC2_METADATA_DISABLED

禁用 Amazon EC2 实例元数据服务（IMDS）。

如果设置为 true，则不会从 IMDS 请求用户凭证或配置（如区域）。

AWS_ENDPOINT_URL

指定用于所有服务请求的端点。有关更多信息，请参阅 为所有 Amazon Web Services 服务设置全局端点。

端点优先级

端点配置设置位于多个位置（例如，系统变量或用户环境变量、本地 Amazon 配置文件），或者在命令行上显式声明为参数。Amazon CLI 按特定顺序检查这些端点设置，并使用优先级最高的端点设置。有关端点优先级列表，请参阅端点配置和设置优先级。

AWS_ENDPOINT_URL_<SERVICE>

指定用于特定服务的自定义端点，在该服务中 <SERVICE> 替换为 Amazon Web Services 服务 标识符。例如，Amazon DynamoDB 具有 DynamoDB 的 serviceId。对于此服务，端点 URL 环境变量为 AWS_ENDPOINT_URL_DYNAMODB。

有关特定于服务的所有环境变量的列表，请参阅特定于服务的标识符列表。

端点优先级

端点配置设置位于多个位置（例如，系统变量或用户环境变量、本地 Amazon 配置文件），或者在命令行上显式声明为参数。Amazon CLI 按特定顺序检查这些端点设置，并使用优先级最高的端点设置。有关端点优先级列表，请参阅端点配置和设置优先级。

AWS_IGNORE_CONFIGURED_ENDPOINT_URLS

如果启用，则 Amazon CLI 将忽略所有自定义端点配置。有效值为 true 和 false。有关更多信息，请参阅 为所有 Amazon Web Services 服务设置全局端点。

端点配置设置位于多个位置（例如，系统变量或用户环境变量、本地 Amazon 配置文件），或者在命令行上显式声明为参数。有关端点优先级，请参阅端点配置和设置优先级。

端点优先级

端点配置设置位于多个位置（例如，系统变量或用户环境变量、本地 Amazon 配置文件），或者在命令行上显式声明为参数。Amazon CLI 按特定顺序检查这些端点设置，并使用优先级最高的端点设置。有关端点优先级列表，请参阅端点配置和设置优先级。

AWS_MAX_ATTEMPTS

指定 Amazon CLI 重试处理程序使用的最大重试次数值，其中初始调用计入您提供的值。有关重试的更多信息，请参阅Amazon CLI 中的 Amazon CLI 重试次数 。

如果已定义此环境变量，它将覆盖配置文件设置 max_attempts 的值。

AWS_METADATA_SERVICE_NUM_ATTEMPTS

尝试在已配置 IAM 角色的 Amazon EC2 实例上检索凭证时，Amazon CLI 会在停止前尝试从实例元数据服务检索一次凭证。如果您知道您的命令将在 Amazon EC2 实例上运行，则可增大此值，以使 Amazon CLI 在放弃前重试多次。

AWS_METADATA_SERVICE_TIMEOUT

与实例元数据服务的连接超时前等待的秒数。尝试在已配置 IAM 角色的 Amazon EC2 实例上检索凭证时，默认情况下，与实例元数据服务的连接将在 1 秒后超时。如果您知道您正在已配置 IAM 角色的 Amazon EC2 实例上运行，如有必要，可增大此值。

AWS_PAGER

指定用于处理输出的分页程序。默认情况下，Amazon CLI 版本 2 会通过操作系统的默认分页程序返回所有输出。

要完全禁用外部分页程序，请将该变量设置为空字符串。

如果已定义此环境变量，它将覆盖配置文件设置 cli_pager 的值。

AWS_PROFILE

指定包含要使用的凭证和选项的 Amazon CLI 配置文件的名称。可以是存储在 credentials 或 config 文件中的配置文件的名称，也可以是值 default，后者使用默认配置文件。

如果您定义了此环境变量，它将在配置文件中覆盖使用名为 [default] 的配置文件的行为。您可以使用 --profile 命令行参数覆盖此环境变量。

AWS_REGION

与 Amazon SDK 兼容的环境变量，它指定要将请求发送到的 Amazon 区域。

如果已定义此环境变量，它将覆盖环境变量 AWS_DEFAULT_REGION 和配置文件设置 region 中的值。您可以使用 --region 命令行参数覆盖此环境变量。

AWS_REQUEST_CHECKSUM_CALCULATION

指定何时计算请求有效载荷的校验和，并提供以下选项：

• when_supported –（默认）当操作在其服务模型中指定校验和算法或需要请求校验和时，将计算请求有效载荷校验和。

• when_required – 当操作需要请求校验和或用户提供由 Amazon Web Services 服务 建模的 requestAlgorithmMember 时，将计算请求有效载荷校验和。

如果已定义此环境变量，它将覆盖配置文件设置 request_checksum_calculation 的值。

AWS_RESPONSE_CHECKSUM_VALIDATION

指定何时对响应有效载荷执行校验和验证，并提供以下选项：

• when_supported –（默认）当操作在其服务模型中指定 Amazon CLI 支持的响应算法时，将执行响应有效载荷校验和验证。

• when_required：当操作在其服务模型中指定 Amazon CLI 支持的响应算法，并且您在操作输出中将建模的 requestValidationModeMember 设置为 ENABLED 时，将执行响应有效载荷校验和验证。

如果已定义此环境变量，它将覆盖配置文件设置 response_checksum_validation 的值。

AWS_RETRY_MODE

指定 Amazon CLI 使用哪种重试模式。有三种重试模式可用：旧模式（默认模式）、标准模式和自适应模式。有关重试的更多信息，请参阅Amazon CLI 中的 Amazon CLI 重试次数 。

如果已定义此环境变量，它将覆盖配置文件设置 retry_mode 的值。

AWS_ROLE_ARN

指定要用于运行 Amazon CLI 命令的 IAM 角色的 Amazon Resource Name（ARN）以及 Web 身份提供者。

结合使用 AWS_WEB_IDENTITY_TOKEN_FILE 和 AWS_ROLE_SESSION_NAME 环境变量。

如果已定义此环境变量，它将覆盖配置文件设置 role_arn 的值。不能将角色会话名称指定为命令行参数。

注意

此环境变量仅适用于使用 Web 身份提供者的代入角色，而不适用于常规代入角色提供商配置。

有关使用 Web 身份的更多信息，请参阅 通过 Web 身份代入角色。

AWS_ROLE_SESSION_NAME

指定要附加到角色会话的名称。此值在 RoleSessionName 调用 Amazon CLI 操作时将提供给 AssumeRole 参数，并成为代入角色用户 ARN 的一部分： arn:aws:sts::123456789012:assumed-role/role_name/role_session_name。此参数为可选参数。如果未提供此值，则将自动生成会话名称。此名称显示在与此会话关联的条目的 Amazon CloudTrail 日志中。

如果已定义此环境变量，它将覆盖配置文件设置 role_session_name 的值。

结合使用 AWS_ROLE_ARN 和 AWS_WEB_IDENTITY_TOKEN_FILE 环境变量。

有关使用 Web 身份的更多信息，请参阅 通过 Web 身份代入角色。

注意

此环境变量仅适用于使用 Web 身份提供者的代入角色，而不适用于常规代入角色提供商配置。

AWS_SDK_UA_APP_ID

一个 Amazon Web Services 账户可以供多个客户应用程序来调用 Amazon Web Services 服务。应用程序 ID 标识哪个源应用程序使用 Amazon Web Services 服务 进行了一组调用。AmazonSDK 和服务不会使用或解释此值，除非将其显示在客户通信中。例如，此值可以包含在操作电子邮件中，以唯一标识您的哪个应用程序与通知相关联。

默认情况下，没有值。

应用程序 ID 是一个字符串，最大长度为 50 个字符。允许使用字母、数字和以下特殊字符：

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

如果已定义此环境变量，它将覆盖 sdk_ua_app_id 配置文件设置的值。您不能将应用程序 ID 指定为命令行选项。

AWS_SECRET_ACCESS_KEY

指定与访问密钥关联的私有密钥。这基本上是访问密钥的“密码”。

如果已定义此环境变量，它将覆盖配置文件设置 aws_secret_access_key 的值。您不能将秘密访问密钥 ID 指定为命令行选项。

AWS_SESSION_TOKEN

指定在使用您直接从 Amazon STS 操作中检索的临时安全凭证时需要的会话令牌值。有关更多信息，请参阅 Amazon CLI 命令引用中的代入角色命令的输出部分。

如果已定义此环境变量，它将覆盖配置文件设置 aws_session_token 的值。

AWS_SHARED_CREDENTIALS_FILE

指定 Amazon CLI 用于存储访问密钥的文件的位置。默认路径为 ~/.aws/credentials。

您不能在命名配置文件设置中或使用命令行参数来指定此值。

AWS_SIGV4A_SIGNING_REGION_SET

使用逗号分隔列表指定在通过 SigV4a 进行签名时要使用的区域。如果未设置此变量，Amazon CLI 会使用 Amazon Web Services 服务 所使用的默认值。如果 Amazon Web Services 服务 没有默认值，则请求签名将使用 * 作为值，在所有区域内生效。

有关 SigV4a 的更多信息，请参阅《IAM 用户指南》中的适用于 API 请求的 Amazon 签名版本 4。

如果已定义此环境变量，它将覆盖 sigv4a_signing_region_set 配置文件设置的值。

AWS_USE_DUALSTACK_ENDPOINT

允许使用双堆栈端点发送 Amazon 请求。要详细了解支持 IPv4 和 IPv6 流量的双堆栈端点，请参阅 Amazon Simple Storage Service 用户指南中的使用 Amazon S3 双堆栈端点。双堆栈端点适用于某些区域。如果不存在适用于服务和/或 Amazon Web Services 区域的双堆栈端点，则请求将失败。默认情况下，将禁用该功能。有关更多信息，请参阅 设置成为所有 Amazon Web Services 服务使用双堆栈端点。

端点优先级

端点配置设置位于多个位置（例如，系统变量或用户环境变量、本地 Amazon 配置文件），或者在命令行上显式声明为参数。Amazon CLI 按特定顺序检查这些端点设置，并使用优先级最高的端点设置。有关端点优先级列表，请参阅端点配置和设置优先级。

AWS_USE_FIPS_ENDPOINT

在某些 Amazon Web Services 区域，部分 Amazon 服务提供支持美国联邦信息处理标准 (FIPS) 140-2 的端点。当 Amazon 服务支持 FIPS 时，此设置指定 Amazon CLI 应使用哪个 FIPS 端点。与标准 Amazon 端点不同，FIPS 端点使用符合 FIPS 140-2 的 TLS 软件库。与美国政府有业务来往的企业可能需要使用这些端点。有关更多信息，请参阅设置成为所有 Amazon Web Services 服务使用 FIPS 端点。

如果启用此设置，但不存在适用于您所在 Amazon Web Services 区域中的服务的 FIPS 端点，则 Amazon 命令可能会失败。在这种情况下，请使用 --endpoint-url 选项手动指定要在命令中使用的端点，或者使用特定于服务的端点。

端点优先级

端点配置设置位于多个位置（例如，系统变量或用户环境变量、本地 Amazon 配置文件），或者在命令行上显式声明为参数。Amazon CLI 按特定顺序检查这些端点设置，并使用优先级最高的端点设置。有关端点优先级列表，请参阅端点配置和设置优先级。

AWS_WEB_IDENTITY_TOKEN_FILE

指定一个文件的路径，该文件包含由身份提供者提供的 OAuth 2.0 访问令牌或 OpenID Connect ID 令牌。Amazon CLI 加载此文件的内容，并将其作为 WebIdentityToken 参数传递给 AssumeRoleWithWebIdentity 操作。

结合使用 AWS_ROLE_ARN 和 AWS_ROLE_SESSION_NAME 环境变量。

如果已定义此环境变量，它将覆盖配置文件设置 web_identity_token_file 的值。

有关使用 Web 身份的更多信息，请参阅 通过 Web 身份代入角色。

注意

此环境变量仅适用于使用 Web 身份提供者的代入角色，而不适用于常规代入角色提供商配置。