function_event_invoke_configs

Creates, updates, deletes, gets or lists a function_event_invoke_configs resource.

Overview

Name	function_event_invoke_configs
Type	Resource
Id	aws.lambda.function_event_invoke_configs

Fields

The following fields are returned by SELECT queries:

get_function_event_invoke_config

Name	Datatype	Description
destination_config	object	A configuration object that specifies the destination of an event after Lambda processes it. For more information, see Adding a destination.
function_arn	string	The Amazon Resource Name (ARN) of the function. (pattern: <code>arn:(aws[a-zA-Z-]*)?:lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-]+(:($LATEST|[a-zA-Z0-9-]+))?</code>)
last_modified	string (date-time)	The date and time that the configuration was last updated.
maximum_event_age_in_seconds	integer	The maximum age of a request that Lambda sends to a function for processing.
maximum_retry_attempts	integer	The maximum number of times to retry when the function returns an error.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_function_event_invoke_config	select	function_name, region	Qualifier	Retrieves the configuration for asynchronous invocation for a function, version, or alias. To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.
update_function_event_invoke_config	update	function_name, region	Qualifier	Updates the configuration for asynchronous invocation for a function, version, or alias. To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.
put_function_event_invoke_config	replace	function_name, region	Qualifier	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, S3 bucket, 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. S3 buckets are supported only for on-failure destinations. To retain records of successful invocations, use another destination type.
delete_function_event_invoke_config	delete	function_name, region	Qualifier	Deletes the configuration for asynchronous invocation for a function, version, or alias. To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.
list_function_event_invoke_configs	exec	function_name, region	Marker, MaxItems	Retrieves a list of configurations for asynchronous invocation for a function. To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
function_name	string	The name or ARN of the Lambda function. Name formats Function name - my-function. Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN - 123456789012:function:my-function. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
region	string	AWS region (default: us-east-1)
Marker	string	Specify the pagination token that's returned by a previous request to retrieve the next page of results.
MaxItems	integer	The maximum number of configurations to return.
Qualifier	string	A version number or alias name.

SELECT examples

get_function_event_invoke_config

Retrieves the configuration for asynchronous invocation for a function, version, or alias. To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

SELECT
destination_config,
function_arn,
last_modified,
maximum_event_age_in_seconds,
maximum_retry_attempts
FROM aws.lambda.function_event_invoke_configs
WHERE function_name = '{{ function_name }}' -- required
AND region = '{{ region }}' -- required
AND Qualifier = '{{ Qualifier }}'
;

UPDATE examples

update_function_event_invoke_config

Updates the configuration for asynchronous invocation for a function, version, or alias. To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

UPDATE aws.lambda.function_event_invoke_configs
SET 
MaximumRetryAttempts = {{ MaximumRetryAttempts }},
MaximumEventAgeInSeconds = {{ MaximumEventAgeInSeconds }},
DestinationConfig = '{{ DestinationConfig }}'
WHERE 
function_name = '{{ function_name }}' --required
AND region = '{{ region }}' --required
AND Qualifier = '{{ Qualifier}}'
RETURNING
destination_config,
function_arn,
last_modified,
maximum_event_age_in_seconds,
maximum_retry_attempts;

REPLACE examples

put_function_event_invoke_config

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, S3 bucket, 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. S3 buckets are supported only for on-failure destinations. To retain records of successful invocations, use another destination type.

REPLACE aws.lambda.function_event_invoke_configs
SET 
MaximumRetryAttempts = {{ MaximumRetryAttempts }},
MaximumEventAgeInSeconds = {{ MaximumEventAgeInSeconds }},
DestinationConfig = '{{ DestinationConfig }}'
WHERE 
function_name = '{{ function_name }}' --required
AND region = '{{ region }}' --required
AND Qualifier = '{{ Qualifier}}'
RETURNING
destination_config,
function_arn,
last_modified,
maximum_event_age_in_seconds,
maximum_retry_attempts;

DELETE examples

delete_function_event_invoke_config

Deletes the configuration for asynchronous invocation for a function, version, or alias. To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

DELETE FROM aws.lambda.function_event_invoke_configs
WHERE function_name = '{{ function_name }}' --required
AND region = '{{ region }}' --required
AND Qualifier = '{{ Qualifier }}'
;

Lifecycle Methods

list_function_event_invoke_configs

Retrieves a list of configurations for asynchronous invocation for a function. To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

EXEC aws.lambda.function_event_invoke_configs.list_function_event_invoke_configs 
@function_name='{{ function_name }}' --required, 
@region='{{ region }}' --required, 
@Marker='{{ Marker }}', 
@MaxItems='{{ MaxItems }}'
;