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

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

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 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_typeString

The content-type for the model.

Returns:

  • (String)


876
877
878
879
880
881
882
883
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 876

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

#descriptionString

The description of the model.

Returns:

  • (String)


876
877
878
879
880
881
882
883
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 876

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

#nameString

The name of the model.

Returns:

  • (String)


876
877
878
879
880
881
882
883
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 876

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

#rest_api_idString

The RestApi identifier under which the Model will be created.

Returns:

  • (String)


876
877
878
879
880
881
882
883
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 876

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

#schemaString

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

Returns:

  • (String)


876
877
878
879
880
881
882
883
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 876

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