Variables de entorno para configurar el AWS CLI

AWS CLI Admite las siguientes variables de entorno.

AWS_ACCESS_KEY_ID

Especifica una clave de AWS acceso asociada a una cuenta de IAM.

Si se define, esta variable de entorno anula el valor de la configuración del perfil aws_access_key_id. No se puede especificar el ID de clave de acceso mediante una opción de línea de comandos.

AWS_CA_BUNDLE

Especifica la ruta a un paquete de certificados que desea utilizar para la validación de certificados HTTPS.

Si se define, esta variable de entorno anula el valor de la configuración del perfil ca_bundle. Puede anular esta variable de entorno mediante el parámetro de la línea de comandos --ca-bundle.

AWS_CLI_AUTO_PROMPT

Activa el mensaje automático para la AWS CLI versión 2. Hay dos configuraciones que se pueden usar:

• on utiliza el modo de petición automática completa cada vez que intenta ejecutar un comando de aws. Esto incluye presionar ENTER (INTRO) después de un comando completo o un comando incompleto.

• on-partial utiliza el modo de petición automática parcial. Si un comando está incompleto o no se puede ejecutar debido a errores de validación del lado del cliente, se utiliza la petición automática. Este modo es útil si tiene scripts o manuales preexistentes o si solo desea que se le pidan automáticamente los comandos con los que no está familiarizado en lugar de que se le soliciten en todos los comandos.

Si se define, esta variable de entorno anula el valor de la configuración del perfil cli_auto_prompt. Puede anular esta variable de entorno mediante los parámetros de la línea de comandos --cli-auto-prompt y --no-cli-auto-prompt.

Para obtener información sobre la función de aviso automático de la AWS CLI versión 2, consulteTener una solicitud de la AWS CLI para los comandos.

AWS_CLI_FILE_ENCODING

Especifica la codificación utilizada para los archivos de texto. De forma predeterminada, la codificación coincide con su configuración regional. Para establecer que una codificación distinta de la configuración regional, utilice la variable de entorno aws_cli_file_encoding. Por ejemplo, si utiliza Windows con codificación predeterminada CP1252, la configuración de aws_cli_file_encoding=UTF-8 establece la CLI para que abra archivos de texto mediante UTF-8.

AWS_CLI_S3_MV_VALIDATE_SAME_S3_PATHS

Si los depósitos de origen y destino son los mismos al utilizar el s3 mv comando custom the, el archivo u objeto fuente se puede mover sobre sí mismo, lo que puede provocar la eliminación accidental del archivo u objeto fuente. La variable de AWS_CLI_S3_MV_VALIDATE_SAME_S3_PATHS entorno y la --validate-same-s3-paths opción especifican si se deben validar los ARN o los alias de los puntos de acceso en los URI de origen o destino de Amazon S3.

nota

La validación de rutas s3 mv requiere llamadas a la API adicionales.

AWS_CONFIG_FILE

Especifica la ubicación del archivo que AWS CLI utiliza para almacenar los perfiles de configuración. La ruta predeterminada es ~/.aws/config.

No puede especificar este valor en una configuración de perfil con nombre o mediante un parámetro de la línea de comandos.

AWS_DATA_PATH

Una lista de directorios adicionales para comprobar fuera de la ruta de búsqueda integrada ~/.aws/models al cargar AWS CLI los datos. La configuración de esta variable de entorno indica los directorios adicionales que hay que comprobar primero antes de recurrir a las rutas de búsqueda integradas. Varias entradas se deben separar con el carácter os.pathsep que ‎es : en Linux o macOS y ; en Windows.

AWS_DEFAULT_OUTPUT

Especifica el formato de salida que se va a utilizar.

Si se define, esta variable de entorno anula el valor de la configuración del perfil output. Puede anular esta variable de entorno mediante el parámetro de la línea de comandos --output.

AWS_DEFAULT_REGION

Default region nameIdentifica la AWS región a cuyos servidores quieres enviar tus solicitudes de forma predeterminada. Suele ser la región más cercana a usted, pero puede ser cualquier región. Por ejemplo, puede escribir us-west-2 para utilizar EE.UU. Oeste (Oregón). Esta es la región a la que se envían todas las solicitudes posteriores, a menos que especifique lo contrario en un comando concreto.

nota

