:doc:`QuickSight <../../quicksight>` / Paginator / DescribeFolderPermissions

*************************
DescribeFolderPermissions
*************************



.. py:class:: QuickSight.Paginator.DescribeFolderPermissions

  ::

    
    paginator = client.get_paginator('describe_folder_permissions')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`QuickSight.Client.describe_folder_permissions`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          AwsAccountId='string',
          FolderId='string',
          Namespace='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type AwsAccountId: string
    :param AwsAccountId: **[REQUIRED]** 

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

      

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

      The ID of the folder.

      

    
    :type Namespace: string
    :param Namespace: 

      The namespace of the folder whose permissions you want described.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

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

      

      - *(dict) --* 
        

        - **Status** *(integer) --* 

          The HTTP status of the request.

          
        

        - **FolderId** *(string) --* 

          The ID of the folder.

          
        

        - **Arn** *(string) --* 

          The Amazon Resource Name (ARN) for the folder.

          
        

        - **Permissions** *(list) --* 

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

          
    