Utilisation des identifiants d'objets

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 fournir leurs propres identifiants à vos objets.

Utilisation des UUID d'objets

Chaque objet persistant AWS IoT SiteWise possède un UUID pour l'identifier. 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 au format UUID.

Note

Les UUID doivent être globalement uniques dans la AWS région où ils ont été créés, 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 votre propre 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.

Utilisation d'identifiants externes

Pour définir votre propre identifiant dans un format autre que l'UUID, 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 identifiants externes ont un format plus flexible. Vous pouvez les utiliser pour référencer vos objets dans des opérations AWS IoT SiteWise d'API où vous utiliseriez autrement l'UUID.

Comme les UUID, 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 les UUID, 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 les identifiants externes et les UUID

Les identifiants externes diffèrent des UUID de la manière suivante :

• Chaque objet possède un UUID, mais les identifiants externes sont facultatifs.

• AWS IoT SiteWise ne génère jamais d'identifiants externes. 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 des identifiants externes

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]+

Référencement d'objets avec des identifiants externes

Dans de nombreux endroits où vous pouvez référencer un objet à l'aide de son UUID, 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 l'UUID (ID de modèle d'actif) esta1b2c3d4-5678-90ab-cdef-11111EXAMPLE, qui possède également l'ID externe. myExternalId Appelez DescribeAssetModel pour obtenir des informations à 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 devez uniquement fournir le préfixe lorsque vous fournissez un identifiant externe à une opération d'API qui accepte des UUID ou des identifiants externes. 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 des identifiants externes à la place des UUID de cette manière pour de nombreuses opérations d'API AWS IoT SiteWise, mais pas pour toutes. Par exemple, le GetAssetPropertyValue, doit utiliser des UUID ; il ne prend pas en charge l'utilisation d'identifiants externes.

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