Sets your function's recursive loop detection configuration.
When you configure a Lambda function to output to the same service or resource that invokes the function, it's possible to create an infinite recursive loop. For example, a Lambda function might write a message to an Amazon Simple Queue Service (Amazon SQS) queue, which then invokes the same function. This invocation causes the function to write another message to the queue, which in turn invokes the function again.
Lambda can detect certain types of recursive loops shortly after they occur. When Lambda detects a recursive loop and your function's recursive loop detection configuration is set to Terminate
, it stops your function being invoked and notifies you.
PUT /2024-08-31/functions/FunctionName
/recursion-config HTTP/1.1
Content-type: application/json
{
"RecursiveLoop": "string
"
}
URI Request Parameters
The request uses the following URI parameters.
The name or ARN of the Lambda function.
Name formatsFunction 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.
Length Constraints: Minimum length of 1. Maximum length of 140.
Pattern: (arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)
Required: Yes
The request accepts the following data in JSON format.
If you set your function's recursive loop detection configuration to Allow
, Lambda doesn't take any action when it detects your function being invoked as part of a recursive loop. We recommend that you only use this setting if your design intentionally uses a Lambda function to write data back to the same AWS resource that invokes it.
If you set your function's recursive loop detection configuration to Terminate
, Lambda stops your function being invoked and notifies you when it detects your function being invoked as part of a recursive loop.
By default, Lambda sets your function's configuration to Terminate
.
If your design intentionally uses a Lambda function to write data back to the same AWS resource that invokes the function, then use caution and implement suitable guard rails to prevent unexpected charges being billed to your AWS account. To learn more about best practices for using recursive invocation patterns, see Recursive patterns that cause run-away Lambda functions in Serverless Land.
Type: String
Valid Values: Allow | Terminate
Required: Yes
HTTP/1.1 200
Content-type: application/json
{
"RecursiveLoop": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
The status of your function's recursive loop detection configuration.
When this value is set to Allow
and Lambda detects your function being invoked as part of a recursive loop, it doesn't take any action.
When this value is set to Terminate
and Lambda detects your function being invoked as part of a recursive loop, it stops your function being invoked and notifies you.
Type: String
Valid Values: Allow | Terminate
For information about the errors that are common to all actions, see Common Errors.
One of the parameters in the request is not valid.
HTTP Status Code: 400
The resource already exists, or another operation is in progress.
HTTP Status Code: 409
The resource specified in the request does not exist.
HTTP Status Code: 404
The AWS Lambda service encountered an internal error.
HTTP Status Code: 500
The request throughput limit was exceeded. For more information, see Lambda quotas.
HTTP Status Code: 429
For more information about using this API in one of the language-specific AWS SDKs, see the following:
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4