Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.APIGateway.GetModelTemplate

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

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 The string identifier of the associated RestApi. modelName :: Text The name of the model for which to generate a template.

Instances

Instances details

ToHeaders GetModelTemplate Source #
Instance details Defined in Amazonka.APIGateway.GetModelTemplate Methods toHeaders :: GetModelTemplate -> [Header] #
ToPath GetModelTemplate Source #
Instance details Defined in Amazonka.APIGateway.GetModelTemplate Methods toPath :: GetModelTemplate -> ByteString #
ToQuery GetModelTemplate Source #
Instance details Defined in Amazonka.APIGateway.GetModelTemplate Methods toQuery :: GetModelTemplate -> QueryString #
AWSRequest GetModelTemplate Source #
Instance details Defined in Amazonka.APIGateway.GetModelTemplate Associated Types type AWSResponse GetModelTemplate # Methods request :: (Service -> Service) -> GetModelTemplate -> Request GetModelTemplate # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetModelTemplate -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetModelTemplate))) #
Generic GetModelTemplate Source #
Instance details Defined in Amazonka.APIGateway.GetModelTemplate Associated Types type Rep GetModelTemplate :: Type -> Type # Methods from :: GetModelTemplate -> Rep GetModelTemplate x # to :: Rep GetModelTemplate x -> GetModelTemplate #
Read GetModelTemplate Source #
Instance details Defined in Amazonka.APIGateway.GetModelTemplate Methods readsPrec :: Int -> ReadS GetModelTemplate # readList :: ReadS [GetModelTemplate] # readPrec :: ReadPrec GetModelTemplate # readListPrec :: ReadPrec [GetModelTemplate] #
Show GetModelTemplate Source #
Instance details Defined in Amazonka.APIGateway.GetModelTemplate Methods showsPrec :: Int -> GetModelTemplate -> ShowS # show :: GetModelTemplate -> String # showList :: [GetModelTemplate] -> ShowS #
NFData GetModelTemplate Source #
Instance details Defined in Amazonka.APIGateway.GetModelTemplate Methods rnf :: GetModelTemplate -> () #
Eq GetModelTemplate Source #
Instance details Defined in Amazonka.APIGateway.GetModelTemplate Methods (==) :: GetModelTemplate -> GetModelTemplate -> Bool # (/=) :: GetModelTemplate -> GetModelTemplate -> Bool #
Hashable GetModelTemplate Source #
Instance details Defined in Amazonka.APIGateway.GetModelTemplate Methods hashWithSalt :: Int -> GetModelTemplate -> Int # hash :: GetModelTemplate -> Int #
type AWSResponse GetModelTemplate Source #
Instance details Defined in Amazonka.APIGateway.GetModelTemplate type AWSResponse GetModelTemplate = GetModelTemplateResponse
type Rep GetModelTemplate Source #
Instance details Defined in Amazonka.APIGateway.GetModelTemplate type Rep GetModelTemplate = D1 ('MetaData "GetModelTemplate" "Amazonka.APIGateway.GetModelTemplate" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetModelTemplate'" 'PrefixI 'True) (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "modelName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetModelTemplate Source #

Arguments

:: Text	`GetModelTemplate`
-> Text	`$sel:modelName:GetModelTemplate'`
-> GetModelTemplate

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:

GetModelTemplate, getModelTemplate_restApiId - The string identifier of the associated RestApi.

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

Request Lenses

getModelTemplate_restApiId :: Lens' GetModelTemplate Text Source #

The string identifier of the associated RestApi.

getModelTemplate_modelName :: Lens' GetModelTemplate Text Source #

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.

See: newGetModelTemplateResponse smart constructor.

Constructors

GetModelTemplateResponse'
Fields value :: Maybe Text The Apache Velocity Template Language (VTL) template content used for the template resource. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic GetModelTemplateResponse Source #
Instance details Defined in Amazonka.APIGateway.GetModelTemplate Associated Types type Rep GetModelTemplateResponse :: Type -> Type # Methods from :: GetModelTemplateResponse -> Rep GetModelTemplateResponse x # to :: Rep GetModelTemplateResponse x -> GetModelTemplateResponse #
Read GetModelTemplateResponse Source #
Instance details Defined in Amazonka.APIGateway.GetModelTemplate Methods readsPrec :: Int -> ReadS GetModelTemplateResponse # readList :: ReadS [GetModelTemplateResponse] # readPrec :: ReadPrec GetModelTemplateResponse # readListPrec :: ReadPrec [GetModelTemplateResponse] #
Show GetModelTemplateResponse Source #
Instance details Defined in Amazonka.APIGateway.GetModelTemplate Methods showsPrec :: Int -> GetModelTemplateResponse -> ShowS # show :: GetModelTemplateResponse -> String # showList :: [GetModelTemplateResponse] -> ShowS #
NFData GetModelTemplateResponse Source #
Instance details Defined in Amazonka.APIGateway.GetModelTemplate Methods rnf :: GetModelTemplateResponse -> () #
Eq GetModelTemplateResponse Source #
Instance details Defined in Amazonka.APIGateway.GetModelTemplate Methods (==) :: GetModelTemplateResponse -> GetModelTemplateResponse -> Bool # (/=) :: GetModelTemplateResponse -> GetModelTemplateResponse -> Bool #
type Rep GetModelTemplateResponse Source #
Instance details Defined in Amazonka.APIGateway.GetModelTemplate type Rep GetModelTemplateResponse = D1 ('MetaData "GetModelTemplateResponse" "Amazonka.APIGateway.GetModelTemplate" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" '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 #

Arguments

:: Int	`$sel:httpStatus:GetModelTemplateResponse'`
-> GetModelTemplateResponse

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:

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

getModelTemplateResponse_value :: Lens' GetModelTemplateResponse (Maybe Text) Source #

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

getModelTemplateResponse_httpStatus :: Lens' GetModelTemplateResponse Int Source #

The response's http status code.