APIGateway / Client / get_model_template

get_model_template

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

Request Syntax

response = client.get_model_template(
    restApiId='string',
    modelName='string'
)
Parameters:

  • restApiId (string) –

    [REQUIRED]

    The string identifier of the associated RestApi.

  • modelName (string) –

    [REQUIRED]

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

Return type:

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