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

***************
describe_folder
***************



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

  

  Describes a folder.

  

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


  **Request Syntax**
  ::

    response = client.describe_folder(
        AwsAccountId='string',
        FolderId='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.

    

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

    
    ::

      {
          'Status': 123,
          'Folder': {
              'FolderId': 'string',
              'Arn': 'string',
              'Name': 'string',
              'FolderType': 'SHARED'|'RESTRICTED',
              'FolderPath': [
                  'string',
              ],
              'CreatedTime': datetime(2015, 1, 1),
              'LastUpdatedTime': datetime(2015, 1, 1),
              'SharingModel': 'ACCOUNT'|'NAMESPACE'
          },
          'RequestId': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        The HTTP status of the request.

        
      

      - **Folder** *(dict) --* 

        Information about the folder.

        
        

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

          The ID of the folder.

          
        

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

          The Amazon Resource Name (ARN) for the folder.

          
        

        - **Name** *(string) --* 

          A display name for the folder.

          
        

        - **FolderType** *(string) --* 

          The type of folder it is.

          
        

        - **FolderPath** *(list) --* 

          An array of ancestor ARN strings for the folder.

          
          

          - *(string) --* 
      
        

        - **CreatedTime** *(datetime) --* 

          The time that the folder was created.

          
        

        - **LastUpdatedTime** *(datetime) --* 

          The time that the folder was last updated.

          
        

        - **SharingModel** *(string) --* 

          The sharing scope of the folder.

          
    
      

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

        The Amazon Web Services request ID for this operation.

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

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

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

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

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

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

  