Skip to content

list_policy_engine_summaries

Operation

list_policy_engine_summaries

list_policy_engine_summaries(request: ListPolicyEngineSummariesInput | ListPolicyEngineSummariesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListPolicyEngineSummariesInputDict]) -> ListPolicyEngineSummariesOutput

Retrieves a paginated list of metadata-only policy engine summaries without decrypting customer content. This lightweight read operation returns resource identifiers, status, and timestamps for each policy engine, but does not include 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 ListPolicyEngineSummariesInput | ListPolicyEngineSummariesInputDict | 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[ListPolicyEngineSummariesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListPolicyEngineSummariesOutput

An instance of ListPolicyEngineSummariesOutput.

list_policy_engine_summaries async

list_policy_engine_summaries(request: ListPolicyEngineSummariesInput | ListPolicyEngineSummariesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListPolicyEngineSummariesInputDict]) -> ListPolicyEngineSummariesOutput

Retrieves a paginated list of metadata-only policy engine summaries without decrypting customer content. This lightweight read operation returns resource identifiers, status, and timestamps for each policy engine, but does not include 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 ListPolicyEngineSummariesInput | ListPolicyEngineSummariesInputDict | 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[ListPolicyEngineSummariesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListPolicyEngineSummariesOutput

An instance of ListPolicyEngineSummariesOutput.

Input

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

ListPolicyEngineSummariesInputDict

Bases: TypedDict

Dictionary form of ListPolicyEngineSummariesInput.

Attributes

max_results instance-attribute
max_results: int | None

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

next_token instance-attribute
next_token: str | None

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

ListPolicyEngineSummariesInput dataclass

Bases: _SerdeShape

Dataclass for ListPolicyEngineSummariesInput structure.

Attributes

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

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

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

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

Output

ListPolicyEngineSummariesOutput dataclass

Bases: _SerdeShape

Dataclass for ListPolicyEngineSummariesOutput structure.

Attributes

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

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

policy_engines instance-attribute
policy_engines: list[PolicyEngineSummary]

An array of policy engine summary objects that exist in the account. 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.