Agent Registry

2026/08/06 - Agent Registry - 3 new api methods

Changes  Agent Registry's Public Preview release

BatchGetDiscoverableRegistryRecord (new) Link ¶

Retrieves multiple discoverable registry records by ID from a single registry. Records that cannot be retrieved are reported individually in the errors list rather than failing the entire request.

See also: AWS API Documentation

Request Syntax

client.batch_get_discoverable_registry_record(
    entries=[
        {
            'registryId': 'string',
            'recordIds': [
                'string',
            ]
        },
    ]
)
type entries:

list

param entries:

[REQUIRED]

The registry-scoped groups of record IDs to retrieve. Currently, you can specify exactly one entry.

  • (dict) --

    Binds one registry to the record IDs requested from it.

    • registryId (string) -- [REQUIRED]

      Registry identifier that accepts either ARN or ID format

    • recordIds (list) -- [REQUIRED]

      The record IDs to retrieve from the registry. You can specify 1 through 100 record IDs.

      • (string) --

        Record identifier that accepts either ARN or ID format

rtype:

dict

returns:

Response Syntax

{
    'registryRecords': [
        {
            'registryArn': 'string',
            'recordArn': 'string',
            'recordId': 'string',
            'name': 'string',
            'description': 'string',
            'displayName': 'string',
            'recordType': 'MCP'|'AGENT'|'CUSTOM'|'SKILL',
            'descriptors': {
                'mcpServer': {
                    'data': 'string',
                    'dataSchemaVersion': 'string',
                    'additionalData': {
                        'tools': {
                            'data': 'string',
                            'dataSchemaVersion': 'string'
                        }
                    },
                    'source': {
                        'fromUrl': {
                            'url': 'string'
                        }
                    }
                },
                'a2aAgentCard': {
                    'data': 'string',
                    'dataSchemaVersion': 'string',
                    'source': {
                        'fromUrl': {
                            'url': 'string'
                        }
                    }
                },
                'agentSkillsDefinition': {
                    'data': 'string',
                    'dataSchemaVersion': 'string',
                    'additionalData': {
                        'skillMd': {
                            'data': 'string',
                            'dataSchemaVersion': 'string',
                            'source': {
                                'fromUrl': {
                                    'url': 'string'
                                }
                            }
                        }
                    }
                },
                'custom': {
                    'data': 'string'
                }
            },
            '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)
        },
    ],
    'errors': [
        {
            'registryId': 'string',
            'recordId': 'string',
            'errorCode': 'RESOURCE_NOT_FOUND'|'ACCESS_DENIED'|'INTERNAL_ERROR',
            'message': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • registryRecords (list) --

      The records that were successfully retrieved. Each record correlates to the request by its recordId.

      • (dict) --

        Summary information about a registry record, including its descriptors.

        • registryArn (string) --

          Registry Amazon Resource Name

        • recordArn (string) --

          Registry Record Amazon Resource Name

        • recordId (string) --

          Registry Record unique identifier - 12-character alphanumeric string

        • name (string) --

          Registry Record name

        • description (string) --

          Description of the Resource

        • displayName (string) --

          Display name for a registry record

        • recordType (string) --

          Record type enum for registry record classification

        • descriptors (dict) --

          The protocol-specific descriptors that describe how to connect to and use the record.

          • mcpServer (dict) --

            Base mixin for MCP server descriptor content

            • data (string) --

              Descriptor payload data

            • dataSchemaVersion (string) --

              Version of the descriptor type schema

            • additionalData (dict) --

              Additional data for an MCP server descriptor

              • tools (dict) --

                MCP tools descriptor containing tool definitions

                • data (string) --

                  Descriptor payload data

                • dataSchemaVersion (string) --

                  Version of the descriptor type schema

            • source (dict) --

              The source location from which the MCP (Model Context Protocol) server descriptor content was retrieved.

              • fromUrl (dict) --

                Base mixin for descriptor source from URL

                • url (string) --

                  URL source for descriptor content

          • a2aAgentCard (dict) --

            Base mixin for A2A agent card descriptor content

            • data (string) --

              Descriptor payload data

            • dataSchemaVersion (string) --

              Version of the descriptor type schema

            • source (dict) --

              The source location from which the A2A (Agent-to-Agent) agent card descriptor content was retrieved.

              • fromUrl (dict) --

                Base mixin for descriptor source from URL

                • url (string) --

                  URL source for descriptor content

          • agentSkillsDefinition (dict) --

            Base mixin for agent skills definition descriptor content

            • data (string) --

              Descriptor payload data

            • dataSchemaVersion (string) --

              Version of the descriptor type schema

            • additionalData (dict) --

              Additional data for the agent skills definition, such as the skills markdown descriptor.

              • skillMd (dict) --

                Base mixin for agent skills markdown descriptor content

                • data (string) --

                  Descriptor payload data

                • dataSchemaVersion (string) --

                  Version of the descriptor type schema

                • source (dict) --

                  The source location from which the agent skills markdown content was retrieved.

                  • fromUrl (dict) --

                    Base mixin for descriptor source from URL

                    • url (string) --

                      URL source for descriptor content

          • custom (dict) --

            Custom descriptor for user-defined content

            • data (string) --

              Descriptor payload data

        • recordVersion (string) --

          Version of the registry record

        • status (string) --

          Registry record status

        • createdAt (datetime) --

          Timestamp in ISO 8601 date-time format

        • updatedAt (datetime) --

          Timestamp in ISO 8601 date-time format

    • errors (list) --

      The per-record errors for records that could not be retrieved. This list is empty when all requested records were returned.

      • (dict) --

        Describes why a requested record could not be retrieved.

        • registryId (string) --

          Registry identifier that accepts either ARN or ID format

        • recordId (string) --

          Record identifier that accepts either ARN or ID format

        • errorCode (string) --

          The machine-readable reason that the record could not be retrieved.

        • message (string) --

          An optional human-readable detail about the error. Do not parse this value programmatically.

SearchDiscoverableRegistryRecords (new) Link ¶

Searches the discoverable registry records in a registry using a natural language query. Returns metadata for the matching records ordered by relevance.

See also: AWS API Documentation

Request Syntax

client.search_discoverable_registry_records(
    searchQuery='string',
    registryIds=[
        'string',
    ],
    maxResults=123,
    filters={...}|[...]|123|123.4|'string'|True|None
)
type searchQuery:

string

param searchQuery:

[REQUIRED]

The natural language query to search for matching registry records.

type registryIds:

list

param registryIds:

[REQUIRED]

The registry identifiers to search within. Currently, you must specify exactly one registry identifier. You can provide either the full Amazon Web Services Resource Name (ARN) or the registry ID.

  • (string) --

    Registry identifier that accepts either ARN or ID format

type maxResults:

integer

param maxResults:

The maximum number of results to return. Valid values are 1 through 20. The default value is 10.

type filters:

:ref:`document<document>`

param filters:

An optional structured JSON metadata filter that narrows the search results. Supports the field-level operators $eq, $ne, and $in, and the logical operators $and and $or on filterable fields.

rtype:

dict

returns:

Response Syntax

{
    'registryRecords': [
        {
            'registryArn': 'string',
            'recordArn': 'string',
            'recordId': 'string',
            'name': 'string',
            'description': 'string',
            'displayName': 'string',
            'recordType': 'MCP'|'AGENT'|'CUSTOM'|'SKILL',
            'descriptors': {
                'mcpServer': {
                    'data': 'string',
                    'dataSchemaVersion': 'string',
                    'additionalData': {
                        'tools': {
                            'data': 'string',
                            'dataSchemaVersion': 'string'
                        }
                    },
                    'source': {
                        'fromUrl': {
                            'url': 'string'
                        }
                    }
                },
                'a2aAgentCard': {
                    'data': 'string',
                    'dataSchemaVersion': 'string',
                    'source': {
                        'fromUrl': {
                            'url': 'string'
                        }
                    }
                },
                'agentSkillsDefinition': {
                    'data': 'string',
                    'dataSchemaVersion': 'string',
                    'additionalData': {
                        'skillMd': {
                            'data': 'string',
                            'dataSchemaVersion': 'string',
                            'source': {
                                'fromUrl': {
                                    'url': 'string'
                                }
                            }
                        }
                    }
                },
                'custom': {
                    'data': 'string'
                }
            },
            '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)
        },
    ]
}

Response Structure

  • (dict) --

    • registryRecords (list) --

      The registry records that match the search query, ordered by relevance.

      • (dict) --

        Summary information about a registry record, including its descriptors.

        • registryArn (string) --

          Registry Amazon Resource Name

        • recordArn (string) --

          Registry Record Amazon Resource Name

        • recordId (string) --

          Registry Record unique identifier - 12-character alphanumeric string

        • name (string) --

          Registry Record name

        • description (string) --

          Description of the Resource

        • displayName (string) --

          Display name for a registry record

        • recordType (string) --

          Record type enum for registry record classification

        • descriptors (dict) --

          The protocol-specific descriptors that describe how to connect to and use the record.

          • mcpServer (dict) --

            Base mixin for MCP server descriptor content

            • data (string) --

              Descriptor payload data

            • dataSchemaVersion (string) --

              Version of the descriptor type schema

            • additionalData (dict) --

              Additional data for an MCP server descriptor

              • tools (dict) --

                MCP tools descriptor containing tool definitions

                • data (string) --

                  Descriptor payload data

                • dataSchemaVersion (string) --

                  Version of the descriptor type schema

            • source (dict) --

              The source location from which the MCP (Model Context Protocol) server descriptor content was retrieved.

              • fromUrl (dict) --

                Base mixin for descriptor source from URL

                • url (string) --

                  URL source for descriptor content

          • a2aAgentCard (dict) --

            Base mixin for A2A agent card descriptor content

            • data (string) --

              Descriptor payload data

            • dataSchemaVersion (string) --

              Version of the descriptor type schema

            • source (dict) --

              The source location from which the A2A (Agent-to-Agent) agent card descriptor content was retrieved.

              • fromUrl (dict) --

                Base mixin for descriptor source from URL

                • url (string) --

                  URL source for descriptor content

          • agentSkillsDefinition (dict) --

            Base mixin for agent skills definition descriptor content

            • data (string) --

              Descriptor payload data

            • dataSchemaVersion (string) --

              Version of the descriptor type schema

            • additionalData (dict) --

              Additional data for the agent skills definition, such as the skills markdown descriptor.

              • skillMd (dict) --

                Base mixin for agent skills markdown descriptor content

                • data (string) --

                  Descriptor payload data

                • dataSchemaVersion (string) --

                  Version of the descriptor type schema

                • source (dict) --

                  The source location from which the agent skills markdown content was retrieved.

                  • fromUrl (dict) --

                    Base mixin for descriptor source from URL

                    • url (string) --

                      URL source for descriptor content

          • custom (dict) --

            Custom descriptor for user-defined content

            • data (string) --

              Descriptor payload data

        • recordVersion (string) --

          Version of the registry record

        • status (string) --

          Registry record status

        • createdAt (datetime) --

          Timestamp in ISO 8601 date-time format

        • updatedAt (datetime) --

          Timestamp in ISO 8601 date-time format

ListDiscoverableRegistryRecords (new) Link ¶

Lists the discoverable registry records in a registry. You can optionally filter and paginate the results.

See also: AWS API Documentation

Request Syntax

client.list_discoverable_registry_records(
    registryId='string',
    maxResults=123,
    nextToken='string',
    filters=[
        {
            'name': 'recordType'|'descriptorType',
            'values': [
                'string',
            ]
        },
    ]
)
type registryId:

string

param registryId:

[REQUIRED]

Registry identifier that accepts either ARN or ID format

type maxResults:

integer

param maxResults:

The maximum number of records to return in a single page. Valid values are 1 through 100.

type nextToken:

string

param nextToken:

The pagination token returned by a previous request. Use this value to retrieve the next page of results.

type filters:

list

param filters:

The filters to apply to the discoverable registry record list.

  • (dict) --

    A single filter applied to a ListDiscoverableRegistryRecords request.

    • 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.

rtype:

dict

returns:

Response Syntax

{
    'registryRecords': [
        {
            'registryArn': 'string',
            'recordArn': 'string',
            'recordId': 'string',
            'name': 'string',
            'description': 'string',
            'displayName': 'string',
            'recordType': 'MCP'|'AGENT'|'CUSTOM'|'SKILL',
            '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)
        },
    ],
    '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) --

          Registry Amazon Resource Name

        • recordArn (string) --

          Registry Record Amazon Resource Name

        • recordId (string) --

          Registry Record unique identifier - 12-character alphanumeric string

        • name (string) --

          Registry Record name

        • description (string) --

          Description of the Resource

        • displayName (string) --

          Display name for a registry record

        • recordType (string) --

          Record type enum for registry record classification

        • recordVersion (string) --

          Version of the registry record

        • status (string) --

          Registry record status

        • createdAt (datetime) --

          Timestamp in ISO 8601 date-time format

        • updatedAt (datetime) --

          Timestamp in ISO 8601 date-time format

    • 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.