UNPKG

@aws-sdk/client-lambda

Version:

AWS SDK for JavaScript Lambda Client for Node.js, Browser and React Native

83 lines (82 loc) 4.59 kB
import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { LambdaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LambdaClient"; import { PutFunctionRecursionConfigRequest, PutFunctionRecursionConfigResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link PutFunctionRecursionConfigCommand}. */ export interface PutFunctionRecursionConfigCommandInput extends PutFunctionRecursionConfigRequest { } /** * @public * * The output of {@link PutFunctionRecursionConfigCommand}. */ export interface PutFunctionRecursionConfigCommandOutput extends PutFunctionRecursionConfigResponse, __MetadataBearer { } declare const PutFunctionRecursionConfigCommand_base: { new (input: PutFunctionRecursionConfigCommandInput): import("@smithy/smithy-client").CommandImpl<PutFunctionRecursionConfigCommandInput, PutFunctionRecursionConfigCommandOutput, LambdaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; new (__0_0: PutFunctionRecursionConfigCommandInput): import("@smithy/smithy-client").CommandImpl<PutFunctionRecursionConfigCommandInput, PutFunctionRecursionConfigCommandOutput, LambdaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** * <p>Sets your function's <a href="https://docs.aws.amazon.com/lambda/latest/dg/invocation-recursion.html">recursive loop detection</a> configuration.</p> * <p>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.</p> * <p>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 <code>Terminate</code>, it stops your function being invoked and notifies * you.</p> * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { LambdaClient, PutFunctionRecursionConfigCommand } from "@aws-sdk/client-lambda"; // ES Modules import * // const { LambdaClient, PutFunctionRecursionConfigCommand } = require("@aws-sdk/client-lambda"); // CommonJS import * const client = new LambdaClient(config); * const input = { // PutFunctionRecursionConfigRequest * FunctionName: "STRING_VALUE", // required * RecursiveLoop: "Allow" || "Terminate", // required * }; * const command = new PutFunctionRecursionConfigCommand(input); * const response = await client.send(command); * // { // PutFunctionRecursionConfigResponse * // RecursiveLoop: "Allow" || "Terminate", * // }; * * ``` * * @param PutFunctionRecursionConfigCommandInput - {@link PutFunctionRecursionConfigCommandInput} * @returns {@link PutFunctionRecursionConfigCommandOutput} * @see {@link PutFunctionRecursionConfigCommandInput} for command's `input` shape. * @see {@link PutFunctionRecursionConfigCommandOutput} for command's `response` shape. * @see {@link LambdaClientResolvedConfig | config} for LambdaClient's `config` shape. * * @throws {@link InvalidParameterValueException} (client fault) * <p>One of the parameters in the request is not valid.</p> * * @throws {@link ResourceConflictException} (client fault) * <p>The resource already exists, or another operation is in progress.</p> * * @throws {@link ResourceNotFoundException} (client fault) * <p>The resource specified in the request does not exist.</p> * * @throws {@link ServiceException} (server fault) * <p>The Lambda service encountered an internal error.</p> * * @throws {@link TooManyRequestsException} (client fault) * <p>The request throughput limit was exceeded. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-limits.html#api-requests">Lambda quotas</a>.</p> * * @throws {@link LambdaServiceException} * <p>Base exception class for all service exceptions from Lambda service.</p> * * @public */ export declare class PutFunctionRecursionConfigCommand extends PutFunctionRecursionConfigCommand_base { }