update_dashboard_permissions¶

QuickSight.Client.update_dashboard_permissions(**kwargs)¶

Updates read and write permissions on a dashboard.

Request Syntax

response = client.update_dashboard_permissions(
    AwsAccountId='string',
    DashboardId='string',
    GrantPermissions=[
        {
            'Principal': 'string',
            'Actions': [
                'string',
            ]
        },
    ],
    RevokePermissions=[
        {
            'Principal': 'string',
            'Actions': [
                'string',
            ]
        },
    ],
    GrantLinkPermissions=[
        {
            'Principal': 'string',
            'Actions': [
                'string',
            ]
        },
    ],
    RevokeLinkPermissions=[
        {
            'Principal': 'string',
            'Actions': [
                'string',
            ]
        },
    ]
)

Parameters

AwsAccountId (string) --
[REQUIRED]

The ID of the Amazon Web Services account that contains the dashboard whose permissions you're updating.
DashboardId (string) --
[REQUIRED]

The ID for the dashboard.
GrantPermissions (list) --
The permissions that you want to grant on this resource.
- (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 this resource.
- (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) --
GrantLinkPermissions (list) --
Grants link permissions to all users in a defined namespace.
- (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) --
RevokeLinkPermissions (list) --
Revokes link permissions from all users in a defined namespace.
- (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

{
    'DashboardArn': 'string',
    'DashboardId': 'string',
    'Permissions': [
        {
            'Principal': 'string',
            'Actions': [
                'string',
            ]
        },
    ],
    'RequestId': 'string',
    'Status': 123,
    'LinkSharingConfiguration': {
        'Permissions': [
            {
                'Principal': 'string',
                'Actions': [
                    'string',
                ]
            },
        ]
    }
}

Response Structure

(dict) --
- DashboardArn (string) --
  
  The Amazon Resource Name (ARN) of the dashboard.
- DashboardId (string) --
  
  The ID for the dashboard.
- Permissions (list) --
  
  Information about the permissions on the dashboard.
  - (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.
- Status (integer) --
  
  The HTTP status of the request.
- LinkSharingConfiguration (dict) --
  
  Updates the permissions of a shared link to an Amazon QuickSight dashboard.
  - Permissions (list) --
    
    A structure that contains the permissions of a shareable link.
    - (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) --

Exceptions

QuickSight.Client.exceptions.ThrottlingException
QuickSight.Client.exceptions.InvalidParameterValueException
QuickSight.Client.exceptions.ResourceNotFoundException
QuickSight.Client.exceptions.UnsupportedUserEditionException
QuickSight.Client.exceptions.ConflictException
QuickSight.Client.exceptions.LimitExceededException
QuickSight.Client.exceptions.InternalFailureException

Table Of Contents

update_dashboard_permissions¶