Referência da sintaxe de consulta de pesquisa do Explorador de Recursos - Explorador de recursos da AWS
Como as consultas funcionam no Explorador de RecursosSintaxe da string de consulta

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

Referência da sintaxe de consulta de pesquisa do Explorador de Recursos

Explorador de recursos da AWS ajuda você a encontrar AWS recursos individuais em seu Contas da AWS. Para ajudar você a encontrar os recursos exatos que está procurando, o Explorador de Recursos aceita strings de consulta de pesquisa que sigam a sintaxe descrita neste tópico. Para obter exemplos de consultas que demonstram como usar os recursos descritos aqui, consulte Exemplo de consultas de pesquisa do Explorador de Recursos.

nota

No momento, as tags anexadas aos recursos AWS Identity and Access Management (IAM), como funções ou usuários, não são indexadas.

Como as consultas funcionam no Explorador de Recursos

As consultas de pesquisa sempre usam uma visualização. Se você não especificar explicitamente uma, o Resource Explorer usará a visualização designada como padrão para Região da AWS aquela em que você está trabalhando.

As visualizações determinam quais recursos estão disponíveis para você consultar. Você pode criar diferentes visualizações, cada uma retornando um conjunto diferente de recursos.

Por exemplo, você pode criar uma visualização que inclua somente os recursos marcados com a chave Environment e o valor Production. Depois, você pode escolher só conceder acesso a essa visualização aos usuários que têm um motivo comercial para visualizar esses recursos. Uma visualização separada que inclua os recursos do ambiente Alpha ou Beta pode ser acessada por diferentes usuários que precisam visualizar esses recursos. Para obter mais informações sobre como controlar quem tem acesso a qual visualização, consulte Conceder acesso às visualizações do Explorador de Recursos para pesquisa.

Sintaxe da string de consulta

Esta seção fornece informações sobre aspectos básicos da sintaxe de consulta, dos filtros e dos operadores de filtro.

Conceitos básicos

Basicamente, uma QueryString é um conjunto de palavras-chave de texto em formato livre que são unidas implicitamente por um operador lógico OR. Separe as palavras-chaves umas das outras com um espaço, como mostrado no seguinte exemplo:

ec2 billing test gamma

O Explorador de Recursos avalia que essa lista de palavras-chave significa:

ec2 OR billing OR test OR gamma

O Explorador de Recursos classifica os resultados por relevância, dando maior preferência aos recursos que correspondem a um número maior de termos de pesquisa. Os recursos que não correspondem a um ou mais termos não são excluídos dos resultados. Porém, o Explorador de Recursos os considera de menor relevância e os empurra ainda mais para baixo nos resultados de pesquisa.

Se você especificar uma string vazia para o parâmetro QueryString, sua consulta retornará os primeiros 1.000 recursos disponíveis por meio da visualização usada para a operação. O número máximo de recursos que podem ser retornados por qualquer consulta é 1.000.

nota

AWS reserva-se o direito de atualizar a lógica de correspondência e os algoritmos de relevância para avaliar palavras-chave de texto de formato livre para que possamos fornecer aos clientes os resultados mais relevantes. Portanto, os resultados retornados para as mesmas consultas usando palavras-chave de texto em formato livre podem mudar com o tempo. Quando você precisar de resultados mais determinísticos, recomendamos que use filtros. A lógica de correspondência dos filtros não muda com o tempo.

Filtros

Você pode limitar os resultados da sua consulta de modo mais rígido incluindo filtros. Diferentemente das palavras-chave de texto, os filtros são avaliados na consulta com o ANDoperador. Por exemplo, considere a consulta a seguir, que consiste em duas palavras-chave em formato livre e dois filtros:

test instance service:EC2 region:us-west-2

Essa consulta é avaliada da seguinte maneira:

( test OR instance ) AND service:EC2 AND region:us-west-2

Os filtros são sempre avaliados usando operadores ANDlógicos. Se um recurso não corresponder ao filtro, ele não será incluído nos resultados. Os resultados da consulta de exemplo incluem todos os recursos que estão associados à Amazon EC2 e estão no Oeste dos EUA (Oregon) Região da AWS e têm pelo menos uma das palavras-chave anexadas de alguma forma.

nota

Por causa do AND implícito, você só pode usar com sucesso um único filtro para um atributo que só pode ter um valor associado ao recurso. Por exemplo, um recurso não pode fazer parte de mais de uma Região da AWS. Portanto, a consulta a seguir não retorna nenhum resultado.

