mirror of
https://github.com/serverless/serverless.git
synced 2026-01-18 14:58:43 +00:00
Resolves https://github.com/serverless/serverless/issues/2442 1. Allow for the given `path` parameter to be an absolute path. Detect this case and do not prepend the service path in this case. 2. Update docs (including random missing apostrophe) 3. Add test to verify absolute path use
2.1 KiB
2.1 KiB
Invoke
Invokes a previously deployed function. It allows to send event data to the function and read logs and display other important information of the function invoke.
serverless invoke --function functionName
Options
--functionor-fThe name of the function in your service that you want to invoke. Required.--stageor-sThe stage in your service you want to invoke your function in.--regionor-rThe region in your stage that you want to invoke your function in.--pathor-pThe path to a json file holding input data to be passed to the invoked function. Either an absolute or relative (to the root directory of your service) may be given.--typeor-tThe type of invocation. EitherRequestResponse,EventorDryRun. Default isRequestResponse.--logor-lIf set totrueand invocation type isRequestResponse, it will output logging data of the invocation. Default isfalse.
Provided lifecycle events
invoke:invoke
Examples
AWS
serverless invoke --function functionName --stage dev --region us-east-1
This example will invoke your deployed function named functionName in region us-east-1 in stage dev. This will
output the result of the invocation in your terminal.
Function invocation with logging
serverless invoke --function functionName --stage dev --region us-east-1 --log
Just like the first example, but will also outputs logging information about your invocation.
Function invocation with data passing
serverless invoke --function functionName --stage dev --region us-east-1 --path lib/data.json
This example will pass the json data in the lib/data.json file (relative to the root of the service) while invoking
the specified/deployed function.
serverless invoke --function functionName --stage dev --region us-east-1 --path /tmp/data.json
This example will pass the json data in the /tmp/data.json file while invoking the specified/deployed function.