QuickSight / Client / update_folder_permissions

update_folder_permissions#

QuickSight.Client.update_folder_permissions(**kwargs)#

Updates permissions of a folder.

See also: AWS API Documentation

Request Syntax

response = client.update_folder_permissions(
    AwsAccountId='string',
    FolderId='string',
    GrantPermissions=[
        {
            'Principal': 'string',
            'Actions': [
                'string',
            ]
        },
    ],
    RevokePermissions=[
        {
            'Principal': 'string',
            'Actions': [
                'string',
            ]
        },
    ]
)
Parameters:

  • AwsAccountId (string) –

    [REQUIRED]

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

  • FolderId (string) –

    [REQUIRED]

    The ID of the folder.

  • GrantPermissions (list) –

    The permissions that you want to grant on a resource. Namespace ARNs are not supported Principal values for folder permissions.

    • (dict) –

      Permission for the resource.

      • Principal (string) – [REQUIRED]

        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) – [REQUIRED]

        The IAM action to grant or revoke permissions on.

        • (string) –

  • RevokePermissions (list) –

    The permissions that you want to revoke from a resource. Namespace ARNs are not supported Principal values for folder permissions.

    • (dict) –

      Permission for the resource.

      • Principal (string) – [REQUIRED]

        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) – [REQUIRED]

        The IAM action to grant or revoke permissions on.

        • (string) –

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • Status (integer) –

      The HTTP status of the request.

    • Arn (string) –

      The Amazon Resource Name (ARN) of the folder.

    • FolderId (string) –

      The ID of the folder.

    • Permissions (list) –

      Information about the permissions for 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.

Exceptions

  • QuickSight.Client.exceptions.InvalidParameterValueException

  • QuickSight.Client.exceptions.AccessDeniedException

  • QuickSight.Client.exceptions.LimitExceededException

  • QuickSight.Client.exceptions.ResourceNotFoundException

  • QuickSight.Client.exceptions.ThrottlingException

  • QuickSight.Client.exceptions.UnsupportedUserEditionException

  • QuickSight.Client.exceptions.InternalFailureException