Skip to content

list_policy_generation_summaries

Operation

list_policy_generation_summaries

list_policy_generation_summaries(request: ListPolicyGenerationSummariesInput | ListPolicyGenerationSummariesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListPolicyGenerationSummariesInputDict]) -> ListPolicyGenerationSummariesOutput

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

The input fields as keyword arguments.

{}

Returns:

Type Description
ListPolicyGenerationSummariesOutput

An instance of ListPolicyGenerationSummariesOutput.

list_policy_generation_summaries async

list_policy_generation_summaries(request: ListPolicyGenerationSummariesInput | ListPolicyGenerationSummariesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListPolicyGenerationSummariesInputDict]) -> ListPolicyGenerationSummariesOutput

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

The input fields as keyword arguments.

{}

Returns:

Type Description
ListPolicyGenerationSummariesOutput

An instance of ListPolicyGenerationSummariesOutput.

Input

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

ListPolicyGenerationSummariesInputDict

Bases: TypedDict

Dictionary form of ListPolicyGenerationSummariesInput.

Attributes

max_results instance-attribute
max_results: int | None

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

next_token instance-attribute
next_token: str | None

A pagination token returned from a previous ListPolicyGenerationSummaries 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 generation summaries to retrieve.

ListPolicyGenerationSummariesInput dataclass

Bases: _SerdeShape

Dataclass for ListPolicyGenerationSummariesInput structure.

Attributes

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

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

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

A pagination token returned from a previous ListPolicyGenerationSummaries 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 generation summaries to retrieve.

Output

ListPolicyGenerationSummariesOutput dataclass

Bases: _SerdeShape

Dataclass for ListPolicyGenerationSummariesOutput structure.

Attributes

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

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

policy_generations instance-attribute
policy_generations: list[PolicyGenerationSummary]

An array of policy generation summary objects that match the specified criteria. Each summary contains resource identifiers, status, timestamps, and findings 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.