Variable APIGatewayProxyEventSchemaConst

APIGatewayProxyEventSchema: ZodObject<
    {
        body: ZodNullable<ZodString>;
        headers: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodString>>>;
        httpMethod: ZodEnum<
            ["GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "OPTIONS"],
        >;
        isBase64Encoded: ZodBoolean;
        multiValueHeaders: ZodOptional<
            ZodNullable<ZodRecord<ZodString, ZodArray<ZodString, "many">>>,
        >;
        multiValueQueryStringParameters: ZodNullable<
            ZodRecord<ZodString, ZodArray<ZodString, "many">>,
        >;
        path: ZodString;
        pathParameters: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodString>>>;
        queryStringParameters: ZodNullable<ZodRecord<ZodString, ZodString>>;
        requestContext: ZodEffects<
            ZodObject<
                {
                    accountId: ZodString;
                    apiId: ZodString;
                    authorizer: ZodOptional<
                        ZodNullable<
                            ZodUnion<
                                [
                                    ZodObject<
                                        { integrationLatency: ...; principalId: ... },
                                        "strip",
                                        ZodTypeAny,
                                        { integrationLatency: ...; principalId: ... },
                                        { integrationLatency: ...; principalId: ... },
                                    >,
                                    ZodObject<
                                        { claims: ...; scopes: ... },
                                        "strip",
                                        ZodTypeAny,
                                        { claims: ...; scopes?: ... },
                                        { claims: ...; scopes?: ... },
                                    >,
                                ],
                            >,
                        >,
                    >;
                    connectedAt: ZodOptional<ZodNullable<ZodNumber>>;
                    connectionId: ZodOptional<ZodNullable<ZodString>>;
                    deploymentId: ZodOptional<ZodNullable<ZodString>>;
                    domainName: ZodOptional<ZodNullable<ZodString>>;
                    domainPrefix: ZodOptional<ZodNullable<ZodString>>;
                    eventType: ZodOptional<
                        ZodNullable<ZodEnum<["CONNECT", "MESSAGE", "DISCONNECT"]>>,
                    >;
                    extendedRequestId: ZodOptional<ZodNullable<ZodString>>;
                    httpMethod: ZodEnum<
                        ["GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "OPTIONS"],
                    >;
                    identity: ZodObject<
                        {
                            accessKey: ZodOptional<ZodNullable<ZodString>>;
                            accountId: ZodOptional<ZodNullable<ZodString>>;
                            apiKey: ZodOptional<ZodNullable<ZodString>>;
                            apiKeyId: ZodOptional<ZodNullable<ZodString>>;
                            caller: ZodOptional<ZodNullable<ZodString>>;
                            clientCert: ZodOptional<
                                ZodNullable<
                                    ZodObject<
                                        {
                                            clientCertPem: ...;
                                            issuerDN: ...;
                                            serialNumber: ...;
                                            subjectDN: ...;
                                            validity: ...;
                                        },
                                        "strip",
                                        ZodTypeAny,
                                        {
                                            clientCertPem: ...;
                                            issuerDN: ...;
                                            serialNumber: ...;
                                            subjectDN: ...;
                                            validity: ...;
                                        },
                                        {
                                            clientCertPem: ...;
                                            issuerDN: ...;
                                            serialNumber: ...;
                                            subjectDN: ...;
                                            validity: ...;
                                        },
                                    >,
                                >,
                            >;
                            cognitoAuthenticationProvider: ZodOptional<ZodNullable<ZodString>>;
                            cognitoAuthenticationType: ZodOptional<ZodNullable<ZodString>>;
                            cognitoIdentityId: ZodOptional<ZodNullable<ZodString>>;
                            cognitoIdentityPoolId: ZodOptional<ZodNullable<ZodString>>;
                            principalOrgId: ZodOptional<ZodNullable<ZodString>>;
                            sourceIp: ZodOptional<ZodUnion<[ZodString, ZodLiteral<(...)>]>>;
                            user: ZodOptional<ZodNullable<ZodString>>;
                            userAgent: ZodOptional<ZodNullable<ZodString>>;
                            userArn: ZodOptional<ZodNullable<ZodString>>;
                        },
                        "strip",
                        ZodTypeAny,
                        {
                            accessKey?: null
                            | string;
                            accountId?: null | string;
                            apiKey?: null | string;
                            apiKeyId?: null | string;
                            caller?: null | string;
                            clientCert?:
                                | null
                                | {
                                    clientCertPem: string;
                                    issuerDN: string;
                                    serialNumber: string;
                                    subjectDN: string;
                                    validity: { notAfter: string; notBefore: string };
                                };
                            cognitoAuthenticationProvider?: null
                            | string;
                            cognitoAuthenticationType?: null | string;
                            cognitoIdentityId?: null | string;
                            cognitoIdentityPoolId?: null | string;
                            principalOrgId?: null | string;
                            sourceIp?: string;
                            user?: null | string;
                            userAgent?: null | string;
                            userArn?: null | string;
                        },
                        {
                            accessKey?: null
                            | string;
                            accountId?: null | string;
                            apiKey?: null | string;
                            apiKeyId?: null | string;
                            caller?: null | string;
                            clientCert?:
                                | null
                                | {
                                    clientCertPem: string;
                                    issuerDN: string;
                                    serialNumber: string;
                                    subjectDN: string;
                                    validity: { notAfter: string; notBefore: string };
                                };
                            cognitoAuthenticationProvider?: null
                            | string;
                            cognitoAuthenticationType?: null | string;
                            cognitoIdentityId?: null | string;
                            cognitoIdentityPoolId?: null | string;
                            principalOrgId?: null | string;
                            sourceIp?: string;
                            user?: null | string;
                            userAgent?: null | string;
                            userArn?: null | string;
                        },
                    >;
                    messageDirection: ZodOptional<ZodNullable<ZodString>>;
                    messageId: ZodOptional<ZodNullable<ZodString>>;
                    operationName: ZodOptional<ZodNullable<ZodString>>;
                    path: ZodString;
                    protocol: ZodString;
                    requestId: ZodString;
                    requestTime: ZodString;
                    requestTimeEpoch: ZodNumber;
                    resourceId: ZodOptional<ZodNullable<ZodString>>;
                    resourcePath: ZodString;
                    routeKey: ZodOptional<ZodNullable<ZodString>>;
                    stage: ZodString;
                },
                "strip",
                ZodTypeAny,
                {
                    accountId: string;
                    apiId: string;
                    authorizer?: | null
                    | { integrationLatency: number; principalId: string }
                    | { claims: Record<string, any>; scopes?: string[] };
                    connectedAt?: null | number;
                    connectionId?: null | string;
                    deploymentId?: null | string;
                    domainName?: null | string;
                    domainPrefix?: null | string;
                    eventType?: null | "CONNECT" | "MESSAGE" | "DISCONNECT";
                    extendedRequestId?: null | string;
                    httpMethod:
                        | "GET"
                        | "POST"
                        | "PUT"
                        | "PATCH"
                        | "DELETE"
                        | "HEAD"
                        | "OPTIONS";
                    identity: {
                        accessKey?: null
                        | string;
                        accountId?: null | string;
                        apiKey?: null | string;
                        apiKeyId?: null | string;
                        caller?: null | string;
                        clientCert?:
                            | null
                            | {
                                clientCertPem: string;
                                issuerDN: string;
                                serialNumber: string;
                                subjectDN: string;
                                validity: { notAfter: string; notBefore: string };
                            };
                        cognitoAuthenticationProvider?: null
                        | string;
                        cognitoAuthenticationType?: null | string;
                        cognitoIdentityId?: null | string;
                        cognitoIdentityPoolId?: null | string;
                        principalOrgId?: null | string;
                        sourceIp?: string;
                        user?: null | string;
                        userAgent?: null | string;
                        userArn?: null | string;
                    };
                    messageDirection?: null
                    | string;
                    messageId?: null | string;
                    operationName?: null | string;
                    path: string;
                    protocol: string;
                    requestId: string;
                    requestTime: string;
                    requestTimeEpoch: number;
                    resourceId?: null | string;
                    resourcePath: string;
                    routeKey?: null | string;
                    stage: string;
                },
                {
                    accountId: string;
                    apiId: string;
                    authorizer?: | null
                    | { integrationLatency: number; principalId: string }
                    | { claims: Record<string, any>; scopes?: string[] };
                    connectedAt?: null | number;
                    connectionId?: null | string;
                    deploymentId?: null | string;
                    domainName?: null | string;
                    domainPrefix?: null | string;
                    eventType?: null | "CONNECT" | "MESSAGE" | "DISCONNECT";
                    extendedRequestId?: null | string;
                    httpMethod:
                        | "GET"
                        | "POST"
                        | "PUT"
                        | "PATCH"
                        | "DELETE"
                        | "HEAD"
                        | "OPTIONS";
                    identity: {
                        accessKey?: null
                        | string;
                        accountId?: null | string;
                        apiKey?: null | string;
                        apiKeyId?: null | string;
                        caller?: null | string;
                        clientCert?:
                            | null
                            | {
                                clientCertPem: string;
                                issuerDN: string;
                                serialNumber: string;
                                subjectDN: string;
                                validity: { notAfter: string; notBefore: string };
                            };
                        cognitoAuthenticationProvider?: null
                        | string;
                        cognitoAuthenticationType?: null | string;
                        cognitoIdentityId?: null | string;
                        cognitoIdentityPoolId?: null | string;
                        principalOrgId?: null | string;
                        sourceIp?: string;
                        user?: null | string;
                        userAgent?: null | string;
                        userArn?: null | string;
                    };
                    messageDirection?: null
                    | string;
                    messageId?: null | string;
                    operationName?: null | string;
                    path: string;
                    protocol: string;
                    requestId: string;
                    requestTime: string;
                    requestTimeEpoch: number;
                    resourceId?: null | string;
                    resourcePath: string;
                    routeKey?: null | string;
                    stage: string;
                },
            >,
            {
                accountId: string;
                apiId: string;
                authorizer?: | null
                | { integrationLatency: number; principalId: string }
                | { claims: Record<string, any>; scopes?: string[] };
                connectedAt?: null | number;
                connectionId?: null | string;
                deploymentId?: null | string;
                domainName?: null | string;
                domainPrefix?: null | string;
                eventType?: null | "CONNECT" | "MESSAGE" | "DISCONNECT";
                extendedRequestId?: null | string;
                httpMethod:
                    | "GET"
                    | "POST"
                    | "PUT"
                    | "PATCH"
                    | "DELETE"
                    | "HEAD"
                    | "OPTIONS";
                identity: {
                    accessKey?: null
                    | string;
                    accountId?: null | string;
                    apiKey?: null | string;
                    apiKeyId?: null | string;
                    caller?: null | string;
                    clientCert?:
                        | null
                        | {
                            clientCertPem: string;
                            issuerDN: string;
                            serialNumber: string;
                            subjectDN: string;
                            validity: { notAfter: string; notBefore: string };
                        };
                    cognitoAuthenticationProvider?: null
                    | string;
                    cognitoAuthenticationType?: null | string;
                    cognitoIdentityId?: null | string;
                    cognitoIdentityPoolId?: null | string;
                    principalOrgId?: null | string;
                    sourceIp?: string;
                    user?: null | string;
                    userAgent?: null | string;
                    userArn?: null | string;
                };
                messageDirection?: null
                | string;
                messageId?: null | string;
                operationName?: null | string;
                path: string;
                protocol: string;
                requestId: string;
                requestTime: string;
                requestTimeEpoch: number;
                resourceId?: null | string;
                resourcePath: string;
                routeKey?: null | string;
                stage: string;
            },
            {
                accountId: string;
                apiId: string;
                authorizer?: | null
                | { integrationLatency: number; principalId: string }
                | { claims: Record<string, any>; scopes?: string[] };
                connectedAt?: null | number;
                connectionId?: null | string;
                deploymentId?: null | string;
                domainName?: null | string;
                domainPrefix?: null | string;
                eventType?: null | "CONNECT" | "MESSAGE" | "DISCONNECT";
                extendedRequestId?: null | string;
                httpMethod:
                    | "GET"
                    | "POST"
                    | "PUT"
                    | "PATCH"
                    | "DELETE"
                    | "HEAD"
                    | "OPTIONS";
                identity: {
                    accessKey?: null
                    | string;
                    accountId?: null | string;
                    apiKey?: null | string;
                    apiKeyId?: null | string;
                    caller?: null | string;
                    clientCert?:
                        | null
                        | {
                            clientCertPem: string;
                            issuerDN: string;
                            serialNumber: string;
                            subjectDN: string;
                            validity: { notAfter: string; notBefore: string };
                        };
                    cognitoAuthenticationProvider?: null
                    | string;
                    cognitoAuthenticationType?: null | string;
                    cognitoIdentityId?: null | string;
                    cognitoIdentityPoolId?: null | string;
                    principalOrgId?: null | string;
                    sourceIp?: string;
                    user?: null | string;
                    userAgent?: null | string;
                    userArn?: null | string;
                };
                messageDirection?: null
                | string;
                messageId?: null | string;
                operationName?: null | string;
                path: string;
                protocol: string;
                requestId: string;
                requestTime: string;
                requestTimeEpoch: number;
                resourceId?: null | string;
                resourcePath: string;
                routeKey?: null | string;
                stage: string;
            },
        >;
        resource: ZodString;
        stageVariables: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodString>>>;
    },
    "strip",
    ZodTypeAny,
    {
        body: null
        | string;
        headers?: null | Record<string, string>;
        httpMethod:
            | "GET"
            | "POST"
            | "PUT"
            | "PATCH"
            | "DELETE"
            | "HEAD"
            | "OPTIONS";
        isBase64Encoded: boolean;
        multiValueHeaders?: null
        | Record<string, string[]>;
        multiValueQueryStringParameters: null | Record<string, string[]>;
        path: string;
        pathParameters?: null | Record<string, string>;
        queryStringParameters: null | Record<string, string>;
        requestContext: {
            accountId: string;
            apiId: string;
            authorizer?:
                | null
                | { integrationLatency: number; principalId: string }
                | { claims: Record<string, any>; scopes?: string[] };
            connectedAt?: null | number;
            connectionId?: null | string;
            deploymentId?: null | string;
            domainName?: null | string;
            domainPrefix?: null | string;
            eventType?: null | "CONNECT" | "MESSAGE" | "DISCONNECT";
            extendedRequestId?: null | string;
            httpMethod:
                | "GET"
                | "POST"
                | "PUT"
                | "PATCH"
                | "DELETE"
                | "HEAD"
                | "OPTIONS";
            identity: {
                accessKey?: null
                | string;
                accountId?: null | string;
                apiKey?: null | string;
                apiKeyId?: null | string;
                caller?: null | string;
                clientCert?:
                    | null
                    | {
                        clientCertPem: string;
                        issuerDN: string;
                        serialNumber: string;
                        subjectDN: string;
                        validity: { notAfter: string; notBefore: string };
                    };
                cognitoAuthenticationProvider?: null
                | string;
                cognitoAuthenticationType?: null | string;
                cognitoIdentityId?: null | string;
                cognitoIdentityPoolId?: null | string;
                principalOrgId?: null | string;
                sourceIp?: string;
                user?: null | string;
                userAgent?: null | string;
                userArn?: null | string;
            };
            messageDirection?: null
            | string;
            messageId?: null | string;
            operationName?: null | string;
            path: string;
            protocol: string;
            requestId: string;
            requestTime: string;
            requestTimeEpoch: number;
            resourceId?: null | string;
            resourcePath: string;
            routeKey?: null | string;
            stage: string;
        };
        resource: string;
        stageVariables?: null
        | Record<string, string>;
    },
    {
        body: null
        | string;
        headers?: null | Record<string, string>;
        httpMethod:
            | "GET"
            | "POST"
            | "PUT"
            | "PATCH"
            | "DELETE"
            | "HEAD"
            | "OPTIONS";
        isBase64Encoded: boolean;
        multiValueHeaders?: null
        | Record<string, string[]>;
        multiValueQueryStringParameters: null | Record<string, string[]>;
        path: string;
        pathParameters?: null | Record<string, string>;
        queryStringParameters: null | Record<string, string>;
        requestContext: {
            accountId: string;
            apiId: string;
            authorizer?:
                | null
                | { integrationLatency: number; principalId: string }
                | { claims: Record<string, any>; scopes?: string[] };
            connectedAt?: null | number;
            connectionId?: null | string;
            deploymentId?: null | string;
            domainName?: null | string;
            domainPrefix?: null | string;
            eventType?: null | "CONNECT" | "MESSAGE" | "DISCONNECT";
            extendedRequestId?: null | string;
            httpMethod:
                | "GET"
                | "POST"
                | "PUT"
                | "PATCH"
                | "DELETE"
                | "HEAD"
                | "OPTIONS";
            identity: {
                accessKey?: null
                | string;
                accountId?: null | string;
                apiKey?: null | string;
                apiKeyId?: null | string;
                caller?: null | string;
                clientCert?:
                    | null
                    | {
                        clientCertPem: string;
                        issuerDN: string;
                        serialNumber: string;
                        subjectDN: string;
                        validity: { notAfter: string; notBefore: string };
                    };
                cognitoAuthenticationProvider?: null
                | string;
                cognitoAuthenticationType?: null | string;
                cognitoIdentityId?: null | string;
                cognitoIdentityPoolId?: null | string;
                principalOrgId?: null | string;
                sourceIp?: string;
                user?: null | string;
                userAgent?: null | string;
                userArn?: null | string;
            };
            messageDirection?: null
            | string;
            messageId?: null | string;
            operationName?: null | string;
            path: string;
            protocol: string;
            requestId: string;
            requestTime: string;
            requestTimeEpoch: number;
            resourceId?: null | string;
            resourcePath: string;
            routeKey?: null | string;
            stage: string;
        };
        resource: string;
        stageVariables?: null
        | Record<string, string>;
    },
> = ...

{
  "type": "REQUEST",
  "methodArn": "arn:aws:execute-api:us-east-1:123456789012:abcdef123/test/GET/request",
  "resource": "/request",
  "path": "/request",
  "httpMethod": "GET",
  "headers": {
    "X-AMZ-Date": "20170718T062915Z",
    "Accept": "application/json",
    "HeaderAuth1": "headerValue1"
  },
  "queryStringParameters": {
    "QueryString1": "queryValue1"
  },
  "pathParameters": {},
  "stageVariables": null,
  "requestContext": {
    "path": "/request",
    "accountId": "123456789012",
    "resourceId": "05c7jb",
    "stage": "test",
    "requestId": "...",
    "identity": {
      "cognitoIdentityPoolId": null,
      "accountId": null,
      "cognitoIdentityId": null,
      "caller": null,
      "sourceIp": "192.168.1.1",
      "principalOrgId": null,
      "accessKey": null,
      "cognitoAuthenticationType": null,
      "cognitoAuthenticationProvider": null,
      "userArn": null,
      "userAgent": "HTTPie/3.2.2",
      "user": null
    }
  },
  "resourcePath": "/request",
  "httpMethod": "GET",
  "apiId": "abcdef123"
}
Copy