libZSservicesZSamazonka-apigatewayZSamazonka-apigateway
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.APIGateway.GetModelTemplate

Description

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

Synopsis

Creating a Request

data GetModelTemplate Source #

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

See: newGetModelTemplate smart constructor.

Constructors

GetModelTemplate' 

Fields

  • restApiId :: Text
    Required
    The string identifier of the associated RestApi.
  • modelName :: Text
    Required
    The name of the model for which to generate a template.

Instances

Instances details
Eq GetModelTemplate Source # 
Instance details

Defined in Amazonka.APIGateway.GetModelTemplate

Read GetModelTemplate Source # 
Instance details

Defined in Amazonka.APIGateway.GetModelTemplate

Show GetModelTemplate Source # 
Instance details

Defined in Amazonka.APIGateway.GetModelTemplate

Generic GetModelTemplate Source # 
Instance details

Defined in Amazonka.APIGateway.GetModelTemplate

Associated Types

type Rep GetModelTemplate :: Type -> Type #

NFData GetModelTemplate Source # 
Instance details

Defined in Amazonka.APIGateway.GetModelTemplate

Methods

rnf :: GetModelTemplate -> () #

Hashable GetModelTemplate Source # 
Instance details

Defined in Amazonka.APIGateway.GetModelTemplate

AWSRequest GetModelTemplate Source # 
Instance details

Defined in Amazonka.APIGateway.GetModelTemplate

Associated Types

type AWSResponse GetModelTemplate #

ToHeaders GetModelTemplate Source # 
Instance details

Defined in Amazonka.APIGateway.GetModelTemplate

ToPath GetModelTemplate Source # 
Instance details

Defined in Amazonka.APIGateway.GetModelTemplate

ToQuery GetModelTemplate Source # 
Instance details

Defined in Amazonka.APIGateway.GetModelTemplate

type Rep GetModelTemplate Source # 
Instance details

Defined in Amazonka.APIGateway.GetModelTemplate

type Rep GetModelTemplate = D1 ('MetaData "GetModelTemplate" "Amazonka.APIGateway.GetModelTemplate" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "GetModelTemplate'" 'PrefixI 'True) (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "modelName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse GetModelTemplate Source # 
Instance details

Defined in Amazonka.APIGateway.GetModelTemplate

newGetModelTemplate Source #

Create a value of GetModelTemplate with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:restApiId:GetModelTemplate', getModelTemplate_restApiId - [Required] The string identifier of the associated RestApi.

$sel:modelName:GetModelTemplate', getModelTemplate_modelName - [Required] The name of the model for which to generate a template.

Request Lenses

getModelTemplate_restApiId :: Lens' GetModelTemplate Text Source #

Required
The string identifier of the associated RestApi.

getModelTemplate_modelName :: Lens' GetModelTemplate Text Source #

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

Destructuring the Response

data GetModelTemplateResponse Source #

Represents a mapping template used to transform a payload.

Mapping Templates

See: newGetModelTemplateResponse smart constructor.

Constructors

GetModelTemplateResponse' 

Fields

Instances

Instances details
Eq GetModelTemplateResponse Source # 
Instance details

Defined in Amazonka.APIGateway.GetModelTemplate

Read GetModelTemplateResponse Source # 
Instance details

Defined in Amazonka.APIGateway.GetModelTemplate

Show GetModelTemplateResponse Source # 
Instance details

Defined in Amazonka.APIGateway.GetModelTemplate

Generic GetModelTemplateResponse Source # 
Instance details

Defined in Amazonka.APIGateway.GetModelTemplate

Associated Types

type Rep GetModelTemplateResponse :: Type -> Type #

NFData GetModelTemplateResponse Source # 
Instance details

Defined in Amazonka.APIGateway.GetModelTemplate

type Rep GetModelTemplateResponse Source # 
Instance details

Defined in Amazonka.APIGateway.GetModelTemplate

type Rep GetModelTemplateResponse = D1 ('MetaData "GetModelTemplateResponse" "Amazonka.APIGateway.GetModelTemplate" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "GetModelTemplateResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetModelTemplateResponse Source #

Create a value of GetModelTemplateResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:value:GetModelTemplateResponse', getModelTemplateResponse_value - The Apache Velocity Template Language (VTL) template content used for the template resource.

$sel:httpStatus:GetModelTemplateResponse', getModelTemplateResponse_httpStatus - The response's http status code.

Response Lenses