Model - Amazon API Gateway (original) (raw)

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

Contents

contentType

The content-type for the model.

Type: String

Required: No

description

The description of the model.

Type: String

Required: No

id

The identifier for the model resource.

Type: String

Required: No

name

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

Type: String

Required: No

schema

The schema for the model. For application/json models, this should be JSON schema draft 4 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.

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++
• AWS SDK for Java V2
• AWS SDK for Ruby V3

MethodSnapshot

MutualTlsAuthentication

Did this page help you? - Yes

Thanks for letting us know we're doing a good job!

If you've got a moment, please tell us what we did right so we can do more of it.

Did this page help you? - No

Thanks for letting us know this page needs work. We're sorry we let you down.

If you've got a moment, please tell us how we can make the documentation better.