Class: Aws::APIGateway::Types::GetModelRequest

Inherits:

Struct

• Object
• Struct
• Aws::APIGateway::Types::GetModelRequest

Includes:

Structure

Defined in:

lib/aws-sdk-apigateway/types.rb

Overview

Note:

When making an API call, you may pass GetModelRequest data as a hash:

{
  rest_api_id: "String", # required
  model_name: "String", # required
  flatten: false,
}

Request to list information about a model in an existing RestApi resource.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #flatten ⇒ Boolean

  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`.

• #model_name ⇒ String

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

• #rest_api_id ⇒ String

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

Instance Attribute Details

#flatten ⇒ Boolean

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`.

Returns:

• (Boolean)

# File 'lib/aws-sdk-apigateway/types.rb', line 3839

class GetModelRequest < Struct.new(
  :rest_api_id,
  :model_name,
  :flatten)
  SENSITIVE = []
  include Aws::Structure
end

#model_name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 3839

class GetModelRequest < Struct.new(
  :rest_api_id,
  :model_name,
  :flatten)
  SENSITIVE = []
  include Aws::Structure
end

#rest_api_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 3839

class GetModelRequest < Struct.new(
  :rest_api_id,
  :model_name,
  :flatten)
  SENSITIVE = []
  include Aws::Structure
end