Skip to content

create_registry_record

Operation

create_registry_record

create_registry_record(request: CreateRegistryRecordInput | CreateRegistryRecordInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateRegistryRecordInputDict]) -> CreateRegistryRecordOutput

Creates a new registry record within the specified registry. A registry record represents an individual AI resource's metadata in the registry. This could be an MCP server (and associated tools), A2A agent, agent skill, or a custom resource with a custom schema.

The record is processed asynchronously and returns HTTP 202 Accepted.

Parameters:

Name Type Description Default
request CreateRegistryRecordInput | CreateRegistryRecordInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[CreateRegistryRecordInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateRegistryRecordOutput

An instance of CreateRegistryRecordOutput.

create_registry_record async

create_registry_record(request: CreateRegistryRecordInput | CreateRegistryRecordInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateRegistryRecordInputDict]) -> CreateRegistryRecordOutput

Creates a new registry record within the specified registry. A registry record represents an individual AI resource's metadata in the registry. This could be an MCP server (and associated tools), A2A agent, agent skill, or a custom resource with a custom schema.

The record is processed asynchronously and returns HTTP 202 Accepted.

Parameters:

Name Type Description Default
request CreateRegistryRecordInput | CreateRegistryRecordInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[CreateRegistryRecordInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateRegistryRecordOutput

An instance of CreateRegistryRecordOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

CreateRegistryRecordInputDict

Bases: TypedDict

Dictionary form of CreateRegistryRecordInput.

Attributes

client_token instance-attribute
client_token: str | None

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

This field is autopopulated if not provided.

description instance-attribute
description: str | None

A description of the registry record.

descriptor_type instance-attribute
descriptor_type: Required[str]

The descriptor type of the registry record.

  • MCP - Model Context Protocol descriptor for MCP-compatible servers and tools.

  • A2A - Agent-to-Agent protocol descriptor.

  • CUSTOM - Custom descriptor type for resources such as APIs, Lambda functions, or servers not conforming to a standard protocol.

  • AGENT_SKILLS - Agent skills descriptor for defining agent skill definitions.

descriptors instance-attribute
descriptors: Descriptors | DescriptorsDict | None

The descriptor-type-specific configuration containing the resource schema and metadata. The structure of this field depends on the descriptorType you specify.

name instance-attribute
name: Required[str]

The name of the registry record.

record_version instance-attribute
record_version: str | None

The version of the registry record. Use this to track different versions of the record's content.

registry_id instance-attribute
registry_id: Required[str]

The identifier of the registry where the record will be created. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.

synchronization_configuration instance-attribute
synchronization_configuration: SynchronizationConfiguration | SynchronizationConfigurationDict | None

The configuration for synchronizing registry record metadata from an external source, such as a URL-based MCP server.

synchronization_type instance-attribute
synchronization_type: str | None

The type of synchronization to use for keeping the record metadata up to date from an external source. Possible values include FROM_URL and NONE.

CreateRegistryRecordInput dataclass

Bases: _SerdeShape

Dataclass for CreateRegistryRecordInput structure.

Attributes

client_token class-attribute instance-attribute
client_token: str | None = ...

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

This field is autopopulated if not provided.

description class-attribute instance-attribute
description: str | None = ...

A description of the registry record.

descriptor_type class-attribute instance-attribute
descriptor_type: str | None = ...

The descriptor type of the registry record.

  • MCP - Model Context Protocol descriptor for MCP-compatible servers and tools.

  • A2A - Agent-to-Agent protocol descriptor.

  • CUSTOM - Custom descriptor type for resources such as APIs, Lambda functions, or servers not conforming to a standard protocol.

  • AGENT_SKILLS - Agent skills descriptor for defining agent skill definitions.

descriptors class-attribute instance-attribute
descriptors: Descriptors | None = ...

The descriptor-type-specific configuration containing the resource schema and metadata. The structure of this field depends on the descriptorType you specify.

name class-attribute instance-attribute
name: str | None = ...

The name of the registry record.

record_version class-attribute instance-attribute
record_version: str | None = ...

The version of the registry record. Use this to track different versions of the record's content.

registry_id class-attribute instance-attribute
registry_id: str | None = ...

The identifier of the registry where the record will be created. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.

synchronization_configuration class-attribute instance-attribute
synchronization_configuration: SynchronizationConfiguration | None = ...

The configuration for synchronizing registry record metadata from an external source, such as a URL-based MCP server.

synchronization_type class-attribute instance-attribute
synchronization_type: str | None = ...

The type of synchronization to use for keeping the record metadata up to date from an external source. Possible values include FROM_URL and NONE.

Output

CreateRegistryRecordOutput dataclass

Bases: _SerdeShape

Dataclass for CreateRegistryRecordOutput structure.

Attributes

record_arn instance-attribute
record_arn: str

The Amazon Resource Name (ARN) of the created registry record.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

status instance-attribute
status: str

The status of the registry record. Set to CREATING while the asynchronous workflow is in progress.