BedrockAgentCoreControl / Paginator / ListPolicyEngines
ListPolicyEngines¶
- class BedrockAgentCoreControl.Paginator.ListPolicyEngines¶
paginator = client.get_paginator('list_policy_engines')
- paginate(**kwargs)¶
Creates an iterator that will paginate through responses from
BedrockAgentCoreControl.Client.list_policy_engines().See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a
NextTokenwill be provided in the output that you can use to resume pagination.PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the
NextTokenfrom a previous response.
- Return type:
dict
- Returns:
Response Syntax
{ 'policyEngines': [ { 'policyEngineId': 'string', 'name': 'string', 'description': 'string', 'createdAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1), 'policyEngineArn': 'string', 'status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED', 'statusReasons': [ 'string', ] }, ], 'NextToken': 'string' }
Response Structure
(dict) –
policyEngines (list) –
An array of policy engine objects that exist in the account. Each policy engine object contains the engine metadata, status, and key identifiers for further operations.
(dict) –
Represents a policy engine resource within the AgentCore Policy system. Policy engines serve as containers for grouping related policies and provide the execution context for policy evaluation and management. Each policy engine can be associated with one Gateway (one engine per Gateway), where it intercepts all agent tool calls and evaluates them against the contained policies before allowing tools to execute. The policy engine maintains the Cedar schema generated from the Gateway’s tool manifest, ensuring that policies are validated against the actual tools and parameters available. Policy engines support two enforcement modes that can be configured when associating with a Gateway: log-only mode for testing (evaluates decisions without blocking) and enforce mode for production (actively allows or denies based on policy evaluation).
policyEngineId (string) –
The unique identifier for the policy engine. This system-generated identifier consists of the user name plus a 10-character generated suffix and serves as the primary key for policy engine operations.
name (string) –
The customer-assigned immutable name for the policy engine. This human-readable identifier must be unique within the account and cannot exceed 48 characters.
description (string) –
A human-readable description of the policy engine’s purpose and scope. Limited to 4,096 characters, this helps administrators understand the policy engine’s role in the overall governance strategy.
createdAt (datetime) –
The timestamp when the policy engine was originally created. This is automatically set by the service and used for auditing and lifecycle management.
updatedAt (datetime) –
The timestamp when the policy engine was last modified. This tracks the most recent changes to the policy engine configuration or metadata.
policyEngineArn (string) –
The Amazon Resource Name (ARN) of the policy engine. This globally unique identifier can be used for cross-service references and IAM policy statements.
status (string) –
The current status of the policy engine.
statusReasons (list) –
Additional information about the policy engine status. This provides details about any failures or the current state of the policy engine lifecycle.
(string) –
NextToken (string) –
A token to resume pagination.