ModelTemplate - Amazon API Gateway

ModelTemplate

Represents a model template. Supported only for WebSocket APIs.

URI

/v2/apis/apiId/models/modelId/template

HTTP methods

GET

Operation ID: GetModelTemplate

Gets a model template.

Path parameters
NameTypeRequiredDescription
modelIdStringTrue

The model ID.

apiIdStringTrue

The API identifier.

Responses
Status codeResponse modelDescription
200Template

Success

404NotFoundException

The resource specified in the request was not found.

429LimitExceededException

The client is sending more than the allowed number of requests per unit of time.

Schemas

Response bodies

{ "value": "string" }
{ "message": "string", "resourceType": "string" }
{ "message": "string", "limitType": "string" }

Properties

LimitExceededException

A limit has been exceeded. See the accompanying error message for details.

PropertyTypeRequiredDescription
limitType

string

False

The limit type.

message

string

False

Describes the error encountered.

NotFoundException

The resource specified in the request was not found. See the message field for more information.

PropertyTypeRequiredDescription
message

string

False

Describes the error encountered.

resourceType

string

False

The resource type.

Template

Represents a template.

PropertyTypeRequiredDescription
value

string

False

The template value.

See also

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

GetModelTemplate