Variables d'environnement pour configurer le AWS CLI

AWS CLI prend en charge les variables d'environnement suivantes.

AWS_ACCESS_KEY_ID

Spécifie une clé AWS d'accès associée à un IAM compte.

Si elle est définie, cette variable d'environnement remplace la valeur du paramètre de profil aws_access_key_id. Vous ne pouvez pas spécifier l'ID de clé d'accès en utilisant une option de ligne de commande.

AWS_CA_BUNDLE

Spécifie le chemin d'accès à un ensemble de certificats à utiliser pour la validation des HTTPS certificats.

Si elle est définie, cette variable d'environnement remplace la valeur du paramètre de profil ca_bundle. Vous pouvez remplacer cette variable d'environnement à l'aide du paramètre de ligne de commande --ca-bundle.

AWS_CLI_S3_MV_VALIDATE_SAME_S3_PATHS

Si les compartiments source et de destination sont identiques lors de l'utilisation de la s3 mv commande personnalisée, le fichier source ou l'objet peut être déplacé sur lui-même, ce qui peut entraîner la suppression accidentelle de votre fichier ou objet source. La variable et l'--validate-same-s3-pathsoption d'AWS_CLI_S3_MV_VALIDATE_SAME_S3_PATHSenvironnement indiquent s'il faut valider votre point d'accès ARNs ou ses alias dans votre source ou votre destination URIs Amazon S3.

Note

La validation du chemin pour s3 mv nécessite des API appels supplémentaires.

AWS_CONFIG_FILE

Spécifie l'emplacement du fichier AWS CLI utilisé pour stocker les profils de configuration. Le chemin par défaut est ~/.aws/config.

Vous ne pouvez pas spécifier cette valeur dans un paramètre de profil nommé ou à l'aide d'un paramètre de ligne de commande.

AWS_DATA_PATH

Une liste de répertoires supplémentaires à vérifier en dehors du chemin de recherche intégré ou ~/.aws/models lors du chargement de AWS CLI données. La définition de cette variable d'environnement indique les répertoires supplémentaires à vérifier avant de revenir au chemin de recherche intégré. Les entrées multiples doivent être séparées par le os.pathsep caractère, qui se trouve : sous Linux ou macOS et ; sous Windows.

AWS_DEFAULT_OUTPUT

Spécifie le format de sortie à utiliser.

Si elle est définie, cette variable d'environnement remplace la valeur du paramètre de profil output. Vous pouvez remplacer cette variable d'environnement à l'aide du paramètre de ligne de commande --output.

AWS_DEFAULT_REGION

Default region nameIdentifie la AWS région à laquelle vous souhaitez envoyer vos demandes par défaut aux serveurs. Il s'agit généralement de la région la plus proche de vous, mais il peut s'agir de n'importe quelle autre région. Par exemple, vous pouvez taper us-west-2 pour utiliser US West (Oregon). Il s'agit de la région à laquelle toutes les requêtes ultérieures sont envoyées, à moins que vous ne spécifiiez une autre option dans une commande individuelle.

Note

Vous devez spécifier une AWS région lorsque vous utilisez le AWS CLI, soit explicitement, soit en définissant une région par défaut. Pour connaître la liste des régions disponibles, consultez Régions et points de terminaison. Les désignateurs de région utilisés par le AWS CLI sont les mêmes noms que ceux que vous voyez dans les points de terminaison AWS Management Console URLs de service.

Si elle est définie, cette variable d'environnement remplace la valeur du paramètre de profil region. Vous pouvez remplacer cette variable d'environnement à l'aide du paramètre de ligne de --region commande .

AWS_EC2_METADATA_DISABLED

Désactive l'utilisation du service de métadonnées d'EC2instance Amazon (IMDS).

Si ce paramètre est défini sur true, les informations d'identification de l'utilisateur ou la configuration (comme la région) ne sont pas demandéesIMDS.

AWS_ENDPOINT_URL

Spécifie le point de terminaison utilisé pour toutes les demandes de service.

Les paramètres de configuration du point de terminaison se trouvent à plusieurs endroits, tels que les variables d'environnement système ou utilisateur, les fichiers de AWS configuration locaux, ou sont explicitement déclarés sur la ligne de commande en tant que paramètre. Les paramètres de configuration du point de AWS CLI terminaison sont prioritaires dans l'ordre suivant :

1. L'option --endpoint-url de ligne de commande.

2. Si cette option est activée, la variable d'environnement AWS_IGNORE_CONFIGURED_ENDPOINT_URLS global du point de terminaison ou le paramètre ignore_configure_endpoint_urls de profil ignore les points de terminaison personnalisés.

