Skip to content

Update Base Path Mapping

apigateway_update_base_path_mapping R Documentation

Changes information about the BasePathMapping resource

Description

Changes information about the BasePathMapping resource.

Usage

apigateway_update_base_path_mapping(domainName, domainNameId, basePath,
  patchOperations)

Arguments

domainName

[required] The domain name of the BasePathMapping resource to change.

domainNameId

The identifier for the domain name resource. Supported only for private custom domain names.

basePath

[required] The base path of the BasePathMapping resource to change.

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

patchOperations

For more information about supported patch operations, see Patch Operations.

Value

A list with the following syntax:

list(
  basePath = "string",
  restApiId = "string",
  stage = "string"
)

Request syntax

svc$update_base_path_mapping(
  domainName = "string",
  domainNameId = "string",
  basePath = "string",
  patchOperations = list(
    list(
      op = "add"|"remove"|"replace"|"move"|"copy"|"test",
      path = "string",
      value = "string",
      from = "string"
    )
  )
)