Skip to content

Qbusiness  >  Operations  >  associate_permission

associate_permission

Operation

associate_permission async

associate_permission(input: AssociatePermissionInput, plugins: list[Plugin] | None = None) -> AssociatePermissionOutput

Adds or updates a permission policy for a Amazon Q Business application, allowing cross-account access for an ISV. This operation creates a new policy statement for the specified Amazon Q Business application. The policy statement defines the IAM actions that the ISV is allowed to perform on the Amazon Q Business application's resources.

Parameters:

Name Type Description Default
input AssociatePermissionInput

An instance of AssociatePermissionInput.

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
AssociatePermissionOutput

An instance of AssociatePermissionOutput.

Input

AssociatePermissionInput dataclass

Dataclass for AssociatePermissionInput structure.

Attributes

actions class-attribute instance-attribute
actions: list[str] | None = None

The list of Amazon Q Business actions that the ISV is allowed to perform.

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

The unique identifier of the Amazon Q Business application.

conditions class-attribute instance-attribute
conditions: list[PermissionCondition] | None = None

The conditions that restrict when the permission is effective. These conditions can be used to limit the permission based on specific attributes of the request.

principal class-attribute instance-attribute
principal: str | None = None

The Amazon Resource Name of the IAM role for the ISV that is being granted permission.

statement_id class-attribute instance-attribute
statement_id: str | None = None

A unique identifier for the policy statement.

Output

AssociatePermissionOutput dataclass

Dataclass for AssociatePermissionOutput structure.

Attributes

statement class-attribute instance-attribute
statement: str | None = None

The JSON representation of the added permission statement.