Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateRegistryRecord

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

Request Syntax


PATCH /registries/registryId/records/recordId HTTP/1.1
Content-type: application/json

{
   "description": { 
      "optionalValue": "string"
   },
   "descriptors": { 
      "optionalValue": { 
         "a2a": { 
            "optionalValue": { 
               "agentCard": { 
                  "inlineContent": "string",
                  "schemaVersion": "string"
               }
            }
         },
         "agentSkills": { 
            "optionalValue": { 
               "skillDefinition": { 
                  "optionalValue": { 
                     "inlineContent": "string",
                     "schemaVersion": "string"
                  }
               },
               "skillMd": { 
                  "optionalValue": { 
                     "inlineContent": "string"
                  }
               }
            }
         },
         "custom": { 
            "optionalValue": { 
               "inlineContent": "string"
            }
         },
         "mcp": { 
            "optionalValue": { 
               "server": { 
                  "optionalValue": { 
                     "inlineContent": "string",
                     "schemaVersion": "string"
                  }
               },
               "tools": { 
                  "optionalValue": { 
                     "inlineContent": "string",
                     "protocolVersion": "string"
                  }
               }
            }
         }
      }
   },
   "descriptorType": "string",
   "name": "string",
   "recordVersion": "string",
   "synchronizationConfiguration": { 
      "optionalValue": { 
         "fromUrl": { 
            "credentialProviderConfigurations": [ 
               { 
                  "credentialProvider": { ... },
                  "credentialProviderType": "string"
               }
            ],
            "url": "string"
         }
      }
   },
   "synchronizationType": { 
      "optionalValue": "string"
   },
   "triggerSynchronization": boolean
}

URI Request Parameters

The request uses the following URI parameters.

recordId

The identifier of the registry record to update. You can specify either the Amazon Resource Name (ARN) or the ID of the record.

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: (arn:aws(-[^:]+)?:bedrock-agentcore:[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. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: (arn:aws(-[^:]+)?:bedrock-agentcore:[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 for the registry record. To clear the description, include the UpdatedDescription wrapper with optionalValue not specified.

Type: UpdatedDescription object

Required: No

descriptors

The updated descriptor-type-specific configuration containing the resource schema and metadata. Uses PATCH semantics where individual descriptor fields can be updated independently.

Type: UpdatedDescriptors object

Required: No

descriptorType

The updated descriptor type for the registry record. Changing the descriptor type may require updating the descriptors field to match the new type's schema requirements.

Type: String

Valid Values: MCP | A2A | CUSTOM | AGENT_SKILLS

Required: No

name

The updated name for the registry record.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [a-zA-Z0-9][a-zA-Z0-9_\-\.\/]*

Required: No

recordVersion

The version of the registry record for optimistic locking. If provided, it must match the current version of the record. The service automatically increments the version after a successful update.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [a-zA-Z0-9.-]+

Required: No

synchronizationConfiguration

The updated synchronization configuration for the registry record.

Type: UpdatedSynchronizationConfiguration object

Required: No

synchronizationType

The updated synchronization type for the registry record.

Type: UpdatedSynchronizationType object

Required: No

triggerSynchronization

Whether to trigger synchronization using the stored or provided configuration. When set to true, the service will synchronize the record metadata from the configured external source.

Type: Boolean

Required: No

Response Syntax


HTTP/1.1 202
Content-type: application/json

{
   "createdAt": "string",
   "description": "string",
   "descriptors": { 
      "a2a": { 
         "agentCard": { 
            "inlineContent": "string",
            "schemaVersion": "string"
         }
      },
      "agentSkills": { 
         "skillDefinition": { 
            "inlineContent": "string",
            "schemaVersion": "string"
         },
         "skillMd": { 
            "inlineContent": "string"
         }
      },
      "custom": { 
         "inlineContent": "string"
      },
      "mcp": { 
         "server": { 
            "inlineContent": "string",
            "schemaVersion": "string"
         },
         "tools": { 
            "inlineContent": "string",
            "protocolVersion": "string"
         }
      }
   },
   "descriptorType": "string",
   "name": "string",
   "recordArn": "string",
   "recordId": "string",
   "recordVersion": "string",
   "registryArn": "string",
   "status": "string",
   "statusReason": "string",
   "synchronizationConfiguration": { 
      "fromUrl": { 
         "credentialProviderConfigurations": [ 
            { 
               "credentialProvider": { ... },
               "credentialProviderType": "string"
            }
         ],
         "url": "string"
      }
   },
   "synchronizationType": "string",
   "updatedAt": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

createdAt

The timestamp when the registry record was created.

Type: Timestamp

description

The description of the updated registry record.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 4096.

descriptors

The descriptor-type-specific configuration of the updated registry record. For details, see the Descriptors data type.

Type: Descriptors object

descriptorType

The descriptor type of the updated registry record. Possible values are MCP, A2A, CUSTOM, and AGENT_SKILLS.

Type: String

Valid Values: MCP | A2A | CUSTOM | AGENT_SKILLS

name

The name of the updated registry record.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [a-zA-Z0-9][a-zA-Z0-9_\-\.\/]*

recordArn

The Amazon Resource Name (ARN) of the updated registry record.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:registry/[a-zA-Z0-9]{12,16}/record/[a-zA-Z0-9]{12}

recordId

The unique identifier of the updated registry record.

Type: String

Length Constraints: Fixed length of 12.

Pattern: [a-zA-Z0-9]{12}

recordVersion

The version of the updated registry record.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [a-zA-Z0-9.-]+

registryArn

The Amazon Resource Name (ARN) of the registry that contains the updated record.

Type: String

Pattern: arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:registry/[a-zA-Z0-9]{12,16}

status

The current status of the updated registry record. Possible values include CREATING, DRAFT, APPROVED, PENDING_APPROVAL, REJECTED, DEPRECATED, UPDATING, CREATE_FAILED, and UPDATE_FAILED.

Type: String

statusReason

The reason for the current status of the updated registry record.

Type: String

synchronizationConfiguration

The synchronization configuration of the updated registry record.

Type: SynchronizationConfiguration object

synchronizationType

The synchronization type of the updated registry record.

Type: String

Valid Values: URL

updatedAt

The timestamp when the registry record was last updated.

Type: Timestamp

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

This exception is thrown when a request is denied per access permissions

HTTP Status Code: 403

ConflictException

This exception is thrown when there is a conflict performing an operation

HTTP Status Code: 409

InternalServerException

This exception is thrown if there was an unexpected error during processing of request

HTTP Status Code: 500

ResourceNotFoundException

This exception is thrown when a resource referenced by the operation does not exist

HTTP Status Code: 404

ThrottlingException

This exception is thrown when the number of requests exceeds the limit

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by the service.

HTTP Status Code: 400