mirror of
https://github.com/serverless/serverless.git
synced 2026-01-18 14:58:43 +00:00
fba685d8b1
- removed erroneous statement about "context and event properties" in mock event data files - added example data.json @TODO: the `invoke` docs should be the main source of truth here, the `invoke local` docs should describe *only what's different from invoke* and defer to `invoke` for the rest. Duplicating across the two files is not ideal.
98 lines
3.4 KiB
Markdown
98 lines
3.4 KiB
Markdown
<!--
|
|
title: Serverless Framework Commands - AWS Lambda - Invoke
|
|
menuText: invoke
|
|
menuOrder: 8
|
|
description: Invoke an AWS Lambda 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/aws/cli-reference/invoke)
|
|
<!-- DOCS-SITE-LINK:END -->
|
|
|
|
# AWS - 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 [local] --function functionName
|
|
```
|
|
|
|
## 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.
|
|
- `--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.
|
|
- `--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`
|
|
|
|
|
|
# Invoke Local
|
|
|
|
Invokes a function locally for testing and logs the output. You can only invoke Node.js runtime locally at the moment. Keep in mind that we mock the `context` with simple mock data.
|
|
|
|
```bash
|
|
serverless invoke local --function functionName
|
|
```
|
|
|
|
## Options
|
|
- `--function` or `-f` The name of the function in your service that you want to invoke locally. **Required**.
|
|
- `--path` or `-p` The path to a json file holding input data to be passed to the invoked function as the `event`. This path is relative to the
|
|
root directory of the service.
|
|
- `--data` or `-d` String data to be passed as an event to your function. Keep in mind that if you pass both `--path` and `--data`, the data included in the `--path` file will overwrite the data you passed with the `--data` flag.
|
|
|
|
## Examples
|
|
|
|
### AWS
|
|
|
|
```bash
|
|
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 data
|
|
|
|
```bash
|
|
serverless invoke --function functionName --stage dev --region us-east-1 --data "hello world"
|
|
```
|
|
|
|
#### Function invocation with data from standard input
|
|
|
|
```bash
|
|
node dataGenerator.js | serverless invoke --function functionName --stage dev --region us-east-1
|
|
```
|
|
|
|
#### Function invocation with logging
|
|
|
|
```bash
|
|
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
|
|
|
|
```bash
|
|
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.
|
|
|
|
#### Example `data.json`
|
|
|
|
```json
|
|
{
|
|
"resource": "/",
|
|
"path": "/",
|
|
"httpMethod": "GET",
|
|
// etc. //
|
|
}
|
|
```
|