:doc:`QuickSight <../../quicksight>` / Client / update_dashboard_permissions

****************************
update_dashboard_permissions
****************************



.. py:method:: QuickSight.Client.update_dashboard_permissions(**kwargs)

  

  Updates read and write permissions on a dashboard.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateDashboardPermissions>`_  


  **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',
                ]
            },
        ]
    )
    
  :type AwsAccountId: string
  :param AwsAccountId: **[REQUIRED]** 

    The ID of the Amazon Web Services account that contains the dashboard whose permissions you're updating.

    

  
  :type DashboardId: string
  :param DashboardId: **[REQUIRED]** 

    The ID for the dashboard.

    

  
  :type GrantPermissions: list
  :param GrantPermissions: 

    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 Quick Sight user or group associated with a data source or dataset. (This is common.)
         
        * The ARN of an Quick Sight user, group, or namespace associated with an analysis, dashboard, template, or theme. Namespace sharing is not supported for action connectors. (This is common.)
         
        * The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a Quick Sight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. Account root sharing is not supported for action connectors. (This is less common.)
        

        

      
      - **Actions** *(list) --* **[REQUIRED]** 

        The IAM action to grant or revoke permissions on.

        

      
        - *(string) --* 

        
    
    

  :type RevokePermissions: list
  :param RevokePermissions: 

    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 Quick Sight user or group associated with a data source or dataset. (This is common.)
         
        * The ARN of an Quick Sight user, group, or namespace associated with an analysis, dashboard, template, or theme. Namespace sharing is not supported for action connectors. (This is common.)
         
        * The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a Quick Sight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. Account root sharing is not supported for action connectors. (This is less common.)
        

        

      
      - **Actions** *(list) --* **[REQUIRED]** 

        The IAM action to grant or revoke permissions on.

        

      
        - *(string) --* 

        
    
    

  :type GrantLinkPermissions: list
  :param GrantLinkPermissions: 

    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 Quick Sight user or group associated with a data source or dataset. (This is common.)
         
        * The ARN of an Quick Sight user, group, or namespace associated with an analysis, dashboard, template, or theme. Namespace sharing is not supported for action connectors. (This is common.)
         
        * The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a Quick Sight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. Account root sharing is not supported for action connectors. (This is less common.)
        

        

      
      - **Actions** *(list) --* **[REQUIRED]** 

        The IAM action to grant or revoke permissions on.

        

      
        - *(string) --* 

        
    
    

  :type RevokeLinkPermissions: list
  :param RevokeLinkPermissions: 

    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 Quick Sight user or group associated with a data source or dataset. (This is common.)
         
        * The ARN of an Quick Sight user, group, or namespace associated with an analysis, dashboard, template, or theme. Namespace sharing is not supported for action connectors. (This is common.)
         
        * The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a Quick Sight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. Account root sharing is not supported for action connectors. (This is less common.)
        

        

      
      - **Actions** *(list) --* **[REQUIRED]** 

        The IAM action to grant or revoke permissions on.

        

      
        - *(string) --* 

        
    
    

  
  :rtype: 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 Quick Sight user or group associated with a data source or dataset. (This is common.)
             
            * The ARN of an Quick Sight user, group, or namespace associated with an analysis, dashboard, template, or theme. Namespace sharing is not supported for action connectors. (This is common.)
             
            * The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a Quick Sight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. Account root sharing is not supported for action connectors. (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 Quick Sight 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 Quick Sight user or group associated with a data source or dataset. (This is common.)
               
              * The ARN of an Quick Sight user, group, or namespace associated with an analysis, dashboard, template, or theme. Namespace sharing is not supported for action connectors. (This is common.)
               
              * The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a Quick Sight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. Account root sharing is not supported for action connectors. (This is less common.)
              

              
            

            - **Actions** *(list) --* 

              The IAM action to grant or revoke permissions on.

              
              

              - *(string) --* 
          
        
      
    
  
  **Exceptions**
  
  *   :py:class:`QuickSight.Client.exceptions.ThrottlingException`

  
  *   :py:class:`QuickSight.Client.exceptions.InvalidParameterValueException`

  
  *   :py:class:`QuickSight.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`QuickSight.Client.exceptions.UnsupportedUserEditionException`

  
  *   :py:class:`QuickSight.Client.exceptions.ConflictException`

  
  *   :py:class:`QuickSight.Client.exceptions.LimitExceededException`

  
  *   :py:class:`QuickSight.Client.exceptions.InternalFailureException`

  