search_registry_records¶
Operation¶
search_registry_records
¶
search_registry_records(request: SearchRegistryRecordsInput | SearchRegistryRecordsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[SearchRegistryRecordsInputDict]) -> 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 |
|---|---|---|---|
request
|
SearchRegistryRecordsInput | SearchRegistryRecordsInputDict | 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[SearchRegistryRecordsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
SearchRegistryRecordsOutput
|
An instance of |
search_registry_records
async
¶
search_registry_records(request: SearchRegistryRecordsInput | SearchRegistryRecordsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[SearchRegistryRecordsInputDict]) -> 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 |
|---|---|---|---|
request
|
SearchRegistryRecordsInput | SearchRegistryRecordsInputDict | 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[SearchRegistryRecordsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
SearchRegistryRecordsOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
SearchRegistryRecordsInputDict
¶
Bases: TypedDict
Dictionary form of SearchRegistryRecordsInput.
Attributes¶
filters
instance-attribute
¶
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"}}]}.
max_results
instance-attribute
¶
max_results: int | None
The maximum number of records to return in a single call. Valid values are 1 through 20. The default value is 10.
registry_ids
instance-attribute
¶
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.
SearchRegistryRecordsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for SearchRegistryRecordsInput structure.
Attributes¶
filters
class-attribute
instance-attribute
¶
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"}}]}.
max_results
class-attribute
instance-attribute
¶
max_results: int = ...
The maximum number of records to return in a single call. Valid values are 1 through 20. The default value is 10.
registry_ids
class-attribute
instance-attribute
¶
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.
Output¶
SearchRegistryRecordsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for SearchRegistryRecordsOutput structure.
Attributes¶
registry_records
instance-attribute
¶
registry_records: list[RegistryRecordSummary]
The list of registry records that match the search query, ordered by relevance.
response_metadata
class-attribute
instance-attribute
¶
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.