Gets the RequestValidators collection of a given RestApi.
Request Syntax
GET /restapis/restapi_id/requestvalidators?limit=limit&position=position HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- limit
-
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
- position
-
The current pagination position in the paged result set.
- restapi_id
-
The string identifier of the associated RestApi.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"item": [
{
"id": "string",
"name": "string",
"validateRequestBody": boolean,
"validateRequestParameters": boolean
}
],
"position": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- item
-
The current page of elements from this collection.
Type: Array of RequestValidator objects
- position
-
The current pagination position in the paged result set.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- BadRequestException
-
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
HTTP Status Code: 400
- NotFoundException
-
The requested resource is not found. Make sure that the request URI is correct.
HTTP Status Code: 404
- TooManyRequestsException
-
The request has reached its throttling limit. Retry after the specified time period.
HTTP Status Code: 429
- UnauthorizedException
-
The request is denied because the caller has insufficient permissions.
HTTP Status Code: 401
Examples
Get the RequestValidators collection of an API
This example illustrates one usage of GetRequestValidators.
Sample Request
GET /restapis/mkhqppt4e4/requestvalidators HTTP/1.1
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20170223T172652Z
Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20170223/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Sample Response
{
"_links": {
"curies": {
"href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-requestvalidator-{rel}.html",
"name": "requestvalidator",
"templated": true
},
"self": {
"href": "/restapis/mkhqppt4e4/requestvalidators"
},
"item": [
{
"href": "/restapis/mkhqppt4e4/requestvalidators/1t3hul"
},
{
"href": "/restapis/mkhqppt4e4/requestvalidators/8sbwvf"
}
],
"requestvalidator:by-id": {
"href": "/restapis/mkhqppt4e4/requestvalidators/{requestvalidator_id}",
"templated": true
},
"requestvalidator:create": {
"href": "/restapis/mkhqppt4e4/requestvalidators"
}
},
"_embedded": {
"item": [
{
"_links": {
"self": {
"href": "/restapis/mkhqppt4e4/requestvalidators/1t3hul"
},
"request-validator-delete": {
"href": "/restapis/mkhqppt4e4/requestvalidators/1t3hul"
},
"request-validator-update": {
"href": "/restapis/mkhqppt4e4/requestvalidators/1t3hul"
}
},
"id": "1t3hul",
"name": "params-only",
"validateRequestBody": false,
"validateRequestParameters": true
},
{
"_links": {
"self": {
"href": "/restapis/mkhqppt4e4/requestvalidators/8sbwvf"
},
"request-validator-delete": {
"href": "/restapis/mkhqppt4e4/requestvalidators/8sbwvf"
},
"request-validator-update": {
"href": "/restapis/mkhqppt4e4/requestvalidators/8sbwvf"
}
},
"id": "8sbwvf",
"name": "all",
"validateRequestBody": true,
"validateRequestParameters": true
}
]
}
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
