Qbusiness  >  Operations  >  get_policy

get_policy

Operation

get_policy async

get_policy(input: GetPolicyInput, plugins: list[Plugin] | None = None) -> 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
input	GetPolicyInput	An instance of GetPolicyInput.	required
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

Returns:

Type	Description
GetPolicyOutput	An instance of GetPolicyOutput.

Input

GetPolicyInput dataclass

Dataclass for GetPolicyInput structure.

Attributes

application_id class-attribute instance-attribute

application_id: str | None = None

The unique identifier of the Amazon Q Business application.

Output

GetPolicyOutput dataclass

Dataclass for GetPolicyOutput structure.

Attributes

policy class-attribute instance-attribute

policy: str | None = None

The JSON representation of the permission policy.