Fn - Invoke

Invokes a deployed function. You can send event data, read logs and display other important information of the function invocation.

serverless invoke --function functionName

Options

  • --function or -f The name of the function in your service that you want to invoke. Required.
  • --data or -d String data to be passed as an event to your function. By default data is read from standard input.
  • --path or -p The path to a json file with input data to be passed to the invoked function. This path is relative to the root directory of the service.
  • --log or -l If set to true, it will output logging data of the invocation. Default is false.

Provided lifecycle events

  • invoke:invoke

Examples

Fn

serverless invoke --function functionName

This example will invoke your deployed function on the configured Fn Api Url endpoint. This will output the result of the invocation in your terminal.

Function invocation with data

serverless invoke --function functionName --data '{"name": "Bernie"}'

Function invocation with logging

serverless invoke --function functionName --log

Just like the first example, but will also outputs logging information about your invocation.

Function invocation with data passing

serverless invoke --function functionName --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.

Edit this page

Fn - Invoke

Invokes a deployed function. You can send event data, read logs and display other important information of the function invocation.

serverless invoke --function functionName

Options

  • --function or -f The name of the function in your service that you want to invoke. Required.
  • --data or -d String data to be passed as an event to your function. By default data is read from standard input.
  • --path or -p The path to a json file with input data to be passed to the invoked function. This path is relative to the root directory of the service.
  • --log or -l If set to true, it will output logging data of the invocation. Default is false.

Provided lifecycle events

  • invoke:invoke

Examples

Fn

serverless invoke --function functionName

This example will invoke your deployed function on the configured Fn Api Url endpoint. This will output the result of the invocation in your terminal.

Function invocation with data

serverless invoke --function functionName --data '{"name": "Bernie"}'

Function invocation with logging

serverless invoke --function functionName --log

Just like the first example, but will also outputs logging information about your invocation.

Function invocation with data passing

serverless invoke --function functionName --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.