AgentRegistryControl / Client / list_registry_records

list_registry_records¶

AgentRegistryControl.Client.list_registry_records(**kwargs)¶

Lists the registry records within a registry, with optional filtering by name, status, and record type

Request Syntax

response = client.list_registry_records(
    registryId='string',
    maxResults=123,
    nextToken='string',
    filters=[
        {
            'name': 'name'|'status'|'recordType',
            'values': [
                'string',
            ]
        },
    ]
)

Parameters:

registryId (string) –
[REQUIRED]

The identifier of the registry to list records from (ARN or ID)
maxResults (integer) – Maximum number of records to return
nextToken (string) – Token for pagination
filters (list) –
Filters to apply to the registry record list
- (dict) –
  
  A single filter applied to a ListRegistryRecords 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.

Return type:

dict

Returns:

Response Syntax

{
    'registryRecords': [
        {
            'registryArn': 'string',
            'recordArn': 'string',
            'recordId': 'string',
            'name': 'string',
            'displayName': 'string',
            'description': '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) –

Response structure for listing registry records
- registryRecords (list) –
  
  List of registry record summaries
  - (dict) –
    
    A summary of a registry record returned by list operations. Contains identifying and lifecycle fields but omits descriptor content.
    - registryArn (string) –
      
      The &ARN; of the parent registry that owns the record.
    - recordArn (string) –
      
      The &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.
    - displayName (string) –
      
      The human-readable display name of the registry record.
    - description (string) –
      
      A description of the registry record.
    - recordType (string) –
      
      The type of the registry record, such as MCP, AGENT, SKILL, or CUSTOM.
    - recordVersion (string) –
      
      The version identifier of the registry record.
    - status (string) –
      
      The lifecycle status of the registry record.
    - createdAt (datetime) –
      
      The timestamp when the registry record was created.
    - updatedAt (datetime) –
      
      The timestamp when the registry record was last updated.
- nextToken (string) –
  
  Token for next page of results

Exceptions

AgentRegistryControl.Client.exceptions.InternalServerException
AgentRegistryControl.Client.exceptions.AccessDeniedException
AgentRegistryControl.Client.exceptions.ResourceNotFoundException
AgentRegistryControl.Client.exceptions.ThrottlingException
AgentRegistryControl.Client.exceptions.ValidationException
AgentRegistryControl.Client.exceptions.ConflictException