delete_policy_engine¶
Operation¶
delete_policy_engine
¶
delete_policy_engine(request: DeletePolicyEngineInput | DeletePolicyEngineInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeletePolicyEngineInputDict]) -> 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 |
|---|---|---|---|
request
|
DeletePolicyEngineInput | DeletePolicyEngineInputDict | 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[DeletePolicyEngineInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DeletePolicyEngineOutput
|
An instance of |
delete_policy_engine
async
¶
delete_policy_engine(request: DeletePolicyEngineInput | DeletePolicyEngineInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeletePolicyEngineInputDict]) -> 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 |
|---|---|---|---|
request
|
DeletePolicyEngineInput | DeletePolicyEngineInputDict | 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[DeletePolicyEngineInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DeletePolicyEngineOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
Output¶
DeletePolicyEngineOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DeletePolicyEngineOutput structure.
Attributes¶
created_at
instance-attribute
¶
created_at: datetime
The timestamp when the deleted policy engine was originally created.
description
class-attribute
instance-attribute
¶
description: str | None = ...
The human-readable description of the deleted policy engine.
encryption_key_arn
class-attribute
instance-attribute
¶
encryption_key_arn: str | None = ...
The Amazon Resource Name (ARN) of the KMS key used to encrypt the policy engine data.
policy_engine_arn
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.
policy_engine_id
instance-attribute
¶
policy_engine_id: str
The unique identifier of the policy engine being deleted. This confirms which policy engine the deletion operation targets.
response_metadata
class-attribute
instance-attribute
¶
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 status of the policy engine deletion operation. This provides status about any issues that occurred during the deletion process.
status_reasons
instance-attribute
¶
Additional information about the deletion status. This provides details about the deletion process or any issues that may have occurred.