Configurer l'objet IDs - AWS IoT SiteWise

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Configurer l'objet IDs

AWS IoT SiteWise définit différents types d'objets persistants, tels que les actifs, les modèles d'actifs, les propriétés et les hiérarchies. Tous ces objets possèdent des identifiants uniques que vous pouvez utiliser pour les récupérer, les mettre à jour et les supprimer.

AWS IoT SiteWise propose différentes options aux clients pour la création d'un identifiant. AWS IoT SiteWise en génère un pour vous par défaut au moment de la création de l'objet. Les utilisateurs peuvent également ajouter les leurs IDs à vos objets.

Travailler avec un objet UUIDs

Chaque objet persistant AWS IoT SiteWise possède UUIDun identifiant. Par exemple, les modèles d'actifs ont un ID de modèle d'actif, les actifs ont un ID d'actif, etc. Cet identifiant est attribué au moment de la création de l'objet et reste inchangé pendant toute la durée de vie de l'objet.

Lorsque vous créez un nouvel objet, il AWS IoT SiteWise génère un identifiant unique pour vous par défaut. Vous pouvez également fournir votre propre identifiant au moment de la création sous UUID format.

Note

UUIDsdoit être globalement unique dans la AWS région où il a été créé, et pour le même type d'objet. Lorsque vous AWS IoT SiteWise générez automatiquement un identifiant, celui-ci est toujours unique. Si vous choisissez votre propre identifiant, assurez-vous qu'il est unique.

Par exemple, si vous créez un nouveau modèle d'actif en appelant CreateAssetModel, vous pouvez fournir le vôtre UUID dans le assetModelId champ facultatif de la demande.

En revanche, si vous omettez assetModelId de le faire dans la demande, AWS IoT SiteWise génère un UUID pour le nouveau modèle d'actif.

Utiliser un usage externe IDs

Pour définir votre propre identifiant dans un format autre queUUID, vous pouvez attribuer un identifiant externe. Par exemple, vous pouvez le faire si vous réutilisez un identifiant que vous utilisez dans un système qui ne l'est pas AWS, ou pour qu'il soit plus lisible par l'homme. Les formats externes IDs ont un format plus flexible. Vous pouvez les utiliser pour référencer vos objets dans le AWS IoT SiteWise API cadre d'opérations où vous utiliseriez autrement leUUID.

Comme leUUIDs, chaque identifiant externe doit être unique dans son contexte. Par exemple, vous ne pouvez pas avoir deux modèles d'actifs avec le même ID externe. De plus, comme leUUIDs, un objet ne peut avoir qu'un seul identifiant externe au cours de sa durée de vie, qui ne peut pas changer.

Différences entre externe IDs et UUIDs

IDsLes différences externes sont les suivantes : UUIDs

  • Chaque objet possède unUUID, mais les éléments externes IDs sont facultatifs.

  • AWS IoT SiteWise ne génère jamais de données externesIDs. Vous les fournissez vous-même.

  • Si l'objet n'en possède pas déjà un, vous pouvez attribuer un identifiant externe à tout moment.

Format externe IDs

Un identifiant externe valide possède les propriétés suivantes :

  • Comporte entre 2 et 128 caractères.

  • Les premier et dernier caractères doivent être alphanumériques (A-Z, a-z, 0-9).

  • Les caractères autres que le premier et le dernier doivent être alphanumériques ou être l'un des suivants : _-.:

Par exemple, un identifiant externe doit être conforme à l'expression régulière suivante :

[a-zA-Z0-9][a-zA-Z0-9_\-.:]*[a-zA-Z0-9]+

Objets de référence avec interface externe IDs

Dans de nombreux endroits où vous pouvez référencer un objet à l'aide de son identifiant externeUUID, vous pouvez utiliser son identifiant externe à la place, s'il en possède un. Pour ce faire, ajoutez l'ID externe à la chaîneexternalId:.

Supposons, par exemple, que vous disposiez d'un modèle d'actif dont UUID (ID de modèle d'actif) esta1b2c3d4-5678-90ab-cdef-11111EXAMPLE, qui possède également l'ID externemyExternalId. Appelez DescribeAssetModelpour obtenir des détails à ce sujet. Vous pouvez utiliser l'une des valeurs suivantes comme valeur de assetModelId :

  • Avec l'identifiant du modèle d'actif (UUID) lui-même : a1b2c3d4-5678-90ab-cdef-11111EXAMPLE

  • Avec l'ID externe : externalId:myExternalId

aws iotsitewise describe-asset-model --asset-model-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE aws iotsitewise describe-asset-model --asset-model-id externalId:myExternalId
Note

Le externalId: préfixe ne fait pas lui-même partie de l'identifiant externe. Vous ne devez fournir le préfixe que lorsque vous fournissez un identifiant externe à une API opération qui accepte l'un UUIDs ou l'autre élément externeIDs. Par exemple, fournissez le préfixe lorsque vous interrogez ou mettez à jour un objet existant.

Lorsque vous définissez un ID externe pour un objet, par exemple lorsque vous créez un modèle de ressource, n'incluez pas le préfixe.

Vous pouvez utiliser l'externe IDs UUIDs à la place de cette manière pour de nombreuses API opérations AWS IoT SiteWise, mais pas toutes. Par exemple, le GetAssetPropertyValue, doit être utilisé UUIDs ; il ne prend pas en charge l'utilisation d'identifiants externes.

Pour déterminer si une API opération particulière prend en charge cette utilisation, consultez la APIréférence.