QuickSight / Client / describe_folder_permissions

describe_folder_permissions#

QuickSight.Client.describe_folder_permissions(**kwargs)#

Describes permissions for a folder.

See also: AWS API Documentation

Request Syntax

response = client.describe_folder_permissions(
    AwsAccountId='string',
    FolderId='string',
    Namespace='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • AwsAccountId (string) –

    [REQUIRED]

    The ID for the Amazon Web Services account that contains the folder.

  • FolderId (string) –

    [REQUIRED]

    The ID of the folder.

  • Namespace (string) – The namespace of the folder whose permissions you want described.

  • MaxResults (integer) – The maximum number of results to be returned per request.

  • NextToken (string) – A pagination token for the next set of results.

Return type:

dict

Returns:

Response Syntax

{
    'Status': 123,
    'FolderId': 'string',
    'Arn': 'string',
    'Permissions': [
        {
            'Principal': 'string',
            'Actions': [
                'string',
            ]
        },
    ],
    'RequestId': 'string',
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Status (integer) –

      The HTTP status of the request.

    • FolderId (string) –

      The ID of the folder.

    • Arn (string) –

      The Amazon Resource Name (ARN) for the folder.

    • Permissions (list) –

      Information about the permissions on the folder.

      • (dict) –

        Permission for the resource.

        • Principal (string) –

          The Amazon Resource Name (ARN) of the principal. This can be one of the following:

          • The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

          • The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)

          • The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.)

        • Actions (list) –

          The IAM action to grant or revoke permissions on.

          • (string) –

    • RequestId (string) –

      The Amazon Web Services request ID for this operation.

    • NextToken (string) –

      The pagination token for the next set of results, or null if there are no more results.

Exceptions