update_data_set_permissions

QuickSight.Client.update_data_set_permissions(**kwargs)

Updates the permissions on a dataset.

The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id .

See also: AWS API Documentation

Request Syntax

response = client.update_data_set_permissions(
    AwsAccountId='string',
    DataSetId='string',
    GrantPermissions=[
        {
            'Principal': 'string',
            'Actions': [
                'string',
            ]
        },
    ],
    RevokePermissions=[
        {
            'Principal': 'string',
            'Actions': [
                'string',
            ]
        },
    ]
)

Parameters

• AwsAccountId (string) --

  [REQUIRED]

  The Amazon Web Services account ID.

• DataSetId (string) --

  [REQUIRED]

  The ID for the dataset whose permissions you want to update. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

• GrantPermissions (list) --

  The resource permissions that you want to grant to the dataset.

  • (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 resource permissions that you want to revoke from the dataset.

  • (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

{
    'DataSetArn': 'string',
    'DataSetId': 'string',
    'RequestId': 'string',
    'Status': 123
}

Response Structure

• (dict) --

  • DataSetArn (string) --

    The Amazon Resource Name (ARN) of the dataset.

  • DataSetId (string) --

    The ID for the dataset whose permissions you want to update. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

  • RequestId (string) --

    The Amazon Web Services request ID for this operation.

  • Status (integer) --

    The HTTP status of the request.

Exceptions

• QuickSight.Client.exceptions.AccessDeniedException
• QuickSight.Client.exceptions.ConflictException
• QuickSight.Client.exceptions.InvalidParameterValueException
• QuickSight.Client.exceptions.ResourceNotFoundException
• QuickSight.Client.exceptions.ThrottlingException
• QuickSight.Client.exceptions.InternalFailureException