AWS API Gateway Event

AWS API Gateway v1 proxy event with headers, params, body, and request context.

Report an issue
aws

Install

$ npx shadcn@latest add @open-types/aws-api-gateway-event

Source

export interface AWSAPIGatewayRequestIdentity {
  sourceIp: string;
  userAgent: string;
}

export interface AWSAPIGatewayRequestContext {
  accountId: string;
  apiId: string;
  httpMethod: string;
  identity: AWSAPIGatewayRequestIdentity;
  path: string;
  protocol: string;
  requestId: string;
  requestTimeEpoch: number;
  resourceId: string;
  resourcePath: string;
  stage: string;
}

export interface AWSAPIGatewayEvent {
  resource: string;
  path: string;
  httpMethod: string;
  headers: Record<string, string> | null;
  queryStringParameters: Record<string, string> | null;
  pathParameters: Record<string, string> | null;
  stageVariables: Record<string, string> | null;
  requestContext: AWSAPIGatewayRequestContext;
  body: string | null;
  isBase64Encoded: boolean;
}

export interface AWSAPIGatewayRequestIdentity {
  sourceIp: string;
  userAgent: string;
}

export interface AWSAPIGatewayRequestContext {
  accountId: string;
  apiId: string;
  httpMethod: string;
  identity: AWSAPIGatewayRequestIdentity;
  path: string;
  protocol: string;
  requestId: string;
  requestTimeEpoch: number;
  resourceId: string;
  resourcePath: string;
  stage: string;
}

export interface AWSAPIGatewayEvent {
  resource: string;
  path: string;
  httpMethod: string;
  headers: Record<string, string> | null;
  queryStringParameters: Record<string, string> | null;
  pathParameters: Record<string, string> | null;
  stageVariables: Record<string, string> | null;
  requestContext: AWSAPIGatewayRequestContext;
  body: string | null;
  isBase64Encoded: boolean;
}