Etiquetado de recursos de Amazon Pinpoint - Amazon Pinpoint

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.

Etiquetado de recursos de Amazon Pinpoint

Una etiqueta es una etiqueta que puede definir y asociar de forma opcional a AWS los recursos, incluidos determinados tipos de recursos de Amazon Pinpoint. Las etiquetas pueden ayudarle a clasificar y administrar recursos de distintas formas, como, por finalidad, propietario, entorno u otros criterios. Por ejemplo, puede usar etiquetas para aplicar políticas o automatización, o bien para identificar recursos que están sujetos a determinados requisitos de conformidad. Puede agregar etiquetas a los siguientes tipos de recursos de Amazon Pinpoint:

  • Campañas

  • Plantillas de mensaje

  • Proyectos (aplicaciones)

  • Segmentos

Un recurso puede tener hasta 50 etiquetas.

Administrar etiquetas

Cada etiqueta está formada por una clave de etiqueta y un valor de etiqueta opcional, ambos definidos por el usuario. Un clave de etiqueta es una etiqueta general que actúa como una categoría para valores de etiqueta más específicos. Un valor de etiqueta actúa como descriptor de una clave de etiqueta.

Una clave de etiqueta incluye hasta 128 caracteres. Un valor de etiqueta puede incluir hasta 256 caracteres. Los caracteres pueden ser letras Unicode, números, espacios en blanco o uno de los siguientes símbolos: _ . : / = + -. Las siguientes restricciones adicionales se aplican a las etiquetas:

  • Las claves y los valores de las etiquetas distinguen entre mayúsculas y minúsculas.

  • Para cada recurso asociado, cada clave de etiqueta debe ser única y solo puede tener un valor.

  • El aws: prefijo está reservado para que lo usen AWS; no puede usarlo en ninguna clave o valor de etiqueta que defina. Además, las claves o valores de etiqueta que utilizan este prefijo no se pueden editar ni quitar. Las etiquetas que usan este prefijo no cuentan para la cuota de 50 etiquetas por recurso.

  • No puede actualizar ni eliminar un recurso en función únicamente de sus etiquetas. También debe especificar el ID de recurso o nombre de recurso de Amazon (ARN), dependiendo de la operación que use.

  • Puede asociar etiquetas a recursos públicos o compartidos. Sin embargo, las etiquetas solo están disponibles para tu AWS cuenta, no para ninguna otra cuenta que comparta el recurso. Además, las etiquetas solo están disponibles para los recursos que se encuentran en la AWS región especificada para su AWS cuenta.

Para añadir, mostrar, actualizar y eliminar claves y valores de etiquetas de los recursos de Amazon Pinpoint, puede utilizar AWS Command Line Interface (AWS CLI), la API de Amazon Pinpoint, AWS Resource Groups la API de etiquetado o un SDK. AWS Para administrar las claves y los valores de las etiquetas en todos los AWS recursos que se encuentran en una AWS región específica de su AWS cuenta (incluidos los recursos de Amazon Pinpoint), utilice la API de AWS Resource Groups etiquetado.

Uso de etiquetas en políticas de IAM

Una vez que comience a implementar etiquetas, podrá aplicar permisos basados en etiquetas a nivel de recursos a las políticas AWS Identity and Access Management (IAM) y las operaciones de la API. Esto incluye operaciones que admiten agregar etiquetas a los recursos cuando se crean recursos. Al usar las etiquetas de esta manera, puede implementar un control pormenorizado sobre qué grupos y usuarios de su AWS cuenta tienen permiso para crear y etiquetar recursos, y qué grupos y usuarios tienen permiso para crear, actualizar y eliminar etiquetas de manera más general.

Por ejemplo, puede crear una política que permita a un usuario tener acceso completo a todos los recursos de Amazon Pinpoint en los que su nombre sea un valor en la etiqueta Owner del recurso:

