v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1466347371.7 KB

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.

put/2019-09-25/functions/{FunctionName}/event-invoke-config

Path parameters

FunctionNamestring required
<p>The name of the Lambda function, version, or alias.</p> <p class="title"> <b>Name formats</b> </p> <ul> <li> <p> <b>Function name</b> - <code>my-function</code> (name-only), <code>my-function:v1</code> (with alias).</p> </li> <li> <p> <b>Function ARN</b> - <code>arn:aws:lambda:us-west-2:123456789012:function:my-function</code>.</p> </li> <li> <p> <b>Partial ARN</b> - <code>123456789012:function:my-function</code>.</p> </li> </ul> <p>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.</p>

Query parameters

Qualifierstring

A version number or alias name.

Request body

MaximumRetryAttemptsinteger

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

MaximumEventAgeInSecondsinteger

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

Response

Success

LastModifiedstring date-time

The date and time that the configuration was last updated.

FunctionArnstring

The Amazon Resource Name (ARN) of the function.

MaximumRetryAttemptsinteger

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

MaximumEventAgeInSecondsinteger

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