region:us-east-1 region:us-west-1

Essa limitação não se aplica aos filtros de atributos que podem ter vários valores ao mesmo tempo, como tag:, tag.key: e tag.value:.

A tabela a seguir lista os nomes de filtros disponíveis que podem ser usados em uma consulta de pesquisa do Explorador de Recursos.

Nome do filtro Descrição e exemplo

accountid:

O Conta da AWS proprietário do recurso. O Explorador de Recursos só inclui nos resultados os recursos que pertencem à conta especificada.

accountid:123456789012

application:

Esse filtro permite que você pesquise recursos com uma chave de tag awsApplication e um valor de grupo de recursos. Você pode pesquisar pelo nome do aplicativo ou pelo grupo de recursos do aplicativoARN.

application:MyApplicationName

application:arn:aws:resource-groups:us-east-1:123456789012:group/MyApplicationName/123456789abced

arn:aws:resource-groups:us-east-1:123456789012:group/MyApplicationName/123456789abced

nota

Para usar esse filtro, a visualização deve ter acesso a marcação de dados.

id:

O identificador de um recurso individual, expresso como um nome de recurso da Amazon (ARN).

id:arn:aws:license-manager:us-east-1:123456789012:license-configuration:lic-ecbd5574fd92cb0d312baea26EXAMPLE

region:

O Região da AWS local onde o recurso está localizado. O Resource Explorer inclui nos resultados somente os recursos que residem no especificado Região da AWS.

region:us-east-1

nota

Digitar somente o código da região (sem um filtro, como us-east-1) não retorna os mesmos resultados que region:us-east-1. Esse resultado ocorre porque, como uma palavra-chave de texto em formato livre que não é um filtro, o código da região é dividido em suas partes individuais. Por exemplo, us-east-1 é pesquisado como us, east e 1. Essa divisão em componentes não ocorre quando você usa o prefixo region:.

region:global

Um caso especial para o region: filtro que você pode usar para encontrar recursos que não estão associados a um indivíduo Região da AWS , mas são considerados de escopo global.

region:global

nota

Digitar somente a palavra-chave global não retorna os mesmos resultados que region:global porque a palavra literal "global" não está anexada aos recursos globais. Digitar global como uma palavra-chave só retorna os recursos que têm essa string literal associada a eles.

resourcetype:

O tipo de recurso na notação de service:type. O Explorador de Recursos só inclui nos resultados os recursos do tipo especificado.

resourcetype:ec2:instance

resourcetype.supports:

Esse filtro permite que você pesquise recursos que suportam tags. tagsé o único valor suportado. O Resource Explorer inclui nos resultados somente os recursos que podem ser marcados.

resourcetype.supports:tags

service:

O AWS service (Serviço da AWS) que está associado ao tipo do recurso. O Explorador de Recursos só inclui nos resultados os recursos que são criados e gerenciados pelo serviço especificado.

service:ec2

tag:

Um par de chave/valor de tag expresso como <key>=<value>. O Explorador de Recursos só inclui nos resultados os recursos que têm uma tag com uma chave correspondente e o valor especificado.

tag:environment=production

tag:all

Um caso especial do tag: filtro que permite pesquisar recursos que tenham uma ou mais tags criadas pelo usuário anexadas, mesmo que o tipo de recurso não seja suportado no Resource Explorer.

nota

Recursos com tags criadas pelo serviço da AWS ainda aparecem nos resultados desse filtro.

tag:none

Um caso especial do filtro tag: que permite pesquisar qualquer recurso que não tenha nenhuma tag criada pelo usuário anexada.

nota

Recursos com tags criadas pelo serviço da AWS ainda aparecem nos resultados desse filtro.

tag.key:

Uma chave de tag. O Explorador de Recursos só inclui nos resultados os recursos que têm uma tag com uma chave correspondente, qualquer que seja o valor.

tag.key:environment

tag.value:

Um valor de tag. O Explorador de Recursos só inclui nos resultados os recursos que têm uma tag com um valor correspondente, qualquer que seja nome da chave.

tag.value:production

Operadores de filtro

Você pode modificar suas palavras-chave e filtros incluindo um dos operadores mostrados na tabela a seguir como parte da string.

Operador Descrição e exemplo

"multiple word phrase"

ou

"hyphenated-phrase"

Coloque entre aspas duplas (" ") uma frase composta de várias palavras que deve ser tratada como uma única palavra-chave. O Explorador de Recursos só inclui os recursos que correspondem à frase inteira, com todas as palavras juntas e na ordem especificada.

