Interface APIGatewayProxyEvent

interface APIGatewayProxyEvent {
    body: null | string;
    headers: APIGatewayProxyEventHeaders;
    httpMethod: string;
    isBase64Encoded: boolean;
    multiValueHeaders: APIGatewayProxyEventMultiValueHeaders;
    multiValueQueryStringParameters: null | APIGatewayProxyEventMultiValueQueryStringParameters;
    path: string;
    pathParameters: null | APIGatewayProxyEventPathParameters;
    queryStringParameters: null | APIGatewayProxyEventQueryStringParameters;
    requestContext: {
        accountId: string;
        apiId: string;
        authorizer: null | {
            [k: string]: unknown | undefined;
        };
        connectedAt?: number;
        connectionId?: string;
        domainName?: string;
        domainPrefix?: string;
        eventType?: string;
        extendedRequestId?: string;
        httpMethod: string;
        identity: APIGatewayEventIdentity;
        messageDirection?: string;
        messageId: null | string;
        path: string;
        protocol: string;
        requestId: string;
        requestTime?: string;
        requestTimeEpoch: number;
        resourceId: string;
        resourcePath: string;
        routeKey?: string;
        stage: string;
    };
    resource: string;
    stageVariables: null | APIGatewayProxyEventStageVariables;
}

Properties

body headers httpMethod isBase64Encoded multiValueHeaders multiValueQueryStringParameters path pathParameters queryStringParameters requestContext resource stageVariables

Properties

body

body: null | string

headers

headers: APIGatewayProxyEventHeaders

httpMethod

httpMethod: string

isBase64Encoded

isBase64Encoded: boolean

multiValueHeaders

multiValueHeaders: APIGatewayProxyEventMultiValueHeaders

multiValueQueryStringParameters

multiValueQueryStringParameters: null | APIGatewayProxyEventMultiValueQueryStringParameters

path

path: string

pathParameters

pathParameters: null | APIGatewayProxyEventPathParameters

queryStringParameters

queryStringParameters: null | APIGatewayProxyEventQueryStringParameters

requestContext

requestContext: {
    accountId: string;
    apiId: string;
    authorizer: null | {
        [k: string]: unknown | undefined;
    };
    connectedAt?: number;
    connectionId?: string;
    domainName?: string;
    domainPrefix?: string;
    eventType?: string;
    extendedRequestId?: string;
    httpMethod: string;
    identity: APIGatewayEventIdentity;
    messageDirection?: string;
    messageId: null | string;
    path: string;
    protocol: string;
    requestId: string;
    requestTime?: string;
    requestTimeEpoch: number;
    resourceId: string;
    resourcePath: string;
    routeKey?: string;
    stage: string;
}

Type declaration

  • accountId: string
  • apiId: string
  • authorizer: null | {
        [k: string]: unknown | undefined;
    }
  • Optional connectedAt?: number
  • Optional connectionId?: string
  • Optional domainName?: string
  • Optional domainPrefix?: string
  • Optional eventType?: string
  • Optional extendedRequestId?: string
  • httpMethod: string
  • identity: APIGatewayEventIdentity
  • Optional messageDirection?: string
  • messageId: null | string
  • path: string
  • protocol: string
  • requestId: string
  • Optional requestTime?: string
  • requestTimeEpoch: number
  • resourceId: string
  • resourcePath: string
  • Optional routeKey?: string
  • stage: string

resource

resource: string

stageVariables

stageVariables: null | APIGatewayProxyEventStageVariables

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc