Bedrock Agentcore Control  >  Operations  >  update_registry

update_registry

Operation

update_registry async

update_registry(input: UpdateRegistryInput, plugins: list[Plugin] | None = None) -> UpdateRegistryOutput

Updates an existing registry. This operation uses PATCH semantics, so you only need to specify the fields you want to change.

Parameters:

Name	Type	Description	Default
input	UpdateRegistryInput	An instance of UpdateRegistryInput.	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
UpdateRegistryOutput	An instance of UpdateRegistryOutput.

Input

UpdateRegistryInput dataclass

Dataclass for UpdateRegistryInput structure.

Attributes

approval_configuration class-attribute instance-attribute

approval_configuration: UpdatedApprovalConfiguration | None = None

The updated approval configuration for registry records. The updated configuration only affects new records that move to PENDING_APPROVAL status after the change. Existing records already in PENDING_APPROVAL status are not affected.

authorizer_configuration class-attribute instance-attribute

authorizer_configuration: UpdatedAuthorizerConfiguration | None = None

The updated authorizer configuration for the registry. Changing the authorizer configuration can break existing consumers of the registry who are using the authorization type prior to the update.

description class-attribute instance-attribute

description: UpdatedDescription | None = None

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

name class-attribute instance-attribute

name: str | None = None

The updated name of the registry.

registry_id class-attribute instance-attribute

registry_id: str | None = None

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

Output

UpdateRegistryOutput dataclass

Dataclass for UpdateRegistryOutput structure.

Attributes

approval_configuration class-attribute instance-attribute

approval_configuration: ApprovalConfiguration | None = None

The approval configuration for the updated registry. For details, see the ApprovalConfiguration data type.

authorizer_configuration class-attribute instance-attribute

authorizer_configuration: AuthorizerConfiguration | None = None

The authorizer configuration for the updated registry. For details, see the AuthorizerConfiguration data type.

authorizer_type class-attribute instance-attribute

authorizer_type: RegistryAuthorizerType | None = None

The type of authorizer used by the updated registry. This controls the authorization method for the Search and Invoke APIs used by consumers.

• CUSTOM_JWT - Authorize with a bearer token.

• AWS_IAM - Authorize with your Amazon Web Services IAM credentials.

created_at instance-attribute

created_at: datetime

The timestamp when the registry was created.

description class-attribute instance-attribute

description: str | None = field(repr=False, default=None)

The description of the updated registry.

name instance-attribute

name: str

The name of the updated registry.

registry_arn instance-attribute

registry_arn: str

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

registry_id instance-attribute

registry_id: str

The unique identifier of the updated registry.

status instance-attribute

status: RegistryStatus

The current status of the updated registry. Possible values include CREATING, READY, UPDATING, CREATE_FAILED, UPDATE_FAILED, DELETING, and DELETE_FAILED.

status_reason class-attribute instance-attribute

status_reason: str | None = None

The reason for the current status of the updated registry.

updated_at instance-attribute

updated_at: datetime

The timestamp when the registry was last updated.