@aws-sdk/client-lambda

import { Command as $Command } from "@smithy/smithy-client"; import { BlobPayloadInputTypes, MetadataBearer as __MetadataBearer } from "@smithy/types"; import { LambdaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LambdaClient"; import { InvokeWithResponseStreamRequest, InvokeWithResponseStreamResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public */ export type InvokeWithResponseStreamCommandInputType = Omit<InvokeWithResponseStreamRequest, "Payload"> & { Payload?: BlobPayloadInputTypes; }; /** * @public * * The input for {@link InvokeWithResponseStreamCommand}. */ export interface InvokeWithResponseStreamCommandInput extends InvokeWithResponseStreamCommandInputType { } /** * @public * * The output of {@link InvokeWithResponseStreamCommand}. */ export interface InvokeWithResponseStreamCommandOutput extends InvokeWithResponseStreamResponse, __MetadataBearer { } declare const InvokeWithResponseStreamCommand_base: { new (input: InvokeWithResponseStreamCommandInput): import("@smithy/smithy-client").CommandImpl<InvokeWithResponseStreamCommandInput, InvokeWithResponseStreamCommandOutput, LambdaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; new (__0_0: InvokeWithResponseStreamCommandInput): import("@smithy/smithy-client").CommandImpl<InvokeWithResponseStreamCommandInput, InvokeWithResponseStreamCommandOutput, LambdaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** * Configure your Lambda functions to stream response payloads back to clients. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/configuration-response-streaming.html">Configuring a Lambda function to stream responses</a>. * 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, InvokeWithResponseStreamCommand } from "@aws-sdk/client-lambda"; // ES Modules import * // const { LambdaClient, InvokeWithResponseStreamCommand } = require("@aws-sdk/client-lambda"); // CommonJS import * const client = new LambdaClient(config); * const input = { // InvokeWithResponseStreamRequest * FunctionName: "STRING_VALUE", // required * InvocationType: "RequestResponse" || "DryRun", * LogType: "None" || "Tail", * ClientContext: "STRING_VALUE", * Qualifier: "STRING_VALUE", * Payload: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("") * }; * const command = new InvokeWithResponseStreamCommand(input); * const response = await client.send(command); * // { // InvokeWithResponseStreamResponse * // StatusCode: Number("int"), * // ExecutedVersion: "STRING_VALUE", * // EventStream: { // InvokeWithResponseStreamResponseEvent Union: only one key present * // PayloadChunk: { // InvokeResponseStreamUpdate * // Payload: new Uint8Array(), * // }, * // InvokeComplete: { // InvokeWithResponseStreamCompleteEvent * // ErrorCode: "STRING_VALUE", * // ErrorDetails: "STRING_VALUE", * // LogResult: "STRING_VALUE", * // }, * // }, * // ResponseStreamContentType: "STRING_VALUE", * // }; * * ``` * * @param InvokeWithResponseStreamCommandInput - {@link InvokeWithResponseStreamCommandInput} * @returns {@link InvokeWithResponseStreamCommandOutput} * @see {@link InvokeWithResponseStreamCommandInput} for command's `input` shape. * @see {@link InvokeWithResponseStreamCommandOutput} 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 */ export declare class InvokeWithResponseStreamCommand extends InvokeWithResponseStreamCommand_base { }