オブジェクト IDs

AWS IoT SiteWise は、アセット、アセットモデル、プロパティ、階層など、さまざまなタイプの永続オブジェクトを定義します。このようなオブジェクトには、取得、更新、削除に使用できる一意の識別子があります。

AWS IoT SiteWise には、ID 作成のオプションが顧客ごとに異なります。 は、オブジェクト作成時にデフォルトで ID AWS IoT SiteWise を生成します。ユーザーは、オブジェクトに独自の IDsを指定することもできます。

オブジェクト UUIDs

のすべての永続オブジェクト AWS IoT SiteWise には、それを識別するための UUID があります。例えば、アセットモデルにはアセットモデル ID があり、アセットにはアセット ID があります。この ID は、オブジェクトの作成時に割り当てられ、オブジェクトの存続期間中は変更されません。

新しいオブジェクトを作成すると、 はデフォルトで一意の ID AWS IoT SiteWise を生成します。作成時に独自の ID を UUID 形式で指定することもできます。

注記

UUIDsは、作成された AWS リージョン内でグローバルに一意で、同じオブジェクトタイプに対して一意である必要があります。が ID を AWS IoT SiteWise 自動生成する場合、常に一意です。独自の ID を選択する場合は、一意であることを確認してください。

例えば、モデル を呼び出して新しいアセットCreateAssetモデルを作成する場合、リクエストのオプションassetModelIdフィールドに独自の UUID を指定できます。

対照的に、リクエストassetModelIdから を省略すると、 は新しいアセットモデルの UUID AWS IoT SiteWise を生成します。

外部 IDsの使用

UUID 以外の形式で独自の ID を定義するには、外部 ID を割り当てることができます。例えば、 ではないシステムで使用している ID を再利用する場合や AWS、人間が読み取れるようにする場合などに、これを行うことができます。外部 IDs形式はより柔軟です。これらを使用して、UUID を使用する API オペレーションで AWS IoT SiteWise オブジェクトを参照できます。

UUIDsはコンテキスト内で一意である必要があります。例えば、同じ外部 ID を持つ 2 つのアセットモデルを持つことはできません。また、UUIDsつの外部 ID のみを持つことができ、変更することはできません。

外部 IDs と UUIDsの違い

外部 IDs、次の点で UUIDsとは異なります。

• すべてのオブジェクトには UUID がありますが、外部 IDsはオプションです。

• AWS IoT SiteWise は外部 IDsを生成しません。これらを自分で指定します。

• オブジェクトにまだ存在しない場合は、いつでも外部 ID を割り当てることができます。

外部 IDsの形式

有効な外部 ID には、次のプロパティがあります。

• 2～128 文字の長さです。

• 最初と最後の文字は英数字 (A～Z、a～z、0～9) である必要があります。

• 最初と最後の文字以外の文字は英数字であるか、次のいずれかである必要があります。 _-.:

例えば、外部 ID は次の正規表現に準拠している必要があります。

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

外部 IDs を持つオブジェクトの参照

UUID を使用してオブジェクトを参照できる多くの場所では、外部 ID がある場合は、代わりにその外部 ID を使用できます。そのためには、外部 ID を文字列 に追加しますexternalId:。

例えば、UUID (アセットモデル ID) が でa1b2c3d4-5678-90ab-cdef-11111EXAMPLE、外部 ID も のアセットモデルがあるとしますmyExternalId。DescribeAssetモデルを呼び出して、詳細を取得します。の値として次のいずれかを使用できますassetModelId。

• アセットモデル ID (UUID) 自体の場合: a1b2c3d4-5678-90ab-cdef-11111EXAMPLE

• 外部 ID の場合: 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

注記

externalId: プレフィックス自体は外部 ID の一部ではありません。プレフィックスを指定する必要があるのは、UUIDs または外部 ID のいずれかを受け入れる API オペレーションに外部 IDs。例えば、既存のオブジェクトをクエリまたは更新するときに プレフィックスを指定します。

アセットモデルの作成時など、オブジェクトの外部 ID を定義する場合は、 プレフィックスを含めないでください。

この方法で UUIDs の代わりに外部 IDs を の多くの API オペレーションに使用できますが AWS IoT SiteWise、すべてには使用できません。例えば、 GetAssetPropertyValueは UUIDsを使用する必要があります。外部 ID の使用をサポートしていません。

特定の API オペレーションがこの使用をサポートしているかどうかを確認するには、「 API リファレンス」を参照してください。