Skip to content

Describes existing Models defined for a RestApi resource

Description

Describes existing Models defined for a RestApi resource.

Usage

apigateway_get_models(restApiId, position, limit)

Arguments

  • restApiId

    [required] The string identifier of the associated RestApi.

  • 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(
      id = "string",
      name = "string",
      description = "string",
      schema = "string",
      contentType = "string"
    )
  )
)

Request syntax

svc$get_models(
  restApiId = "string",
  position = "string",
  limit = 123
)