HttpApiGateway

Index

Interfaces

• APIGatewayEventRequestContextV2
• APIGatewayProxyEventV2Schema
• APIGatewayRequestAuthorizerEventV2Schema
• RequestContextV2Http

Type Aliases

• RequestContextV2Authorizer

Variables

• APIGatewayEventRequestContextV2
• APIGatewayProxyEventV2Schema
• APIGatewayRequestAuthorizerEventV2Schema

Interfaces

APIGatewayEventRequestContextV2

APIGatewayEventRequestContextV2:

accountId

accountId: string

apiId

apiId: string

optionalauthentication

authentication?: null | { clientCert?: APIGatewayCert }

optionalauthorizer

authorizer?: RequestContextV2Authorizer

domainName

domainName: string

domainPrefix

domainPrefix: string

http

http: RequestContextV2Http

requestId

requestId: string

routeKey

routeKey: string

stage

stage: string

time

time: string

timeEpoch

timeEpoch: number

APIGatewayProxyEventV2Schema

APIGatewayProxyEventV2Schema:

optionalbody

body?: string

optionalcookies

cookies?: string[]

headers

headers: {}

Type declaration

• [k string]: string | undefined

isBase64Encoded

isBase64Encoded: boolean

optionalpathParameters

pathParameters?: null | {}

optionalqueryStringParameters

queryStringParameters?: {}

Type declaration

• [k string]: string | undefined

rawPath

rawPath: string

rawQueryString

rawQueryString: string

requestContext

requestContext: APIGatewayEventRequestContextV2

routeKey

routeKey: string

optionalstageVariables

stageVariables?: null | {}

version

version: string

APIGatewayRequestAuthorizerEventV2Schema

APIGatewayRequestAuthorizerEventV2Schema:

optionalcookies

cookies?: string[]

optionalheaders

headers?: {}

Type declaration

• [k string]: string | undefined

identitySource

identitySource: string[]

optionalpathParameters

pathParameters?: null | {}

optionalqueryStringParameters

queryStringParameters?: {}

Type declaration

• [k string]: string | undefined

rawPath

rawPath: string

rawQueryString

rawQueryString: string

requestContext

requestContext: APIGatewayEventRequestContextV2

routeArn

routeArn: string

routeKey

routeKey: string

optionalstageVariables

stageVariables?: null | {}

type

type: REQUEST

version

version: 2.0

RequestContextV2Http

RequestContextV2Http:

method

method: GET | POST | PUT | PATCH | DELETE | HEAD | OPTIONS

path

path: string

protocol

protocol: string

sourceIp

sourceIp: string

userAgent

userAgent: string

Type Aliases

RequestContextV2Authorizer

RequestContextV2Authorizer: { iam?: { accessKey?: string; accountId?: string; callerId?: string; cognitoIdentity?: { amr: string[]; identityId: string; identityPoolId: string } | null; principalOrgId?: string | null; userArn?: string; userId?: string }; jwt?: { claims: {}; scopes: string[] | null }; lambda?: {} | null } | undefined

Variables

APIGatewayEventRequestContextV2

APIGatewayEventRequestContextV2: { is: (o: unknown) => o is APIGatewayEventRequestContextV2; parse: (o: unknown) => { right: APIGatewayEventRequestContextV2 } | { left: DefinedError[] }; validate: ValidateFunction<APIGatewayEventRequestContextV2>; errors: any; schema: any }

Type declaration

• readonlyis: (o: unknown) => o is APIGatewayEventRequestContextV2

  • • (o: unknown): o is APIGatewayEventRequestContextV2

    • Parameters

      • o: unknown

      Returns o is APIGatewayEventRequestContextV2

• readonlyparse: (o: unknown) => { right: APIGatewayEventRequestContextV2 } | { left: DefinedError[] }

  • • (o: unknown): { right: APIGatewayEventRequestContextV2 } | { left: DefinedError[] }

    • Parameters

      • o: unknown

      Returns { right: APIGatewayEventRequestContextV2 } | { left: DefinedError[] }

• readonlyvalidate: ValidateFunction<APIGatewayEventRequestContextV2>

• get errors(): undefined | ErrorObject<string, Record<string, any>, unknown>[]

• get schema(): AnySchema

APIGatewayProxyEventV2Schema

APIGatewayProxyEventV2Schema: { is: (o: unknown) => o is APIGatewayProxyEventV2Schema; parse: (o: unknown) => { right: APIGatewayProxyEventV2Schema } | { left: DefinedError[] }; validate: ValidateFunction<APIGatewayProxyEventV2Schema>; errors: any; schema: any }

Type declaration

• readonlyis: (o: unknown) => o is APIGatewayProxyEventV2Schema

  • • (o: unknown): o is APIGatewayProxyEventV2Schema

    • Parameters

      • o: unknown

      Returns o is APIGatewayProxyEventV2Schema

• readonlyparse: (o: unknown) => { right: APIGatewayProxyEventV2Schema } | { left: DefinedError[] }

  • • (o: unknown): { right: APIGatewayProxyEventV2Schema } | { left: DefinedError[] }

    • Parameters

      • o: unknown

      Returns { right: APIGatewayProxyEventV2Schema } | { left: DefinedError[] }

• readonlyvalidate: ValidateFunction<APIGatewayProxyEventV2Schema>

• get errors(): undefined | ErrorObject<string, Record<string, any>, unknown>[]

• get schema(): AnySchema

APIGatewayRequestAuthorizerEventV2Schema

APIGatewayRequestAuthorizerEventV2Schema: { is: (o: unknown) => o is APIGatewayRequestAuthorizerEventV2Schema; parse: (o: unknown) => { right: APIGatewayRequestAuthorizerEventV2Schema } | { left: DefinedError[] }; validate: ValidateFunction<APIGatewayRequestAuthorizerEventV2Schema>; errors: any; schema: any }

Type declaration

• readonlyis: (o: unknown) => o is APIGatewayRequestAuthorizerEventV2Schema

  • • (o: unknown): o is APIGatewayRequestAuthorizerEventV2Schema

    • Parameters

      • o: unknown

      Returns o is APIGatewayRequestAuthorizerEventV2Schema

• readonlyparse: (o: unknown) => { right: APIGatewayRequestAuthorizerEventV2Schema } | { left: DefinedError[] }

  • • (o: unknown): { right: APIGatewayRequestAuthorizerEventV2Schema } | { left: DefinedError[] }

    • Parameters

      • o: unknown

      Returns { right: APIGatewayRequestAuthorizerEventV2Schema } | { left: DefinedError[] }

• readonlyvalidate: ValidateFunction<APIGatewayRequestAuthorizerEventV2Schema>

• get errors(): undefined | ErrorObject<string, Record<string, any>, unknown>[]

• get schema(): AnySchema