Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.APIGateway.GetModels

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes existing Models defined for a RestApi resource.

This operation returns paginated results.

Synopsis

data GetModels = GetModels' {
- limit :: Maybe Int
- position :: Maybe Text
- restApiId :: Text
}
newGetModels :: Text -> GetModels
getModels_limit :: Lens' GetModels (Maybe Int)
getModels_position :: Lens' GetModels (Maybe Text)
getModels_restApiId :: Lens' GetModels Text
data GetModelsResponse = GetModelsResponse' {
- items :: Maybe [Model]
- position :: Maybe Text
- httpStatus :: Int
}
newGetModelsResponse :: Int -> GetModelsResponse
getModelsResponse_items :: Lens' GetModelsResponse (Maybe [Model])
getModelsResponse_position :: Lens' GetModelsResponse (Maybe Text)
getModelsResponse_httpStatus :: Lens' GetModelsResponse Int

Creating a Request

data GetModels Source #

Request to list existing Models defined for a RestApi resource.

See: newGetModels smart constructor.

Constructors

GetModels'
Fields limit :: Maybe Int The maximum number of returned results per page. The default value is 25 and the maximum value is 500. position :: Maybe Text The current pagination position in the paged result set. restApiId :: Text Required The string identifier of the associated RestApi.

Instances

Instances details

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

newGetModels Source #

Arguments

:: Text	`$sel:restApiId:GetModels'`
-> GetModels

Create a value of GetModels 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:limit:GetModels', getModels_limit - The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

$sel:position:GetModels', getModels_position - The current pagination position in the paged result set.

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

Request Lenses

getModels_limit :: Lens' GetModels (Maybe Int) Source #

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

getModels_position :: Lens' GetModels (Maybe Text) Source #

The current pagination position in the paged result set.

getModels_restApiId :: Lens' GetModels Text Source #

Required: The string identifier of the associated RestApi.

Destructuring the Response

data GetModelsResponse Source #

Represents a collection of Model resources.

Method, MethodResponse, Models and Mappings

See: newGetModelsResponse smart constructor.

Constructors

GetModelsResponse'
Fields items :: Maybe [Model] The current page of elements from this collection. position :: Maybe Text httpStatus :: Int The response's http status code.

Instances

Instances details

Eq GetModelsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetModels Methods (==) :: GetModelsResponse -> GetModelsResponse -> Bool # (/=) :: GetModelsResponse -> GetModelsResponse -> Bool #
Read GetModelsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetModels Methods readsPrec :: Int -> ReadS GetModelsResponse # readList :: ReadS [GetModelsResponse] # readPrec :: ReadPrec GetModelsResponse # readListPrec :: ReadPrec [GetModelsResponse] #
Show GetModelsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetModels Methods showsPrec :: Int -> GetModelsResponse -> ShowS # show :: GetModelsResponse -> String # showList :: [GetModelsResponse] -> ShowS #
Generic GetModelsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetModels Associated Types type Rep GetModelsResponse :: Type -> Type # Methods from :: GetModelsResponse -> Rep GetModelsResponse x # to :: Rep GetModelsResponse x -> GetModelsResponse #
NFData GetModelsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetModels Methods rnf :: GetModelsResponse -> () #
type Rep GetModelsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetModels type Rep GetModelsResponse = D1 ('MetaData "GetModelsResponse" "Amazonka.APIGateway.GetModels" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "GetModelsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "items") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Model])) :: (S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetModelsResponse Source #

Arguments

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

Create a value of GetModelsResponse 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:items:GetModelsResponse', getModelsResponse_items - The current page of elements from this collection.

$sel:position:GetModels', getModelsResponse_position - Undocumented member.

$sel:httpStatus:GetModelsResponse', getModelsResponse_httpStatus - The response's http status code.

Response Lenses

getModelsResponse_items :: Lens' GetModelsResponse (Maybe [Model]) Source #

The current page of elements from this collection.

getModelsResponse_position :: Lens' GetModelsResponse (Maybe Text) Source #

Undocumented member.

getModelsResponse_httpStatus :: Lens' GetModelsResponse Int Source #

The response's http status code.