Há mais exemplos de AWS SDK disponíveis no repositório [AWS Doc SDK Examples](https://github.com/awsdocs/aws-doc-sdk-examples) GitHub . As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá. # Exemplos de código para a API Resource Groups Tagging usando AWS SDKs Os exemplos de código a seguir mostram como usar AWS Resource Groups Tagging API com um kit de desenvolvimento de AWS software (SDK). *Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados. **Mais atributos** + **[ Guia do usuário da API de marcação com tags de Resource Groups](https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html)**: mais informações sobre a API de marcação com tags de Resource Groups. + **[Referência de API da API de marcação com tags de Resource Groups](https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/overview.html)**: detalhes sobre todas as ações disponíveis da API de marcação com tags de Resource Groups. + **[AWS Centro do desenvolvedor](https://aws.amazon.com/developer/code-examples/?awsf.sdk-code-examples-product=product%23)** — exemplos de código que você pode filtrar por categoria ou pesquisa de texto completo. + **[AWS Exemplos de SDK](https://github.com/awsdocs/aws-doc-sdk-examples)** — GitHub repositório com código completo nos idiomas preferidos. Inclui instruções para configurar e executar o código. **Contents** + [Conceitos básicos](resource-groups-tagging-api_code_examples_basics.md) + [Ações](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) # Exemplos básicos da API Resource Groups Tagging usando AWS SDKs Os exemplos de código a seguir mostram como usar o básico do AWS Resource Groups Tagging API with AWS SDKs. **Contents** + [Ações](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) # Ações para a API Resource Groups Tagging usando AWS SDKs Os exemplos de código a seguir demonstram como realizar ações individuais da API Resource Groups Tagging com AWS SDKs. Cada exemplo inclui um link para GitHub, onde você pode encontrar instruções para configurar e executar o código. Os exemplos a seguir incluem apenas as ações mais utilizadas. Para obter uma lista completa, consulte a [Referência de APIs do 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) # Usar `GetResources` com uma CLI Os exemplos de código a seguir mostram como usar o `GetResources`. ------ #### [ CLI ] **AWS CLI** **Obter uma lista de recursos marcados** O exemplo `get-resources` a seguir exibe uma lista de recursos na conta que estão marcados com o nome e o valor da chave especificados. ``` aws resourcegroupstaggingapi get-resources \ --tag-filters Key=Environment,Values=Production \ --tags-per-page 100 ``` Saída: ``` { "ResourceTagMappingList": [ { "ResourceARN": " arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-7sbz2Kz0", "Tags": [ { "Key": "Environment", "Value": "Production" } ] } ] } ``` Para obter mais informações, consulte a *Referência [GetResources](https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_GetResources.html)da API Resource Groups Tagging*. + Para obter detalhes da API, consulte [GetResources](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/resourcegroupstaggingapi/get-resources.html)em *Referência de AWS CLI Comandos*. ------ #### [ PowerShell ] **Ferramentas para PowerShell V4** **Exemplo 1: retorna todos os recursos marcados em uma região e as chaves de tag associadas ao recurso. Se nenhum parâmetro -Region for fornecido ao cmdlet, ele tentará inferir a região pelo shell ou pelos metadados da instância do EC2.** ``` Get-RGTResource ``` **Saída**: ``` ResourceARN Tags ----------- ---- arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version} arn:aws:s3:::amzn-s3-demo-bucket {stage, version, othertag} ``` **Exemplo 2: retorna todos os recursos marcados do tipo especificado em uma região. A string para cada nome de serviço e tipo de recurso é a mesma incorporada ao nome do recurso da Amazon (ARN) de um recurso.** ``` Get-RGTResource -ResourceType "s3" ``` **Saída**: ``` ResourceARN Tags ----------- ---- arn:aws:s3:::amzn-s3-demo-bucket {stage, version, othertag} ``` **Exemplo 3: retorna todos os recursos marcados do tipo especificado em uma região. Observe que quando os tipos de recursos são canalizados para o cmdlet, uma chamada para o serviço é feita para cada tipo de recurso fornecido.** ``` "dynamodb","s3" | Get-RGTResource ``` **Saída**: ``` ResourceARN Tags ----------- ---- arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version} arn:aws:s3:::amzn-s3-demo-bucket {stage, version, othertag} ``` **Exemplo 4: retorna todos os recursos marcados que correspondem ao filtro especificado.** ``` Get-RGTResource -TagFilter @{ Key="stage" } ``` **Saída**: ``` ResourceARN Tags ----------- ---- arn:aws:s3:::amzn-s3-demo-bucket {stage, version, othertag} ``` **Exemplo 5: retorna todos os recursos marcados que correspondem ao filtro e ao tipo de recurso especificados.** ``` Get-RGTResource -TagFilter @{ Key="stage" } -ResourceType "dynamodb" ``` **Saída**: ``` ResourceARN Tags ----------- ---- arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version} ``` **Exemplo 6: retorna todos os recursos marcados que correspondem ao filtro especificado.** ``` Get-RGTResource -TagFilter @{ Key="stage"; Values=@("beta","gamma") } ``` **Saída**: ``` ResourceARN Tags ----------- ---- arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version} ``` + Para obter detalhes da API, consulte [GetResources](https://docs.aws.amazon.com/powershell/v4/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V4)*. **Ferramentas para PowerShell V5** **Exemplo 1: retorna todos os recursos marcados em uma região e as chaves de tag associadas ao recurso. Se nenhum parâmetro -Region for fornecido ao cmdlet, ele tentará inferir a região pelo shell ou pelos metadados da instância do EC2.** ``` Get-RGTResource ``` **Saída**: ``` ResourceARN Tags ----------- ---- arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version} arn:aws:s3:::amzn-s3-demo-bucket {stage, version, othertag} ``` **Exemplo 2: retorna todos os recursos marcados do tipo especificado em uma região. A string para cada nome de serviço e tipo de recurso é a mesma incorporada ao nome do recurso da Amazon (ARN) de um recurso.** ``` Get-RGTResource -ResourceType "s3" ``` **Saída**: ``` ResourceARN Tags ----------- ---- arn:aws:s3:::amzn-s3-demo-bucket {stage, version, othertag} ``` **Exemplo 3: retorna todos os recursos marcados do tipo especificado em uma região. Observe que quando os tipos de recursos são canalizados para o cmdlet, uma chamada para o serviço é feita para cada tipo de recurso fornecido.** ``` "dynamodb","s3" | Get-RGTResource ``` **Saída**: ``` ResourceARN Tags ----------- ---- arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version} arn:aws:s3:::amzn-s3-demo-bucket {stage, version, othertag} ``` **Exemplo 4: retorna todos os recursos marcados que correspondem ao filtro especificado.** ``` Get-RGTResource -TagFilter @{ Key="stage" } ``` **Saída**: ``` ResourceARN Tags ----------- ---- arn:aws:s3:::amzn-s3-demo-bucket {stage, version, othertag} ``` **Exemplo 5: retorna todos os recursos marcados que correspondem ao filtro e ao tipo de recurso especificados.** ``` Get-RGTResource -TagFilter @{ Key="stage" } -ResourceType "dynamodb" ``` **Saída**: ``` ResourceARN Tags ----------- ---- arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version} ``` **Exemplo 6: retorna todos os recursos marcados que correspondem ao filtro especificado.** ``` Get-RGTResource -TagFilter @{ Key="stage"; Values=@("beta","gamma") } ``` **Saída**: ``` ResourceARN Tags ----------- ---- arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version} ``` + Para obter detalhes da API, consulte [GetResources](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*. ------ # Usar `GetTagKeys` com uma CLI Os exemplos de código a seguir mostram como usar o `GetTagKeys`. ------ #### [ CLI ] **AWS CLI** **Obter uma lista de todas as chaves de tag** O exemplo `get-tag-keys` a seguir recupera a lista de todos os nomes de chave de tag usados pelos recursos na conta. ``` aws resourcegroupstaggingapi get-tag-keys ``` Saída: ``` { "TagKeys": [ "Environment", "CostCenter", "Department" ] } ``` Para obter mais informações, consulte a *Referência [GetTagKeys](https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_GetTagKeys.html)da API Resource Groups Tagging*. + Para obter detalhes da API, consulte [GetTagKeys](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/resourcegroupstaggingapi/get-tag-keys.html)em *Referência de AWS CLI Comandos*. ------ #### [ PowerShell ] **Ferramentas para PowerShell V4** **Exemplo 1: retorna todas as chaves de tag na região especificada. Se o parâmetro -Region não for especificado, o cmdlet tentará inferir a região por meio da região padrão do shell ou dos metadados da instância do EC2. Observe que as chaves da tag não são retornadas em nenhuma ordem específica.** ``` Get-RGTTagKey -region us-west-2 ``` **Saída**: ``` version stage ``` + Para obter detalhes da API, consulte [GetTagKeys](https://docs.aws.amazon.com/powershell/v4/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V4)*. **Ferramentas para PowerShell V5** **Exemplo 1: retorna todas as chaves de tag na região especificada. Se o parâmetro -Region não for especificado, o cmdlet tentará inferir a região por meio da região padrão do shell ou dos metadados da instância do EC2. Observe que as chaves da tag não são retornadas em nenhuma ordem específica.** ``` Get-RGTTagKey -region us-west-2 ``` **Saída**: ``` version stage ``` + Para obter detalhes da API, consulte [GetTagKeys](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*. ------ # Usar `GetTagValues` com uma CLI Os exemplos de código a seguir mostram como usar o `GetTagValues`. ------ #### [ CLI ] **AWS CLI** **Obter uma lista de todos os valores de tag** O exemplo `get-tag-values` a seguir exibe todos os valores usados para a chave especificada para todos os recursos no ``` aws resourcegroupstaggingapi get-tag-values \ --key=Environment ``` Saída: ``` { "TagValues": [ "Alpha", "Gamma", "Production" ] } ``` Para obter mais informações, consulte a *Referência [GetTagValues](https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_GetTagValues.html)da API Resource Groups Tagging*. + Para obter detalhes da API, consulte [GetTagValues](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/resourcegroupstaggingapi/get-tag-values.html)em *Referência de AWS CLI Comandos*. ------ #### [ PowerShell ] **Ferramentas para PowerShell V4** **Exemplo 1: retorna o valor da tag especificada em uma região. Se o parâmetro -Region não for especificado, o cmdlet tentará inferir a região por meio da região padrão do shell ou dos metadados da instância do EC2.** ``` Get-RGTTagValue -Key "stage" -Region us-west-2 ``` **Saída**: ``` beta ``` + Para obter detalhes da API, consulte [GetTagValues](https://docs.aws.amazon.com/powershell/v4/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V4)*. **Ferramentas para PowerShell V5** **Exemplo 1: retorna o valor da tag especificada em uma região. Se o parâmetro -Region não for especificado, o cmdlet tentará inferir a região por meio da região padrão do shell ou dos metadados da instância do EC2.** ``` Get-RGTTagValue -Key "stage" -Region us-west-2 ``` **Saída**: ``` beta ``` + Para obter detalhes da API, consulte [GetTagValues](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*. ------ # Usar `TagResources` com uma CLI Os exemplos de código a seguir mostram como usar o `TagResources`. ------ #### [ CLI ] **AWS CLI** **Adicionar uma tag a um recurso** O exemplo `tag-resources` a seguir adiciona tags com o nome de chave e o valor à visualização especificada. ``` aws resourcegroupstaggingapi tag-resources \ --resource-arn-list arn:aws:s3:::MyProductionBucket \ --tags Environment=Production,CostCenter=1234 ``` Saída: ``` { "FailedResourcesMap": {} } ``` Para obter mais informações, consulte a *Referência [TagResources](https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_TagResources.html)da API Resource Groups Tagging*. + Para obter detalhes da API, consulte [TagResources](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/resourcegroupstaggingapi/tag-resources.html)em *Referência de AWS CLI Comandos*. ------ #### [ PowerShell ] **Ferramentas para PowerShell V4** **Exemplo 1: esse exemplo adiciona as chaves de tag “stage” e “version” com os valores “beta” e “preprod\$1test” a um bucket do Amazon S3 e a uma tabela do Amazon DynamoDB. Uma única chamada será feita para o serviço a fim de aplicar as tags.** ``` $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" } ``` **Exemplo 2: esse exemplo adiciona as tags e os valores especificados a um bucket do Amazon S3 e a uma tabela do Amazon DynamoDB. Duas chamadas são feitas para o serviço, uma para cada ARN de recurso canalizado para o cmdlet.** ``` $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" } ``` + Para obter detalhes da API, consulte [TagResources](https://docs.aws.amazon.com/powershell/v4/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V4)*. **Ferramentas para PowerShell V5** **Exemplo 1: esse exemplo adiciona as chaves de tag “stage” e “version” com os valores “beta” e “preprod\$1test” a um bucket do Amazon S3 e a uma tabela do Amazon DynamoDB. Uma única chamada será feita para o serviço a fim de aplicar as tags.** ``` $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" } ``` **Exemplo 2: esse exemplo adiciona as tags e os valores especificados a um bucket do Amazon S3 e a uma tabela do Amazon DynamoDB. Duas chamadas são feitas para o serviço, uma para cada ARN de recurso canalizado para o cmdlet.** ``` $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" } ``` + Para obter detalhes da API, consulte [TagResources](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*. ------ # Usar `UntagResources` com uma CLI Os exemplos de código a seguir mostram como usar o `UntagResources`. ------ #### [ CLI ] **AWS CLI** **Para remover uma tag de um recurso** O exemplo `untag-resources` a seguir remove as chaves de tag especificadas e seus valores associados do recurso especificado. ``` aws resourcegroupstaggingapi untag-resources \ --resource-arn-list arn:aws:s3:::amzn-s3-demo-bucket \ --tag-keys Environment CostCenter ``` Saída: ``` { "FailedResourcesMap": {} } ``` Para obter mais informações, consulte a *Referência [UntagResources](https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_UntagResources.html)da API Resource Groups Tagging*. + Para obter detalhes da API, consulte [UntagResources](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/resourcegroupstaggingapi/untag-resources.html)em *Referência de AWS CLI Comandos*. ------ #### [ PowerShell ] **Ferramentas para PowerShell V4** **Exemplo 1: remove as chaves de tag “stage” e “version” e os valores associados de um bucket do Amazon S3 e de uma tabela do Amazon DynamoDB. Uma única chamada será feita para o serviço a fim de remover as tags. Antes que as tags sejam removidas, o cmdlet solicitará a confirmação. Para ignorar a confirmação, adicione o parâmetro -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" ``` **Exemplo 2: remove as chaves de tag “stage” e “version” e os valores associados de um bucket do Amazon S3 e de uma tabela do Amazon DynamoDB. Duas chamadas são feitas para o serviço, uma para cada ARN de recurso canalizado para o cmdlet. Antes de cada chamada, o cmdlet solicitará a confirmação. Para ignorar a confirmação, adicione o parâmetro -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" ``` + Para obter detalhes da API, consulte [UntagResources](https://docs.aws.amazon.com/powershell/v4/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V4)*. **Ferramentas para PowerShell V5** **Exemplo 1: remove as chaves de tag “stage” e “version” e os valores associados de um bucket do Amazon S3 e de uma tabela do Amazon DynamoDB. Uma única chamada será feita para o serviço a fim de remover as tags. Antes que as tags sejam removidas, o cmdlet solicitará a confirmação. Para ignorar a confirmação, adicione o parâmetro -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" ``` **Exemplo 2: remove as chaves de tag “stage” e “version” e os valores associados de um bucket do Amazon S3 e de uma tabela do Amazon DynamoDB. Duas chamadas são feitas para o serviço, uma para cada ARN de recurso canalizado para o cmdlet. Antes de cada chamada, o cmdlet solicitará a confirmação. Para ignorar a confirmação, adicione o parâmetro -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" ``` + Para obter detalhes da API, consulte [UntagResources](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*. ------