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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Represents a collection of BasePathMapping resources.

This operation returns paginated results.

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 The domain name of a BasePathMapping resource.

Instances

Instances details

ToHeaders GetBasePathMappings Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMappings Methods toHeaders :: GetBasePathMappings -> [Header] #
ToPath GetBasePathMappings Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMappings Methods toPath :: GetBasePathMappings -> ByteString #
ToQuery GetBasePathMappings Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMappings Methods toQuery :: GetBasePathMappings -> QueryString #
AWSPager GetBasePathMappings Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMappings Methods page :: GetBasePathMappings -> AWSResponse GetBasePathMappings -> Maybe GetBasePathMappings #
AWSRequest GetBasePathMappings Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMappings Associated Types type AWSResponse GetBasePathMappings # Methods request :: (Service -> Service) -> GetBasePathMappings -> Request GetBasePathMappings # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetBasePathMappings -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetBasePathMappings))) #
Generic GetBasePathMappings Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMappings Associated Types type Rep GetBasePathMappings :: Type -> Type # Methods from :: GetBasePathMappings -> Rep GetBasePathMappings x # to :: Rep GetBasePathMappings x -> GetBasePathMappings #
Read GetBasePathMappings Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMappings Methods readsPrec :: Int -> ReadS GetBasePathMappings # readList :: ReadS [GetBasePathMappings] # readPrec :: ReadPrec GetBasePathMappings # readListPrec :: ReadPrec [GetBasePathMappings] #
Show GetBasePathMappings Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMappings Methods showsPrec :: Int -> GetBasePathMappings -> ShowS # show :: GetBasePathMappings -> String # showList :: [GetBasePathMappings] -> ShowS #
NFData GetBasePathMappings Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMappings Methods rnf :: GetBasePathMappings -> () #
Eq GetBasePathMappings Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMappings Methods (==) :: GetBasePathMappings -> GetBasePathMappings -> Bool # (/=) :: GetBasePathMappings -> GetBasePathMappings -> Bool #
Hashable GetBasePathMappings Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMappings Methods hashWithSalt :: Int -> GetBasePathMappings -> Int # hash :: GetBasePathMappings -> Int #
type AWSResponse GetBasePathMappings Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMappings type AWSResponse GetBasePathMappings = GetBasePathMappingsResponse
type Rep GetBasePathMappings Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMappings type Rep GetBasePathMappings = D1 ('MetaData "GetBasePathMappings" "Amazonka.APIGateway.GetBasePathMappings" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" '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))))

newGetBasePathMappings Source #

Arguments

:: Text	`GetBasePathMappings`
-> GetBasePathMappings

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:

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

GetBasePathMappings, getBasePathMappings_position - The current pagination position in the paged result set.

GetBasePathMappings, getBasePathMappings_domainName - 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 #

The domain name of a BasePathMapping resource.

Destructuring the Response

data GetBasePathMappingsResponse Source #

Represents a collection of BasePathMapping resources.

See: newGetBasePathMappingsResponse smart constructor.

Constructors

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

Instances

Instances details

Generic GetBasePathMappingsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMappings Associated Types type Rep GetBasePathMappingsResponse :: Type -> Type # Methods from :: GetBasePathMappingsResponse -> Rep GetBasePathMappingsResponse x # to :: Rep GetBasePathMappingsResponse x -> GetBasePathMappingsResponse #
Read GetBasePathMappingsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMappings Methods readsPrec :: Int -> ReadS GetBasePathMappingsResponse # readList :: ReadS [GetBasePathMappingsResponse] # readPrec :: ReadPrec GetBasePathMappingsResponse # readListPrec :: ReadPrec [GetBasePathMappingsResponse] #
Show GetBasePathMappingsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMappings Methods showsPrec :: Int -> GetBasePathMappingsResponse -> ShowS # show :: GetBasePathMappingsResponse -> String # showList :: [GetBasePathMappingsResponse] -> ShowS #
NFData GetBasePathMappingsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMappings Methods rnf :: GetBasePathMappingsResponse -> () #
Eq GetBasePathMappingsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMappings Methods (==) :: GetBasePathMappingsResponse -> GetBasePathMappingsResponse -> Bool # (/=) :: GetBasePathMappingsResponse -> GetBasePathMappingsResponse -> Bool #
type Rep GetBasePathMappingsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMappings type Rep GetBasePathMappingsResponse = D1 ('MetaData "GetBasePathMappingsResponse" "Amazonka.APIGateway.GetBasePathMappings" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" '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 #

Arguments

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

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:

GetBasePathMappingsResponse, getBasePathMappingsResponse_items - The current page of elements from this collection.

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.

getBasePathMappingsResponse_position :: Lens' GetBasePathMappingsResponse (Maybe Text) Source #

Undocumented member.

getBasePathMappingsResponse_httpStatus :: Lens' GetBasePathMappingsResponse Int Source #

The response's http status code.