Debe especificar una AWS región cuando utilice la AWS CLI, ya sea de forma explícita o configurando una región predeterminada. Para obtener una lista de las regiones disponibles, consulte Regiones y puntos de enlace. Los designadores de región que utilizan AWS CLI son los mismos nombres que aparecen en las AWS Management Console URL y en los puntos de enlace del servicio.

Si se define, esta variable de entorno anula el valor de la configuración del perfil region. Puede anular esta variable de entorno mediante el parámetro de línea de --region comandos y la variable de entorno compatible con el AWS SDK. AWS_REGION

AWS_EC2_METADATA_DISABLED

Desactiva el uso del servicio de metadatos de la instancia de Amazon EC2 (IMDS).

Si se establece en true (verdadero), las credenciales de usuario o la configuración (como la región) no se solicitan desde IMDS.

AWS_ENDPOINT_URL

Especifica el punto de conexión que se utiliza para todas las solicitudes de servicio.

Los ajustes de configuración del punto final se encuentran en varios lugares, como las variables de entorno del sistema o del usuario, los archivos de AWS configuración locales, o se declaran explícitamente en la línea de comandos como parámetros. Los ajustes de configuración del punto de conexión de la AWS CLI tienen prioridad en el siguiente orden:

1. La opción de línea de comandos --endpoint-url.

2. Si está habilitada, la variable de entorno del punto de conexión AWS_IGNORE_CONFIGURED_ENDPOINT_URLS global o la configuración del perfil ignore_configure_endpoint_urls para ignorar los puntos de conexión personalizados.

3. El valor proporcionado por una variable de entorno específica del servicio AWS_ENDPOINT_URL_<SERVICE>, como AWS_ENDPOINT_URL_DYNAMODB.

4. Los valores proporcionados por las variables de entorno AWS_USE_DUALSTACK_ENDPOINT, AWS_USE_FIPS_ENDPOINT y AWS_ENDPOINT_URL.

5. El valor de punto de conexión específico del servicio proporcionado por la configuración endpoint_url de una sección de services del archivo compartido config.

6. El valor proporcionado por la configuración endpoint_url en un profile de un archivo compartido config.

7. Configuración de use_dualstack_endpoint, use_fips_endpoint y endpoint_url.

8. En último lugar, Servicio de AWS se utilizará cualquier URL de punto final predeterminada correspondiente. Para obtener una lista de los puntos de enlace de servicio estándar disponibles en cada región, consulte Regiones y puntos de enlace de AWS en la Referencia general de Amazon Web Services.

AWS_ENDPOINT_URL_<SERVICE>

Especifica un punto final personalizado que se utiliza para un servicio específico, donde <SERVICE> se sustituye por el Servicio de AWS identificador. Por ejemplo, Amazon DynamoDB tiene una serviceId de DynamoDB. Para este servicio, la variable de entorno de la URL del punto de conexión es AWS_ENDPOINT_URL_DYNAMODB.

Para obtener una lista de todas las variables de entorno específicas del servicio, consulte Lista de identificadores específicos del servicio.

Los valores de configuración del punto final se encuentran en varios lugares, como las variables de entorno del sistema o del usuario, los archivos de AWS configuración locales, o se declaran explícitamente en la línea de comandos como parámetros. Los ajustes de configuración del punto de conexión de la AWS CLI tienen prioridad en el siguiente orden:

1. La opción de línea de comandos --endpoint-url.

2. Si está habilitada, la variable de entorno del punto de conexión AWS_IGNORE_CONFIGURED_ENDPOINT_URLS global o la configuración del perfil ignore_configure_endpoint_urls para ignorar los puntos de conexión personalizados.

3. El valor proporcionado por una variable de entorno específica del servicio AWS_ENDPOINT_URL_<SERVICE>, como AWS_ENDPOINT_URL_DYNAMODB.

4. Los valores proporcionados por las variables de entorno AWS_USE_DUALSTACK_ENDPOINT, AWS_USE_FIPS_ENDPOINT y AWS_ENDPOINT_URL.

5. El valor de punto de conexión específico del servicio proporcionado por la configuración endpoint_url de una sección de services del archivo compartido config.

6. El valor proporcionado por la configuración endpoint_url en un profile de un archivo compartido config.

7. Configuración de use_dualstack_endpoint, use_fips_endpoint y endpoint_url.

8. En último lugar, Servicio de AWS se utilizará cualquier URL de punto final predeterminada correspondiente. Para obtener una lista de los puntos de enlace de servicio estándar disponibles en cada región, consulte Regiones y puntos de enlace de AWS en la Referencia general de Amazon Web Services.

