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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Changes information about the BasePathMapping resource.

Creating a Request

data UpdateBasePathMapping Source #

A request to change information about the BasePathMapping resource.

See: newUpdateBasePathMapping smart constructor.

Constructors

UpdateBasePathMapping'
Fields patchOperations :: Maybe [PatchOperation] For more information about supported patch operations, see Patch Operations. domainName :: Text The domain name of the BasePathMapping resource to change. basePath :: Text The base path of the BasePathMapping resource to change. To specify an empty base path, set this parameter to `'(none)'`.

Instances

Instances details

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

newUpdateBasePathMapping Source #

Arguments

:: Text	`UpdateBasePathMapping`
-> Text	`UpdateBasePathMapping`
-> 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'
Fields 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. stage :: Maybe Text The name of the associated stage.

Instances

Instances details

FromJSON BasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.Types.BasePathMapping Methods parseJSON :: Value -> Parser BasePathMapping # parseJSONList :: Value -> Parser [BasePathMapping] #
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 #
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 #
NFData BasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.Types.BasePathMapping Methods rnf :: BasePathMapping -> () #
Eq BasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.Types.BasePathMapping Methods (==) :: BasePathMapping -> BasePathMapping -> Bool # (/=) :: BasePathMapping -> BasePathMapping -> Bool #
Hashable BasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.Types.BasePathMapping Methods hashWithSalt :: Int -> BasePathMapping -> Int # hash :: BasePathMapping -> Int #
type Rep BasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.Types.BasePathMapping type Rep BasePathMapping = D1 ('MetaData "BasePathMapping" "Amazonka.APIGateway.Types.BasePathMapping" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "BasePathMapping'" 'PrefixI 'True) (S1 ('MetaSel ('Just "basePath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "stage") '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: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.