Stone.js API
    Preparing search index...

    Interface AwsLambdaHttpEvent

    Represents the structure of an AWS Lambda HTTP event across every supported trigger: API Gateway REST (payload v1), API Gateway HTTP API and Lambda Function URLs (payload v2), and Application Load Balancer (ALB). Every field is optional because each trigger populates a different subset; use normalizeHttpEvent to reduce it to a canonical shape.

    interface AwsLambdaHttpEvent {
        body?: unknown;
        cookies?: string[];
        encoding?: string;
        headers?: Record<string, string>;
        httpMethod?: string;
        isBase64Encoded?: boolean;
        multiValueHeaders?: Record<string, string[]>;
        multiValueQueryStringParameters?: Record<string, string[]>;
        path?: string;
        queryStringParameters?: Record<string, string>;
        rawPath?: string;
        rawQueryString?: string;
        requestContext?: {
            elb?: unknown;
            http?: { method?: string; path?: string; sourceIp?: string };
            httpMethod?: string;
            identity?: { sourceIp?: string };
        };
        version?: string;
        [key: string]: unknown;
    }

    Hierarchy

    • Record<string, unknown>
      • AwsLambdaHttpEvent

    Indexable

    • [key: string]: unknown
    Index
    body? cookies? encoding? headers? httpMethod? isBase64Encoded? multiValueHeaders? multiValueQueryStringParameters? path? queryStringParameters? rawPath? rawQueryString? requestContext? version?

    Optionalbody

    body?: unknown

    The body of the HTTP request.

    cookies?: string[]

    Raw cookie strings (v2 / Function URLs).

    encoding?: string

    The encoding format of the body, such as base64.

    headers?: Record<string, string>

    The headers of the HTTP request as key-value pairs (may be null/absent on some triggers).

    httpMethod?: string

    The HTTP method of the request (v1/ALB).

    isBase64Encoded?: boolean

    Indicates whether the request body is base64-encoded.

    multiValueHeaders?: Record<string, string[]>

    Multi-value headers (v1 / ALB with multi-value enabled).

    multiValueQueryStringParameters?: Record<string, string[]>

    The multi-value query string parameters (v1 / ALB with multi-value enabled).

    path?: string

    The path of the HTTP request (v1/ALB).

    queryStringParameters?: Record<string, string>

    The single-value query string parameters.

    rawPath?: string

    The raw path of the HTTP request (v2).

    rawQueryString?: string

    The raw query string, without leading ? (v2).

    requestContext?: {
        elb?: unknown;
        http?: { method?: string; path?: string; sourceIp?: string };
        httpMethod?: string;
        identity?: { sourceIp?: string };
    }

    The request context, whose shape varies by trigger.

    version?: string

    Payload format version, e.g. '1.0' (REST) or '2.0' (HTTP API / Function URL).

    Settings
    Member Visibility

    On This Page
    Properties