Se você não usar aspas duplas, o Explorador de Recursos usará espaços ou hífens para dividir a frase em seus componentes e incluirá os recursos que corresponderem aos componentes individuais, mesmo que não estejam juntos ou estejam em uma ordem diferente. As cotações devem estar em torno de tudo após o operador.

"This matches only resources with the whole sentence."

This matches resources with any of the words.

"us-east-1": faz a correspondência apenas com os recursos associados a essa região exata.

us-east-1: faz a correspondência com qualquer recurso que contenha "us", "east" ou "1".

-tag:"environment=production"

keyword*

Correspondência com caracteres curinga como prefixo. Você só pode colocar um caractere curinga (um asterisco *) no final da string. O Explorador de Recursos só inclui nos resultados os recursos com valores que começam com o texto do prefixo antes do *. O exemplo a seguir corresponde a tudo Regiões da AWS o que começa comus-east.

region:us-east*

Importante

A pesquisa unificada insere automaticamente um operador de caractere curinga (*) no final da primeira palavra-chave da string. Isso significa que os resultados da pesquisa unificada incluem os recursos que correspondem a qualquer string que comece com a palavra-chave especificada.

A pesquisa realizada pela caixa de texto Consulta na página Pesquisa de recursos no console do Explorador de Recursos não adiciona automaticamente um caractere curinga. Você pode inserir um * manualmente depois de qualquer termo na string de pesquisa.

-keyword

Operador Not. Você pode colocar um hífen (-) no início da palavra-chave ou do filtro para inverter os resultados da pesquisa. O Explorador de Recursos exclui dos resultados todos os recursos que correspondem à palavra-chave ou ao filtro que vem depois desse operador. O exemplo a seguir faz com que todos os recursos associados ao EC2 serviço da Amazon sejam excluídos dos resultados.

-service:ec2

Importante

Se você usar o AWS CLI search comando e o valor do --query-string parâmetro tiver o - operador como primeiro caractere, você deverá separar o nome do parâmetro de seu valor com um caractere de sinal de igual (=) em vez do caractere de espaço usual. Se você usar o caractere de espaço, ele CLI interpretará mal a string. Por exemplo, a consulta a seguir não funciona.

aws resource-explorer-2 search --query-string "-tag:none region:us-east-1"

A string de consulta corrigida a seguir, com um = substituindo o espaço, funciona como esperado.

aws resource-explorer-2 search --query-string="-tag:none region:us-east-1"

Se você alterar a ordem dos filtros na string de consulta para que - não seja o primeiro caractere no valor do parâmetro, poderá usar o caractere de espaço padrão. A string de consulta a seguir funciona.

aws resource-explorer-2 search --query-string "region:us-east-1 -tag:none"
\<special character>

Você pode ignorar os caracteres especiais que devem ser incluídos exatamente como mostrado, em vez de serem interpretados. Se o texto incluir um dos caracteres especiais ( * " - : = \), você deverá preceder esse caractere por uma barra invertida (\) para garantir que o caractere seja interpretado literalmente. O exemplo a seguir mostra como usar uma palavra-chave de texto de formato livre que inclui o caractere hífen (-) ("my-key-word").

Além disso, para evitar que o Explorador de Recursos divida a expressão em três palavras-chave separadas nos hífens, você pode colocar a frase inteira entre aspas duplas.

"my\-key\-word"

Para inserir uma barra invertida literal, insira dois caracteres de barra invertida em sequência. A primeira barra invertida é interpretada como escape e a segunda barra invertida é o caractere literal a ser inserido.

"some_text\\some_more_text"
nota

Se a visualização incluir as tags anexadas aos recursos, a operação Search não gerará erros de validação para as strings de pesquisa, pois um filtro que não é válido também pode ser interpretado como uma pesquisa de texto em formato livre. Por exemplo, embora cat:blue pareça um filtro, o Explorador de Recursos não pode analisá-lo como tal porque cat: não é um dos filtros definidos válidos. Em vez disso, o Resource Explorer interpreta a string inteira como uma string de pesquisa de formato livre para permitir que ela corresponda a coisas como um nome de chave de tag ou uma parte de uma. ARN

A operação gerará um erro de validação se uma das seguintes situações for verdadeira:

  • A visualização não inclui informações sobre tags

  • A consulta de pesquisa usa explicitamente um filtro de tag (tag.key:, tag.value: ou tag:)