Skip to main content

registries

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

Overview

Nameregistries
TypeResource
Idaws.bedrock_agentcore_control.registries

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
namestringThe name of the registry. (pattern: <code>[a-zA-Z0-9][a-zA-Z0-9_-./]*</code>)
approval_configurationobjectConfiguration for the registry record approval workflow. Controls whether records added to the registry require explicit approval before becoming active.
authorizer_configurationobjectRepresents inbound authorization configuration options used to authenticate incoming requests.
authorizer_typestringThe type of authorizer used by the registry. This controls the authorization method for the Search and Invoke APIs used by consumers. CUSTOM_JWT - Authorize with a bearer token. AWS_IAM - Authorize with your Amazon Web Services IAM credentials. (CUSTOM_JWT, AWS_IAM)
created_atstring (date-time)The timestamp when the registry was created.
descriptionstringThe description of the registry.
registry_arnstringThe Amazon Resource Name (ARN) of the registry. (pattern: <code>arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:registry/[a-zA-Z0-9]{12,16}</code>)
registry_idstringThe unique identifier of the registry. (pattern: <code>[a-zA-Z0-9]{12,16}</code>)
statusstringThe current status of the registry. Possible values include CREATING, READY, UPDATING, CREATE_FAILED, UPDATE_FAILED, DELETING, and DELETE_FAILED. (CREATING, READY, UPDATING, CREATE_FAILED, UPDATE_FAILED, DELETING, DELETE_FAILED)
status_reasonstringThe reason for the current status, typically set when the status is a failure state.
updated_atstring (date-time)The timestamp when the registry was last updated.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_registryselectregistry_id, regionRetrieves information about a specific registry.
list_registriesselectregionmaxResults, nextToken, status, authorizerTypeLists all registries in the account. You can optionally filter results by status using the status parameter, or by authorizer type using the authorizerType parameter.
create_registryinsertregion, nameCreates a new registry in your Amazon Web Services account. A registry serves as a centralized catalog for organizing and managing registry records, including MCP servers, A2A agents, agent skills, and custom resource types. If you specify CUSTOM_JWT as the authorizerType, you must provide an authorizerConfiguration.
update_registryupdateregistry_id, regionUpdates an existing registry. This operation uses PATCH semantics, so you only need to specify the fields you want to change.
delete_registrydeleteregistry_id, regionDeletes a registry. The registry must contain zero records before it can be deleted. This operation initiates the deletion process asynchronously.

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.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)
registry_idstringThe identifier of the registry to delete. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.
authorizerTypestringFilter registries by their authorizer type. Possible values are CUSTOM_JWT and AWS_IAM. For more information about authorizer types, see the RegistryAuthorizerType enum.
maxResultsintegerThe 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.
nextTokenstringIf 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.
statusstringFilter registries by their current status. Possible values include CREATING, READY, UPDATING, CREATE_FAILED, UPDATE_FAILED, DELETING, and DELETE_FAILED.

SELECT examples

Retrieves information about a specific registry.

SELECT
name,
approval_configuration,
authorizer_configuration,
authorizer_type,
created_at,
description,
registry_arn,
registry_id,
status,
status_reason,
updated_at
FROM aws.bedrock_agentcore_control.registries
WHERE registry_id = '{{ registry_id }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

Creates a new registry in your Amazon Web Services account. A registry serves as a centralized catalog for organizing and managing registry records, including MCP servers, A2A agents, agent skills, and custom resource types. If you specify CUSTOM_JWT as the authorizerType, you must provide an authorizerConfiguration.

INSERT INTO aws.bedrock_agentcore_control.registries (
name,
description,
authorizerType,
authorizerConfiguration,
clientToken,
approvalConfiguration,
region
)
SELECT
'{{ name }}' /* required */,
'{{ description }}',
'{{ authorizerType }}',
'{{ authorizerConfiguration }}',
'{{ clientToken }}',
'{{ approvalConfiguration }}',
'{{ region }}'
RETURNING
registry_arn
;

UPDATE examples

Updates an existing registry. This operation uses PATCH semantics, so you only need to specify the fields you want to change.

UPDATE aws.bedrock_agentcore_control.registries
SET
name = '{{ name }}',
description = '{{ description }}',
authorizerConfiguration = '{{ authorizerConfiguration }}',
approvalConfiguration = '{{ approvalConfiguration }}'
WHERE
registry_id = '{{ registry_id }}' --required
AND region = '{{ region }}' --required
RETURNING
name,
approval_configuration,
authorizer_configuration,
authorizer_type,
created_at,
description,
registry_arn,
registry_id,
status,
status_reason,
updated_at;

DELETE examples

Deletes a registry. The registry must contain zero records before it can be deleted. This operation initiates the deletion process asynchronously.

DELETE FROM aws.bedrock_agentcore_control.registries
WHERE registry_id = '{{ registry_id }}' --required
AND region = '{{ region }}' --required
;