registry_records

Creates, updates, deletes, gets or lists a registry_records resource.

Overview

Name	registry_records
Type	Resource
Id	aws.agent_registry_control.registry_records

Fields

The following fields are returned by SELECT queries:

get_registry_record

Name	Datatype	Description
name	string	Registry Record name (pattern: <code>[a-zA-Z0-9][a-zA-Z0-9_-./]*</code>)
created_at	string (date-time)	The timestamp when the registry record was created.
description	string	Description of the Resource
descriptors	object	The typed set of descriptors for a registry record. Exactly one descriptor field is populated based on the record type.
display_name	string	Display name for a registry record
record_arn	string	The &ARN; of the registry record. (pattern: <code>arn:aws(-[^:]+)?:agent-registry:[a-z0-9-]+:[0-9]{12}:registry/[a-zA-Z0-9]{12,16}/record/[a-zA-Z0-9]{12}</code>)
record_id	string	The unique identifier of the registry record. (pattern: <code>[a-zA-Z0-9]{12}</code>)
record_type	string	Record type enum for registry record classification (MCP, AGENT, CUSTOM, SKILL)
record_version	string	Version of the registry record (pattern: <code>[a-zA-Z0-9.-]+</code>)
registry_arn	string	The &ARN; of the parent registry that owns the record. (pattern: <code>arn:aws(-[^:]+)?:agent-registry:[a-z0-9-]+:[0-9]{12}:registry/[a-zA-Z0-9]{12,16}</code>)
status	string	The lifecycle status of the registry record. (DRAFT, PENDING_APPROVAL, APPROVED, REJECTED, DEPRECATED, CREATING, UPDATING, CREATE_FAILED, UPDATE_FAILED)
status_reason	string	The reason for the current status. Typically populated when the status indicates a failure state.
updated_at	string (date-time)	The timestamp when the registry record was last updated.

list_registry_records

Name	Datatype	Description
name	string	Registry Record name (pattern: <code>[a-zA-Z0-9][a-zA-Z0-9_-./]*</code>)
created_at	string (date-time)	The timestamp when the registry record was created.
description	string	Description of the Resource
display_name	string	Display name for a registry record
record_arn	string	The &ARN; of the registry record. (pattern: <code>arn:aws(-[^:]+)?:agent-registry:[a-z0-9-]+:[0-9]{12}:registry/[a-zA-Z0-9]{12,16}/record/[a-zA-Z0-9]{12}</code>)
record_id	string	The unique identifier of the registry record. (pattern: <code>[a-zA-Z0-9]{12}</code>)
record_type	string	Record type enum for registry record classification (MCP, AGENT, CUSTOM, SKILL)
record_version	string	Version of the registry record (pattern: <code>[a-zA-Z0-9.-]+</code>)
registry_arn	string	The &ARN; of the parent registry that owns the record. (pattern: <code>arn:aws(-[^:]+)?:agent-registry:[a-z0-9-]+:[0-9]{12}:registry/[a-zA-Z0-9]{12,16}</code>)
status	string	The lifecycle status of the registry record. (DRAFT, PENDING_APPROVAL, APPROVED, REJECTED, DEPRECATED, CREATING, UPDATING, CREATE_FAILED, UPDATE_FAILED)
updated_at	string (date-time)	The timestamp when the registry record was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_registry_record	select	registry_id, record_id, region		Retrieves the details of a registry record
list_registry_records	select	registry_id, region		Lists the registry records within a registry, with optional filtering by name, status, and record type
create_registry_record	insert	registry_id, region, name, recordType, descriptors		Creates a registry record within a registry. A registry record describes a discoverable resource, such as an MCP server, an agent, an agent skill, or a custom resource. Creation is asynchronous: the record is returned with the CREATING status while it is processed.
update_registry_record_status	update	registry_id, record_id, region, status, statusReason		Updates the status of a registry record as part of the registry's curation workflow, for example to approve or reject a record that is pending approval, or to deprecate an approved record so that it is no longer discoverable
update_registry_record	update	registry_id, record_id, region		Updates a registry record. The update is asynchronous: the record is returned with the UPDATING status while it is processed. Fields that use update wrappers follow PATCH semantics: omit the field to leave it unchanged.
delete_registry_record	delete	registry_id, record_id, region		Deletes a registry record
submit_registry_record_for_approval	exec	registry_id, record_id, region		Submits a DRAFT registry record for approval, moving it into the registry's approval workflow. Depending on the registry's approval configuration, the record is either auto-approved or set to PENDING_APPROVAL for a curator to approve or reject.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
record_id	string	The identifier of the registry record to submit for approval (ARN or ID)
region	string	AWS region (default: us-east-1)
registry_id	string	The identifier of the registry containing the record (ARN or ID)

SELECT examples

get_registry_record

Retrieves the details of a registry record

SELECT
name,
created_at,
description,
descriptors,
display_name,
record_arn,
record_id,
record_type,
record_version,
registry_arn,
status,
status_reason,
updated_at
FROM aws.agent_registry_control.registry_records
WHERE registry_id = '{{ registry_id }}' -- required
AND record_id = '{{ record_id }}' -- required
AND region = '{{ region }}' -- required
;

list_registry_records

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

SELECT
name,
created_at,
description,
display_name,
record_arn,
record_id,
record_type,
record_version,
registry_arn,
status,
updated_at
FROM aws.agent_registry_control.registry_records
WHERE registry_id = '{{ registry_id }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_registry_record

