Skip to content

list_policy_summaries

Operation

list_policy_summaries

list_policy_summaries(request: ListPolicySummariesInput | ListPolicySummariesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListPolicySummariesInputDict]) -> ListPolicySummariesOutput

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.

Parameters:

Name Type Description Default
request ListPolicySummariesInput | ListPolicySummariesInputDict | 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[ListPolicySummariesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListPolicySummariesOutput

An instance of ListPolicySummariesOutput.

list_policy_summaries async

list_policy_summaries(request: ListPolicySummariesInput | ListPolicySummariesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListPolicySummariesInputDict]) -> ListPolicySummariesOutput

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.

Parameters:

Name Type Description Default
request ListPolicySummariesInput | ListPolicySummariesInputDict | 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[ListPolicySummariesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListPolicySummariesOutput

An instance of ListPolicySummariesOutput.

Input

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

ListPolicySummariesInputDict

Bases: TypedDict

Dictionary form of ListPolicySummariesInput.

Attributes

max_results instance-attribute
max_results: int | None

The maximum number of policy summaries to return in a single response.

next_token instance-attribute
next_token: str | None

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

policy_engine_id instance-attribute
policy_engine_id: Required[str]

The identifier of the policy engine whose policy summaries to retrieve.

target_resource_scope instance-attribute
target_resource_scope: str | None

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.

ListPolicySummariesInput dataclass

Bases: _SerdeShape

Dataclass for ListPolicySummariesInput structure.

Attributes

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

The maximum number of policy summaries to return in a single response.

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

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

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

The identifier of the policy engine whose policy summaries to retrieve.

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

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.

Output

ListPolicySummariesOutput dataclass

Bases: _SerdeShape

Dataclass for ListPolicySummariesOutput structure.

Attributes

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

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.

policies instance-attribute
policies: list[PolicySummary]

An array of policy summary objects that match the specified criteria. Each summary contains resource identifiers, status, and timestamps without customer-encrypted content.

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.