AWS_IGNORE_CONFIGURED_ENDPOINT_URLS

Si está habilitada, AWS CLI ignora todas las configuraciones de punto final personalizadas. Los valores válidos son true y false.

Los ajustes de configuración de los puntos finales se encuentran en varios lugares, como las variables de entorno del sistema o del usuario, los archivos de AWS configuración locales, o se declaran explícitamente en la línea de comandos como parámetros. Los ajustes de configuración del punto de conexión de la AWS CLI tienen prioridad en el siguiente orden:

1. La opción de línea de comandos --endpoint-url.

2. Si está habilitada, la variable de entorno del punto de conexión AWS_IGNORE_CONFIGURED_ENDPOINT_URLS global o la configuración del perfil ignore_configure_endpoint_urls para ignorar los puntos de conexión personalizados.

3. El valor proporcionado por una variable de entorno específica del servicio AWS_ENDPOINT_URL_<SERVICE>, como AWS_ENDPOINT_URL_DYNAMODB.

4. Los valores proporcionados por las variables de entorno AWS_USE_DUALSTACK_ENDPOINT, AWS_USE_FIPS_ENDPOINT y AWS_ENDPOINT_URL.

5. El valor de punto de conexión específico del servicio proporcionado por la configuración endpoint_url de una sección de services del archivo compartido config.

6. El valor proporcionado por la configuración endpoint_url en un profile de un archivo compartido config.

7. Configuración de use_dualstack_endpoint, use_fips_endpoint y endpoint_url.

8. En último lugar, Servicio de AWS se utilizará cualquier URL de punto final predeterminada correspondiente. Para obtener una lista de los puntos de enlace de servicio estándar disponibles en cada región, consulte Regiones y puntos de enlace de AWS en la Referencia general de Amazon Web Services.

AWS_MAX_ATTEMPTS

Especifica el valor máximo de reintentos que utiliza el controlador de AWS CLI reintentos, donde la llamada inicial se tiene en cuenta para el valor que usted proporciona. Para obtener más información acerca de los reintentos, consulte Reintentos de AWS CLI.

Si se define, esta variable de entorno anula el valor de la configuración de los perfiles max_attempts.

AWS_METADATA_SERVICE_NUM_ATTEMPTS

Al intentar recuperar las credenciales en una instancia de Amazon EC2 que se ha configurado con un rol de IAM, AWS CLI intenta recuperar las credenciales una vez del servicio de metadatos de la instancia antes de detenerse. Si sabe que los comandos se ejecutarán en una instancia de Amazon EC2, puede aumentar este valor ‎para que AWS CLI realice varios intentos antes de desistir.

AWS_METADATA_SERVICE_TIMEOUT

El número de segundos antes de que una conexión al servicio de metadatos de la instancia agote el tiempo de espera. Al intentar recuperar las credenciales en una instancia de Amazon EC2 que se ha configurado con un rol de IAM, una conexión al servicio de metadatos de instancia agotará el tiempo de espera después de 1 segundo de forma predeterminada. Si sabe que está ejecutando en una instancia de Amazon EC2 con un rol de IAM configurado, puede aumentar este valor si es necesario.

AWS_PAGER

Especifica el programa de paginación utilizado para la salida. De forma predeterminada, AWS CLI la versión 2 devuelve todos los resultados mediante el programa localizador predeterminado del sistema operativo.

Para deshabilitar todo el uso de un programa de paginación externo, establezca la variable en una cadena vacía.

Si se define, esta variable de entorno anula el valor de la configuración del perfil cli_pager.

AWS_PROFILE

Especifica el nombre del AWS CLI perfil con las credenciales y las opciones que se van a utilizar. Puede ser el nombre de un perfil almacenado en un archivo credentials o config, o el valor default para utilizar el perfil predeterminado.

Si se define, esta variable de entorno anula el comportamiento de utilizar el perfil llamado [default] en el archivo de configuración. Puede anular esta variable de entorno mediante el parámetro de la línea de comandos --profile.

AWS_REGION

La variable de entorno compatible con el AWS SDK que especifica la AWS región a la que se va a enviar la solicitud.

Si se define, esta variable de entorno invalida los valores de la variable de entorno AWS_DEFAULT_REGION y la configuración del perfil de region. Puede anular esta variable de entorno mediante el parámetro de la línea de comandos --region.

