AgentDiscovery / Paginator / SearchPublicRecords
SearchPublicRecords¶
- class AgentDiscovery.Paginator.SearchPublicRecords¶
paginator = client.get_paginator('search_public_records')
- paginate(**kwargs)¶
Creates an iterator that will paginate through responses from
AgentDiscovery.Client.search_public_records().See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( searchQuery='string', filters={...}|[...]|123|123.4|'string'|True|None, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
searchQuery (string) – Free-text natural-language query (ARD
text). Drives semantic + lexical ranking.filters (document) –
Structured filter narrowing the results, in the grammar of Agent Registry’s SearchDiscoverableRegistryRecords
filters:$eq,$neand$inon a field, with$andor$orover single-condition objects, never nested. Fields areidentifier,domain,recordType,descriptorType,provenanceandrecordVersion, andidentifieralso takes$prefix. For example{"recordType": {"$eq": "AGENT"}}or{"$or": [{"recordType": {"$eq": "MCP"}}, {"domain": {"$eq": "acme.com"}}]}.Limits, the same ones Agent Registry applies: at most 10 conditions, $in takes 1-25 values, values are strings of 1-512 characters, and {} is invalid. A document can’t carry @length, so the service enforces these and answers a filter past them with a ValidationException, as Agent Registry does.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a
NextTokenwill be provided in the output that you can use to resume pagination.PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the
NextTokenfrom a previous response.
- Return type:
dict
- Returns:
Response Syntax
{ 'records': [ { 'identifier': { 'domain': 'string', 'uri': 'string' }, 'displayName': 'string', 'description': 'string', 'recordType': 'AGENT'|'TOOL'|'SKILL'|'CUSTOM'|'GATEWAY'|'WEB_BOT', 'domain': 'string', 'descriptors': { 'string': { 'data': 'string', 'version': 'string', 'source': { 'fromUrl': { 'url': 'string' } }, 'additionalData': {'... recursive ...'} } }, 'trustManifests': [ { 'contributor': 'string', 'provenance': [ { 'relation': 'publishedFrom'|'discoveredFrom'|'federatedFrom', 'sourceId': 'string' }, ] }, ], 'recordVersion': 'string', 'createdAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1) }, ], 'NextToken': 'string' }
Response Structure
(dict) –
records (list) –
The records that match the search, most relevant first.
(dict) –
A public record returned by search. Only the record’s public descriptors are included.
identifier (dict) –
The resolvable identifier value. Discriminated union — exactly one member is set.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set:
domain,uri. If a client receives an unknown member it will setSDK_UNKNOWN_MEMBERas the top level key, which maps to the name or tag of the unknown member. The structure ofSDK_UNKNOWN_MEMBERis as follows:'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
domain (string) –
Verified domain (e.g. example.com).
uri (string) –
Arbitrary resolvable URI (urn / url / did).
displayName (string) –
The record’s display name.
description (string) –
A description of the record.
recordType (string) –
The kind of resource the record describes, such as an agent, a tool, or a skill.
domain (string) –
FQDN per RFC-1035/1123, case-insensitive, at least two labels.
descriptors (dict) –
Every PUBLIC descriptor slot the record was published with, as published: each slot’s
source, inlinedata,versionand nestedadditionalData, thecustomslot included. Absent on a record discovered at a partner source; ARD serves the partner’s cards.(string) –
(dict) –
A descriptor slot value (A2A card, MCP server card, skills definition, custom). Content is either inline (
data) or a reference (source).additionalDatacarries nested sub-descriptors (e.g. mcpServer.tools, agentSkillsDefinition.skillMd).data (string) –
Inline descriptor content (JSON string).
version (string) –
Descriptor type version.
source (dict) –
Reference to externally-hosted descriptor content.
fromUrl (dict) –
The URL that hosts the descriptor content.
url (string) –
The URL of the externally hosted descriptor content.
additionalData (dict) –
Nested sub-descriptors keyed by slot name (e.g.
tools,skillMd).
trustManifests (list) –
Trust Manifests (AI Catalog Trust Manifest Object), today only the registry’s own,
contributordid:web:agent-registry.global.api.aws. Its one provenance link says how the registry got the record:relationispublishedFromfor a record its owner published anddiscoveredFromfor one the registry discovered at a partner source, withsourceIdasProvenanceLink.sourceIddescribes. Theprovenancefilter takes the same values (seeProvenanceRelation). It’s left off when the registry can’t name the source: afederatedFromrecord until the index carries the peer registry, a discovered record with no source, or a missing or unknown origin. The manifest is unsigned, so it attributes the claim to the registry and doesn’t authenticate it.(dict) –
One contributor’s trust metadata about a record (AI Catalog Trust Manifest Object), with only the members the registry sets. AI Catalog’s other members (
subject,signature,trustSchema,attestations,extensions) are optional, so each can be added when something sets it.contributor (string) –
Absolute URI of the contributor these claims are attributed to.
provenance (list) –
The record’s lineage as the contributor states it: how the contributor got the record, and from which source.
(dict) –
Lineage of a record (AI Catalog Provenance Link Object), with only its required members.
relation (string) –
How the contributor got the record.
sourceId (string) –
The source of the record. Not always a URI. On
publishedFromit’s the value of the record’sidentifierunion member,identifier.urioridentifier.domain, unchanged. OndiscoveredFromit’s the name the registry gave the partner source when it was configured for crawling, not a URL.
recordVersion (string) –
The record’s version string, set by its publisher. Left off when the record has none, for example a discovered record whose source carries no version.
createdAt (datetime) –
When the record was created.
updatedAt (datetime) –
When the record was last updated.
NextToken (string) –
A token to resume pagination.