Skip to content

list_policy_generation_assets

Operation

list_policy_generation_assets

list_policy_generation_assets(request: ListPolicyGenerationAssetsInput | ListPolicyGenerationAssetsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListPolicyGenerationAssetsInputDict]) -> ListPolicyGenerationAssetsOutput

Retrieves a list of generated policy assets from a policy generation request within the AgentCore Policy system. This operation returns the actual Dogwood policies and related artifacts produced by the AI-powered policy generation process, allowing users to review and select from multiple generated policy options.

Parameters:

Name Type Description Default
request ListPolicyGenerationAssetsInput | ListPolicyGenerationAssetsInputDict | 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[ListPolicyGenerationAssetsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListPolicyGenerationAssetsOutput

An instance of ListPolicyGenerationAssetsOutput.

list_policy_generation_assets async

list_policy_generation_assets(request: ListPolicyGenerationAssetsInput | ListPolicyGenerationAssetsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListPolicyGenerationAssetsInputDict]) -> ListPolicyGenerationAssetsOutput

Retrieves a list of generated policy assets from a policy generation request within the AgentCore Policy system. This operation returns the actual Dogwood policies and related artifacts produced by the AI-powered policy generation process, allowing users to review and select from multiple generated policy options.

Parameters:

Name Type Description Default
request ListPolicyGenerationAssetsInput | ListPolicyGenerationAssetsInputDict | 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[ListPolicyGenerationAssetsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListPolicyGenerationAssetsOutput

An instance of ListPolicyGenerationAssetsOutput.

Input

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

ListPolicyGenerationAssetsInputDict

Bases: TypedDict

Dictionary form of ListPolicyGenerationAssetsInput.

Attributes

max_results instance-attribute
max_results: int | None

The maximum number of policy generation assets to return in a single response. If not specified, the default is 10 assets per page, with a maximum of 100 per page. This helps control response size when dealing with policy generations that produce many alternative policy options.

next_token instance-attribute
next_token: str | None

A pagination token returned from a previous ListPolicyGenerationAssets call. Use this token to retrieve the next page of assets when the response is paginated due to large numbers of generated policy options.

policy_engine_id instance-attribute
policy_engine_id: Required[str]

The unique identifier of the policy engine associated with the policy generation request. This provides the context for the generation operation and ensures assets are retrieved from the correct policy engine.

policy_generation_id instance-attribute
policy_generation_id: Required[str]

The unique identifier of the policy generation request whose assets are to be retrieved. This must be a valid generation ID from a previous StartPolicyGeneration call that has completed processing.

ListPolicyGenerationAssetsInput dataclass

Bases: _SerdeShape

Dataclass for ListPolicyGenerationAssetsInput structure.

Attributes

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

The maximum number of policy generation assets to return in a single response. If not specified, the default is 10 assets per page, with a maximum of 100 per page. This helps control response size when dealing with policy generations that produce many alternative policy options.

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

A pagination token returned from a previous ListPolicyGenerationAssets call. Use this token to retrieve the next page of assets when the response is paginated due to large numbers of generated policy options.

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

The unique identifier of the policy engine associated with the policy generation request. This provides the context for the generation operation and ensures assets are retrieved from the correct policy engine.

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

The unique identifier of the policy generation request whose assets are to be retrieved. This must be a valid generation ID from a previous StartPolicyGeneration call that has completed processing.

Output

ListPolicyGenerationAssetsOutput dataclass

Bases: _SerdeShape

Dataclass for ListPolicyGenerationAssetsOutput structure.

Attributes

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

A pagination token that can be used in subsequent ListPolicyGenerationAssets calls to retrieve additional assets. This token is only present when there are more generated policy assets available beyond the current response.

policy_generation_assets class-attribute instance-attribute
policy_generation_assets: list[PolicyGenerationAsset] | None = ...

An array of generated policy assets including Dogwood policies and related artifacts from the AI-powered policy generation process. Each asset represents a different policy option or variation generated from the original natural language input.

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.