3. La valeur fournie par une variable d'environnement spécifique au serviceAWS_ENDPOINT_URL_<SERVICE>, telle que. AWS_ENDPOINT_URL_DYNAMODB

4. Les valeurs fournies par les variables d'AWS_ENDPOINT_URLenvironnement AWS_USE_DUALSTACK_ENDPOINTAWS_USE_FIPS_ENDPOINT, et.

5. La valeur du point de terminaison spécifique au service fournie par le endpoint_url paramètre dans une services section du fichier partagéconfig.

6. La valeur fournie par le endpoint_url paramètre dans un profile config fichier partagé.

7. use_dualstack_endpointuse_fips_endpoint, et endpoint_url paramètres.

8. Tout point de terminaison par défaut URL pour le point correspondant AWS service est utilisé en dernier. Pour afficher la liste des points de terminaison de service disponibles dans chaque région, consultez Régions et points de terminaison AWS dans le document Référence générale d'Amazon Web Services.

AWS_ENDPOINT_URL_<SERVICE>

Spécifie un point de terminaison personnalisé utilisé pour un service spécifique, où <SERVICE> il est remplacé par l' AWS service identifiant. Par exemple, Amazon DynamoDB possède un serviceId de DynamoDB. Pour ce service, la variable d'URLenvironnement du point de terminaison estAWS_ENDPOINT_URL_DYNAMODB.

Pour obtenir la liste de toutes les variables d'environnement spécifiques au service, consultez. Liste des identifiants spécifiques au service

Les paramètres de configuration du point de terminaison se trouvent à plusieurs endroits, tels que les variables d'environnement système ou utilisateur, les fichiers de AWS configuration locaux, ou sont explicitement déclarés sur la ligne de commande en tant que paramètre. Les paramètres de configuration du point de AWS CLI terminaison sont prioritaires dans l'ordre suivant :

1. L'option --endpoint-url de ligne de commande.

2. Si cette option est activée, la variable d'environnement AWS_IGNORE_CONFIGURED_ENDPOINT_URLS global du point de terminaison ou le paramètre ignore_configure_endpoint_urls de profil ignore les points de terminaison personnalisés.

3. La valeur fournie par une variable d'environnement spécifique au serviceAWS_ENDPOINT_URL_<SERVICE>, telle que. AWS_ENDPOINT_URL_DYNAMODB

4. Les valeurs fournies par les variables d'AWS_ENDPOINT_URLenvironnement AWS_USE_DUALSTACK_ENDPOINTAWS_USE_FIPS_ENDPOINT, et.

5. La valeur du point de terminaison spécifique au service fournie par le endpoint_url paramètre dans une services section du fichier partagéconfig.

6. La valeur fournie par le endpoint_url paramètre dans un profile config fichier partagé.

7. use_dualstack_endpointuse_fips_endpoint, et endpoint_url paramètres.

8. Tout point de terminaison par défaut URL pour le point correspondant AWS service est utilisé en dernier. Pour afficher la liste des points de terminaison de service disponibles dans chaque région, consultez Régions et points de terminaison AWS dans le document Référence générale d'Amazon Web Services.

AWS_IGNORE_CONFIGURED_ENDPOINT_URLS

Si cette option est activée, toutes les configurations de point de terminaison personnalisées sont AWS CLI ignorées. Les valeurs valides sont true et false.

Les paramètres de configuration du point de terminaison se trouvent à plusieurs endroits, tels que les variables d'environnement système ou utilisateur, les fichiers de AWS configuration locaux, ou sont explicitement déclarés sur la ligne de commande en tant que paramètre. Les paramètres de configuration du point de AWS CLI terminaison sont prioritaires dans l'ordre suivant :

1. L'option --endpoint-url de ligne de commande.

2. Si cette option est activée, la variable d'environnement AWS_IGNORE_CONFIGURED_ENDPOINT_URLS global du point de terminaison ou le paramètre ignore_configure_endpoint_urls de profil ignore les points de terminaison personnalisés.

3. La valeur fournie par une variable d'environnement spécifique au serviceAWS_ENDPOINT_URL_<SERVICE>, telle que. AWS_ENDPOINT_URL_DYNAMODB

4. Les valeurs fournies par les variables d'AWS_ENDPOINT_URLenvironnement AWS_USE_DUALSTACK_ENDPOINTAWS_USE_FIPS_ENDPOINT, et.

5. La valeur du point de terminaison spécifique au service fournie par le endpoint_url paramètre dans une services section du fichier partagéconfig.

6. La valeur fournie par le endpoint_url paramètre dans un profile config fichier partagé.

