AgentRegistry / Paginator / ListDiscoverableRegistryRecords

ListDiscoverableRegistryRecords

class AgentRegistry.Paginator.ListDiscoverableRegistryRecords

paginator = client.get_paginator('list_discoverable_registry_records')

paginate(**kwargs)

Creates an iterator that will paginate through responses from AgentRegistry.Client.list_discoverable_registry_records().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    registryId='string',
    filters=[
        {
            'name': 'recordType'|'descriptorType',
            'values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': '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.

• filters (list) –

  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.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

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

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

      • 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) –

    A token to resume pagination.