QApps / Client / update_q_app_permissions

update_q_app_permissions

QApps.Client.update_q_app_permissions(**kwargs)

Updates read permissions for a Amazon Q App in Amazon Q Business application environment instance.

See also: AWS API Documentation

Request Syntax

response = client.update_q_app_permissions(
    instanceId='string',
    appId='string',
    grantPermissions=[
        {
            'action': 'read'|'write',
            'principal': 'string'
        },
    ],
    revokePermissions=[
        {
            'action': 'read'|'write',
            'principal': 'string'
        },
    ]
)

Parameters:

• instanceId (string) –

  [REQUIRED]

  The unique identifier of the Amazon Q Business application environment instance.

• appId (string) –

  [REQUIRED]

  The unique identifier of the Amazon Q App for which permissions are being updated.

• grantPermissions (list) –

  The list of permissions to grant for the Amazon Q App.

  • (dict) –

    The permission to grant or revoke for a Amazon Q App.

    • action (string) – [REQUIRED]

      The action associated with the permission.

    • principal (string) – [REQUIRED]

      The principal user to which the permission applies.

• revokePermissions (list) –

  The list of permissions to revoke for the Amazon Q App.

  • (dict) –

    The permission to grant or revoke for a Amazon Q App.

    • action (string) – [REQUIRED]

      The action associated with the permission.

    • principal (string) – [REQUIRED]

      The principal user to which the permission applies.

Return type:

dict

Returns:

Response Syntax

{
    'resourceArn': 'string',
    'appId': 'string',
    'permissions': [
        {
            'action': 'read'|'write',
            'principal': {
                'userId': 'string',
                'userType': 'owner'|'user',
                'email': 'string'
            }
        },
    ]
}

Response Structure

• (dict) –

  • resourceArn (string) –

    The Amazon Resource Name (ARN) of the Amazon Q App for which permissions were updated.

  • appId (string) –

    The unique identifier of the Amazon Q App for which permissions were updated.

  • permissions (list) –

    The updated list of permissions for the Amazon Q App.

    • (dict) –

      The permission granted to the Amazon Q App.

      • action (string) –

        The action associated with the permission.

      • principal (dict) –

        The principal user to which the permission applies.

        • userId (string) –

          The unique identifier of the user.

        • userType (string) –

          The type of the user.

        • email (string) –

          The email address associated with the user.

Exceptions

• QApps.Client.exceptions.ResourceNotFoundException

• QApps.Client.exceptions.AccessDeniedException

• QApps.Client.exceptions.ValidationException

• QApps.Client.exceptions.InternalServerException

• QApps.Client.exceptions.UnauthorizedException

• QApps.Client.exceptions.ThrottlingException