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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the RestApis resources for your collection.

This operation returns paginated results.

Synopsis

data GetRestApis = GetRestApis' {
- limit :: Maybe Int
- position :: Maybe Text
}
newGetRestApis :: GetRestApis
getRestApis_limit :: Lens' GetRestApis (Maybe Int)
getRestApis_position :: Lens' GetRestApis (Maybe Text)
data GetRestApisResponse = GetRestApisResponse' {
- items :: Maybe [RestApi]
- position :: Maybe Text
- httpStatus :: Int
}
newGetRestApisResponse :: Int -> GetRestApisResponse
getRestApisResponse_items :: Lens' GetRestApisResponse (Maybe [RestApi])
getRestApisResponse_position :: Lens' GetRestApisResponse (Maybe Text)
getRestApisResponse_httpStatus :: Lens' GetRestApisResponse Int

Creating a Request

data GetRestApis Source #

The GET request to list existing RestApis defined for your collection.

See: newGetRestApis smart constructor.

Constructors

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

Instances

Instances details

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

newGetRestApis :: GetRestApis Source #

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

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

Request Lenses

getRestApis_limit :: Lens' GetRestApis (Maybe Int) Source #

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

getRestApis_position :: Lens' GetRestApis (Maybe Text) Source #

The current pagination position in the paged result set.

Destructuring the Response

data GetRestApisResponse Source #

Contains references to your APIs and links that guide you in how to interact with your collection. A collection offers a paginated view of your APIs.

Create an API

See: newGetRestApisResponse smart constructor.

Constructors

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

Instances

Instances details

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

newGetRestApisResponse Source #

Arguments

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

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

$sel:position:GetRestApis', getRestApisResponse_position - Undocumented member.

$sel:httpStatus:GetRestApisResponse', getRestApisResponse_httpStatus - The response's http status code.

Response Lenses

getRestApisResponse_items :: Lens' GetRestApisResponse (Maybe [RestApi]) Source #

The current page of elements from this collection.

getRestApisResponse_position :: Lens' GetRestApisResponse (Maybe Text) Source #

Undocumented member.

getRestApisResponse_httpStatus :: Lens' GetRestApisResponse Int Source #

The response's http status code.