Skip to content

associate_permission

Operation

associate_permission

associate_permission(request: AssociatePermissionInput | AssociatePermissionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[AssociatePermissionInputDict]) -> 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
request AssociatePermissionInput | AssociatePermissionInputDict | 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[AssociatePermissionInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
AssociatePermissionOutput

An instance of AssociatePermissionOutput.

associate_permission async

associate_permission(request: AssociatePermissionInput | AssociatePermissionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[AssociatePermissionInputDict]) -> 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
request AssociatePermissionInput | AssociatePermissionInputDict | 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[AssociatePermissionInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
AssociatePermissionOutput

An instance of AssociatePermissionOutput.

Input

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

AssociatePermissionInputDict

Bases: TypedDict

Dictionary form of AssociatePermissionInput.

Attributes

actions instance-attribute
actions: Required[Sequence[str]]

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

application_id instance-attribute
application_id: Required[str]

The unique identifier of the Amazon Q Business application.

conditions instance-attribute

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 instance-attribute
principal: Required[str]

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

statement_id instance-attribute
statement_id: Required[str]

A unique identifier for the policy statement.

AssociatePermissionInput dataclass

Bases: _SerdeShape

Dataclass for AssociatePermissionInput structure.

Attributes

actions class-attribute instance-attribute
actions: list[str] | 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 = ...

The unique identifier of the Amazon Q Business application.

conditions class-attribute instance-attribute
conditions: list[PermissionCondition] | 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 = ...

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 = ...

A unique identifier for the policy statement.

Output

AssociatePermissionOutput dataclass

Bases: _SerdeShape

Dataclass for AssociatePermissionOutput structure.

Attributes

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.

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

The JSON representation of the added permission statement.