7. use_dualstack_endpointuse_fips_endpoint, et endpoint_url paramètres.

8. Tout point de terminaison par défaut URL pour le point correspondant AWS service est utilisé en dernier. Pour afficher la liste des points de terminaison de service disponibles dans chaque région, consultez Régions et points de terminaison AWS dans le document Référence générale d'Amazon Web Services.

AWS_MAX_ATTEMPTS

Spécifie la valeur maximale de tentatives utilisées par le gestionnaire de AWS CLI nouvelles tentatives, l'appel initial étant pris en compte dans la valeur que vous fournissez. Pour plus d'informations sur les nouvelles tentatives, consultez la section AWS CLI réessaie.

Si elle est définie, cette variable d'environnement remplace la valeur du paramètre max_attempts des profils.

AWS_METADATA_SERVICE_NUM_ATTEMPTS

Lorsque vous tentez de récupérer des informations d'identification sur une EC2 instance Amazon configurée avec un IAM rôle, le système AWS CLI tente de récupérer les informations d'identification une seule fois auprès du service de métadonnées de l'instance avant de s'arrêter. Si vous savez que vos commandes seront exécutées sur une EC2 instance Amazon, vous pouvez augmenter cette valeur pour AWS CLI réessayer plusieurs fois avant d'abandonner.

AWS_METADATA_SERVICE_TIMEOUT

Le nombre de secondes avant l'expiration d'une connexion au service de métadonnées d'instance. Lorsque vous tentez de récupérer des informations d'identification sur une EC2 instance Amazon configurée avec un IAM rôle, la connexion au service de métadonnées de l'instance expire au bout d'une seconde par défaut. Si vous savez que vous exécutez une EC2 instance Amazon avec un IAM rôle configuré, vous pouvez augmenter cette valeur si nécessaire.

AWS_PROFILE

Spécifie le nom du AWS CLI profil avec les informations d'identification et les options à utiliser. Il peut s'agir du nom d'un profil stocké dans un fichier credentials ou config, ou de la valeur default pour utiliser le profil par défaut.

Si elle est définie, cette variable d'environnement remplace le comportement d'utilisation du profil nommé [default] dans le fichier de configuration. Vous pouvez remplacer cette variable d'environnement à l'aide du paramètre de ligne de commande --profile.

AWS_RETRY_MODE

Spécifie le mode de nouvelle tentative AWS CLI utilisé. Trois modes de nouvelle tentative sont disponibles : ancien (par défaut), standard et adaptatif. Pour plus d'informations sur les nouvelles tentatives, consultez la section AWS CLI réessaie.

Si elle est définie, cette variable d'environnement remplace la valeur du paramètre retry_mode des profils.

AWS_ROLE_ARN

Spécifie le nom de ressource Amazon (ARN) d'un IAM rôle auprès d'un fournisseur d'identité Web que vous souhaitez utiliser pour exécuter les AWS CLI commandes.

Utilisé avec les variables AWS_WEB_IDENTITY_TOKEN_FILE d'AWS_ROLE_SESSION_NAMEenvironnement et.

Si elle est définie, cette variable d'environnement remplace la valeur du paramètre de profil role_arn. Vous ne pouvez pas spécifier un nom de session de rôle en tant que paramètre de ligne de commande.

Note

Cette variable d'environnement s'applique uniquement à un rôle assumé auprès d'un fournisseur d'identité Web ; elle ne s'applique pas à la configuration générale du fournisseur de rôles d'emprunt.

Pour plus d'informations sur l'utilisation des identités Web, consultezUtilisation d'un rôle à l'aide d'une identité web.

AWS_ROLE_SESSION_NAME

Spécifie le nom à attacher à la session de rôle. Cette valeur est fournie au RoleSessionName paramètre lorsqu'il AWS CLI appelle l'AssumeRoleopération, et fait partie du rôle assumé user ARN : arn:aws:sts::123456789012:assumed-role/role_name/role_session_name. Ce paramètre est facultatif. Si vous ne spécifiez pas cette valeur, un nom de session est généré automatiquement. Ce nom apparaît dans AWS CloudTrail les journaux des entrées associées à cette session.

Si elle est définie, cette variable d'environnement remplace la valeur du paramètre de profil role_session_name.

Utilisé avec les variables AWS_ROLE_ARN d'AWS_WEB_IDENTITY_TOKEN_FILEenvironnement et.

Pour plus d'informations sur l'utilisation des identités Web, consultezUtilisation d'un rôle à l'aide d'une identité web.

Note

