AgentRegistry / Client / batch_get_discoverable_registry_record

batch_get_discoverable_registry_record

AgentRegistry.Client.batch_get_discoverable_registry_record(**kwargs)

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

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

Parameters:

entries (list) –

[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

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)
        },
    ],
    '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.

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