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.

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]
  
  The identifier of the registry to retrieve the records from. You can provide either the full Amazon Resource Name (ARN) or the registry ID.
- 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'|'GATEWAY',
            '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'
                },
                'http': {
                    'source': {
                        'fromUrl': {
                            'url': 'string'
                        }
                    }
                },
                'agui': {
                    'source': {
                        'fromUrl': {
                            'url': '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) –
      
      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. MCP is a Model Context Protocol server record, AGENT is an Agent-to-Agent (A2A) agent card record, SKILL is an agent skills definition record, and CUSTOM is a record with a custom descriptor.
    - descriptors (dict) –
      
      The protocol-specific descriptors that describe how to connect to and use the record.
      - mcpServer (dict) –
        
        The MCP server descriptor, populated when the record type is MCP.
        
        data (string) –
        
        The MCP server descriptor content, serialized as descriptor payload data.
        
        dataSchemaVersion (string) –
        
        The schema version of the descriptor payload.
        
        additionalData (dict) –
        
        Additional data associated with the MCP server descriptor, such as tool definitions.
        
        tools (dict) –
        
        The MCP tools descriptor that defines the tools exposed by the MCP server.
        
        data (string) –
        
        The MCP tools descriptor content, serialized as descriptor payload data.
        
        dataSchemaVersion (string) –
        
        The schema version of the descriptor payload.
        
        source (dict) –
        
        The source location from which the MCP (Model Context Protocol) server descriptor content was retrieved.
        
        fromUrl (dict) –
        
        The URL-based descriptor source, populated when descriptor content is synchronized from a URL.
        
        url (string) –
        
        The URL from which the descriptor content is retrieved.
      - a2aAgentCard (dict) –
        
        The A2A agent card descriptor, populated when the record type is AGENT.
        
        data (string) –
        
        The A2A agent card content, serialized as descriptor payload data.
        
        dataSchemaVersion (string) –
        
        The schema version of the descriptor payload.
        
        source (dict) –
        
        The source location from which the A2A (Agent-to-Agent) agent card descriptor content was retrieved.
        
        fromUrl (dict) –
        
        The URL-based descriptor source, populated when descriptor content is synchronized from a URL.
        
        url (string) –
        
        The URL from which the descriptor content is retrieved.
      - agentSkillsDefinition (dict) –
        
        The agent skills definition descriptor, populated when the record type is SKILL.
        
        data (string) –
        
        The agent skills definition content, serialized as descriptor payload data.
        
        dataSchemaVersion (string) –
        
        The schema version of the descriptor payload.
        
        additionalData (dict) –
        
        Additional data for the agent skills definition, such as the skills markdown descriptor.
        
        skillMd (dict) –
        
        The agent skills markdown descriptor associated with the agent skills definition.
        
        data (string) –
        
        The agent skills markdown content, serialized as descriptor payload data.
        
        dataSchemaVersion (string) –
        
        The schema version of the descriptor payload.
        
        source (dict) –
        
        The source location from which the agent skills markdown content was retrieved.
        
        fromUrl (dict) –
        
        The URL-based descriptor source, populated when descriptor content is synchronized from a URL.
        
        url (string) –
        
        The URL from which the descriptor content is retrieved.
      - custom (dict) –
        
        The custom descriptor, populated when the record type is CUSTOM.
        
        data (string) –
        
        The custom descriptor content, serialized as descriptor payload data.
      - http (dict) –
        
        The HTTP descriptor, populated when the record exposes an HTTP endpoint.
        
        source (dict) –
        
        The source location of the HTTP endpoint.
        
        fromUrl (dict) –
        
        The URL-based descriptor source, populated when descriptor content is synchronized from a URL.
        
        url (string) –
        
        The URL from which the descriptor content is retrieved.
      - agui (dict) –
        
        The AG-UI descriptor, populated when the record exposes an AG-UI protocol endpoint.
        
        source (dict) –
        
        The source location of the AG-UI protocol endpoint.
        
        fromUrl (dict) –
        
        The URL-based descriptor source, populated when descriptor content is synchronized from a URL.
        
        url (string) –
        
        The URL from which the descriptor content is retrieved.
    - recordVersion (string) –
      
      The version identifier of the registry record.
    - status (string) –
      
      The lifecycle status of the registry record. A record is DRAFT before it is submitted, PENDING_APPROVAL while awaiting curator review, and APPROVED once it is approved and discoverable. REJECTED and DEPRECATED records are not discoverable. The CREATING, UPDATING, CREATE_FAILED, and UPDATE_FAILED values 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.
- 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) –
      
      The identifier of the registry the record was requested from, echoed from the request.
    - recordId (string) –
      
      The identifier of the record that could not be retrieved, echoed from the request in the same format that you supplied (ARN or record ID).
    - 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