Skip to content

Bedrock AgentCore Control  >  Operations  >  update_policy_engine

update_policy_engine

Operation

update_policy_engine async 

update_policy_engine(input: UpdatePolicyEngineInput, plugins: list[Plugin] | None = None) -> UpdatePolicyEngineOutput

Updates an existing policy engine within the AgentCore Policy system. This operation allows modification of the policy engine description while maintaining its identity. This is an asynchronous operation. Use the GetPolicyEngine operation to poll the status field to track completion.

Parameters:

Name Type Description Default
input UpdatePolicyEngineInput

An instance of UpdatePolicyEngineInput.

 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
UpdatePolicyEngineOutput

An instance of UpdatePolicyEngineOutput.

Input

UpdatePolicyEngineInput dataclass

Dataclass for UpdatePolicyEngineInput structure.

Attributes

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

The new description for the policy engine.

policy_engine_id class-attribute instance-attribute 
policy_engine_id: str | None = None

The unique identifier of the policy engine to be updated.

Output

UpdatePolicyEngineOutput dataclass

Dataclass for UpdatePolicyEngineOutput structure.

Attributes

created_at instance-attribute 
created_at: datetime

The original creation timestamp of the policy engine.

description class-attribute instance-attribute 
description: str | None = field(repr=False, default=None)

The updated description of the policy engine.

encryption_key_arn class-attribute instance-attribute 
encryption_key_arn: str | None = None

The Amazon Resource Name (ARN) of the KMS key used to encrypt the policy engine data.

name instance-attribute 
name: str

The name of the updated policy engine.

policy_engine_arn instance-attribute 
policy_engine_arn: str

The ARN of the updated policy engine.

policy_engine_id instance-attribute 
policy_engine_id: str

The unique identifier of the updated policy engine.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = field(default=EMPTY_RESPONSE_METADATA, repr=False, compare=False)

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 policy engine.

status_reasons instance-attribute 
status_reasons: list[str]

Additional information about the update status.

updated_at instance-attribute 
updated_at: datetime

The timestamp when the policy engine was last updated.