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.GetModel

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes an existing model defined for a RestApi resource.

Synopsis

data GetModel = GetModel' {
- flatten :: Maybe Bool
- restApiId :: Text
- modelName :: Text
}
newGetModel :: Text -> Text -> GetModel
getModel_flatten :: Lens' GetModel (Maybe Bool)
getModel_restApiId :: Lens' GetModel Text
getModel_modelName :: Lens' GetModel Text
data Model = Model' {
- contentType :: Maybe Text
- description :: Maybe Text
- id :: Maybe Text
- name :: Maybe Text
- schema :: Maybe Text
}
newModel :: Model
model_contentType :: Lens' Model (Maybe Text)
model_description :: Lens' Model (Maybe Text)
model_id :: Lens' Model (Maybe Text)
model_name :: Lens' Model (Maybe Text)
model_schema :: Lens' Model (Maybe Text)

Creating a Request

data GetModel Source #

Request to list information about a model in an existing RestApi resource.

See: newGetModel smart constructor.

Constructors

GetModel'
Fields flatten :: Maybe Bool A query parameter of a Boolean value to resolve (`true`) all external model references and returns a flattened model schema or not (`false`) The default is `false`. restApiId :: Text The RestApi identifier under which the Model exists. modelName :: Text The name of the model as an identifier.

Instances

Instances details

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

newGetModel Source #

Arguments

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

Create a value of GetModel 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:flatten:GetModel', getModel_flatten - A query parameter of a Boolean value to resolve (true) all external model references and returns a flattened model schema or not (false) The default is false.

GetModel, getModel_restApiId - The RestApi identifier under which the Model exists.

$sel:modelName:GetModel', getModel_modelName - The name of the model as an identifier.

Request Lenses

getModel_flatten :: Lens' GetModel (Maybe Bool) Source #

A query parameter of a Boolean value to resolve (true) all external model references and returns a flattened model schema or not (false) The default is false.

getModel_restApiId :: Lens' GetModel Text Source #

The RestApi identifier under which the Model exists.

getModel_modelName :: Lens' GetModel Text Source #

The name of the model as an identifier.

Destructuring the Response

data Model Source #

Represents the data structure of a method's request or response payload.

See: newModel smart constructor.

Constructors

Model'

Fields

contentType :: Maybe Text
The content-type for the model.
description :: Maybe Text
The description of the model.
id :: Maybe Text
The identifier for the model resource.
name :: Maybe Text
The name of the model. Must be an alphanumeric string.
schema :: Maybe Text
The schema for the model. For application/json models, this should be JSON schema draft 4 model. Do not include "\*/" characters in the description of any properties because such "\*/" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.

Instances

Instances details

FromJSON Model Source #
Instance details Defined in Amazonka.APIGateway.Types.Model Methods parseJSON :: Value -> Parser Model # parseJSONList :: Value -> Parser [Model] #
Generic Model Source #
Instance details Defined in Amazonka.APIGateway.Types.Model Associated Types type Rep Model :: Type -> Type # Methods from :: Model -> Rep Model x # to :: Rep Model x -> Model #
Read Model Source #
Instance details Defined in Amazonka.APIGateway.Types.Model Methods readsPrec :: Int -> ReadS Model # readList :: ReadS [Model] # readPrec :: ReadPrec Model # readListPrec :: ReadPrec [Model] #
Show Model Source #
Instance details Defined in Amazonka.APIGateway.Types.Model Methods showsPrec :: Int -> Model -> ShowS # show :: Model -> String # showList :: [Model] -> ShowS #
NFData Model Source #
Instance details Defined in Amazonka.APIGateway.Types.Model Methods rnf :: Model -> () #
Eq Model Source #
Instance details Defined in Amazonka.APIGateway.Types.Model Methods (==) :: Model -> Model -> Bool # (/=) :: Model -> Model -> Bool #
Hashable Model Source #
Instance details Defined in Amazonka.APIGateway.Types.Model Methods hashWithSalt :: Int -> Model -> Int # hash :: Model -> Int #
type Rep Model Source #
Instance details Defined in Amazonka.APIGateway.Types.Model type Rep Model = D1 ('MetaData "Model" "Amazonka.APIGateway.Types.Model" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "Model'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "contentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "schema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newModel :: Model Source #

Create a value of Model 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:contentType:Model', model_contentType - The content-type for the model.

$sel:description:Model', model_description - The description of the model.

$sel:id:Model', model_id - The identifier for the model resource.

$sel:name:Model', model_name - The name of the model. Must be an alphanumeric string.

$sel:schema:Model', model_schema - The schema for the model. For application/json models, this should be JSON schema draft 4 model. Do not include "\*/" characters in the description of any properties because such "\*/" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.

Response Lenses

model_contentType :: Lens' Model (Maybe Text) Source #

The content-type for the model.

model_description :: Lens' Model (Maybe Text) Source #

The description of the model.

model_id :: Lens' Model (Maybe Text) Source #

The identifier for the model resource.

model_name :: Lens' Model (Maybe Text) Source #

The name of the model. Must be an alphanumeric string.

model_schema :: Lens' Model (Maybe Text) Source #

The schema for the model. For application/json models, this should be JSON schema draft 4 model. Do not include "\*/" characters in the description of any properties because such "\*/" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.