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

************
list_layouts
************



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

  

  Lists all layouts in the given cases domain. Each list item is a condensed summary object of the layout.

  

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


  **Request Syntax**
  ::

    response = client.list_layouts(
        domainId='string',
        maxResults=123,
        nextToken='string'
    )
    
  :type domainId: string
  :param domainId: **[REQUIRED]** 

    The unique identifier of the Cases domain.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of results to return per page.

    

  
  :type nextToken: string
  :param nextToken: 

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    

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

    
    ::

      {
          'layouts': [
              {
                  'layoutId': 'string',
                  'layoutArn': 'string',
                  'name': 'string'
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **layouts** *(list) --* 

        The layouts for the domain.

        
        

        - *(dict) --* 

          Object for the summarized details of the layout.

          
          

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

            The unique identifier for of the layout.

            
          

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

            The Amazon Resource Name (ARN) of the layout.

            
          

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

            The name of the layout.

            
      
    
      

      - **nextToken** *(string) --* 

        The token for the next set of results. This is null if there are no more results to return.

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

  