BedrockAgentCoreControl / Client / list_policy_summaries
list_policy_summaries¶
- BedrockAgentCoreControl.Client.list_policy_summaries(**kwargs)¶
Retrieves 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.
See also: AWS API Documentation
Request Syntax
response = client.list_policy_summaries( nextToken='string', maxResults=123, policyEngineId='string', targetResourceScope='string' )
- Parameters:
nextToken (string) – A pagination token returned from a previous ListPolicySummaries call. Use this token to retrieve the next page of results when the response is paginated.
maxResults (integer) – The maximum number of policy summaries to return in a single response.
policyEngineId (string) –
[REQUIRED]
The identifier of the policy engine whose policy summaries to retrieve.
targetResourceScope (string) – Optional 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.
- Return type:
dict
- Returns:
Response Syntax
{ 'policies': [ { 'policyId': 'string', 'name': 'string', 'policyEngineId': 'string', 'createdAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1), 'policyArn': 'string', 'status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED' }, ], 'nextToken': 'string' }
Response Structure
(dict) –
policies (list) –
An array of policy summary objects that match the specified criteria. Each summary contains resource identifiers, status, and timestamps without customer-encrypted content.
(dict) –
Represents a metadata-only summary of a policy resource. This structure contains resource identifiers, status, and timestamps without customer-encrypted fields such as definition, description, or status reasons. Policy summaries are returned by operations that do not require access to the customer’s KMS key.
policyId (string) –
The unique identifier for the policy.
name (string) –
The customer-assigned name of the policy.
policyEngineId (string) –
The identifier of the policy engine that manages this policy.
createdAt (datetime) –
The timestamp when the policy was originally created.
updatedAt (datetime) –
The timestamp when the policy was last modified.
policyArn (string) –
The Amazon Resource Name (ARN) of the policy.
status (string) –
The current status of the policy.
nextToken (string) –
A pagination token that can be used in subsequent ListPolicySummaries calls to retrieve additional results. This token is only present when there are more results available.
Exceptions
BedrockAgentCoreControl.Client.exceptions.AccessDeniedExceptionBedrockAgentCoreControl.Client.exceptions.ValidationExceptionBedrockAgentCoreControl.Client.exceptions.ThrottlingExceptionBedrockAgentCoreControl.Client.exceptions.ResourceNotFoundExceptionBedrockAgentCoreControl.Client.exceptions.InternalServerException