libZSservicesZSamazonka-apigatewayZSamazonka-apigateway
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.APIGateway.UpdateBasePathMapping

Description

Changes information about the BasePathMapping resource.

Synopsis

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]

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

  • domainName :: Text
    Required
    The domain name of the BasePathMapping resource to change.
  • basePath :: Text
    Required
    The base path of the BasePathMapping resource to change.

    To specify an empty base path, set this parameter to '(none)'.

Instances

Instances details
Eq UpdateBasePathMapping Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateBasePathMapping

Methods

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

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

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 #

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 #

NFData UpdateBasePathMapping Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateBasePathMapping

Methods

rnf :: UpdateBasePathMapping -> () #

Hashable UpdateBasePathMapping Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateBasePathMapping

Methods

hashWithSalt :: Int -> UpdateBasePathMapping -> Int #

hash :: UpdateBasePathMapping -> Int #

ToJSON UpdateBasePathMapping Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateBasePathMapping

Methods

toJSON :: UpdateBasePathMapping -> Value #

toEncoding :: UpdateBasePathMapping -> Encoding #

toJSONList :: [UpdateBasePathMapping] -> Value #

toEncodingList :: [UpdateBasePathMapping] -> Encoding #

AWSRequest UpdateBasePathMapping Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateBasePathMapping

Associated Types

type AWSResponse UpdateBasePathMapping #

Methods

request :: UpdateBasePathMapping -> Request UpdateBasePathMapping #

response :: MonadResource m => Logger -> Service -> Proxy UpdateBasePathMapping -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateBasePathMapping))) #

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 #

type Rep UpdateBasePathMapping Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateBasePathMapping

type Rep UpdateBasePathMapping = D1 ('MetaData "UpdateBasePathMapping" "Amazonka.APIGateway.UpdateBasePathMapping" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" '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))))
type AWSResponse UpdateBasePathMapping Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateBasePathMapping

type AWSResponse UpdateBasePathMapping = BasePathMapping

newUpdateBasePathMapping Source #

Arguments

:: Text

$sel:domainName:UpdateBasePathMapping'

-> Text

$sel:basePath: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 - A list of update operations to be applied to the specified resource and in the order specified in this list.

$sel:domainName:UpdateBasePathMapping', updateBasePathMapping_domainName - [Required] The domain name of the BasePathMapping resource to change.

$sel:basePath:UpdateBasePathMapping', updateBasePathMapping_basePath - [Required] 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 #

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

updateBasePathMapping_domainName :: Lens' UpdateBasePathMapping Text Source #

Required
The domain name of the BasePathMapping resource to change.

updateBasePathMapping_basePath :: Lens' UpdateBasePathMapping Text Source #

Required
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.

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

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.