Get Base Path Mapping

apigateway_get_base_path_mapping

R Documentation

Describe a BasePathMapping resource

Description

Describe a BasePathMapping resource.

Usage

apigateway_get_base_path_mapping(domainName, basePath)

Arguments

domainName

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

basePath

[required] The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Specify '(none)' if you do not want callers to specify any base path name after the domain name.

Value

A list with the following syntax:

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

Request syntax

svc$get_base_path_mapping(
  domainName = "string",
  basePath = "string"
)