Marcação de domínios do Amazon OpenSearch Service

As etiquetas permitem atribuir informações arbitrárias a um domínio do Amazon OpenSearch Service para que você possa categorizar e filtrar por essas informações. Uma tag é um par de chaves-valor que você define e associa a um domínio do OpenSearch Service. Você pode usar essas tags para monitorar custos agrupando despesas de recursos marcados com tags semelhantes. A AWS não aplica nenhum significado semântico às suas tags. Tags são interpretadas estritamente como sequências de caracteres. Todas as tags têm os elementos a seguir:

Elemento da tag	Descrição	Obrigatório
Chave de tag	A chave de tags é o nome da tag. A chave deve ser exclusiva do domínio do OpenSearch Service ao qual ela está anexada. Para obter uma lista de restrições básicas a chaves e valores de tag, consulte Restrições a tags definidas pelo usuário.	Sim
Valor da tag	O valor da tag é o valor da string da tag. Os valores de tag podem ser null e não precisam ser exclusivos em um conjunto de tags. Por exemplo, você pode ter um par de chave-valor em um conjunto de tags definido como projeto/Trinity e centro-custos/Trinity. Para obter uma lista de restrições básicas a chaves e valores de tag, consulte Restrições a tags definidas pelo usuário.	Não

Cada domínio do OpenSearch Service tem um conjunto de tags que contém todas as tags atribuídas a esse domínio do OpenSearch Service. O AWS não atribui automaticamente nenhuma marca a domínios do OpenSearch Service. Um conjunto de tags pode conter entre 0 e 50 tags. Se você adicionar uma tag a um domínio que tenha a mesma chave que uma tag existente, o novo valor sobrescreverá o antigo.

Exemplos de marcação com tags

Você pode usar uma chave para definir uma categoria, e o valor da tag pode ser um item nessa categoria. Por exemplo, você pode definir uma chave de tag como project e um valor de tag como Salix, indicando que o domínio do OpenSearch Service é atribuído ao projeto Salix. As tags também podem ser usadas para designar domínios do OpenSearch Service como sendo usados para testes ou produção por meio do uso de uma chave como environment=test ou environment=production. Recomendamos usar um conjunto consistente de chaves de tag para facilitar o monitoramento de metadados associados aos domínios do OpenSearch Service.

Também é possível usar tags para organizar sua conta AWS para refletir sua própria estrutura de custo. Para fazer isso, inscreva-se para obter a fatura da sua Conta da AWS com os valores de chave de tag incluídos. Organize então suas informações de faturamento de acordo com recursos com os mesmos valores de chave de tag para ver o custo de recursos combinados. Por exemplo, você pode atribuir tags a vários domínios do OpenSearch Service com pares de chave/valor e, em seguida, organizar suas informações de faturamento para ver o custo total para cada domínio em vários serviços. Para obter mais informações, consulte Como usar tags de alocação de custos na documentação do AWS Billing and Cost Management.

nota

As tags são armazenados em cache para finalidade de autorização. Por isso, as adições e atualizações de tag em domínios do OpenSearch Service podem demorar alguns minutos para ser disponibilizadas.

Uso de tags (console)

O console é a maneira mais simples marcar um domínio com tags.

Para criar uma tag (console)

1. Vá para https://aws.amazon.com e escolha Sign In to the Console (Fazer login no console)

2. Em Analytics (Análise), escolha Amazon OpenSearch Service.

3. Selecione o domínio ao qual você deseja adicionar tags e vá para guia Tags (Etiquetas).

4. Escolha Manage (Gerenciar) e Add new tag (Adicionar nova tag).

5. Insira uma chave de tag e um valor opcional.

6. Escolha Save (Salvar).

Para excluir uma tag, siga as mesmas etapas e escolha Remove (Remover) na página Manage tags (Gerenciar tags).

