D'autres exemples de AWS SDK sont disponibles dans le référentiel [AWS Doc SDK Examples](https://github.com/awsdocs/aws-doc-sdk-examples) GitHub . Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra. # Exemples de code pour l'API Resource Groups Tagging utilisant AWS SDKs Les exemples de code suivants vous montrent comment utiliser AWS Resource Groups Tagging API un kit de développement AWS logiciel (SDK). Les *actions* sont des extraits de code de programmes plus larges et doivent être exécutées dans leur contexte. Alors que les actions vous indiquent comment appeler des fonctions de service individuelles, vous pouvez les voir en contexte dans leurs scénarios associés. **Ressources supplémentaires** + **[Guide de l’utilisateur de l’API Resource Groups Tagging](https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html)** : plus d’informations sur l’API Resource Groups Tagging. + **[Référence des API Resource Groups Tagging](https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/overview.html)** : détails sur toutes les actions de l’API Resource Groups Tagging disponibles. + **[AWS Centre pour les développeurs](https://aws.amazon.com/developer/code-examples/?awsf.sdk-code-examples-product=product%23)** : exemples de code que vous pouvez filtrer par catégorie ou par recherche en texte intégral. + **[AWS Exemples de SDK](https://github.com/awsdocs/aws-doc-sdk-examples)** : GitHub dépôt avec code complet dans les langues préférées. Inclut des instructions sur la configuration et l’exécution du code. **Contents** + [Principes de base](resource-groups-tagging-api_code_examples_basics.md) + [Actions](resource-groups-tagging-api_code_examples_actions.md) + [`GetResources`](resource-groups-tagging-api_example_resource-groups-tagging-api_GetResources_section.md) + [`GetTagKeys`](resource-groups-tagging-api_example_resource-groups-tagging-api_GetTagKeys_section.md) + [`GetTagValues`](resource-groups-tagging-api_example_resource-groups-tagging-api_GetTagValues_section.md) + [`TagResources`](resource-groups-tagging-api_example_resource-groups-tagging-api_TagResources_section.md) + [`UntagResources`](resource-groups-tagging-api_example_resource-groups-tagging-api_UntagResources_section.md) # Exemples de base pour l'API Resource Groups Tagging utilisant AWS SDKs Les exemples de code suivants montrent comment utiliser les principes de base de AWS Resource Groups Tagging API with AWS SDKs. **Contents** + [Actions](resource-groups-tagging-api_code_examples_actions.md) + [`GetResources`](resource-groups-tagging-api_example_resource-groups-tagging-api_GetResources_section.md) + [`GetTagKeys`](resource-groups-tagging-api_example_resource-groups-tagging-api_GetTagKeys_section.md) + [`GetTagValues`](resource-groups-tagging-api_example_resource-groups-tagging-api_GetTagValues_section.md) + [`TagResources`](resource-groups-tagging-api_example_resource-groups-tagging-api_TagResources_section.md) + [`UntagResources`](resource-groups-tagging-api_example_resource-groups-tagging-api_UntagResources_section.md) # Actions pour l'API de balisage Resource Groups à l'aide de AWS SDKs Les exemples de code suivants montrent comment effectuer des actions individuelles de l'API Resource Groups Tagging avec AWS SDKs. Chaque exemple inclut un lien vers GitHub, où vous pouvez trouver des instructions pour configurer et exécuter le code. Les exemples suivants incluent uniquement les actions les plus couramment utilisées. Pour obtenir la liste complète, consultez la [Référence des API AWS Resource Groups Tagging API](https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/overview.html). **Topics** + [`GetResources`](resource-groups-tagging-api_example_resource-groups-tagging-api_GetResources_section.md) + [`GetTagKeys`](resource-groups-tagging-api_example_resource-groups-tagging-api_GetTagKeys_section.md) + [`GetTagValues`](resource-groups-tagging-api_example_resource-groups-tagging-api_GetTagValues_section.md) + [`TagResources`](resource-groups-tagging-api_example_resource-groups-tagging-api_TagResources_section.md) + [`UntagResources`](resource-groups-tagging-api_example_resource-groups-tagging-api_UntagResources_section.md) # Utilisation de `GetResources` avec une CLI Les exemples de code suivants illustrent comment utiliser `GetResources`. ------ #### [ CLI ] **AWS CLI** **Pour obtenir une liste de ressources balisées** L’exemple `get-resources` suivant affiche une liste des ressources du compte qui sont balisées avec le nom et la valeur de clé spécifiés. ``` aws resourcegroupstaggingapi get-resources \ --tag-filters Key=Environment,Values=Production \ --tags-per-page 100 ``` Sortie : ``` { "ResourceTagMappingList": [ { "ResourceARN": " arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-7sbz2Kz0", "Tags": [ { "Key": "Environment", "Value": "Production" } ] } ] } ``` Pour plus d'informations, consultez le [GetResources](https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_GetResources.html)manuel *Resource Groups Tagging API Reference*. + Pour plus de détails sur l'API, voir [GetResources](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/resourcegroupstaggingapi/get-resources.html)la section *Référence des AWS CLI commandes*. ------ #### [ PowerShell ] **Outils pour PowerShell V4** **Exemple 1 : renvoie toutes les ressources balisées d’une région et les clés de balise associées à la ressource. Si aucun paramètre -Region n’est fourni à l’applet de commande, elle tentera de déduire la région à partir des métadonnées du shell ou de l’instance EC2.** ``` Get-RGTResource ``` **Sortie** : ``` ResourceARN Tags ----------- ---- arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version} arn:aws:s3:::amzn-s3-demo-bucket {stage, version, othertag} ``` **Exemple 2 : renvoie toutes les ressources balisées du type spécifié dans une région. La chaîne pour chaque nom de service et type de ressource est la même que celle incorporée dans l’Amazon Resource Name (ARN) d’une ressource.** ``` Get-RGTResource -ResourceType "s3" ``` **Sortie** : ``` ResourceARN Tags ----------- ---- arn:aws:s3:::amzn-s3-demo-bucket {stage, version, othertag} ``` **Exemple 3 : renvoie toutes les ressources balisées du type spécifié dans une région. Notez que lorsque les types de ressources sont redirigés vers l’applet de commande, un appel au service est effectué pour chaque type de ressource fourni.** ``` "dynamodb","s3" | Get-RGTResource ``` **Sortie** : ``` ResourceARN Tags ----------- ---- arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version} arn:aws:s3:::amzn-s3-demo-bucket {stage, version, othertag} ``` **Exemple 4 : renvoie toutes les ressources balisées correspondant au filtre spécifié.** ``` Get-RGTResource -TagFilter @{ Key="stage" } ``` **Sortie** : ``` ResourceARN Tags ----------- ---- arn:aws:s3:::amzn-s3-demo-bucket {stage, version, othertag} ``` **Exemple 5 : renvoie toutes les ressources balisées correspondant au filtre et au type de ressource spécifiés.** ``` Get-RGTResource -TagFilter @{ Key="stage" } -ResourceType "dynamodb" ``` **Sortie** : ``` ResourceARN Tags ----------- ---- arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version} ``` **Exemple 6 : renvoie toutes les ressources balisées correspondant au filtre spécifié.** ``` Get-RGTResource -TagFilter @{ Key="stage"; Values=@("beta","gamma") } ``` **Sortie** : ``` ResourceARN Tags ----------- ---- arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version} ``` + Pour plus de détails sur l'API, reportez-vous [GetResources](https://docs.aws.amazon.com/powershell/v4/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V4)*. **Outils pour PowerShell V5** **Exemple 1 : renvoie toutes les ressources balisées d’une région et les clés de balise associées à la ressource. Si aucun paramètre -Region n’est fourni à l’applet de commande, elle tentera de déduire la région à partir des métadonnées du shell ou de l’instance EC2.** ``` Get-RGTResource ``` **Sortie** : ``` ResourceARN Tags ----------- ---- arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version} arn:aws:s3:::amzn-s3-demo-bucket {stage, version, othertag} ``` **Exemple 2 : renvoie toutes les ressources balisées du type spécifié dans une région. La chaîne pour chaque nom de service et type de ressource est la même que celle incorporée dans l’Amazon Resource Name (ARN) d’une ressource.** ``` Get-RGTResource -ResourceType "s3" ``` **Sortie** : ``` ResourceARN Tags ----------- ---- arn:aws:s3:::amzn-s3-demo-bucket {stage, version, othertag} ``` **Exemple 3 : renvoie toutes les ressources balisées du type spécifié dans une région. Notez que lorsque les types de ressources sont redirigés vers l’applet de commande, un appel au service est effectué pour chaque type de ressource fourni.** ``` "dynamodb","s3" | Get-RGTResource ``` **Sortie** : ``` ResourceARN Tags ----------- ---- arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version} arn:aws:s3:::amzn-s3-demo-bucket {stage, version, othertag} ``` **Exemple 4 : renvoie toutes les ressources balisées correspondant au filtre spécifié.** ``` Get-RGTResource -TagFilter @{ Key="stage" } ``` **Sortie** : ``` ResourceARN Tags ----------- ---- arn:aws:s3:::amzn-s3-demo-bucket {stage, version, othertag} ``` **Exemple 5 : renvoie toutes les ressources balisées correspondant au filtre et au type de ressource spécifiés.** ``` Get-RGTResource -TagFilter @{ Key="stage" } -ResourceType "dynamodb" ``` **Sortie** : ``` ResourceARN Tags ----------- ---- arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version} ``` **Exemple 6 : renvoie toutes les ressources balisées correspondant au filtre spécifié.** ``` Get-RGTResource -TagFilter @{ Key="stage"; Values=@("beta","gamma") } ``` **Sortie** : ``` ResourceARN Tags ----------- ---- arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version} ``` + Pour plus de détails sur l'API, reportez-vous [GetResources](https://docs.aws.amazon.com/powershell/v5/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V5)*. ------ # Utilisation de `GetTagKeys` avec une CLI Les exemples de code suivants illustrent comment utiliser `GetTagKeys`. ------ #### [ CLI ] **AWS CLI** **Pour obtenir la liste de toutes les clés de balises** L’exemple `get-tag-keys` suivant récupère la liste de tous les noms de clé de balise utilisés par les ressources du compte. ``` aws resourcegroupstaggingapi get-tag-keys ``` Sortie : ``` { "TagKeys": [ "Environment", "CostCenter", "Department" ] } ``` Pour plus d'informations, consultez le [GetTagKeys](https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_GetTagKeys.html)manuel *Resource Groups Tagging API Reference*. + Pour plus de détails sur l'API, voir [GetTagKeys](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/resourcegroupstaggingapi/get-tag-keys.html)la section *Référence des AWS CLI commandes*. ------ #### [ PowerShell ] **Outils pour PowerShell V4** **Exemple 1 : renvoie toutes les clés de balise de la région spécifiée. Si le paramètre -Region n’est pas spécifié, l’applet de commande tentera de déduire la région à partir de la région shell par défaut ou des métadonnées de l’instance EC2. Notez que les clés de la balise ne sont pas renvoyées dans un ordre spécifique.** ``` Get-RGTTagKey -region us-west-2 ``` **Sortie** : ``` version stage ``` + Pour plus de détails sur l'API, reportez-vous [GetTagKeys](https://docs.aws.amazon.com/powershell/v4/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V4)*. **Outils pour PowerShell V5** **Exemple 1 : renvoie toutes les clés de balise de la région spécifiée. Si le paramètre -Region n’est pas spécifié, l’applet de commande tentera de déduire la région à partir de la région shell par défaut ou des métadonnées de l’instance EC2. Notez que les clés de la balise ne sont pas renvoyées dans un ordre spécifique.** ``` Get-RGTTagKey -region us-west-2 ``` **Sortie** : ``` version stage ``` + Pour plus de détails sur l'API, reportez-vous [GetTagKeys](https://docs.aws.amazon.com/powershell/v5/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V5)*. ------ # Utilisation de `GetTagValues` avec une CLI Les exemples de code suivants illustrent comment utiliser `GetTagValues`. ------ #### [ CLI ] **AWS CLI** **Pour obtenir la liste de toutes les valeurs de balises** L’exemple `get-tag-values` suivant affiche toutes les valeurs utilisées pour la clé spécifiée pour toutes les ressources. ``` aws resourcegroupstaggingapi get-tag-values \ --key=Environment ``` Sortie : ``` { "TagValues": [ "Alpha", "Gamma", "Production" ] } ``` Pour plus d'informations, consultez le [GetTagValues](https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_GetTagValues.html)manuel *Resource Groups Tagging API Reference*. + Pour plus de détails sur l'API, voir [GetTagValues](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/resourcegroupstaggingapi/get-tag-values.html)la section *Référence des AWS CLI commandes*. ------ #### [ PowerShell ] **Outils pour PowerShell V4** **Exemple 1 : renvoie la valeur de la balise spécifiée dans une région. Si le paramètre -Region n’est pas spécifié, l’applet de commande tentera de déduire la région à partir de la région shell par défaut ou des métadonnées de l’instance EC2.** ``` Get-RGTTagValue -Key "stage" -Region us-west-2 ``` **Sortie** : ``` beta ``` + Pour plus de détails sur l'API, reportez-vous [GetTagValues](https://docs.aws.amazon.com/powershell/v4/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V4)*. **Outils pour PowerShell V5** **Exemple 1 : renvoie la valeur de la balise spécifiée dans une région. Si le paramètre -Region n’est pas spécifié, l’applet de commande tentera de déduire la région à partir de la région shell par défaut ou des métadonnées de l’instance EC2.** ``` Get-RGTTagValue -Key "stage" -Region us-west-2 ``` **Sortie** : ``` beta ``` + Pour plus de détails sur l'API, reportez-vous [GetTagValues](https://docs.aws.amazon.com/powershell/v5/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V5)*. ------ # Utilisation de `TagResources` avec une CLI Les exemples de code suivants illustrent comment utiliser `TagResources`. ------ #### [ CLI ] **AWS CLI** **Pour attacher une balise à une ressource** L’exemple `tag-resources` suivant balise la ressource spécifiée avec un nom et une valeur de clé. ``` aws resourcegroupstaggingapi tag-resources \ --resource-arn-list arn:aws:s3:::MyProductionBucket \ --tags Environment=Production,CostCenter=1234 ``` Sortie : ``` { "FailedResourcesMap": {} } ``` Pour plus d'informations, consultez le [TagResources](https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_TagResources.html)manuel *Resource Groups Tagging API Reference*. + Pour plus de détails sur l'API, voir [TagResources](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/resourcegroupstaggingapi/tag-resources.html)la section *Référence des AWS CLI commandes*. ------ #### [ PowerShell ] **Outils pour PowerShell V4** **Exemple 1 : cet exemple ajoute les clés de balise « stage » et « version » avec les valeurs « beta » et « preprod\$1test » à un compartiment Amazon S3 et à une table Amazon DynamoDB. Un seul appel est fait au service pour supprimer les balises.** ``` $arn1 = "arn:aws:s3:::amzn-s3-demo-bucket" $arn2 = "arn:aws:dynamodb:us-west-2:123456789012:table/mytable" Add-RGTResourceTag -ResourceARNList $arn1,$arn2 -Tag @{ "stage"="beta"; "version"="preprod_test" } ``` **Exemple 2 : cet exemple ajoute les balises et les valeurs spécifiées à un compartiment Amazon S3 et à une table Amazon DynamoDB. Deux appels sont effectués vers le service, un pour chaque ARN de ressource redirigé vers l’applet de commande.** ``` $arn1 = "arn:aws:s3:::amzn-s3-demo-bucket" $arn2 = "arn:aws:dynamodb:us-west-2:123456789012:table/mytable" $arn1,$arn2 | Add-RGTResourceTag -Tag @{ "stage"="beta"; "version"="preprod_test" } ``` + Pour plus de détails sur l'API, reportez-vous [TagResources](https://docs.aws.amazon.com/powershell/v4/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V4)*. **Outils pour PowerShell V5** **Exemple 1 : cet exemple ajoute les clés de balise « stage » et « version » avec les valeurs « beta » et « preprod\$1test » à un compartiment Amazon S3 et à une table Amazon DynamoDB. Un seul appel est fait au service pour supprimer les balises.** ``` $arn1 = "arn:aws:s3:::amzn-s3-demo-bucket" $arn2 = "arn:aws:dynamodb:us-west-2:123456789012:table/mytable" Add-RGTResourceTag -ResourceARNList $arn1,$arn2 -Tag @{ "stage"="beta"; "version"="preprod_test" } ``` **Exemple 2 : cet exemple ajoute les balises et les valeurs spécifiées à un compartiment Amazon S3 et à une table Amazon DynamoDB. Deux appels sont effectués vers le service, un pour chaque ARN de ressource redirigé vers l’applet de commande.** ``` $arn1 = "arn:aws:s3:::amzn-s3-demo-bucket" $arn2 = "arn:aws:dynamodb:us-west-2:123456789012:table/mytable" $arn1,$arn2 | Add-RGTResourceTag -Tag @{ "stage"="beta"; "version"="preprod_test" } ``` + Pour plus de détails sur l'API, reportez-vous [TagResources](https://docs.aws.amazon.com/powershell/v5/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V5)*. ------ # Utilisation de `UntagResources` avec une CLI Les exemples de code suivants illustrent comment utiliser `UntagResources`. ------ #### [ CLI ] **AWS CLI** **Pour supprimer une balise d’une ressource** L’exemple `untag-resources` suivant supprime les clés de balise spécifiées et leurs valeurs associées provenant de la ressource spécifiée. ``` aws resourcegroupstaggingapi untag-resources \ --resource-arn-list arn:aws:s3:::amzn-s3-demo-bucket \ --tag-keys Environment CostCenter ``` Sortie : ``` { "FailedResourcesMap": {} } ``` Pour plus d'informations, consultez le [UntagResources](https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_UntagResources.html)manuel *Resource Groups Tagging API Reference*. + Pour plus de détails sur l'API, voir [UntagResources](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/resourcegroupstaggingapi/untag-resources.html)la section *Référence des AWS CLI commandes*. ------ #### [ PowerShell ] **Outils pour PowerShell V4** **Exemple 1 : supprime les clés de balise « stage » et « version », ainsi que les valeurs associées, d’un compartiment Amazon S3 et d’une table Amazon DynamoDB. Un seul appel est envoyé au service pour supprimer les tags. Avant de supprimer les balises, l’applet de commande vous invite à confirmer. Pour contourner la confirmation, ajoutez le paramètre -Force.** ``` $arn1 = "arn:aws:s3:::amzn-s3-demo-bucket" $arn2 = "arn:aws:dynamodb:us-west-2:123456789012:table/mytable" Remove-RGTResourceTag -ResourceARNList $arn1,$arn2 -TagKey "stage","version" ``` **Exemple 2 : supprime les clés de balise « stage » et « version », ainsi que les valeurs associées, d’un compartiment Amazon S3 et d’une table Amazon DynamoDB. Deux appels sont effectués vers le service, un pour chaque ARN de ressource redirigé vers l’applet de commande. Avant chaque appel, l’applet de commande demande une confirmation. Pour contourner la confirmation, ajoutez le paramètre -Force.** ``` $arn1 = "arn:aws:s3:::amzn-s3-demo-bucket" $arn2 = "arn:aws:dynamodb:us-west-2:123456789012:table/mytable" $arn1,$arn2 | Remove-RGTResourceTag -TagKey "stage","version" ``` + Pour plus de détails sur l'API, reportez-vous [UntagResources](https://docs.aws.amazon.com/powershell/v4/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V4)*. **Outils pour PowerShell V5** **Exemple 1 : supprime les clés de balise « stage » et « version », ainsi que les valeurs associées, d’un compartiment Amazon S3 et d’une table Amazon DynamoDB. Un seul appel est envoyé au service pour supprimer les tags. Avant de supprimer les balises, l’applet de commande vous invite à confirmer. Pour contourner la confirmation, ajoutez le paramètre -Force.** ``` $arn1 = "arn:aws:s3:::amzn-s3-demo-bucket" $arn2 = "arn:aws:dynamodb:us-west-2:123456789012:table/mytable" Remove-RGTResourceTag -ResourceARNList $arn1,$arn2 -TagKey "stage","version" ``` **Exemple 2 : supprime les clés de balise « stage » et « version », ainsi que les valeurs associées, d’un compartiment Amazon S3 et d’une table Amazon DynamoDB. Deux appels sont effectués vers le service, un pour chaque ARN de ressource redirigé vers l’applet de commande. Avant chaque appel, l’applet de commande demande une confirmation. Pour contourner la confirmation, ajoutez le paramètre -Force.** ``` $arn1 = "arn:aws:s3:::amzn-s3-demo-bucket" $arn2 = "arn:aws:dynamodb:us-west-2:123456789012:table/mytable" $arn1,$arn2 | Remove-RGTResourceTag -TagKey "stage","version" ``` + Pour plus de détails sur l'API, reportez-vous [UntagResources](https://docs.aws.amazon.com/powershell/v5/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V5)*. ------