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

Inherits:

Struct

• Object
• Struct
• Aws::APIGateway::Types::CreateModelRequest

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.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #content_type ⇒ String

  [Required] The content-type for the model.

• #description ⇒ String

  The description of the model.

• #name ⇒ String

  [Required] The name of the model.

• #rest_api_id ⇒ String

  [Required] The RestApi identifier under which the Model will be created.

• #schema ⇒ String

  The schema for the model.

Instance Attribute Details

#content_type ⇒ String

[Required] The content-type for the model.

Returns:

• (String)

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

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

#description ⇒ String

The description of the model.

Returns:

• (String)

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

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

#name ⇒ String

[Required] The name of the model. Must be alphanumeric.

Returns:

• (String)

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

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

#rest_api_id ⇒ String

[Required] The RestApi identifier under which the Model will be created.

Returns:

• (String)

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

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

#schema ⇒ String

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

[1]: tools.ietf.org/html/draft-zyp-json-schema-04

Returns:

• (String)

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

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