RouteRequestParameter - Amazon API Gateway

RouteRequestParameter

Represents a route request parameter.

URI

/v2/apis/apiId/routes/routeId/requestparameters/requestParameterKey

HTTP methods

DELETE

Operation ID: DeleteRouteRequestParameter

Deletes a route request parameter. Supported only for WebSocket APIs.

Path parameters
NameTypeRequiredDescription
requestParameterKeyStringTrue

The route request parameter key.

apiIdStringTrue

The API identifier.

routeIdStringTrue

The route ID.

Responses
Status codeResponse modelDescription
204None

The request has succeeded, and there is no additional content to send in the response payload body.

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

{ "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.

See also

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

DeleteRouteRequestParameter