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

**************
list_templates
**************



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

  

  Lists all of the templates in a Cases domain. Each list item is a condensed summary object of the template.

   

  Other template APIs are:

   

  
  * `CreateTemplate <https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateTemplate.html>`__
   
  * `DeleteTemplate <https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_DeleteTemplate.html>`__
   
  * `GetTemplate <https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_GetTemplate.html>`__
   
  * `UpdateTemplate <https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_UpdateTemplate.html>`__
  

  

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


  **Request Syntax**
  ::

    response = client.list_templates(
        domainId='string',
        maxResults=123,
        nextToken='string',
        status=[
            'Active'|'Inactive',
        ]
    )
    
  :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.

    

  
  :type status: list
  :param status: 

    A list of status values to filter on.

    

  
    - *(string) --* 

    

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

    
    ::

      {
          'templates': [
              {
                  'templateId': 'string',
                  'templateArn': 'string',
                  'name': 'string',
                  'status': 'Active'|'Inactive',
                  'tagPropagationConfigurations': [
                      {
                          'resourceType': 'Cases',
                          'tagMap': {
                              'string': 'string'
                          }
                      },
                  ]
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **templates** *(list) --* 

        List of template summary objects.

        
        

        - *(dict) --* 

          Template summary information.

          
          

          - **templateId** *(string) --* 

            The unique identifier for the template.

            
          

          - **templateArn** *(string) --* 

            The Amazon Resource Name (ARN) of the template.

            
          

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

            The template name.

            
          

          - **status** *(string) --* 

            The status of the template.

            
          

          - **tagPropagationConfigurations** *(list) --* 

            Defines tag propagation configuration for resources created within a domain. Tags specified here will be automatically applied to resources being created for the specified resource type.

            
            

            - *(dict) --* 

              Defines tag propagation configuration for resources created within a domain. Tags specified here will be automatically applied to resources being created for the specified resource type.

              
              

              - **resourceType** *(string) --* 

                Supported resource types for tag propagation. Determines which resources will receive automatically propagated tags.

                
              

              - **tagMap** *(dict) --* 

                The tags that will be applied to the created resource.

                
                

                - *(string) --* 
                  

                  - *(string) --* 
            
          
          
        
      
    
      

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

  