Class: Aws::APIGateway::Types::CreateModelRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-apigateway/types.rb

Overview

Note:

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

{
  rest_api_id: "String", # required
  name: "String", # required
  description: "String",
  schema: "String",
  content_type: "String", # required
}

Request to add a new Model to an existing RestApi resource.

Instance Attribute Summary collapse

Instance Attribute Details

#content_type ⇒ String

The content-type for the model.

Returns:

  • (String) 


946
947
948
949
950
951
952
953
 
# File 'lib/aws-sdk-apigateway/types.rb', line 946

class CreateModelRequest < Struct.new(
  :rest_api_id,
  :name,
  :description,
  :schema,
  :content_type)
  include Aws::Structure
end

#description ⇒ String

The description of the model.

Returns:

  • (String) 


946
947
948
949
950
951
952
953
 
# File 'lib/aws-sdk-apigateway/types.rb', line 946

class CreateModelRequest < Struct.new(
  :rest_api_id,
  :name,
  :description,
  :schema,
  :content_type)
  include Aws::Structure
end

#name ⇒ String

The name of the model. Must be alphanumeric.

Returns:

  • (String) 


946
947
948
949
950
951
952
953
 
# File 'lib/aws-sdk-apigateway/types.rb', line 946

class CreateModelRequest < Struct.new(
  :rest_api_id,
  :name,
  :description,
  :schema,
  :content_type)
  include Aws::Structure
end

#rest_api_id ⇒ String

The RestApi identifier under which the Model will be created.

Returns:

  • (String) 


946
947
948
949
950
951
952
953
 
# File 'lib/aws-sdk-apigateway/types.rb', line 946

class CreateModelRequest < Struct.new(
  :rest_api_id,
  :name,
  :description,
  :schema,
  :content_type)
  include Aws::Structure
end

#schema ⇒ String

The schema for the model. For ‘application/json` models, this should be [JSON-schema draft v4] model.

[1]: json-schema.org/documentation.html

Returns:

  • (String) 


946
947
948
949
950
951
952
953
 
# File 'lib/aws-sdk-apigateway/types.rb', line 946

class CreateModelRequest < Struct.new(
  :rest_api_id,
  :name,
  :description,
  :schema,
  :content_type)
  include Aws::Structure
end