Amazon API Gateway
API Reference

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

RouteResponses

Represents the collection of responses for a route.

URI

/v2/apis/apiId/routes/routeId/routeresponses

HTTP Methods

GET

Operation ID: GetRouteResponses

Gets the RouteResponses for a Route.

Path Parameters

Name Type Required Description
routeId String True

The route ID.

apiId String True

The API identifier.

Query Parameters

Name Type Required Description
nextToken String False

The next page of elements from this collection. Not valid for the last element of the collection.

maxResults String False

The maximum number of elements to be returned for this resource.

Responses

Status Code Response Model Description
200 RouteResponses

Success

400 BadRequestException

One of the parameters in the request is invalid.

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.

POST

Operation ID: CreateRouteResponse

Creates a RouteResponse for a Route.

Path Parameters

Name Type Required Description
apiId String True

The API identifier.

routeId String True

The route ID.

Responses

Status Code Response Model Description
201 RouteResponse

The request has succeeded and has resulted in the creation of a resource.

400 BadRequestException

One of the parameters in the request is invalid.

404 NotFoundException

The resource specified in the request was not found.

409 ConflictException

The resource already exists.

429 LimitExceededException

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

Schemas

Request Bodies

Example POST

{ "routeResponseKey": "string", "responseParameters": { }, "responseModels": { }, "modelSelectionExpression": "string" }

Response Bodies

Example RouteResponses

{ "items": [ { "routeResponseId": "string", "routeResponseKey": "string", "responseParameters": { }, "responseModels": { }, "modelSelectionExpression": "string" } ], "nextToken": "string" }

Example RouteResponse

{ "routeResponseId": "string", "routeResponseKey": "string", "responseParameters": { }, "responseModels": { }, "modelSelectionExpression": "string" }

Example BadRequestException

{ "message": "string" }

Example NotFoundException

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

Example ConflictException

{ "message": "string" }

Example LimitExceededException

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

Properties

BadRequestException

The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

Property Type Required Description
message

string

False

Describes the error encountered.

ConflictException

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.

Property Type Required Description
message

string

False

Describes the error encountered.

CreateRouteResponseInput

Represents the input parameters for an CreateRouteResponse request.

Property Type Required Description
routeResponseKey

string

True

The route response key.

responseParameters

RouteParameters

False

The route response parameters.

responseModels

RouteModels

False

The response models for the route response.

modelSelectionExpression

string

False

The model selection expression for the route response.

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.

ParameterConstraints

Validation constraints imposed on parameters of a request (path, query string, headers).

Property Type Required Description
required

boolean

False

Whether or not the parameter is required.

RouteModels

The route models.

Property Type Required Description

*

string

False

RouteParameters

The route parameters.

Property Type Required Description

*

object

False

RouteResponse

Represents a route response.

Property Type Required Description
routeResponseId

string

False

Represents the identifier of a route response.

routeResponseKey

string

True

Represents the route response key of a route response.

responseParameters

RouteParameters

False

Represents the response parameters of a route response.

responseModels

RouteModels

False

Represents the response models of a route response.

modelSelectionExpression

string

False

Represents the model selection expression of a route response.

RouteResponses

Represents a collection of route responses.

Property Type Required Description
items

Array of type RouteResponse

False

The elements from this collection.

nextToken

string

False

The next page of elements from this collection. Not valid for the last element of the collection.

See Also

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

GetRouteResponses

CreateRouteResponse