update_registry_record¶
Operation¶
async
¶
update_registry_record(input: UpdateRegistryRecordInput, plugins: list[Plugin] | None = None) -> UpdateRegistryRecordOutput
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
UpdateRegistryRecordInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
UpdateRegistryRecordOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for UpdateRegistryRecordInput structure.
Attributes¶
class-attribute
instance-attribute
¶
description: UpdatedDescription | None = None
The updated description for the registry record. To clear the
description, include the UpdatedDescription wrapper with
optionalValue not specified.
class-attribute
instance-attribute
¶
descriptor_type: DescriptorType | None = None
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.
class-attribute
instance-attribute
¶
descriptors: UpdatedDescriptors | None = None
The updated descriptor-type-specific configuration containing the resource schema and metadata. Uses PATCH semantics where individual descriptor fields can be updated independently.
class-attribute
instance-attribute
¶
name: str | None = None
The updated name for the registry record.
class-attribute
instance-attribute
¶
record_id: str | None = None
The identifier of the registry record to update. You can specify either the Amazon Resource Name (ARN) or the ID of the record.
class-attribute
instance-attribute
¶
record_version: str | None = None
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.
class-attribute
instance-attribute
¶
registry_id: str | None = None
The identifier of the registry containing the record. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.
class-attribute
instance-attribute
¶
synchronization_configuration: UpdatedSynchronizationConfiguration | None = None
The updated synchronization configuration for the registry record.
class-attribute
instance-attribute
¶
synchronization_type: UpdatedSynchronizationType | None = None
The updated synchronization type for the registry record.
class-attribute
instance-attribute
¶
trigger_synchronization: bool | None = None
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.
Output¶
dataclass
¶
Dataclass for UpdateRegistryRecordOutput structure.
Attributes¶
instance-attribute
¶
created_at: datetime
The timestamp when the registry record was created.
class-attribute
instance-attribute
¶
description: str | None = field(repr=False, default=None)
The description of the updated registry record.
instance-attribute
¶
descriptor_type: DescriptorType
The descriptor type of the updated registry record. Possible values are
MCP, A2A, CUSTOM, and AGENT_SKILLS.
instance-attribute
¶
descriptors: Descriptors
The descriptor-type-specific configuration of the updated registry
record. For details, see the Descriptors data type.
instance-attribute
¶
record_arn: str
The Amazon Resource Name (ARN) of the updated registry record.
class-attribute
instance-attribute
¶
record_version: str | None = None
The version of the updated registry record.
instance-attribute
¶
registry_arn: str
The Amazon Resource Name (ARN) of the registry that contains the updated record.
instance-attribute
¶
status: RegistryRecordStatus
The current status of the updated registry record. Possible values
include CREATING, DRAFT, APPROVED, PENDING_APPROVAL, REJECTED,
DEPRECATED, UPDATING, CREATE_FAILED, and UPDATE_FAILED.
class-attribute
instance-attribute
¶
status_reason: str | None = None
The reason for the current status of the updated registry record.
class-attribute
instance-attribute
¶
synchronization_configuration: SynchronizationConfiguration | None = None
The synchronization configuration of the updated registry record.
class-attribute
instance-attribute
¶
synchronization_type: SynchronizationType | None = None
The synchronization type of the updated registry record.
instance-attribute
¶
updated_at: datetime
The timestamp when the registry record was last updated.