Skip to content

Lambda  >  Operations  >  get_function_event_invoke_config

get_function_event_invoke_config

Operation

get_function_event_invoke_config async 

get_function_event_invoke_config(input: GetFunctionEventInvokeConfigInput, plugins: list[Plugin] | None = None) -> GetFunctionEventInvokeConfigOutput

Retrieves the configuration for asynchronous invocation for a function, version, or alias.

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

Parameters:

Name Type Description Default
input GetFunctionEventInvokeConfigInput

An instance of GetFunctionEventInvokeConfigInput.

 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
GetFunctionEventInvokeConfigOutput

An instance of GetFunctionEventInvokeConfigOutput.

Input

GetFunctionEventInvokeConfigInput dataclass

Dataclass for GetFunctionEventInvokeConfigInput structure.

Attributes

function_name 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.

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

A version number or alias name.

Output

GetFunctionEventInvokeConfigOutput dataclass

Dataclass for GetFunctionEventInvokeConfigOutput structure.

Attributes

destination_config 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.

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

The Amazon Resource Name (ARN) of the function.

last_modified class-attribute instance-attribute 
last_modified: datetime | None = 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 = 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 = None

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