Skip to main content

policy_summaries

Creates, updates, deletes, gets or lists a policy_summaries resource.

Overview

Namepolicy_summaries
TypeResource
Idaws.bedrock_agentcore_control.policy_summaries

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
namestringThe customer-assigned name of the policy. (pattern: <code>[A-Za-z][A-Za-z0-9_]*</code>)
created_atstring (date-time)The timestamp when the policy was originally created.
enforcement_modestringThe enforcement mode for a policy. Run this policy in LOG_ONLY mode to collect data on how it affects your application. Once you are satisfied with the data gathered, switch the policy to ACTIVE. (ACTIVE, LOG_ONLY)
policy_arnstringThe Amazon Resource Name (ARN) of the policy. (pattern: <code>arn:aws[-a-z]{0,7}:bedrock-agentcore:[a-z0-9-]{9,15}:[0-9]{12}:policy-engine/[a-zA-Z][a-zA-Z0-9-]{0,47}-[a-zA-Z0-9]{10}/policy/[a-zA-Z][a-zA-Z0-9-]{0,47}-[a-zA-Z0-9]{10}</code>)
policy_engine_idstringThe identifier of the policy engine that manages this policy. (pattern: <code>[A-Za-z][A-Za-z0-9_]*-[a-z0-9_]{10}</code>)
policy_idstringThe unique identifier of the policy. (pattern: <code>[A-Za-z][A-Za-z0-9_]*-[a-z0-9_]{10}</code>)
statusstringThe current status of the policy. (CREATING, ACTIVE, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, DELETE_FAILED)
updated_atstring (date-time)The timestamp when the policy was last modified.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_policy_summaryselectpolicy_engine_id, policy_id, regionRetrieves 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.
list_policy_summariesselectpolicy_engine_id, regionnextToken, maxResults, targetResourceScopeRetrieves a paginated list of metadata-only policy summaries within a policy engine without decrypting customer content. This lightweight read operation returns resource identifiers, status, and timestamps for each policy, but does not include policy definitions, descriptions, 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

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
policy_engine_idstringThe identifier of the policy engine whose policy summaries to retrieve.
policy_idstringThe unique identifier of the policy to retrieve the summary for. This must be a valid policy ID that exists within the specified policy engine.
regionstringAWS region (default: us-east-1)
maxResultsintegerThe maximum number of policy summaries to return in a single response.
nextTokenstringA pagination token returned from a previous ListPolicySummaries call. Use this token to retrieve the next page of results when the response is paginated.
targetResourceScopestringOptional filter to list policy summaries that apply to a specific resource scope or resource type. This helps narrow down results to those relevant for particular Amazon Web Services resources, agent tools, or operational contexts within the policy engine ecosystem.

SELECT examples

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.

SELECT
name,
created_at,
enforcement_mode,
policy_arn,
policy_engine_id,
policy_id,
status,
updated_at
FROM aws.bedrock_agentcore_control.policy_summaries
WHERE policy_engine_id = '{{ policy_engine_id }}' -- required
AND policy_id = '{{ policy_id }}' -- required
AND region = '{{ region }}' -- required
;