QuickSight / Client / describe_dashboard_permissions

describe_dashboard_permissions#

QuickSight.Client.describe_dashboard_permissions(**kwargs)#

Describes read and write permissions for a dashboard.

Request Syntax

response = client.describe_dashboard_permissions(
    AwsAccountId='string',
    DashboardId='string'
)

Parameters:

AwsAccountId (string) –
[REQUIRED]

The ID of the Amazon Web Services account that contains the dashboard that you’re describing permissions for.
DashboardId (string) –
[REQUIRED]

The ID for the dashboard, also added to the IAM policy.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –
- DashboardId (string) –
  
  The ID for the dashboard.
- DashboardArn (string) –
  
  The Amazon Resource Name (ARN) of the dashboard.
- Permissions (list) –
  
  A structure that contains the permissions for 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) –
- Status (integer) –
  
  The HTTP status of the request.
- RequestId (string) –
  
  The Amazon Web Services request ID for this operation.
- LinkSharingConfiguration (dict) –
  
  A structure that contains the configuration of a shareable link that grants access to the dashboard. Your users can use the link to view and interact with the dashboard, if the dashboard has been shared with them. For more information about sharing dashboards, see Sharing Dashboards.
  - 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.InvalidParameterValueException
QuickSight.Client.exceptions.ResourceNotFoundException
QuickSight.Client.exceptions.ThrottlingException
QuickSight.Client.exceptions.UnsupportedUserEditionException
QuickSight.Client.exceptions.InternalFailureException