Configuración de variables de entorno para AWS CLI

AWS CLI Admite las siguientes variables de entorno.

AWS_ACCESS_KEY_ID

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

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 se utilizará para la validación de HTTPS certificados.

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_S3_MV_VALIDATE_SAME_S3_PATHS

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

nota

La validación de rutas s3 mv requiere API llamadas 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 AWS Management Console URLs los puntos finales 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 .

AWS_EC2_METADATA_DISABLED

Inhabilita el uso del servicio de metadatos de EC2 instancias de Amazon (IMDS).

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

AWS_ENDPOINT_URL

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

Los valores de configuración del punto final se encuentran en varios lugares, como las variables de entorno del sistema o del usuario o 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 se utiliza cualquier punto final predeterminado URL para el respectivo Servicio de AWS . 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 URL entorno del punto final esAWS_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 se utiliza cualquier punto final predeterminado URL para el respectivo Servicio de AWS . 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á activado, 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 se utiliza cualquier punto final predeterminado URL para el respectivo Servicio de AWS . 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 AWS CLI vuelve a intentarlo en el 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 EC2 instancia de Amazon que se ha configurado con un IAM rol, AWS CLI intenta recuperar las credenciales una vez del servicio de metadatos de la instancia antes de detenerse. Si sabes que tus comandos se ejecutarán en una EC2 instancia de Amazon, puedes aumentar este valor para AWS CLI volver a intentarlo varias veces antes de darte por vencido.

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 de una EC2 instancia de Amazon que está configurada con un IAM rol, se agota el tiempo de espera de la conexión al servicio de metadatos de la instancia después de 1 segundo de forma predeterminada. Si sabes que estás ejecutando una EC2 instancia de Amazon con un IAM rol configurado, puedes aumentar este valor si es necesario.

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_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 AWS CLI vuelve a intentarlo en el 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 IAM rol con un proveedor de identidad web que desea usar para ejecutar los AWS CLI comandos.

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 userARN: 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_SDK_UA_APP_ID

Varias aplicaciones de clientes Cuenta de AWS pueden utilizar una sola aplicación para realizar llamadas Servicios de AWS. El ID de aplicación identifica qué aplicación de origen realizó un conjunto de llamadas mediante un Servicio de AWS. AWS SDKsy los servicios no utilizan ni interpretan este valor más que para mostrarlo en las comunicaciones con los clientes. Por ejemplo, este valor se puede incluir en los correos electrónicos operativos para identificar de forma exclusiva qué aplicaciones están asociadas a la notificación.

De forma predeterminada, no hay ningún valor.

El identificador de la aplicación es una cadena con una longitud máxima de 50 caracteres. Se permiten letras, números y los siguientes caracteres especiales:

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

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

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_STS_REGIONAL_ENDPOINTS

Especifica cómo AWS CLI determina el punto final del AWS servicio que el AWS CLI cliente utiliza para comunicarse con el AWS Security Token Service (AWS STS). El valor predeterminado para la versión 1 de AWS CLI es legacy.

Puede especificar uno de estos dos valores:

• legacy— Utiliza el STS punto final globalsts.amazonaws.com,, para las siguientes AWS regiones: ap-northeast-1ap-south-1,,ap-southeast-1,ap-southeast-2,aws-global,ca-central-1,eu-central-1,eu-north-1,eu-west-1,eu-west-2,eu-west-3,sa-east-1,us-east-1,us-east-2,us-west-1, yus-west-2. Todas las demás regiones utilizan automáticamente su punto de conexión regional respectivo.

• regional— AWS CLI Siempre usa el AWS STS punto final de la región configurada actualmente. Por ejemplo, si el cliente está configurado para usarlous-west-2, todas las llamadas AWS STS se realizan al punto final regional sts.us-west-2.amazonaws.com en lugar de al sts.amazonaws.com punto final global. Para enviar una solicitud al punto de enlace global mientras esta configuración está habilitada, puede establecer la región en aws-global.

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 enlace de doble pila, que admiten tanto como IPv4 el IPv6 tráfico, consulte Uso de los puntos de enlace 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 Región de AWS si la solicitud 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 se utiliza cualquier punto final predeterminado URL para el respectivo Servicio de AWS . 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 la Información (FIPS) 140-2. Regiones de AWS Cuando el AWS servicio lo admiteFIPS, esta configuración especifica qué FIPS punto final AWS CLI debe usar. A diferencia de AWS los puntos finales estándar, los FIPS puntos finales utilizan una biblioteca de TLS software que cumple con FIPS la norma 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 FIPS punto final para el servicio en su servidor Región de AWS, es posible que se produzca un error en el AWS comando. 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 FIPS puntos de enlace por Región de AWS, consulte FIPSPuntos finales 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 se utiliza cualquier punto final predeterminado URL para el respectivo Servicio de AWS . 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 a un archivo que contiene un token de acceso OAuth 2.0 o un token de ID de OpenID Connect proporcionado por un proveedor de identidad. 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.