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

************
get_template
************



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

  

  Returns the details for the requested 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>`__
   
  * `ListTemplates <https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_ListTemplates.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/GetTemplate>`_  


  **Request Syntax**
  ::

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

    The unique identifier of the Cases domain.

    

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

    A unique identifier of a template.

    

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

    
    ::

      {
          'templateId': 'string',
          'templateArn': 'string',
          'name': 'string',
          'description': 'string',
          'layoutConfiguration': {
              'defaultLayout': 'string'
          },
          'requiredFields': [
              {
                  'fieldId': 'string'
              },
          ],
          'tags': {
              'string': 'string'
          },
          'status': 'Active'|'Inactive',
          'deleted': True|False,
          'createdTime': datetime(2015, 1, 1),
          'lastModifiedTime': datetime(2015, 1, 1),
          'rules': [
              {
                  'caseRuleId': 'string',
                  'fieldId': 'string'
              },
          ],
          'tagPropagationConfigurations': [
              {
                  'resourceType': 'Cases',
                  'tagMap': {
                      'string': 'string'
                  }
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        A unique identifier of a template.

        
      

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

        The Amazon Resource Name (ARN) of the template.

        
      

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

        The name of the template.

        
      

      - **description** *(string) --* 

        A brief description of the template.

        
      

      - **layoutConfiguration** *(dict) --* 

        Configuration of layouts associated to the template.

        
        

        - **defaultLayout** *(string) --* 

          Unique identifier of a layout.

          
    
      

      - **requiredFields** *(list) --* 

        A list of fields that must contain a value for a case to be successfully created with this template.

        
        

        - *(dict) --* 

          List of fields that must have a value provided to create a case.

          
          

          - **fieldId** *(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) --* 
    
  
      

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

        The status of the template.

        
      

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

        
      

      - **rules** *(list) --* 

        A list of case rules (also known as `case field conditions <https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html>`__) on a template.

        
        

        - *(dict) --* 

          An association representing a case rule acting upon a field. In the Amazon Connect admin website, case rules are known as *case field conditions*. For more information about case field conditions, see `Add case field conditions to a case template <https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html>`__.

          
          

          - **caseRuleId** *(string) --* 

            Unique identifier of a case rule.

            
          

          - **fieldId** *(string) --* 

            Unique identifier of a field.

            
      
    
      

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

  