[ aws . lambda ]

get-function-event-invoke-config

Description

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

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-function-event-invoke-config
--function-name <value>
[--qualifier <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--function-name (string)

The name 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 (string)

A version number or alias name.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To view an asynchronous invocation configuration

The following get-function-event-invoke-config example retrieves the asynchronous invocation configuration for the BLUE alias of the specified function.

aws lambda get-function-event-invoke-config \
    --function-name my-function:BLUE

Output:

{
    "LastModified": 1577824396.653,
    "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:BLUE",
    "MaximumRetryAttempts": 0,
    "MaximumEventAgeInSeconds": 3600,
    "DestinationConfig": {
        "OnSuccess": {},
        "OnFailure": {
            "Destination": "arn:aws:sqs:us-east-2:123456789012:failed-invocations"
        }
    }
}

Output

LastModified -> (timestamp)

The date and time that the configuration was last updated.

FunctionArn -> (string)

The Amazon Resource Name (ARN) of the function.

MaximumRetryAttempts -> (integer)

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

MaximumEventAgeInSeconds -> (integer)

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

DestinationConfig -> (structure)

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 an SQS queue.

• Topic - The ARN of an SNS topic.

• Event Bus - The ARN of an Amazon EventBridge event bus.

OnSuccess -> (structure)

The destination configuration for successful invocations.

Destination -> (string)

The Amazon Resource Name (ARN) of the destination resource.

OnFailure -> (structure)

The destination configuration for failed invocations.

Destination -> (string)

The Amazon Resource Name (ARN) of the destination resource.