タイプ定義のスキーマ - のマネージド統合 AWS IoT Device Management
$id$ref名前titledescriptionextrinsicIdextrinsicProperties

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

タイプ定義のスキーマ

以下のセクションでは、型定義に使用されるスキーマについて詳しく説明します。

$id

$id 要素はスキーマ定義を識別します。次の構造に従う必要があります。

  • URI /schema-versions/ プレフィックスで始める

  • definition スキーマタイプを含める

  • URI パス区切り文字としてスラッシュ (/) を使用する

  • フラグメントをピリオドで区切ってスキーマ ID を含める (.）

  • @ 文字を使用してスキーマ ID とバージョンを区切る

  • ピリオド (.) を使用してバージョンフラグメントを分離し、セムバーバージョンで終わる

スキーマ ID は、3～12 文字のルート名前空間で始まり、その後にオプションのサブ名前空間と名前が続く必要があります。

セムバーバージョンには、メジャーバージョン (最大 3 桁）、マイナーバージョン (最大 3 桁）、オプションの PATCH バージョン (最大 4 桁) が含まれます。

注記

予約済み名前空間awsや matter

例 $id の例
/schema-version/capability/aws.Recording@1.0

$ref

$ref 要素は、システム内の既存の型定義を参照します。これは、 $id要素と同じ制約に従います。

注記

タイプ定義または機能は、 $ref ファイルで指定された値で存在する必要があります。

例 $ref の例
/schema-version/definition/aws.capability@1.0

名前

name 要素は、スキーマドキュメント内のエンティティ名を表す文字列です。多くの場合、略語が含まれており、次のルールに従う必要があります。

  • 英数字、ピリオド (.)、スラッシュ (/)、ハイフン (-)、スペースのみを含む

  • 文字で始める

  • 最大 192 文字

名前要素は、Amazon Web Services コンソールの UI とドキュメントで使用されます。

例 名前の例
Door Lock
On/Off
Wi-Fi Network Management
PM2.5 Concentration Measurement
RTCSessionController
Energy EVSE

title

title 要素は、スキーマドキュメントで表されるエンティティの記述文字列です。任意の文字を含めることができ、ドキュメントで使用されます。

例 タイトルの例
Real-time Communication (RTC) Session Controller
Energy EVSE Capability

description

description 要素は、スキーマドキュメントで表されるエンティティの詳細な説明を提供します。任意の文字を含めることができ、ドキュメントで使用されます。

例 説明の例
Electric Vehicle Supply Equipment (EVSE) is equipment used to charge an Electric Vehicle (EV) or Plug-In Hybrid Electric Vehicle. 
            This capability provides an interface to the functionality of Electric Vehicle Supply Equipment (EVSE) management.

extrinsicId

extrinsicId 要素は、Amazon Web Services IoT システム外で管理される識別子を表します。Matter 機能の場合、コンテキストに応じて 、fieldId、、clusterIdattributeIdcommandIdeventId、または にマッピングされます。

は、文字列化された 10 進数整数 (1～10 桁) または文字列化された 16 進数整数 (0x または 0X プレフィックス、1～8 桁の 16 進数) のいずれかextrinsicIdです。

注記

AWSベンダー ID (VID) は 0x1577 で、Matter の場合は 0 です。システムは、カスタムスキーマがこれらの予約済み VIDs を機能に使用しないようにします。

例 extrinsicIds の例
0018
0x001A
0x15771002

extrinsicProperties

extrinsicProperties 要素には、外部システムで定義されているが、データモデル内で維持されている一連のプロパティが含まれています。Matter 機能の場合、ZCL クラスター、属性、コマンド、またはイベント内のさまざまなモデル化されていない要素または部分的にモデル化された要素にマッピングされます。

外部プロパティは、次の制約に従う必要があります。

  • プロパティ名は英数字で、スペースや特殊文字は使用できません

  • プロパティ値は任意の JSON スキーマ値にすることができます

  • 最大 20 個のプロパティ

システムは、extrinsicProperties、、、 などcliFunctionName、さまざまな access apiMaturity cliをサポートしています。これらのプロパティにより、データモデル変換への AWS （またはその逆の) ACL が容易になります。

注記

外部プロパティは、機能の action、event、property、および structフィールド要素でサポートされていますが、機能やクラスター自体ではサポートされていません。