# PutFunctionEventInvokeConfig
<a name="API_PutFunctionEventInvokeConfig"></a>

Configures options for [asynchronous invocation](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html) 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](API_UpdateFunctionEventInvokeConfig.md).

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](API_UpdateFunctionConfiguration.md).

To send an invocation record to a queue, topic, S3 bucket, function, or event bus, specify a [destination](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-async-destinations). 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.

**Note**  
S3 buckets are supported only for on-failure destinations. To retain records of successful invocations, use another destination type.

## Request Syntax
<a name="API_PutFunctionEventInvokeConfig_RequestSyntax"></a>

```
PUT /2019-09-25/functions/FunctionName/event-invoke-config?Qualifier=Qualifier HTTP/1.1
Content-type: application/json

{
   "DestinationConfig": { 
      "OnFailure": { 
         "Destination": "string"
      },
      "OnSuccess": { 
         "Destination": "string"
      }
   },
   "MaximumEventAgeInSeconds": number,
   "MaximumRetryAttempts": number
}
```

## URI Request Parameters
<a name="API_PutFunctionEventInvokeConfig_RequestParameters"></a>

The request uses the following URI parameters.

 ** [FunctionName](#API_PutFunctionEventInvokeConfig_RequestSyntax) **   <a name="lambda-PutFunctionEventInvokeConfig-request-uri-FunctionName"></a>
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.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_\.]+)(:(\$LATEST(\.PUBLISHED)?|[a-zA-Z0-9-_]+))?`   
Required: Yes

 ** [Qualifier](#API_PutFunctionEventInvokeConfig_RequestSyntax) **   <a name="lambda-PutFunctionEventInvokeConfig-request-uri-Qualifier"></a>
A version number or alias name.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `\$(LATEST(\.PUBLISHED)?)|[a-zA-Z0-9-_$]+` 

## Request Body
<a name="API_PutFunctionEventInvokeConfig_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [DestinationConfig](#API_PutFunctionEventInvokeConfig_RequestSyntax) **   <a name="lambda-PutFunctionEventInvokeConfig-request-DestinationConfig"></a>
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.
Type: [DestinationConfig](API_DestinationConfig.md) object  
Required: No

 ** [MaximumEventAgeInSeconds](#API_PutFunctionEventInvokeConfig_RequestSyntax) **   <a name="lambda-PutFunctionEventInvokeConfig-request-MaximumEventAgeInSeconds"></a>
The maximum age of a request that Lambda sends to a function for processing.  
Type: Integer  
Valid Range: Minimum value of 60. Maximum value of 21600.  
Required: No

 ** [MaximumRetryAttempts](#API_PutFunctionEventInvokeConfig_RequestSyntax) **   <a name="lambda-PutFunctionEventInvokeConfig-request-MaximumRetryAttempts"></a>
The maximum number of times to retry when the function returns an error.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 2.  
Required: No

## Response Syntax
<a name="API_PutFunctionEventInvokeConfig_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "DestinationConfig": { 
      "OnFailure": { 
         "Destination": "string"
      },
      "OnSuccess": { 
         "Destination": "string"
      }
   },
   "FunctionArn": "string",
   "LastModified": number,
   "MaximumEventAgeInSeconds": number,
   "MaximumRetryAttempts": number
}
```

## Response Elements
<a name="API_PutFunctionEventInvokeConfig_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [DestinationConfig](#API_PutFunctionEventInvokeConfig_ResponseSyntax) **   <a name="lambda-PutFunctionEventInvokeConfig-response-DestinationConfig"></a>
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.
Type: [DestinationConfig](API_DestinationConfig.md) object

 ** [FunctionArn](#API_PutFunctionEventInvokeConfig_ResponseSyntax) **   <a name="lambda-PutFunctionEventInvokeConfig-response-FunctionArn"></a>
The Amazon Resource Name (ARN) of the function.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 10000.  
Pattern: `arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(:(\$LATEST|[a-zA-Z0-9-_]+))?` 

 ** [LastModified](#API_PutFunctionEventInvokeConfig_ResponseSyntax) **   <a name="lambda-PutFunctionEventInvokeConfig-response-LastModified"></a>
The date and time that the configuration was last updated, in Unix time seconds.  
Type: Timestamp

 ** [MaximumEventAgeInSeconds](#API_PutFunctionEventInvokeConfig_ResponseSyntax) **   <a name="lambda-PutFunctionEventInvokeConfig-response-MaximumEventAgeInSeconds"></a>
The maximum age of a request that Lambda sends to a function for processing.  
Type: Integer  
Valid Range: Minimum value of 60. Maximum value of 21600.

 ** [MaximumRetryAttempts](#API_PutFunctionEventInvokeConfig_ResponseSyntax) **   <a name="lambda-PutFunctionEventInvokeConfig-response-MaximumRetryAttempts"></a>
The maximum number of times to retry when the function returns an error.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 2.

## Errors
<a name="API_PutFunctionEventInvokeConfig_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidParameterValueException **   
One of the parameters in the request is not valid.    
 ** message **   
The exception message.  
 ** Type **   
The exception type.
HTTP Status Code: 400

 ** ResourceConflictException **   
The resource already exists, or another operation is in progress.    
 ** message **   
The exception message.  
 ** Type **   
The exception type.
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The resource specified in the request does not exist.  
HTTP Status Code: 404

 ** ServiceException **   
The AWS Lambda service encountered an internal error.  
HTTP Status Code: 500

 ** TooManyRequestsException **   
The request throughput limit was exceeded. For more information, see [Lambda quotas](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-limits.html#api-requests).    
 ** retryAfterSeconds **   
The number of seconds the caller should wait before retrying.
HTTP Status Code: 429

## See Also
<a name="API_PutFunctionEventInvokeConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lambda-2015-03-31/PutFunctionEventInvokeConfig) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lambda-2015-03-31/PutFunctionEventInvokeConfig) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/PutFunctionEventInvokeConfig) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lambda-2015-03-31/PutFunctionEventInvokeConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/PutFunctionEventInvokeConfig) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lambda-2015-03-31/PutFunctionEventInvokeConfig) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lambda-2015-03-31/PutFunctionEventInvokeConfig) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/PutFunctionEventInvokeConfig) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/PutFunctionEventInvokeConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/PutFunctionEventInvokeConfig)