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.ApiGatewayV2.GetModels

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets the Models for an API.

This operation returns paginated results.

Synopsis

data GetModels = GetModels' {
- maxResults :: Maybe Text
- nextToken :: Maybe Text
- apiId :: Text
}
newGetModels :: Text -> GetModels
getModels_maxResults :: Lens' GetModels (Maybe Text)
getModels_nextToken :: Lens' GetModels (Maybe Text)
getModels_apiId :: Lens' GetModels Text
data GetModelsResponse = GetModelsResponse' {
- items :: Maybe [Model]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newGetModelsResponse :: Int -> GetModelsResponse
getModelsResponse_items :: Lens' GetModelsResponse (Maybe [Model])
getModelsResponse_nextToken :: Lens' GetModelsResponse (Maybe Text)
getModelsResponse_httpStatus :: Lens' GetModelsResponse Int

Creating a Request

data GetModels Source #

See: newGetModels smart constructor.

Constructors

GetModels'
Fields maxResults :: Maybe Text The maximum number of elements to be returned for this resource. nextToken :: Maybe Text The next page of elements from this collection. Not valid for the last element of the collection. apiId :: Text The API identifier.

Instances

Instances details

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

newGetModels Source #

Arguments

:: Text	`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:maxResults:GetModels', getModels_maxResults - The maximum number of elements to be returned for this resource.

GetModels, getModels_nextToken - The next page of elements from this collection. Not valid for the last element of the collection.

GetModels, getModels_apiId - The API identifier.

Request Lenses

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

The maximum number of elements to be returned for this resource.

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

The next page of elements from this collection. Not valid for the last element of the collection.

getModels_apiId :: Lens' GetModels Text Source #

The API identifier.

Destructuring the Response

data GetModelsResponse Source #

See: newGetModelsResponse smart constructor.

Constructors

GetModelsResponse'
Fields items :: Maybe [Model] The elements from this collection. nextToken :: Maybe Text The next page of elements from this collection. Not valid for the last element of the collection. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic GetModelsResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.GetModels Associated Types type Rep GetModelsResponse :: Type -> Type # Methods from :: GetModelsResponse -> Rep GetModelsResponse x # to :: Rep GetModelsResponse x -> GetModelsResponse #
Read GetModelsResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.GetModels Methods readsPrec :: Int -> ReadS GetModelsResponse # readList :: ReadS [GetModelsResponse] # readPrec :: ReadPrec GetModelsResponse # readListPrec :: ReadPrec [GetModelsResponse] #
Show GetModelsResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.GetModels Methods showsPrec :: Int -> GetModelsResponse -> ShowS # show :: GetModelsResponse -> String # showList :: [GetModelsResponse] -> ShowS #
NFData GetModelsResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.GetModels Methods rnf :: GetModelsResponse -> () #
Eq GetModelsResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.GetModels Methods (==) :: GetModelsResponse -> GetModelsResponse -> Bool # (/=) :: GetModelsResponse -> GetModelsResponse -> Bool #
type Rep GetModelsResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.GetModels type Rep GetModelsResponse = D1 ('MetaData "GetModelsResponse" "Amazonka.ApiGatewayV2.GetModels" "amazonka-apigatewayv2-2.0-4MZ8oueToeLOWomgegceF" 'False) (C1 ('MetaCons "GetModelsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "items") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Model])) :: (S1 ('MetaSel ('Just "nextToken") '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 elements from this collection.

GetModels, getModelsResponse_nextToken - The next page of elements from this collection. Not valid for the last element of the collection.

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

Response Lenses

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

The elements from this collection.

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

The next page of elements from this collection. Not valid for the last element of the collection.

getModelsResponse_httpStatus :: Lens' GetModelsResponse Int Source #

The response's http status code.