Autorisations nécessaires Créer des collections Accès aux OpenSearch tableaux de bord Afficher les collections Supprimer des collections

Création, mise en vente et suppression de collections Amazon OpenSearch Serverless

Dans Amazon OpenSearch Serverless, une collection est un regroupement logique d'un ou de plusieurs index représentant une charge de travail d'analyse. OpenSearch Le service gère et ajuste automatiquement la collection, nécessitant un minimum de saisie manuelle.

Autorisations nécessaires

OpenSearch Serverless utilise les autorisations AWS Identity and Access Management (IAM) suivantes pour créer et gérer des collections. Vous pouvez spécifier des conditions IAM pour restreindre les utilisateurs à des collections spécifiques.

aoss:CreateCollection : créer une collection.
aoss:ListCollections : répertorier les collections du compte actuel.
aoss:BatchGetCollection : obtenir des informations sur une ou plusieurs collections.
aoss:UpdateCollection : modifier une collection.
aoss:DeleteCollection : supprimer une collection.

L'exemple suivant de stratégie d'accès basée sur l'identité fournit les autorisations minimales nécessaires à un utilisateur pour gérer une collection unique nommée 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 et aoss:CreateSecurityPolicy sont incluses, car des stratégies de chiffrement, de réseau et d'accès aux données sont nécessaires au bon fonctionnement d'une collection. Pour plus d’informations, consultez Identity and Access Management pour Amazon OpenSearch Serverless.

Note

Si vous créez la première collection de votre compte, vous devez également disposer de l'autorisation iam:CreateServiceLinkedRole. Pour plus d’informations, consultez Utilisation de rôles liés à un service pour créer OpenSearch des collections sans serveur.

Créer des collections

Vous pouvez utiliser la console ou le AWS CLI pour créer une collection sans serveur. Ces étapes expliquent comment créer une recherche ou une collection de séries chronologiques. Pour créer une collection de recherche vectorielle, voirUtilisation de collections de recherche vectorielle.

Créer une collection (console)

Créer une collection à l'aide de la console

