Permissões obrigatórias Criação de coleções Acessando OpenSearch painéis Exibição das coleções Exclusão de coleções

Criação, listagem e exclusão de coleções Amazon OpenSearch Serverless

Uma coleção no Amazon OpenSearch Serverless é um agrupamento lógico de um ou mais índices que representam uma carga de trabalho de análise. OpenSearch O serviço gerencia e ajusta automaticamente a coleção, exigindo o mínimo de entrada manual.

Permissões obrigatórias

OpenSearch O Serverless usa as seguintes permissões AWS Identity and Access Management (IAM) para criar e gerenciar coleções. É possível especificar as condições do IAM para restringir os usuários a coleções específicas.

aoss:CreateCollection: cria uma coleção.
aoss:ListCollections: lista coleções na conta atual.
aoss:BatchGetCollection: obtém detalhes sobre uma ou mais coleções.
aoss:UpdateCollection: modifica uma coleção.
aoss:DeleteCollection: exclui uma coleção.

O exemplo de política de acesso baseada em identidade a seguir fornece as permissões mínimas necessárias para que um usuário gerencie uma única coleção de nome Logs:


[
   {
      "Sid":"Allows managing logs collections",
      "Effect":"Allow",
      "Action":[
         "aoss:CreateCollection",
         "aoss:ListCollections",
         "aoss:BatchGetCollection",
         "aoss:UpdateCollection",
         "aoss:DeleteCollection",
         "aoss:CreateAccessPolicy",
         "aoss:CreateSecurityPolicy"
      ],
      "Resource":"*",
      "Condition":{
         "StringEquals":{
            "aoss:collection":"Logs"
         }
      }
   }
]

aoss:CreateAccessPolicy e aoss:CreateSecurityPolicy estão incluídos porque as políticas de criptografia, de rede e de acesso a dados são necessárias para que uma coleção funcione adequadamente. Para ter mais informações, consulte Gerenciamento de identidade e acesso no Amazon OpenSearch Sem Servidor.

nota

Se você estiver criando a primeira coleção em sua conta, também precisará da permissão iam:CreateServiceLinkedRole. Para ter mais informações, consulte Usando funções vinculadas a serviços para criar OpenSearch coleções sem servidor.

Criação de coleções

Você pode usar o console ou o AWS CLI para criar uma coleção sem servidor. Essas etapas abordam como criar uma pesquisa ou uma coleção de séries temporais. Para criar uma coleção de pesquisa vetorial, consulteTrabalho com coleções de pesquisa vetorial.

Criação de uma coleção (console)

Para criar uma coleção usando o console

Navegue até o console do Amazon OpenSearch Service em https://console.aws.amazon.com/aos/home/.
Expanda Sem Servidor no painel de navegação à esquerda e escolha Coleções.
Escolha Criar coleção.
Forneça um nome e uma descrição para a coleção. O nome deve atender aos seguintes critérios:
- É exclusivo para sua conta e Região da AWS
- Iniciar com letra minúscula.
- Contém de 3 a 32 caracteres
- Contém apenas letras minúsculas a-z, números de 0 a 9 e hífens (-).
Escolha um tipo de coleção:
- Pesquisa: pesquisa de texto completo que alimenta aplicações em suas redes internas e aplicações voltadas para a Internet. Todos os dados de pesquisa são armazenados em um armazenamento de atividade muito alta para garantir tempos de resposta rápidos às consultas.
- Séries temporais: segmento de análise de logs que se concentra na análise de grandes volumes de dados semiestruturados gerados por máquina. Pelo menos 24 horas de dados são armazenadas em índices ativos, e o restante permanece no armazenamento ativo.
- Pesquisa vetorial: pesquisa semântica em incorporações vetoriais que simplifica o gerenciamento de dados vetoriais. Potencializa experiências de pesquisa aumentada de machine learning (ML) e aplicações de IA generativa, como chatbots, assistentes pessoais e detecção de fraudes.
Para ter mais informações, consulte Escolha de um tipo de coleção.
Em Tipo de implantação, escolha a configuração de redundância para sua coleção. Por padrão, cada coleção é criada com redundância, o que significa que as unidades de OpenSearch computação (OCUs) de indexação e pesquisa têm suas próprias réplicas em espera em uma zona de disponibilidade diferente. Para fins de desenvolvimento e teste, você pode optar por desativar a redundância, o que reduz o número de OCUs em sua coleção para duas. Para ter mais informações, consulte Como funciona.
Em Criptografia, escolha uma AWS KMS chave com a qual criptografar seus dados. OpenSearch O Serverless notifica você se o nome da coleção que você inseriu corresponder a um padrão definido em uma política de criptografia. É possível optar por manter essa correspondência ou substituí-la por configurações de criptografia exclusivas. Para ter mais informações, consulte Criptografia no Amazon OpenSearch Serverless.
Em Configurações de acesso à rede, configure o acesso à rede para a coleção.
- Em Tipo de acesso, selecione público ou privado. Em seguida, especifique quais endpoints de VPC Serviços da AWS podem acessar a coleção.
  - VPC endpoints para acesso — especifique um ou mais endpoints VPC para permitir o acesso. Para criar um VPC da endpoint, consulte Acesse o Amazon OpenSearch Serverless usando um endpoint de interface ()AWS PrivateLink.
  - AWS service (Serviço da AWS) acesso privado — Selecione um ou mais serviços compatíveis aos quais permitir o acesso.
