serverless
Version:
Serverless Framework - Build web, mobile and IoT applications with serverless architectures using AWS Lambda, Azure Functions, Google CloudFunctions & more
73 lines (48 loc) • 2.12 kB
Markdown
<!--
title: Serverless Framework Commands - Kubeless - Invoke
menuText: invoke
menuOrder: 3
description: Invoke an Kubeless Function using the Serverless Framework
layout: Doc
-->
<!-- DOCS-SITE-LINK:START automatically generated -->
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/kubeless/cli-reference/invoke)
<!-- DOCS-SITE-LINK:END -->
# Kubeless - Invoke
Invokes deployed function. It allows to send event data to the function, read logs and display other important information of the function invocation.
```bash
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
### Kubeless
```bash
serverless invoke --function functionName
```
This example will invoke your deployed function on the configured platform
endpoint. This will output the result of the invocation in your terminal.
#### Function invocation with data
```bash
serverless invoke --function functionName --data '{"name": "Bernie"}'
```
#### Function invocation with data from standard input
```bash
node dataGenerator.js | serverless invoke --function functionName
```
#### Function invocation with logging
```bash
serverless invoke --function functionName --log
```
Just like the first example, but will also outputs logging information about your invocation.
#### Function invocation with data passing
```bash
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.