Accédez à la console Amazon OpenSearch Service à l'adresse https://console.aws.amazon.com/aos/home/.
Développez Serverless (Sans serveur) dans le panneau de navigation de gauche et choisissez Collections.
Choisissez Create collection (Créer une collection).
Saisissez un nom et une description pour la collection. Le nom doit répondre aux critères suivants :
- est propre à votre compte et Région AWS
- Commence par une lettre minuscule
- Contient entre 3 et 32 caractères
- Contient uniquement les lettres minuscules a-z, les chiffres 0-9 et le trait d'union (-)
Choisissez un type de collection :
- Recherche : recherche en texte intégral qui alimente les applications de vos réseaux internes et les applications disponibles sur Internet. Toutes les données de recherche sont stockées dans le stockage à chaud afin de garantir des temps de réponse rapides aux requêtes.
- Séries temporelles : segment d'analyse des journaux qui se concentre sur des gros volumes de données semi-structurées et générées par des machines. Au moins 24 heures de données sont stockées sur des index chauds, le reste étant stocké à chaud.
- Recherche vectorielle : recherche sémantique sur les intégrations vectorielles qui simplifie la gestion des données vectorielles. Favorise les expériences de recherche augmentées par le machine learning (ML) et les applications d'IA génératives telles que les chatbots, les assistants personnels et la détection des fraudes.
Pour plus d’informations, consultez Choix d'un type de collection.
Sous Type de déploiement, choisissez le paramètre de redondance pour votre collection. Par défaut, chaque collection est créée de manière redondante, ce qui signifie que les unités de OpenSearch calcul d'indexation et de recherche (OCU) disposent chacune de leurs propres répliques de secours dans une zone de disponibilité différente. À des fins de développement et de test, vous pouvez choisir de désactiver la redondance, ce qui réduit à deux le nombre d'OCU de votre collection. Pour plus d’informations, consultez Comment ça marche.
Sous Chiffrement, choisissez une AWS KMS clé pour chiffrer vos données. OpenSearch Serverless vous avertit si le nom de collection que vous avez saisi correspond à un modèle défini dans une politique de chiffrement. Vous pouvez choisir de conserver cette correspondance ou de la remplacer par des paramètres de chiffrement uniques. Pour plus d’informations, consultez Chiffrement dans Amazon OpenSearch Serverless.
Sous Network access settings (Paramètres d'accès au réseau), configurez l'accès au réseau pour la collection.
- Pour le type d'accès, sélectionnez public ou privé. Spécifiez ensuite les points de terminaison VPC autorisés à Services AWS accéder à la collection.
  - Points de terminaison VPC pour l'accès : spécifiez un ou plusieurs points de terminaison VPC pour autoriser l'accès. Pour créer un point de terminaison d'un VPC, veuillez consulter la rubrique Accédez à Amazon OpenSearch Serverless à l'aide d'un point de terminaison d'interface ()AWS PrivateLink.
  - Service AWS accès privé : sélectionnez un ou plusieurs services pris en charge auxquels vous souhaitez autoriser l'accès.
- Pour le type de ressource, indiquez si la collection sera accessible via son OpenSearchpoint de terminaison (pour effectuer des appels d'API via curl, Postman, etc.), via le point de terminaison OpenSearch Dashboards (pour travailler avec des visualisations et effectuer des appels d'API via la console), ou via les deux.
  
  Note
  Service AWS l'accès privé s'applique uniquement au OpenSearch point de terminaison, pas au point de terminaison OpenSearch des tableaux de bord.
OpenSearch Serverless vous avertit si le nom de collection que vous avez saisi correspond à un modèle défini dans une politique réseau. Vous pouvez choisir de conserver cette correspondance ou de la remplacer par des paramètres réseau personnalisés. Pour plus d’informations, consultez Accès au réseau pour Amazon OpenSearch Serverless.
(Facultatif) Ajoutez une ou plusieurs balises à la collection. Pour plus d’informations, consultez Baliser des collections Amazon OpenSearch sans serveur.
Choisissez Suivant.
Configurez les règles d'accès aux données pour la collection, qui définissent qui peut accéder aux données de la collection. Pour chaque règle que vous créez, effectuez les opérations suivantes :
- Choisissez Add principals (Ajouter des principaux) et sélectionnez un ou plusieurs rôles IAM ou utilisateurs et groupes SAML pour accorder l'accès aux données.
- Sous Grant permissions (Accorder des autorisations), sélectionnez les autorisations d'alias, de modèle et d'index à accorder aux principaux associés. Pour obtenir la liste complète des autorisations et des accès qu'elles octroient, veuillez consulter la rubrique Opérations et autorisations d' OpenSearch API prises en charge.
OpenSearch Serverless vous avertit si le nom de collection que vous avez saisi correspond à un modèle défini dans une politique d'accès aux données. Vous pouvez choisir de conserver cette correspondance ou de la remplacer par des paramètres d'accès aux données uniques. Pour plus d’informations, consultez Contrôle d'accès aux données pour Amazon OpenSearch Serverless.
Choisissez Suivant.
Sous Data access policy settings (Paramètres de la stratégie d'accès aux données), choisissez ce que vous voulez faire avec les règles que vous venez de créer. Vous pouvez soit les utiliser pour créer une nouvelle stratégie d'accès aux données, soit les ajouter à une stratégie existante.
Vérifiez la configuration de votre collection et choisissez Submit (Soumettre).

Le statut de la collection passe au Creating fur et à mesure que OpenSearch Serverless crée la collection.

Créer une collection (CLI)

Avant de créer une collection à l'aide de AWS CLI, vous devez disposer d'une politique de chiffrement avec un modèle de ressource correspondant au nom prévu de la collection. Par exemple, si vous envisagez de nommer votre collection logs-application, vous pouvez créer une stratégie de chiffrement comme suit :


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

Si vous envisagez d'utiliser la stratégie pour des collections supplémentaires, vous pouvez élargir la règle, par exemple collection/logs* ou collection/*.

Vous devez également configurer les paramètres réseau pour la collection sous la forme d'une stratégie réseau. À l'aide de l'exemple logs-application précédent, vous pouvez créer la stratégie réseau suivante :


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}]"

Note

Vous pouvez créer des stratégies réseau après avoir créé une collection, mais nous vous recommandons de le faire au préalable.

Pour créer une collection, envoyez une CreateCollectiondemande :


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