{ "Version": "2012-10-17", "Statement": [ { "Sid": "ModifyResourceIfOwner", "Effect": "Allow", "Action": "mobiletargeting:*", "Resource": "*", "Condition": { "StringEqualsIgnoreCase": { "aws:ResourceTag/Owner": "${aws:username}" } } } ] }

Si define los permisos de nivel de recurso basados en etiquetas, estos entrarán en vigor inmediatamente. Esto significa que sus recursos están más seguros en cuanto se crean y que puede empezar a aplicar el uso de etiquetas de nuevos recursos rápidamente. También puede usar permisos de nivel de recurso para controlar las claves y valores de etiqueta que se pueden asociar a recursos nuevos y existentes. Para obtener más información, consulte Control del acceso mediante etiquetas en la Guía del usuario de IAM de AWS .

Adición de etiquetas de a los recursos de

En los ejemplos siguientes se muestra cómo agregar una etiqueta a un recurso de Amazon Pinpoint mediante la AWS CLI y la API de REST de Amazon Pinpoint. También puedes usar cualquier AWS SDK compatible para añadir una etiqueta a un recurso.

Para añadir una etiqueta a varios recursos de Amazon Pinpoint en una sola operación, utilice las operaciones de etiquetado de grupos de recursos de la API de etiquetado AWS CLI o la AWS Resource Groups API de etiquetado.

Agregar etiquetas mediante la API

Para crear un recurso nuevo y agregarle una etiqueta mediante la API de REST de Amazon Pinpoint, envíe una solicitud POST al URI de recurso apropiado. En el cuerpo de la solicitud, incluya el parámetro tags y los valores. En el siguiente ejemplo se muestra cómo especificar una etiqueta al crear un nuevo proyecto.

POST /v1/apps HTTP/1.1 Host: pinpoint.us-east-1.amazonaws.com Content-Type: application/x-www-form-urlencoded Accept: application/json Cache-Control: no-cache { "Name":"MyProject", "tags":{ "key1":"value1" } }

Para agregar una etiqueta a un recurso existente, envíe una solicitud POST al URI de Etiquetas. Incluya el nombre de recurso de Amazon (ARN) del recurso en el URI. El ARN debe estar codificado en la URL. En el cuerpo de la solicitud, incluya el parámetro tags y los valores, tal y como se muestra en el siguiente ejemplo.

POST /v1/tags/resource-arn HTTP/1.1 Host: pinpoint.us-east-1.amazonaws.com Content-Type: application/json Accept: application/json Cache-Control: no-cache { "tags":{ "key1":"value1" } }

Para añadir etiquetas, utilice la AWS CLI

Para crear un nuevo recurso y añadirle una etiqueta mediante el AWS CLI, utilice el create comando correspondiente al recurso. Incluya el parámetro tags y los valores. En el siguiente ejemplo se muestra cómo especificar etiquetas al crear un nuevo proyecto.

Linux, macOS, or Unix
$ aws pinpoint create-app \ --create-application-request '{ "Name":"MyProject", "tags": { "key1":"value1", "key2":"value2" } }'
Windows Command prompt
C:\> aws pinpoint create-app ^ --create-application-request Name=MyProject,tags={key1=value1,key2=value2}

En el ejemplo anterior, realice el siguiente procedimiento:

  • MyProjectSustitúyalo por el nombre que desee asignar al proyecto.

  • Sustituya key1 y key2 por las claves de las etiquetas que desee agregar al recurso.

  • Sustituya value1 y value2 por los valores de las etiquetas que desee agregar para las claves respectivas.

Para obtener información acerca de los comandos que puede usar para crear un recurso de Amazon Pinpoint, consulte la Referencia de comandos de la AWS CLI.

Para agregar una etiqueta a un recurso existente, utilice el comando tag-resource y especifique los valores adecuados para los parámetros requeridos:

