Skip to content

list_policy_engines

Operation

list_policy_engines

list_policy_engines(request: ListPolicyEnginesInput | ListPolicyEnginesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListPolicyEnginesInputDict]) -> ListPolicyEnginesOutput

Retrieves a list of policy engines within the AgentCore Policy system. This operation supports pagination to help administrators discover and manage policy engines across their account. Each policy engine serves as a container for related policies.

Parameters:

Name Type Description Default
request ListPolicyEnginesInput | ListPolicyEnginesInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[ListPolicyEnginesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListPolicyEnginesOutput

An instance of ListPolicyEnginesOutput.

list_policy_engines async

list_policy_engines(request: ListPolicyEnginesInput | ListPolicyEnginesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListPolicyEnginesInputDict]) -> ListPolicyEnginesOutput

Retrieves a list of policy engines within the AgentCore Policy system. This operation supports pagination to help administrators discover and manage policy engines across their account. Each policy engine serves as a container for related policies.

Parameters:

Name Type Description Default
request ListPolicyEnginesInput | ListPolicyEnginesInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[ListPolicyEnginesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListPolicyEnginesOutput

An instance of ListPolicyEnginesOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

ListPolicyEnginesInputDict

Bases: TypedDict

Dictionary form of ListPolicyEnginesInput.

Attributes

max_results instance-attribute
max_results: int | None

The maximum number of policy engines to return in a single response. If not specified, the default is 10 policy engines per page, with a maximum of 100 per page.

next_token instance-attribute
next_token: str | None

A pagination token returned from a previous ListPolicyEngines call. Use this token to retrieve the next page of results when the response is paginated.

ListPolicyEnginesInput dataclass

Bases: _SerdeShape

Dataclass for ListPolicyEnginesInput structure.

Attributes

max_results class-attribute instance-attribute
max_results: int | None = ...

The maximum number of policy engines to return in a single response. If not specified, the default is 10 policy engines per page, with a maximum of 100 per page.

next_token class-attribute instance-attribute
next_token: str | None = ...

A pagination token returned from a previous ListPolicyEngines call. Use this token to retrieve the next page of results when the response is paginated.

Output

ListPolicyEnginesOutput dataclass

Bases: _SerdeShape

Dataclass for ListPolicyEnginesOutput structure.

Attributes

next_token class-attribute instance-attribute
next_token: str | None = ...

A pagination token that can be used in subsequent ListPolicyEngines calls to retrieve additional results. This token is only present when there are more results available.

policy_engines instance-attribute
policy_engines: list[PolicyEngine]

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.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.