Skip to content

Get Function Event Invoke Config

lambda_get_function_event_invoke_config R Documentation

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

Description

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

To configure options for asynchronous invocation, use put_function_event_invoke_config.

Usage

lambda_get_function_event_invoke_config(FunctionName, Qualifier)

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.

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$get_function_event_invoke_config(
  FunctionName = "string",
  Qualifier = "string"
)

Examples

## Not run: 
# The following example returns the asynchronous invocation configuration
# for the BLUE alias of a function named my-function.
svc$get_function_event_invoke_config(
  FunctionName = "my-function",
  Qualifier = "BLUE"
)

## End(Not run)