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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Name | Type | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
requestParameterKey | String | True | The route request parameter key. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
apiId | String | True | The API identifier. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
routeId | String | True | The route ID. |
Responses | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Status code | Response model | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
204 | None | The request has succeeded, and there is no additional content to send in the response payload body. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
{ "message": "string", "resourceType": "string" }
Properties
LimitExceededException
A limit has been exceeded. See the accompanying error message for details.
Property | Type | Required | Description |
---|---|---|---|
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.
Property | Type | Required | Description |
---|---|---|---|
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: