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

*************
create_layout
*************



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

  

  Creates a layout in the Cases domain. Layouts define the following configuration in the top section and More Info tab of the Cases user interface:

   

  
  * Fields to display to the users
   
  * Field ordering
  

   

  .. note::

    

    Title and Status fields cannot be part of layouts since they are not configurable.

    

  

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


  **Request Syntax**
  ::

    response = client.create_layout(
        domainId='string',
        name='string',
        content={
            'basic': {
                'topPanel': {
                    'sections': [
                        {
                            'fieldGroup': {
                                'name': 'string',
                                'fields': [
                                    {
                                        'id': 'string'
                                    },
                                ]
                            }
                        },
                    ]
                },
                'moreInfo': {
                    'sections': [
                        {
                            'fieldGroup': {
                                'name': 'string',
                                'fields': [
                                    {
                                        'id': 'string'
                                    },
                                ]
                            }
                        },
                    ]
                }
            }
        }
    )
    
  :type domainId: string
  :param domainId: **[REQUIRED]** 

    The unique identifier of the Cases domain.

    

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

    The name of the layout. It must be unique for the Cases domain.

    

  
  :type content: dict
  :param content: **[REQUIRED]** 

    Information about which fields will be present in the layout, and information about the order of the fields.

    .. note::    This is a Tagged Union structure. Only one of the     following top level keys can be set: ``basic``. 

  
    - **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 can be set: ``fieldGroup``. 

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

              Consists of a group of fields and associated properties.

              

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

                Name of the field group.

                

              
              - **fields** *(list) --* **[REQUIRED]** 

                Represents an ordered list containing field related information.

                

              
                - *(dict) --* 

                  Object for field related information.

                  

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

                    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 can be set: ``fieldGroup``. 

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

              Consists of a group of fields and associated properties.

              

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

                Name of the field group.

                

              
              - **fields** *(list) --* **[REQUIRED]** 

                Represents an ordered list containing field related information.

                

              
                - *(dict) --* 

                  Object for field related information.

                  

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

                    Unique identifier of a field.

                    

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

    
    ::

      {
          'layoutId': 'string',
          'layoutArn': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        The unique identifier of the layout.

        
      

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

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

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

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

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

  