list_policies¶
Operation¶
async
¶
list_policies(input: ListPoliciesInput, plugins: list[Plugin] | None = None) -> ListPoliciesOutput
Retrieves a list of policies within the AgentCore Policy engine. This operation supports pagination and filtering to help administrators manage and discover policies across policy engines. Results can be filtered by policy engine or resource associations.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ListPoliciesInput
|
An instance of |
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 |
|---|---|
ListPoliciesOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for ListPoliciesInput structure.
Attributes¶
class-attribute
instance-attribute
¶
max_results: int | None = None
The maximum number of policies to return in a single response. If not specified, the default is 10 policies per page, with a maximum of 100 per page.
class-attribute
instance-attribute
¶
next_token: str | None = None
A pagination token returned from a previous ListPolicies call. Use this token to retrieve the next page of results when the response is paginated.
class-attribute
instance-attribute
¶
policy_engine_id: str | None = None
The identifier of the policy engine whose policies to retrieve.
class-attribute
instance-attribute
¶
target_resource_scope: str | None = None
Optional filter to list policies that apply to a specific resource scope or resource type. This helps narrow down policy results to those relevant for particular Amazon Web Services resources, agent tools, or operational contexts within the policy engine ecosystem.
Output¶
dataclass
¶
Dataclass for ListPoliciesOutput structure.