Trabajar con identificadores de objetos

AWS IoT SiteWise define varios tipos de objetos persistentes, como activos, modelos de activos, propiedades y jerarquías. Todos estos objetos tienen identificadores únicos que puede utilizar para recuperarlos, actualizarlos y eliminarlos.

AWS IoT SiteWise tiene diferentes opciones para los clientes a la hora de crear identificaciones. AWS IoT SiteWise genera uno por defecto en el momento de la creación del objeto. Los usuarios también pueden proporcionar sus propios identificadores a sus objetos.

Trabajar con los UUID de objetos

Cada objeto persistente AWS IoT SiteWise tiene un UUID para identificarlo. Por ejemplo, los modelos de activos tienen un ID de modelo de activo, los activos tienen un ID de activo, etc. Este identificador se asigna en el momento de crear el objeto y permanece inalterado durante la vida útil del objeto.

Cuando creas un objeto nuevo, AWS IoT SiteWise genera un identificador único para ti de forma predeterminada. También puedes proporcionar tu propio ID en el momento de la creación en formato UUID.

nota

Los UUID deben ser únicos a nivel mundial en la AWS región en la que se crearon y para el mismo tipo de objeto. Cuando se AWS IoT SiteWise genera automáticamente un ID para ti, siempre es único. Si eliges tu propio identificador, asegúrate de que sea único.

Por ejemplo, si creas un nuevo modelo de activos llamando a CreateAssetModel, puedes proporcionar tu propio UUID en el assetModelId campo opcional de la solicitud.

Por el contrario, si lo omites assetModelId en la solicitud, AWS IoT SiteWise genera un UUID para el nuevo modelo de activos.

Uso de identificadores externos

Para definir su propio ID en un formato que no sea el UUID, puede asignar un ID externo. Por ejemplo, puedes hacerlo si reutilizas un ID que estás utilizando en un sistema que no lo está AWS, o si quieres que sea más legible para los humanos. Los ID externos tienen un formato más flexible. Puedes utilizarlos para hacer referencia a tus objetos en las operaciones de la AWS IoT SiteWise API en las que, de otro modo, utilizarías el UUID.

Al igual que los UUID, cada ID externo debe ser único en su contexto. Por ejemplo, no puede tener dos modelos de activos con el mismo ID externo. Además, al igual que los UUID, un objeto solo puede tener un ID externo durante su vida útil, lo que no puede cambiar.

Diferencias entre los ID externos y los UUID

Los ID externos se diferencian de los UUID en los siguientes aspectos:

• Cada objeto tiene un UUID, pero los ID externos son opcionales.

• AWS IoT SiteWise nunca genera identificadores externos. Los proporciona usted mismo.

• Si el objeto aún no tiene uno, puedes asignarle un identificador externo en cualquier momento.

Formato de los identificadores externos

Un identificador externo válido tiene las siguientes propiedades:

• Tiene una longitud de entre 2 y 128 caracteres.

• El primer y el último carácter deben ser alfanuméricos (A-Z, a-z, 0-9).

• Los caracteres que no sean el primero y el último deben ser alfanuméricos o bien alguno de los siguientes caracteres: _-.:

Por ejemplo, un identificador externo debe ajustarse a la siguiente expresión regular:

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

Hacer referencia a objetos con identificadores externos

En muchos lugares en los que puede hacer referencia a un objeto mediante su UUID, puede utilizar su ID externo en su lugar, si lo tiene. Para ello, añade el ID externo a la cadena. externalId:

Por ejemplo, supongamos que tiene un modelo de activos cuyo UUID (ID del modelo de activo) es a1b2c3d4-5678-90ab-cdef-11111EXAMPLE y que también tiene el ID externo. myExternalId Llame a DescribeAssetModel para obtener detalles al respecto. Puede utilizar cualquiera de los siguientes valores como valor deassetModelId:

• Con el propio ID del modelo de activo (UUID): a1b2c3d4-5678-90ab-cdef-11111EXAMPLE

• Con el ID externo: 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

nota

El externalId: prefijo no forma parte, en sí mismo, del identificador externo. Solo debes proporcionar el prefijo cuando proporciones un ID externo a una operación de API que acepte UUID o ID externos. Por ejemplo, proporciona el prefijo cuando consultes o actualices un objeto existente.

Al definir un identificador externo para un objeto, por ejemplo, al crear un modelo de activos, no incluya el prefijo.

De este modo, puedes usar identificadores externos en lugar de UUID para muchas operaciones de API AWS IoT SiteWise, pero no para todas. Por ejemplo, el GetAssetPropertyValue, debe usar UUID; no admite el uso de ID externos.

Para determinar si una operación de API en particular admite este uso, consulta la referencia de la API.