Cette variable d'environnement s'applique uniquement à un rôle assumé auprès d'un fournisseur d'identité Web ; elle ne s'applique pas à la configuration générale du fournisseur de rôles d'emprunt.

AWS_SDK_UA_APP_ID

Un seul Compte AWS peut être utilisé par plusieurs applications clients pour passer des appels à AWS services. L'ID d'application identifie l'application source qui a effectué un ensemble d'appels à l'aide d'un AWS service. AWS SDKset les services n'utilisent ni n'interprètent cette valeur autrement que pour la réintégrer dans les communications avec les clients. Par exemple, cette valeur peut être incluse dans les e-mails opérationnels pour identifier de manière unique laquelle de vos applications est associée à la notification.

Par défaut, il n'y a aucune valeur.

L'ID de l'application est une chaîne d'une longueur maximale de 50 caractères. Les lettres, les chiffres et les caractères spéciaux suivants sont autorisés :

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

Si elle est définie, cette variable d'environnement remplace la valeur du paramètre de profil sdk_ua_app_id. Vous ne pouvez pas spécifier l'ID de l'application comme option de ligne de commande.

AWS_SECRET_ACCESS_KEY

Indique la clé secrète associée à la clé d'accès. Il s'agit du « mot de passe » de la clé d'accès.

Si elle est définie, cette variable d'environnement remplace la valeur du paramètre de profil aws_secret_access_key. Vous ne pouvez pas spécifier l'ID de la clé d'accès secrète en tant qu'option de ligne de commande.

AWS_SESSION_TOKEN

Spécifie la valeur du jeton de session requise si vous utilisez des informations d'identification de sécurité temporaires que vous avez extraites directement des opérations AWS STS . Pour plus d'informations, consultez la section Sortie de la commande assume-role dans la référence des AWS CLI commandes.

Si elle est définie, cette variable d'environnement remplace la valeur du paramètre de profil aws_session_token.

AWS_SHARED_CREDENTIALS_FILE

Spécifie l'emplacement du fichier AWS CLI utilisé pour stocker les clés d'accès. Le chemin par défaut est ~/.aws/credentials.

Vous ne pouvez pas spécifier cette valeur dans un paramètre de profil nommé ou à l'aide d'un paramètre de ligne de commande.

AWS_STS_REGIONAL_ENDPOINTS

Spécifie comment AWS CLI détermine le point AWS de terminaison de service que le AWS CLI client utilise pour parler au AWS Security Token Service (AWS STS). La valeur par défaut pour AWS CLI la version 1 estlegacy.

Vous pouvez spécifier l'une des deux valeurs suivantes :

• legacy— Utilise le point de STS terminaison global sts.amazonaws.comap-northeast-1, pour AWS les régions suivantes : ap-south-1 ap-southeast-1 ap-southeast-2aws-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, etus-west-2. Toutes les autres régions utilisent automatiquement leur point de terminaison régional respectif.

• regional— Utilise AWS CLI toujours le AWS STS point de terminaison pour la région actuellement configurée. Par exemple, si le client est configuré pour être utiliséus-west-2, tous les appels AWS STS sont effectués vers le point de terminaison régional sts.us-west-2.amazonaws.com plutôt que vers le point de sts.amazonaws.com terminaison global. Pour envoyer une demande au point de terminaison global lorsque ce paramètre est activé, vous pouvez définir la région sur aws-global.

AWS_USE_DUALSTACK_ENDPOINT

Permet d'utiliser des points de terminaison à double pile pour envoyer AWS des demandes. Pour en savoir plus sur les points de terminaison à double pile, qui prennent en charge à la fois le IPv6 trafic IPv4 et le trafic, consultez la section Utilisation des points de terminaison à double pile Amazon S3 dans le guide de l'utilisateur d'Amazon Simple Storage Service. Des points de terminaison à double pile sont disponibles pour certains services dans certaines régions. S'il n'existe pas de point de terminaison à double pile pour le service ou Région AWS si la demande échoue. Par défaut, l'option est désactivée.

Les paramètres de configuration du point de terminaison se trouvent à plusieurs endroits, tels que les variables d'environnement système ou utilisateur, les fichiers de AWS configuration locaux, ou sont explicitement déclarés sur la ligne de commande en tant que paramètre. Les paramètres de configuration du point de AWS CLI terminaison sont prioritaires dans l'ordre suivant :

1. L'option --endpoint-url de ligne de commande.

2. Si cette option est activée, la variable d'environnement AWS_IGNORE_CONFIGURED_ENDPOINT_URLS global du point de terminaison ou le paramètre ignore_configure_endpoint_urls de profil ignore les points de terminaison personnalisés.

