Note:
You are viewing the documentation for an older major version of the AWS CLI (version 1).AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
[ aws . apigateway ]
test-invoke-method¶
Description¶
Simulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body.
See also: AWS API Documentation
Synopsis¶
test-invoke-method
--rest-api-id <value>
--resource-id <value>
--http-method <value>
[--path-with-query-string <value>]
[--body <value>]
[--headers <value>]
[--multi-value-headers <value>]
[--client-certificate-id <value>]
[--stage-variables <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
Options¶
--rest-api-id (string)
The string identifier of the associated RestApi.
--resource-id (string)
Specifies a test invoke method request's resource ID.
--http-method (string)
Specifies a test invoke method request's HTTP method.
--path-with-query-string (string)
The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.
--body (string)
The simulated request body of an incoming invocation request.
--headers (map)
A key-value map of headers to simulate an incoming invocation request.
key -> (string)
value -> (string)
Shorthand Syntax:
KeyName1=string,KeyName2=string
JSON Syntax:
{"string": "string"
...}
--multi-value-headers (map)
The headers as a map from string to list of values to simulate an incoming invocation request.
key -> (string)
value -> (list)
(string)
Shorthand Syntax:
KeyName1=string,string,KeyName2=string,string
JSON Syntax:
{"string": ["string", ...]
...}
--client-certificate-id (string)
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.
--stage-variables (map)
A key-value map of stage variables to simulate an invocation on a deployed Stage.
key -> (string)
value -> (string)
Shorthand Syntax:
KeyName1=string,KeyName2=string
JSON Syntax:
{"string": "string"
...}
--cli-input-json (string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
Global Options¶
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command's default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output (string)
The formatting style for command output.
- json
- text
- table
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
- on
- off
- auto
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
Examples¶
Note
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To test invoke the root resource in an API by making a GET request
Command:
aws apigateway test-invoke-method --rest-api-id 1234123412 --resource-id avl5sg8fw8 --http-method GET --path-with-query-string '/'
To test invoke a sub-resource in an API by making a GET request with a path parameter value specified
Command:
aws apigateway test-invoke-method --rest-api-id 1234123412 --resource-id 3gapai --http-method GET --path-with-query-string '/pets/1'
Output¶
status -> (integer)
The HTTP status code.
body -> (string)
The body of the HTTP response.
headers -> (map)
The headers of the HTTP response.
key -> (string)
value -> (string)
multiValueHeaders -> (map)
The headers of the HTTP response as a map from string to list of values.
key -> (string)
value -> (list)
(string)
log -> (string)
The API Gateway execution log for the test invoke request.
latency -> (long)
The execution latency, in ms, of the test invoke request.