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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets a collection of Api resources.

This operation returns paginated results.

Synopsis

data GetApis = GetApis' {
- maxResults :: Maybe Text
- nextToken :: Maybe Text
}
newGetApis :: GetApis
getApis_maxResults :: Lens' GetApis (Maybe Text)
getApis_nextToken :: Lens' GetApis (Maybe Text)
data GetApisResponse = GetApisResponse' {
- items :: Maybe [Api]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newGetApisResponse :: Int -> GetApisResponse
getApisResponse_items :: Lens' GetApisResponse (Maybe [Api])
getApisResponse_nextToken :: Lens' GetApisResponse (Maybe Text)
getApisResponse_httpStatus :: Lens' GetApisResponse Int

Creating a Request

data GetApis Source #

See: newGetApis smart constructor.

Constructors

GetApis'
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.

Instances

Instances details

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

newGetApis :: GetApis Source #

Create a value of GetApis 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:GetApis', getApis_maxResults - The maximum number of elements to be returned for this resource.

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

Request Lenses

getApis_maxResults :: Lens' GetApis (Maybe Text) Source #

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

getApis_nextToken :: Lens' GetApis (Maybe Text) Source #

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

Destructuring the Response

data GetApisResponse Source #

See: newGetApisResponse smart constructor.

Constructors

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

newGetApisResponse Source #

Arguments

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

Create a value of GetApisResponse 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:GetApisResponse', getApisResponse_items - The elements from this collection.

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

$sel:httpStatus:GetApisResponse', getApisResponse_httpStatus - The response's http status code.

Response Lenses

getApisResponse_items :: Lens' GetApisResponse (Maybe [Api]) Source #

The elements from this collection.

getApisResponse_nextToken :: Lens' GetApisResponse (Maybe Text) Source #

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

getApisResponse_httpStatus :: Lens' GetApisResponse Int Source #

The response's http status code.