Creates a registry record within a registry. A registry record describes a discoverable resource, such as an MCP server, an agent, an agent skill, or a custom resource. Creation is asynchronous: the record is returned with the CREATING status while it is processed.

INSERT INTO aws.agent_registry_control.registry_records (
name,
displayName,
description,
recordType,
descriptors,
recordVersion,
clientToken,
tags,
registry_id,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ displayName }}',
'{{ description }}',
'{{ recordType }}' /* required */,
'{{ descriptors }}' /* required */,
'{{ recordVersion }}',
'{{ clientToken }}',
'{{ tags }}',
'{{ registry_id }}',
'{{ region }}'
RETURNING
record_arn,
status
;

Manifest

# Description fields are for documentation purposes
- name: registry_records
props:
  - name: registry_id
    value: "{{ registry_id }}"
    description: Required parameter for the registry_records resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the registry_records resource.
  - name: name
    value: "{{ name }}"
    description: |
      Registry Record name
  - name: displayName
    value: "{{ displayName }}"
    description: |
      Display name for a registry record
  - name: description
    value: "{{ description }}"
    description: |
      Description of the Resource
  - name: recordType
    value: "{{ recordType }}"
    description: |
      Record type enum for registry record classification
    valid_values: ['MCP', 'AGENT', 'CUSTOM', 'SKILL']
  - name: descriptors
    description: |
      The typed set of descriptors for a registry record. Exactly one descriptor field is populated based on the record type.
    value:
      mcpServer:
        data: "{{ data }}"
        dataSchemaVersion: "{{ dataSchemaVersion }}"
        additionalData:
          tools:
            data: "{{ data }}"
            dataSchemaVersion: "{{ dataSchemaVersion }}"
        source:
          fromUrl:
            url: "{{ url }}"
            credentialProviderConfigurations:
              - credentialProviderType: "{{ credentialProviderType }}"
                credentialProvider:
                  oauthCredentialProvider: "{{ oauthCredentialProvider }}"
                  iamCredentialProvider: "{{ iamCredentialProvider }}"
      a2aAgentCard:
        data: "{{ data }}"
        dataSchemaVersion: "{{ dataSchemaVersion }}"
        source:
          fromUrl:
            url: "{{ url }}"
            credentialProviderConfigurations:
              - credentialProviderType: "{{ credentialProviderType }}"
                credentialProvider:
                  oauthCredentialProvider: "{{ oauthCredentialProvider }}"
                  iamCredentialProvider: "{{ iamCredentialProvider }}"
      agentSkillsDefinition:
        data: "{{ data }}"
        dataSchemaVersion: "{{ dataSchemaVersion }}"
        additionalData:
          skillMd:
            data: "{{ data }}"
            dataSchemaVersion: "{{ dataSchemaVersion }}"
            source:
              fromUrl: "{{ fromUrl }}"
      custom:
        data: "{{ data }}"
  - name: recordVersion
    value: "{{ recordVersion }}"
    description: |
      Version of the registry record
  - name: clientToken
    value: "{{ clientToken }}"
    description: |
      Client specified token used for idempotency checks
  - name: tags
    value: "{{ tags }}"
    description: |
      A map of tag keys to tag values.

UPDATE examples

update_registry_record_status

Updates the status of a registry record as part of the registry's curation workflow, for example to approve or reject a record that is pending approval, or to deprecate an approved record so that it is no longer discoverable

UPDATE aws.agent_registry_control.registry_records
SET 
status = '{{ status }}',
statusReason = '{{ statusReason }}'
WHERE 
registry_id = '{{ registry_id }}' --required
AND record_id = '{{ record_id }}' --required
AND region = '{{ region }}' --required
AND status = '{{ status }}' --required
AND statusReason = '{{ statusReason }}' --required
RETURNING
record_arn,
record_id,
registry_arn,
status,
status_reason,
updated_at;

update_registry_record

Updates a registry record. The update is asynchronous: the record is returned with the UPDATING status while it is processed. Fields that use update wrappers follow PATCH semantics: omit the field to leave it unchanged.

UPDATE aws.agent_registry_control.registry_records
SET 
name = '{{ name }}',
displayName = '{{ displayName }}',
description = '{{ description }}',
recordType = '{{ recordType }}',
descriptors = '{{ descriptors }}',
recordVersion = '{{ recordVersion }}',
triggerSynchronization = {{ triggerSynchronization }}
WHERE 
registry_id = '{{ registry_id }}' --required
AND record_id = '{{ record_id }}' --required
AND region = '{{ region }}' --required
RETURNING
name,
created_at,
description,
descriptors,
display_name,
record_arn,
record_id,
record_type,
record_version,
registry_arn,
status,
status_reason,
updated_at;

DELETE examples

delete_registry_record

Deletes a registry record

DELETE FROM aws.agent_registry_control.registry_records
WHERE registry_id = '{{ registry_id }}' --required
AND record_id = '{{ record_id }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

submit_registry_record_for_approval

Submits a DRAFT registry record for approval, moving it into the registry's approval workflow. Depending on the registry's approval configuration, the record is either auto-approved or set to PENDING_APPROVAL for a curator to approve or reject.

EXEC aws.agent_registry_control.registry_records.submit_registry_record_for_approval 
@registry_id='{{ registry_id }}' --required, 
@record_id='{{ record_id }}' --required, 
@region='{{ region }}' --required
;