aws apigateway test-invoke-method
Simulate the execution of a Method in your RestApi with headers, parameters, and an incoming request body
Options
| Name | Description |
|---|---|
--rest-api-id <string> | [Required] The string identifier of the associated RestApi |
--resource-id <string> | [Required] Specifies a test invoke method request's resource ID |
--http-method <string> | [Required] 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 |
--multi-value-headers <map> | The headers as a map from string to list of values to simulate an incoming invocation request |
--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 |
--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 |