QApps / Client / describe_q_app_permissions

describe_q_app_permissions#

QApps.Client.describe_q_app_permissions(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.describe_q_app_permissions(
    instanceId='string',
    appId='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 to retrieve permissions.

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 are returned.

    • appId (string) –

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

    • permissions (list) –

      The list of permissions granted 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