Skip to content

put_function_event_invoke_config

Operation

put_function_event_invoke_config

put_function_event_invoke_config(request: PutFunctionEventInvokeConfigInput | PutFunctionEventInvokeConfigInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[PutFunctionEventInvokeConfigInputDict]) -> 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
request PutFunctionEventInvokeConfigInput | PutFunctionEventInvokeConfigInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[PutFunctionEventInvokeConfigInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
PutFunctionEventInvokeConfigOutput

An instance of PutFunctionEventInvokeConfigOutput.

put_function_event_invoke_config async

put_function_event_invoke_config(request: PutFunctionEventInvokeConfigInput | PutFunctionEventInvokeConfigInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[PutFunctionEventInvokeConfigInputDict]) -> 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
request PutFunctionEventInvokeConfigInput | PutFunctionEventInvokeConfigInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[PutFunctionEventInvokeConfigInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
PutFunctionEventInvokeConfigOutput

An instance of PutFunctionEventInvokeConfigOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

PutFunctionEventInvokeConfigInputDict

Bases: TypedDict

Dictionary form of PutFunctionEventInvokeConfigInput.

Attributes

destination_config instance-attribute
destination_config: DestinationConfig | DestinationConfigDict | 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.

function_name instance-attribute
function_name: Required[str]

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.

maximum_event_age_in_seconds instance-attribute
maximum_event_age_in_seconds: int | None

The maximum age of a request that Lambda sends to a function for processing.

maximum_retry_attempts instance-attribute
maximum_retry_attempts: int | None

The maximum number of times to retry when the function returns an error.

qualifier instance-attribute
qualifier: str | None

A version number or alias name.

PutFunctionEventInvokeConfigInput dataclass

Bases: _SerdeShape

Dataclass for PutFunctionEventInvokeConfigInput structure.

Attributes

destination_config class-attribute instance-attribute
destination_config: DestinationConfig | 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.

function_name class-attribute instance-attribute
function_name: str | 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.

maximum_event_age_in_seconds class-attribute instance-attribute
maximum_event_age_in_seconds: int | None = ...

The maximum age of a request that Lambda sends to a function for processing.

maximum_retry_attempts class-attribute instance-attribute
maximum_retry_attempts: int | None = ...

The maximum number of times to retry when the function returns an error.

qualifier class-attribute instance-attribute
qualifier: str | None = ...

A version number or alias name.

Output

PutFunctionEventInvokeConfigOutput dataclass

Bases: _SerdeShape

Dataclass for PutFunctionEventInvokeConfigOutput structure.

Attributes

destination_config class-attribute instance-attribute
destination_config: DestinationConfig | 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.

function_arn class-attribute instance-attribute
function_arn: str | None = ...

The Amazon Resource Name (ARN) of the function.

last_modified class-attribute instance-attribute
last_modified: datetime | None = ...

The date and time that the configuration was last updated.

maximum_event_age_in_seconds class-attribute instance-attribute
maximum_event_age_in_seconds: int | None = ...

The maximum age of a request that Lambda sends to a function for processing.

maximum_retry_attempts class-attribute instance-attribute
maximum_retry_attempts: int | None = ...

The maximum number of times to retry when the function returns an error.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.