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

Description

Represents a collection of BasePathMapping resources.

This operation returns paginated results.

Synopsis

Creating a Request

data GetBasePathMappings Source #

A request to get information about a collection of BasePathMapping resources.

See: newGetBasePathMappings smart constructor.

Constructors

GetBasePathMappings' 

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.

  • domainName :: Text
    Required
    The domain name of a BasePathMapping resource.

Instances

Instances details
Eq GetBasePathMappings Source # 
Instance details

Defined in Amazonka.APIGateway.GetBasePathMappings

Read GetBasePathMappings Source # 
Instance details

Defined in Amazonka.APIGateway.GetBasePathMappings

Show GetBasePathMappings Source # 
Instance details

Defined in Amazonka.APIGateway.GetBasePathMappings

Generic GetBasePathMappings Source # 
Instance details

Defined in Amazonka.APIGateway.GetBasePathMappings

Associated Types

type Rep GetBasePathMappings :: Type -> Type #

NFData GetBasePathMappings Source # 
Instance details

Defined in Amazonka.APIGateway.GetBasePathMappings

Methods

rnf :: GetBasePathMappings -> () #

Hashable GetBasePathMappings Source # 
Instance details

Defined in Amazonka.APIGateway.GetBasePathMappings

AWSPager GetBasePathMappings Source # 
Instance details

Defined in Amazonka.APIGateway.GetBasePathMappings

AWSRequest GetBasePathMappings Source # 
Instance details

Defined in Amazonka.APIGateway.GetBasePathMappings

Associated Types

type AWSResponse GetBasePathMappings #

ToHeaders GetBasePathMappings Source # 
Instance details

Defined in Amazonka.APIGateway.GetBasePathMappings

ToPath GetBasePathMappings Source # 
Instance details

Defined in Amazonka.APIGateway.GetBasePathMappings

ToQuery GetBasePathMappings Source # 
Instance details

Defined in Amazonka.APIGateway.GetBasePathMappings

type Rep GetBasePathMappings Source # 
Instance details

Defined in Amazonka.APIGateway.GetBasePathMappings

type Rep GetBasePathMappings = D1 ('MetaData "GetBasePathMappings" "Amazonka.APIGateway.GetBasePathMappings" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "GetBasePathMappings'" '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 "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse GetBasePathMappings Source # 
Instance details

Defined in Amazonka.APIGateway.GetBasePathMappings

newGetBasePathMappings Source #

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

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

$sel:domainName:GetBasePathMappings', getBasePathMappings_domainName - [Required] The domain name of a BasePathMapping resource.

Request Lenses

getBasePathMappings_limit :: Lens' GetBasePathMappings (Maybe Int) Source #

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

getBasePathMappings_position :: Lens' GetBasePathMappings (Maybe Text) Source #

The current pagination position in the paged result set.

getBasePathMappings_domainName :: Lens' GetBasePathMappings Text Source #

Required
The domain name of a BasePathMapping resource.

Destructuring the Response

data GetBasePathMappingsResponse Source #

Represents a collection of BasePathMapping resources.

Use Custom Domain Names

See: newGetBasePathMappingsResponse smart constructor.

Constructors

GetBasePathMappingsResponse' 

Fields

Instances

Instances details
Eq GetBasePathMappingsResponse Source # 
Instance details

Defined in Amazonka.APIGateway.GetBasePathMappings

Read GetBasePathMappingsResponse Source # 
Instance details

Defined in Amazonka.APIGateway.GetBasePathMappings

Show GetBasePathMappingsResponse Source # 
Instance details

Defined in Amazonka.APIGateway.GetBasePathMappings

Generic GetBasePathMappingsResponse Source # 
Instance details

Defined in Amazonka.APIGateway.GetBasePathMappings

Associated Types

type Rep GetBasePathMappingsResponse :: Type -> Type #

NFData GetBasePathMappingsResponse Source # 
Instance details

Defined in Amazonka.APIGateway.GetBasePathMappings

type Rep GetBasePathMappingsResponse Source # 
Instance details

Defined in Amazonka.APIGateway.GetBasePathMappings

type Rep GetBasePathMappingsResponse = D1 ('MetaData "GetBasePathMappingsResponse" "Amazonka.APIGateway.GetBasePathMappings" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "GetBasePathMappingsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "items") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [BasePathMapping])) :*: (S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetBasePathMappingsResponse Source #

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

$sel:position:GetBasePathMappings', getBasePathMappingsResponse_position - Undocumented member.

$sel:httpStatus:GetBasePathMappingsResponse', getBasePathMappingsResponse_httpStatus - The response's http status code.

Response Lenses

getBasePathMappingsResponse_items :: Lens' GetBasePathMappingsResponse (Maybe [BasePathMapping]) Source #

The current page of elements from this collection.