[ aws . apigateway ]

get-model-template

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-model-template
--rest-api-id <value>
--model-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--rest-api-id (string)

The string identifier of the associated RestApi.

--model-name (string)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To get the mapping template for a model defined under a REST API

Command:

aws apigateway get-model-template --rest-api-id 1234123412 --model-name Empty

Output:

{
    "value": "#set($inputRoot = $input.path('$'))\n{ }"
}

Output

value -> (string)

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