amazonka-apigateway-1.4.5: Amazon API Gateway SDK.

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

Network.AWS.APIGateway.GetBasePathMapping

Contents

Description

Describe a BasePathMapping resource.

Synopsis

Creating a Request

getBasePathMapping #

Creates a value of GetBasePathMapping with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • gbpmDomainName - The domain name of the BasePathMapping resource to be described.
  • gbpmBasePath - The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Leave this blank if you do not want callers to specify any base path name after the domain name.

data GetBasePathMapping #

Request to describe a BasePathMapping resource.

See: getBasePathMapping smart constructor.

Instances

Eq GetBasePathMapping # 
Data GetBasePathMapping # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetBasePathMapping -> c GetBasePathMapping #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetBasePathMapping #

toConstr :: GetBasePathMapping -> Constr #

dataTypeOf :: GetBasePathMapping -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GetBasePathMapping) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetBasePathMapping) #

gmapT :: (forall b. Data b => b -> b) -> GetBasePathMapping -> GetBasePathMapping #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetBasePathMapping -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetBasePathMapping -> r #

gmapQ :: (forall d. Data d => d -> u) -> GetBasePathMapping -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetBasePathMapping -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetBasePathMapping -> m GetBasePathMapping #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetBasePathMapping -> m GetBasePathMapping #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetBasePathMapping -> m GetBasePathMapping #

Read GetBasePathMapping # 
Show GetBasePathMapping # 
Generic GetBasePathMapping # 
Hashable GetBasePathMapping # 
NFData GetBasePathMapping # 

Methods

rnf :: GetBasePathMapping -> () #

AWSRequest GetBasePathMapping # 
ToQuery GetBasePathMapping # 
ToPath GetBasePathMapping # 
ToHeaders GetBasePathMapping # 
type Rep GetBasePathMapping # 
type Rep GetBasePathMapping = D1 (MetaData "GetBasePathMapping" "Network.AWS.APIGateway.GetBasePathMapping" "amazonka-apigateway-1.4.5-5OCToOwmZjEH3FMiU9Yogu" False) (C1 (MetaCons "GetBasePathMapping'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_gbpmDomainName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_gbpmBasePath") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))
type Rs GetBasePathMapping # 

Request Lenses

gbpmDomainName :: Lens' GetBasePathMapping Text #

The domain name of the BasePathMapping resource to be described.

gbpmBasePath :: Lens' GetBasePathMapping Text #

The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Leave this blank if you do not want callers to specify any base path name after the domain name.

Destructuring the Response

basePathMapping :: BasePathMapping #

Creates a value of BasePathMapping with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • bpmStage - The name of the API's stage.
  • bpmBasePath - The base path name that callers of the API must provide as part of the URL after the domain name.
  • bpmRestAPIId - The name of the API.

data BasePathMapping #

Represents the base path that callers of the API must provide as part of the URL after the domain name.

A custom domain name plus a BasePathMapping specification identifies a deployed RestApi in a given stage of the owner Account .Use Custom Domain Names

See: basePathMapping smart constructor.

Instances

Eq BasePathMapping # 
Data BasePathMapping # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> BasePathMapping -> c BasePathMapping #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c BasePathMapping #

toConstr :: BasePathMapping -> Constr #

dataTypeOf :: BasePathMapping -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c BasePathMapping) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c BasePathMapping) #

gmapT :: (forall b. Data b => b -> b) -> BasePathMapping -> BasePathMapping #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> BasePathMapping -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> BasePathMapping -> r #

gmapQ :: (forall d. Data d => d -> u) -> BasePathMapping -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> BasePathMapping -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> BasePathMapping -> m BasePathMapping #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> BasePathMapping -> m BasePathMapping #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> BasePathMapping -> m BasePathMapping #

Read BasePathMapping # 
Show BasePathMapping # 
Generic BasePathMapping # 
Hashable BasePathMapping # 
FromJSON BasePathMapping # 
NFData BasePathMapping # 

Methods

rnf :: BasePathMapping -> () #

type Rep BasePathMapping # 
type Rep BasePathMapping = D1 (MetaData "BasePathMapping" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.5-5OCToOwmZjEH3FMiU9Yogu" False) (C1 (MetaCons "BasePathMapping'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_bpmStage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_bpmBasePath") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_bpmRestAPIId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

Response Lenses

bpmStage :: Lens' BasePathMapping (Maybe Text) #

The name of the API's stage.

bpmBasePath :: Lens' BasePathMapping (Maybe Text) #

The base path name that callers of the API must provide as part of the URL after the domain name.

bpmRestAPIId :: Lens' BasePathMapping (Maybe Text) #

The name of the API.