libZSservicesZSamazonka-apigatewayZSamazonka-apigateway
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.APIGateway.GetRestApis

Description

Lists the RestApis resources for your collection.

This operation returns paginated results.

Synopsis

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

Read GetRestApis Source # 
Instance details

Defined in Amazonka.APIGateway.GetRestApis

Show GetRestApis Source # 
Instance details

Defined in Amazonka.APIGateway.GetRestApis

Generic GetRestApis Source # 
Instance details

Defined in Amazonka.APIGateway.GetRestApis

Associated Types

type Rep GetRestApis :: Type -> Type #

NFData GetRestApis Source # 
Instance details

Defined in Amazonka.APIGateway.GetRestApis

Methods

rnf :: GetRestApis -> () #

Hashable GetRestApis Source # 
Instance details

Defined in Amazonka.APIGateway.GetRestApis

AWSPager GetRestApis Source # 
Instance details

Defined in Amazonka.APIGateway.GetRestApis

AWSRequest GetRestApis Source # 
Instance details

Defined in Amazonka.APIGateway.GetRestApis

Associated Types

type 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

ToQuery GetRestApis Source # 
Instance details

Defined in Amazonka.APIGateway.GetRestApis

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

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

Instances

Instances details
Eq GetRestApisResponse Source # 
Instance details

Defined in Amazonka.APIGateway.GetRestApis

Read GetRestApisResponse Source # 
Instance details

Defined in Amazonka.APIGateway.GetRestApis

Show GetRestApisResponse Source # 
Instance details

Defined in Amazonka.APIGateway.GetRestApis

Generic GetRestApisResponse Source # 
Instance details

Defined in Amazonka.APIGateway.GetRestApis

Associated Types

type Rep GetRestApisResponse :: Type -> Type #

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 #

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.