RestApiGateway

Index

Interfaces

• APIGatewayEventIdentity
• APIGatewayEventRequestContext
• APIGatewayProxyEventSchema
• APIGatewayRequestAuthorizerEventSchema
• APIGatewayTokenAuthorizerEventSchema

Variables

• APIGatewayEventRequestContext
• APIGatewayProxyEventSchema
• APIGatewayRequestAuthorizerEventSchema
• APIGatewayTokenAuthorizerEventSchema

Interfaces

APIGatewayEventIdentity

APIGatewayEventIdentity:

optionalaccessKey

accessKey?: null | string

optionalaccountId

accountId?: null | string

optionalapiKey

apiKey?: null | string

optionalapiKeyId

apiKeyId?: null | string

optionalcaller

caller?: null | string

optionalclientCert

clientCert?: null | APIGatewayCert

optionalcognitoAuthenticationProvider

cognitoAuthenticationProvider?: null | string

optionalcognitoAuthenticationType

cognitoAuthenticationType?: null | string

optionalcognitoIdentityId

cognitoIdentityId?: null | string

optionalcognitoIdentityPoolId

cognitoIdentityPoolId?: null | string

optionalprincipalOrgId

principalOrgId?: null | string

optionalsourceIp

sourceIp?: string

optionaluser

user?: null | string

optionaluserAgent

userAgent?: null | string

optionaluserArn

userArn?: null | string

APIGatewayEventRequestContext

APIGatewayEventRequestContext:

accountId

accountId: string

apiId

apiId: string

optionalauthorizer

authorizer?: null | { integrationLatency: number; principalId: string } | { claims: {}; scopes?: string[] }

optionalconnectedAt

connectedAt?: null | number

optionalconnectionId

connectionId?: null | string

optionaldeploymentId

deploymentId?: null | string

optionaldomainName

domainName?: null | string

optionaldomainPrefix

domainPrefix?: null | string

optionaleventType

eventType?: null | CONNECT | MESSAGE | DISCONNECT

optionalextendedRequestId

extendedRequestId?: null | string

httpMethod

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

identity

identity: APIGatewayEventIdentity

optionalmessageDirection

messageDirection?: null | string

optionalmessageId

messageId?: null | string

optionaloperationName

operationName?: null | string

path

path: string

protocol

protocol: string

requestId

requestId: string

requestTime

requestTime: string

requestTimeEpoch

requestTimeEpoch: number

optionalresourceId

resourceId?: null | string

resourcePath

resourcePath: string

optionalrouteKey

routeKey?: null | string

stage

stage: string

APIGatewayProxyEventSchema

APIGatewayProxyEventSchema:

body

body: null | string

optionalheaders

headers?: APIGatewayRecord

httpMethod

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

isBase64Encoded

isBase64Encoded: boolean

optionalmultiValueHeaders

multiValueHeaders?: null | {}

multiValueQueryStringParameters

multiValueQueryStringParameters: null | {}

path

path: string

optionalpathParameters

pathParameters?: null | {}

queryStringParameters

queryStringParameters: null | {}

requestContext

requestContext: APIGatewayEventRequestContext

resource

resource: string

optionalstageVariables

stageVariables?: null | {}

APIGatewayRequestAuthorizerEventSchema

APIGatewayRequestAuthorizerEventSchema:

optionalapiId

apiId?: string

optionaldeploymentId

deploymentId?: string

optionaldomainName

domainName?: string

headers

headers: {}

Type declaration

• [k string]: string | undefined

httpMethod

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

methodArn

methodArn: string

multiValueHeaders

multiValueHeaders: {}

Type declaration

• [k string]: string[] | undefined

multiValueQueryStringParameters

multiValueQueryStringParameters: {}

Type declaration

• [k string]: string[] | undefined

path

path: string

pathParameters

pathParameters: {}

Type declaration

• [k string]: string | undefined

queryStringParameters

queryStringParameters: {}

Type declaration

• [k string]: string | undefined

requestContext

requestContext: APIGatewayEventRequestContext

resource

resource: string

stageVariables

stageVariables: {}

Type declaration

• [k string]: string | undefined

type

type: REQUEST

APIGatewayTokenAuthorizerEventSchema

APIGatewayTokenAuthorizerEventSchema:

authorizationToken

authorizationToken: string

methodArn

methodArn: string

type

type: TOKEN

Variables

APIGatewayEventRequestContext

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

Type declaration

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

  • • (o: unknown): o is APIGatewayEventRequestContext

    • Parameters

      • o: unknown

      Returns o is APIGatewayEventRequestContext

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

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

    • Parameters

      • o: unknown

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

• readonlyvalidate: ValidateFunction<APIGatewayEventRequestContext>

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

• get schema(): AnySchema

APIGatewayProxyEventSchema

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

Type declaration

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

  • • (o: unknown): o is APIGatewayProxyEventSchema

    • Parameters

      • o: unknown

      Returns o is APIGatewayProxyEventSchema

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

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

    • Parameters

      • o: unknown

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

• readonlyvalidate: ValidateFunction<APIGatewayProxyEventSchema>

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

• get schema(): AnySchema

APIGatewayRequestAuthorizerEventSchema

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

Type declaration

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

  • • (o: unknown): o is APIGatewayRequestAuthorizerEventSchema

    • Parameters

      • o: unknown

      Returns o is APIGatewayRequestAuthorizerEventSchema

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

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

    • Parameters

      • o: unknown

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

• readonlyvalidate: ValidateFunction<APIGatewayRequestAuthorizerEventSchema>

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

• get schema(): AnySchema

APIGatewayTokenAuthorizerEventSchema

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

Type declaration

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

  • • (o: unknown): o is APIGatewayTokenAuthorizerEventSchema

    • Parameters

      • o: unknown

      Returns o is APIGatewayTokenAuthorizerEventSchema

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

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

    • Parameters

      • o: unknown

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

• readonlyvalidate: ValidateFunction<APIGatewayTokenAuthorizerEventSchema>

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

• get schema(): AnySchema