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

*****************************
describe_user_hierarchy_group
*****************************



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

  

  Describes the specified hierarchy group.

  

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


  **Request Syntax**
  ::

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

    The identifier of the hierarchy group.

    

  
  :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**

    
    ::

      {
          'HierarchyGroup': {
              'Id': 'string',
              'Arn': 'string',
              'Name': 'string',
              'LevelId': 'string',
              'HierarchyPath': {
                  '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'
                  }
              },
              'Tags': {
                  'string': 'string'
              },
              'LastModifiedTime': datetime(2015, 1, 1),
              'LastModifiedRegion': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **HierarchyGroup** *(dict) --* 

        Information about the hierarchy group.

        
        

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

          The identifier of the hierarchy group.

          
        

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

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

          
        

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

          The name of the hierarchy group.

          
        

        - **LevelId** *(string) --* 

          The identifier of the level in the hierarchy group.

          
        

        - **HierarchyPath** *(dict) --* 

          Information about the levels in the hierarchy group.

          
          

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

            Information about level one.

            
            

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

              The identifier of the hierarchy group.

              
            

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

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

              
            

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

              The name of the hierarchy group.

              
            

            - **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 group.

              
            

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

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

              
            

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

              The name of the hierarchy group.

              
            

            - **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 group.

              
            

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

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

              
            

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

              The name of the hierarchy group.

              
            

            - **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 group.

              
            

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

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

              
            

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

              The name of the hierarchy group.

              
            

            - **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 group.

              
            

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

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

              
            

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

              The name of the hierarchy group.

              
            

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

              The timestamp when this resource was last modified.

              
            

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

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

              
        
      
        

        - **Tags** *(dict) --* 

          The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

          
          

          - *(string) --* 
            

            - *(string) --* 
      
    
        

        - **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`

  