archive-gh-me/serverless
1
0
Fork 0
mirror of https://github.com/serverless/serverless.git synced 2025-12-08 19:46:03 +00:00
Code Issues Projects Releases Wiki Activity
serverless/lib/plugins/invoke/README.md
Philipp Muens cf7028677b Refactor docs structure 
Each plugin now has a README.md file in it's root folder. The docs/README.md file
links to each plugins index folder so that the user can directly see the plugins folder structure
and the corresponding README.md file at once. This makes understanding the plugin way easier.
2016-06-17 08:43:51 +02:00

1.6 KiB
Raw Blame History

Invoke

serverless invoke --function functionName --stage dev --region us-east-1

Invokes your deployed function and outputs the results.

Options

  • --function The name of the function in your service that you want to invoke. Required.
  • --stage The stage in your service you want to invoke your function in. Required.
  • --region The region in your stage that you want to invoke your function in. Required.
  • --path The path to a json file holding input data to be passed to the invoked function. This path is relative to the root directory of the service.
  • --type The type of invocation. Either RequestResponse, Event or DryRun. Default is RequestResponse.
  • --log If set to true and invocation type is RequestResponse, it will output logging data of the invocation. Default is false.

Provided lifecycle events

  • invoke:invoke

Examples

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.

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.

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.