3. La valeur fournie par une variable d'environnement spécifique au serviceAWS_ENDPOINT_URL_<SERVICE>, telle que. AWS_ENDPOINT_URL_DYNAMODB

4. Les valeurs fournies par les variables d'AWS_ENDPOINT_URLenvironnement AWS_USE_DUALSTACK_ENDPOINTAWS_USE_FIPS_ENDPOINT, et.

5. La valeur du point de terminaison spécifique au service fournie par le endpoint_url paramètre dans une services section du fichier partagéconfig.

6. La valeur fournie par le endpoint_url paramètre dans un profile config fichier partagé.

7. use_dualstack_endpointuse_fips_endpoint, et endpoint_url paramètres.

8. Tout point de terminaison par défaut URL pour le point correspondant AWS service est utilisé en dernier. Pour afficher la liste des points de terminaison de service disponibles dans chaque région, consultez Régions et points de terminaison AWS dans le document Référence générale d'Amazon Web Services.

AWS_USE_FIPS_ENDPOINT

Certains AWS services proposent des points de terminaison compatibles avec la norme fédérale de traitement de l'information (FIPS) 140-2 dans certains cas. Régions AWS Lorsque le AWS service est pris en chargeFIPS, ce paramètre indique quel FIPS point de terminaison AWS CLI il doit utiliser. Contrairement aux AWS terminaux standard, les FIPS terminaux utilisent une bibliothèque TLS logicielle conforme FIPS à la norme 140-2. Ces points de terminaison peuvent être requis par les entreprises qui interagissent avec le gouvernement des États-Unis.

Si ce paramètre est activé, mais qu'il n'existe aucun point de FIPS terminaison pour le service dans votre ordinateur Région AWS, la AWS commande risque d'échouer. Dans ce cas, spécifiez manuellement le point de terminaison à utiliser dans la commande à l'aide de l'--endpoint-urloption ou utilisez des points de terminaison spécifiques au service.

Pour plus d'informations sur la spécification des FIPS points de terminaison par Région AWS, consultez la section FIPSPoints de terminaison par service.

Les paramètres de configuration du point de terminaison se trouvent à plusieurs endroits, tels que les variables d'environnement système ou utilisateur, les fichiers de AWS configuration locaux, ou sont explicitement déclarés sur la ligne de commande en tant que paramètre. Les paramètres de configuration du point de AWS CLI terminaison sont prioritaires dans l'ordre suivant :

1. L'option --endpoint-url de ligne de commande.

2. Si cette option est activée, la variable d'environnement AWS_IGNORE_CONFIGURED_ENDPOINT_URLS global du point de terminaison ou le paramètre ignore_configure_endpoint_urls de profil ignore les points de terminaison personnalisés.

3. La valeur fournie par une variable d'environnement spécifique au serviceAWS_ENDPOINT_URL_<SERVICE>, telle que. AWS_ENDPOINT_URL_DYNAMODB

4. Les valeurs fournies par les variables d'AWS_ENDPOINT_URLenvironnement AWS_USE_DUALSTACK_ENDPOINTAWS_USE_FIPS_ENDPOINT, et.

5. La valeur du point de terminaison spécifique au service fournie par le endpoint_url paramètre dans une services section du fichier partagéconfig.

6. La valeur fournie par le endpoint_url paramètre dans un profile config fichier partagé.

7. use_dualstack_endpointuse_fips_endpoint, et endpoint_url paramètres.

8. Tout point de terminaison par défaut URL pour le point correspondant AWS service est utilisé en dernier. Pour afficher la liste des points de terminaison de service disponibles dans chaque région, consultez Régions et points de terminaison AWS dans le document Référence générale d'Amazon Web Services.

AWS_WEB_IDENTITY_TOKEN_FILE

Spécifie le chemin d'accès à un fichier contenant un jeton d'accès OAuth 2.0 ou un jeton d'identification OpenID Connect fourni par un fournisseur d'identité. L’ AWS CLI charge le contenu de ce fichier et le transmet en tant qu’argument WebIdentityToken à l'opération AssumeRoleWithWebIdentity.

Utilisé avec les variables AWS_ROLE_ARN d'AWS_ROLE_SESSION_NAMEenvironnement et.

Si elle est définie, cette variable d'environnement remplace la valeur du paramètre de profil web_identity_token_file.

Pour plus d'informations sur l'utilisation des identités Web, consultezUtilisation d'un rôle à l'aide d'une identité web.

Note

Cette variable d'environnement s'applique uniquement à un rôle assumé auprès d'un fournisseur d'identité Web ; elle ne s'applique pas à la configuration générale du fournisseur de rôles d'emprunt.