UpdateRegistryRecord
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.
Request Syntax
PATCH /registries/registryId/records/recordId HTTP/1.1
Content-type: application/json
{
"description": {
"optionalValue": "string"
},
"descriptors": {
"optionalValue": {
"a2aAgentCard": {
"optionalValue": {
"data": {
"optionalValue": "string"
},
"dataSchemaVersion": {
"optionalValue": "string"
},
"source": {
"optionalValue": {
"fromUrl": {
"credentialProviderConfigurations": [
{
"credentialProvider": { ... },
"credentialProviderType": "string"
}
],
"url": "string"
}
}
}
}
},
"agentSkillsDefinition": {
"optionalValue": {
"additionalData": {
"optionalValue": {
"skillMd": {
"optionalValue": {
"data": {
"optionalValue": "string"
},
"dataSchemaVersion": {
"optionalValue": "string"
},
"source": {
"optionalValue": {
"fromUrl": {
"credentialProviderConfigurations": [
{
"credentialProvider": { ... },
"credentialProviderType": "string"
}
],
"url": "string"
}
}
}
}
}
}
},
"data": {
"optionalValue": "string"
},
"dataSchemaVersion": {
"optionalValue": "string"
}
}
},
"agui": {
"optionalValue": {
"source": {
"optionalValue": {
"fromUrl": {
"credentialProviderConfigurations": [
{
"credentialProvider": { ... },
"credentialProviderType": "string"
}
],
"url": "string"
}
}
}
}
},
"custom": {
"optionalValue": {
"data": {
"optionalValue": "string"
}
}
},
"http": {
"optionalValue": {
"source": {
"optionalValue": {
"fromUrl": {
"credentialProviderConfigurations": [
{
"credentialProvider": { ... },
"credentialProviderType": "string"
}
],
"url": "string"
}
}
}
}
},
"mcpServer": {
"optionalValue": {
"additionalData": {
"optionalValue": {
"tools": {
"optionalValue": {
"data": {
"optionalValue": "string"
},
"dataSchemaVersion": {
"optionalValue": "string"
}
}
}
}
},
"data": {
"optionalValue": "string"
},
"dataSchemaVersion": {
"optionalValue": "string"
},
"source": {
"optionalValue": {
"fromUrl": {
"credentialProviderConfigurations": [
{
"credentialProvider": { ... },
"credentialProviderType": "string"
}
],
"url": "string"
}
}
}
}
}
}
},
"displayName": {
"optionalValue": "string"
},
"name": "string",
"provenance": [
{
"relation": "string",
"sourceDetails": { ... },
"sourceId": "string",
"sourceType": "string"
}
],
"recordType": "string",
"recordVersion": "string",
"triggerSynchronization": boolean
}URI Request Parameters
The request uses the following URI parameters.
- recordId
-
The identifier of the registry record to update (ARN or ID)
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
(arn:aws(-[^:]+)?:agent-registry:[a-z0-9-]+:[0-9]{12}:registry/[a-zA-Z0-9]{12,16}/record/)?[a-zA-Z0-9]{12}Required: Yes
- registryId
-
The identifier of the registry containing the record (ARN or ID)
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
(arn:aws(-[^:]+)?:agent-registry:[a-z0-9-]+:[0-9]{12}:registry/)?[a-zA-Z0-9]{12,16}Required: Yes
Request Body
The request accepts the following data in JSON format.
- description
-
The updated description of the registry record. Omit to leave the description unchanged; provide an empty wrapper to unset it.
Type: UpdatedDescription object
Required: No
- descriptors
-
The updated typed descriptor content for the registry record. Omit to leave the descriptors unchanged.
Type: UpdatedDescriptors object
Required: No
- displayName
-
The updated display name of the registry record. Omit to leave the display name unchanged; provide an empty wrapper to unset it.
Type: UpdatedDisplayName object
Required: No
- name
-
The updated name of the registry record. Omit to leave the name unchanged.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[a-zA-Z0-9][a-zA-Z0-9_\-\.\/]*Required: No
- provenance
-
The provenance lineage re-assertion for the registry record. This field is reserved for the AWS 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.
Type: Array of Provenance objects
Array Members: Minimum number of 0 items. Maximum number of 1 item.
Required: No
- recordType
-
The updated type of the registry record. Omit to leave the record type unchanged.
Type: String
Valid Values:
MCP | AGENT | CUSTOM | SKILL | GATEWAYRequired: No
- recordVersion
-
The updated version of the registry record. Omit to leave the version unchanged.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[a-zA-Z0-9.-]+Required: No
- triggerSynchronization
-
Whether to trigger synchronization of the record's descriptor content from its source
Type: Boolean
Required: No
Response Syntax
HTTP/1.1 202
Content-type: application/json
{
"createdAt": "string",
"createdBy": "string",
"createdByAutoDetection": boolean,
"description": "string",
"descriptors": {
"a2aAgentCard": {
"data": "string",
"dataSchemaVersion": "string",
"source": {
"fromUrl": {
"credentialProviderConfigurations": [
{
"credentialProvider": { ... },
"credentialProviderType": "string"
}
],
"url": "string"
}
}
},
"agentSkillsDefinition": {
"additionalData": {
"skillMd": {
"data": "string",
"dataSchemaVersion": "string",
"source": {
"fromUrl": {
"credentialProviderConfigurations": [
{
"credentialProvider": { ... },
"credentialProviderType": "string"
}
],
"url": "string"
}
}
}
},
"data": "string",
"dataSchemaVersion": "string"
},
"agui": {
"source": {
"fromUrl": {
"credentialProviderConfigurations": [
{
"credentialProvider": { ... },
"credentialProviderType": "string"
}
],
"url": "string"
}
}
},
"custom": {
"data": "string"
},
"http": {
"source": {
"