Invoke

yaml

type: "io.kestra.plugin.aws.lambda.Invoke"

Invoke Lambda function and wait for its completion.

Examples

Invoke given Lambda function and wait for its completion.

yaml

id: aws_lambda_invoke
namespace: company.team

tasks:
  - id: invoke
    type: io.kestra.plugin.aws.lambda.Invoke
    accessKeyId: "<access-key>"
    secretKeyId: "<secret-key>"
    region: "eu-central-1"
    functionArn: "arn:aws:lambda:eu-central-1:123456789012:function:my-function"

Invoke given Lambda function with given payload parameters and wait for its completion. Payload is a map of items.

yaml

id: aws_lambda_invoke
namespace: company.team

tasks:
  - id: invoke
    type: io.kestra.plugin.aws.lambda.Invoke
    accessKeyId: "<access-key>"
    secretKeyId: "<secret-key>"
    region: "eu-central-1"
    functionArn: "arn:aws:lambda:eu-central-1:123456789012:function:my-function"
    functionPayload:
        id: 1
        firstname: "John"
        lastname: "Doe"

Properties

`functionArn`

Type: string
Dynamic: ✔️
Required: ✔️

The Lambda function name.

`accessKeyId`

Type: string
Dynamic: ✔️
Required: ❌

Access Key Id in order to connect to AWS.

If no credentials are defined, we will use the default credentials provider chain to fetch credentials.

`compatibilityMode`

Type: boolean
Dynamic: ✔️
Required: ❌

`endpointOverride`

Type: string
Dynamic: ✔️
Required: ❌

The endpoint with which the SDK should communicate.

This property allows you to use a different S3 compatible storage backend.

`functionPayload`

Type: object
Dynamic: ✔️
Required: ❌

Function request payload.

Request payload. It's a map of string -> object.

`region`

Type: string
Dynamic: ✔️
Required: ❌

AWS region with which the SDK should communicate.

`secretKeyId`

Type: string
Dynamic: ✔️
Required: ❌

Secret Key Id in order to connect to AWS.

If no credentials are defined, we will use the default credentials provider chain to fetch credentials.

`sessionToken`

Type: string
Dynamic: ✔️
Required: ❌

AWS session token, retrieved from an AWS token service, used for authenticating that this user has received temporary permissions to access a given resource.

If no credentials are defined, we will use the default credentials provider chain to fetch credentials.

`stsEndpointOverride`

Type: string
Dynamic: ✔️
Required: ❌

The AWS STS endpoint with which the SDKClient should communicate.

`stsRoleArn`

Type: string
Dynamic: ✔️
Required: ❌

AWS STS Role.

The Amazon Resource Name (ARN) of the role to assume. If set the task will use the StsAssumeRoleCredentialsProvider. If no credentials are defined, we will use the default credentials provider chain to fetch credentials.