put_function_event_invoke_config¶
Operation¶
async
¶
put_function_event_invoke_config(input: PutFunctionEventInvokeConfigInput, plugins: list[Plugin] | None = None) -> PutFunctionEventInvokeConfigOutput
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.
Note
S3 buckets are supported only for on-failure destinations. To retain records of successful invocations, use another destination type.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PutFunctionEventInvokeConfigInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
PutFunctionEventInvokeConfigOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for PutFunctionEventInvokeConfigInput structure.
Attributes¶
class-attribute
instance-attribute
¶
destination_config: DestinationConfig | None = None
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.
Note
S3 buckets are supported only for on-failure destinations. To retain records of successful invocations, use another destination type.
class-attribute
instance-attribute
¶
function_name: str | None = None
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.
class-attribute
instance-attribute
¶
maximum_event_age_in_seconds: int | None = None
The maximum age of a request that Lambda sends to a function for processing.
class-attribute
instance-attribute
¶
maximum_retry_attempts: int | None = None
The maximum number of times to retry when the function returns an error.
class-attribute
instance-attribute
¶
qualifier: str | None = None
A version number or alias name.
Output¶
dataclass
¶
Dataclass for PutFunctionEventInvokeConfigOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
destination_config: DestinationConfig | None = None
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.
Note
S3 buckets are supported only for on-failure destinations. To retain records of successful invocations, use another destination type.
class-attribute
instance-attribute
¶
function_arn: str | None = None
The Amazon Resource Name (ARN) of the function.
class-attribute
instance-attribute
¶
last_modified: datetime | None = None
The date and time that the configuration was last updated.
class-attribute
instance-attribute
¶
maximum_event_age_in_seconds: int | None = None
The maximum age of a request that Lambda sends to a function for processing.
class-attribute
instance-attribute
¶
maximum_retry_attempts: int | None = None
The maximum number of times to retry when the function returns an error.