- Em Tipo de recurso, selecione se a coleção será acessível por meio de seu OpenSearchendpoint (para fazer chamadas de API por meio de curl, Postman e assim por diante), por meio do endpoint OpenSearch Dashboards (para trabalhar com visualizações e fazer chamadas de API por meio do console) ou por meio de ambos.
  
  nota
  AWS service (Serviço da AWS) o acesso privado se aplica somente ao OpenSearch endpoint, não ao endpoint do OpenSearch Dashboards.
OpenSearch O Serverless notifica você se o nome da coleção inserido corresponder a um padrão definido em uma política de rede. É possível optar por manter essa correspondência ou substituí-la por configurações de rede personalizadas. Para ter mais informações, consulte Acesso à rede para Amazon OpenSearch Serverless.
(Opcional) Adicione uma ou mais tags à coleção. Para ter mais informações, consulte Aplicação de tags nas coleções do Amazon OpenSearch Sem Servidor.
Escolha Próximo.
Configure regras de acesso aos dados para a coleção, que definem quem pode acessar os dados dentro da coleção. Para cada regra que você criar, execute as seguintes etapas:
- Escolha Adicionar entidades principais e selecione um ou mais perfis do IAM, ou usuários e grupos de SAML aos quais fornecer acesso aos dados.
- Em Conceder permissões, selecione o alias, o modelo e as permissões de índice para conceder aos principais associados. Para obter uma lista completa de permissões e o acesso que elas permitem, consulte Operações e permissões de OpenSearch API suportadas.
OpenSearch O Serverless notifica você se o nome da coleção inserido corresponder a um padrão definido em uma política de acesso a dados. É possível optar por manter essa correspondência ou substituí-la por configurações de acesso a dados exclusivas. Para ter mais informações, consulte Controle de acesso a dados para Amazon OpenSearch Serverless.
Escolha Próximo.
Em Configurações da política de acesso a dados, escolha o que fazer com as regras que você acabou de criar. É possível usá-las para criar uma nova política de acesso a dados ou adicioná-los a uma política existente.
Reveja sua configuração da coleção e escolha Enviar.

O status da coleção muda para Creating quando o OpenSearch Serverless cria a coleção.

Criação de uma coleção (CLI)

Antes de criar uma coleção usando o AWS CLI, você deve ter uma política de criptografia com um padrão de recurso que corresponda ao nome pretendido da coleção. Por exemplo, se você planeja nomear sua coleção como logs-application, é possível criar uma política de criptografia como esta:


aws opensearchserverless create-security-policy \
  --name logs-policy \
  --type encryption --policy "{\"Rules\":[{\"ResourceType\":\"collection\",\"Resource\":[\"collection\/logs-application\"]}],\"AWSOwnedKey\":true}"

