AgentRegistry / Client / list_discoverable_registry_records
list_discoverable_registry_records¶
- AgentRegistry.Client.list_discoverable_registry_records(**kwargs)¶
Lists the discoverable registry records in a registry. You can optionally filter and paginate the results.
See also: AWS API Documentation
Request Syntax
response = client.list_discoverable_registry_records( registryId='string', maxResults=123, nextToken='string', filters=[ { 'name': 'recordType'|'descriptorType', 'values': [ 'string', ] }, ] )
- Parameters:
registryId (string) –
[REQUIRED]
The identifier of the registry whose discoverable records are listed. You can provide either the full Amazon Resource Name (ARN) or the registry ID.
maxResults (integer) – The maximum number of records to return in a single page. Valid values are 1 through 100.
nextToken (string) – The pagination token returned by a previous request. Use this value to retrieve the next page of results.
filters (list) –
The filters to apply to the discoverable registry record list.
(dict) –
A single filter applied to a
ListDiscoverableRegistryRecordsrequest.name (string) – [REQUIRED]
The attribute to filter on.
values (list) – [REQUIRED]
The values to match for the attribute.
(string) –
A single filter value. Constrained by length only; the accepted set of values is filter-specific and validated server-side so enum-style values such as READY or AWS_IAM are accepted.
- Return type:
dict
- Returns:
Response Syntax
{ 'registryRecords': [ { 'registryArn': 'string', 'recordArn': 'string', 'recordId': 'string', 'name': 'string', 'description': 'string', 'displayName': 'string', 'recordType': 'MCP'|'AGENT'|'CUSTOM'|'SKILL'|'GATEWAY', 'recordVersion': 'string', 'status': 'DRAFT'|'PENDING_APPROVAL'|'APPROVED'|'REJECTED'|'DEPRECATED'|'CREATING'|'UPDATING'|'CREATE_FAILED'|'UPDATE_FAILED', 'createdAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1), 'descriptorTypes': [ 'string', ] }, ], 'nextToken': 'string' }
Response Structure
(dict) –
registryRecords (list) –
The page of discoverable registry record summaries.
(dict) –
Summary information about a discoverable registry record returned by
ListDiscoverableRegistryRecords. This summary does not include descriptors.registryArn (string) –
The Amazon Resource Name (ARN) of the parent registry that owns the record.
recordArn (string) –
The Amazon Resource Name (ARN) of the registry record.
recordId (string) –
The unique identifier of the registry record.
name (string) –
The name of the registry record. Names are unique within a registry.
description (string) –
A human-readable description of the registry record. Use this field to explain the record’s purpose or content to consumers discovering it in the registry.
displayName (string) –
The human-readable display name of the registry record.
recordType (string) –
The type of the registry record.
MCPis a Model Context Protocol server record,AGENTis an Agent-to-Agent (A2A) agent card record,SKILLis an agent skills definition record, andCUSTOMis a record with a custom descriptor.recordVersion (string) –
The version identifier of the registry record.
status (string) –
The lifecycle status of the registry record. A record is
DRAFTbefore it is submitted,PENDING_APPROVALwhile awaiting curator review, andAPPROVEDonce it is approved and discoverable.REJECTEDandDEPRECATEDrecords are not discoverable. TheCREATING,UPDATING,CREATE_FAILED, andUPDATE_FAILEDvalues reflect the state of an in-progress or failed asynchronous change.createdAt (datetime) –
The timestamp when the registry record was created.
updatedAt (datetime) –
The timestamp when the registry record was last updated.
descriptorTypes (list) –
The descriptor types that are present on this registry record. Each value corresponds to a descriptor entry key on the approved record.
(string) –
nextToken (string) –
The pagination token to pass to a subsequent request to retrieve the next page of results. This field is absent when there are no more results.
Exceptions