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

Class: Aws::APIGateway::Types::Model

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Represents the data structure of a method's request or response payload.

A request model defines the data structure of the client-supplied request payload. A response model defines the data structure of the response payload returned by the back end. Although not required, models are useful for mapping payloads between the front end and back end.

A model is used for generating an API's SDK, validating the input request body, and creating a skeletal mapping template.

Method, MethodResponse, Models and Mappings

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#content_type ⇒ String

The content-type for the model.

Returns:

  • (String) —

    The content-type for the model.

#description ⇒ String

The description of the model.

Returns:

  • (String) —

    The description of the model.

#id ⇒ String

The identifier for the model resource.

Returns:

  • (String) —

    The identifier for the model resource.

#name ⇒ String

The name of the model. Must be an alphanumeric string.

Returns:

  • (String) —

    The name of the model.

#schema ⇒ String

The schema for the model. For application/json models, this should be JSON schema draft 4target="_blank" model. Do not include \"\*/\" characters in the description of any properties because such \"\*/\" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API\'s SDK generated by API Gateway to fail.

Returns:

  • (String) —

    The schema for the model.