Get Model

apigateway_get_model

R Documentation

Describes an existing model defined for a RestApi resource

Description

Describes an existing model defined for a RestApi resource.

Usage

apigateway_get_model(restApiId, modelName, flatten)

Arguments

restApiId

[required] The RestApi identifier under which the Model exists.

modelName

[required] The name of the model as an identifier.

flatten

A query parameter of a Boolean value to resolve (true) all external model references and returns a flattened model schema or not (false) The default is false.

Value

A list with the following syntax:

list(
  id = "string",
  name = "string",
  description = "string",
  schema = "string",
  contentType = "string"
)

Request syntax

svc$get_model(
  restApiId = "string",
  modelName = "string",
  flatten = TRUE|FALSE
)