update_registry_record
¶
update_registry_record(
registry_id: RegistryIdentifier,
record_id: RecordIdentifier,
*,
config_overrides: Optional[AgentRegistryControlClientConfig] = None,
name: Optional[RegistryRecordName] = None,
display_name: Optional[UpdatedDisplayName] = None,
description: Optional[UpdatedDescription] = None,
record_type: Optional[RecordType] = None,
descriptors: Optional[UpdatedDescriptors] = None,
record_version: Optional[RegistryRecordVersion] = None,
custom_metadata: Optional[UpdatedCustomMetadataMap] = None,
trigger_synchronization: Optional[bool] = None,
provenance: Optional[ProvenanceList] = None,
) -> UpdateRegistryRecordResponse
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.
Parameters:
-
registry_id(RegistryIdentifier) –The identifier of the registry containing the record (ARN or ID)
-
record_id(RecordIdentifier) –The identifier of the registry record to update (ARN or ID)
-
name(Optional[RegistryRecordName], default:None) –The updated name of the registry record. Omit to leave the name unchanged.
-
display_name(Optional[UpdatedDisplayName], default:None) –The updated display name of the registry record. Omit to leave the display name unchanged; provide an empty wrapper to unset it.
-
description(Optional[UpdatedDescription], default:None) –The updated description of the registry record. Omit to leave the description unchanged; provide an empty wrapper to unset it.
-
record_type(Optional[RecordType], default:None) –The updated type of the registry record. Omit to leave the record type unchanged.
-
descriptors(Optional[UpdatedDescriptors], default:None) –The updated typed descriptor content for the registry record. Omit to leave the descriptors unchanged.
-
record_version(Optional[RegistryRecordVersion], default:None) –The updated version of the registry record. Omit to leave the version unchanged.
-
custom_metadata(Optional[UpdatedCustomMetadataMap], default:None) –The updated custom metadata for the registry record. Values can be strings (maximum 128 characters) or native JSON booleans (
trueorfalse). Omit to leave the existing metadata unchanged. Supply the wrapper with a full replacement set to update, or with a null value to clear all metadata. -
trigger_synchronization(Optional[bool], default:None) –Whether to trigger synchronization of the record's descriptor content from its source
-
provenance(Optional[ProvenanceList], default:None) –The provenance lineage re-assertion for the registry record. This field is reserved for the Amazon Web Services 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.
Raises:
-
AccessDeniedException–The caller is not authorized to perform the requested action.
-
ConflictException–The request conflicts with the current state of the resource.
-
InternalServerException–The request failed due to an unexpected internal error; the caller may retry.
-
ResourceNotFoundException–The requested resource was not found.
-
ThrottlingException–The request was denied due to request throttling; the caller may retry after a delay.
-
ValidationException–The request failed validation of one or more input fields.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_agent_registry_control/_services/agent_registry_control.py
537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 | |