Linux, macOS, or Unix
$ aws pinpoint tag-resource \ --resource-arn resource-arn \ --tags-model '{ "tags": { "key1":"value1", "key2":"value2" } }'
Windows Command Prompt
C:\> aws pinpoint tag-resource ^ --resource-arn resource-arn ^ --tags-model tags={key1=value1,key2=value2}

En el ejemplo anterior, realice el siguiente procedimiento:

  • Sustituya resource-arn por el nombre de recurso de Amazon (ARN) del recurso al que desea agregar una etiqueta.

  • Sustituya key1 y key2 por las claves de las etiquetas que desee agregar al recurso.

  • Sustituya value1 y value2 por los valores de las etiquetas que desee agregar para las claves respectivas.

Visualización de etiquetas para recursos

Los ejemplos siguientes muestran cómo utilizar la AWS CLI y la API de REST de Amazon Pinpoint para mostrar una lista de todas las etiquetas (claves y valores) asociadas a un recurso de Amazon Pinpoint. También puedes usar cualquier AWS SDK compatible para mostrar las etiquetas asociadas a un recurso.

Visualización de etiquetas mediante la API

Para utilizar la API de REST de Amazon Pinpoint para mostrar todas las etiquetas que están asociadas a un recurso específico, envíe una solicitud GET al URI Etiquetas e incluya el nombre de recurso de Amazon (ARN) del recurso en el URI. El ARN debe estar codificado en la URL. Por ejemplo, la siguiente solicitud recupera todas las etiquetas asociadas a una campaña especificada (resource-arn):

GET /v1/tags/resource-arn HTTP/1.1 Host: pinpoint.us-east-1.amazonaws.com Content-Type: application/json Accept: application/json Cache-Control: no-cache

La respuesta JSON a la solicitud incluye un objeto tags. El objeto tags enumera todas las claves de etiqueta y los valores asociados a la campaña.

Para mostrar todas las etiquetas asociadas a más de un recurso del mismo tipo, envíe una solicitud GET al URI adecuado para dicho tipo de recurso. Por ejemplo, la siguiente solicitud recopila información acerca de todas las campañas en el proyecto especificado (application-id):

GET /v1/apps/application-id/campaigns HTTP/1.1 Host: pinpoint.us-east-1.amazonaws.com Content-Type: application/json Accept: application/json Cache-Control: no-cache

La respuesta JSON a la solicitud muestra todas las campañas del proyecto. El objeto tags de cada campaña muestra todas las claves y valores de etiqueta asociados a la campaña.

Visualización de etiquetas mediante el AWS CLI

Para usar el AWS CLI para mostrar una lista de las etiquetas asociadas a un recurso específico, ejecute el list-tags-for-resource comando y especifique el nombre del recurso de Amazon (ARN) del recurso para el resource-arn parámetro, como se muestra en el siguiente ejemplo.

Linux, macOS, or Unix
$ aws pinpoint list-tags-for-resource \ --resource-arn resource-arn
Windows Command Prompt
C:\> aws pinpoint list-tags-for-resource ^ --resource-arn resource-arn

Para mostrar una lista de todos los recursos de Amazon Pinpoint que tienen etiquetas y todas las etiquetas asociadas a cada uno de esos recursos, utilice el comando get-resources de la API de etiquetado. AWS Resource Groups Establezca el parámetro resource-type-filters en mobiletargeting, como se muestra en el siguiente ejemplo.

Linux, macOS, or Unix
$ aws resourcegroupstaggingapi get-resources \ --resource-type-filters "mobiletargeting"
Windows Command Prompt
C:\> aws resourcegroupstaggingapi get-resources ^ --resource-type-filters "mobiletargeting"

La salida del comando es una lista de ARN de todos los recursos de Amazon Pinpoint que tienen etiquetas. En la lista se incluyen todas las claves y valores de etiqueta asociados a cada recurso.

Actualización de etiquetas para recursos

