Skip to content

get_model_template

Operation

get_model_template

get_model_template(request: GetModelTemplateInput | GetModelTemplateInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetModelTemplateInputDict]) -> GetModelTemplateOutput

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

Parameters:

Name Type Description Default
request GetModelTemplateInput | GetModelTemplateInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[GetModelTemplateInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetModelTemplateOutput

An instance of GetModelTemplateOutput.

get_model_template async

get_model_template(request: GetModelTemplateInput | GetModelTemplateInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetModelTemplateInputDict]) -> GetModelTemplateOutput

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

Parameters:

Name Type Description Default
request GetModelTemplateInput | GetModelTemplateInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[GetModelTemplateInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetModelTemplateOutput

An instance of GetModelTemplateOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

GetModelTemplateInputDict

Bases: TypedDict

Dictionary form of GetModelTemplateInput.

Attributes

model_name instance-attribute
model_name: Required[str]

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

rest_api_id instance-attribute
rest_api_id: Required[str]

The string identifier of the associated RestApi.

GetModelTemplateInput dataclass

Bases: _SerdeShape

Request to generate a sample mapping template used to transform the payload.

Attributes

model_name class-attribute instance-attribute
model_name: str | None = ...

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

rest_api_id class-attribute instance-attribute
rest_api_id: str | None = ...

The string identifier of the associated RestApi.

Output

GetModelTemplateOutput dataclass

Bases: _SerdeShape

Represents a mapping template used to transform a payload.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

value class-attribute instance-attribute
value: str | None = ...

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