Skip to content

get_policy

Operation

get_policy

get_policy(request: GetPolicyInput | GetPolicyInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetPolicyInputDict]) -> GetPolicyOutput

Retrieves the current permission policy for a Amazon Q Business application. The policy is returned as a JSON-formatted string and defines the IAM actions that are allowed or denied for the application's resources.

Parameters:

Name Type Description Default
request GetPolicyInput | GetPolicyInputDict | 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[GetPolicyInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetPolicyOutput

An instance of GetPolicyOutput.

get_policy async

get_policy(request: GetPolicyInput | GetPolicyInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetPolicyInputDict]) -> GetPolicyOutput

Retrieves the current permission policy for a Amazon Q Business application. The policy is returned as a JSON-formatted string and defines the IAM actions that are allowed or denied for the application's resources.

Parameters:

Name Type Description Default
request GetPolicyInput | GetPolicyInputDict | 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[GetPolicyInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetPolicyOutput

An instance of GetPolicyOutput.

Input

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

GetPolicyInputDict

Bases: TypedDict

Dictionary form of GetPolicyInput.

Attributes

application_id instance-attribute
application_id: Required[str]

The unique identifier of the Amazon Q Business application.

GetPolicyInput dataclass

Bases: _SerdeShape

Dataclass for GetPolicyInput structure.

Attributes

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

The unique identifier of the Amazon Q Business application.

Output

GetPolicyOutput dataclass

Bases: _SerdeShape

Dataclass for GetPolicyOutput structure.

Attributes

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

The JSON representation of the permission policy.

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.