:doc:`APIGateway <../../apigateway>` / Client / get_model_template

******************
get_model_template
******************



.. py:method:: APIGateway.Client.get_model_template(**kwargs)

  

  Generates a sample mapping template that can be used to transform a payload into the structure of a model.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/apigateway-2015-07-09/GetModelTemplate>`_  


  **Request Syntax**
  ::

    response = client.get_model_template(
        restApiId='string',
        modelName='string'
    )
    
  :type restApiId: string
  :param restApiId: **[REQUIRED]** 

    The string identifier of the associated RestApi.

    

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

    The name of the model for which to generate a template.

    

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

    
    ::

      {
          'value': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 

      Represents a mapping template used to transform a payload.

      
      

      - **value** *(string) --* 

        The Apache Velocity Template Language (VTL) template content used for the template resource.

        
  
  **Exceptions**
  
  *   :py:class:`APIGateway.Client.exceptions.UnauthorizedException`

  
  *   :py:class:`APIGateway.Client.exceptions.NotFoundException`

  
  *   :py:class:`APIGateway.Client.exceptions.BadRequestException`

  
  *   :py:class:`APIGateway.Client.exceptions.TooManyRequestsException`

  