Existen varias formas de actualizar (sobrescribir) una etiqueta para un recurso de Amazon Pinpoint. La mejor manera de actualizar una etiqueta depende de:

  • El tipo de recurso para el que desea actualizar etiquetas.

  • Si desea actualizar una etiqueta para uno o varios recursos al mismo tiempo.

  • Si desea actualizar una clave de etiqueta, un valor de etiqueta, o ambos.

Para actualizar una etiqueta para un proyecto de Amazon Pinpoint o para varios recursos al mismo tiempo, utilice las operaciones de etiquetado de grupos de recursos de la API de etiquetado AWS CLI o de la API de etiquetado.AWS Resource Groups En la actualidad, la API de Amazon Pinpoint no admite directamente ninguna de esas tareas.

Para actualizar una etiqueta para un recurso, puede eliminar la etiqueta actual y agregar una nueva etiqueta mediante la API de Amazon Pinpoint.

Eliminar etiquetas de recursos

Los siguientes ejemplos muestran cómo eliminar una etiqueta (tanto la clave como el valor) de un recurso de Amazon Pinpoint mediante la AWS CLI y la API de REST de Amazon Pinpoint. También puede usar cualquier AWS SDK compatible para eliminar una etiqueta de un recurso.

Para eliminar una etiqueta de varios recursos de Amazon Pinpoint en una sola operación, utilice las operaciones de etiquetado de grupos de recursos de la API de etiquetado AWS CLI o la AWS Resource Groups API de etiquetado. Para quitar solo un valor de etiqueta específico (no una clave de etiqueta) de un recurso, puede actualizar la etiqueta para el recurso.

Eliminación de etiquetas mediante la API

Para eliminar una etiqueta de un recurso mediante la API de REST de Amazon Pinpoint, envíe una solicitud DELETE al URI de las etiquetas. En el URI, incluya el nombre de recurso de Amazon (ARN) del recurso del que desea quitar una etiqueta, seguida del parámetro tagKeys y la etiqueta que se va a quitar. Por ejemplo:

https://endpoint/v1/tags/resource-arn?tagKeys=key

Donde:

  • punto de conexión es el punto de conexión de Amazon Pinpoint de la región de AWS que aloja el recurso.

  • resource-arn es el ARN del recurso del que desea quitar una etiqueta.

  • key es la etiqueta que desea quitar del recurso.

Todos los parámetros deben tener codificación URL.

Para quitar varias claves de etiquetas y sus valores asociados de un recurso, añada el parámetro tagKeys y el argumento para cada una de las etiquetas adicionales que se van a quitar, separadas por un signo ampersand (&). Por ejemplo:

https://endpoint/v1/tags/resource-arn?tagKeys=key1&tagKeys=key2

Todos los parámetros deben tener codificación URL.

Para eliminar las etiquetas, utilice la AWS CLI

Para eliminar una etiqueta de un recurso mediante el AWS CLI, ejecute el untag-resource comando. Incluya el argumento y el parámetro tag-keys, como se muestra en el siguiente ejemplo.

Linux, macOS, or Unix
$ aws pinpoint untag-resource \ --resource-arn resource-arn \ --tag-keys key1 key2
Windows Command Prompt
C:\> aws pinpoint untag-resource ^ --resource-arn resource-arn ^ --tag-keys key1 key2

En el ejemplo anterior, realice los siguientes cambios:

  • Sustituya resource-arn por el ARN del recurso del que desea eliminar etiquetas.

  • Sustituya key1 y key2 por las claves de las etiquetas que desee eliminar del recurso.

Para obtener más información acerca de los comandos de la CLI que puede usar para administrar recursos de Amazon Pinpoint, consulte la sección de Amazon Pinpoint de la Referencia de comandos de la AWS CLI.

Para obtener más información acerca de los recursos de la API de Amazon Pinpoint, incluidos los esquemas, parámetros y métodos HTTP(S) admitidos, consulte la Referencia de la API de Amazon Pinpoint.