2026/09/28 - Agent Registry Control - 7 updated api methods
Changes AWS Agent Registry adds support for custom metadata. Discovery APIs now return custom metadata on registry records and support filtering by metadata fields. Semantic search includes custom metadata for improved relevance. Filter customMetadata fields using eq, ne, and in operators.
{'customMetadataSchemaConfiguration': {'defaultSchema': 'string',
'recordTypeSchemaOverrides': [{'recordType': 'MCP '
'| '
'AGENT '
'| '
'CUSTOM '
'| '
'SKILL '
'| '
'GATEWAY',
'schema': 'string'}]}}
Creates a new registry, a catalog that organizes registry records and defines their discovery authorization and record approval behavior. Creation is asynchronous: the registry begins in the CREATING status and becomes usable once it reaches READY.
See also: AWS API Documentation
Request Syntax
client.create_registry(
name='string',
description='string',
encryptionConfiguration={
'kmsKeyArn': 'string'
},
discoveryConfiguration={
'authorizerConfiguration': {
'customJWTAuthorizer': {
'discoveryUrl': 'string',
'allowedAudience': [
'string',
],
'allowedClients': [
'string',
],
'allowedScopes': [
'string',
],
'customClaims': [
{
'inboundTokenClaimName': 'string',
'inboundTokenClaimValueType': 'STRING'|'STRING_ARRAY',
'authorizingClaimMatchValue': {
'claimMatchValue': {
'matchValueString': 'string',
'matchValueStringList': [
'string',
]
},
'claimMatchOperator': 'EQUALS'|'CONTAINS'|'CONTAINS_ANY'
}
},
],
'privateEndpoint': {
'selfManagedLatticeResource': {
'resourceConfigurationIdentifier': 'string'
},
'managedVpcResource': {
'vpcIdentifier': 'string',
'subnetIds': [
'string',
],
'endpointIpAddressType': 'IPV4'|'IPV6',
'securityGroupIds': [
'string',
],
'tags': {
'string': 'string'
},
'routingDomain': 'string'
}
},
'privateEndpointOverrides': [
{
'domain': 'string',
'privateEndpoint': {
'selfManagedLatticeResource': {
'resourceConfigurationIdentifier': 'string'
},
'managedVpcResource': {
'vpcIdentifier': 'string',
'subnetIds': [
'string',
],
'endpointIpAddressType': 'IPV4'|'IPV6',
'securityGroupIds': [
'string',
],
'tags': {
'string': 'string'
},
'routingDomain': 'string'
}
}
},
]
}
},
'authorizerType': 'CUSTOM_JWT'|'AWS_IAM'
},
clientToken='string',
tags={
'string': 'string'
},
approvalConfiguration={
'autoApprovalRules': [
'APPROVE_ALL',
]
},
customMetadataSchemaConfiguration={
'defaultSchema': 'string',
'recordTypeSchemaOverrides': [
{
'recordType': 'MCP'|'AGENT'|'CUSTOM'|'SKILL'|'GATEWAY',
'schema': 'string'
},
]
},
autoDetectionConfiguration={
'scope': 'ORGANIZATION',
'enabled': True|False
}
)
string
[REQUIRED]
The name of the registry
string
The description of the registry
dict
The optional server-side encryption configuration for the registry. When you provide this field, the specified customer-managed Amazon Web Services KMS key encrypts the registry's content. Omit this field to use an Amazon Web Services-owned encryption key. You cannot change the encryption configuration after registry creation.
kmsKeyArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the customer-managed Amazon Web Services KMS key used to encrypt the registry's content. The key must be a symmetric encryption key in the same Amazon Web Services account and Region as the registry.
dict
Discovery configuration for the registry
authorizerConfiguration (dict) --
The authorizer configuration for the registry. Required when authorizerType is CUSTOM_JWT.
customJWTAuthorizer (dict) --
Configuration for a custom JWT authorizer.
discoveryUrl (string) -- [REQUIRED]
The OpenID Connect discovery URL used to retrieve the identity provider's metadata and signing keys.
allowedAudience (list) --
The audience values accepted during JWT validation. A token is rejected if none of its audience claims match.
(string) --
An audience value that an inbound JWT must contain to be authorized.
allowedClients (list) --
The client identifiers accepted during JWT validation. A token is rejected if it was not issued to one of these clients.
(string) --
A client identifier that an inbound JWT must be issued to in order to be authorized.
allowedScopes (list) --
The scopes accepted during JWT validation. A token is rejected if it does not carry one of these scopes.
(string) --
A scope value that an inbound JWT must carry to be authorized.
customClaims (list) --
Additional custom claim validations applied to the inbound JWT.
(dict) --
A validation rule applied to a single claim of an inbound JWT.
inboundTokenClaimName (string) -- [REQUIRED]
The name of the claim in the inbound token to validate.
inboundTokenClaimValueType (string) -- [REQUIRED]
The value type of the claim in the inbound token, either a string or an array of strings.
authorizingClaimMatchValue (dict) -- [REQUIRED]
The value and match operator used to authorize the claim.
claimMatchValue (dict) -- [REQUIRED]
The expected value or values that the claim is compared against.
matchValueString (string) --
A single string value to match the claim against.
matchValueStringList (list) --
A list of string values to match the claim against.
(string) --
A single value used to match a claim during JWT validation.
claimMatchOperator (string) -- [REQUIRED]
The operator used to compare the claim value against the expected value.
privateEndpoint (dict) --
The private endpoint used to reach the identity provider's discovery URL over a private network path.
selfManagedLatticeResource (dict) --
A private endpoint backed by a self-managed VPC Lattice resource configuration.
resourceConfigurationIdentifier (string) --
The identifier of the VPC Lattice resource configuration, specified as a resource configuration ID or ARN.
managedVpcResource (dict) --
A private endpoint backed by a service-managed VPC resource.
vpcIdentifier (string) -- [REQUIRED]
The identifier of the VPC in which the private endpoint is provisioned.
subnetIds (list) -- [REQUIRED]
The identifiers of the subnets in which the private endpoint network interfaces are placed.
(string) --
Subnet identifier
endpointIpAddressType (string) -- [REQUIRED]
The IP address type used by the private endpoint, either IPV4 or IPV6.
securityGroupIds (list) --
The identifiers of the security groups associated with the private endpoint network interfaces.
(string) --
The identifier of a security group.
tags (dict) --
The tags applied to the service-managed VPC resource.
(string) --
Key of a tag.
(string) --
Value of a tag.
routingDomain (string) --
The routing domain used to resolve traffic through the private endpoint.
privateEndpointOverrides (list) --
Per-domain private endpoint overrides that route specific identity provider domains through distinct private endpoints.
(dict) --
A mapping of a domain to the private endpoint used to reach it.
domain (string) -- [REQUIRED]
The domain name to which this private endpoint override applies.
privateEndpoint (dict) -- [REQUIRED]
The private endpoint used to reach the specified domain.
selfManagedLatticeResource (dict) --
A private endpoint backed by a self-managed VPC Lattice resource configuration.
resourceConfigurationIdentifier (string) --
The identifier of the VPC Lattice resource configuration, specified as a resource configuration ID or ARN.
managedVpcResource (dict) --
A private endpoint backed by a service-managed VPC resource.
vpcIdentifier (string) -- [REQUIRED]
The identifier of the VPC in which the private endpoint is provisioned.
subnetIds (list) -- [REQUIRED]
The identifiers of the subnets in which the private endpoint network interfaces are placed.
(string) --
Subnet identifier
endpointIpAddressType (string) -- [REQUIRED]
The IP address type used by the private endpoint, either IPV4 or IPV6.
securityGroupIds (list) --
The identifiers of the security groups associated with the private endpoint network interfaces.
(string) --
The identifier of a security group.
tags (dict) --
The tags applied to the service-managed VPC resource.
(string) --
Key of a tag.
(string) --
Value of a tag.
routingDomain (string) --
The routing domain used to resolve traffic through the private endpoint.
authorizerType (string) --
The type of authorizer that controls how consumers access the registry's search and MCP invoke operations.
string
A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the service ignores the request, but does not return an error.
This field is autopopulated if not provided.
dict
Tags to associate with the registry
(string) --
Key of a tag.
(string) --
Value of a tag.
dict
Approval configuration for registry records
autoApprovalRules (list) --
The rules that determine which registry records are automatically approved on submission. When omitted or empty, submitted records require manual review.
(string) --
dict
The optional custom metadata schema configuration for the registry. When provided, registry records can carry structured metadata validated against this schema.
defaultSchema (string) --
The default JSON Schema that applies to record types without a specific override. Supported property types are string, string with an enum constraint, string with a uri format, and boolean.
recordTypeSchemaOverrides (list) --
A list of per-record-type schema overrides. When a record's type matches an override, that override's schema is used instead of the default schema for validation. If you don't specify an override for a record type, the default schema applies. If no default schema exists, custom metadata on records of that type is rejected.
(dict) --
A schema override for a specific record type within a custom metadata schema configuration.
recordType (string) -- [REQUIRED]
The record type that this schema override applies to.
schema (string) -- [REQUIRED]
The JSON Schema for the specified record type. Must follow the same structural rules as the default schema.
dict
The optional auto-detection configuration for the registry. When provided, the registry is automatically populated with resources discovered according to the configuration. Omit this field for registries whose records are managed exclusively through the Agent Registry Control API.
scope (string) -- [REQUIRED]
The source from which resources are detected. For example, ORGANIZATION sources resources from all member accounts of an Amazon Web Services organization.
enabled (boolean) -- [REQUIRED]
Specifies whether auto-detection is requested for the registry. Setting this to true is necessary but not sufficient for auto-detection to become active; the preconditions of the configured scope must also be met.
dict
Response Syntax
{
'registryArn': 'string'
}
Response Structure
(dict) --
Response structure for creating a registry
registryArn (string) --
The ARN of the created registry
{'customMetadata': {}}
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.
See also: AWS API Documentation
Request Syntax
client.create_registry_record(
registryId='string',
name='string',
displayName='string',
description='string',
recordType='MCP'|'AGENT'|'CUSTOM'|'SKILL'|'GATEWAY',
descriptors={
'mcpServer': {
'data': 'string',
'dataSchemaVersion': 'string',
'additionalData': {
'tools': {
'data': 'string',
'dataSchemaVersion': 'string'
}
},
'source': {
'fromUrl': {
'url': 'string',
'credentialProviderConfigurations': [
{
'credentialProviderType': 'OAUTH'|'IAM',
'credentialProvider': {
'oauthCredentialProvider': {
'providerArn': 'string',
'grantType': 'CLIENT_CREDENTIALS',
'scopes': [
'string',
],
'customParameters': {
'string': 'string'
}
},
'iamCredentialProvider': {
'roleArn': 'string',
'service': 'string',
'region': 'string'
}
}
},
]
}
}
},
'a2aAgentCard': {
'data': 'string',
'dataSchemaVersion': 'string',
'source': {
'fromUrl': {
'url': 'string',
'credentialProviderConfigurations': [
{
'credentialProviderType': 'OAUTH'|'IAM',
'credentialProvider': {
'oauthCredentialProvider': {
'providerArn': 'string',
'grantType': 'CLIENT_CREDENTIALS',
'scopes': [
'string',
],
'customParameters': {
'string': 'string'
}
},
'iamCredentialProvider': {
'roleArn': 'string',
'service': 'string',
'region': 'string'
}
}
},
]
}
}
},
'agentSkillsDefinition': {
'data': 'string',
'dataSchemaVersion': 'string',
'additionalData': {
'skillMd': {
'data': 'string',
'dataSchemaVersion': 'string',
'source': {
'fromUrl': {
'url': 'string',
'credentialProviderConfigurations': [
{
'credentialProviderType': 'OAUTH'|'IAM',
'credentialProvider': {
'oauthCredentialProvider': {
'providerArn': 'string',
'grantType': 'CLIENT_CREDENTIALS',
'scopes': [
'string',
],
'customParameters': {
'string': 'string'
}
},
'iamCredentialProvider': {
'roleArn': 'string',
'service': 'string',
'region': 'string'
}
}
},
]
}
}
}
}
},
'custom': {
'data': 'string'
},
'http': {
'source': {
'fromUrl': {
'url': 'string',
'credentialProviderConfigurations': [
{
'credentialProviderType': 'OAUTH'|'IAM',
'credentialProvider': {
'oauthCredentialProvider': {
'providerArn': 'string',
'grantType': 'CLIENT_CREDENTIALS',
'scopes': [
'string',
],
'customParameters': {
'string': 'string'
}
},
'iamCredentialProvider': {
'roleArn': 'string',
'service': 'string',
'region': 'string'
}
}
},
]
}
}
},
'agui': {
'source': {
'fromUrl': {
'url': 'string',
'credentialProviderConfigurations': [
{
'credentialProviderType': 'OAUTH'|'IAM',
'credentialProvider': {
'oauthCredentialProvider': {
'providerArn': 'string',
'grantType': 'CLIENT_CREDENTIALS',
'scopes': [
'string',
],
'customParameters': {
'string': 'string'
}
},
'iamCredentialProvider': {
'roleArn': 'string',
'service': 'string',
'region': 'string'
}
}
},
]
}
}
}
},
recordVersion='string',
clientToken='string',
provenance=[
{
'relation': 'DETECTED_FROM',
'sourceId': 'string',
'sourceType': 'AWS::BedrockAgentCore::Runtime'|'AWS::BedrockAgentCore::Gateway',
'sourceDetails': {
'agentcoreRuntime': {
'protocolConfiguration': {
'serverProtocol': 'HTTP'|'A2A'|'MCP'|'AGUI'
},
'authorizerConfiguration': {
'customJWTAuthorizer': {
'discoveryUrl': 'string',
'allowedAudience': [
'string',
],
'allowedClients': [
'string',
],
'allowedScopes': [
'string',
],
'customClaims': [
{
'inboundTokenClaimName': 'string',
'inboundTokenClaimValueType': 'STRING'|'STRING_ARRAY',
'authorizingClaimMatchValue': {
'claimMatchValue': {
'matchValueString': 'string',
'matchValueStringList': [
'string',
]
},
'claimMatchOperator': 'EQUALS'|'CONTAINS'|'CONTAINS_ANY'
}
},
],
'privateEndpoint': {
'selfManagedLatticeResource': {
'resourceConfigurationIdentifier': 'string'
},
'managedVpcResource': {
'vpcIdentifier': 'string',
'subnetIds': [
'string',
],
'endpointIpAddressType': 'IPV4'|'IPV6',
'securityGroupIds': [
'string',
],
'tags': {
'string': 'string'
},
'routingDomain': 'string'
}
},
'privateEndpointOverrides': [
{
'domain': 'string',
'privateEndpoint': {
'selfManagedLatticeResource': {
'resourceConfigurationIdentifier': 'string'
},
'managedVpcResource': {
'vpcIdentifier': 'string',
'subnetIds': [
'string',
],
'endpointIpAddressType': 'IPV4'|'IPV6',
'securityGroupIds': [
'string',
],
'tags': {
'string': 'string'
},
'routingDomain': 'string'
}
}
},
]
}
},
'workloadIdentityDetails': {
'workloadIdentityArn': 'string'
}
},
'agentcoreGateway': {
'protocolType': 'MCP',
'authorizerType': 'string',
'authorizerConfiguration': {
'customJWTAuthorizer': {
'discoveryUrl': 'string',
'allowedAudience': [
'string',
],
'allowedClients': [
'string',
],
'allowedScopes': [
'string',
],
'customClaims': [
{
'inboundTokenClaimName': 'string',
'inboundTokenClaimValueType': 'STRING'|'STRING_ARRAY',
'authorizingClaimMatchValue': {
'claimMatchValue': {
'matchValueString': 'string',
'matchValueStringList': [
'string',
]
},
'claimMatchOperator': 'EQUALS'|'CONTAINS'|'CONTAINS_ANY'
}
},
],
'privateEndpoint': {
'selfManagedLatticeResource': {
'resourceConfigurationIdentifier': 'string'
},
'managedVpcResource': {
'vpcIdentifier': 'string',
'subnetIds': [
'string',
],
'endpointIpAddressType': 'IPV4'|'IPV6',
'securityGroupIds': [
'string',
],
'tags': {
'string': 'string'
},
'routingDomain': 'string'
}
},
'privateEndpointOverrides': [
{
'domain': 'string',
'privateEndpoint': {
'selfManagedLatticeResource': {
'resourceConfigurationIdentifier': 'string'
},
'managedVpcResource': {
'vpcIdentifier': 'string',
'subnetIds': [
'string',
],
'endpointIpAddressType': 'IPV4'|'IPV6',
'securityGroupIds': [
'string',
],
'tags': {
'string': 'string'
},
'routingDomain': 'string'
}
}
},
]
}
},
'workloadIdentityDetails': {
'workloadIdentityArn': 'string'
}
}
}
},
],
customMetadata={...}|[...]|123|123.4|'string'|True|None,
tags={
'string': 'string'
}
)
string
[REQUIRED]
The identifier of the registry in which to create the record (ARN or ID)
string
[REQUIRED]
The name of the registry record
string
The human-readable display name of the registry record
string
The description of the registry record
string
[REQUIRED]
The type of the registry record, which determines the descriptor format
dict
[REQUIRED]
The typed descriptor content for the registry record
mcpServer (dict) --
The MCP server descriptor, populated when the record type is MCP.
data (string) --
The MCP server descriptor content, serialized as descriptor payload data.
dataSchemaVersion (string) --
The schema version of the descriptor payload.
additionalData (dict) --
Additional data associated with the MCP server descriptor, such as tool definitions.
tools (dict) --
The MCP tools descriptor that defines the tools exposed by the MCP server.
data (string) --
The MCP tools descriptor content, serialized as descriptor payload data.
dataSchemaVersion (string) --
The schema version of the descriptor payload.
source (dict) --
The optional source configuration used to synchronize the MCP server descriptor content.
fromUrl (dict) --
URL-based descriptor source, populated when descriptor content is synchronized from a URL.
url (string) -- [REQUIRED]
The URL from which the descriptor content is retrieved.
credentialProviderConfigurations (list) --
The credential providers used to authenticate when fetching descriptor content from the source URL.
(dict) --
A credential provider configuration that specifies how to authenticate when fetching descriptor content from a registry record's source URL.
credentialProviderType (string) -- [REQUIRED]
The type of credential provider.
credentialProvider (dict) -- [REQUIRED]
The credential provider details corresponding to the specified credential provider type.
oauthCredentialProvider (dict) --
The OAuth 2.0 credential provider details.
providerArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the OAuth 2.0 credential provider resource in Amazon Bedrock AgentCore Identity.
grantType (string) --
The OAuth 2.0 grant type used to obtain access tokens.
scopes (list) --
The OAuth 2.0 scopes to request when obtaining access tokens.
(string) --
customParameters (dict) --
Additional parameters to include in the OAuth 2.0 token request.
(string) --
(string) --
iamCredentialProvider (dict) --
The IAM role credential provider details.
roleArn (string) --
The Amazon Resource Name (ARN) of the IAM role to assume for request signing.
service (string) --
The service name to use for request signing, such as execute-api.
region (string) --
The Amazon Web Services Region to use for request signing. If not specified, the Region is derived from the source URL hostname, falling back to the Region of the registry.
a2aAgentCard (dict) --
The A2A agent card descriptor, populated when the record type is AGENT.
data (string) --
The A2A agent card content, serialized as descriptor payload data.
dataSchemaVersion (string) --
The schema version of the descriptor payload.
source (dict) --
The optional source configuration used to synchronize the A2A agent card descriptor content.
fromUrl (dict) --
URL-based descriptor source, populated when descriptor content is synchronized from a URL.
url (string) -- [REQUIRED]
The URL from which the descriptor content is retrieved.
credentialProviderConfigurations (list) --
The credential providers used to authenticate when fetching descriptor content from the source URL.
(dict) --
A credential provider configuration that specifies how to authenticate when fetching descriptor content from a registry record's source URL.
credentialProviderType (string) -- [REQUIRED]
The type of credential provider.
credentialProvider (dict) -- [REQUIRED]
The credential provider details corresponding to the specified credential provider type.
oauthCredentialProvider (dict) --
The OAuth 2.0 credential provider details.
providerArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the OAuth 2.0 credential provider resource in Amazon Bedrock AgentCore Identity.
grantType (string) --
The OAuth 2.0 grant type used to obtain access tokens.
scopes (list) --
The OAuth 2.0 scopes to request when obtaining access tokens.
(string) --
customParameters (dict) --
Additional parameters to include in the OAuth 2.0 token request.
(string) --
(string) --
iamCredentialProvider (dict) --
The IAM role credential provider details.
roleArn (string) --
The Amazon Resource Name (ARN) of the IAM role to assume for request signing.
service (string) --
The service name to use for request signing, such as execute-api.
region (string) --
The Amazon Web Services Region to use for request signing. If not specified, the Region is derived from the source URL hostname, falling back to the Region of the registry.
agentSkillsDefinition (dict) --
The agent skills definition descriptor, populated when the record type is SKILL.
data (string) --
The agent skills definition content, serialized as descriptor payload data.
dataSchemaVersion (string) --
The schema version of the descriptor payload.
additionalData (dict) --
Additional data associated with the agent skills definition descriptor.
skillMd (dict) --
The markdown skill content associated with an agent skills definition.
data (string) --
The agent skills markdown content, serialized as descriptor payload data.
dataSchemaVersion (string) --
The schema version of the descriptor payload.
source (dict) --
The optional source configuration used to synchronize the agent skills markdown content.
fromUrl (dict) --
URL-based descriptor source, populated when descriptor content is synchronized from a URL.
url (string) -- [REQUIRED]
The URL from which the descriptor content is retrieved.
credentialProviderConfigurations (list) --
The credential providers used to authenticate when fetching descriptor content from the source URL.
(dict) --
A credential provider configuration that specifies how to authenticate when fetching descriptor content from a registry record's source URL.
credentialProviderType (string) -- [REQUIRED]
The type of credential provider.
credentialProvider (dict) -- [REQUIRED]
The credential provider details corresponding to the specified credential provider type.
oauthCredentialProvider (dict) --
The OAuth 2.0 credential provider details.
providerArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the OAuth 2.0 credential provider resource in Amazon Bedrock AgentCore Identity.
grantType (string) --
The OAuth 2.0 grant type used to obtain access tokens.
scopes (list) --
The OAuth 2.0 scopes to request when obtaining access tokens.
(string) --
customParameters (dict) --
Additional parameters to include in the OAuth 2.0 token request.
(string) --
(string) --
iamCredentialProvider (dict) --
The IAM role credential provider details.
roleArn (string) --
The Amazon Resource Name (ARN) of the IAM role to assume for request signing.
service (string) --
The service name to use for request signing, such as execute-api.
region (string) --
The Amazon Web Services Region to use for request signing. If not specified, the Region is derived from the source URL hostname, falling back to the Region of the registry.
custom (dict) --
The custom descriptor, populated when the record type is CUSTOM.
data (string) --
The custom descriptor content, serialized as descriptor payload data.
http (dict) --
The HTTP descriptor, populated for records detected from an HTTP protocol source.
source (dict) --
The source configuration that defines where descriptor content is retrieved from.
fromUrl (dict) --
URL-based descriptor source, populated when descriptor content is synchronized from a URL.
url (string) -- [REQUIRED]
The URL from which the descriptor content is retrieved.
credentialProviderConfigurations (list) --
The credential providers used to authenticate when fetching descriptor content from the source URL.
(dict) --
A credential provider configuration that specifies how to authenticate when fetching descriptor content from a registry record's source URL.
credentialProviderType (string) -- [REQUIRED]
The type of credential provider.
credentialProvider (dict) -- [REQUIRED]
The credential provider details corresponding to the specified credential provider type.
oauthCredentialProvider (dict) --
The OAuth 2.0 credential provider details.
providerArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the OAuth 2.0 credential provider resource in Amazon Bedrock AgentCore Identity.
grantType (string) --
The OAuth 2.0 grant type used to obtain access tokens.
scopes (list) --
The OAuth 2.0 scopes to request when obtaining access tokens.
(string) --
customParameters (dict) --
Additional parameters to include in the OAuth 2.0 token request.
(string) --
(string) --
iamCredentialProvider (dict) --
The IAM role credential provider details.
roleArn (string) --
The Amazon Resource Name (ARN) of the IAM role to assume for request signing.
service (string) --
The service name to use for request signing, such as execute-api.
region (string) --
The Amazon Web Services Region to use for request signing. If not specified, the Region is derived from the source URL hostname, falling back to the Region of the registry.
agui (dict) --
The AG-UI descriptor, populated for records detected from an AG-UI protocol source.
source (dict) --
The source configuration that defines where descriptor content is retrieved from.
fromUrl (dict) --
URL-based descriptor source, populated when descriptor content is synchronized from a URL.
url (string) -- [REQUIRED]
The URL from which the descriptor content is retrieved.
credentialProviderConfigurations (list) --
The credential providers used to authenticate when fetching descriptor content from the source URL.
(dict) --
A credential provider configuration that specifies how to authenticate when fetching descriptor content from a registry record's source URL.
credentialProviderType (string) -- [REQUIRED]
The type of credential provider.
credentialProvider (dict) -- [REQUIRED]
The credential provider details corresponding to the specified credential provider type.
oauthCredentialProvider (dict) --
The OAuth 2.0 credential provider details.
providerArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the OAuth 2.0 credential provider resource in Amazon Bedrock AgentCore Identity.
grantType (string) --
The OAuth 2.0 grant type used to obtain access tokens.
scopes (list) --
The OAuth 2.0 scopes to request when obtaining access tokens.
(string) --
customParameters (dict) --
Additional parameters to include in the OAuth 2.0 token request.
(string) --
(string) --
iamCredentialProvider (dict) --
The IAM role credential provider details.
roleArn (string) --
The Amazon Resource Name (ARN) of the IAM role to assume for request signing.
service (string) --
The service name to use for request signing, such as execute-api.
region (string) --
The Amazon Web Services Region to use for request signing. If not specified, the Region is derived from the source URL hostname, falling back to the Region of the registry.
string
The version of the registry record
string
Client token for idempotency
This field is autopopulated if not provided.
list
The provenance lineage entries for the registry record. This field is reserved for the Amazon Web Services Agent Registry auto-detection service principal. Requests that include this field from other callers are rejected.
(dict) --
A provenance entry that describes the lineage of a registry record. Records that were auto-detected by Amazon Web Services Agent Registry carry a provenance entry that links the record back to its upstream source.
relation (string) -- [REQUIRED]
The relationship between the registry record and its upstream source. DETECTED_FROM indicates that the record was auto-detected from the source resource.
sourceId (string) -- [REQUIRED]
The identifier of the upstream source that the registry record was detected from.
sourceType (string) --
The type of the upstream source that the registry record was detected from.
sourceDetails (dict) --
Additional details about the upstream source that the registry record was detected from, such as the AgentCore Gateway or Runtime configuration. The populated member corresponds to the source type.
agentcoreRuntime (dict) --
The source details for a registry record that was auto-detected from an Amazon Bedrock AgentCore Runtime resource. Populated when the source type is AWS::BedrockAgentCore::Runtime.
protocolConfiguration (dict) --
The protocol configuration of the AgentCore Runtime resource that the registry record was detected from.
serverProtocol (string) --
The server protocol used by the AgentCore Runtime, such as MCP, HTTP, A2A, or AGUI.
authorizerConfiguration (dict) --
The authorizer configuration for a registry. Exactly one member is set.
customJWTAuthorizer (dict) --
Configuration for a custom JWT authorizer.
discoveryUrl (string) -- [REQUIRED]
The OpenID Connect discovery URL used to retrieve the identity provider's metadata and signing keys.
allowedAudience (list) --
The audience values accepted during JWT validation. A token is rejected if none of its audience claims match.
(string) --
An audience value that an inbound JWT must contain to be authorized.
allowedClients (list) --
The client identifiers accepted during JWT validation. A token is rejected if it was not issued to one of these clients.
(string) --
A client identifier that an inbound JWT must be issued to in order to be authorized.
allowedScopes (list) --
The scopes accepted during JWT validation. A token is rejected if it does not carry one of these scopes.
(string) --
A scope value that an inbound JWT must carry to be authorized.
customClaims (list) --
Additional custom claim validations applied to the inbound JWT.
(dict) --
A validation rule applied to a single claim of an inbound JWT.
inboundTokenClaimName (string) -- [REQUIRED]
The name of the claim in the inbound token to validate.
inboundTokenClaimValueType (string) -- [REQUIRED]
The value type of the claim in the inbound token, either a string or an array of strings.
authorizingClaimMatchValue (dict) -- [REQUIRED]
The value and match operator used to authorize the claim.
claimMatchValue (dict) -- [REQUIRED]
The expected value or values that the claim is compared against.
matchValueString (string) --
A single string value to match the claim against.
matchValueStringList (list) --
A list of string values to match the claim against.
(string) --
A single value used to match a claim during JWT validation.
claimMatchOperator (string) -- [REQUIRED]
The operator used to compare the claim value against the expected value.
privateEndpoint (dict) --
The private endpoint used to reach the identity provider's discovery URL over a private network path.
selfManagedLatticeResource (dict) --
A private endpoint backed by a self-managed VPC Lattice resource configuration.
resourceConfigurationIdentifier (string) --
The identifier of the VPC Lattice resource configuration, specified as a resource configuration ID or ARN.
managedVpcResource (dict) --
A private endpoint backed by a service-managed VPC resource.
vpcIdentifier (string) -- [REQUIRED]
The identifier of the VPC in which the private endpoint is provisioned.
subnetIds (list) -- [REQUIRED]
The identifiers of the subnets in which the private endpoint network interfaces are placed.
(string) --
Subnet identifier
endpointIpAddressType (string) -- [REQUIRED]
The IP address type used by the private endpoint, either IPV4 or IPV6.
securityGroupIds (list) --
The identifiers of the security groups associated with the private endpoint network interfaces.
(string) --
The identifier of a security group.
tags (dict) --
The tags applied to the service-managed VPC resource.
(string) --
Key of a tag.
(string) --
Value of a tag.
routingDomain (string) --
The routing domain used to resolve traffic through the private endpoint.
privateEndpointOverrides (list) --
Per-domain private endpoint overrides that route specific identity provider domains through distinct private endpoints.
(dict) --
A mapping of a domain to the private endpoint used to reach it.
domain (string) -- [REQUIRED]
The domain name to which this private endpoint override applies.
privateEndpoint (dict) -- [REQUIRED]
The private endpoint used to reach the specified domain.
selfManagedLatticeResource (dict) --
A private endpoint backed by a self-managed VPC Lattice resource configuration.
resourceConfigurationIdentifier (string) --
The identifier of the VPC Lattice resource configuration, specified as a resource configuration ID or ARN.
managedVpcResource (dict) --
A private endpoint backed by a service-managed VPC resource.
vpcIdentifier (string) -- [REQUIRED]
The identifier of the VPC in which the private endpoint is provisioned.
subnetIds (list) -- [REQUIRED]
The identifiers of the subnets in which the private endpoint network interfaces are placed.
(string) --
Subnet identifier
endpointIpAddressType (string) -- [REQUIRED]
The IP address type used by the private endpoint, either IPV4 or IPV6.
securityGroupIds (list) --
The identifiers of the security groups associated with the private endpoint network interfaces.
(string) --
The identifier of a security group.
tags (dict) --
The tags applied to the service-managed VPC resource.
(string) --
Key of a tag.
(string) --
Value of a tag.
routingDomain (string) --
The routing domain used to resolve traffic through the private endpoint.
workloadIdentityDetails (dict) --
The workload identity details for the AgentCore Runtime resource. Present when the runtime has a workload identity configured.
workloadIdentityArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the workload identity associated with the source resource.
agentcoreGateway (dict) --
The source details for a registry record that was auto-detected from an Amazon Bedrock AgentCore Gateway resource. Populated when the source type is AWS::BedrockAgentCore::Gateway.
protocolType (string) --
The protocol type of the AgentCore Gateway resource that the registry record was detected from, for example MCP.
authorizerType (string) --
The type of authorizer configured on the AgentCore Gateway resource that the registry record was detected from.
authorizerConfiguration (dict) --
The authorizer configuration for a registry. Exactly one member is set.
customJWTAuthorizer (dict) --
Configuration for a custom JWT authorizer.
discoveryUrl (string) -- [REQUIRED]
The OpenID Connect discovery URL used to retrieve the identity provider's metadata and signing keys.
allowedAudience (list) --
The audience values accepted during JWT validation. A token is rejected if none of its audience claims match.
(string) --
An audience value that an inbound JWT must contain to be authorized.
allowedClients (list) --
The client identifiers accepted during JWT validation. A token is rejected if it was not issued to one of these clients.
(string) --
A client identifier that an inbound JWT must be issued to in order to be authorized.
allowedScopes (list) --
The scopes accepted during JWT validation. A token is rejected if it does not carry one of these scopes.
(string) --
A scope value that an inbound JWT must carry to be authorized.
customClaims (list) --
Additional custom claim validations applied to the inbound JWT.
(dict) --
A validation rule applied to a single claim of an inbound JWT.
inboundTokenClaimName (string) -- [REQUIRED]
The name of the claim in the inbound token to validate.
inboundTokenClaimValueType (string) -- [REQUIRED]
The value type of the claim in the inbound token, either a string or an array of strings.
authorizingClaimMatchValue (dict) -- [REQUIRED]
The value and match operator used to authorize the claim.
claimMatchValue (dict) -- [REQUIRED]
The expected value or values that the claim is compared against.
matchValueString (string) --
A single string value to match the claim against.
matchValueStringList (list) --
A list of string values to match the claim against.
(string) --
A single value used to match a claim during JWT validation.
claimMatchOperator (string) -- [REQUIRED]
The operator used to compare the claim value against the expected value.
privateEndpoint (dict) --
The private endpoint used to reach the identity provider's discovery URL over a private network path.
selfManagedLatticeResource (dict) --
A private endpoint backed by a self-managed VPC Lattice resource configuration.
resourceConfigurationIdentifier (string) --
The identifier of the VPC Lattice resource configuration, specified as a resource configuration ID or ARN.
managedVpcResource (dict) --
A private endpoint backed by a service-managed VPC resource.
vpcIdentifier (string) -- [REQUIRED]
The identifier of the VPC in which the private endpoint is provisioned.
subnetIds (list) -- [REQUIRED]
The identifiers of the subnets in which the private endpoint network interfaces are placed.
(string) --
Subnet identifier
endpointIpAddressType (string) -- [REQUIRED]
The IP address type used by the private endpoint, either IPV4 or IPV6.
securityGroupIds (list) --
The identifiers of the security groups associated with the private endpoint network interfaces.
(string) --
The identifier of a security group.
tags (dict) --
The tags applied to the service-managed VPC resource.
(string) --
Key of a tag.
(string) --
Value of a tag.
routingDomain (string) --
The routing domain used to resolve traffic through the private endpoint.
privateEndpointOverrides (list) --
Per-domain private endpoint overrides that route specific identity provider domains through distinct private endpoints.
(dict) --
A mapping of a domain to the private endpoint used to reach it.
domain (string) -- [REQUIRED]
The domain name to which this private endpoint override applies.
privateEndpoint (dict) -- [REQUIRED]
The private endpoint used to reach the specified domain.
selfManagedLatticeResource (dict) --
A private endpoint backed by a self-managed VPC Lattice resource configuration.
resourceConfigurationIdentifier (string) --
The identifier of the VPC Lattice resource configuration, specified as a resource configuration ID or ARN.
managedVpcResource (dict) --
A private endpoint backed by a service-managed VPC resource.
vpcIdentifier (string) -- [REQUIRED]
The identifier of the VPC in which the private endpoint is provisioned.
subnetIds (list) -- [REQUIRED]
The identifiers of the subnets in which the private endpoint network interfaces are placed.
(string) --
Subnet identifier
endpointIpAddressType (string) -- [REQUIRED]
The IP address type used by the private endpoint, either IPV4 or IPV6.
securityGroupIds (list) --
The identifiers of the security groups associated with the private endpoint network interfaces.
(string) --
The identifier of a security group.
tags (dict) --
The tags applied to the service-managed VPC resource.
(string) --
Key of a tag.
(string) --
Value of a tag.
routingDomain (string) --
The routing domain used to resolve traffic through the private endpoint.
workloadIdentityDetails (dict) --
The workload identity details for the AgentCore Gateway resource. Present when the gateway has a workload identity configured.
workloadIdentityArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the workload identity associated with the source resource.
:ref:`document<document>`
The custom metadata to attach to the registry record. Each key must match a property defined in the registry's custom metadata schema. Values can be strings (maximum 128 characters) or native JSON booleans ( true or false). Values are validated against the schema at creation time.
dict
Tags to associate with the registry record
(string) --
Key of a tag.
(string) --
Value of a tag.
dict
Response Syntax
{
'recordArn': 'string',
'status': 'DRAFT'|'PENDING_APPROVAL'|'APPROVED'|'REJECTED'|'DEPRECATED'|'CREATING'|'UPDATING'|'CREATE_FAILED'|'UPDATE_FAILED'
}
Response Structure
(dict) --
Response structure for creating a registry record
recordArn (string) --
The ARN of the created registry record
status (string) --
The status of the registry record, set to CREATING while the asynchronous workflow is in progress
{'customMetadataSchemaConfiguration': {'defaultSchema': 'string',
'recordTypeSchemaOverrides': [{'recordType': 'MCP '
'| '
'AGENT '
'| '
'CUSTOM '
'| '
'SKILL '
'| '
'GATEWAY',
'schema': 'string'}]}}
Gets a registry by identifier (ARN or ID)
See also: AWS API Documentation
Request Syntax
client.get_registry(
registryId='string'
)
string
[REQUIRED]
The identifier of the registry to retrieve (ARN or ID)
dict
Response Syntax
{
'name': 'string',
'description': 'string',
'registryId': 'string',
'registryArn': 'string',
'discoveryConfiguration': {
'authorizerConfiguration': {
'customJWTAuthorizer': {
'discoveryUrl': 'string',
'allowedAudience': [
'string',
],
'allowedClients': [
'string',
],
'allowedScopes': [
'string',
],
'customClaims': [
{
'inboundTokenClaimName': 'string',
'inboundTokenClaimValueType': 'STRING'|'STRING_ARRAY',
'authorizingClaimMatchValue': {
'claimMatchValue': {
'matchValueString': 'string',
'matchValueStringList': [
'string',
]
},
'claimMatchOperator': 'EQUALS'|'CONTAINS'|'CONTAINS_ANY'
}
},
],
'privateEndpoint': {
'selfManagedLatticeResource': {
'resourceConfigurationIdentifier': 'string'
},
'managedVpcResource': {
'vpcIdentifier': 'string',
'subnetIds': [
'string',
],
'endpointIpAddressType': 'IPV4'|'IPV6',
'securityGroupIds': [
'string',
],
'tags': {
'string': 'string'
},
'routingDomain': 'string'
}
},
'privateEndpointOverrides': [
{
'domain': 'string',
'privateEndpoint': {
'selfManagedLatticeResource': {
'resourceConfigurationIdentifier': 'string'
},
'managedVpcResource': {
'vpcIdentifier': 'string',
'subnetIds': [
'string',
],
'endpointIpAddressType': 'IPV4'|'IPV6',
'securityGroupIds': [
'string',
],
'tags': {
'string': 'string'
},
'routingDomain': 'string'
}
}
},
]
}
},
'authorizerType': 'CUSTOM_JWT'|'AWS_IAM'
},
'encryptionConfiguration': {
'kmsKeyArn': 'string'
},
'approvalConfiguration': {
'autoApprovalRules': [
'APPROVE_ALL',
]
},
'customMetadataSchemaConfiguration': {
'defaultSchema': 'string',
'recordTypeSchemaOverrides': [
{
'recordType': 'MCP'|'AGENT'|'CUSTOM'|'SKILL'|'GATEWAY',
'schema': 'string'
},
]
},
'status': 'CREATING'|'READY'|'UPDATING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETING'|'DELETE_FAILED',
'statusReason': 'string',
'autoDetection': {
'configuration': {
'scope': 'ORGANIZATION',
'enabled': True|False
},
'status': 'ACTIVE'|'INACTIVE',
'statusReason': 'string'
},
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
Response structure for getting a registry
name (string) --
The name of the registry
description (string) --
The description of the registry
registryId (string) --
The unique identifier of the registry
registryArn (string) --
The ARN of the registry
discoveryConfiguration (dict) --
Discovery configuration for the registry
authorizerConfiguration (dict) --
The authorizer configuration for the registry. Required when authorizerType is CUSTOM_JWT.
customJWTAuthorizer (dict) --
Configuration for a custom JWT authorizer.
discoveryUrl (string) --
The OpenID Connect discovery URL used to retrieve the identity provider's metadata and signing keys.
allowedAudience (list) --
The audience values accepted during JWT validation. A token is rejected if none of its audience claims match.
(string) --
An audience value that an inbound JWT must contain to be authorized.
allowedClients (list) --
The client identifiers accepted during JWT validation. A token is rejected if it was not issued to one of these clients.
(string) --
A client identifier that an inbound JWT must be issued to in order to be authorized.
allowedScopes (list) --
The scopes accepted during JWT validation. A token is rejected if it does not carry one of these scopes.
(string) --
A scope value that an inbound JWT must carry to be authorized.
customClaims (list) --
Additional custom claim validations applied to the inbound JWT.
(dict) --
A validation rule applied to a single claim of an inbound JWT.
inboundTokenClaimName (string) --
The name of the claim in the inbound token to validate.
inboundTokenClaimValueType (string) --
The value type of the claim in the inbound token, either a string or an array of strings.
authorizingClaimMatchValue (dict) --
The value and match operator used to authorize the claim.
claimMatchValue (dict) --
The expected value or values that the claim is compared against.
matchValueString (string) --
A single string value to match the claim against.
matchValueStringList (list) --
A list of string values to match the claim against.
(string) --
A single value used to match a claim during JWT validation.
claimMatchOperator (string) --
The operator used to compare the claim value against the expected value.
privateEndpoint (dict) --
The private endpoint used to reach the identity provider's discovery URL over a private network path.
selfManagedLatticeResource (dict) --
A private endpoint backed by a self-managed VPC Lattice resource configuration.
resourceConfigurationIdentifier (string) --
The identifier of the VPC Lattice resource configuration, specified as a resource configuration ID or ARN.
managedVpcResource (dict) --
A private endpoint backed by a service-managed VPC resource.
vpcIdentifier (string) --
The identifier of the VPC in which the private endpoint is provisioned.
subnetIds (list) --
The identifiers of the subnets in which the private endpoint network interfaces are placed.
(string) --
Subnet identifier
endpointIpAddressType (string) --
The IP address type used by the private endpoint, either IPV4 or IPV6.
securityGroupIds (list) --
The identifiers of the security groups associated with the private endpoint network interfaces.
(string) --
The identifier of a security group.
tags (dict) --
The tags applied to the service-managed VPC resource.
(string) --
Key of a tag.
(string) --
Value of a tag.
routingDomain (string) --
The routing domain used to resolve traffic through the private endpoint.
privateEndpointOverrides (list) --
Per-domain private endpoint overrides that route specific identity provider domains through distinct private endpoints.
(dict) --
A mapping of a domain to the private endpoint used to reach it.
domain (string) --
The domain name to which this private endpoint override applies.
privateEndpoint (dict) --
The private endpoint used to reach the specified domain.
selfManagedLatticeResource (dict) --
A private endpoint backed by a self-managed VPC Lattice resource configuration.
resourceConfigurationIdentifier (string) --
The identifier of the VPC Lattice resource configuration, specified as a resource configuration ID or ARN.
managedVpcResource (dict) --
A private endpoint backed by a service-managed VPC resource.
vpcIdentifier (string) --
The identifier of the VPC in which the private endpoint is provisioned.
subnetIds (list) --
The identifiers of the subnets in which the private endpoint network interfaces are placed.
(string) --
Subnet identifier
endpointIpAddressType (string) --
The IP address type used by the private endpoint, either IPV4 or IPV6.
securityGroupIds (list) --
The identifiers of the security groups associated with the private endpoint network interfaces.
(string) --
The identifier of a security group.
tags (dict) --
The tags applied to the service-managed VPC resource.
(string) --
Key of a tag.
(string) --
Value of a tag.
routingDomain (string) --
The routing domain used to resolve traffic through the private endpoint.
authorizerType (string) --
The type of authorizer that controls how consumers access the registry's search and MCP invoke operations.
encryptionConfiguration (dict) --
The server-side encryption configuration for the registry. Appears only when a customer-managed Amazon Web Services KMS key encrypts the registry.
kmsKeyArn (string) --
The Amazon Resource Name (ARN) of the customer-managed Amazon Web Services KMS key used to encrypt the registry's content. The key must be a symmetric encryption key in the same Amazon Web Services account and Region as the registry.
approvalConfiguration (dict) --
Approval configuration for registry records
autoApprovalRules (list) --
The rules that determine which registry records are automatically approved on submission. When omitted or empty, submitted records require manual review.
(string) --
customMetadataSchemaConfiguration (dict) --
The custom metadata schema configuration for this registry, if one has been defined.
defaultSchema (string) --
The default JSON Schema that applies to record types without a specific override. Supported property types are string, string with an enum constraint, string with a uri format, and boolean.
recordTypeSchemaOverrides (list) --
A list of per-record-type schema overrides. When a record's type matches an override, that override's schema is used instead of the default schema for validation. If you don't specify an override for a record type, the default schema applies. If no default schema exists, custom metadata on records of that type is rejected.
(dict) --
A schema override for a specific record type within a custom metadata schema configuration.
recordType (string) --
The record type that this schema override applies to.
schema (string) --
The JSON Schema for the specified record type. Must follow the same structural rules as the default schema.
status (string) --
Current status of the registry
statusReason (string) --
The reason for the current status. Typically populated when the status indicates a failure state.
autoDetection (dict) --
The registry's auto-detection properties, including the requested configuration and the current detection status. Present only when auto-detection was configured for the registry.
configuration (dict) --
The auto-detection settings that control how resources are discovered for the registry.
scope (string) --
The source from which resources are detected. For example, ORGANIZATION sources resources from all member accounts of an Amazon Web Services organization.
enabled (boolean) --
Specifies whether auto-detection is requested for the registry. Setting this to true is necessary but not sufficient for auto-detection to become active; the preconditions of the configured scope must also be met.
status (string) --
The current auto-detection status. ACTIVE indicates that the registry is actively being populated with detected resources. INACTIVE indicates that the preconditions required at the configured scope are not currently met.
statusReason (string) --
A human-readable explanation of the current auto-detection status. Typically populated when the status requires additional context.
createdAt (datetime) --
The timestamp when the registry was created
updatedAt (datetime) --
The timestamp when the registry was last updated
{'customMetadata': {},
'customMetadataSchemaComplianceStatus': 'COMPLIANT | NON_COMPLIANT'}
Retrieves the details of a registry record
See also: AWS API Documentation
Request Syntax
client.get_registry_record(
registryId='string',
recordId='string'
)
string
[REQUIRED]
The identifier of the registry containing the record (ARN or ID)
string
[REQUIRED]
The identifier of the registry record to retrieve (ARN or ID)
dict
Response Syntax
{
'registryArn': 'string',
'recordArn': 'string',
'recordId': 'string',
'name': 'string',
'displayName': 'string',
'description': 'string',
'recordType': 'MCP'|'AGENT'|'CUSTOM'|'SKILL'|'GATEWAY',
'descriptors': {
'mcpServer': {
'data': 'string',
'dataSchemaVersion': 'string',
'additionalData': {
'tools': {
'data': 'string',
'dataSchemaVersion': 'string'
}
},
'source': {
'fromUrl': {
'url': 'string',
'credentialProviderConfigurations': [
{
'credentialProviderType': 'OAUTH'|'IAM',
'credentialProvider': {
'oauthCredentialProvider': {
'providerArn': 'string',
'grantType': 'CLIENT_CREDENTIALS',
'scopes': [
'string',
],
'customParameters': {
'string': 'string'
}
},
'iamCredentialProvider': {
'roleArn': 'string',
'service': 'string',
'region': 'string'
}
}
},
]
}
}
},
'a2aAgentCard': {
'data': 'string',
'dataSchemaVersion': 'string',
'source': {
'fromUrl': {
'url': 'string',
'credentialProviderConfigurations': [
{
'credentialProviderType': 'OAUTH'|'IAM',
'credentialProvider': {
'oauthCredentialProvider': {
'providerArn': 'string',
'grantType': 'CLIENT_CREDENTIALS',
'scopes': [
'string',
],
'customParameters': {
'string': 'string'
}
},
'iamCredentialProvider': {
'roleArn': 'string',
'service': 'string',
'region': 'string'
}
}
},
]
}
}
},
'agentSkillsDefinition': {
'data': 'string',
'dataSchemaVersion': 'string',
'additionalData': {
'skillMd': {
'data': 'string',
'dataSchemaVersion': 'string',
'source': {
'fromUrl': {
'url': 'string',
'credentialProviderConfigurations': [
{
'credentialProviderType': 'OAUTH'|'IAM',
'credentialProvider': {
'oauthCredentialProvider': {
'providerArn': 'string',
'grantType': 'CLIENT_CREDENTIALS',
'scopes': [
'string',
],
'customParameters': {
'string': 'string'
}
},
'iamCredentialProvider': {
'roleArn': 'string',
'service': 'string',
'region': 'string'
}
}
},
]
}
}
}
}
},
'custom': {
'data': 'string'
},
'http': {
'source': {
'fromUrl': {
'url': 'string',
'credentialProviderConfigurations': [
{
'credentialProviderType': 'OAUTH'|'IAM',
'credentialProvider': {
'oauthCredentialProvider': {
'providerArn': 'string',
'grantType': 'CLIENT_CREDENTIALS',
'scopes': [
'string',
],
'customParameters': {
'string': 'string'
}
},
'iamCredentialProvider': {
'roleArn': 'string',
'service': 'string',
'region': 'string'
}
}
},
]
}
}
},
'agui': {
'source': {
'fromUrl': {
'url': 'string',
'credentialProviderConfigurations': [
{
'credentialProviderType': 'OAUTH'|'IAM',
'credentialProvider': {
'oauthCredentialProvider': {
'providerArn': 'string',
'grantType': 'CLIENT_CREDENTIALS',
'scopes': [
'string',
],
'customParameters': {
'string': 'string'
}
},
'iamCredentialProvider': {
'roleArn': 'string',
'service': 'string',
'region': 'string'
}
}
},
]
}
}
}
},
'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),
'statusReason': 'string',
'provenance': [
{
'relation': 'DETECTED_FROM',
'sourceId': 'string',
'sourceType': 'AWS::BedrockAgentCore::Runtime'|'AWS::BedrockAgentCore::Gateway',
'sourceDetails': {
'agentcoreRuntime': {
'protocolConfiguration': {
'serverProtocol': 'HTTP'|'A2A'|'MCP'|'AGUI'
},
'authorizerConfiguration': {
'customJWTAuthorizer': {
'discoveryUrl': 'string',
'allowedAudience': [
'string',
],
'allowedClients': [
'string',
],
'allowedScopes': [
'string',
],
'customClaims': [
{
'inboundTokenClaimName': 'string',
'inboundTokenClaimValueType': 'STRING'|'STRING_ARRAY',
'authorizingClaimMatchValue': {
'claimMatchValue': {
'matchValueString': 'string',
'matchValueStringList': [
'string',
]
},
'claimMatchOperator': 'EQUALS'|'CONTAINS'|'CONTAINS_ANY'
}
},
],
'privateEndpoint': {
'selfManagedLatticeResource': {
'resourceConfigurationIdentifier': 'string'
},
'managedVpcResource': {
'vpcIdentifier': 'string',
'subnetIds': [
'string',
],
'endpointIpAddressType': 'IPV4'|'IPV6',
'securityGroupIds': [
'string',
],
'tags': {
'string': 'string'
},
'routingDomain': 'string'
}
},
'privateEndpointOverrides': [
{
'domain': 'string',
'privateEndpoint': {
'selfManagedLatticeResource': {
'resourceConfigurationIdentifier': 'string'
},
'managedVpcResource': {
'vpcIdentifier': 'string',
'subnetIds': [
'string',
],
'endpointIpAddressType': 'IPV4'|'IPV6',
'securityGroupIds': [
'string',
],
'tags': {
'string': 'string'
},
'routingDomain': 'string'
}
}
},
]
}
},
'workloadIdentityDetails': {
'workloadIdentityArn': 'string'
}
},
'agentcoreGateway': {
'protocolType': 'MCP',
'authorizerType': 'string',
'authorizerConfiguration': {
'customJWTAuthorizer': {
'discoveryUrl': 'string',
'allowedAudience': [
'string',
],
'allowedClients': [
'string',
],
'allowedScopes': [
'string',
],
'customClaims': [
{
'inboundTokenClaimName': 'string',
'inboundTokenClaimValueType': 'STRING'|'STRING_ARRAY',
'authorizingClaimMatchValue': {
'claimMatchValue': {
'matchValueString': 'string',
'matchValueStringList': [
'string',
]
},
'claimMatchOperator': 'EQUALS'|'CONTAINS'|'CONTAINS_ANY'
}
},
],
'privateEndpoint': {
'selfManagedLatticeResource': {
'resourceConfigurationIdentifier': 'string'
},
'managedVpcResource': {
'vpcIdentifier': 'string',
'subnetIds': [
'string',
],
'endpointIpAddressType': 'IPV4'|'IPV6',
'securityGroupIds': [
'string',
],
'tags': {
'string': 'string'
},
'routingDomain': 'string'
}
},
'privateEndpointOverrides': [
{
'domain': 'string',
'privateEndpoint': {
'selfManagedLatticeResource': {
'resourceConfigurationIdentifier': 'string'
},
'managedVpcResource': {
'vpcIdentifier': 'string',
'subnetIds': [
'string',
],
'endpointIpAddressType': 'IPV4'|'IPV6',
'securityGroupIds': [
'string',
],
'tags': {
'string': 'string'
},
'routingDomain': 'string'
}
}
},
]
}
},
'workloadIdentityDetails': {
'workloadIdentityArn': 'string'
}
}
}
},
],
'createdByAutoDetection': True|False,
'createdBy': 'string',
'customMetadata': {...}|[...]|123|123.4|'string'|True|None,
'customMetadataSchemaComplianceStatus': 'COMPLIANT'|'NON_COMPLIANT'
}
Response Structure
(dict) --
Response structure for retrieving a registry record
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.
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.
descriptors (dict) --
The typed descriptors that define the content of the registry record.
mcpServer (dict) --
The MCP server descriptor, populated when the record type is MCP.
data (string) --
The MCP server descriptor content, serialized as descriptor payload data.
dataSchemaVersion (string) --
The schema version of the descriptor payload.
additionalData (dict) --
Additional data associated with the MCP server descriptor, such as tool definitions.
tools (dict) --
The MCP tools descriptor that defines the tools exposed by the MCP server.
data (string) --
The MCP tools descriptor content, serialized as descriptor payload data.
dataSchemaVersion (string) --
The schema version of the descriptor payload.
source (dict) --
The optional source configuration used to synchronize the MCP server descriptor content.
fromUrl (dict) --
URL-based descriptor source, populated when descriptor content is synchronized from a URL.
url (string) --
The URL from which the descriptor content is retrieved.
credentialProviderConfigurations (list) --
The credential providers used to authenticate when fetching descriptor content from the source URL.
(dict) --
A credential provider configuration that specifies how to authenticate when fetching descriptor content from a registry record's source URL.
credentialProviderType (string) --
The type of credential provider.
credentialProvider (dict) --
The credential provider details corresponding to the specified credential provider type.
oauthCredentialProvider (dict) --
The OAuth 2.0 credential provider details.
providerArn (string) --
The Amazon Resource Name (ARN) of the OAuth 2.0 credential provider resource in Amazon Bedrock AgentCore Identity.
grantType (string) --
The OAuth 2.0 grant type used to obtain access tokens.
scopes (list) --
The OAuth 2.0 scopes to request when obtaining access tokens.
(string) --
customParameters (dict) --
Additional parameters to include in the OAuth 2.0 token request.
(string) --
(string) --
iamCredentialProvider (dict) --
The IAM role credential provider details.
roleArn (string) --
The Amazon Resource Name (ARN) of the IAM role to assume for request signing.
service (string) --
The service name to use for request signing, such as execute-api.
region (string) --
The Amazon Web Services Region to use for request signing. If not specified, the Region is derived from the source URL hostname, falling back to the Region of the registry.
a2aAgentCard (dict) --
The A2A agent card descriptor, populated when the record type is AGENT.
data (string) --
The A2A agent card content, serialized as descriptor payload data.
dataSchemaVersion (string) --
The schema version of the descriptor payload.
source (dict) --
The optional source configuration used to synchronize the A2A agent card descriptor content.
fromUrl (dict) --
URL-based descriptor source, populated when descriptor content is synchronized from a URL.
url (string) --
The URL from which the descriptor content is retrieved.
credentialProviderConfigurations (list) --
The credential providers used to authenticate when fetching descriptor content from the source URL.
(dict) --
A credential provider configuration that specifies how to authenticate when fetching descriptor content from a registry record's source URL.
credentialProviderType (string) --
The type of credential provider.
credentialProvider (dict) --
The credential provider details corresponding to the specified credential provider type.
oauthCredentialProvider (dict) --
The OAuth 2.0 credential provider details.
providerArn (string) --
The Amazon Resource Name (ARN) of the OAuth 2.0 credential provider resource in Amazon Bedrock AgentCore Identity.
grantType (string) --
The OAuth 2.0 grant type used to obtain access tokens.
scopes (list) --
The OAuth 2.0 scopes to request when obtaining access tokens.
(string) --
customParameters (dict) --
Additional parameters to include in the OAuth 2.0 token request.
(string) --
(string) --
iamCredentialProvider (dict) --
The IAM role credential provider details.
roleArn (string) --
The Amazon Resource Name (ARN) of the IAM role to assume for request signing.
service (string) --
The service name to use for request signing, such as execute-api.
region (string) --
The Amazon Web Services Region to use for request signing. If not specified, the Region is derived from the source URL hostname, falling back to the Region of the registry.
agentSkillsDefinition (dict) --
The agent skills definition descriptor, populated when the record type is SKILL.
data (string) --
The agent skills definition content, serialized as descriptor payload data.
dataSchemaVersion (string) --
The schema version of the descriptor payload.
additionalData (dict) --
Additional data associated with the agent skills definition descriptor.
skillMd (dict) --
The markdown skill content associated with an agent skills definition.
data (string) --
The agent skills markdown content, serialized as descriptor payload data.
dataSchemaVersion (string) --
The schema version of the descriptor payload.
source (dict) --
The optional source configuration used to synchronize the agent skills markdown content.
fromUrl (dict) --
URL-based descriptor source, populated when descriptor content is synchronized from a URL.
url (string) --
The URL from which the descriptor content is retrieved.
credentialProviderConfigurations (list) --
The credential providers used to authenticate when fetching descriptor content from the source URL.
(dict) --
A credential provider configuration that specifies how to authenticate when fetching descriptor content from a registry record's source URL.
credentialProviderType (string) --
The type of credential provider.
credentialProvider (dict) --
The credential provider details corresponding to the specified credential provider type.
oauthCredentialProvider (dict) --
The OAuth 2.0 credential provider details.
providerArn (string) --
The Amazon Resource Name (ARN) of the OAuth 2.0 credential provider resource in Amazon Bedrock AgentCore Identity.
grantType (string) --
The OAuth 2.0 grant type used to obtain access tokens.
scopes (list) --
The OAuth 2.0 scopes to request when obtaining access tokens.
(string) --
customParameters (dict) --
Additional parameters to include in the OAuth 2.0 token request.
(string) --
(string) --
iamCredentialProvider (dict) --
The IAM role credential provider details.
roleArn (string) --
The Amazon Resource Name (ARN) of the IAM role to assume for request signing.
service (string) --
The service name to use for request signing, such as execute-api.
region (string) --
The Amazon Web Services Region to use for request signing. If not specified, the Region is derived from the source URL hostname, falling back to the Region of the registry.
custom (dict) --
The custom descriptor, populated when the record type is CUSTOM.
data (string) --
The custom descriptor content, serialized as descriptor payload data.
http (dict) --
The HTTP descriptor, populated for records detected from an HTTP protocol source.
source (dict) --
The source configuration that defines where descriptor content is retrieved from.
fromUrl (dict) --
URL-based descriptor source, populated when descriptor content is synchronized from a URL.
url (string) --
The URL from which the descriptor content is retrieved.
credentialProviderConfigurations (list) --
The credential providers used to authenticate when fetching descriptor content from the source URL.
(dict) --
A credential provider configuration that specifies how to authenticate when fetching descriptor content from a registry record's source URL.
credentialProviderType (string) --
The type of credential provider.
credentialProvider (dict) --
The credential provider details corresponding to the specified credential provider type.
oauthCredentialProvider (dict) --
The OAuth 2.0 credential provider details.
providerArn (string) --
The Amazon Resource Name (ARN) of the OAuth 2.0 credential provider resource in Amazon Bedrock AgentCore Identity.
grantType (string) --
The OAuth 2.0 grant type used to obtain access tokens.
scopes (list) --
The OAuth 2.0 scopes to request when obtaining access tokens.
(string) --
customParameters (dict) --
Additional parameters to include in the OAuth 2.0 token request.
(string) --
(string) --
iamCredentialProvider (dict) --
The IAM role credential provider details.
roleArn (string) --
The Amazon Resource Name (ARN) of the IAM role to assume for request signing.
service (string) --
The service name to use for request signing, such as execute-api.
region (string) --
The Amazon Web Services Region to use for request signing. If not specified, the Region is derived from the source URL hostname, falling back to the Region of the registry.
agui (dict) --
The AG-UI descriptor, populated for records detected from an AG-UI protocol source.
source (dict) --
The source configuration that defines where descriptor content is retrieved from.
fromUrl (dict) --
URL-based descriptor source, populated when descriptor content is synchronized from a URL.
url (string) --
The URL from which the descriptor content is retrieved.
credentialProviderConfigurations (list) --
The credential providers used to authenticate when fetching descriptor content from the source URL.
(dict) --
A credential provider configuration that specifies how to authenticate when fetching descriptor content from a registry record's source URL.
credentialProviderType (string) --
The type of credential provider.
credentialProvider (dict) --
The credential provider details corresponding to the specified credential provider type.
oauthCredentialProvider (dict) --
The OAuth 2.0 credential provider details.
providerArn (string) --
The Amazon Resource Name (ARN) of the OAuth 2.0 credential provider resource in Amazon Bedrock AgentCore Identity.
grantType (string) --
The OAuth 2.0 grant type used to obtain access tokens.
scopes (list) --
The OAuth 2.0 scopes to request when obtaining access tokens.
(string) --
customParameters (dict) --
Additional parameters to include in the OAuth 2.0 token request.
(string) --
(string) --
iamCredentialProvider (dict) --
The IAM role credential provider details.
roleArn (string) --
The Amazon Resource Name (ARN) of the IAM role to assume for request signing.
service (string) --
The service name to use for request signing, such as execute-api.
region (string) --
The Amazon Web Services Region to use for request signing. If not specified, the Region is derived from the source URL hostname, falling back to the Region of the registry.
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.
statusReason (string) --
The reason for the current status. Typically populated when the status indicates a failure state.
provenance (list) --
The provenance lineage entries for the registry record. Populated for records created by auto-detection; each entry identifies the upstream source that the record was detected from.
(dict) --
A provenance entry that describes the lineage of a registry record. Records that were auto-detected by Amazon Web Services Agent Registry carry a provenance entry that links the record back to its upstream source.
relation (string) --
The relationship between the registry record and its upstream source. DETECTED_FROM indicates that the record was auto-detected from the source resource.
sourceId (string) --
The identifier of the upstream source that the registry record was detected from.
sourceType (string) --
The type of the upstream source that the registry record was detected from.
sourceDetails (dict) --
Additional details about the upstream source that the registry record was detected from, such as the AgentCore Gateway or Runtime configuration. The populated member corresponds to the source type.
agentcoreRuntime (dict) --
The source details for a registry record that was auto-detected from an Amazon Bedrock AgentCore Runtime resource. Populated when the source type is AWS::BedrockAgentCore::Runtime.
protocolConfiguration (dict) --
The protocol configuration of the AgentCore Runtime resource that the registry record was detected from.
serverProtocol (string) --
The server protocol used by the AgentCore Runtime, such as MCP, HTTP, A2A, or AGUI.
authorizerConfiguration (dict) --
The authorizer configuration for a registry. Exactly one member is set.
customJWTAuthorizer (dict) --
Configuration for a custom JWT authorizer.
discoveryUrl (string) --
The OpenID Connect discovery URL used to retrieve the identity provider's metadata and signing keys.
allowedAudience (list) --
The audience values accepted during JWT validation. A token is rejected if none of its audience claims match.
(string) --
An audience value that an inbound JWT must contain to be authorized.
allowedClients (list) --
The client identifiers accepted during JWT validation. A token is rejected if it was not issued to one of these clients.
(string) --
A client identifier that an inbound JWT must be issued to in order to be authorized.
allowedScopes (list) --
The scopes accepted during JWT validation. A token is rejected if it does not carry one of these scopes.
(string) --
A scope value that an inbound JWT must carry to be authorized.
customClaims (list) --
Additional custom claim validations applied to the inbound JWT.
(dict) --
A validation rule applied to a single claim of an inbound JWT.
inboundTokenClaimName (string) --
The name of the claim in the inbound token to validate.
inboundTokenClaimValueType (string) --
The value type of the claim in the inbound token, either a string or an array of strings.
authorizingClaimMatchValue (dict) --
The value and match operator used to authorize the claim.
claimMatchValue (dict) --
The expected value or values that the claim is compared against.
matchValueString (string) --
A single string value to match the claim against.
matchValueStringList (list) --
A list of string values to match the claim against.
(string) --
A single value used to match a claim during JWT validation.
claimMatchOperator (string) --
The operator used to compare the claim value against the expected value.
privateEndpoint (dict) --
The private endpoint used to reach the identity provider's discovery URL over a private network path.
selfManagedLatticeResource (dict) --
A private endpoint backed by a self-managed VPC Lattice resource configuration.
resourceConfigurationIdentifier (string) --
The identifier of the VPC Lattice resource configuration, specified as a resource configuration ID or ARN.
managedVpcResource (dict) --
A private endpoint backed by a service-managed VPC resource.
vpcIdentifier (string) --
The identifier of the VPC in which the private endpoint is provisioned.
subnetIds (list) --
The identifiers of the subnets in which the private endpoint network interfaces are placed.
(string) --
Subnet identifier
endpointIpAddressType (string) --
The IP address type used by the private endpoint, either IPV4 or IPV6.
securityGroupIds (list) --
The identifiers of the security groups associated with the private endpoint network interfaces.
(string) --
The identifier of a security group.
tags (dict) --
The tags applied to the service-managed VPC resource.
(string) --
Key of a tag.
(string) --
Value of a tag.
routingDomain (string) --
The routing domain used to resolve traffic through the private endpoint.
privateEndpointOverrides (list) --
Per-domain private endpoint overrides that route specific identity provider domains through distinct private endpoints.
(dict) --
A mapping of a domain to the private endpoint used to reach it.
domain (string) --
The domain name to which this private endpoint override applies.
privateEndpoint (dict) --
The private endpoint used to reach the specified domain.
selfManagedLatticeResource (dict) --
A private endpoint backed by a self-managed VPC Lattice resource configuration.
resourceConfigurationIdentifier (string) --
The identifier of the VPC Lattice resource configuration, specified as a resource configuration ID or ARN.
managedVpcResource (dict) --
A private endpoint backed by a service-managed VPC resource.
vpcIdentifier (string) --
The identifier of the VPC in which the private endpoint is provisioned.
subnetIds (list) --
The identifiers of the subnets in which the private endpoint network interfaces are placed.
(string) --
Subnet identifier
endpointIpAddressType (string) --
The IP address type used by the private endpoint, either IPV4 or IPV6.
securityGroupIds (list) --
The identifiers of the security groups associated with the private endpoint network interfaces.
(string) --
The identifier of a security group.
tags (dict) --
The tags applied to the service-managed VPC resource.
(string) --
Key of a tag.
(string) --
Value of a tag.
routingDomain (string) --
The routing domain used to resolve traffic through the private endpoint.
workloadIdentityDetails (dict) --
The workload identity details for the AgentCore Runtime resource. Present when the runtime has a workload identity configured.
workloadIdentityArn (string) --
The Amazon Resource Name (ARN) of the workload identity associated with the source resource.
agentcoreGateway (dict) --
The source details for a registry record that was auto-detected from an Amazon Bedrock AgentCore Gateway resource. Populated when the source type is AWS::BedrockAgentCore::Gateway.
protocolType (string) --
The protocol type of the AgentCore Gateway resource that the registry record was detected from, for example MCP.
authorizerType (string) --
The type of authorizer configured on the AgentCore Gateway resource that the registry record was detected from.
authorizerConfiguration (dict) --
The authorizer configuration for a registry. Exactly one member is set.
customJWTAuthorizer (dict) --
Configuration for a custom JWT authorizer.
discoveryUrl (string) --
The OpenID Connect discovery URL used to retrieve the identity provider's metadata and signing keys.
allowedAudience (list) --
The audience values accepted during JWT validation. A token is rejected if none of its audience claims match.
(string) --
An audience value that an inbound JWT must contain to be authorized.
allowedClients (list) --
The client identifiers accepted during JWT validation. A token is rejected if it was not issued to one of these clients.
(string) --
A client identifier that an inbound JWT must be issued to in order to be authorized.
allowedScopes (list) --
The scopes accepted during JWT validation. A token is rejected if it does not carry one of these scopes.
(string) --
A scope value that an inbound JWT must carry to be authorized.
customClaims (list) --
Additional custom claim validations applied to the inbound JWT.
(dict) --
A validation rule applied to a single claim of an inbound JWT.
inboundTokenClaimName (string) --
The name of the claim in the inbound token to validate.
inboundTokenClaimValueType (string) --
The value type of the claim in the inbound token, either a string or an array of strings.
authorizingClaimMatchValue (dict) --
The value and match operator used to authorize the claim.
claimMatchValue (dict) --
The expected value or values that the claim is compared against.
matchValueString (string) --
A single string value to match the claim against.
matchValueStringList (list) --
A list of string values to match the claim against.
(string) --
A single value used to match a claim during JWT validation.
claimMatchOperator (string) --
The operator used to compare the claim value against the expected value.
privateEndpoint (dict) --
The private endpoint used to reach the identity provider's discovery URL over a private network path.
selfManagedLatticeResource (dict) --
A private endpoint backed by a self-managed VPC Lattice resource configuration.
resourceConfigurationIdentifier (string) --
The identifier of the VPC Lattice resource configuration, specified as a resource configuration ID or ARN.
managedVpcResource (dict) --
A private endpoint backed by a service-managed VPC resource.
vpcIdentifier (string) --
The identifier of the VPC in which the private endpoint is provisioned.
subnetIds (list) --
The identifiers of the subnets in which the private endpoint network interfaces are placed.
(string) --
Subnet identifier
endpointIpAddressType (string) --
The IP address type used by the private endpoint, either IPV4 or IPV6.
securityGroupIds (list) --
The identifiers of the security groups associated with the private endpoint network interfaces.
(string) --
The identifier of a security group.
tags (dict) --
The tags applied to the service-managed VPC resource.
(string) --
Key of a tag.
(string) --
Value of a tag.
routingDomain (string) --
The routing domain used to resolve traffic through the private endpoint.
privateEndpointOverrides (list) --
Per-domain private endpoint overrides that route specific identity provider domains through distinct private endpoints.
(dict) --
A mapping of a domain to the private endpoint used to reach it.
domain (string) --
The domain name to which this private endpoint override applies.
privateEndpoint (dict) --
The private endpoint used to reach the specified domain.
selfManagedLatticeResource (dict) --
A private endpoint backed by a self-managed VPC Lattice resource configuration.
resourceConfigurationIdentifier (string) --
The identifier of the VPC Lattice resource configuration, specified as a resource configuration ID or ARN.
managedVpcResource (dict) --
A private endpoint backed by a service-managed VPC resource.
vpcIdentifier (string) --
The identifier of the VPC in which the private endpoint is provisioned.
subnetIds (list) --
The identifiers of the subnets in which the private endpoint network interfaces are placed.
(string) --
Subnet identifier
endpointIpAddressType (string) --
The IP address type used by the private endpoint, either IPV4 or IPV6.
securityGroupIds (list) --
The identifiers of the security groups associated with the private endpoint network interfaces.
(string) --
The identifier of a security group.
tags (dict) --
The tags applied to the service-managed VPC resource.
(string) --
Key of a tag.
(string) --
Value of a tag.
routingDomain (string) --
The routing domain used to resolve traffic through the private endpoint.
workloadIdentityDetails (dict) --
The workload identity details for the AgentCore Gateway resource. Present when the gateway has a workload identity configured.
workloadIdentityArn (string) --
The Amazon Resource Name (ARN) of the workload identity associated with the source resource.
createdByAutoDetection (boolean) --
Specifies whether the registry record was created by auto-detection. true indicates the record was automatically created by the service based on the registry's auto-detection configuration; false indicates the record was created through a control-plane API call.
createdBy (string) --
The ID of the Amazon Web Services account that created the registry record.
customMetadata (:ref:`document<document>`) --
The custom metadata attached to this registry record. Values are strings (maximum 128 characters) or booleans.
customMetadataSchemaComplianceStatus (string) --
Indicates whether this record's custom metadata conforms to the registry's current schema. This status is computed at read time against the latest schema.
{'registryRecords': {'customMetadataSchemaComplianceStatus': 'COMPLIANT | '
'NON_COMPLIANT'}}
Lists the registry records within a registry, with optional filtering by name, status, and record type
See also: AWS API Documentation
Request Syntax
client.list_registry_records(
registryId='string',
maxResults=123,
nextToken='string',
filters=[
{
'name': 'name'|'status'|'recordType',
'values': [
'string',
]
},
]
)
string
[REQUIRED]
The identifier of the registry to list records from (ARN or ID)
integer
Maximum number of records to return
string
Token for pagination
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.
dict
Response Syntax
{
'registryRecords': [
{
'registryArn': 'string',
'recordArn': 'string',
'recordId': 'string',
'name': 'string',
'displayName': 'string',
'description': '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),
'createdByAutoDetection': True|False,
'createdBy': 'string',
'provenanceSummaryList': [
{
'relation': 'DETECTED_FROM',
'sourceId': 'string',
'sourceType': 'AWS::BedrockAgentCore::Runtime'|'AWS::BedrockAgentCore::Gateway'
},
],
'customMetadataSchemaComplianceStatus': 'COMPLIANT'|'NON_COMPLIANT'
},
],
'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 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.
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.
createdByAutoDetection (boolean) --
Specifies whether the registry record was created by auto-detection. true indicates the record was automatically created by the service based on the registry's auto-detection configuration; false indicates the record was created through a control-plane API call.
createdBy (string) --
The ID of the Amazon Web Services account that created the registry record.
provenanceSummaryList (list) --
The condensed provenance lineage for the registry record. Each entry contains the source relation, source identifier, and source type of an auto-detection lineage entry. Populated for records created by auto-detection.
(dict) --
A condensed provenance entry surfaced in list results. Contains the source identity of a lineage entry without the source details returned by GetRegistryRecord.
relation (string) --
The relationship between the registry record and its upstream source. DETECTED_FROM indicates that the record was auto-detected from the source resource.
sourceId (string) --
The identifier of the upstream source that the registry record was detected from.
sourceType (string) --
The type of the upstream source that the registry record was detected from.
customMetadataSchemaComplianceStatus (string) --
Indicates whether this record's custom metadata conforms to the registry's current schema.
nextToken (string) --
Token for next page of results
{'customMetadataSchemaConfiguration': {'optionalValue': {'defaultSchema': 'string',
'recordTypeSchemaOverrides': [{'recordType': 'MCP '
'| '
'AGENT '
'| '
'CUSTOM '
'| '
'SKILL '
'| '
'GATEWAY',
'schema': 'string'}]}}}
Response {'customMetadataSchemaConfiguration': {'defaultSchema': 'string',
'recordTypeSchemaOverrides': [{'recordType': 'MCP '
'| '
'AGENT '
'| '
'CUSTOM '
'| '
'SKILL '
'| '
'GATEWAY',
'schema': 'string'}]}}
Updates an existing registry. This operation uses PATCH semantics: specify only the fields you want to change, and omit the rest to leave them unchanged. Updates are applied asynchronously and the registry transitions to the UPDATING status while they are processed.
See also: AWS API Documentation
Request Syntax
client.update_registry(
registryId='string',
name='string',
description={
'optionalValue': 'string'
},
discoveryConfiguration={
'authorizerConfiguration': {
'optionalValue': {
'customJWTAuthorizer': {
'discoveryUrl': 'string',
'allowedAudience': [
'string',
],
'allowedClients': [
'string',
],
'allowedScopes': [
'string',
],
'customClaims': [
{
'inboundTokenClaimName': 'string',
'inboundTokenClaimValueType': 'STRING'|'STRING_ARRAY',
'authorizingClaimMatchValue': {
'claimMatchValue': {
'matchValueString': 'string',
'matchValueStringList': [
'string',
]
},
'claimMatchOperator': 'EQUALS'|'CONTAINS'|'CONTAINS_ANY'
}
},
],
'privateEndpoint': {
'selfManagedLatticeResource': {
'resourceConfigurationIdentifier': 'string'
},
'managedVpcResource': {
'vpcIdentifier': 'string',
'subnetIds': [
'string',
],
'endpointIpAddressType': 'IPV4'|'IPV6',
'securityGroupIds': [
'string',
],
'tags': {
'string': 'string'
},
'routingDomain': 'string'
}
},
'privateEndpointOverrides': [
{
'domain': 'string',
'privateEndpoint': {
'selfManagedLatticeResource': {
'resourceConfigurationIdentifier': 'string'
},
'managedVpcResource': {
'vpcIdentifier': 'string',
'subnetIds': [
'string',
],
'endpointIpAddressType': 'IPV4'|'IPV6',
'securityGroupIds': [
'string',
],
'tags': {
'string': 'string'
},
'routingDomain': 'string'
}
}
},
]
}
}
}
},
approvalConfiguration={
'optionalValue': {
'autoApprovalRules': [
'APPROVE_ALL',
]
}
},
customMetadataSchemaConfiguration={
'optionalValue': {
'defaultSchema': 'string',
'recordTypeSchemaOverrides': [
{
'recordType': 'MCP'|'AGENT'|'CUSTOM'|'SKILL'|'GATEWAY',
'schema': 'string'
},
]
}
},
autoDetectionConfiguration={
'optionalValue': {
'scope': 'ORGANIZATION',
'enabled': True|False
}
}
)
string
[REQUIRED]
The identifier of the registry to update (ARN or ID)
string
The updated name of the registry
dict
The updated description of the registry
optionalValue (string) --
The value to set for this field. Omit the wrapper to leave the field unchanged.
dict
The updated discovery configuration. Changing the discovery authorization can break existing consumers that rely on the previous authorization type.
authorizerConfiguration (dict) --
Authorization configuration for the registry, with PATCH semantics
optionalValue (dict) --
The new authorizer configuration to set. Omit to leave the existing configuration unchanged.
customJWTAuthorizer (dict) --
Configuration for a custom JWT authorizer.
discoveryUrl (string) -- [REQUIRED]
The OpenID Connect discovery URL used to retrieve the identity provider's metadata and signing keys.
allowedAudience (list) --
The audience values accepted during JWT validation. A token is rejected if none of its audience claims match.
(string) --
An audience value that an inbound JWT must contain to be authorized.
allowedClients (list) --
The client identifiers accepted during JWT validation. A token is rejected if it was not issued to one of these clients.
(string) --
A client identifier that an inbound JWT must be issued to in order to be authorized.
allowedScopes (list) --
The scopes accepted during JWT validation. A token is rejected if it does not carry one of these scopes.
(string) --
A scope value that an inbound JWT must carry to be authorized.
customClaims (list) --
Additional custom claim validations applied to the inbound JWT.
(dict) --
A validation rule applied to a single claim of an inbound JWT.
inboundTokenClaimName (string) -- [REQUIRED]
The name of the claim in the inbound token to validate.
inboundTokenClaimValueType (string) -- [REQUIRED]
The value type of the claim in the inbound token, either a string or an array of strings.
authorizingClaimMatchValue (dict) -- [REQUIRED]
The value and match operator used to authorize the claim.
claimMatchValue (dict) -- [REQUIRED]
The expected value or values that the claim is compared against.
matchValueString (string) --
A single string value to match the claim against.
matchValueStringList (list) --
A list of string values to match the claim against.
(string) --
A single value used to match a claim during JWT validation.
claimMatchOperator (string) -- [REQUIRED]
The operator used to compare the claim value against the expected value.
privateEndpoint (dict) --
The private endpoint used to reach the identity provider's discovery URL over a private network path.
selfManagedLatticeResource (dict) --
A private endpoint backed by a self-managed VPC Lattice resource configuration.
resourceConfigurationIdentifier (string) --
The identifier of the VPC Lattice resource configuration, specified as a resource configuration ID or ARN.
managedVpcResource (dict) --
A private endpoint backed by a service-managed VPC resource.
vpcIdentifier (string) -- [REQUIRED]
The identifier of the VPC in which the private endpoint is provisioned.
subnetIds (list) -- [REQUIRED]
The identifiers of the subnets in which the private endpoint network interfaces are placed.
(string) --
Subnet identifier
endpointIpAddressType (string) -- [REQUIRED]
The IP address type used by the private endpoint, either IPV4 or IPV6.
securityGroupIds (list) --
The identifiers of the security groups associated with the private endpoint network interfaces.
(string) --
The identifier of a security group.
tags (dict) --
The tags applied to the service-managed VPC resource.
(string) --
Key of a tag.
(string) --
Value of a tag.
routingDomain (string) --
The routing domain used to resolve traffic through the private endpoint.
privateEndpointOverrides (list) --
Per-domain private endpoint overrides that route specific identity provider domains through distinct private endpoints.
(dict) --
A mapping of a domain to the private endpoint used to reach it.
domain (string) -- [REQUIRED]
The domain name to which this private endpoint override applies.
privateEndpoint (dict) -- [REQUIRED]
The private endpoint used to reach the specified domain.
selfManagedLatticeResource (dict) --
A private endpoint backed by a self-managed VPC Lattice resource configuration.
resourceConfigurationIdentifier (string) --
The identifier of the VPC Lattice resource configuration, specified as a resource configuration ID or ARN.
managedVpcResource (dict) --
A private endpoint backed by a service-managed VPC resource.
vpcIdentifier (string) -- [REQUIRED]
The identifier of the VPC in which the private endpoint is provisioned.
subnetIds (list) -- [REQUIRED]
The identifiers of the subnets in which the private endpoint network interfaces are placed.
(string) --
Subnet identifier
endpointIpAddressType (string) -- [REQUIRED]
The IP address type used by the private endpoint, either IPV4 or IPV6.
securityGroupIds (list) --
The identifiers of the security groups associated with the private endpoint network interfaces.
(string) --
The identifier of a security group.
tags (dict) --
The tags applied to the service-managed VPC resource.
(string) --
Key of a tag.
(string) --
Value of a tag.
routingDomain (string) --
The routing domain used to resolve traffic through the private endpoint.
dict
The updated approval configuration. The change applies only to records that move to PENDING_APPROVAL after the update; records already in PENDING_APPROVAL are unaffected.
optionalValue (dict) --
The value to set for this field. Omit the wrapper to leave the field unchanged.
autoApprovalRules (list) --
The rules that determine which registry records are automatically approved on submission. When omitted or empty, submitted records require manual review.
(string) --
dict
Updated custom metadata schema configuration for the registry. Omit to leave the existing schema unchanged. Schema evolution is additive only: you can add properties and enum values, but you cannot remove properties, change property types or formats, add or remove enum constraints, or remove record type overrides.
optionalValue (dict) --
The value to set for this field. Omit the wrapper to leave the field unchanged.
defaultSchema (string) --
The default JSON Schema that applies to record types without a specific override. Supported property types are string, string with an enum constraint, string with a uri format, and boolean.
recordTypeSchemaOverrides (list) --
A list of per-record-type schema overrides. When a record's type matches an override, that override's schema is used instead of the default schema for validation. If you don't specify an override for a record type, the default schema applies. If no default schema exists, custom metadata on records of that type is rejected.
(dict) --
A schema override for a specific record type within a custom metadata schema configuration.
recordType (string) -- [REQUIRED]
The record type that this schema override applies to.
schema (string) -- [REQUIRED]
The JSON Schema for the specified record type. Must follow the same structural rules as the default schema.
dict
The updated auto-detection configuration for the registry, with PATCH semantics. Omit this field to leave the current configuration unchanged. Supply an empty wrapper to unset it. Supply optionalValue to replace it.
optionalValue (dict) --
The value to set for this field. Omit the wrapper to leave the field unchanged.
scope (string) -- [REQUIRED]
The source from which resources are detected. For example, ORGANIZATION sources resources from all member accounts of an Amazon Web Services organization.
enabled (boolean) -- [REQUIRED]
Specifies whether auto-detection is requested for the registry. Setting this to true is necessary but not sufficient for auto-detection to become active; the preconditions of the configured scope must also be met.
dict
Response Syntax
{
'name': 'string',
'description': 'string',
'registryId': 'string',
'registryArn': 'string',
'discoveryConfiguration': {
'authorizerConfiguration': {
'customJWTAuthorizer': {
'discoveryUrl': 'string',
'allowedAudience': [
'string',
],
'allowedClients': [
'string',
],
'allowedScopes': [
'string',
],
'customClaims': [
{
'inboundTokenClaimName': 'string',
'inboundTokenClaimValueType': 'STRING'|'STRING_ARRAY',
'authorizingClaimMatchValue': {
'claimMatchValue': {
'matchValueString': 'string',
'matchValueStringList': [
'string',
]
},
'claimMatchOperator': 'EQUALS'|'CONTAINS'|'CONTAINS_ANY'
}
},
],
'privateEndpoint': {
'selfManagedLatticeResource': {
'resourceConfigurationIdentifier': 'string'
},
'managedVpcResource': {
'vpcIdentifier': 'string',
'subnetIds': [
'string',
],
'endpointIpAddressType': 'IPV4'|'IPV6',
'securityGroupIds': [
'string',
],
'tags': {
'string': 'string'
},
'routingDomain': 'string'
}
},
'privateEndpointOverrides': [
{
'domain': 'string',
'privateEndpoint': {
'selfManagedLatticeResource': {
'resourceConfigurationIdentifier': 'string'
},
'managedVpcResource': {
'vpcIdentifier': 'string',
'subnetIds': [
'string',
],
'endpointIpAddressType': 'IPV4'|'IPV6',
'securityGroupIds': [
'string',
],
'tags': {
'string': 'string'
},
'routingDomain': 'string'
}
}
},
]
}
},
'authorizerType': 'CUSTOM_JWT'|'AWS_IAM'
},
'encryptionConfiguration': {
'kmsKeyArn': 'string'
},
'approvalConfiguration': {
'autoApprovalRules': [
'APPROVE_ALL',
]
},
'customMetadataSchemaConfiguration': {
'defaultSchema': 'string',
'recordTypeSchemaOverrides': [
{
'recordType': 'MCP'|'AGENT'|'CUSTOM'|'SKILL'|'GATEWAY',
'schema': 'string'
},
]
},
'status': 'CREATING'|'READY'|'UPDATING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETING'|'DELETE_FAILED',
'statusReason': 'string',
'autoDetection': {
'configuration': {
'scope': 'ORGANIZATION',
'enabled': True|False
},
'status': 'ACTIVE'|'INACTIVE',
'statusReason': 'string'
},
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
Response structure for updating a registry
name (string) --
The name of the registry
description (string) --
The description of the registry
registryId (string) --
The unique identifier of the registry
registryArn (string) --
The ARN of the registry
discoveryConfiguration (dict) --
Discovery configuration for the registry
authorizerConfiguration (dict) --
The authorizer configuration for the registry. Required when authorizerType is CUSTOM_JWT.
customJWTAuthorizer (dict) --
Configuration for a custom JWT authorizer.
discoveryUrl (string) --
The OpenID Connect discovery URL used to retrieve the identity provider's metadata and signing keys.
allowedAudience (list) --
The audience values accepted during JWT validation. A token is rejected if none of its audience claims match.
(string) --
An audience value that an inbound JWT must contain to be authorized.
allowedClients (list) --
The client identifiers accepted during JWT validation. A token is rejected if it was not issued to one of these clients.
(string) --
A client identifier that an inbound JWT must be issued to in order to be authorized.
allowedScopes (list) --
The scopes accepted during JWT validation. A token is rejected if it does not carry one of these scopes.
(string) --
A scope value that an inbound JWT must carry to be authorized.
customClaims (list) --
Additional custom claim validations applied to the inbound JWT.
(dict) --
A validation rule applied to a single claim of an inbound JWT.
inboundTokenClaimName (string) --
The name of the claim in the inbound token to validate.
inboundTokenClaimValueType (string) --
The value type of the claim in the inbound token, either a string or an array of strings.
authorizingClaimMatchValue (dict) --
The value and match operator used to authorize the claim.
claimMatchValue (dict) --
The expected value or values that the claim is compared against.
matchValueString (string) --
A single string value to match the claim against.
matchValueStringList (list) --
A list of string values to match the claim against.
(string) --
A single value used to match a claim during JWT validation.
claimMatchOperator (string) --
The operator used to compare the claim value against the expected value.
privateEndpoint (dict) --
The private endpoint used to reach the identity provider's discovery URL over a private network path.
selfManagedLatticeResource (dict) --
A private endpoint backed by a self-managed VPC Lattice resource configuration.
resourceConfigurationIdentifier (string) --
The identifier of the VPC Lattice resource configuration, specified as a resource configuration ID or ARN.
managedVpcResource (dict) --
A private endpoint backed by a service-managed VPC resource.
vpcIdentifier (string) --
The identifier of the VPC in which the private endpoint is provisioned.
subnetIds (list) --
The identifiers of the subnets in which the private endpoint network interfaces are placed.
(string) --
Subnet identifier
endpointIpAddressType (string) --
The IP address type used by the private endpoint, either IPV4 or IPV6.
securityGroupIds (list) --
The identifiers of the security groups associated with the private endpoint network interfaces.
(string) --
The identifier of a security group.
tags (dict) --
The tags applied to the service-managed VPC resource.
(string) --
Key of a tag.
(string) --
Value of a tag.
routingDomain (string) --
The routing domain used to resolve traffic through the private endpoint.
privateEndpointOverrides (list) --
Per-domain private endpoint overrides that route specific identity provider domains through distinct private endpoints.
(dict) --
A mapping of a domain to the private endpoint used to reach it.
domain (string) --
The domain name to which this private endpoint override applies.
privateEndpoint (dict) --
The private endpoint used to reach the specified domain.
selfManagedLatticeResource (dict) --
A private endpoint backed by a self-managed VPC Lattice resource configuration.
resourceConfigurationIdentifier (string) --
The identifier of the VPC Lattice resource configuration, specified as a resource configuration ID or ARN.
managedVpcResource (dict) --
A private endpoint backed by a service-managed VPC resource.
vpcIdentifier (string) --
The identifier of the VPC in which the private endpoint is provisioned.
subnetIds (list) --
The identifiers of the subnets in which the private endpoint network interfaces are placed.
(string) --
Subnet identifier
endpointIpAddressType (string) --
The IP address type used by the private endpoint, either IPV4 or IPV6.
securityGroupIds (list) --
The identifiers of the security groups associated with the private endpoint network interfaces.
(string) --
The identifier of a security group.
tags (dict) --
The tags applied to the service-managed VPC resource.
(string) --
Key of a tag.
(string) --
Value of a tag.
routingDomain (string) --
The routing domain used to resolve traffic through the private endpoint.
authorizerType (string) --
The type of authorizer that controls how consumers access the registry's search and MCP invoke operations.
encryptionConfiguration (dict) --
The server-side encryption configuration for the registry. Appears only when a customer-managed Amazon Web Services KMS key encrypts the registry.
kmsKeyArn (string) --
The Amazon Resource Name (ARN) of the customer-managed Amazon Web Services KMS key used to encrypt the registry's content. The key must be a symmetric encryption key in the same Amazon Web Services account and Region as the registry.
approvalConfiguration (dict) --
Approval configuration for registry records
autoApprovalRules (list) --
The rules that determine which registry records are automatically approved on submission. When omitted or empty, submitted records require manual review.
(string) --
customMetadataSchemaConfiguration (dict) --
The custom metadata schema configuration for this registry, if one has been defined.
defaultSchema (string) --
The default JSON Schema that applies to record types without a specific override. Supported property types are string, string with an enum constraint, string with a uri format, and boolean.
recordTypeSchemaOverrides (list) --
A list of per-record-type schema overrides. When a record's type matches an override, that override's schema is used instead of the default schema for validation. If you don't specify an override for a record type, the default schema applies. If no default schema exists, custom metadata on records of that type is rejected.
(dict) --
A schema override for a specific record type within a custom metadata schema configuration.
recordType (string) --
The record type that this schema override applies to.
schema (string) --
The JSON Schema for the specified record type. Must follow the same structural rules as the default schema.
status (string) --
Current status of the registry
statusReason (string) --
The reason for the current status. Typically populated when the status indicates a failure state.
autoDetection (dict) --
The registry's auto-detection properties, including the requested configuration and the current detection status. Present only when auto-detection was configured for the registry.
configuration (dict) --
The auto-detection settings that control how resources are discovered for the registry.
scope (string) --
The source from which resources are detected. For example, ORGANIZATION sources resources from all member accounts of an Amazon Web Services organization.
enabled (boolean) --
Specifies whether auto-detection is requested for the registry. Setting this to true is necessary but not sufficient for auto-detection to become active; the preconditions of the configured scope must also be met.
status (string) --
The current auto-detection status. ACTIVE indicates that the registry is actively being populated with detected resources. INACTIVE indicates that the preconditions required at the configured scope are not currently met.
statusReason (string) --
A human-readable explanation of the current auto-detection status. Typically populated when the status requires additional context.
createdAt (datetime) --
The timestamp when the registry was created
updatedAt (datetime) --
The timestamp when the registry was last updated
{'customMetadata': {'optionalValue': {}}}
Response {'customMetadata': {},
'customMetadataSchemaComplianceStatus': 'COMPLIANT | NON_COMPLIANT'}
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.
See also: AWS API Documentation
Request Syntax
client.update_registry_record(
registryId='string',
recordId='string',
name='string',
displayName={
'optionalValue': 'string'
},
description={
'optionalValue': 'string'
},
recordType='MCP'|'AGENT'|'CUSTOM'|'SKILL'|'GATEWAY',
descriptors={
'optionalValue': {
'mcpServer': {
'optionalValue': {
'data': {
'optionalValue': 'string'
},
'dataSchemaVersion': {
'optionalValue': 'string'
},
'source': {
'optionalValue': {
'fromUrl': {
'url': 'string',
'credentialProviderConfigurations': [
{
'credentialProviderType': 'OAUTH'|'IAM',
'credentialProvider': {
'oauthCredentialProvider': {
'providerArn': 'string',
'grantType': 'CLIENT_CREDENTIALS',
'scopes': [
'string',
],
'customParameters': {
'string': 'string'
}
},
'iamCredentialProvider': {
'roleArn': 'string',
'service': 'string',
'region': 'string'
}
}
},
]
}
}
},
'additionalData': {
'optionalValue': {
'tools': {
'optionalValue': {
'data': {
'optionalValue': 'string'
},
'dataSchemaVersion': {
'optionalValue': 'string'
}
}
}
}
}
}
},
'a2aAgentCard': {
'optionalValue': {
'data': {
'optionalValue': 'string'
},
'dataSchemaVersion': {
'optionalValue': 'string'
},
'source': {
'optionalValue': {
'fromUrl': {
'url': 'string',
'credentialProviderConfigurations': [
{
'credentialProviderType': 'OAUTH'|'IAM',
'credentialProvider': {
'oauthCredentialProvider': {
'providerArn': 'string',
'grantType': 'CLIENT_CREDENTIALS',
'scopes': [
'string',
],
'customParameters': {
'string': 'string'
}
},
'iamCredentialProvider': {
'roleArn': 'string',
'service': 'string',
'region': 'string'
}
}
},
]
}
}
}
}
},
'agentSkillsDefinition': {
'optionalValue': {
'data': {
'optionalValue': 'string'
},
'dataSchemaVersion': {
'optionalValue': 'string'
},
'additionalData': {
'optionalValue': {
'skillMd': {
'optionalValue': {
'data': {
'optionalValue': 'string'
},
'dataSchemaVersion': {
'optionalValue': 'string'
},
'source': {
'optionalValue': {
'fromUrl': {
'url': 'string',
'credentialProviderConfigurations': [
{
'credentialProviderType': 'OAUTH'|'IAM',
'credentialProvider': {
'oauthCredentialProvider': {
'providerArn': 'string',
'grantType': 'CLIENT_CREDENTIALS',
'scopes': [
'string',
],
'customParameters': {
'string': 'string'
}
},
'iamCredentialProvider': {
'roleArn': 'string',
'service': 'string',
'region': 'string'
}
}
},
]
}
}
}
}
}
}
}
}
},
'custom': {
'optionalValue': {
'data': {
'optionalValue': 'string'
}
}
},
'http': {
'optionalValue': {
'source': {
'optionalValue': {
'fromUrl': {
'url': 'string',
'credentialProviderConfigurations': [
{
'credentialProviderType': 'OAUTH'|'IAM',
'credentialProvider': {
'oauthCredentialProvider': {
'providerArn': 'string',
'grantType': 'CLIENT_CREDENTIALS',
'scopes': [
'string',
],
'customParameters': {
'string': 'string'
}
},
'iamCredentialProvider': {
'roleArn': 'string',
'service': 'string',
'region': 'string'
}
}
},
]
}
}
}
}
},
'agui': {
'optionalValue': {
'source': {
'optionalValue': {
'fromUrl': {
'url': 'string',
'credentialProviderConfigurations': [
{
'credentialProviderType': 'OAUTH'|'IAM',
'credentialProvider': {
'oauthCredentialProvider': {
'providerArn': 'string',
'grantType': 'CLIENT_CREDENTIALS',
'scopes': [
'string',
],
'customParameters': {
'string': 'string'
}
},
'iamCredentialProvider': {
'roleArn': 'string',
'service': 'string',
'region': 'string'
}
}
},
]
}
}
}
}
}
}
},
recordVersion='string',
customMetadata={
'optionalValue': {...}|[...]|123|123.4|'string'|True|None
},
triggerSynchronization=True|False,
provenance=[
{
'relation': 'DETECTED_FROM',
'sourceId': 'string',
'sourceType': 'AWS::BedrockAgentCore::Runtime'|'AWS::BedrockAgentCore::Gateway',
'sourceDetails': {
'agentcoreRuntime': {
'protocolConfiguration': {
'serverProtocol': 'HTTP'|'A2A'|'MCP'|'AGUI'
},
'authorizerConfiguration': {
'customJWTAuthorizer': {
'discoveryUrl': 'string',
'allowedAudience': [
'string',
],
'allowedClients': [
'string',
],
'allowedScopes': [
'string',
],
'customClaims': [
{
'inboundTokenClaimName': 'string',
'inboundTokenClaimValueType': 'STRING'|'STRING_ARRAY',
'authorizingClaimMatchValue': {
'claimMatchValue': {
'matchValueString': 'string',
'matchValueStringList': [
'string',
]
},
'claimMatchOperator': 'EQUALS'|'CONTAINS'|'CONTAINS_ANY'
}
},
],
'privateEndpoint': {
'selfManagedLatticeResource': {
'resourceConfigurationIdentifier': 'string'
},
'managedVpcResource': {
'vpcIdentifier': 'string',
'subnetIds': [
'string',
],
'endpointIpAddressType': 'IPV4'|'IPV6',
'securityGroupIds': [
'string',
],
'tags': {
'string': 'string'
},
'routingDomain': 'string'
}
},
'privateEndpointOverrides': [
{
'domain': 'string',
'privateEndpoint': {
'selfManagedLatticeResource': {
'resourceConfigurationIdentifier': 'string'
},
'managedVpcResource': {
'vpcIdentifier': 'string',
'subnetIds': [
'string',
],
'endpointIpAddressType': 'IPV4'|'IPV6',
'securityGroupIds': [
'string',
],
'tags': {
'string': 'string'
},
'routingDomain': 'string'
}
}
},
]
}
},
'workloadIdentityDetails': {
'workloadIdentityArn': 'string'
}
},
'agentcoreGateway': {
'protocolType': 'MCP',
'authorizerType': 'string',
'authorizerConfiguration': {
'customJWTAuthorizer': {
'discoveryUrl': 'string',
'allowedAudience': [
'string',
],
'allowedClients': [
'string',
],
'allowedScopes': [
'string',
],
'customClaims': [
{
'inboundTokenClaimName': 'string',
'inboundTokenClaimValueType': 'STRING'|'STRING_ARRAY',
'authorizingClaimMatchValue': {
'claimMatchValue': {
'matchValueString': 'string',
'matchValueStringList': [
'string',
]
},
'claimMatchOperator': 'EQUALS'|'CONTAINS'|'CONTAINS_ANY'
}
},
],
'privateEndpoint': {
'selfManagedLatticeResource': {
'resourceConfigurationIdentifier': 'string'
},
'managedVpcResource': {
'vpcIdentifier': 'string',
'subnetIds': [
'string',
],
'endpointIpAddressType': 'IPV4'|'IPV6',
'securityGroupIds': [
'string',
],
'tags': {
'string': 'string'
},
'routingDomain': 'string'
}
},
'privateEndpointOverrides': [
{
'domain': 'string',
'privateEndpoint': {
'selfManagedLatticeResource': {
'resourceConfigurationIdentifier': 'string'
},
'managedVpcResource': {
'vpcIdentifier': 'string',
'subnetIds': [
'string',
],
'endpointIpAddressType': 'IPV4'|'IPV6',
'securityGroupIds': [
'string',
],
'tags': {
'string': 'string'
},
'routingDomain': 'string'
}
}
},
]
}
},
'workloadIdentityDetails': {
'workloadIdentityArn': 'string'
}
}
}
},
]
)
string
[REQUIRED]
The identifier of the registry containing the record (ARN or ID)
string
[REQUIRED]
The identifier of the registry record to update (ARN or ID)
string
The updated name of the registry record. Omit to leave the name unchanged.
dict
The updated display name of the registry record. Omit to leave the display name unchanged; provide an empty wrapper to unset it.
optionalValue (string) --
The value to set for this field. Omit the wrapper to leave the field unchanged.
dict
The updated description of the registry record. Omit to leave the description unchanged; provide an empty wrapper to unset it.
optionalValue (string) --
The value to set for this field. Omit the wrapper to leave the field unchanged.
string
The updated type of the registry record. Omit to leave the record type unchanged.
dict
The updated typed descriptor content for the registry record. Omit to leave the descriptors unchanged.
optionalValue (dict) --
The value to set for this field. Omit the wrapper to leave the field unchanged.
mcpServer (dict) --
The patch for the MCP server descriptor.
optionalValue (dict) --
The value to set for this field. Omit the wrapper to leave the field unchanged.
data (dict) --
The patch for the descriptor's data field.
optionalValue (string) --
The value to set for this field. Omit the wrapper to leave the field unchanged.
dataSchemaVersion (dict) --
The patch for the descriptor's data schema version field.
optionalValue (string) --
The value to set for this field. Omit the wrapper to leave the field unchanged.
source (dict) --
The patch for the descriptor's source field.
optionalValue (dict) --
The value to set for this field. Omit the wrapper to leave the field unchanged.
fromUrl (dict) --
URL-based descriptor source, populated when descriptor content is synchronized from a URL.
url (string) -- [REQUIRED]
The URL from which the descriptor content is retrieved.
credentialProviderConfigurations (list) --
The credential providers used to authenticate when fetching descriptor content from the source URL.
(dict) --
A credential provider configuration that specifies how to authenticate when fetching descriptor content from a registry record's source URL.
credentialProviderType (string) -- [REQUIRED]
The type of credential provider.
credentialProvider (dict) -- [REQUIRED]
The credential provider details corresponding to the specified credential provider type.
oauthCredentialProvider (dict) --
The OAuth 2.0 credential provider details.
providerArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the OAuth 2.0 credential provider resource in Amazon Bedrock AgentCore Identity.
grantType (string) --
The OAuth 2.0 grant type used to obtain access tokens.
scopes (list) --
The OAuth 2.0 scopes to request when obtaining access tokens.
(string) --
customParameters (dict) --
Additional parameters to include in the OAuth 2.0 token request.
(string) --
(string) --
iamCredentialProvider (dict) --
The IAM role credential provider details.
roleArn (string) --
The Amazon Resource Name (ARN) of the IAM role to assume for request signing.
service (string) --
The service name to use for request signing, such as execute-api.
region (string) --
The Amazon Web Services Region to use for request signing. If not specified, the Region is derived from the source URL hostname, falling back to the Region of the registry.
additionalData (dict) --
The patch for the descriptor's additional data field.
optionalValue (dict) --
The value to set for this field. Omit the wrapper to leave the field unchanged.
tools (dict) --
The patch for the MCP tools descriptor field.
optionalValue (dict) --
The value to set for this field. Omit the wrapper to leave the field unchanged.
data (dict) --
The patch for the descriptor's data field.
optionalValue (string) --
The value to set for this field. Omit the wrapper to leave the field unchanged.
dataSchemaVersion (dict) --
The patch for the descriptor's data schema version field.
optionalValue (string) --
The value to set for this field. Omit the wrapper to leave the field unchanged.
a2aAgentCard (dict) --
The patch for the A2A agent card descriptor.
optionalValue (dict) --
The value to set for this field. Omit the wrapper to leave the field unchanged.
data (dict) --
The patch for the descriptor's data field.
optionalValue (string) --
The value to set for this field. Omit the wrapper to leave the field unchanged.
dataSchemaVersion (dict) --
The patch for the descriptor's data schema version field.
optionalValue (string) --
The value to set for this field. Omit the wrapper to leave the field unchanged.
source (dict) --
The patch for the descriptor's source field.
optionalValue (dict) --
The value to set for this field. Omit the wrapper to leave the field unchanged.
fromUrl (dict) --
URL-based descriptor source, populated when descriptor content is synchronized from a URL.
url (string) -- [REQUIRED]
The URL from which the descriptor content is retrieved.
credentialProviderConfigurations (list) --
The credential providers used to authenticate when fetching descriptor content from the source URL.
(dict) --
A credential provider configuration that specifies how to authenticate when fetching descriptor content from a registry record's source URL.
credentialProviderType (string) -- [REQUIRED]
The type of credential provider.
credentialProvider (dict) -- [REQUIRED]
The credential provider details corresponding to the specified credential provider type.
oauthCredentialProvider (dict) --
The OAuth 2.0 credential provider details.
providerArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the OAuth 2.0 credential provider resource in Amazon Bedrock AgentCore Identity.
grantType (string) --
The OAuth 2.0 grant type used to obtain access tokens.
scopes (list) --
The OAuth 2.0 scopes to request when obtaining access tokens.
(string) --
customParameters (dict) --
Additional parameters to include in the OAuth 2.0 token request.
(string) --
(string) --
iamCredentialProvider (dict) --
The IAM role credential provider details.
roleArn (string) --
The Amazon Resource Name (ARN) of the IAM role to assume for request signing.
service (string) --
The service name to use for request signing, such as execute-api.
region (string) --
The Amazon Web Services Region to use for request signing. If not specified, the Region is derived from the source URL hostname, falling back to the Region of the registry.
agentSkillsDefinition (dict) --
The patch for the agent skills definition descriptor.
optionalValue (dict) --
The value to set for this field. Omit the wrapper to leave the field unchanged.
data (dict) --
The patch for the descriptor's data field.
optionalValue (string) --
The value to set for this field. Omit the wrapper to leave the field unchanged.
dataSchemaVersion (dict) --
The patch for the descriptor's data schema version field.
optionalValue (string) --
The value to set for this field. Omit the wrapper to leave the field unchanged.
additionalData (dict) --
The patch for the descriptor's additional data field.
optionalValue (dict) --
The value to set for this field. Omit the wrapper to leave the field unchanged.
skillMd (dict) --
The patch for the agent skills markdown descriptor field.
optionalValue (dict) --
The value to set for this field. Omit the wrapper to leave the field unchanged.
data (dict) --
The patch for the descriptor's data field.
optionalValue (string) --
The value to set for this field. Omit the wrapper to leave the field unchanged.
dataSchemaVersion (dict) --
The patch for the descriptor's data schema version field.
optionalValue (string) --
The value to set for this field. Omit the wrapper to leave the field unchanged.
source (dict) --
The patch for the descriptor's source field.
optionalValue (dict) --
The value to set for this field. Omit the wrapper to leave the field unchanged.
fromUrl (dict) --
URL-based descriptor source, populated when descriptor content is synchronized from a URL.
url (string) -- [REQUIRED]
The URL from which the descriptor content is retrieved.
credentialProviderConfigurations (list) --
The credential providers used to authenticate when fetching descriptor content from the source URL.
(dict) --
A credential provider configuration that specifies how to authenticate when fetching descriptor content from a registry record's source URL.
credentialProviderType (string) -- [REQUIRED]
The type of credential provider.
credentialProvider (dict) -- [REQUIRED]
The credential provider details corresponding to the specified credential provider type.
oauthCredentialProvider (dict) --
The OAuth 2.0 credential provider details.
providerArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the OAuth 2.0 credential provider resource in Amazon Bedrock AgentCore Identity.
grantType (string) --
The OAuth 2.0 grant type used to obtain access tokens.
scopes (list) --
The OAuth 2.0 scopes to request when obtaining access tokens.
(string) --
customParameters (dict) --
Additional parameters to include in the OAuth 2.0 token request.
(string) --
(string) --
iamCredentialProvider (dict) --
The IAM role credential provider details.
roleArn (string) --
The Amazon Resource Name (ARN) of the IAM role to assume for request signing.
service (string) --
The service name to use for request signing, such as execute-api.
region (string) --
The Amazon Web Services Region to use for request signing. If not specified, the Region is derived from the source URL hostname, falling back to the Region of the registry.
custom (dict) --
The patch for the custom descriptor.
optionalValue (dict) --
The value to set for this field. Omit the wrapper to leave the field unchanged.
data (dict) --
The patch for the descriptor's data field.
optionalValue (string) --
The value to set for this field. Omit the wrapper to leave the field unchanged.
http (dict) --
The patch for the HTTP descriptor.
optionalValue (dict) --
The value to set for this field. Omit the wrapper to leave the field unchanged.
source (dict) --
The patch for the descriptor's source field.
optionalValue (dict) --
The value to set for this field. Omit the wrapper to leave the field unchanged.
fromUrl (dict) --
URL-based descriptor source, populated when descriptor content is synchronized from a URL.
url (string) -- [REQUIRED]
The URL from which the descriptor content is retrieved.
credentialProviderConfigurations (list) --
The credential providers used to authenticate when fetching descriptor content from the source URL.
(dict) --
A credential provider configuration that specifies how to authenticate when fetching descriptor content from a registry record's source URL.
credentialProviderType (string) -- [REQUIRED]
The type of credential provider.
credentialProvider (dict) -- [REQUIRED]
The credential provider details corresponding to the specified credential provider type.
oauthCredentialProvider (dict) --
The OAuth 2.0 credential provider details.
providerArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the OAuth 2.0 credential provider resource in Amazon Bedrock AgentCore Identity.
grantType (string) --
The OAuth 2.0 grant type used to obtain access tokens.
scopes (list) --
The OAuth 2.0 scopes to request when obtaining access tokens.
(string) --
customParameters (dict) --
Additional parameters to include in the OAuth 2.0 token request.
(string) --
(string) --
iamCredentialProvider (dict) --
The IAM role credential provider details.
roleArn (string) --
The Amazon Resource Name (ARN) of the IAM role to assume for request signing.
service (string) --
The service name to use for request signing, such as execute-api.
region (string) --
The Amazon Web Services Region to use for request signing. If not specified, the Region is derived from the source URL hostname, falling back to the Region of the registry.
agui (dict) --
The patch for the AG-UI descriptor.
optionalValue (dict) --
The value to set for this field. Omit the wrapper to leave the field unchanged.
source (dict) --
The patch for the descriptor's source field.
optionalValue (dict) --
The value to set for this field. Omit the wrapper to leave the field unchanged.
fromUrl (dict) --
URL-based descriptor source, populated when descriptor content is synchronized from a URL.
url (string) -- [REQUIRED]
The URL from which the descriptor content is retrieved.
credentialProviderConfigurations (list) --
The credential providers used to authenticate when fetching descriptor content from the source URL.
(dict) --
A credential provider configuration that specifies how to authenticate when fetching descriptor content from a registry record's source URL.
credentialProviderType (string) -- [REQUIRED]
The type of credential provider.
credentialProvider (dict) -- [REQUIRED]
The credential provider details corresponding to the specified credential provider type.
oauthCredentialProvider (dict) --
The OAuth 2.0 credential provider details.
providerArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the OAuth 2.0 credential provider resource in Amazon Bedrock AgentCore Identity.
grantType (string) --
The OAuth 2.0 grant type used to obtain access tokens.
scopes (list) --
The OAuth 2.0 scopes to request when obtaining access tokens.
(string) --
customParameters (dict) --
Additional parameters to include in the OAuth 2.0 token request.
(string) --
(string) --
iamCredentialProvider (dict) --
The IAM role credential provider details.
roleArn (string) --
The Amazon Resource Name (ARN) of the IAM role to assume for request signing.
service (string) --
The service name to use for request signing, such as execute-api.
region (string) --
The Amazon Web Services Region to use for request signing. If not specified, the Region is derived from the source URL hostname, falling back to the Region of the registry.
string
The updated version of the registry record. Omit to leave the version unchanged.
dict
The updated custom metadata for the registry record. Values can be strings (maximum 128 characters) or native JSON booleans ( true or false). Omit to leave the existing metadata unchanged. Supply the wrapper with a full replacement set to update, or with a null value to clear all metadata.
optionalValue (:ref:`document<document>`) --
The value to set for this field. Omit the wrapper to leave the field unchanged.
boolean
Whether to trigger synchronization of the record's descriptor content from its source
list
The provenance lineage re-assertion for the registry record. This field is reserved for the Amazon Web Services Agent Registry auto-detection service principal. Requests that include this field from other callers are rejected. The source identity of an existing lineage is immutable; a re-assertion may only refresh the source details.
(dict) --
A provenance entry that describes the lineage of a registry record. Records that were auto-detected by Amazon Web Services Agent Registry carry a provenance entry that links the record back to its upstream source.
relation (string) -- [REQUIRED]
The relationship between the registry record and its upstream source. DETECTED_FROM indicates that the record was auto-detected from the source resource.
sourceId (string) -- [REQUIRED]
The identifier of the upstream source that the registry record was detected from.
sourceType (string) --
The type of the upstream source that the registry record was detected from.
sourceDetails (dict) --
Additional details about the upstream source that the registry record was detected from, such as the AgentCore Gateway or Runtime configuration. The populated member corresponds to the source type.
agentcoreRuntime (dict) --
The source details for a registry record that was auto-detected from an Amazon Bedrock AgentCore Runtime resource. Populated when the source type is AWS::BedrockAgentCore::Runtime.
protocolConfiguration (dict) --
The protocol configuration of the AgentCore Runtime resource that the registry record was detected from.
serverProtocol (string) --
The server protocol used by the AgentCore Runtime, such as MCP, HTTP, A2A, or AGUI.
authorizerConfiguration (dict) --
The authorizer configuration for a registry. Exactly one member is set.
customJWTAuthorizer (dict) --
Configuration for a custom JWT authorizer.
discoveryUrl (string) -- [REQUIRED]
The OpenID Connect discovery URL used to retrieve the identity provider's metadata and signing keys.
allowedAudience (list) --
The audience values accepted during JWT validation. A token is rejected if none of its audience claims match.
(string) --
An audience value that an inbound JWT must contain to be authorized.
allowedClients (list) --
The client identifiers accepted during JWT validation. A token is rejected if it was not issued to one of these clients.
(string) --
A client identifier that an inbound JWT must be issued to in order to be authorized.
allowedScopes (list) --
The scopes accepted during JWT validation. A token is rejected if it does not carry one of these scopes.
(string) --
A scope value that an inbound JWT must carry to be authorized.
customClaims (list) --
Additional custom claim validations applied to the inbound JWT.
(dict) --
A validation rule applied to a single claim of an inbound JWT.
inboundTokenClaimName (string) -- [REQUIRED]
The name of the claim in the inbound token to validate.
inboundTokenClaimValueType (string) -- [REQUIRED]
The value type of the claim in the inbound token, either a string or an array of strings.
authorizingClaimMatchValue (dict) -- [REQUIRED]
The value and match operator used to authorize the claim.
claimMatchValue (dict) -- [REQUIRED]
The expected value or values that the claim is compared against.
matchValueString (string) --
A single string value to match the claim against.
matchValueStringList (list) --
A list of string values to match the claim against.
(string) --
A single value used to match a claim during JWT validation.
claimMatchOperator (string) -- [REQUIRED]
The operator used to compare the claim value against the expected value.
privateEndpoint (dict) --
The private endpoint used to reach the identity provider's discovery URL over a private network path.
selfManagedLatticeResource (dict) --
A private endpoint backed by a self-managed VPC Lattice resource configuration.
resourceConfigurationIdentifier (string) --
The identifier of the VPC Lattice resource configuration, specified as a resource configuration ID or ARN.
managedVpcResource (dict) --
A private endpoint backed by a service-managed VPC resource.
vpcIdentifier (string) -- [REQUIRED]
The identifier of the VPC in which the private endpoint is provisioned.
subnetIds (list) -- [REQUIRED]
The identifiers of the subnets in which the private endpoint network interfaces are placed.
(string) --
Subnet identifier
endpointIpAddressType (string) -- [REQUIRED]
The IP address type used by the private endpoint, either IPV4 or IPV6.
securityGroupIds (list) --
The identifiers of the security groups associated with the private endpoint network interfaces.
(string) --
The identifier of a security group.
tags (dict) --
The tags applied to the service-managed VPC resource.
(string) --
Key of a tag.
(string) --
Value of a tag.
routingDomain (string) --
The routing domain used to resolve traffic through the private endpoint.
privateEndpointOverrides (list) --
Per-domain private endpoint overrides that route specific identity provider domains through distinct private endpoints.
(dict) --
A mapping of a domain to the private endpoint used to reach it.
domain (string) -- [REQUIRED]
The domain name to which this private endpoint override applies.
privateEndpoint (dict) -- [REQUIRED]
The private endpoint used to reach the specified domain.
selfManagedLatticeResource (dict) --
A private endpoint backed by a self-managed VPC Lattice resource configuration.
resourceConfigurationIdentifier (string) --
The identifier of the VPC Lattice resource configuration, specified as a resource configuration ID or ARN.
managedVpcResource (dict) --
A private endpoint backed by a service-managed VPC resource.
vpcIdentifier (string) -- [REQUIRED]
The identifier of the VPC in which the private endpoint is provisioned.
subnetIds (list) -- [REQUIRED]
The identifiers of the subnets in which the private endpoint network interfaces are placed.
(string) --
Subnet identifier
endpointIpAddressType (string) -- [REQUIRED]
The IP address type used by the private endpoint, either IPV4 or IPV6.
securityGroupIds (list) --
The identifiers of the security groups associated with the private endpoint network interfaces.
(string) --
The identifier of a security group.
tags (dict) --
The tags applied to the service-managed VPC resource.
(string) --
Key of a tag.
(string) --
Value of a tag.
routingDomain (string) --
The routing domain used to resolve traffic through the private endpoint.
workloadIdentityDetails (dict) --
The workload identity details for the AgentCore Runtime resource. Present when the runtime has a workload identity configured.
workloadIdentityArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the workload identity associated with the source resource.
agentcoreGateway (dict) --
The source details for a registry record that was auto-detected from an Amazon Bedrock AgentCore Gateway resource. Populated when the source type is AWS::BedrockAgentCore::Gateway.
protocolType (string) --
The protocol type of the AgentCore Gateway resource that the registry record was detected from, for example MCP.
authorizerType (string) --
The type of authorizer configured on the AgentCore Gateway resource that the registry record was detected from.
authorizerConfiguration (dict) --
The authorizer configuration for a registry. Exactly one member is set.
customJWTAuthorizer (dict) --
Configuration for a custom JWT authorizer.
discoveryUrl (string) -- [REQUIRED]
The OpenID Connect discovery URL used to retrieve the identity provider's metadata and signing keys.
allowedAudience (list) --
The audience values accepted during JWT validation. A token is rejected if none of its audience claims match.
(string) --
An audience value that an inbound JWT must contain to be authorized.
allowedClients (list) --
The client identifiers accepted during JWT validation. A token is rejected if it was not issued to one of these clients.
(string) --
A client identifier that an inbound JWT must be issued to in order to be authorized.
allowedScopes (list) --
The scopes accepted during JWT validation. A token is rejected if it does not carry one of these scopes.
(string) --
A scope value that an inbound JWT must carry to be authorized.
customClaims (list) --
Additional custom claim validations applied to the inbound JWT.
(dict) --
A validation rule applied to a single claim of an inbound JWT.
inboundTokenClaimName (string) -- [REQUIRED]
The name of the claim in the inbound token to validate.
inboundTokenClaimValueType (string) -- [REQUIRED]
The value type of the claim in the inbound token, either a string or an array of strings.
authorizingClaimMatchValue (dict) -- [REQUIRED]
The value and match operator used to authorize the claim.
claimMatchValue (dict) -- [REQUIRED]
The expected value or values that the claim is compared against.
matchValueString (string) --
A single string value to match the claim against.
matchValueStringList (list) --
A list of string values to match the claim against.
(string) --
A single value used to match a claim during JWT validation.
claimMatchOperator (string) -- [REQUIRED]
The operator used to compare the claim value against the expected value.
privateEndpoint (dict) --
The private endpoint used to reach the identity provider's discovery URL over a private network path.
selfManagedLatticeResource (dict) --
A private endpoint backed by a self-managed VPC Lattice resource configuration.
resourceConfigurationIdentifier (string) --
The identifier of the VPC Lattice resource configuration, specified as a resource configuration ID or ARN.
managedVpcResource (dict) --
A private endpoint backed by a service-managed VPC resource.
vpcIdentifier (string) -- [REQUIRED]
The identifier of the VPC in which the private endpoint is provisioned.
subnetIds (list) -- [REQUIRED]
The identifiers of the subnets in which the private endpoint network interfaces are placed.
(string) --
Subnet identifier
endpointIpAddressType (string) -- [REQUIRED]
The IP address type used by the private endpoint, either IPV4 or IPV6.
securityGroupIds (list) --
The identifiers of the security groups associated with the private endpoint network interfaces.
(string) --
The identifier of a security group.
tags (dict) --
The tags applied to the service-managed VPC resource.
(string) --
Key of a tag.
(string) --
Value of a tag.
routingDomain (string) --
The routing domain used to resolve traffic through the private endpoint.
privateEndpointOverrides (list) --
Per-domain private endpoint overrides that route specific identity provider domains through distinct private endpoints.
(dict) --
A mapping of a domain to the private endpoint used to reach it.
domain (string) -- [REQUIRED]
The domain name to which this private endpoint override applies.
privateEndpoint (dict) -- [REQUIRED]
The private endpoint used to reach the specified domain.
selfManagedLatticeResource (dict) --
A private endpoint backed by a self-managed VPC Lattice resource configuration.
resourceConfigurationIdentifier (string) --
The identifier of the VPC Lattice resource configuration, specified as a resource configuration ID or ARN.
managedVpcResource (dict) --
A private endpoint backed by a service-managed VPC resource.
vpcIdentifier (string) -- [REQUIRED]
The identifier of the VPC in which the private endpoint is provisioned.
subnetIds (list) -- [REQUIRED]
The identifiers of the subnets in which the private endpoint network interfaces are placed.
(string) --
Subnet identifier
endpointIpAddressType (string) -- [REQUIRED]
The IP address type used by the private endpoint, either IPV4 or IPV6.
securityGroupIds (list) --
The identifiers of the security groups associated with the private endpoint network interfaces.
(string) --
The identifier of a security group.
tags (dict) --
The tags applied to the service-managed VPC resource.
(string) --
Key of a tag.
(string) --
Value of a tag.
routingDomain (string) --
The routing domain used to resolve traffic through the private endpoint.
workloadIdentityDetails (dict) --
The workload identity details for the AgentCore Gateway resource. Present when the gateway has a workload identity configured.
workloadIdentityArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the workload identity associated with the source resource.
dict
Response Syntax
{
'registryArn': 'string',
'recordArn': 'string',
'recordId': 'string',
'name': 'string',
'displayName': 'string',
'description': 'string',
'recordType': 'MCP'|'AGENT'|'CUSTOM'|'SKILL'|'GATEWAY',
'descriptors': {
'mcpServer': {
'data': 'string',
'dataSchemaVersion': 'string',
'additionalData': {
'tools': {
'data': 'string',
'dataSchemaVersion': 'string'
}
},
'source': {
'fromUrl': {
'url': 'string',
'credentialProviderConfigurations': [
{
'credentialProviderType': 'OAUTH'|'IAM',
'credentialProvider': {
'oauthCredentialProvider': {
'providerArn': 'string',
'grantType': 'CLIENT_CREDENTIALS',
'scopes': [
'string',
],
'customParameters': {
'string': 'string'
}
},
'iamCredentialProvider': {
'roleArn': 'string',
'service': 'string',
'region': 'string'
}
}
},
]
}
}
},
'a2aAgentCard': {
'data': 'string',
'dataSchemaVersion': 'string',
'source': {
'fromUrl': {
'url': 'string',
'credentialProviderConfigurations': [
{
'credentialProviderType': 'OAUTH'|'IAM',
'credentialProvider': {
'oauthCredentialProvider': {
'providerArn': 'string',
'grantType': 'CLIENT_CREDENTIALS',
'scopes': [
'string',
],
'customParameters': {
'string': 'string'
}
},
'iamCredentialProvider': {
'roleArn': 'string',
'service': 'string',
'region': 'string'
}
}
},
]
}
}
},
'agentSkillsDefinition': {
'data': 'string',
'dataSchemaVersion': 'string',
'additionalData': {
'skillMd': {
'data': 'string',
'dataSchemaVersion': 'string',
'source': {
'fromUrl': {
'url': 'string',
'credentialProviderConfigurations': [
{
'credentialProviderType': 'OAUTH'|'IAM',
'credentialProvider': {
'oauthCredentialProvider': {
'providerArn': 'string',
'grantType': 'CLIENT_CREDENTIALS',
'scopes': [
'string',
],
'customParameters': {
'string': 'string'
}
},
'iamCredentialProvider': {
'roleArn': 'string',
'service': 'string',
'region': 'string'
}
}
},
]
}
}
}
}
},
'custom': {
'data': 'string'
},
'http': {
'source': {
'fromUrl': {
'url': 'string',
'credentialProviderConfigurations': [
{
'credentialProviderType': 'OAUTH'|'IAM',
'credentialProvider': {
'oauthCredentialProvider': {
'providerArn': 'string',
'grantType': 'CLIENT_CREDENTIALS',
'scopes': [
'string',
],
'customParameters': {
'string': 'string'
}
},
'iamCredentialProvider': {
'roleArn': 'string',
'service': 'string',
'region': 'string'
}
}
},
]
}
}
},
'agui': {
'source': {
'fromUrl': {
'url': 'string',
'credentialProviderConfigurations': [
{
'credentialProviderType': 'OAUTH'|'IAM',
'credentialProvider': {
'oauthCredentialProvider': {
'providerArn': 'string',
'grantType': 'CLIENT_CREDENTIALS',
'scopes': [
'string',
],
'customParameters': {
'string': 'string'
}
},
'iamCredentialProvider': {
'roleArn': 'string',
'service': 'string',
'region': 'string'
}
}
},
]
}
}
}
},
'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),
'statusReason': 'string',
'provenance': [
{
'relation': 'DETECTED_FROM',
'sourceId': 'string',
'sourceType': 'AWS::BedrockAgentCore::Runtime'|'AWS::BedrockAgentCore::Gateway',
'sourceDetails': {
'agentcoreRuntime': {
'protocolConfiguration': {
'serverProtocol': 'HTTP'|'A2A'|'MCP'|'AGUI'
},
'authorizerConfiguration': {
'customJWTAuthorizer': {
'discoveryUrl': 'string',
'allowedAudience': [
'string',
],
'allowedClients': [
'string',
],
'allowedScopes': [
'string',
],
'customClaims': [
{
'inboundTokenClaimName': 'string',
'inboundTokenClaimValueType': 'STRING'|'STRING_ARRAY',
'authorizingClaimMatchValue': {
'claimMatchValue': {
'matchValueString': 'string',
'matchValueStringList': [
'string',
]
},
'claimMatchOperator': 'EQUALS'|'CONTAINS'|'CONTAINS_ANY'
}
},
],
'privateEndpoint': {
'selfManagedLatticeResource': {
'resourceConfigurationIdentifier': 'string'
},
'managedVpcResource': {
'vpcIdentifier': 'string',
'subnetIds': [
'string',
],
'endpointIpAddressType': 'IPV4'|'IPV6',
'securityGroupIds': [
'string',
],
'tags': {
'string': 'string'
},
'routingDomain': 'string'
}
},
'privateEndpointOverrides': [
{
'domain': 'string',
'privateEndpoint': {
'selfManagedLatticeResource': {
'resourceConfigurationIdentifier': 'string'
},
'managedVpcResource': {
'vpcIdentifier': 'string',
'subnetIds': [
'string',
],
'endpointIpAddressType': 'IPV4'|'IPV6',
'securityGroupIds': [
'string',
],
'tags': {
'string': 'string'
},
'routingDomain': 'string'
}
}
},
]
}
},
'workloadIdentityDetails': {
'workloadIdentityArn': 'string'
}
},
'agentcoreGateway': {
'protocolType': 'MCP',
'authorizerType': 'string',
'authorizerConfiguration': {
'customJWTAuthorizer': {
'discoveryUrl': 'string',
'allowedAudience': [
'string',
],
'allowedClients': [
'string',
],
'allowedScopes': [
'string',
],
'customClaims': [
{
'inboundTokenClaimName': 'string',
'inboundTokenClaimValueType': 'STRING'|'STRING_ARRAY',
'authorizingClaimMatchValue': {
'claimMatchValue': {
'matchValueString': 'string',
'matchValueStringList': [
'string',
]
},
'claimMatchOperator': 'EQUALS'|'CONTAINS'|'CONTAINS_ANY'
}
},
],
'privateEndpoint': {
'selfManagedLatticeResource': {
'resourceConfigurationIdentifier': 'string'
},
'managedVpcResource': {
'vpcIdentifier': 'string',
'subnetIds': [
'string',
],
'endpointIpAddressType': 'IPV4'|'IPV6',
'securityGroupIds': [
'string',
],
'tags': {
'string': 'string'
},
'routingDomain': 'string'
}
},
'privateEndpointOverrides': [
{
'domain': 'string',
'privateEndpoint': {
'selfManagedLatticeResource': {
'resourceConfigurationIdentifier': 'string'
},
'managedVpcResource': {
'vpcIdentifier': 'string',
'subnetIds': [
'string',
],
'endpointIpAddressType': 'IPV4'|'IPV6',
'securityGroupIds': [
'string',
],
'tags': {
'string': 'string'
},
'routingDomain': 'string'
}
}
},
]
}
},
'workloadIdentityDetails': {
'workloadIdentityArn': 'string'
}
}
}
},
],
'createdByAutoDetection': True|False,
'createdBy': 'string',
'customMetadata': {...}|[...]|123|123.4|'string'|True|None,
'customMetadataSchemaComplianceStatus': 'COMPLIANT'|'NON_COMPLIANT'
}
Response Structure
(dict) --
Response structure for updating a registry record
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.
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.
descriptors (dict) --
The typed descriptors that define the content of the registry record.
mcpServer (dict) --
The MCP server descriptor, populated when the record type is MCP.
data (string) --
The MCP server descriptor content, serialized as descriptor payload data.
dataSchemaVersion (string) --
The schema version of the descriptor payload.
additionalData (dict) --
Additional data associated with the MCP server descriptor, such as tool definitions.
tools (dict) --
The MCP tools descriptor that defines the tools exposed by the MCP server.
data (string) --
The MCP tools descriptor content, serialized as descriptor payload data.
dataSchemaVersion (string) --
The schema version of the descriptor payload.
source (dict) --
The optional source configuration used to synchronize the MCP server descriptor content.
fromUrl (dict) --
URL-based descriptor source, populated when descriptor content is synchronized from a URL.
url (string) --
The URL from which the descriptor content is retrieved.
credentialProviderConfigurations (list) --
The credential providers used to authenticate when fetching descriptor content from the source URL.
(dict) --
A credential provider configuration that specifies how to authenticate when fetching descriptor content from a registry record's source URL.
credentialProviderType (string) --
The type of credential provider.
credentialProvider (dict) --
The credential provider details corresponding to the specified credential provider type.
oauthCredentialProvider (dict) --
The OAuth 2.0 credential provider details.
providerArn (string) --
The Amazon Resource Name (ARN) of the OAuth 2.0 credential provider resource in Amazon Bedrock AgentCore Identity.
grantType (string) --
The OAuth 2.0 grant type used to obtain access tokens.
scopes (list) --
The OAuth 2.0 scopes to request when obtaining access tokens.
(string) --
customParameters (dict) --
Additional parameters to include in the OAuth 2.0 token request.
(string) --
(string) --
iamCredentialProvider (dict) --
The IAM role credential provider details.
roleArn (string) --
The Amazon Resource Name (ARN) of the IAM role to assume for request signing.
service (string) --
The service name to use for request signing, such as execute-api.
region (string) --
The Amazon Web Services Region to use for request signing. If not specified, the Region is derived from the source URL hostname, falling back to the Region of the registry.
a2aAgentCard (dict) --
The A2A agent card descriptor, populated when the record type is AGENT.
data (string) --
The A2A agent card content, serialized as descriptor payload data.
dataSchemaVersion (string) --
The schema version of the descriptor payload.
source (dict) --
The optional source configuration used to synchronize the A2A agent card descriptor content.
fromUrl (dict) --
URL-based descriptor source, populated when descriptor content is synchronized from a URL.
url (string) --
The URL from which the descriptor content is retrieved.
credentialProviderConfigurations (list) --
The credential providers used to authenticate when fetching descriptor content from the source URL.
(dict) --
A credential provider configuration that specifies how to authenticate when fetching descriptor content from a registry record's source URL.
credentialProviderType (string) --
The type of credential provider.
credentialProvider (dict) --
The credential provider details corresponding to the specified credential provider type.
oauthCredentialProvider (dict) --
The OAuth 2.0 credential provider details.
providerArn (string) --
The Amazon Resource Name (ARN) of the OAuth 2.0 credential provider resource in Amazon Bedrock AgentCore Identity.
grantType (string) --
The OAuth 2.0 grant type used to obtain access tokens.
scopes (list) --
The OAuth 2.0 scopes to request when obtaining access tokens.
(string) --
customParameters (dict) --
Additional parameters to include in the OAuth 2.0 token request.
(string) --
(string) --
iamCredentialProvider (dict) --
The IAM role credential provider details.
roleArn (string) --
The Amazon Resource Name (ARN) of the IAM role to assume for request signing.
service (string) --
The service name to use for request signing, such as execute-api.
region (string) --
The Amazon Web Services Region to use for request signing. If not specified, the Region is derived from the source URL hostname, falling back to the Region of the registry.
agentSkillsDefinition (dict) --
The agent skills definition descriptor, populated when the record type is SKILL.
data (string) --
The agent skills definition content, serialized as descriptor payload data.
dataSchemaVersion (string) --
The schema version of the descriptor payload.
additionalData (dict) --
Additional data associated with the agent skills definition descriptor.
skillMd (dict) --
The markdown skill content associated with an agent skills definition.
data (string) --
The agent skills markdown content, serialized as descriptor payload data.
dataSchemaVersion (string) --
The schema version of the descriptor payload.
source (dict) --
The optional source configuration used to synchronize the agent skills markdown content.
fromUrl (dict) --
URL-based descriptor source, populated when descriptor content is synchronized from a URL.
url (string) --
The URL from which the descriptor content is retrieved.
credentialProviderConfigurations (list) --
The credential providers used to authenticate when fetching descriptor content from the source URL.
(dict) --
A credential provider configuration that specifies how to authenticate when fetching descriptor content from a registry record's source URL.
credentialProviderType (string) --
The type of credential provider.
credentialProvider (dict) --
The credential provider details corresponding to the specified credential provider type.
oauthCredentialProvider (dict) --
The OAuth 2.0 credential provider details.
providerArn (string) --
The Amazon Resource Name (ARN) of the OAuth 2.0 credential provider resource in Amazon Bedrock AgentCore Identity.
grantType (string) --
The OAuth 2.0 grant type used to obtain access tokens.
scopes (list) --
The OAuth 2.0 scopes to request when obtaining access tokens.
(string) --
customParameters (dict) --
Additional parameters to include in the OAuth 2.0 token request.
(string) --
(string) --
iamCredentialProvider (dict) --
The IAM role credential provider details.
roleArn (string) --
The Amazon Resource Name (ARN) of the IAM role to assume for request signing.
service (string) --
The service name to use for request signing, such as execute-api.
region (string) --
The Amazon Web Services Region to use for request signing. If not specified, the Region is derived from the source URL hostname, falling back to the Region of the registry.
custom (dict) --
The custom descriptor, populated when the record type is CUSTOM.
data (string) --
The custom descriptor content, serialized as descriptor payload data.
http (dict) --
The HTTP descriptor, populated for records detected from an HTTP protocol source.
source (dict) --
The source configuration that defines where descriptor content is retrieved from.
fromUrl (dict) --
URL-based descriptor source, populated when descriptor content is synchronized from a URL.
url (string) --
The URL from which the descriptor content is retrieved.
credentialProviderConfigurations (list) --
The credential providers used to authenticate when fetching descriptor content from the source URL.
(dict) --
A credential provider configuration that specifies how to authenticate when fetching descriptor content from a registry record's source URL.
credentialProviderType (string) --
The type of credential provider.
credentialProvider (dict) --
The credential provider details corresponding to the specified credential provider type.
oauthCredentialProvider (dict) --
The OAuth 2.0 credential provider details.
providerArn (string) --
The Amazon Resource Name (ARN) of the OAuth 2.0 credential provider resource in Amazon Bedrock AgentCore Identity.
grantType (string) --
The OAuth 2.0 grant type used to obtain access tokens.
scopes (list) --
The OAuth 2.0 scopes to request when obtaining access tokens.
(string) --
customParameters (dict) --
Additional parameters to include in the OAuth 2.0 token request.
(string) --
(string) --
iamCredentialProvider (dict) --
The IAM role credential provider details.
roleArn (string) --
The Amazon Resource Name (ARN) of the IAM role to assume for request signing.
service (string) --
The service name to use for request signing, such as execute-api.
region (string) --
The Amazon Web Services Region to use for request signing. If not specified, the Region is derived from the source URL hostname, falling back to the Region of the registry.
agui (dict) --
The AG-UI descriptor, populated for records detected from an AG-UI protocol source.
source (dict) --
The source configuration that defines where descriptor content is retrieved from.
fromUrl (dict) --
URL-based descriptor source, populated when descriptor content is synchronized from a URL.
url (string) --
The URL from which the descriptor content is retrieved.
credentialProviderConfigurations (list) --
The credential providers used to authenticate when fetching descriptor content from the source URL.
(dict) --
A credential provider configuration that specifies how to authenticate when fetching descriptor content from a registry record's source URL.
credentialProviderType (string) --
The type of credential provider.
credentialProvider (dict) --
The credential provider details corresponding to the specified credential provider type.
oauthCredentialProvider (dict) --
The OAuth 2.0 credential provider details.
providerArn (string) --
The Amazon Resource Name (ARN) of the OAuth 2.0 credential provider resource in Amazon Bedrock AgentCore Identity.
grantType (string) --
The OAuth 2.0 grant type used to obtain access tokens.
scopes (list) --
The OAuth 2.0 scopes to request when obtaining access tokens.
(string) --
customParameters (dict) --
Additional parameters to include in the OAuth 2.0 token request.
(string) --
(string) --
iamCredentialProvider (dict) --
The IAM role credential provider details.
roleArn (string) --
The Amazon Resource Name (ARN) of the IAM role to assume for request signing.
service (string) --
The service name to use for request signing, such as execute-api.
region (string) --
The Amazon Web Services Region to use for request signing. If not specified, the Region is derived from the source URL hostname, falling back to the Region of the registry.
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.
statusReason (string) --
The reason for the current status. Typically populated when the status indicates a failure state.
provenance (list) --
The provenance lineage entries for the registry record. Populated for records created by auto-detection; each entry identifies the upstream source that the record was detected from.
(dict) --
A provenance entry that describes the lineage of a registry record. Records that were auto-detected by Amazon Web Services Agent Registry carry a provenance entry that links the record back to its upstream source.
relation (string) --
The relationship between the registry record and its upstream source. DETECTED_FROM indicates that the record was auto-detected from the source resource.
sourceId (string) --
The identifier of the upstream source that the registry record was detected from.
sourceType (string) --
The type of the upstream source that the registry record was detected from.
sourceDetails (dict) --
Additional details about the upstream source that the registry record was detected from, such as the AgentCore Gateway or Runtime configuration. The populated member corresponds to the source type.
agentcoreRuntime (dict) --
The source details for a registry record that was auto-detected from an Amazon Bedrock AgentCore Runtime resource. Populated when the source type is AWS::BedrockAgentCore::Runtime.
protocolConfiguration (dict) --
The protocol configuration of the AgentCore Runtime resource that the registry record was detected from.
serverProtocol (string) --
The server protocol used by the AgentCore Runtime, such as MCP, HTTP, A2A, or AGUI.
authorizerConfiguration (dict) --
The authorizer configuration for a registry. Exactly one member is set.
customJWTAuthorizer (dict) --
Configuration for a custom JWT authorizer.
discoveryUrl (string) --
The OpenID Connect discovery URL used to retrieve the identity provider's metadata and signing keys.
allowedAudience (list) --
The audience values accepted during JWT validation. A token is rejected if none of its audience claims match.
(string) --
An audience value that an inbound JWT must contain to be authorized.
allowedClients (list) --
The client identifiers accepted during JWT validation. A token is rejected if it was not issued to one of these clients.
(string) --
A client identifier that an inbound JWT must be issued to in order to be authorized.
allowedScopes (list) --
The scopes accepted during JWT validation. A token is rejected if it does not carry one of these scopes.
(string) --
A scope value that an inbound JWT must carry to be authorized.
customClaims (list) --
Additional custom claim validations applied to the inbound JWT.
(dict) --
A validation rule applied to a single claim of an inbound JWT.
inboundTokenClaimName (string) --
The name of the claim in the inbound token to validate.
inboundTokenClaimValueType (string) --
The value type of the claim in the inbound token, either a string or an array of strings.
authorizingClaimMatchValue (dict) --
The value and match operator used to authorize the claim.
claimMatchValue (dict) --
The expected value or values that the claim is compared against.
matchValueString (string) --
A single string value to match the claim against.
matchValueStringList (list) --
A list of string values to match the claim against.
(string) --
A single value used to match a claim during JWT validation.
claimMatchOperator (string) --
The operator used to compare the claim value against the expected value.
privateEndpoint (dict) --
The private endpoint used to reach the identity provider's discovery URL over a private network path.
selfManagedLatticeResource (dict) --
A private endpoint backed by a self-managed VPC Lattice resource configuration.
resourceConfigurationIdentifier (string) --
The identifier of the VPC Lattice resource configuration, specified as a resource configuration ID or ARN.
managedVpcResource (dict) --
A private endpoint backed by a service-managed VPC resource.
vpcIdentifier (string) --
The identifier of the VPC in which the private endpoint is provisioned.
subnetIds (list) --
The identifiers of the subnets in which the private endpoint network interfaces are placed.
(string) --
Subnet identifier
endpointIpAddressType (string) --
The IP address type used by the private endpoint, either IPV4 or IPV6.
securityGroupIds (list) --
The identifiers of the security groups associated with the private endpoint network interfaces.
(string) --
The identifier of a security group.
tags (dict) --
The tags applied to the service-managed VPC resource.
(string) --
Key of a tag.
(string) --
Value of a tag.
routingDomain (string) --
The routing domain used to resolve traffic through the private endpoint.
privateEndpointOverrides (list) --
Per-domain private endpoint overrides that route specific identity provider domains through distinct private endpoints.
(dict) --
A mapping of a domain to the private endpoint used to reach it.
domain (string) --
The domain name to which this private endpoint override applies.
privateEndpoint (dict) --
The private endpoint used to reach the specified domain.
selfManagedLatticeResource (dict) --
A private endpoint backed by a self-managed VPC Lattice resource configuration.
resourceConfigurationIdentifier (string) --
The identifier of the VPC Lattice resource configuration, specified as a resource configuration ID or ARN.
managedVpcResource (dict) --
A private endpoint backed by a service-managed VPC resource.
vpcIdentifier (string) --
The identifier of the VPC in which the private endpoint is provisioned.
subnetIds (list) --
The identifiers of the subnets in which the private endpoint network interfaces are placed.
(string) --
Subnet identifier
endpointIpAddressType (string) --
The IP address type used by the private endpoint, either IPV4 or IPV6.
securityGroupIds (list) --
The identifiers of the security groups associated with the private endpoint network interfaces.
(string) --
The identifier of a security group.
tags (dict) --
The tags applied to the service-managed VPC resource.
(string) --
Key of a tag.
(string) --
Value of a tag.
routingDomain (string) --
The routing domain used to resolve traffic through the private endpoint.
workloadIdentityDetails (dict) --
The workload identity details for the AgentCore Runtime resource. Present when the runtime has a workload identity configured.
workloadIdentityArn (string) --
The Amazon Resource Name (ARN) of the workload identity associated with the source resource.
agentcoreGateway (dict) --
The source details for a registry record that was auto-detected from an Amazon Bedrock AgentCore Gateway resource. Populated when the source type is AWS::BedrockAgentCore::Gateway.
protocolType (string) --
The protocol type of the AgentCore Gateway resource that the registry record was detected from, for example MCP.
authorizerType (string) --
The type of authorizer configured on the AgentCore Gateway resource that the registry record was detected from.
authorizerConfiguration (dict) --
The authorizer configuration for a registry. Exactly one member is set.
customJWTAuthorizer (dict) --
Configuration for a custom JWT authorizer.
discoveryUrl (string) --
The OpenID Connect discovery URL used to retrieve the identity provider's metadata and signing keys.
allowedAudience (list) --
The audience values accepted during JWT validation. A token is rejected if none of its audience claims match.
(string) --
An audience value that an inbound JWT must contain to be authorized.
allowedClients (list) --
The client identifiers accepted during JWT validation. A token is rejected if it was not issued to one of these clients.
(string) --
A client identifier that an inbound JWT must be issued to in order to be authorized.
allowedScopes (list) --
The scopes accepted during JWT validation. A token is rejected if it does not carry one of these scopes.
(string) --
A scope value that an inbound JWT must carry to be authorized.
customClaims (list) --
Additional custom claim validations applied to the inbound JWT.
(dict) --
A validation rule applied to a single claim of an inbound JWT.
inboundTokenClaimName (string) --
The name of the claim in the inbound token to validate.
inboundTokenClaimValueType (string) --
The value type of the claim in the inbound token, either a string or an array of strings.
authorizingClaimMatchValue (dict) --
The value and match operator used to authorize the claim.
claimMatchValue (dict) --
The expected value or values that the claim is compared against.
matchValueString (string) --
A single string value to match the claim against.
matchValueStringList (list) --
A list of string values to match the claim against.
(string) --
A single value used to match a claim during JWT validation.
claimMatchOperator (string) --
The operator used to compare the claim value against the expected value.
privateEndpoint (dict) --
The private endpoint used to reach the identity provider's discovery URL over a private network path.
selfManagedLatticeResource (dict) --
A private endpoint backed by a self-managed VPC Lattice resource configuration.
resourceConfigurationIdentifier (string) --
The identifier of the VPC Lattice resource configuration, specified as a resource configuration ID or ARN.
managedVpcResource (dict) --
A private endpoint backed by a service-managed VPC resource.
vpcIdentifier (string) --
The identifier of the VPC in which the private endpoint is provisioned.
subnetIds (list) --
The identifiers of the subnets in which the private endpoint network interfaces are placed.
(string) --
Subnet identifier
endpointIpAddressType (string) --
The IP address type used by the private endpoint, either IPV4 or IPV6.
securityGroupIds (list) --
The identifiers of the security groups associated with the private endpoint network interfaces.
(string) --
The identifier of a security group.
tags (dict) --
The tags applied to the service-managed VPC resource.
(string) --
Key of a tag.
(string) --
Value of a tag.
routingDomain (string) --
The routing domain used to resolve traffic through the private endpoint.
privateEndpointOverrides (list) --
Per-domain private endpoint overrides that route specific identity provider domains through distinct private endpoints.
(dict) --
A mapping of a domain to the private endpoint used to reach it.
domain (string) --
The domain name to which this private endpoint override applies.
privateEndpoint (dict) --
The private endpoint used to reach the specified domain.
selfManagedLatticeResource (dict) --
A private endpoint backed by a self-managed VPC Lattice resource configuration.
resourceConfigurationIdentifier (string) --
The identifier of the VPC Lattice resource configuration, specified as a resource configuration ID or ARN.
managedVpcResource (dict) --
A private endpoint backed by a service-managed VPC resource.
vpcIdentifier (string) --
The identifier of the VPC in which the private endpoint is provisioned.
subnetIds (list) --
The identifiers of the subnets in which the private endpoint network interfaces are placed.
(string) --
Subnet identifier
endpointIpAddressType (string) --
The IP address type used by the private endpoint, either IPV4 or IPV6.
securityGroupIds (list) --
The identifiers of the security groups associated with the private endpoint network interfaces.
(string) --
The identifier of a security group.
tags (dict) --
The tags applied to the service-managed VPC resource.
(string) --
Key of a tag.
(string) --
Value of a tag.
routingDomain (string) --
The routing domain used to resolve traffic through the private endpoint.
workloadIdentityDetails (dict) --
The workload identity details for the AgentCore Gateway resource. Present when the gateway has a workload identity configured.
workloadIdentityArn (string) --
The Amazon Resource Name (ARN) of the workload identity associated with the source resource.
createdByAutoDetection (boolean) --
Specifies whether the registry record was created by auto-detection. true indicates the record was automatically created by the service based on the registry's auto-detection configuration; false indicates the record was created through a control-plane API call.
createdBy (string) --
The ID of the Amazon Web Services account that created the registry record.
customMetadata (:ref:`document<document>`) --
The custom metadata attached to this registry record. Values are strings (maximum 128 characters) or booleans.
customMetadataSchemaComplianceStatus (string) --
Indicates whether this record's custom metadata conforms to the registry's current schema. This status is computed at read time against the latest schema.