Bedrock Agentcore Control  >  Operations  >  get_policy_engine_summary

get_policy_engine_summary

Operation

get_policy_engine_summary async

get_policy_engine_summary(input: GetPolicyEngineSummaryInput, plugins: list[Plugin] | None = None) -> GetPolicyEngineSummaryOutput

Retrieves a metadata-only summary of a specific policy engine without decrypting customer content. This lightweight read operation returns resource identifiers, status, timestamps, and the encryption key ARN, but does not include the description or status reasons. Because this operation does not require access to the customer's KMS key, it is suitable for resource discovery, inventory, and integration scenarios where only metadata is needed.

Parameters:

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

Input

GetPolicyEngineSummaryInput dataclass

Dataclass for GetPolicyEngineSummaryInput structure.

Attributes

policy_engine_id class-attribute instance-attribute

policy_engine_id: str | None = None

The unique identifier of the policy engine to retrieve the summary for. This must be a valid policy engine ID that exists within the account.

Output

GetPolicyEngineSummaryOutput dataclass

Dataclass for GetPolicyEngineSummaryOutput structure.

Attributes

created_at instance-attribute

created_at: datetime

The timestamp when the policy engine was originally created.

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 customer-assigned name of the policy engine.

policy_engine_arn instance-attribute

policy_engine_arn: str

The Amazon Resource Name (ARN) of the policy engine.

policy_engine_id instance-attribute

policy_engine_id: str

The unique identifier of the policy engine.

status instance-attribute

status: PolicyEngineStatus

The current status of the policy engine.

updated_at instance-attribute

updated_at: datetime

The timestamp when the policy engine was last modified.