Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.APIGateway.GetBasePathMapping

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describe a BasePathMapping resource.

Synopsis

Creating a Request

data GetBasePathMapping Source #

Request to describe a BasePathMapping resource.

See: newGetBasePathMapping smart constructor.

Constructors

GetBasePathMapping'
Fields domainName :: Text Required The domain name of the BasePathMapping resource to be described. basePath :: 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. Specify '(none)' if you do not want callers to specify any base path name after the domain name.

Instances

Instances details

Eq GetBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMapping Methods (==) :: GetBasePathMapping -> GetBasePathMapping -> Bool # (/=) :: GetBasePathMapping -> GetBasePathMapping -> Bool #
Read GetBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMapping Methods readsPrec :: Int -> ReadS GetBasePathMapping # readList :: ReadS [GetBasePathMapping] # readPrec :: ReadPrec GetBasePathMapping # readListPrec :: ReadPrec [GetBasePathMapping] #
Show GetBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMapping Methods showsPrec :: Int -> GetBasePathMapping -> ShowS # show :: GetBasePathMapping -> String # showList :: [GetBasePathMapping] -> ShowS #
Generic GetBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMapping Associated Types type Rep GetBasePathMapping :: Type -> Type # Methods from :: GetBasePathMapping -> Rep GetBasePathMapping x # to :: Rep GetBasePathMapping x -> GetBasePathMapping #
NFData GetBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMapping Methods rnf :: GetBasePathMapping -> () #
Hashable GetBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMapping Methods hashWithSalt :: Int -> GetBasePathMapping -> Int # hash :: GetBasePathMapping -> Int #
AWSRequest GetBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMapping Associated Types type AWSResponse GetBasePathMapping # Methods request :: GetBasePathMapping -> Request GetBasePathMapping # response :: MonadResource m => Logger -> Service -> Proxy GetBasePathMapping -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetBasePathMapping))) #
ToHeaders GetBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMapping Methods toHeaders :: GetBasePathMapping -> [Header] #
ToPath GetBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMapping Methods toPath :: GetBasePathMapping -> ByteString #
ToQuery GetBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMapping Methods toQuery :: GetBasePathMapping -> QueryString #
type Rep GetBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMapping type Rep GetBasePathMapping = D1 ('MetaData "GetBasePathMapping" "Amazonka.APIGateway.GetBasePathMapping" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "GetBasePathMapping'" 'PrefixI 'True) (S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "basePath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse GetBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMapping type AWSResponse GetBasePathMapping = BasePathMapping

newGetBasePathMapping Source #

Arguments

:: Text	`$sel:domainName:GetBasePathMapping'`
-> Text	`$sel:basePath:GetBasePathMapping'`
-> GetBasePathMapping

Create a value of GetBasePathMapping 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:domainName:GetBasePathMapping', getBasePathMapping_domainName - [Required] The domain name of the BasePathMapping resource to be described.

$sel:basePath:GetBasePathMapping', getBasePathMapping_basePath - [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. Specify '(none)' if you do not want callers to specify any base path name after the domain name.

Request Lenses

getBasePathMapping_domainName :: Lens' GetBasePathMapping Text Source #

Required: The domain name of the BasePathMapping resource to be described.

getBasePathMapping_basePath :: Lens' GetBasePathMapping Text Source #

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. Specify '(none)' if you do not want callers to specify any base path name after the domain name.

Destructuring the Response

data BasePathMapping Source #

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: newBasePathMapping smart constructor.

Constructors

BasePathMapping'
Fields stage :: Maybe Text The name of the associated stage. basePath :: Maybe Text The base path name that callers of the API must provide as part of the URL after the domain name. restApiId :: Maybe Text The string identifier of the associated RestApi.

Instances

Instances details

Eq BasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.Types.BasePathMapping Methods (==) :: BasePathMapping -> BasePathMapping -> Bool # (/=) :: BasePathMapping -> BasePathMapping -> Bool #
Read BasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.Types.BasePathMapping Methods readsPrec :: Int -> ReadS BasePathMapping # readList :: ReadS [BasePathMapping] # readPrec :: ReadPrec BasePathMapping # readListPrec :: ReadPrec [BasePathMapping] #
Show BasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.Types.BasePathMapping Methods showsPrec :: Int -> BasePathMapping -> ShowS # show :: BasePathMapping -> String # showList :: [BasePathMapping] -> ShowS #
Generic BasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.Types.BasePathMapping Associated Types type Rep BasePathMapping :: Type -> Type # Methods from :: BasePathMapping -> Rep BasePathMapping x # to :: Rep BasePathMapping x -> BasePathMapping #
NFData BasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.Types.BasePathMapping Methods rnf :: BasePathMapping -> () #
Hashable BasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.Types.BasePathMapping Methods hashWithSalt :: Int -> BasePathMapping -> Int # hash :: BasePathMapping -> Int #
FromJSON BasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.Types.BasePathMapping Methods parseJSON :: Value -> Parser BasePathMapping # parseJSONList :: Value -> Parser [BasePathMapping] #
type Rep BasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.Types.BasePathMapping type Rep BasePathMapping = D1 ('MetaData "BasePathMapping" "Amazonka.APIGateway.Types.BasePathMapping" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "BasePathMapping'" 'PrefixI 'True) (S1 ('MetaSel ('Just "stage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "basePath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newBasePathMapping :: BasePathMapping Source #

Create a value of BasePathMapping 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:stage:BasePathMapping', basePathMapping_stage - The name of the associated stage.

$sel:basePath:BasePathMapping', basePathMapping_basePath - The base path name that callers of the API must provide as part of the URL after the domain name.

$sel:restApiId:BasePathMapping', basePathMapping_restApiId - The string identifier of the associated RestApi.

Response Lenses

basePathMapping_stage :: Lens' BasePathMapping (Maybe Text) Source #

The name of the associated stage.

basePathMapping_basePath :: Lens' BasePathMapping (Maybe Text) Source #

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

basePathMapping_restApiId :: Lens' BasePathMapping (Maybe Text) Source #

The string identifier of the associated RestApi.