ListFunctionEventInvokeConfigsCommand

Suggest an Edit

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

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { LambdaClient, ListFunctionEventInvokeConfigsCommand } from "@aws-sdk/client-lambda"; // ES Modules import
// const { LambdaClient, ListFunctionEventInvokeConfigsCommand } = require("@aws-sdk/client-lambda"); // CommonJS import
const client = new LambdaClient(config);
const input = { // ListFunctionEventInvokeConfigsRequest
  FunctionName: "STRING_VALUE", // required
  Marker: "STRING_VALUE",
  MaxItems: Number("int"),
};
const command = new ListFunctionEventInvokeConfigsCommand(input);
const response = await client.send(command);
// { // ListFunctionEventInvokeConfigsResponse
//   FunctionEventInvokeConfigs: [ // FunctionEventInvokeConfigList
//     { // FunctionEventInvokeConfig
//       LastModified: new Date("TIMESTAMP"),
//       FunctionArn: "STRING_VALUE",
//       MaximumRetryAttempts: Number("int"),
//       MaximumEventAgeInSeconds: Number("int"),
//       DestinationConfig: { // DestinationConfig
//         OnSuccess: { // OnSuccess
//           Destination: "STRING_VALUE",
//         },
//         OnFailure: { // OnFailure
//           Destination: "STRING_VALUE",
//         },
//       },
//     },
//   ],
//   NextMarker: "STRING_VALUE",
// };

Example Usage

 Loading code editor

ListFunctionEventInvokeConfigsCommand Input

See ListFunctionEventInvokeConfigsCommandInput for more details

Parameter
Type
Description
FunctionName
Required
string | undefined

The name or ARN 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.

Marker
string | undefined

Specify the pagination token that's returned by a previous request to retrieve the next page of results.

MaxItems
number | undefined

The maximum number of configurations to return.

ListFunctionEventInvokeConfigsCommand Output

See ListFunctionEventInvokeConfigsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
FunctionEventInvokeConfigs
FunctionEventInvokeConfig[] | undefined

A list of configurations.

NextMarker
string | undefined

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

Throws

Name
Fault
Details
InvalidParameterValueException
client

One of the parameters in the request is not valid.

ResourceNotFoundException
client

The resource specified in the request does not exist.

ServiceException
server

The Lambda service encountered an internal error.

TooManyRequestsException
client

The request throughput limit was exceeded. For more information, see Lambda quotas .

LambdaServiceException
Base exception class for all service exceptions from Lambda service.