search_registry_records¶
Operation¶
async
¶
search_registry_records(input: SearchRegistryRecordsInput, plugins: list[Plugin] | None = None) -> SearchRegistryRecordsOutput
Searches for registry records using semantic, lexical, or hybrid queries. Returns metadata for matching records ordered by relevance within the specified registry.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
SearchRegistryRecordsInput
|
An instance of |
required |
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
|
Returns:
| Type | Description |
|---|---|
SearchRegistryRecordsOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for SearchRegistryRecordsInput structure.
Attributes¶
class-attribute
instance-attribute
¶
filters: Document | None = None
A metadata filter expression to narrow search results. Uses structured
JSON operators including field-level operators ($eq, $ne, $in) and
logical operators ($and, $or) on filterable fields (name,
descriptorType, version). For example, to filter by descriptor type:
{"descriptorType": {"$eq": "MCP"}}. To combine filters:
{"$and": [{"descriptorType": {"$eq": "MCP"}}, {"name": {"$eq": "my-tool"}}]}.
class-attribute
instance-attribute
¶
max_results: int = 10
The maximum number of records to return in a single call. Valid values are 1 through 20. The default value is 10.
class-attribute
instance-attribute
¶
registry_ids: list[str] | None = None
The list of registry identifiers to search within. Currently, you can specify exactly one registry identifier. You can provide either the full Amazon Web Services Resource Name (ARN) or the 12-character alphanumeric registry ID.
class-attribute
instance-attribute
¶
search_query: str | None = None
The search query to find matching registry records.
Output¶
dataclass
¶
Dataclass for SearchRegistryRecordsOutput structure.
Attributes¶
instance-attribute
¶
registry_records: list[RegistryRecordSummary]
The list of registry records that match the search query, ordered by relevance.