AWS_RETRY_MODE

Especifica qué modo de reintento se AWS CLI utiliza. Hay tres modos de reintento disponibles: heredado (predeterminado), estándar y adaptativo. Para obtener más información acerca de los reintentos, consulte Reintentos de AWS CLI.

Si se define, esta variable de entorno anula el valor de la configuración de los perfiles retry_mode.

AWS_ROLE_ARN

Especifica el nombre de recurso de Amazon (ARN) de un rol de IAM con un proveedor de identidad web que desea utilizar para ejecutar los comandos. AWS CLI

Se utiliza con las variables de entorno AWS_WEB_IDENTITY_TOKEN_FILE y AWS_ROLE_SESSION_NAME.

Si se define, esta variable de entorno anula el valor de la configuración del perfil role_arn. No se puede especificar un nombre de sesión de rol como parámetro de línea de comandos.

nota

Esta variable de entorno solo se aplica a un rol asumido con proveedor de identidad web y no se aplican a la configuración general del proveedor de roles asumidos.

Para obtener más información sobre el uso de identidades web, consulte Adopción de un rol con una identidad web.

AWS_ROLE_SESSION_NAME

Especifica el nombre que se va a asociar a la sesión de rol. Este valor se proporciona al RoleSessionName parámetro cuando AWS CLI llama a la AssumeRole operación y pasa a formar parte del rol asumido por el usuario ARN:. arn:aws:sts::123456789012:assumed-role/role_name/role_session_name Se trata de un parámetro opcional. Si no proporciona este valor, se genera automáticamente un nombre de sesión. Este nombre aparece en AWS CloudTrail los registros de las entradas asociadas a esta sesión.

Si se define, esta variable de entorno anula el valor de la configuración del perfil role_session_name.

Se utiliza con las variables de entorno AWS_ROLE_ARN y AWS_WEB_IDENTITY_TOKEN_FILE.

Para obtener más información sobre el uso de identidades web, consulte Adopción de un rol con una identidad web.

nota

Esta variable de entorno solo se aplica a un rol asumido con proveedor de identidad web y no se aplican a la configuración general del proveedor de roles asumidos.

AWS_SECRET_ACCESS_KEY

Especifica la clave secreta asociada a la clave de acceso. Se trata básicamente de la "contraseña" de la clave de acceso.

Si se define, esta variable de entorno anula el valor de la configuración del perfil aws_secret_access_key. No se puede especificar la ID de clave de acceso secreta como una opción de línea de comandos.

AWS_SESSION_TOKEN

Especifica el valor del token de sesión que se requiere si utiliza credenciales de seguridad temporales que ha recuperado directamente de las operaciones de AWS STS . Para obtener más información, consulte la sección Output del comando de rol asumido en la Referencia de comando de AWS CLI .

Si se define, esta variable de entorno anula el valor de la configuración del perfil aws_session_token.

AWS_SHARED_CREDENTIALS_FILE

Especifica la ubicación del archivo que AWS CLI utiliza para almacenar las claves de acceso. La ruta predeterminada es ~/.aws/credentials.

No puede especificar este valor en una configuración de perfil con nombre o mediante un parámetro de la línea de comandos.

AWS_USE_DUALSTACK_ENDPOINT

Permite el uso de puntos finales de doble pila para enviar AWS solicitudes. Para obtener más información sobre los puntos de conexión de doble pila, que admiten tráfico de IPv4 e IPv6, consulte Uso de puntos de conexión de doble pila de Amazon S3 en la Guía del usuario de Amazon Simple Storage Service. Los puntos de conexión de doble pila están disponibles para algunos servicios en algunas regiones. Si no existe un punto final de doble pila para el servicio o si la solicitud Región de AWS falla. Esta opción está deshabilitada de forma predeterminada.

Los ajustes de configuración del punto final se encuentran en varios lugares, como las variables de entorno del sistema o del usuario, los archivos de AWS configuración locales, o se declaran explícitamente en la línea de comandos como parámetros. Los ajustes de configuración del punto de conexión de la AWS CLI tienen prioridad en el siguiente orden:

1. La opción de línea de comandos --endpoint-url.

2. Si está habilitada, la variable de entorno del punto de conexión AWS_IGNORE_CONFIGURED_ENDPOINT_URLS global o la configuración del perfil ignore_configure_endpoint_urls para ignorar los puntos de conexión personalizados.

