mirror of
https://github.com/serverless/serverless.git
synced 2026-01-18 14:58:43 +00:00
49 lines
1.7 KiB
Markdown
49 lines
1.7 KiB
Markdown
# Invoke
|
|
|
|
```
|
|
serverless invoke --function functionName
|
|
```
|
|
|
|
Invokes your deployed function and outputs the results.
|
|
|
|
## Options
|
|
- `--function` or `-f` The name of the function in your service that you want to invoke. **Required**.
|
|
- `--stage` or `-s` The stage in your service you want to invoke your function in.
|
|
- `--region` or `-r` The region in your stage that you want to invoke your function in.
|
|
- `--path` or `-p` 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` or `-t` The type of invocation. Either `RequestResponse`, `Event` or `DryRun`. Default is `RequestResponse`.
|
|
- `--log` or `-l` 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
|
|
|
|
### Simple function invocation
|
|
|
|
```
|
|
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.
|