| 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.UpdateBasePathMapping
Description
Changes information about the BasePathMapping resource.
Synopsis
- data UpdateBasePathMapping = UpdateBasePathMapping' {
- patchOperations :: Maybe [PatchOperation]
- domainName :: Text
- basePath :: Text
- newUpdateBasePathMapping :: Text -> Text -> UpdateBasePathMapping
- updateBasePathMapping_patchOperations :: Lens' UpdateBasePathMapping (Maybe [PatchOperation])
- updateBasePathMapping_domainName :: Lens' UpdateBasePathMapping Text
- updateBasePathMapping_basePath :: Lens' UpdateBasePathMapping 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 UpdateBasePathMapping Source #
A request to change information about the BasePathMapping resource.
See: newUpdateBasePathMapping smart constructor.
Constructors
| UpdateBasePathMapping' | |
Fields
| |
Instances
newUpdateBasePathMapping Source #
Arguments
| :: Text | |
| -> Text | |
| -> UpdateBasePathMapping |
Create a value of UpdateBasePathMapping 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:patchOperations:UpdateBasePathMapping', updateBasePathMapping_patchOperations - For more information about supported patch operations, see
Patch Operations.
UpdateBasePathMapping, updateBasePathMapping_domainName - The domain name of the BasePathMapping resource to change.
UpdateBasePathMapping, updateBasePathMapping_basePath - The base path of the BasePathMapping resource to change.
To specify an empty base path, set this parameter to '(none)'.
Request Lenses
updateBasePathMapping_patchOperations :: Lens' UpdateBasePathMapping (Maybe [PatchOperation]) Source #
For more information about supported patch operations, see Patch Operations.
updateBasePathMapping_domainName :: Lens' UpdateBasePathMapping Text Source #
The domain name of the BasePathMapping resource to change.
updateBasePathMapping_basePath :: Lens' UpdateBasePathMapping Text Source #
The base path of the BasePathMapping resource to change.
To specify an empty base path, set this parameter to '(none)'.
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.
Constructors
| BasePathMapping' | |
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.