Pour type, spécifiez SEARCH ou TIMESERIES. Pour plus d’informations, consultez Choix d'un type de collection.

Exemple de réponse


{
    "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
    }
}

Si vous ne spécifiez pas de type de collection dans la demande, il est défini par défaut à TIMESERIES. Si votre collection est chiffrée avec une Clé détenue par AWS, l'kmsKeyArn est auto plutôt qu'un ARN.

Important

Une fois la collection créée, vous ne pourrez y accéder que si elle correspond à une stratégie d'accès aux données. Pour obtenir des instructions sur la création de stratégies d'accès aux données, veuillez consulter la rubrique Contrôle d'accès aux données pour Amazon OpenSearch Serverless.

Accès aux OpenSearch tableaux de bord

Après avoir créé une collection avec le AWS Management Console, vous pouvez accéder à l'URL des OpenSearch tableaux de bord de la collection. Vous pouvez trouver l'URL des tableaux de bord en choisissant Collections dans le volet de navigation de gauche et en sélectionnant la collection pour ouvrir sa page de détails. L'URL est au format https://dashboards.us-east-1.aoss.amazonaws.com/_login/?collectionId=07tjusf2h91cunochc. Une fois que vous avez accédé à l'URL, vous vous connectez automatiquement aux tableaux de bord.

Si l'URL des OpenSearch tableaux de bord est déjà disponible mais que vous n'y êtes pas AWS Management Console, l'appel de l'URL des tableaux de bord depuis le navigateur sera redirigé vers la console. Une fois que vous aurez saisi vos AWS informations d'identification, vous connecterez automatiquement aux tableaux de bord. Pour plus d'informations sur l'accès aux collections pour le protocole SAML, consultez la section Accès aux OpenSearch tableaux de bord avec le protocole SAML.

Le délai d'expiration OpenSearch de la console Dashboards est d'une heure et n'est pas configurable.

Note

Le 10 mai 2023, OpenSearch a introduit un point de terminaison mondial commun pour les OpenSearch tableaux de bord. Vous pouvez désormais accéder aux OpenSearch tableaux de bord dans le navigateur à l'aide d'une URL au format https://dashboards.us-east-1.aoss.amazonaws.com/_login/?collectionId=07tjusf2h91cunochc approprié. Pour garantir la rétrocompatibilité, nous continuerons à prendre en charge les points de terminaison des OpenSearch tableaux de bord spécifiques à la collection existante avec ce format. https://07tjusf2h91cunochc.us-east-1.aoss.amazonaws.com/_dashboards

Afficher les collections

Vous pouvez consulter les collections existantes dans l' Compte AWS onglet Collections de la console Amazon OpenSearch Service.

Pour répertorier les collections avec leurs identifiants, envoyez une ListCollectionsdemande.


aws opensearchserverless list-collections

Exemple de réponse


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

Pour limiter les résultats de recherche, utilisez des filtres de collection. Cette requête filtre la réponse aux collections à l'état ACTIVE :


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

Pour obtenir des informations plus détaillées sur une ou plusieurs collections, y compris le OpenSearch point de terminaison et le point de terminaison OpenSearch Dashboards, envoyez une BatchGetCollectiondemande :


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

Note

Vous pouvez inclure --names ou --ids dans la requête, mais pas les deux.

Exemple de réponse


{
   "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":[]
}

Supprimer des collections

La suppression d'une collection entraîne la suppression de toutes ses données et de tous ses index. Vous ne pouvez pas récupérer les collections après les avoir supprimées.

Supprimer une collection à l'aide de la console

Dans le panneau Collections de la console Amazon OpenSearch Service, sélectionnez la collection que vous souhaitez supprimer.
Choisissez Delete (Supprimer) et confirmez la suppression.

Pour supprimer une collection à l'aide du AWS CLI, envoyez une DeleteCollectiondemande :


aws opensearchserverless delete-collection --id 07tjusf2h91cunochc

Exemple de réponse


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

Avertissement JavaScript est désactivé ou n'est pas disponible dans votre navigateur.

Pour que vous puissiez utiliser la documentation AWS, Javascript doit être activé. Vous trouverez des instructions sur les pages d'aide de votre navigateur.

Conventions de rédaction

Créer et gérer les collections

Utilisation de collections de recherche vectorielle