Put Function Event Invoke Config

lambda_put_function_event_invoke_config

R Documentation

Configures options for asynchronous invocation on a function, version, or alias¶

Description¶

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

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

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.

Usage¶

lambda_put_function_event_invoke_config(FunctionName, Qualifier,
  MaximumRetryAttempts, MaximumEventAgeInSeconds, DestinationConfig)

Arguments¶

FunctionName

[required] 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

A version number or alias name.

MaximumRetryAttempts

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

MaximumEventAgeInSeconds

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

DestinationConfig

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.

S3 buckets are supported only for on-failure destinations. To retain records of successful invocations, use another destination type.

Value¶

A list with the following syntax:

list(
  LastModified = as.POSIXct(
    "2015-01-01"
  ),
  FunctionArn = "string",
  MaximumRetryAttempts = 123,
  MaximumEventAgeInSeconds = 123,
  DestinationConfig = list(
    OnSuccess = list(
      Destination = "string"
    ),
    OnFailure = list(
      Destination = "string"
    )
  )
)

Request syntax¶

svc$put_function_event_invoke_config(
  FunctionName = "string",
  Qualifier = "string",
  MaximumRetryAttempts = 123,
  MaximumEventAgeInSeconds = 123,
  DestinationConfig = list(
    OnSuccess = list(
      Destination = "string"
    ),
    OnFailure = list(
      Destination = "string"
    )
  )
)

Examples¶

## Not run: 
# The following example sets a maximum event age of one hour and disables
# retries for the specified function.
svc$put_function_event_invoke_config(
  FunctionName = "my-function",
  MaximumEventAgeInSeconds = 3600L,
  MaximumRetryAttempts = 0L
)

## End(Not run)