:doc:`Connect <../../connect>` / Client / describe_user_hierarchy_structure

*********************************
describe_user_hierarchy_structure
*********************************



.. py:method:: Connect.Client.describe_user_hierarchy_structure(**kwargs)

  

  Describes the hierarchy structure of the specified Amazon Connect instance.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUserHierarchyStructure>`_  


  **Request Syntax**
  ::

    response = client.describe_user_hierarchy_structure(
        InstanceId='string'
    )
    
  :type InstanceId: string
  :param InstanceId: **[REQUIRED]** 

    The identifier of the Amazon Connect instance. You can `find the instance ID <https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html>`__ in the Amazon Resource Name (ARN) of the instance.

    

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

    
    ::

      {
          'HierarchyStructure': {
              'LevelOne': {
                  'Id': 'string',
                  'Arn': 'string',
                  'Name': 'string',
                  'LastModifiedTime': datetime(2015, 1, 1),
                  'LastModifiedRegion': 'string'
              },
              'LevelTwo': {
                  'Id': 'string',
                  'Arn': 'string',
                  'Name': 'string',
                  'LastModifiedTime': datetime(2015, 1, 1),
                  'LastModifiedRegion': 'string'
              },
              'LevelThree': {
                  'Id': 'string',
                  'Arn': 'string',
                  'Name': 'string',
                  'LastModifiedTime': datetime(2015, 1, 1),
                  'LastModifiedRegion': 'string'
              },
              'LevelFour': {
                  'Id': 'string',
                  'Arn': 'string',
                  'Name': 'string',
                  'LastModifiedTime': datetime(2015, 1, 1),
                  'LastModifiedRegion': 'string'
              },
              'LevelFive': {
                  'Id': 'string',
                  'Arn': 'string',
                  'Name': 'string',
                  'LastModifiedTime': datetime(2015, 1, 1),
                  'LastModifiedRegion': 'string'
              }
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **HierarchyStructure** *(dict) --* 

        Information about the hierarchy structure.

        
        

        - **LevelOne** *(dict) --* 

          Information about level one.

          
          

          - **Id** *(string) --* 

            The identifier of the hierarchy level.

            
          

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

            The Amazon Resource Name (ARN) of the hierarchy level.

            
          

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

            The name of the hierarchy level.

            
          

          - **LastModifiedTime** *(datetime) --* 

            The timestamp when this resource was last modified.

            
          

          - **LastModifiedRegion** *(string) --* 

            The Amazon Web Services Region where this resource was last modified.

            
      
        

        - **LevelTwo** *(dict) --* 

          Information about level two.

          
          

          - **Id** *(string) --* 

            The identifier of the hierarchy level.

            
          

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

            The Amazon Resource Name (ARN) of the hierarchy level.

            
          

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

            The name of the hierarchy level.

            
          

          - **LastModifiedTime** *(datetime) --* 

            The timestamp when this resource was last modified.

            
          

          - **LastModifiedRegion** *(string) --* 

            The Amazon Web Services Region where this resource was last modified.

            
      
        

        - **LevelThree** *(dict) --* 

          Information about level three.

          
          

          - **Id** *(string) --* 

            The identifier of the hierarchy level.

            
          

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

            The Amazon Resource Name (ARN) of the hierarchy level.

            
          

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

            The name of the hierarchy level.

            
          

          - **LastModifiedTime** *(datetime) --* 

            The timestamp when this resource was last modified.

            
          

          - **LastModifiedRegion** *(string) --* 

            The Amazon Web Services Region where this resource was last modified.

            
      
        

        - **LevelFour** *(dict) --* 

          Information about level four.

          
          

          - **Id** *(string) --* 

            The identifier of the hierarchy level.

            
          

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

            The Amazon Resource Name (ARN) of the hierarchy level.

            
          

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

            The name of the hierarchy level.

            
          

          - **LastModifiedTime** *(datetime) --* 

            The timestamp when this resource was last modified.

            
          

          - **LastModifiedRegion** *(string) --* 

            The Amazon Web Services Region where this resource was last modified.

            
      
        

        - **LevelFive** *(dict) --* 

          Information about level five.

          
          

          - **Id** *(string) --* 

            The identifier of the hierarchy level.

            
          

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

            The Amazon Resource Name (ARN) of the hierarchy level.

            
          

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

            The name of the hierarchy level.

            
          

          - **LastModifiedTime** *(datetime) --* 

            The timestamp when this resource was last modified.

            
          

          - **LastModifiedRegion** *(string) --* 

            The Amazon Web Services Region where this resource was last modified.

            
      
    
  
  **Exceptions**
  
  *   :py:class:`Connect.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`Connect.Client.exceptions.InvalidParameterException`

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

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

  
  *   :py:class:`Connect.Client.exceptions.InternalServiceException`

  