Skip to content

Bedrock AgentCore Control  >  Operations  >  get_policy_summary

get_policy_summary

Operation

get_policy_summary async 

get_policy_summary(input: GetPolicySummaryInput, plugins: list[Plugin] | None = None) -> GetPolicySummaryOutput

Retrieves a metadata-only summary of a specific policy without decrypting customer content. This lightweight read operation returns resource identifiers, status, and timestamps, but does not include the policy definition, 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 GetPolicySummaryInput

An instance of GetPolicySummaryInput.

 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
GetPolicySummaryOutput

An instance of GetPolicySummaryOutput.

Input

GetPolicySummaryInput dataclass

Dataclass for GetPolicySummaryInput structure.

Attributes

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

The identifier of the policy engine that manages the policy to retrieve the summary for.

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

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

Output

GetPolicySummaryOutput dataclass

Dataclass for GetPolicySummaryOutput structure.

Attributes

created_at instance-attribute 
created_at: datetime

The timestamp when the policy was originally created.

enforcement_mode class-attribute instance-attribute 
enforcement_mode: EnforcementMode = EnforcementMode('ACTIVE')

The current enforcement mode of the policy.

name instance-attribute 
name: str

The customer-assigned name of the policy.

policy_arn instance-attribute 
policy_arn: str

The Amazon Resource Name (ARN) of the policy.

policy_engine_id instance-attribute 
policy_engine_id: str

The identifier of the policy engine that manages this policy.

policy_id instance-attribute 
policy_id: str

The unique identifier of the policy.

status instance-attribute 
status: PolicyStatus

The current status of the policy.

updated_at instance-attribute 
updated_at: datetime

The timestamp when the policy was last modified.