

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á.

# Gerenciar tags de chave com operações de API
<a name="manage-tags-api"></a>

É possível usar a [API de AWS Payment Cryptography](https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/Welcome.html) para adicionar, excluir e listar tags para as chaves que você gerencia. Estes exemplos usam a [AWS Command Line Interface (AWS CLI)](https://aws.amazon.com/cli/), mas você pode usar qualquer linguagem de programação compatível. Você não pode marcar Chaves gerenciadas pela AWS.

Para adicionar, editar, visualizar e excluir tags de uma chave, é necessário ter as permissões apropriadas. Para obter detalhes, consulte [Controlar o acesso às tags](tag-permissions.md).

**Topics**
+ [CreateKey: Adicionar tags a uma nova chave](#tagging-keys-create-key)
+ [TagResource: Adicionar ou alterar tags para uma chave](#tagging-keys-tag-resource)
+ [ListResourceTags: Obtenha as etiquetas para uma chave](#tagging-keys-list-resource-tags)
+ [UntagResource: Excluir tags de uma chave](#tagging-keys-untag-resource)

## CreateKey: Adicionar tags a uma nova chave
<a name="tagging-keys-create-key"></a>

Você pode adicionar tags ao criar uma chave. Para especificar as tags, use o `Tags` parâmetro da [CreateKey](https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateKey.html)operação.

Para adicionar tags ao criar uma chave, o chamador deve ter a permissão `payment-cryptography:TagResource` em uma política do IAM. Essa permissão deve abranger, no mínimo, todas as chaves na conta e na região. Para obter detalhes, consulte [Controlar o acesso às tags](tag-permissions.md).

O valor do parâmetro `Tags` de `CreateKey` é uma coleção de pares de chave de etiqueta e valor de etiqueta que faz distinção entre maiúsculas e minúsculas. Cada tag em uma chave deve ter um nome de tag diferente. O valor da tag pode ser uma string nula ou vazia.

Por exemplo, o AWS CLI comando a seguir cria uma chave de criptografia simétrica com uma `Project:Alpha` tag. Ao especificar mais de um par de chave-valor, use um espaço para separar cada par.

```
$ aws payment-cryptography create-key --exportable --key-attributes KeyAlgorithm=TDES_2KEY, \
        KeyUsage=TR31_C0_CARD_VERIFICATION_KEY,KeyClass=SYMMETRIC_KEY, \
        KeyModesOfUse='{Generate=true,Verify=true}' \
        --tags '[{"Key":"Project","Value":"Alpha"},{"Key":"BIN","Value":"123456"}]'
```

Quando esse comando é bem-sucedido, ele retorna um objeto `Key` com informações sobre a nova chave. No entanto, o `Key` não inclui tags. Para obter as tags, use a [ListResourceTags](#tagging-keys-list-resource-tags)operação.

## TagResource: Adicionar ou alterar tags para uma chave
<a name="tagging-keys-tag-resource"></a>

A [TagResource](https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_TagResource.html)operação adiciona uma ou mais tags a uma chave. Não é possível usar essa operação para adicionar ou editar etiquetas em uma Conta da AWS diferente.

Para adicionar uma tag, especifique uma nova chave e um valor de tag. Para editar uma tag, especifique uma chave de tag existente e um novo valor de tag. Cada tag em uma chave deve ter uma chave de tag diferente. O valor da tag pode ser uma string nula ou vazia.

Por exemplo, o comando a seguir adiciona as tags **UseCase** e **BIN** a uma chave demonstrativa.

```
$ aws payment-cryptography tag-resource --resource-arn arn:aws:payment-cryptography:us-east-2:111122223333:key/kwapwa6qaifllw2h --tags '[{"Key":"UseCase","Value":"Acquiring"},{"Key":"BIN","Value":"123456"}]' 
```

Quando esse comando for executado com êxito, ele não retornará nenhuma saída. Para visualizar as tags em uma chave, use a [ListResourceTags](https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ListTagsForResource.html)operação.

Você também pode usar **TagResource** para alterar o valor de uma tag existente. Para substituir um valor de tag, especifique a mesma chave de tag com um valor diferente. Tags não listadas em um comando de modificação não são alteradas nem removidas.

Por exemplo, esse comando altera o valor da tag `Project` de `Alpha` para `Noe`.

O comando retornará http/200 sem conteúdo. Para ver suas alterações, use `ListTagsForResource`

```
$ aws payment-cryptography tag-resource --resource-arn arn:aws:payment-cryptography:us-east-2:111122223333:key/kwapwa6qaifllw2h \ 
        --tags '[{"Key":"Project","Value":"Noe"}]'
```

## ListResourceTags: Obtenha as etiquetas para uma chave
<a name="tagging-keys-list-resource-tags"></a>

A [ListResourceTags](https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ListTagsForResource.html)operação obtém as etiquetas de uma chave. O parâmetro `ResourceArn` (keyARN ou keyAlias) é obrigatório. Essa operação não pode ser usada para visualizar as tags nas chaves em uma Conta da AWS diferente.

Por exemplo, o comando a seguir obtém as tags para uma chave demonstrativa.

```
$ aws payment-cryptography list-tags-for-resource --resource-arn arn:aws:payment-cryptography:us-east-2:111122223333:key/kwapwa6qaifllw2h
       
  {
    "Tags": [
        {
            "Key": "BIN",
            "Value": "20151120"
        },
        {
            "Key": "Project",
            "Value": "Production"
        }
    ]
}
```

## UntagResource: Excluir tags de uma chave
<a name="tagging-keys-untag-resource"></a>

A [UntagResource](https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_UntagResource.html)operação exclui as tags de uma chave. Para identificar as etiquetas a serem excluídas, especifique as chaves de etiqueta. Essa operação não pode ser usada para excluir tags de chaves em uma Conta da AWS diferente.

Quando é bem-sucedida, a operação `UntagResource` não retorna nenhuma saída. Além disso, se a chave da tag especificada não for encontrada na chave, ela não lançará uma exceção nem retornará uma resposta. Para confirmar se a operação funcionou, use a [ListResourceTags](https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ListTagsForResource.html)operação.

Por exemplo, esse comando exclui a tag **Purpose** e seu valor com base na chave especificada.

```
$ aws payment-cryptography untag-resource \ 
        --resource-arn arn:aws:payment-cryptography:us-east-2:111122223333:key/kwapwa6qaifllw2h --tag-keys Project
```