Class PutFunctionEventInvokeConfigCommandProtected

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.

Example

Use a bare-bones client and the command you need to make an API call.

import { LambdaClient, PutFunctionEventInvokeConfigCommand } from "@aws-sdk/client-lambda"; // ES Modules import
// const { LambdaClient, PutFunctionEventInvokeConfigCommand } = require("@aws-sdk/client-lambda"); // CommonJS import
const client = new LambdaClient(config);
const input = { // PutFunctionEventInvokeConfigRequest
  FunctionName: "STRING_VALUE", // required
  Qualifier: "STRING_VALUE",
  MaximumRetryAttempts: Number("int"),
  MaximumEventAgeInSeconds: Number("int"),
  DestinationConfig: { // DestinationConfig
    OnSuccess: { // OnSuccess
      Destination: "STRING_VALUE",
    },
    OnFailure: { // OnFailure
      Destination: "STRING_VALUE",
    },
  },
};
const command = new PutFunctionEventInvokeConfigCommand(input);
const response = await client.send(command);
// { // FunctionEventInvokeConfig
//   LastModified: new Date("TIMESTAMP"),
//   FunctionArn: "STRING_VALUE",
//   MaximumRetryAttempts: Number("int"),
//   MaximumEventAgeInSeconds: Number("int"),
//   DestinationConfig: { // DestinationConfig
//     OnSuccess: { // OnSuccess
//       Destination: "STRING_VALUE",
//     },
//     OnFailure: { // OnFailure
//       Destination: "STRING_VALUE",
//     },
//   },
// };

Param

PutFunctionEventInvokeConfigCommandInput

Returns

PutFunctionEventInvokeConfigCommandOutput

See

• PutFunctionEventInvokeConfigCommandInput for command's input shape.
• PutFunctionEventInvokeConfigCommandOutput for command's response shape.
• config for LambdaClient's config shape.

Throws

InvalidParameterValueException (client fault)

One of the parameters in the request is not valid.

Throws

ResourceConflictException (client fault)

The resource already exists, or another operation is in progress.

Throws

ResourceNotFoundException (client fault)

The resource specified in the request does not exist.

Throws

ServiceException (server fault)

The Lambda service encountered an internal error.

Throws

TooManyRequestsException (client fault)

The request throughput limit was exceeded. For more information, see Lambda quotas.

Throws

LambdaServiceException

Base exception class for all service exceptions from Lambda service.