Network.AWS.APIGateway.UpdateBasePathMapping

Changes information about the BasePathMapping resource.

Creating a Request

updateBasePathMapping

Arguments

:: Text

ubpmDomainName

-> Text

ubpmBasePath

-> UpdateBasePathMapping

Creates a value of UpdateBasePathMapping with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ubpmPatchOperations - A list of update operations to be applied to the specified resource and in the order specified in this list.
• ubpmDomainName - [Required] The domain name of the BasePathMapping resource to change.
• ubpmBasePath - [Required] The base path of the BasePathMapping resource to change.

data UpdateBasePathMapping

A request to change information about the BasePathMapping resource.

See: updateBasePathMapping smart constructor.

Instances

Eq UpdateBasePathMapping

Defined in Network.AWS.APIGateway.UpdateBasePathMapping

Methods

(==) :: UpdateBasePathMapping -> UpdateBasePathMapping -> Bool

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

Data UpdateBasePathMapping

Defined in Network.AWS.APIGateway.UpdateBasePathMapping

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateBasePathMapping -> c UpdateBasePathMapping

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateBasePathMapping

toConstr :: UpdateBasePathMapping -> Constr

dataTypeOf :: UpdateBasePathMapping -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UpdateBasePathMapping)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateBasePathMapping)

gmapT :: (forall b. Data b => b -> b) -> UpdateBasePathMapping -> UpdateBasePathMapping

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateBasePathMapping -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateBasePathMapping -> r

gmapQ :: (forall d. Data d => d -> u) -> UpdateBasePathMapping -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateBasePathMapping -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateBasePathMapping -> m UpdateBasePathMapping

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateBasePathMapping -> m UpdateBasePathMapping

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateBasePathMapping -> m UpdateBasePathMapping

Read UpdateBasePathMapping

Defined in Network.AWS.APIGateway.UpdateBasePathMapping

Methods

readsPrec :: Int -> ReadS UpdateBasePathMapping

readList :: ReadS [UpdateBasePathMapping]

readPrec :: ReadPrec UpdateBasePathMapping

readListPrec :: ReadPrec [UpdateBasePathMapping]

Show UpdateBasePathMapping

Defined in Network.AWS.APIGateway.UpdateBasePathMapping

Methods

showsPrec :: Int -> UpdateBasePathMapping -> ShowS

show :: UpdateBasePathMapping -> String

showList :: [UpdateBasePathMapping] -> ShowS

Generic UpdateBasePathMapping

Defined in Network.AWS.APIGateway.UpdateBasePathMapping

Associated Types

type Rep UpdateBasePathMapping :: Type -> Type

Methods

from :: UpdateBasePathMapping -> Rep UpdateBasePathMapping x

to :: Rep UpdateBasePathMapping x -> UpdateBasePathMapping

Hashable UpdateBasePathMapping

Defined in Network.AWS.APIGateway.UpdateBasePathMapping

Methods

hashWithSalt :: Int -> UpdateBasePathMapping -> Int

hash :: UpdateBasePathMapping -> Int

ToJSON UpdateBasePathMapping

Defined in Network.AWS.APIGateway.UpdateBasePathMapping

Methods

toJSON :: UpdateBasePathMapping -> Value

toEncoding :: UpdateBasePathMapping -> Encoding

toJSONList :: [UpdateBasePathMapping] -> Value

toEncodingList :: [UpdateBasePathMapping] -> Encoding

AWSRequest UpdateBasePathMapping

Defined in Network.AWS.APIGateway.UpdateBasePathMapping

Associated Types

type Rs UpdateBasePathMapping :: Type

Methods

request :: UpdateBasePathMapping -> Request UpdateBasePathMapping

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

ToHeaders UpdateBasePathMapping

Defined in Network.AWS.APIGateway.UpdateBasePathMapping

Methods

toHeaders :: UpdateBasePathMapping -> [Header]

ToPath UpdateBasePathMapping

Defined in Network.AWS.APIGateway.UpdateBasePathMapping

Methods

toPath :: UpdateBasePathMapping -> ByteString

ToQuery UpdateBasePathMapping

Defined in Network.AWS.APIGateway.UpdateBasePathMapping

Methods

toQuery :: UpdateBasePathMapping -> QueryString

NFData UpdateBasePathMapping

Defined in Network.AWS.APIGateway.UpdateBasePathMapping

Methods

rnf :: UpdateBasePathMapping -> ()

type Rep UpdateBasePathMapping

Defined in Network.AWS.APIGateway.UpdateBasePathMapping

type Rep UpdateBasePathMapping = D1 (MetaData "UpdateBasePathMapping" "Network.AWS.APIGateway.UpdateBasePathMapping" "amazonka-apigateway-1.6.1-BCCM2RP3l9Q2ENgHvKrj59" False) (C1 (MetaCons "UpdateBasePathMapping'" PrefixI True) (S1 (MetaSel (Just "_ubpmPatchOperations") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [PatchOperation])) :*: (S1 (MetaSel (Just "_ubpmDomainName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_ubpmBasePath") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

type Rs UpdateBasePathMapping

Defined in Network.AWS.APIGateway.UpdateBasePathMapping

type Rs UpdateBasePathMapping = BasePathMapping

Request Lenses

ubpmPatchOperations :: Lens' UpdateBasePathMapping [PatchOperation]

A list of update operations to be applied to the specified resource and in the order specified in this list.

ubpmDomainName :: Lens' UpdateBasePathMapping Text

Required

The domain name of the BasePathMapping resource to change.

ubpmBasePath :: Lens' UpdateBasePathMapping Text

Required

The base path of the BasePathMapping resource to change.

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 .