You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-apigateway/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.

Instance Attribute Summary collapse

Instance Attribute Details

#flattenBoolean

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)


3466
3467
3468
3469
3470
3471
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3466

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

#model_nameString

The name of the model as an identifier.

Returns:

  • (String)


3466
3467
3468
3469
3470
3471
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3466

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

#rest_api_idString

The RestApi identifier under which the Model exists.

Returns:

  • (String)


3466
3467
3468
3469
3470
3471
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3466

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