Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

定义自定义元数据架构

使用自定义元数据将您自己的字段添加到注册表中的记录中，例如所属团队、审核状态或数据分类。您只需在注册表上定义字段。然后，在创建或编辑记录时，将其填入。

您可以定义两种字段：

记录可以带有公共属性以及与其记录类型对应的字段。对于要在所有记录中筛选或报告的任何内容，请使用通用属性。

示例

此注册表中的每条记录都需要一个所有者，并且可以进行数据分类。代理记录还需要模型族和分类，可以归类为restricted。

常见属性：

{
  "type": "object",
  "properties": {
    "owner": {"type": "string"},
    "dataClassification": {"type": "string", "enum": ["public", "internal", "confidential"]}
  },
  "required": ["owner"]
}

字段为AGENT：

{
  "type": "object",
  "properties": {
    "modelFamily": {"type": "string"},
    "dataClassification": {"type": "string", "enum": ["public", "internal", "confidential", "restricted"]}
  },
  "required": ["modelFamily", "dataClassification"]
}

然后，记录可以携带：

代理字段不会重复owner，因为每种记录类型都已获得通用属性。他们确实会重复dataClassification。这使得该字段成为代理的必填字段，并允许附加值restricted。要像这样更改一种记录类型的通用属性，请将其包含在该记录类型的字段中，其类型和所有允许值都相同。您可以添加允许的值并将其设为必填值。

定义架构

控制台

要将架构编辑为 JSON，请从表单切换到 JSON。每个架构（公共属性或一种记录类型的字段）都是一个 JSON 架构文档，与示例中的文件类似。

Amazon CLI

在 API 中，常用属性是defaultSchema，每种记录类型的字段都是中的一个条目recordTypeSchemaOverrides。每个架构都是一个 JSON 字符串。

将示例中的两个架构另存为common.json和agent.json，然后创建注册表：

jq -n --rawfile common common.json --rawfile agent agent.json \
  '{defaultSchema: $common, recordTypeSchemaOverrides: [{recordType: "AGENT", schema: $agent}]}' \
  > schema-config.json

aws agent-registry-control create-registry \
  --name "my-registry" \
  --custom-metadata-schema-configuration file://schema-config.json \
  --region us-east-1

要稍后更改架构，请编辑架构文件，重新生成配置，然后将其封装后发送optionalValue。此示例向常用属性添加了一个team字段：

jq '.properties.team = {"type": "string"}' common.json > common.tmp && mv common.tmp common.json

jq -n --rawfile common common.json --rawfile agent agent.json \
  '{optionalValue: {defaultSchema: $common, recordTypeSchemaOverrides: [{recordType: "AGENT", schema: $agent}]}}' \
  > schema-update.json

aws agent-registry-control update-registry \
  --registry-id "<registryId>" \
  --custom-metadata-schema-configuration file://schema-update.json \
  --region us-east-1

Amazon SDK

import boto3
import json

client = boto3.client('agent-registry-control')

common_attributes = {
    "type": "object",
    "properties": {
        "owner": {"type": "string"},
        "dataClassification": {"type": "string", "enum": ["public", "internal", "confidential"]}
    },
    "required": ["owner"]
}

agent_fields = {
    "type": "object",
    "properties": {
        "modelFamily": {"type": "string"},
        "dataClassification": {
            "type": "string",
            "enum": ["public", "internal", "confidential", "restricted"]
        }
    },
    "required": ["modelFamily", "dataClassification"]
}

response = client.create_registry(
    name='my-registry',
    customMetadataSchemaConfiguration={
        'defaultSchema': json.dumps(common_attributes),
        'recordTypeSchemaOverrides': [
            {'recordType': 'AGENT', 'schema': json.dumps(agent_fields)}
        ]
    }
)
print(f"Registry ARN: {response['registryArn']}")

要稍后更改架构，请发送包含以下内容的完整新配置optionalValue：

common_attributes["properties"]["team"] = {"type": "string"}

client.update_registry(
    registryId='<registryId>',
    customMetadataSchemaConfiguration={
        'optionalValue': {
            'defaultSchema': json.dumps(common_attributes),
            'recordTypeSchemaOverrides': [
                {'recordType': 'AGENT', 'schema': json.dumps(agent_fields)}
            ]
        }
    }
)

更改架构

更新会替换整个架构，因此请包括要保留的每个字段和记录类型。

您可以随时进行以下更改：

您无法进行以下更改：

更新架构时，现有记录不会更改。如果记录不再与之匹配，例如因为您设置了必填字段，则会报告为NON_COMPLIANT中customMetadataSchemaComplianceStatus并保持其批准状态。在下次提交其自定义元数据以供批准之前，请对其进行更新。

查看架构

控制台-在注册表详细信息页面上，“自定义元数据架构” 部分为每种记录类型都有一个选项卡，其中包含其记录可以包含的字段。

Amazon CLI

aws agent-registry-control get-registry \
  --registry-id "<registryId>" \
  --region us-east-1 \
  --output json | jq '.customMetadataSchemaConfiguration'

Amazon SDK

import boto3

client = boto3.client('agent-registry-control')

registry = client.get_registry(registryId='<registryId>')
print(registry['customMetadataSchemaConfiguration'])

架构规则和限制

下表列出了架构限制。

有关值的限制，请参阅为记录设置自定义元数据值中的约束条件。

相关信息