ModelTemplate - Amazon API Gateway
URIHTTP MethodsSchemasPropertiesSee Also

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
Name Type Required Description
modelId String True

The model ID.
apiId String True

The API identifier.
Responses
Status Code Response Model Description
200 Template

Success
404 NotFoundException

The resource specified in the request was not found.
429 LimitExceededException

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

Schemas

Response Bodies

Example Template

{
  "value": "string"
}

Example NotFoundException

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

Example LimitExceededException

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

Properties

LimitExceededException

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

Property Type Required Description
message

string

 False

Describes the error encountered.
limitType

string

 False

The limit type.

NotFoundException

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

Property Type Required Description
message

string

 False

Describes the error encountered.
resourceType

string

 False

The resource type.

Template

Represents a template.

Property Type Required Description
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