AgentRegistry / Client / search_discoverable_registry_records

search_discoverable_registry_records

AgentRegistry.Client.search_discoverable_registry_records(**kwargs)

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

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

Parameters:

• searchQuery (string) –

  [REQUIRED]

  The natural language query to search for matching registry records.

• registryIds (list) –

  [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

• maxResults (integer) – The maximum number of results to return. Valid values are 1 through 20. The default value is 10.

• filters (document) – 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.

Return type:

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

Exceptions

• AgentRegistry.Client.exceptions.InternalServerException

• AgentRegistry.Client.exceptions.AccessDeniedException

• AgentRegistry.Client.exceptions.ResourceNotFoundException

• AgentRegistry.Client.exceptions.ThrottlingException

• AgentRegistry.Client.exceptions.UnauthorizedException

• AgentRegistry.Client.exceptions.ValidationException