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

*************
create_folder
*************



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

  

  Creates an empty shared folder.

  

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


  **Request Syntax**
  ::

    response = client.create_folder(
        AwsAccountId='string',
        FolderId='string',
        Name='string',
        FolderType='SHARED'|'RESTRICTED',
        ParentFolderArn='string',
        Permissions=[
            {
                'Principal': 'string',
                'Actions': [
                    'string',
                ]
            },
        ],
        Tags=[
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        SharingModel='ACCOUNT'|'NAMESPACE'
    )
    
  :type AwsAccountId: string
  :param AwsAccountId: **[REQUIRED]** 

    The ID for the Amazon Web Services account where you want to create the folder.

    

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

    The ID of the folder.

    

  
  :type Name: string
  :param Name: 

    The name of the folder.

    

  
  :type FolderType: string
  :param FolderType: 

    The type of folder. By default, ``folderType`` is ``SHARED``.

    

  
  :type ParentFolderArn: string
  :param ParentFolderArn: 

    The Amazon Resource Name (ARN) for the parent folder.

     

    ``ParentFolderArn`` can be null. An empty ``parentFolderArn`` creates a root-level folder.

    

  
  :type Permissions: list
  :param Permissions: 

    A structure that describes the principals and the resource-level permissions of a folder.

     

    To specify no permissions, omit ``Permissions``.

    

  
    - *(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 Tags: list
  :param Tags: 

    Tags for the folder.

    

  
    - *(dict) --* 

      The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.

      

    
      - **Key** *(string) --* **[REQUIRED]** 

        Tag key.

        

      
      - **Value** *(string) --* **[REQUIRED]** 

        Tag value.

        

      
    

  :type SharingModel: string
  :param SharingModel: 

    An optional parameter that determines the sharing scope of the folder. The default value for this parameter is ``ACCOUNT``.

    

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

    
    ::

      {
          'Status': 123,
          'Arn': 'string',
          'FolderId': 'string',
          'RequestId': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        The HTTP status of the request.

        
      

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

        The Amazon Resource Name (ARN) for the newly created folder.

        
      

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

        The folder ID for the newly created folder.

        
      

      - **RequestId** *(string) --* 

        The request ID for the newly created folder.

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

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

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

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

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

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

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

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

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

  