Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . lambda ]

list-function-event-invoke-configs

Description

Retrieves a list of configurations for asynchronous invocation for a function.

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig .

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

list-function-event-invoke-configs is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: FunctionEventInvokeConfigs

Synopsis

  list-function-event-invoke-configs
--function-name <value>
[--max-items <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--generate-cli-skeleton <value>]

Options

--function-name (string)

The name of the Lambda function.

Name formats
  • Function name - my-function .
  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function .
  • Partial ARN - 123456789012:function:my-function .

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

--max-items (integer)

The total number of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To view a list of asynchronous invocation configurations

The following list-function-event-invoke-configs example lists the asynchronous invocation configurations for the specified function.

aws lambda list-function-event-invoke-configs \
    --function-name my-function

Output:

{
    "FunctionEventInvokeConfigs": [
        {
            "LastModified": 1577824406.719,
            "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:GREEN",
            "MaximumRetryAttempts": 2,
            "MaximumEventAgeInSeconds": 1800
        },
        {
            "LastModified": 1577824396.653,
            "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:BLUE",
            "MaximumRetryAttempts": 0,
            "MaximumEventAgeInSeconds": 3600
        }
    ]
}

Output

FunctionEventInvokeConfigs -> (list)

A list of configurations.

(structure)

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.

NextMarker -> (string)

The pagination token that's included if more results are available.