TestInvokeMethod - Amazon API Gateway

TestInvokeMethod

Simulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body.

Request Syntax

POST /restapis/restapi_id/resources/resource_id/methods/http_method HTTP/1.1 Content-type: application/json { "body": "string", "clientCertificateId": "string", "headers": { "string" : "string" }, "multiValueHeaders": { "string" : [ "string" ] }, "pathWithQueryString": "string", "stageVariables": { "string" : "string" } }

URI Request Parameters

The request uses the following URI parameters.

http_method

Specifies a test invoke method request's HTTP method.

Required: Yes

resource_id

Specifies a test invoke method request's resource ID.

Required: Yes

restapi_id

The string identifier of the associated RestApi.

Required: Yes

Request Body

The request accepts the following data in JSON format.

body

The simulated request body of an incoming invocation request.

Type: String

Required: No

clientCertificateId

A ClientCertificate identifier to use in the test invocation. API Gateway will use the certificate when making the HTTPS request to the defined back-end endpoint.

Type: String

Required: No

headers

A key-value map of headers to simulate an incoming invocation request.

Type: String to string map

Required: No

multiValueHeaders

The headers as a map from string to list of values to simulate an incoming invocation request.

Type: String to array of strings map

Required: No

pathWithQueryString

The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.

Type: String

Required: No

stageVariables

A key-value map of stage variables to simulate an invocation on a deployed Stage.

Type: String to string map

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "body": "string", "headers": { "string" : "string" }, "latency": number, "log": "string", "multiValueHeaders": { "string" : [ "string" ] }, "status": number }

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.

body

The body of the HTTP response.

Type: String

headers

The headers of the HTTP response.

Type: String to string map

latency

The execution latency of the test invoke request.

Type: Long

log

The API Gateway execution log for the test invoke request.

Type: String

multiValueHeaders

The headers of the HTTP response as a map from string to list of values.

Type: String to array of strings map

status

The HTTP status code.

Type: Integer

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

See Also

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