registry_records

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

Overview

Name	`registry_records`
Type	Resource
Id	`aws.bedrock_agentcore_control.registry_records`

Fields

The following fields are returned by SELECT queries:

get_registry_record
list_registry_records

Name	Datatype	Description
`name`	`string`	The name of the registry record. (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`	The description of the registry record.
`descriptor_type`	`string`	The descriptor type of the registry record. Possible values are MCP, A2A, CUSTOM, and AGENT_SKILLS. (MCP, A2A, CUSTOM, AGENT_SKILLS)
`descriptors`	`object`	Contains descriptor-type-specific configurations for a registry record. Only the descriptor matching the record's descriptorType should be populated.
`record_arn`	`string`	The Amazon Resource Name (ARN) of the registry record. (pattern: <code>arn:aws(-[^:]+)?:bedrock-agentcore:[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_version`	`string`	The version of the registry record. (pattern: <code>[a-zA-Z0-9.-]+</code>)
`registry_arn`	`string`	The Amazon Resource Name (ARN) of the registry that contains the record. (pattern: <code>arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:registry/[a-zA-Z0-9]{12,16}</code>)
`status`	`string`	The current status of the registry record. Possible values include CREATING, DRAFT, APPROVED, PENDING_APPROVAL, REJECTED, DEPRECATED, UPDATING, CREATE_FAILED, and UPDATE_FAILED. A record transitions from CREATING to DRAFT, then to PENDING_APPROVAL (via SubmitRegistryRecordForApproval), and finally to APPROVED upon approval. (DRAFT, PENDING_APPROVAL, APPROVED, REJECTED, DEPRECATED, CREATING, UPDATING, CREATE_FAILED, UPDATE_FAILED)
`status_reason`	`string`	The reason for the current status, typically set when the status is a failure state.
`synchronization_configuration`	`object`	Configuration for synchronizing registry record metadata from an external source.
`synchronization_type`	`string`	The type of synchronization used for this record. (URL)
`updated_at`	`string (date-time)`	The timestamp when the registry record was last updated.

Name	Datatype	Description
`name`	`string`	The name of the registry record. (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`	The description of the registry record.
`descriptor_type`	`string`	The descriptor type of the registry record. Possible values are MCP, A2A, CUSTOM, and AGENT_SKILLS. (MCP, A2A, CUSTOM, AGENT_SKILLS)
`record_arn`	`string`	The Amazon Resource Name (ARN) of the registry record. (pattern: <code>arn:aws(-[^:]+)?:bedrock-agentcore:[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_version`	`string`	The version of the registry record. (pattern: <code>[a-zA-Z0-9.-]+</code>)
`registry_arn`	`string`	The Amazon Resource Name (ARN) of the registry that contains the record. (pattern: <code>arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:registry/[a-zA-Z0-9]{12,16}</code>)
`status`	`string`	The current status of the registry record. Possible values include CREATING, DRAFT, APPROVED, PENDING_APPROVAL, REJECTED, DEPRECATED, UPDATING, CREATE_FAILED, and UPDATE_FAILED. (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 information about a specific registry record.
`list_registry_records`	`select`	`registry_id`, `region`	`maxResults`, `nextToken`, `name`, `status`, `descriptorType`	Lists registry records within a registry. You can optionally filter results using the name, status, and descriptorType parameters. When multiple filters are specified, they are combined using AND logic.
`create_registry_record`	`insert`	`registry_id`, `region`, `name`, `descriptorType`		Creates a new registry record within the specified registry. A registry record represents an individual AI resource's metadata in the registry. This could be an MCP server (and associated tools), A2A agent, agent skill, or a custom resource with a custom schema. The record is processed asynchronously and returns HTTP 202 Accepted.
`update_registry_record_status`	`update`	`registry_id`, `record_id`, `region`, `status`, `statusReason`		Updates the status of a registry record. Use this operation to approve, reject, or deprecate a registry record.
`update_registry_record`	`update`	`registry_id`, `record_id`, `region`		Updates an existing registry record. This operation uses PATCH semantics, so you only need to specify the fields you want to change. The update is processed asynchronously and returns HTTP 202 Accepted.
`delete_registry_record`	`delete`	`registry_id`, `record_id`, `region`		Deletes a registry record. The record's status transitions to DELETING and the record is removed asynchronously.
`submit_registry_record_for_approval`	`exec`	`registry_id`, `record_id`, `region`		Submits a registry record for approval. This transitions the record from DRAFT status to PENDING_APPROVAL status. If the registry has auto-approval enabled, the record is automatically approved.

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. You can specify either the Amazon Resource Name (ARN) or the ID of the record.
`region`	`string`	AWS region (default: us-east-1)
`registry_id`	`string`	The identifier of the registry containing the record. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.
`descriptorType`	`string`	Filter registry records by their descriptor type. Possible values are MCP, A2A, CUSTOM, and AGENT_SKILLS.
`maxResults`	`integer`	The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
`name`	`string`	Filter registry records by name.
`nextToken`	`string`	If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
`status`	`string`	Filter registry records by their current status. Possible values include CREATING, DRAFT, APPROVED, PENDING_APPROVAL, REJECTED, DEPRECATED, UPDATING, CREATE_FAILED, and UPDATE_FAILED.

`SELECT` examples

get_registry_record
list_registry_records

Retrieves information about a specific registry record.

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

Lists registry records within a registry. You can optionally filter results using the name, status, and descriptorType parameters. When multiple filters are specified, they are combined using AND logic.

SELECT
name,
created_at,
description,
descriptor_type,
record_arn,
record_id,
record_version,
registry_arn,
status,
updated_at
FROM aws.bedrock_agentcore_control.registry_records
WHERE registry_id = '{{ registry_id }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND name = '{{ name }}'
AND status = '{{ status }}'
AND descriptorType = '{{ descriptorType }}'
;

`INSERT` examples

create_registry_record
Manifest

Creates a new registry record within the specified registry. A registry record represents an individual AI resource's metadata in the registry. This could be an MCP server (and associated tools), A2A agent, agent skill, or a custom resource with a custom schema. The record is processed asynchronously and returns HTTP 202 Accepted.

INSERT INTO aws.bedrock_agentcore_control.registry_records (
name,
description,
descriptorType,
descriptors,
recordVersion,
synchronizationType,
synchronizationConfiguration,
clientToken,
registry_id,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ description }}',
'{{ descriptorType }}' /* required */,
'{{ descriptors }}',
'{{ recordVersion }}',
'{{ synchronizationType }}',
'{{ synchronizationConfiguration }}',
'{{ clientToken }}',
'{{ registry_id }}',
'{{ region }}'
RETURNING
record_arn,
status
;

# 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 }}"
  - name: description
    value: "{{ description }}"
  - name: descriptorType
    value: "{{ descriptorType }}"
    valid_values: ['MCP', 'A2A', 'CUSTOM', 'AGENT_SKILLS']
  - name: descriptors
    description: |
      Contains descriptor-type-specific configurations for a registry record. Only the descriptor matching the record's descriptorType should be populated.
    value:
      mcp:
        server:
          schemaVersion: "{{ schemaVersion }}"
          inlineContent: "{{ inlineContent }}"
        tools:
          protocolVersion: "{{ protocolVersion }}"
          inlineContent: "{{ inlineContent }}"
      a2a:
        agentCard:
          schemaVersion: "{{ schemaVersion }}"
          inlineContent: "{{ inlineContent }}"
      custom:
        inlineContent: "{{ inlineContent }}"
      agentSkills:
        skillMd:
          inlineContent: "{{ inlineContent }}"
        skillDefinition:
          schemaVersion: "{{ schemaVersion }}"
          inlineContent: "{{ inlineContent }}"
  - name: recordVersion
    value: "{{ recordVersion }}"
  - name: synchronizationType
    value: "{{ synchronizationType }}"
    valid_values: ['URL']
  - name: synchronizationConfiguration
    description: |
      Configuration for synchronizing registry record metadata from an external source.
    value:
      fromUrl:
        url: "{{ url }}"
        credentialProviderConfigurations:
          - credentialProviderType: "{{ credentialProviderType }}"
            credentialProvider:
              oauthCredentialProvider:
                providerArn: "{{ providerArn }}"
                grantType: "{{ grantType }}"
                scopes: "{{ scopes }}"
                customParameters: "{{ customParameters }}"
              iamCredentialProvider:
                roleArn: "{{ roleArn }}"
                service: "{{ service }}"
                region: "{{ region }}"
  - name: clientToken
    value: "{{ clientToken }}"

`UPDATE` examples

update_registry_record_status
update_registry_record

Updates the status of a registry record. Use this operation to approve, reject, or deprecate a registry record.

UPDATE aws.bedrock_agentcore_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;

Updates an existing registry record. This operation uses PATCH semantics, so you only need to specify the fields you want to change. The update is processed asynchronously and returns HTTP 202 Accepted.

UPDATE aws.bedrock_agentcore_control.registry_records
SET 
name = '{{ name }}',
description = '{{ description }}',
descriptorType = '{{ descriptorType }}',
descriptors = '{{ descriptors }}',
recordVersion = '{{ recordVersion }}',
synchronizationType = '{{ synchronizationType }}',
synchronizationConfiguration = '{{ synchronizationConfiguration }}',
triggerSynchronization = {{ triggerSynchronization }}
WHERE 
registry_id = '{{ registry_id }}' --required
AND record_id = '{{ record_id }}' --required
AND region = '{{ region }}' --required
RETURNING
name,
created_at,
description,
descriptor_type,
descriptors,
record_arn,
record_id,
record_version,
registry_arn,
status,
status_reason,
synchronization_configuration,
synchronization_type,
updated_at;

`DELETE` examples

delete_registry_record

Deletes a registry record. The record's status transitions to DELETING and the record is removed asynchronously.

DELETE FROM aws.bedrock_agentcore_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 registry record for approval. This transitions the record from DRAFT status to PENDING_APPROVAL status. If the registry has auto-approval enabled, the record is automatically approved.

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

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​

Lifecycle Methods​