2026/08/06 - Agent Registry Control - 15 new api methods
Changes Agent Registry's Public Preview release
List the tags on a resource
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource(
resourceArn='string'
)
string
[REQUIRED]
ARN of a taggable Agent Registry resource.
dict
Response Syntax
{
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
tags (dict) --
A map of tag keys to tag values returned by read operations (may be empty).
(string) --
Key of a tag.
(string) --
Value of a tag.
Deletes a registry record
See also: AWS API Documentation
Request Syntax
client.delete_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 delete (ARN or ID)
dict
Response Syntax
{}
Response Structure
(dict) --
Response structure for deleting a registry record
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',
'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'
}
},
'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'
}
Response Structure
(dict) --
Response structure for retrieving a registry record
registryArn (string) --
The &ARN; of the parent registry that owns the record.
recordArn (string) --
The &ARN; of the registry record.
recordId (string) --
The unique identifier of the registry record.
name (string) --
The name of the registry record. Names are unique within a registry.
displayName (string) --
The human-readable display name of the registry record.
description (string) --
A description of the registry record.
recordType (string) --
The type of the registry record, such as MCP, AGENT, SKILL, or CUSTOM.
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) --
MCP tools descriptor containing tool definitions
data (string) --
Descriptor payload data
dataSchemaVersion (string) --
Version of the descriptor type schema
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 &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 &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 AWS 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 &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 &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 AWS 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 &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 &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 AWS 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) --
Descriptor payload data
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.
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'
},
'approvalConfiguration': {
'autoApprovalRules': [
'APPROVE_ALL',
]
},
'status': 'CREATING'|'READY'|'UPDATING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETING'|'DELETE_FAILED',
'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) --
A map of tag keys to tag values.
(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) --
A map of tag keys to tag values.
(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.
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) --
status (string) --
Current status of the registry
statusReason (string) --
The reason for the current status. Typically populated when the status indicates a failure state.
createdAt (datetime) --
The timestamp when the registry was created
updatedAt (datetime) --
The timestamp when the registry was last updated
Submits a DRAFT registry record for approval, moving it into the registry's approval workflow. Depending on the registry's approval configuration, the record is either auto-approved or set to PENDING_APPROVAL for a curator to approve or reject.
See also: AWS API Documentation
Request Syntax
client.submit_registry_record_for_approval(
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 submit for approval (ARN or ID)
dict
Response Syntax
{
'registryArn': 'string',
'recordArn': 'string',
'recordId': 'string',
'status': 'DRAFT'|'PENDING_APPROVAL'|'APPROVED'|'REJECTED'|'DEPRECATED'|'CREATING'|'UPDATING'|'CREATE_FAILED'|'UPDATE_FAILED',
'updatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
Response structure for submitting a registry record for approval
registryArn (string) --
The ARN of the registry
recordArn (string) --
The ARN of the registry record
recordId (string) --
The ID of the registry record
status (string) --
The resulting status of the registry record
updatedAt (datetime) --
The timestamp when the record was last updated
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',
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',
]
}
)
string
[REQUIRED]
The name of the registry
string
The description of 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) --
A map of tag keys to tag values.
(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) --
A map of tag keys to tag values.
(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
Client token for idempotency
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
Response Syntax
{
'registryArn': 'string'
}
Response Structure
(dict) --
Response structure for creating a registry
registryArn (string) --
The ARN of the created registry
Updates the status of a registry record as part of the registry's curation workflow, for example to approve or reject a record that is pending approval, or to deprecate an approved record so that it is no longer discoverable
See also: AWS API Documentation
Request Syntax
client.update_registry_record_status(
registryId='string',
recordId='string',
status='DRAFT'|'PENDING_APPROVAL'|'APPROVED'|'REJECTED'|'DEPRECATED'|'CREATING'|'UPDATING'|'CREATE_FAILED'|'UPDATE_FAILED',
statusReason='string'
)
string
[REQUIRED]
The identifier of the registry containing the record (ARN or ID)
string
[REQUIRED]
The identifier of the registry record to update the status of (ARN or ID)
string
[REQUIRED]
The target status for the registry record
string
[REQUIRED]
The reason for the status change, for example why the record was approved, rejected, or deprecated
dict
Response Syntax
{
'registryArn': 'string',
'recordArn': 'string',
'recordId': 'string',
'status': 'DRAFT'|'PENDING_APPROVAL'|'APPROVED'|'REJECTED'|'DEPRECATED'|'CREATING'|'UPDATING'|'CREATE_FAILED'|'UPDATE_FAILED',
'statusReason': 'string',
'updatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
Response structure for updating a registry record status
registryArn (string) --
The ARN of the registry
recordArn (string) --
The ARN of the registry record
recordId (string) --
The ID of the registry record
status (string) --
The resulting status of the registry record
statusReason (string) --
The reason for the status change
updatedAt (datetime) --
The timestamp when the record was last updated
Tag a resource with key-value pairs
See also: AWS API Documentation
Request Syntax
client.tag_resource(
resourceArn='string',
tags={
'string': 'string'
}
)
string
[REQUIRED]
ARN of a taggable Agent Registry resource.
dict
[REQUIRED]
A map of tag keys to tag values.
(string) --
Key of a tag.
(string) --
Value of a tag.
dict
Response Syntax
{}
Response Structure
(dict) --
Lists the registries in the caller's account and Region, with optional filtering by status and discovery authorizer type
See also: AWS API Documentation
Request Syntax
client.list_registries(
maxResults=123,
nextToken='string',
filters=[
{
'name': 'status'|'discoveryConfiguration.authorizerType',
'values': [
'string',
]
},
]
)
integer
Maximum number of results to return
string
Token for pagination
list
Filters to apply to the registry list
(dict) --
A single filter applied to a ListRegistries 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
{
'registries': [
{
'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'
},
'status': 'CREATING'|'READY'|'UPDATING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETING'|'DELETE_FAILED',
'statusReason': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Response structure for listing registries
registries (list) --
List of registry summaries
(dict) --
Registry summary for list operations
name (string) --
Registry name
description (string) --
Registry description
registryId (string) --
Unique registry identifier
registryArn (string) --
Registry Amazon Resource Name
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) --
A map of tag keys to tag values.
(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) --
A map of tag keys to tag values.
(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.
status (string) --
Current status of the registry
statusReason (string) --
The reason for the current status. Typically populated when the status indicates a failure state.
createdAt (datetime) --
The timestamp when the registry was created
updatedAt (datetime) --
The timestamp when the registry was last updated
nextToken (string) --
Token for next page of results
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',
]
}
}
)
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) --
Description of the Resource
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) --
A map of tag keys to tag values.
(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) --
A map of tag keys to tag values.
(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
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'
},
'approvalConfiguration': {
'autoApprovalRules': [
'APPROVE_ALL',
]
},
'status': 'CREATING'|'READY'|'UPDATING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETING'|'DELETE_FAILED',
'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) --
A map of tag keys to tag values.
(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) --
A map of tag keys to tag values.
(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.
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) --
status (string) --
Current status of the registry
statusReason (string) --
The reason for the current status. Typically populated when the status indicates a failure state.
createdAt (datetime) --
The timestamp when the registry was created
updatedAt (datetime) --
The timestamp when the registry was last updated
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',
'recordVersion': 'string',
'status': 'DRAFT'|'PENDING_APPROVAL'|'APPROVED'|'REJECTED'|'DEPRECATED'|'CREATING'|'UPDATING'|'CREATE_FAILED'|'UPDATE_FAILED',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Response structure for listing registry records
registryRecords (list) --
List of registry record summaries
(dict) --
A summary of a registry record returned by list operations. Contains identifying and lifecycle fields but omits descriptor content.
registryArn (string) --
The &ARN; of the parent registry that owns the record.
recordArn (string) --
The &ARN; of the registry record.
recordId (string) --
The unique identifier of the registry record.
name (string) --
The name of the registry record. Names are unique within a registry.
displayName (string) --
The human-readable display name of the registry record.
description (string) --
A description of the registry record.
recordType (string) --
The type of the registry record, such as MCP, AGENT, SKILL, or CUSTOM.
recordVersion (string) --
The version identifier of the registry record.
status (string) --
The lifecycle status of the registry record.
createdAt (datetime) --
The timestamp when the registry record was created.
updatedAt (datetime) --
The timestamp when the registry record was last updated.
nextToken (string) --
Token for next page of results
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',
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'
}
}
}
}
},
recordVersion='string',
triggerSynchronization=True|False
)
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) --
Description of the Resource
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 &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 &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 AWS 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 &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 &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 AWS 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 &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 &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 AWS 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.
string
The updated version of the registry record. Omit to leave the version unchanged.
boolean
Whether to trigger synchronization of the record's descriptor content from its source
dict
Response Syntax
{
'registryArn': 'string',
'recordArn': 'string',
'recordId': 'string',
'name': 'string',
'displayName': 'string',
'description': 'string',
'recordType': 'MCP'|'AGENT'|'CUSTOM'|'SKILL',
'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'
}
},
'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'
}
Response Structure
(dict) --
Response structure for updating a registry record
registryArn (string) --
The &ARN; of the parent registry that owns the record.
recordArn (string) --
The &ARN; of the registry record.
recordId (string) --
The unique identifier of the registry record.
name (string) --
The name of the registry record. Names are unique within a registry.
displayName (string) --
The human-readable display name of the registry record.
description (string) --
A description of the registry record.
recordType (string) --
The type of the registry record, such as MCP, AGENT, SKILL, or CUSTOM.
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) --
MCP tools descriptor containing tool definitions
data (string) --
Descriptor payload data
dataSchemaVersion (string) --
Version of the descriptor type schema
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 &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 &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 AWS 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 &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 &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 AWS 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 &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 &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 AWS 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) --
Descriptor payload data
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.
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',
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'
}
},
recordVersion='string',
clientToken='string',
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) --
MCP tools descriptor containing tool definitions
data (string) --
Descriptor payload data
dataSchemaVersion (string) --
Version of the descriptor type schema
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 &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 &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 AWS 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 &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 &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 AWS 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 &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 &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 AWS 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) --
Descriptor payload data
string
The version of the registry record
string
Client token for idempotency
This field is autopopulated if not provided.
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
Deletes a registry. Deletion is asynchronous: the registry transitions to the DELETING status and is removed along with its registry records.
See also: AWS API Documentation
Request Syntax
client.delete_registry(
registryId='string'
)
string
[REQUIRED]
The identifier of the registry to delete (ARN or ID)
dict
Response Syntax
{
'status': 'CREATING'|'READY'|'UPDATING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETING'|'DELETE_FAILED'
}
Response Structure
(dict) --
Response structure for deleting a registry
status (string) --
Current status of the registry, set to DELETING when deletion is initiated
Remove tags from a resource by key
See also: AWS API Documentation
Request Syntax
client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
string
[REQUIRED]
ARN of a taggable Agent Registry resource.
list
[REQUIRED]
A list of tag keys.
(string) --
Key of a tag.
dict
Response Syntax
{}
Response Structure
(dict) --