Skip to content

/AWS1/CL_LMD=>PUTFUNCTIONEVENTINVOKECONFIG()

About PutFunctionEventInvokeConfig

Configures options for asynchronous invocation on a function, version, or alias. If a configuration already exists for a function, version, or alias, this operation overwrites it. If you exclude any settings, they are removed. To set one option without affecting existing settings for other options, use UpdateFunctionEventInvokeConfig.

By default, Lambda retries an asynchronous invocation twice if the function returns an error. It retains events in a queue for up to six hours. When an event fails all processing attempts or stays in the asynchronous invocation queue for too long, Lambda discards it. To retain discarded events, configure a dead-letter queue with UpdateFunctionConfiguration.

To send an invocation record to a queue, topic, function, or event bus, specify a destination. You can configure separate destinations for successful invocations (on-success) and events that fail all processing attempts (on-failure). You can configure destinations in addition to or instead of a dead-letter queue.

Method Signature

IMPORTING

Required arguments:

IV_FUNCTIONNAME TYPE /AWS1/LMDFUNCTIONNAME /AWS1/LMDFUNCTIONNAME

The name or ARN of the Lambda function, version, or alias.

Name formats

  • Function name - my-function (name-only), my-function:v1 (with alias).

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN - 123456789012:function:my-function.

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

Optional arguments:

IV_QUALIFIER TYPE /AWS1/LMDQUALIFIER /AWS1/LMDQUALIFIER

A version number or alias name.

IV_MAXIMUMRETRYATTEMPTS TYPE /AWS1/LMDMAXIMUMRETRYATTEMPTS /AWS1/LMDMAXIMUMRETRYATTEMPTS

The maximum number of times to retry when the function returns an error.

IV_MAXIMUMEVENTAGEINSECONDS TYPE /AWS1/LMDMAXEVENTAGEINSECONDS /AWS1/LMDMAXEVENTAGEINSECONDS

The maximum age of a request that Lambda sends to a function for processing.

IO_DESTINATIONCONFIG TYPE REF TO /AWS1/CL_LMDDESTINATIONCONFIG /AWS1/CL_LMDDESTINATIONCONFIG

A destination for events after they have been sent to a function for processing.

Destinations

  • Function - The Amazon Resource Name (ARN) of a Lambda function.

  • Queue - The ARN of a standard SQS queue.

  • Topic - The ARN of a standard SNS topic.

  • Event Bus - The ARN of an Amazon EventBridge event bus.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_LMDFUNCEVENTINVOKECFG /AWS1/CL_LMDFUNCEVENTINVOKECFG