View a markdown version of this page

CustomMetadataSchemaConfiguration - AgentRegistry Control Plane API Reference

CustomMetadataSchemaConfiguration

Configuration that defines a typed metadata schema for a registry. Specify at least one of a default schema or per-record-type schema overrides. You can provide both.

Contents

defaultSchema

The default JSON Schema that applies to record types without a specific override. Supported property types are string, string with an enum constraint, string with a uri format, and boolean.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 10240.

Required: No

recordTypeSchemaOverrides

A list of per-record-type schema overrides. When a record's type matches an override, that override's schema is used instead of the default schema for validation. If you don't specify an override for a record type, the default schema applies. If no default schema exists, custom metadata on records of that type is rejected.

Type: Array of RecordTypeSchemaOverride objects

Array Members: Minimum number of 0 items. Maximum number of 5 items.

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: