UpdateFunctionEventInvokeConfigCommand

Updates the configuration for asynchronous invocation for a function, version, or alias.

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

Example Syntax

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

import { LambdaClient, UpdateFunctionEventInvokeConfigCommand } from "@aws-sdk/client-lambda"; // ES Modules import
// const { LambdaClient, UpdateFunctionEventInvokeConfigCommand } = require("@aws-sdk/client-lambda"); // CommonJS import
const client = new LambdaClient(config);
const input = { // UpdateFunctionEventInvokeConfigRequest
  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 UpdateFunctionEventInvokeConfigCommand(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",
//     },
//   },
// };

Example Usage

There was an error loading the code editor. Retry

UpdateFunctionEventInvokeConfigCommand Input

See UpdateFunctionEventInvokeConfigCommandInput for more details

Parameter	Type	Description
`FunctionName` Required	`string \| undefined`	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.
`DestinationConfig`	`DestinationConfig \| undefined`	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. Bucket - The ARN of an Amazon S3 bucket. Topic - The ARN of a standard SNS topic. Event Bus - The ARN of an Amazon EventBridge event bus. S3 buckets are supported only for on-failure destinations. To retain records of successful invocations, use another destination type.
`MaximumEventAgeInSeconds`	`number \| undefined`	The maximum age of a request that Lambda sends to a function for processing.
`MaximumRetryAttempts`	`number \| undefined`	The maximum number of times to retry when the function returns an error.
`Qualifier`	`string \| undefined`	A version number or alias name.

UpdateFunctionEventInvokeConfigCommand Output

See UpdateFunctionEventInvokeConfigCommandOutput for details

Parameter	Type	Description
`$metadata` Required	`ResponseMetadata`	Metadata pertaining to this request.
`DestinationConfig`	`DestinationConfig \| undefined`	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. Bucket - The ARN of an Amazon S3 bucket. Topic - The ARN of a standard SNS topic. Event Bus - The ARN of an Amazon EventBridge event bus. S3 buckets are supported only for on-failure destinations. To retain records of successful invocations, use another destination type.
`FunctionArn`	`string \| undefined`	The Amazon Resource Name (ARN) of the function.
`LastModified`	`Date \| undefined`	The date and time that the configuration was last updated.
`MaximumEventAgeInSeconds`	`number \| undefined`	The maximum age of a request that Lambda sends to a function for processing.
`MaximumRetryAttempts`	`number \| undefined`	The maximum number of times to retry when the function returns an error.

Throws

Name	Fault	Details
InvalidParameterValueException	client	One of the parameters in the request is not valid.
ResourceConflictException	client	The resource already exists, or another operation is in progress.
ResourceNotFoundException	client	The resource specified in the request does not exist.
ServiceException	server	The Lambda service encountered an internal error.
TooManyRequestsException	client	The request throughput limit was exceeded. For more information, see Lambda quotas .
LambdaServiceException		Base exception class for all service exceptions from Lambda service.

Getting Started

References