Hay más ejemplos de AWS SDK disponibles en el GitHub repositorio de [ejemplos de AWS Doc SDK](https://github.com/awsdocs/aws-doc-sdk-examples). Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés. # Ejemplos de código para la API de etiquetado de Resource Groups mediante AWS SDKs Los siguientes ejemplos de código muestran cómo utilizarla AWS Resource Groups Tagging API con un kit de desarrollo de AWS software (SDK). Las *acciones* son extractos de código de programas más grandes y deben ejecutarse en contexto. Mientras las acciones muestran cómo llamar a las distintas funciones de servicio, es posible ver las acciones en contexto en los escenarios relacionados. **Más recursos** + **[Guía del usuario de API de etiquetado de grupos de recursos](https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html)**: más información sobre API de etiquetado de grupos de recursos. + **[Referencia de la API de API de etiquetado de grupos de recursos](https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/overview.html)**: información sobre todas las acciones disponibles en API de etiquetado de grupos de recursos. + **[AWS Centro para desarrolladores](https://aws.amazon.com/developer/code-examples/?awsf.sdk-code-examples-product=product%23)**: ejemplos de código que puede filtrar por categoría o por búsqueda de texto completo. + **[AWS Ejemplos de SDK](https://github.com/awsdocs/aws-doc-sdk-examples)**: GitHub repositorio con código completo en los idiomas preferidos. Incluye instrucciones para configurar y ejecutar el código. **Contents** + [Conceptos básicos](resource-groups-tagging-api_code_examples_basics.md) + [Acciones](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) # Ejemplos básicos de la API de etiquetado de Resource Groups mediante AWS SDKs Los siguientes ejemplos de código muestran cómo utilizar los conceptos básicos de AWS Resource Groups Tagging API with AWS SDKs. **Contents** + [Acciones](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) # Acciones para la API de etiquetado de Resource Groups mediante AWS SDKs Los siguientes ejemplos de código muestran cómo realizar acciones individuales de la API de etiquetado de Resource Groups con AWS SDKs. Cada ejemplo incluye un enlace a GitHub, donde puede encontrar instrucciones para configurar y ejecutar el código. Los siguientes ejemplos incluyen solo las acciones que se utilizan con mayor frecuencia. Para ver una lista completa, consulte la [Referencia de la API de 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) # Utilizar `GetResources` con una CLI Los siguientes ejemplos de código muestran cómo utilizar `GetResources`. ------ #### [ CLI ] **AWS CLI** **Para obtener una lista de recursos etiquetados** En el siguiente ejemplo de `get-resources`, se muestra una lista de los recursos de la cuenta que están etiquetados con el nombre y el valor clave especificados. ``` aws resourcegroupstaggingapi get-resources \ --tag-filters Key=Environment,Values=Production \ --tags-per-page 100 ``` Salida: ``` { "ResourceTagMappingList": [ { "ResourceARN": " arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-7sbz2Kz0", "Tags": [ { "Key": "Environment", "Value": "Production" } ] } ] } ``` Para obtener más información, consulte la *referencia [GetResources](https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_GetResources.html)de la API de etiquetado de Resource Groups*. + Para obtener más información sobre la API, consulte [GetResources](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/resourcegroupstaggingapi/get-resources.html)la *Referencia de AWS CLI comandos*. ------ #### [ PowerShell ] **Herramientas para la PowerShell versión 4** **Ejemplo 1: Devuelve todos los recursos etiquetados de una región y las claves de etiqueta asociadas al recurso. Si no se proporciona ningún parámetro -Region al cmdlet, se intentará deducir la región del intérprete de comandos de los metadatos de la instancia de EC2.** ``` Get-RGTResource ``` **Salida:** ``` ResourceARN Tags ----------- ---- arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version} arn:aws:s3:::amzn-s3-demo-bucket {stage, version, othertag} ``` **Ejemplo 2: Devuelve todos los recursos etiquetados del tipo especificado en una región. La cadena de cada nombre de servicio y tipo de recurso es la misma que la incluida en el Nombre de recurso de Amazon (ARN) de un recurso.** ``` Get-RGTResource -ResourceType "s3" ``` **Salida:** ``` ResourceARN Tags ----------- ---- arn:aws:s3:::amzn-s3-demo-bucket {stage, version, othertag} ``` **Ejemplo 3: Devuelve todos los recursos etiquetados del tipo especificado en una región. Tenga en cuenta que cuando los tipos de recursos se envían al cmdlet, se realiza una llamada al servicio por cada tipo de recurso especificado.** ``` "dynamodb","s3" | Get-RGTResource ``` **Salida:** ``` ResourceARN Tags ----------- ---- arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version} arn:aws:s3:::amzn-s3-demo-bucket {stage, version, othertag} ``` **Ejemplo 4: Devuelve todos los recursos etiquetados que coinciden con el filtro especificado.** ``` Get-RGTResource -TagFilter @{ Key="stage" } ``` **Salida:** ``` ResourceARN Tags ----------- ---- arn:aws:s3:::amzn-s3-demo-bucket {stage, version, othertag} ``` **Ejemplo 5: Devuelve todos los recursos etiquetados que coinciden con el filtro especificado.** ``` Get-RGTResource -TagFilter @{ Key="stage" } -ResourceType "dynamodb" ``` **Salida:** ``` ResourceARN Tags ----------- ---- arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version} ``` **Ejemplo 6: Devuelve todos los recursos etiquetados que coinciden con el filtro especificado.** ``` Get-RGTResource -TagFilter @{ Key="stage"; Values=@("beta","gamma") } ``` **Salida:** ``` ResourceARN Tags ----------- ---- arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version} ``` + Para obtener más información sobre la API, consulte [GetResources Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v4/reference)*Cmdlet Reference (V4)*. **Herramientas para la versión 5 PowerShell ** **Ejemplo 1: Devuelve todos los recursos etiquetados de una región y las claves de etiqueta asociadas al recurso. Si no se proporciona ningún parámetro -Region al cmdlet, se intentará deducir la región del intérprete de comandos de los metadatos de la instancia de EC2.** ``` Get-RGTResource ``` **Salida:** ``` ResourceARN Tags ----------- ---- arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version} arn:aws:s3:::amzn-s3-demo-bucket {stage, version, othertag} ``` **Ejemplo 2: Devuelve todos los recursos etiquetados del tipo especificado en una región. La cadena de cada nombre de servicio y tipo de recurso es la misma que la incluida en el Nombre de recurso de Amazon (ARN) de un recurso.** ``` Get-RGTResource -ResourceType "s3" ``` **Salida:** ``` ResourceARN Tags ----------- ---- arn:aws:s3:::amzn-s3-demo-bucket {stage, version, othertag} ``` **Ejemplo 3: Devuelve todos los recursos etiquetados del tipo especificado en una región. Tenga en cuenta que cuando los tipos de recursos se envían al cmdlet, se realiza una llamada al servicio por cada tipo de recurso especificado.** ``` "dynamodb","s3" | Get-RGTResource ``` **Salida:** ``` ResourceARN Tags ----------- ---- arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version} arn:aws:s3:::amzn-s3-demo-bucket {stage, version, othertag} ``` **Ejemplo 4: Devuelve todos los recursos etiquetados que coinciden con el filtro especificado.** ``` Get-RGTResource -TagFilter @{ Key="stage" } ``` **Salida:** ``` ResourceARN Tags ----------- ---- arn:aws:s3:::amzn-s3-demo-bucket {stage, version, othertag} ``` **Ejemplo 5: Devuelve todos los recursos etiquetados que coinciden con el filtro especificado.** ``` Get-RGTResource -TagFilter @{ Key="stage" } -ResourceType "dynamodb" ``` **Salida:** ``` ResourceARN Tags ----------- ---- arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version} ``` **Ejemplo 6: Devuelve todos los recursos etiquetados que coinciden con el filtro especificado.** ``` Get-RGTResource -TagFilter @{ Key="stage"; Values=@("beta","gamma") } ``` **Salida:** ``` ResourceARN Tags ----------- ---- arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version} ``` + Para obtener más información sobre la API, consulte [GetResources](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5). ------ # Utilizar `GetTagKeys` con una CLI Los siguientes ejemplos de código muestran cómo utilizar `GetTagKeys`. ------ #### [ CLI ] **AWS CLI** **Para obtener una lista de todas las claves de etiqueta** En el siguiente ejemplo de `get-tag-keys` se recupera la lista de todos los nombres de las claves de etiqueta que utilizan los recursos de la cuenta. ``` aws resourcegroupstaggingapi get-tag-keys ``` Salida: ``` { "TagKeys": [ "Environment", "CostCenter", "Department" ] } ``` Para obtener más información, consulte la *referencia [GetTagKeys](https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_GetTagKeys.html)de la API de etiquetado de Resource Groups*. + Para obtener más información sobre la API, consulte [GetTagKeys](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/resourcegroupstaggingapi/get-tag-keys.html)la *Referencia de AWS CLI comandos*. ------ #### [ PowerShell ] **Herramientas para la PowerShell versión 4** **Ejemplo 1: Devuelve todas las claves de etiqueta de la región especificada. Si no se especifica el parámetro -Region, el cmdlet intentará deducir la región del intérprete de comandos predeterminado o los metadatos de la instancia de EC2. Tenga en cuenta que las claves de las etiquetas no se devuelven en ningún orden específico.** ``` Get-RGTTagKey -region us-west-2 ``` **Salida:** ``` version stage ``` + Para obtener más información sobre la API, consulte [GetTagKeys Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v4/reference)*Cmdlet Reference (V4)*. **Herramientas para la versión 5 PowerShell ** **Ejemplo 1: Devuelve todas las claves de etiqueta de la región especificada. Si no se especifica el parámetro -Region, el cmdlet intentará deducir la región del intérprete de comandos predeterminado o los metadatos de la instancia de EC2. Tenga en cuenta que las claves de las etiquetas no se devuelven en ningún orden específico.** ``` Get-RGTTagKey -region us-west-2 ``` **Salida:** ``` version stage ``` + Para obtener más información sobre la API, consulte [GetTagKeys](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5). ------ # Utilizar `GetTagValues` con una CLI Los siguientes ejemplos de código muestran cómo utilizar `GetTagValues`. ------ #### [ CLI ] **AWS CLI** **Para obtener una lista de todos los valores de etiqueta** En el ejemplo siguiente de `get-tag-values`, se muestran todos los valores utilizados para la clave especificada de todos los recursos del ``` aws resourcegroupstaggingapi get-tag-values \ --key=Environment ``` Salida: ``` { "TagValues": [ "Alpha", "Gamma", "Production" ] } ``` Para obtener más información, consulte la *referencia [GetTagValues](https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_GetTagValues.html)de la API de etiquetado de Resource Groups*. + Para obtener más información sobre la API, consulte [GetTagValues](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/resourcegroupstaggingapi/get-tag-values.html)la *Referencia de AWS CLI comandos*. ------ #### [ PowerShell ] **Herramientas para la PowerShell versión 4** **Ejemplo 1: Devuelve el valor de la etiqueta especificada en la región. Si no se especifica el parámetro -Region, el cmdlet intentará deducir la región del intérprete de comandos predeterminado o los metadatos de la instancia de EC2.** ``` Get-RGTTagValue -Key "stage" -Region us-west-2 ``` **Salida:** ``` beta ``` + Para obtener más información sobre la API, consulte [GetTagValues Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v4/reference)*Cmdlet Reference (V4)*. **Herramientas para la versión 5 PowerShell ** **Ejemplo 1: Devuelve el valor de la etiqueta especificada en la región. Si no se especifica el parámetro -Region, el cmdlet intentará deducir la región del intérprete de comandos predeterminado o los metadatos de la instancia de EC2.** ``` Get-RGTTagValue -Key "stage" -Region us-west-2 ``` **Salida:** ``` beta ``` + Para obtener más información sobre la API, consulte [GetTagValues](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5). ------ # Utilizar `TagResources` con una CLI Los siguientes ejemplos de código muestran cómo utilizar `TagResources`. ------ #### [ CLI ] **AWS CLI** **Para asociar una etiqueta a un recurso** El siguiente ejemplo de `tag-resources` etiqueta el recurso especificado con un nombre y un valor clave. ``` aws resourcegroupstaggingapi tag-resources \ --resource-arn-list arn:aws:s3:::MyProductionBucket \ --tags Environment=Production,CostCenter=1234 ``` Salida: ``` { "FailedResourcesMap": {} } ``` Para obtener más información, consulte la *referencia [TagResources](https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_TagResources.html)de la API de etiquetado de Resource Groups*. + Para obtener más información sobre la API, consulte [TagResources](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/resourcegroupstaggingapi/tag-resources.html)la *Referencia de AWS CLI comandos*. ------ #### [ PowerShell ] **Herramientas para la PowerShell versión 4** **Ejemplo 1: En este ejemplo se añaden las claves de etiqueta “stage” y “version” con los valores “beta” y “preprod\$1test” a un bucket de Amazon S3 y a una tabla de Amazon DynamoDB. Se realiza una sola llamada al servicio para aplicar las etiquetas.** ``` $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" } ``` **Ejemplo 2: En este ejemplo se añaden las etiquetas y los valores especificados a un bucket de Amazon S3 y a una tabla de Amazon DynamoDB. Se realizan dos llamadas al servicio, una para cada ARN de recurso enviado al 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 obtener más información sobre la API, consulte [TagResources Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v4/reference)*Cmdlet Reference (V4)*. **Herramientas para la versión 5 PowerShell ** **Ejemplo 1: En este ejemplo se añaden las claves de etiqueta “stage” y “version” con los valores “beta” y “preprod\$1test” a un bucket de Amazon S3 y a una tabla de Amazon DynamoDB. Se realiza una sola llamada al servicio para aplicar las etiquetas.** ``` $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" } ``` **Ejemplo 2: En este ejemplo se añaden las etiquetas y los valores especificados a un bucket de Amazon S3 y a una tabla de Amazon DynamoDB. Se realizan dos llamadas al servicio, una para cada ARN de recurso enviado al 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 obtener más información sobre la API, consulte [TagResources](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5). ------ # Utilizar `UntagResources` con una CLI Los siguientes ejemplos de código muestran cómo utilizar `UntagResources`. ------ #### [ CLI ] **AWS CLI** **Para eliminar una etiqueta de un recurso** El siguiente ejemplo de `untag-resources` elimina las claves de etiqueta especificadas y cualquier valor asociado de un recurso especificado. ``` aws resourcegroupstaggingapi untag-resources \ --resource-arn-list arn:aws:s3:::amzn-s3-demo-bucket \ --tag-keys Environment CostCenter ``` Salida: ``` { "FailedResourcesMap": {} } ``` Para obtener más información, consulte la *referencia [UntagResources](https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_UntagResources.html)de la API de etiquetado de Resource Groups*. + Para obtener más información sobre la API, consulte [UntagResources](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/resourcegroupstaggingapi/untag-resources.html)la *Referencia de AWS CLI comandos*. ------ #### [ PowerShell ] **Herramientas para la PowerShell versión 4** **Ejemplo 1: Elimina las claves de etiqueta “stage” y ”version”, así como los valores asociados, de un bucket de Amazon S3 y una tabla de Amazon DynamoDB. Se realiza una sola llamada al servicio para eliminar las etiquetas. Antes de eliminar las etiquetas, el cmdlet solicitará confirmación. Para omitir la confirmación, añada el 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" ``` **Ejemplo 2: Elimina las claves de etiqueta “stage” y ”version”, así como los valores asociados, de un bucket de Amazon S3 y una tabla de Amazon DynamoDB. Se realizan dos llamadas al servicio, una para cada ARN de recurso enviado al cmdlet. Antes de cada llamada, el cmdlet solicitará confirmación. Para omitir la confirmación, añada el 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 obtener más información sobre la API, consulte [UntagResources Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v4/reference)*Cmdlet Reference (V4)*. **Herramientas para la versión 5 PowerShell ** **Ejemplo 1: Elimina las claves de etiqueta “stage” y ”version”, así como los valores asociados, de un bucket de Amazon S3 y una tabla de Amazon DynamoDB. Se realiza una sola llamada al servicio para eliminar las etiquetas. Antes de eliminar las etiquetas, el cmdlet solicitará confirmación. Para omitir la confirmación, añada el 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" ``` **Ejemplo 2: Elimina las claves de etiqueta “stage” y ”version”, así como los valores asociados, de un bucket de Amazon S3 y una tabla de Amazon DynamoDB. Se realizan dos llamadas al servicio, una para cada ARN de recurso enviado al cmdlet. Antes de cada llamada, el cmdlet solicitará confirmación. Para omitir la confirmación, añada el 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 obtener más información sobre la API, consulte [UntagResources](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5). ------