@aws-sdk/client-lambda

import { Command as $Command } from "@smithy/smithy-client"; import { BlobPayloadInputTypes, MetadataBearer as __MetadataBearer } from "@smithy/types"; import { Uint8ArrayBlobAdapter } from "@smithy/util-stream"; import { LambdaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LambdaClient"; import { InvocationRequest, InvocationResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public */ export type InvokeCommandInputType = Omit<InvocationRequest, "Payload"> & { Payload?: BlobPayloadInputTypes; }; /** * @public * * The input for {@link InvokeCommand}. */ export interface InvokeCommandInput extends InvokeCommandInputType { } /** * @public */ export type InvokeCommandOutputType = Omit<InvocationResponse, "Payload"> & { Payload?: Uint8ArrayBlobAdapter; }; /** * @public * * The output of {@link InvokeCommand}. */ export interface InvokeCommandOutput extends InvokeCommandOutputType, __MetadataBearer { } declare const InvokeCommand_base: { new (input: InvokeCommandInput): import("@smithy/smithy-client").CommandImpl<InvokeCommandInput, InvokeCommandOutput, LambdaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; new (__0_0: InvokeCommandInput): import("@smithy/smithy-client").CommandImpl<InvokeCommandInput, InvokeCommandOutput, LambdaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** * Invokes a Lambda function. You can invoke a function synchronously (and wait for the response), or * asynchronously. By default, Lambda invokes your function synchronously (i.e. the<code>InvocationType</code> * is <code>RequestResponse</code>). To invoke a function asynchronously, set <code>InvocationType</code> to * <code>Event</code>. Lambda passes the <code>ClientContext</code> object to your function for * synchronous invocations only. * For <a href="https://docs.aws.amazon.com/lambda/latest/dg/invocation-sync.html">synchronous invocation</a>, * details about the function response, including errors, are included in the response body and headers. For either * invocation type, you can find more information in the <a href="https://docs.aws.amazon.com/lambda/latest/dg/monitoring-functions.html">execution log</a> and <a href="https://docs.aws.amazon.com/lambda/latest/dg/lambda-x-ray.html">trace</a>. * When an error occurs, your function may be invoked multiple times. Retry behavior varies by error type, * client, event source, and invocation type. For example, if you invoke a function asynchronously and it returns an * error, Lambda executes the function up to two more times. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/invocation-retries.html">Error handling and automatic retries in * Lambda</a>. * For <a href="https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html">asynchronous invocation</a>, * Lambda adds events to a queue before sending them to your function. If your function does not have enough capacity * to keep up with the queue, events may be lost. Occasionally, your function may receive the same event multiple * times, even if no error occurs. To retain events that were not processed, configure your function with a <a href="https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq">dead-letter queue</a>. * The status code in the API response doesn't reflect function errors. Error codes are reserved for errors that * prevent your function from executing, such as permissions errors, <a href="https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-limits.html">quota</a> errors, or issues with your function's code and * configuration. For example, Lambda returns <code>TooManyRequestsException</code> if running the * function would cause you to exceed a concurrency limit at either the account level * (<code>ConcurrentInvocationLimitExceeded</code>) or function level * (<code>ReservedFunctionConcurrentInvocationLimitExceeded</code>). * For functions with a long timeout, your client might disconnect during synchronous invocation while it waits * for a response. Configure your HTTP client, SDK, firewall, proxy, or operating system to allow for long * connections with timeout or keep-alive settings. * This operation requires permission for the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/list_awslambda.html">lambda:InvokeFunction</a> action. For details on how to set up * permissions for cross-account invocations, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/access-control-resource-based.html#permissions-resource-xaccountinvoke">Granting function * access to other accounts</a>. * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { LambdaClient, InvokeCommand } from "@aws-sdk/client-lambda"; // ES Modules import * // const { LambdaClient, InvokeCommand } = require("@aws-sdk/client-lambda"); // CommonJS import * const client = new LambdaClient(config); * const input = { // InvocationRequest * FunctionName: "STRING_VALUE", // required * InvocationType: "Event" || "RequestResponse" || "DryRun", * LogType: "None" || "Tail", * ClientContext: "STRING_VALUE", * Payload: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("") * Qualifier: "STRING_VALUE", * }; * const command = new InvokeCommand(input); * const response = await client.send(command); * // { // InvocationResponse * // StatusCode: Number("int"), * // FunctionError: "STRING_VALUE", * // LogResult: "STRING_VALUE", * // Payload: new Uint8Array(), * // ExecutedVersion: "STRING_VALUE", * // }; * * ``` * * @param InvokeCommandInput - {@link InvokeCommandInput} * @returns {@link InvokeCommandOutput} * @see {@link InvokeCommandInput} for command's `input` shape. * @see {@link InvokeCommandOutput} for command's `response` shape. * @see {@link LambdaClientResolvedConfig | config} for LambdaClient's `config` shape. * * @throws {@link EC2AccessDeniedException} (server fault) * Need additional permissions to configure VPC settings. * * @throws {@link EC2ThrottledException} (server fault) * Amazon EC2 throttled Lambda during Lambda function initialization using * the execution role provided for the function. * * @throws {@link EC2UnexpectedException} (server fault) * Lambda received an unexpected Amazon EC2 client exception while setting up for the * Lambda function. * * @throws {@link EFSIOException} (client fault) * An error occurred when reading from or writing to a connected file system. * * @throws {@link EFSMountConnectivityException} (client fault) * The Lambda function couldn't make a network connection to the configured file system. * * @throws {@link EFSMountFailureException} (client fault) * The Lambda function couldn't mount the configured file system due to a permission or configuration * issue. * * @throws {@link EFSMountTimeoutException} (client fault) * The Lambda function made a network connection to the configured file system, but the mount * operation timed out. * * @throws {@link ENILimitReachedException} (server fault) * Lambda couldn't create an elastic network interface in the VPC, specified as part of Lambda function configuration, because the limit for network interfaces has been reached. For more * information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-limits.html">Lambda * quotas</a>. * * @throws {@link InvalidParameterValueException} (client fault) * One of the parameters in the request is not valid. * * @throws {@link InvalidRequestContentException} (client fault) * The request body could not be parsed as JSON. * * @throws {@link InvalidRuntimeException} (server fault) * The runtime or runtime version specified is not supported. * * @throws {@link InvalidSecurityGroupIDException} (server fault) * The security group ID provided in the Lambda function VPC configuration is not valid. * * @throws {@link InvalidSubnetIDException} (server fault) * The subnet ID provided in the Lambda function VPC configuration is not valid. * * @throws {@link InvalidZipFileException} (server fault) * Lambda could not unzip the deployment package. * * @throws {@link KMSAccessDeniedException} (server fault) * Lambda couldn't decrypt the environment variables because KMS access was denied. * Check the Lambda function's KMS permissions. * * @throws {@link KMSDisabledException} (server fault) * Lambda couldn't decrypt the environment variables because the KMS key used is * disabled. Check the Lambda function's KMS key settings. * * @throws {@link KMSInvalidStateException} (server fault) * Lambda couldn't decrypt the environment variables because the state of the KMS key used is not valid for Decrypt. Check the function's KMS key settings. * * @throws {@link KMSNotFoundException} (server fault) * Lambda couldn't decrypt the environment variables because the KMS key was not * found. Check the function's KMS key settings. * * @throws {@link RecursiveInvocationException} (client fault) * Lambda has detected your function being invoked in a recursive loop with other Amazon Web Services resources and stopped your function's invocation. * * @throws {@link RequestTooLargeException} (client fault) * The request payload exceeded the <code>Invoke</code> request body JSON input quota. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-limits.html">Lambda * quotas</a>. * * @throws {@link ResourceConflictException} (client fault) * The resource already exists, or another operation is in progress. * * @throws {@link ResourceNotFoundException} (client fault) * The resource specified in the request does not exist. * * @throws {@link ResourceNotReadyException} (server fault) * The function is inactive and its VPC connection is no longer available. Wait for the VPC connection to * reestablish and try again. * * @throws {@link ServiceException} (server fault) * The Lambda service encountered an internal error. * * @throws {@link SnapStartException} (client fault) * The <code>afterRestore()</code> * <a href="https://docs.aws.amazon.com/lambda/latest/dg/snapstart-runtime-hooks.html">runtime hook</a> encountered an error. For more information, check the Amazon CloudWatch logs. * * @throws {@link SnapStartNotReadyException} (client fault) * Lambda is initializing your function. You can invoke the function when the <a href="https://docs.aws.amazon.com/lambda/latest/dg/functions-states.html">function state</a> becomes <code>Active</code>. * * @throws {@link SnapStartTimeoutException} (client fault) * Lambda couldn't restore the snapshot within the timeout limit. * * @throws {@link SubnetIPAddressLimitReachedException} (server fault) * Lambda couldn't set up VPC access for the Lambda function because one or more * configured subnets has no available IP addresses. * * @throws {@link TooManyRequestsException} (client fault) * 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>. * * @throws {@link UnsupportedMediaTypeException} (client fault) * The content type of the <code>Invoke</code> request body is not JSON. * * @throws {@link LambdaServiceException} * Base exception class for all service exceptions from Lambda service. * * @public * @example To invoke a Lambda function * ```javascript * // The following example invokes version 1 of a function named my-function with an empty event payload. * const input = { * "FunctionName": "my-function", * "Payload": "{}", * "Qualifier": "1" * }; * const command = new InvokeCommand(input); * const response = await client.send(command); * /* response == * { * "Payload": "200 SUCCESS", * "StatusCode": 200 * } * *\/ * // example id: to-invoke-a-lambda-function-1481659683915 * ``` * * @example To invoke a Lambda function asynchronously * ```javascript * // The following example invokes version 1 of a function named my-function asynchronously. * const input = { * "FunctionName": "my-function", * "InvocationType": "Event", * "Payload": "{}", * "Qualifier": "1" * }; * const command = new InvokeCommand(input); * const response = await client.send(command); * /* response == * { * "Payload": "", * "StatusCode": 202 * } * *\/ * // example id: to-invoke-a-lambda-function-async-1481659683915 * ``` * */ export declare class InvokeCommand extends InvokeCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: InvocationRequest; output: InvocationResponse; }; sdk: { input: InvokeCommandInput; output: InvokeCommandOutput; }; }; }