update_policy_engine¶
Operation¶
update_policy_engine
¶
update_policy_engine(request: UpdatePolicyEngineInput | UpdatePolicyEngineInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdatePolicyEngineInputDict]) -> 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 |
|---|---|---|---|
request
|
UpdatePolicyEngineInput | UpdatePolicyEngineInputDict | 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[UpdatePolicyEngineInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UpdatePolicyEngineOutput
|
An instance of |
update_policy_engine
async
¶
update_policy_engine(request: UpdatePolicyEngineInput | UpdatePolicyEngineInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdatePolicyEngineInputDict]) -> 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 |
|---|---|---|---|
request
|
UpdatePolicyEngineInput | UpdatePolicyEngineInputDict | 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[UpdatePolicyEngineInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UpdatePolicyEngineOutput
|
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.
UpdatePolicyEngineInputDict
¶
Bases: TypedDict
Dictionary form of UpdatePolicyEngineInput.
Attributes¶
description
instance-attribute
¶
description: UpdatedDescription | UpdatedDescriptionDict | None
The new description for the policy engine.
UpdatePolicyEngineInput
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdatePolicyEngineInput structure.
Attributes¶
description
class-attribute
instance-attribute
¶
description: UpdatedDescription | None = ...
The new description for the policy engine.
Output¶
UpdatePolicyEngineOutput
dataclass
¶
Bases: _SerdeShape
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 = ...
The updated description of the 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_id
instance-attribute
¶
policy_engine_id: str
The unique identifier of the updated policy engine.
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_reasons
instance-attribute
¶
Additional information about the update status.