Skip to content

update_registry_record

Operation

update_registry_record

update_registry_record(request: UpdateRegistryRecordInput | UpdateRegistryRecordInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateRegistryRecordInputDict]) -> 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
request UpdateRegistryRecordInput | UpdateRegistryRecordInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[UpdateRegistryRecordInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateRegistryRecordOutput

An instance of UpdateRegistryRecordOutput.

update_registry_record async

update_registry_record(request: UpdateRegistryRecordInput | UpdateRegistryRecordInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateRegistryRecordInputDict]) -> 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
request UpdateRegistryRecordInput | UpdateRegistryRecordInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[UpdateRegistryRecordInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateRegistryRecordOutput

An instance of UpdateRegistryRecordOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

UpdateRegistryRecordInputDict

Bases: TypedDict

Dictionary form of UpdateRegistryRecordInput.

Attributes

description instance-attribute

The updated description for the registry record. To clear the description, include the UpdatedDescription wrapper with optionalValue not specified.

descriptor_type instance-attribute
descriptor_type: str | 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.

descriptors instance-attribute

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

name instance-attribute
name: str | None

The updated name for the registry record.

record_id instance-attribute
record_id: Required[str]

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

record_version instance-attribute
record_version: str | 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.

registry_id instance-attribute
registry_id: Required[str]

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

synchronization_configuration instance-attribute

The updated synchronization configuration for the registry record.

synchronization_type instance-attribute

The updated synchronization type for the registry record.

trigger_synchronization instance-attribute
trigger_synchronization: bool | 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.

UpdateRegistryRecordInput dataclass

Bases: _SerdeShape

Dataclass for UpdateRegistryRecordInput structure.

Attributes

description class-attribute instance-attribute
description: UpdatedDescription | None = ...

The updated description for the registry record. To clear the description, include the UpdatedDescription wrapper with optionalValue not specified.

descriptor_type class-attribute instance-attribute
descriptor_type: str | 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.

descriptors class-attribute instance-attribute
descriptors: UpdatedDescriptors | None = ...

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

name class-attribute instance-attribute
name: str | None = ...

The updated name for the registry record.

record_id class-attribute instance-attribute
record_id: str | None = ...

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

record_version class-attribute instance-attribute
record_version: str | 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.

registry_id class-attribute instance-attribute
registry_id: str | None = ...

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

synchronization_configuration class-attribute instance-attribute
synchronization_configuration: UpdatedSynchronizationConfiguration | None = ...

The updated synchronization configuration for the registry record.

synchronization_type class-attribute instance-attribute
synchronization_type: UpdatedSynchronizationType | None = ...

The updated synchronization type for the registry record.

trigger_synchronization class-attribute instance-attribute
trigger_synchronization: bool | 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

UpdateRegistryRecordOutput dataclass

Bases: _SerdeShape

Dataclass for UpdateRegistryRecordOutput structure.

Attributes

created_at instance-attribute
created_at: datetime

The timestamp when the registry record was created.

description class-attribute instance-attribute
description: str | None = ...

The description of the updated registry record.

descriptor_type instance-attribute
descriptor_type: str

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

descriptors instance-attribute
descriptors: Descriptors

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

name instance-attribute
name: str

The name of the updated registry record.

record_arn instance-attribute
record_arn: str

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

record_id instance-attribute
record_id: str

The unique identifier of the updated registry record.

record_version class-attribute instance-attribute
record_version: str | None = ...

The version of the updated registry record.

registry_arn instance-attribute
registry_arn: str

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

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

status instance-attribute
status: str

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

status_reason class-attribute instance-attribute
status_reason: str | None = ...

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

synchronization_configuration class-attribute instance-attribute
synchronization_configuration: SynchronizationConfiguration | None = ...

The synchronization configuration of the updated registry record.

synchronization_type class-attribute instance-attribute
synchronization_type: str | None = ...

The synchronization type of the updated registry record.

updated_at instance-attribute
updated_at: datetime

The timestamp when the registry record was last updated.