Skip to content

get_policy_generation_summary

Operation

get_policy_generation_summary

get_policy_generation_summary(request: GetPolicyGenerationSummaryInput | GetPolicyGenerationSummaryInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetPolicyGenerationSummaryInputDict]) -> GetPolicyGenerationSummaryOutput

Retrieves a metadata-only summary of a specific policy generation request without decrypting customer content. This lightweight read operation returns resource identifiers, status, timestamps, and findings, 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 GetPolicyGenerationSummaryInput | GetPolicyGenerationSummaryInputDict | 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[GetPolicyGenerationSummaryInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetPolicyGenerationSummaryOutput

An instance of GetPolicyGenerationSummaryOutput.

get_policy_generation_summary async

get_policy_generation_summary(request: GetPolicyGenerationSummaryInput | GetPolicyGenerationSummaryInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetPolicyGenerationSummaryInputDict]) -> GetPolicyGenerationSummaryOutput

Retrieves a metadata-only summary of a specific policy generation request without decrypting customer content. This lightweight read operation returns resource identifiers, status, timestamps, and findings, 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 GetPolicyGenerationSummaryInput | GetPolicyGenerationSummaryInputDict | 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[GetPolicyGenerationSummaryInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetPolicyGenerationSummaryOutput

An instance of GetPolicyGenerationSummaryOutput.

Input

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

GetPolicyGenerationSummaryInputDict

Bases: TypedDict

Dictionary form of GetPolicyGenerationSummaryInput.

Attributes

policy_engine_id instance-attribute
policy_engine_id: Required[str]

The identifier of the policy engine associated with the policy generation request.

policy_generation_id instance-attribute
policy_generation_id: Required[str]

The unique identifier of the policy generation request to retrieve the summary for.

GetPolicyGenerationSummaryInput dataclass

Bases: _SerdeShape

Dataclass for GetPolicyGenerationSummaryInput structure.

Attributes

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

The identifier of the policy engine associated with the policy generation request.

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

The unique identifier of the policy generation request to retrieve the summary for.

Output

GetPolicyGenerationSummaryOutput dataclass

Bases: _SerdeShape

Dataclass for GetPolicyGenerationSummaryOutput structure.

Attributes

created_at instance-attribute
created_at: datetime

The timestamp when the policy generation request was created.

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

The findings from the policy generation process, if available.

name instance-attribute
name: str

The customer-assigned name for the policy generation request.

policy_engine_id instance-attribute
policy_engine_id: str

The identifier of the policy engine associated with this policy generation.

policy_generation_arn instance-attribute
policy_generation_arn: str

The Amazon Resource Name (ARN) of the policy generation request.

policy_generation_id instance-attribute
policy_generation_id: str

The unique identifier of the policy generation request.

resource instance-attribute
resource: Resource

The resource information associated with the policy generation.

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.

status instance-attribute
status: str

The current status of the policy generation request.

updated_at instance-attribute
updated_at: datetime

The timestamp when the policy generation was last updated.