Skip to content

Represents a collection of BasePathMapping resources

Description

Represents a collection of BasePathMapping resources.

Usage

apigateway_get_base_path_mappings(domainName, domainNameId, position,
  limit)

Arguments

  • domainName

    [required] The domain name of a BasePathMapping resource.

  • domainNameId

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

  • position

    The current pagination position in the paged result set.

  • limit

    The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

Value

A list with the following syntax:

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

Request syntax

svc$get_base_path_mappings(
  domainName = "string",
  domainNameId = "string",
  position = "string",
  limit = 123
)