Para obter mais informações sobre como usar o console para trabalhar com tags, consulte Editor de tags no Guia de conceitos básicos do Console de GerenciamentoAWS.

Uso de tags (AWS CLI)

Você pode criar tags de recurso na AWS CLI com o comando --add-tags.

Sintaxe

add-tags --arn=<domain_arn> --tag-list Key=<key>,Value=<value>

Parâmetro	Descrição
--arn	Nome do recurso da Amazon para o domínio do OpenSearch Service ao qual a tag está anexada.
--tag-list	Conjunto de pares de chave/valor separados por espaço no seguinte formato: Key=<key>,Value=<value>

Exemplo

O exemplo a seguir cria duas tags para o domínio logs:

aws opensearch add-tags --arn arn:aws:es:us-east-1:379931976431:domain/logs --tag-list Key=service,Value=OpenSearch Key=instances,Value=m3.2xlarge

Você pode remover as tags de um domínio do OpenSearch Service usando o comando remove-tags.

Sintaxe

remove-tags --arn=<domain_arn> --tag-keys Key=<key>,Value=<value>

Parâmetro	Descrição
--arn	Nome do recurso da Amazon (ARN) para o domínio do OpenSearch Service ao qual a tag está anexada.
--tag-keys	Conjunto de pares de chave-valor separados por espaços que você deseja remover do domínio do OpenSearch Service.

Exemplo

O exemplo a seguir remove duas tags do domínio logs que foram criadas no exemplo anterior:

aws opensearch remove-tags --arn arn:aws:es:us-east-1:379931976431:domain/logs --tag-keys service instances

Você pode visualizar as tags existentes para um domínio do OpenSearch Service com o comando list-tags:

Sintaxe

list-tags --arn=<domain_arn>

Parâmetro	Descrição
--arn	Nome do recurso da Amazon (ARN) para o domínio do OpenSearch Service ao qual as tags estão anexadas.

Exemplo

O exemplo a seguir lista todas as tags de recurso para o domínio logs:

aws opensearch list-tags --arn arn:aws:es:us-east-1:379931976431:domain/logs

Uso de tags (AWS SDKs)

Os SDKs da AWS (exceto os SDKs para Android e iOS) são compatíveis com todas as ações definidas na Amazon OpenSearch Service API Reference (Referência da API do Amazon OpenSearch Service), incluindo as operações AddTags, ListTags e RemoveTags. Para obter mais informações sobre instalação e uso dos AWS SDKs, consulte Kits de desenvolvimento de software da AWS.

Python

Este exemplo usa o cliente Python de baixo nível OpenSearchService do AWS SDK para Python (Boto) para adicionar uma etiqueta a um domínio, listar a etiqueta anexada ao domínio e remover uma etiqueta do domínio. É necessário fornecer valores para DOMAIN_ARN, TAG_KEY e TAG_VALUE.

import boto3
from botocore.config import Config  # import configuration

DOMAIN_ARN = ''  # ARN for the domain. i.e "arn:aws:es:us-east-1:123456789012:domain/my-domain
TAG_KEY = ''  # The name of the tag key. i.e 'Smileyface'
TAG_VALUE = ''  # The value assigned to the tag. i.e 'Practicetag'

# defines the configurations parameters such as region

my_config = Config(region_name='us-east-1')
client = boto3.client('opensearch', config=my_config)


# defines the client variable

def addTags():
    """Adds tags to the domain"""

    response = client.add_tags(ARN=DOMAIN_ARN,
                               TagList=[{'Key': TAG_KEY,
                                         'Value': TAG_VALUE}])

    print(response)


def listTags():
    """List tags that have been added to the domain"""

    response = client.list_tags(ARN=DOMAIN_ARN)
    print(response)


def removeTags():
    """Remove tags that have been added to the domain"""

    response = client.remove_tags(ARN=DOMAIN_ARN, TagKeys=[TAG_KEY])

    print('Tag removed')
    return response