:doc:`ConnectCases <../../connectcases>` / Client / get_layout

**********
get_layout
**********



.. py:method:: ConnectCases.Client.get_layout(**kwargs)

  

  Returns the details for the requested layout.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/GetLayout>`_  


  **Request Syntax**
  ::

    response = client.get_layout(
        domainId='string',
        layoutId='string'
    )
    
  :type domainId: string
  :param domainId: **[REQUIRED]** 

    The unique identifier of the Cases domain.

    

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

    The unique identifier of the layout.

    

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

    
    ::

      {
          'layoutId': 'string',
          'layoutArn': 'string',
          'name': 'string',
          'content': {
              'basic': {
                  'topPanel': {
                      'sections': [
                          {
                              'fieldGroup': {
                                  'name': 'string',
                                  'fields': [
                                      {
                                          'id': 'string'
                                      },
                                  ]
                              }
                          },
                      ]
                  },
                  'moreInfo': {
                      'sections': [
                          {
                              'fieldGroup': {
                                  'name': 'string',
                                  'fields': [
                                      {
                                          'id': 'string'
                                      },
                                  ]
                              }
                          },
                      ]
                  }
              }
          },
          'tags': {
              'string': 'string'
          },
          'deleted': True|False,
          'createdTime': datetime(2015, 1, 1),
          'lastModifiedTime': datetime(2015, 1, 1)
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **layoutId** *(string) --* 

        The unique identifier of the layout.

        
      

      - **layoutArn** *(string) --* 

        The Amazon Resource Name (ARN) of the newly created layout.

        
      

      - **name** *(string) --* 

        The name of the layout. It must be unique.

        
      

      - **content** *(dict) --* 

        Information about which fields will be present in the layout, the order of the fields, and read-only attribute of the field.

        .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``basic``.     If a client receives an unknown member it will     set ``SDK_UNKNOWN_MEMBER`` as the top level key,     which maps to the name or tag of the unknown     member. The structure of ``SDK_UNKNOWN_MEMBER`` is     as follows::

                'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}


      
        

        - **basic** *(dict) --* 

          Content specific to ``BasicLayout`` type. It configures fields in the top panel and More Info tab of Cases user interface.

          
          

          - **topPanel** *(dict) --* 

            This represents sections in a panel of the page layout.

            
            

            - **sections** *(list) --* 

              Ordered list containing different kinds of sections that can be added.

              
              

              - *(dict) --* 

                This represents a sections within a panel or tab of the page layout.

                .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``fieldGroup``.     If a client receives an unknown member it will     set ``SDK_UNKNOWN_MEMBER`` as the top level key,     which maps to the name or tag of the unknown     member. The structure of ``SDK_UNKNOWN_MEMBER`` is     as follows::

                                'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}


              
                

                - **fieldGroup** *(dict) --* 

                  Consists of a group of fields and associated properties.

                  
                  

                  - **name** *(string) --* 

                    Name of the field group.

                    
                  

                  - **fields** *(list) --* 

                    Represents an ordered list containing field related information.

                    
                    

                    - *(dict) --* 

                      Object for field related information.

                      
                      

                      - **id** *(string) --* 

                        Unique identifier of a field.

                        
                  
                
              
            
          
        
          

          - **moreInfo** *(dict) --* 

            This represents sections in a tab of the page layout.

            
            

            - **sections** *(list) --* 

              Ordered list containing different kinds of sections that can be added.

              
              

              - *(dict) --* 

                This represents a sections within a panel or tab of the page layout.

                .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``fieldGroup``.     If a client receives an unknown member it will     set ``SDK_UNKNOWN_MEMBER`` as the top level key,     which maps to the name or tag of the unknown     member. The structure of ``SDK_UNKNOWN_MEMBER`` is     as follows::

                                'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}


              
                

                - **fieldGroup** *(dict) --* 

                  Consists of a group of fields and associated properties.

                  
                  

                  - **name** *(string) --* 

                    Name of the field group.

                    
                  

                  - **fields** *(list) --* 

                    Represents an ordered list containing field related information.

                    
                    

                    - *(dict) --* 

                      Object for field related information.

                      
                      

                      - **id** *(string) --* 

                        Unique identifier of a field.

                        
                  
                
              
            
          
        
      
    
      

      - **tags** *(dict) --* 

        A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.

        
        

        - *(string) --* 
          

          - *(string) --* 
    
  
      

      - **deleted** *(boolean) --* 

        Denotes whether or not the resource has been deleted.

        
      

      - **createdTime** *(datetime) --* 

        Timestamp at which the resource was created.

        
      

      - **lastModifiedTime** *(datetime) --* 

        Timestamp at which the resource was created or last modified.

        
  
  **Exceptions**
  
  *   :py:class:`ConnectCases.Client.exceptions.InternalServerException`

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

  
  *   :py:class:`ConnectCases.Client.exceptions.ValidationException`

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

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

  