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 |
Describe a BasePathMapping resource.
Synopsis
- data GetBasePathMapping = GetBasePathMapping' {
- domainName :: Text
- basePath :: Text
- newGetBasePathMapping :: Text -> Text -> GetBasePathMapping
- getBasePathMapping_domainName :: Lens' GetBasePathMapping Text
- getBasePathMapping_basePath :: Lens' GetBasePathMapping Text
- data BasePathMapping = BasePathMapping' {}
- newBasePathMapping :: BasePathMapping
- basePathMapping_basePath :: Lens' BasePathMapping (Maybe Text)
- basePathMapping_restApiId :: Lens' BasePathMapping (Maybe Text)
- basePathMapping_stage :: Lens' BasePathMapping (Maybe Text)
Creating a Request
data GetBasePathMapping Source #
Request to describe a BasePathMapping resource.
See: newGetBasePathMapping
smart constructor.
GetBasePathMapping' | |
|
Instances
newGetBasePathMapping Source #
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:
GetBasePathMapping
, getBasePathMapping_domainName
- The domain name of the BasePathMapping resource to be described.
GetBasePathMapping
, getBasePathMapping_basePath
- 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 #
The domain name of the BasePathMapping resource to be described.
getBasePathMapping_basePath :: Lens' GetBasePathMapping Text Source #
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.
See: newBasePathMapping
smart constructor.
Instances
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: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.
$sel:stage:BasePathMapping'
, basePathMapping_stage
- The name of the associated stage.
Response Lenses
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.
basePathMapping_stage :: Lens' BasePathMapping (Maybe Text) Source #
The name of the associated stage.