3. El valor proporcionado por una variable de entorno específica del servicio AWS_ENDPOINT_URL_<SERVICE>, como AWS_ENDPOINT_URL_DYNAMODB.

4. Los valores proporcionados por las variables de entorno AWS_USE_DUALSTACK_ENDPOINT, AWS_USE_FIPS_ENDPOINT y AWS_ENDPOINT_URL.

5. El valor de punto de conexión específico del servicio proporcionado por la configuración endpoint_url de una sección de services del archivo compartido config.

6. El valor proporcionado por la configuración endpoint_url en un profile de un archivo compartido config.

7. Configuración de use_dualstack_endpoint, use_fips_endpoint y endpoint_url.

8. En último lugar, Servicio de AWS se utilizará cualquier URL de punto final predeterminada correspondiente. Para obtener una lista de los puntos de enlace de servicio estándar disponibles en cada región, consulte Regiones y puntos de enlace de AWS en la Referencia general de Amazon Web Services.

AWS_USE_FIPS_ENDPOINT

Algunos AWS servicios ofrecen terminales que, en algunos casos, son compatibles con la Norma Federal de Procesamiento de Información (FIPS) 140-2. Regiones de AWS Cuando el servicio de AWS es compatible con FIPS, esta configuración establece qué punto de conexión FIPS debe utilizar la AWS CLI . A diferencia de AWS los terminales estándar, los terminales FIPS utilizan una biblioteca de software TLS que cumple con la norma FIPS 140-2. Las empresas que trabajan con el gobierno de los Estados Unidos pueden requerir estos puntos de conexión.

Si esta configuración está habilitada, pero no existe un punto final FIPS para el servicio en su servidor, es posible que se produzca un error en el comando. Región de AWS AWS En este caso, especifique manualmente el punto de conexión que se va a utilizar en el comando mediante la opción --endpoint-url o utilice los puntos de conexión específicos del servicio.

Para obtener más información sobre cómo especificar los puntos de enlace de FIPS por Región de AWS, consulte Puntos de enlace de FIPS por servicio.

Los ajustes de configuración de los terminales se encuentran en varios lugares, como las variables de entorno del sistema o del usuario, los archivos de AWS configuración locales, o se declaran explícitamente en la línea de comandos como parámetros. Los ajustes de configuración del punto de conexión de la AWS CLI tienen prioridad en el siguiente orden:

1. La opción de línea de comandos --endpoint-url.

2. Si está habilitada, la variable de entorno del punto de conexión AWS_IGNORE_CONFIGURED_ENDPOINT_URLS global o la configuración del perfil ignore_configure_endpoint_urls para ignorar los puntos de conexión personalizados.

3. El valor proporcionado por una variable de entorno específica del servicio AWS_ENDPOINT_URL_<SERVICE>, como AWS_ENDPOINT_URL_DYNAMODB.

4. Los valores proporcionados por las variables de entorno AWS_USE_DUALSTACK_ENDPOINT, AWS_USE_FIPS_ENDPOINT y AWS_ENDPOINT_URL.

5. El valor de punto de conexión específico del servicio proporcionado por la configuración endpoint_url de una sección de services del archivo compartido config.

6. El valor proporcionado por la configuración endpoint_url en un profile de un archivo compartido config.

7. Configuración de use_dualstack_endpoint, use_fips_endpoint y endpoint_url.

8. En último lugar, Servicio de AWS se utilizará cualquier URL de punto final predeterminada correspondiente. Para obtener una lista de los puntos de enlace de servicio estándar disponibles en cada región, consulte Regiones y puntos de enlace de AWS en la Referencia general de Amazon Web Services.

AWS_WEB_IDENTITY_TOKEN_FILE

Especifica la ruta de un archivo que contiene un token de acceso de OAuth 2.0 o un token de ID de OpenID Connect proporcionado por un proveedor de identidades. La AWS CLI carga el contenido de este archivo y lo pasa como argumento WebIdentityToken a la operación AssumeRoleWithWebIdentity.

Se utiliza con las variables de entorno AWS_ROLE_ARN y AWS_ROLE_SESSION_NAME.

Si se define, esta variable de entorno anula el valor de la configuración del perfil web_identity_token_file.

Para obtener más información sobre el uso de identidades web, consulte Adopción de un rol con una identidad web.

nota

Esta variable de entorno solo se aplica a un rol asumido con proveedor de identidad web y no se aplican a la configuración general del proveedor de roles asumidos.