apigateway_get_model: Describes an existing model defined for a RestApi resource

Description Usage Arguments Value Request syntax

View source: R/apigateway_operations.R

Description

Describes an existing model defined for a RestApi resource.

Usage

1
apigateway_get_model(restApiId, modelName, flatten)

Arguments

restApiId

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

modelName

[required] [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:

1
2
3
4
5
6
7
list(
  id = "string",
  name = "string",
  description = "string",
  schema = "string",
  contentType = "string"
)

Request syntax

1
2
3
4
5
svc$get_model(
  restApiId = "string",
  modelName = "string",
  flatten = TRUE|FALSE
)

paws.networking documentation built on Aug. 23, 2021, 9:07 a.m.