Lambda / Client / put_function_event_invoke_config

put_function_event_invoke_config#

Lambda.Client.put_function_event_invoke_config(**kwargs)#

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.

Request Syntax

response = client.put_function_event_invoke_config(
    FunctionName='string',
    Qualifier='string',
    MaximumRetryAttempts=123,
    MaximumEventAgeInSeconds=123,
    DestinationConfig={
        'OnSuccess': {
            'Destination': 'string'
        },
        'OnFailure': {
            'Destination': 'string'
        }
    }
)

Parameters:

FunctionName (string) –
[REQUIRED]

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.
Qualifier (string) – A version number or alias name.
MaximumRetryAttempts (integer) – The maximum number of times to retry when the function returns an error.
MaximumEventAgeInSeconds (integer) – The maximum age of a request that Lambda sends to a function for processing.
DestinationConfig (dict) –
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.
- OnSuccess (dict) –
  
  The destination configuration for successful invocations.
  - Destination (string) –
    
    The Amazon Resource Name (ARN) of the destination resource.
- OnFailure (dict) –
  
  The destination configuration for failed invocations.
  - Destination (string) –
    
    The Amazon Resource Name (ARN) of the destination resource.
    
    To retain records of asynchronous invocations, you can configure an Amazon SNS topic, Amazon SQS queue, Lambda function, or Amazon EventBridge event bus as the destination.
    
    To retain records of failed invocations from Kinesis and DynamoDB event sources, you can configure an Amazon SNS topic or Amazon SQS queue as the destination.
    
    To retain records of failed invocations from self-managed Kafka or Amazon MSK, you can configure an Amazon SNS topic, Amazon SQS queue, or Amazon S3 bucket as the destination.

Return type:

dict

Returns:

Response Syntax

{
    'LastModified': datetime(2015, 1, 1),
    'FunctionArn': 'string',
    'MaximumRetryAttempts': 123,
    'MaximumEventAgeInSeconds': 123,
    'DestinationConfig': {
        'OnSuccess': {
            'Destination': 'string'
        },
        'OnFailure': {
            'Destination': 'string'
        }
    }
}

Response Structure

(dict) –
- LastModified (datetime) –
  
  The date and time that the configuration was last updated.
- FunctionArn (string) –
  
  The Amazon Resource Name (ARN) of the function.
- MaximumRetryAttempts (integer) –
  
  The maximum number of times to retry when the function returns an error.
- MaximumEventAgeInSeconds (integer) –
  
  The maximum age of a request that Lambda sends to a function for processing.
- DestinationConfig (dict) –
  
  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.
  - OnSuccess (dict) –
    
    The destination configuration for successful invocations.
    - Destination (string) –
      
      The Amazon Resource Name (ARN) of the destination resource.
  - OnFailure (dict) –
    
    The destination configuration for failed invocations.
    - Destination (string) –
      
      The Amazon Resource Name (ARN) of the destination resource.
      
      To retain records of asynchronous invocations, you can configure an Amazon SNS topic, Amazon SQS queue, Lambda function, or Amazon EventBridge event bus as the destination.
      
      To retain records of failed invocations from Kinesis and DynamoDB event sources, you can configure an Amazon SNS topic or Amazon SQS queue as the destination.
      
      To retain records of failed invocations from self-managed Kafka or Amazon MSK, you can configure an Amazon SNS topic, Amazon SQS queue, or Amazon S3 bucket as the destination.

Exceptions

Lambda.Client.exceptions.ServiceException
Lambda.Client.exceptions.ResourceNotFoundException
Lambda.Client.exceptions.InvalidParameterValueException
Lambda.Client.exceptions.TooManyRequestsException
Lambda.Client.exceptions.ResourceConflictException

Examples

The following example sets a maximum event age of one hour and disables retries for the specified function.

response = client.put_function_event_invoke_config(
    FunctionName='my-function',
    MaximumEventAgeInSeconds=3600,
    MaximumRetryAttempts=0,
)

print(response)

Expected Output:

{
    'DestinationConfig': {
        'OnFailure': {
        },
        'OnSuccess': {
        },
    },
    'FunctionArn': 'arn:aws:lambda:us-east-2:123456789012:function:my-function:$LATEST',
    'LastModified': datetime(2016, 11, 21, 19, 49, 20, 0, 326, 0),
    'MaximumEventAgeInSeconds': 3600,
    'MaximumRetryAttempts': 0,
    'ResponseMetadata': {
        '...': '...',
    },
}