Se você planeja usar a política para cobranças adicionais, é possível tornar a regra mais ampla, como collection/logs* ou collection/*.

Você também precisa definir as configurações de rede para a coleção na forma de uma política de rede. Usando o exemplo anterior de logs-application, é possível criar a seguinte política de rede:


aws opensearchserverless create-security-policy \
  --name logs-policy \
  --type network --policy "[{\"Description\":\"Public access for logs collection\",\"Rules\":[{\"ResourceType\":\"dashboard\",\"Resource\":[\"collection\/logs-application\"]},{\"ResourceType\":\"collection\",\"Resource\":[\"collection\/logs-application\"]}],\"AllowFromPublic\":true}]"

nota

É possível criar políticas de rede depois de criar uma coleção, mas recomendamos fazer isso previamente.

Para criar uma coleção, envie uma CreateCollectionsolicitação:


aws opensearchserverless create-collection --name "logs-application" --type SEARCH --description "A collection for storing log data"

Para o type, especifique SEARCH ou TIMESERIES. Para ter mais informações, consulte Escolha de um tipo de coleção.

Exemplo de resposta


{
    "createCollectionDetail": {
        "id": "07tjusf2h91cunochc",
        "name": "books",
        "description":"A collection for storing log data",
        "status": "CREATING",
        "type": "SEARCH",
        "kmsKeyArn": "auto",
        "arn": "arn:aws:aoss:us-east-1:123456789012:collection/07tjusf2h91cunochc",
        "createdDate": 1665952577473
    }
}

Se você não especificar um tipo de coleção na solicitação, ela assumirá o padrão TIMESERIES. Se sua coleção estiver criptografada com uma Chave pertencente à AWS, o kmsKeyArn será auto em vez de um ARN.

Importante

Depois de criar uma coleção, você não poderá acessá-la, a menos que ela corresponda a uma política de acesso a dados. Para obter instruções sobre como criar políticas de acesso a dados, consulte Controle de acesso a dados para Amazon OpenSearch Serverless.

Acessando OpenSearch painéis

Depois de criar uma coleção com o AWS Management Console, você pode navegar até a URL dos OpenSearch painéis da coleção. Você pode encontrar o URL dos Painéis escolhendo Coleções no painel de navegação esquerdo e selecionando a coleção para abrir a página de detalhes. O URL assume o formato https://dashboards.us-east-1.aoss.amazonaws.com/_login/?collectionId=07tjusf2h91cunochc. Depois de navegar até o URL, você fará login no Dashboards automaticamente.

Se você já tiver o URL dos OpenSearch painéis disponível, mas não estiver no AWS Management Console, chamar o URL dos painéis pelo navegador será redirecionado para o console. Depois de inserir suas AWS credenciais, você fará login automaticamente nos painéis. Para obter informações sobre como acessar coleções para SAML, consulte Acessando OpenSearch painéis com SAML.

O tempo limite do console do OpenSearch Dashboards é de uma hora e não é configurável.

nota

Em 10 de maio de 2023, OpenSearch introduziu um endpoint global comum para OpenSearch painéis. Agora você pode navegar até OpenSearch Painéis no navegador com uma URL que assume o formatohttps://dashboards.us-east-1.aoss.amazonaws.com/_login/?collectionId=07tjusf2h91cunochc. Para garantir a compatibilidade com versões anteriores, continuaremos oferecendo suporte aos endpoints de OpenSearch painéis específicos da coleção existente com o formato. https://07tjusf2h91cunochc.us-east-1.aoss.amazonaws.com/_dashboards

Exibição das coleções

Você pode visualizar as coleções existentes Conta da AWS na sua guia Coleções do console do Amazon OpenSearch Service.

Para listar coleções junto com suas IDs, envie uma ListCollectionssolicitação.


aws opensearchserverless list-collections

Exemplo de resposta


{
   "collectionSummaries":[
      {
         "arn":"arn:aws:aoss:us-east-1:123456789012:collection/07tjusf2h91cunochc",
         "id":"07tjusf2h91cunochc",
         "name":"my-collection",
         "status":"CREATING"
      }
   ]
}

Para limitar os resultados da pesquisa, use filtros de coleções. Esta solicitação filtra a resposta para coleções no estado ACTIVE:


aws opensearchserverless list-collections --collection-filters '{ "status": "ACTIVE" }'

Para obter informações mais detalhadas sobre uma ou mais coleções, incluindo o OpenSearch endpoint e o endpoint do OpenSearch Dashboards, envie uma solicitação: BatchGetCollection


aws opensearchserverless batch-get-collection --ids ["07tjusf2h91cunochc", "1iu5usc4rame"]

nota

É possível incluir --names ou --ids na solicitação, mas não os dois.

Exemplo de resposta


{
   "collectionDetails":[
      {
         "id": "07tjusf2h91cunochc",
         "name": "my-collection",
         "status": "ACTIVE",
         "type": "SEARCH",
         "description": "",
         "arn": "arn:aws:aoss:us-east-1:123456789012:collection/07tjusf2h91cunochc",
         "kmsKeyArn": "arn:aws:kms:us-east-1:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab",
         "createdDate": 1667446262828,
         "lastModifiedDate": 1667446300769,
         "collectionEndpoint": "https://07tjusf2h91cunochc.us-east-1.aoss.amazonaws.com",
         "dashboardEndpoint": "https://07tjusf2h91cunochc.us-east-1.aoss.amazonaws.com/_dashboards"
      },
      {
         "id": "178ukvtg3i82dvopdid",
         "name": "another-collection",
         "status": "ACTIVE",
         "type": "TIMESERIES",
         "description": "",
         "arn": "arn:aws:aoss:us-east-1:123456789012:collection/178ukvtg3i82dvopdid",
         "kmsKeyArn": "arn:aws:kms:us-east-1:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab",
         "createdDate": 1667446262828,
         "lastModifiedDate": 1667446300769,
         "collectionEndpoint": "https://178ukvtg3i82dvopdid.us-east-1.aoss.amazonaws.com",
         "dashboardEndpoint": "https://178ukvtg3i82dvopdid.us-east-1.aoss.amazonaws.com/_dashboards"
      }
   ],
   "collectionErrorDetails":[]
}

Exclusão de coleções

A exclusão de uma coleção exclui todos os dados e índices da coleção. Você não poderá recuperar coleções depois de excluí-las.

Para excluir uma coleção usando o console

No painel Coleções do console do Amazon OpenSearch Service, selecione a coleção que você deseja excluir.
Escolha Excluir e confirme a exclusão.

Para excluir uma coleção usando o AWS CLI, envie uma DeleteCollectionsolicitação:


aws opensearchserverless delete-collection --id 07tjusf2h91cunochc

Exemplo de resposta


{
   "deleteCollectionDetail":{
      "id":"07tjusf2h91cunochc",
      "name":"my-collection",
      "status":"DELETING"
   }
}

Atenção O Javascript está desativado ou não está disponível no seu navegador.

Para usar a documentação da AWS, o Javascript deve estar ativado. Consulte as páginas de Ajuda do navegador para obter instruções.

Convenções do documento

Criação e gerenciamento de coleções

Trabalho com coleções de pesquisa vetorial