update_function_event_invoke_config¶
Operation¶
update_function_event_invoke_config
¶
update_function_event_invoke_config(request: UpdateFunctionEventInvokeConfigInput | UpdateFunctionEventInvokeConfigInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateFunctionEventInvokeConfigInputDict]) -> UpdateFunctionEventInvokeConfigOutput
Updates the configuration for asynchronous invocation for a function, version, or alias.
To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
UpdateFunctionEventInvokeConfigInput | UpdateFunctionEventInvokeConfigInputDict | 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[UpdateFunctionEventInvokeConfigInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UpdateFunctionEventInvokeConfigOutput
|
An instance of |
update_function_event_invoke_config
async
¶
update_function_event_invoke_config(request: UpdateFunctionEventInvokeConfigInput | UpdateFunctionEventInvokeConfigInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateFunctionEventInvokeConfigInputDict]) -> UpdateFunctionEventInvokeConfigOutput
Updates the configuration for asynchronous invocation for a function, version, or alias.
To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
UpdateFunctionEventInvokeConfigInput | UpdateFunctionEventInvokeConfigInputDict | 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[UpdateFunctionEventInvokeConfigInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UpdateFunctionEventInvokeConfigOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
UpdateFunctionEventInvokeConfigInputDict
¶
Bases: TypedDict
Dictionary form of UpdateFunctionEventInvokeConfigInput.
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
¶
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.
UpdateFunctionEventInvokeConfigInput
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateFunctionEventInvokeConfigInput 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.
Output¶
UpdateFunctionEventInvokeConfigOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateFunctionEventInvokeConfigOutput 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
¶
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.