delete_policy_engine¶
Operation¶
async
¶
delete_policy_engine(input: DeletePolicyEngineInput, plugins: list[Plugin] | None = None) -> DeletePolicyEngineOutput
Deletes an existing policy engine from the AgentCore Policy system. The
policy engine must not have any associated policies before deletion.
Once deleted, the policy engine and all its configurations become
unavailable for policy management and evaluation. This is an
asynchronous operation. Use the GetPolicyEngine operation to poll the
status field to track completion.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
DeletePolicyEngineInput
|
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 |
|---|---|
DeletePolicyEngineOutput
|
An instance of |
Input¶
dataclass
¶
Output¶
dataclass
¶
Dataclass for DeletePolicyEngineOutput structure.
Attributes¶
instance-attribute
¶
created_at: datetime
The timestamp when the deleted policy engine was originally created.
class-attribute
instance-attribute
¶
description: str | None = field(repr=False, default=None)
The human-readable description of the deleted policy engine.
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.
instance-attribute
¶
policy_engine_arn: str
The Amazon Resource Name (ARN) of the deleted policy engine. This globally unique identifier confirms which policy engine resource was successfully removed.
instance-attribute
¶
policy_engine_id: str
The unique identifier of the policy engine being deleted. This confirms which policy engine the deletion operation targets.
instance-attribute
¶
status: PolicyEngineStatus
The status of the policy engine deletion operation. This provides status about any issues that occurred during the deletion process.
instance-attribute
¶
status_reasons: list[str]
Additional information about the deletion status. This provides details about the deletion process or any issues that may have occurred.
instance-attribute
¶
updated_at: datetime
The timestamp when the deleted policy engine was last modified before deletion. This tracks the final state of the policy engine before it was removed from the system.