Network.AWS.APIGateway.GetBasePathMapping

Describe a BasePathMapping resource.

Creating a Request

getBasePathMapping

Arguments

:: Text

gbpmDomainName

-> Text

gbpmBasePath

-> 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 - [Required] The domain name of the BasePathMapping resource to be described.
• gbpmBasePath - [Required] 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

Defined in Network.AWS.APIGateway.GetBasePathMapping

Methods

(==) :: GetBasePathMapping -> GetBasePathMapping -> Bool

(/=) :: GetBasePathMapping -> GetBasePathMapping -> Bool

Data GetBasePathMapping

Defined in Network.AWS.APIGateway.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

Defined in Network.AWS.APIGateway.GetBasePathMapping

Methods

readsPrec :: Int -> ReadS GetBasePathMapping

readList :: ReadS [GetBasePathMapping]

readPrec :: ReadPrec GetBasePathMapping

readListPrec :: ReadPrec [GetBasePathMapping]

Show GetBasePathMapping

Defined in Network.AWS.APIGateway.GetBasePathMapping

Methods

showsPrec :: Int -> GetBasePathMapping -> ShowS

show :: GetBasePathMapping -> String

showList :: [GetBasePathMapping] -> ShowS

Generic GetBasePathMapping

Defined in Network.AWS.APIGateway.GetBasePathMapping

Associated Types

type Rep GetBasePathMapping :: Type -> Type

Methods

from :: GetBasePathMapping -> Rep GetBasePathMapping x

to :: Rep GetBasePathMapping x -> GetBasePathMapping

Hashable GetBasePathMapping

Defined in Network.AWS.APIGateway.GetBasePathMapping

Methods

hashWithSalt :: Int -> GetBasePathMapping -> Int

hash :: GetBasePathMapping -> Int

AWSRequest GetBasePathMapping

Defined in Network.AWS.APIGateway.GetBasePathMapping

Associated Types

type Rs GetBasePathMapping :: Type

Methods

request :: GetBasePathMapping -> Request GetBasePathMapping

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy GetBasePathMapping -> ClientResponse -> m (Response GetBasePathMapping)

ToHeaders GetBasePathMapping

Defined in Network.AWS.APIGateway.GetBasePathMapping

Methods

toHeaders :: GetBasePathMapping -> [Header]

ToPath GetBasePathMapping

Defined in Network.AWS.APIGateway.GetBasePathMapping

Methods

toPath :: GetBasePathMapping -> ByteString

ToQuery GetBasePathMapping

Defined in Network.AWS.APIGateway.GetBasePathMapping

Methods

toQuery :: GetBasePathMapping -> QueryString

NFData GetBasePathMapping

Defined in Network.AWS.APIGateway.GetBasePathMapping

Methods

rnf :: GetBasePathMapping -> ()

type Rep GetBasePathMapping

Defined in Network.AWS.APIGateway.GetBasePathMapping

type Rep GetBasePathMapping = D1 (MetaData "GetBasePathMapping" "Network.AWS.APIGateway.GetBasePathMapping" "amazonka-apigateway-1.6.1-BCCM2RP3l9Q2ENgHvKrj59" False) (C1 (MetaCons "GetBasePathMapping'" PrefixI True) (S1 (MetaSel (Just "_gbpmDomainName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_gbpmBasePath") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))

type Rs GetBasePathMapping

Defined in Network.AWS.APIGateway.GetBasePathMapping

type Rs GetBasePathMapping = BasePathMapping

Request Lenses

gbpmDomainName :: Lens' GetBasePathMapping Text

Required

The domain name of the BasePathMapping resource to be described.

gbpmBasePath :: Lens' GetBasePathMapping Text

Required

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 associated stage.
• bpmBasePath - The base path name that callers of the API must provide as part of the URL after the domain name.
• bpmRestAPIId - The string identifier of the associated RestApi .

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

Defined in Network.AWS.APIGateway.Types.Product

Methods

(==) :: BasePathMapping -> BasePathMapping -> Bool

(/=) :: BasePathMapping -> BasePathMapping -> Bool

Data BasePathMapping

Defined in Network.AWS.APIGateway.Types.Product

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

Defined in Network.AWS.APIGateway.Types.Product

Methods

readsPrec :: Int -> ReadS BasePathMapping

readList :: ReadS [BasePathMapping]

readPrec :: ReadPrec BasePathMapping

readListPrec :: ReadPrec [BasePathMapping]

Show BasePathMapping

Defined in Network.AWS.APIGateway.Types.Product

Methods

showsPrec :: Int -> BasePathMapping -> ShowS

show :: BasePathMapping -> String

showList :: [BasePathMapping] -> ShowS

Generic BasePathMapping

Defined in Network.AWS.APIGateway.Types.Product

Associated Types

type Rep BasePathMapping :: Type -> Type

Methods

from :: BasePathMapping -> Rep BasePathMapping x

to :: Rep BasePathMapping x -> BasePathMapping

Hashable BasePathMapping

Defined in Network.AWS.APIGateway.Types.Product

Methods

hashWithSalt :: Int -> BasePathMapping -> Int

hash :: BasePathMapping -> Int

FromJSON BasePathMapping

Defined in Network.AWS.APIGateway.Types.Product

Methods

parseJSON :: Value -> Parser BasePathMapping

parseJSONList :: Value -> Parser [BasePathMapping]

NFData BasePathMapping

Defined in Network.AWS.APIGateway.Types.Product

Methods

rnf :: BasePathMapping -> ()

type Rep BasePathMapping

Defined in Network.AWS.APIGateway.Types.Product

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

Response Lenses

bpmStage :: Lens' BasePathMapping (Maybe Text)

The name of the associated 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 string identifier of the associated RestApi .