Options
All
  • Public
  • Public/Protected
  • All
Menu

@types/aws-lambda

Index

Interfaces

Type aliases

Type aliases

ALBCallback

ALBCallback: Callback<ALBResult>

ALBHandler

ALBHandler: Handler<ALBEvent, ALBResult>

APIGatewayAuthorizerCallback

APIGatewayAuthorizerCallback: Callback<APIGatewayAuthorizerResult>

APIGatewayAuthorizerEvent

APIGatewayAuthorizerHandler

APIGatewayAuthorizerWithContextCallback

APIGatewayAuthorizerWithContextCallback<TAuthorizerContext>: Callback<APIGatewayAuthorizerWithContextResult<TAuthorizerContext>>

Type parameters

APIGatewayAuthorizerWithContextHandler

APIGatewayAuthorizerWithContextHandler<TAuthorizerContext>: Handler<APIGatewayAuthorizerEvent, APIGatewayAuthorizerWithContextResult<TAuthorizerContext>>

Type parameters

APIGatewayEvent

APIGatewayEvent: APIGatewayProxyEvent

APIGatewayEventDefaultAuthorizerContext

APIGatewayEventDefaultAuthorizerContext: undefined | null | {}

APIGatewayEventLambdaAuthorizerContext

APIGatewayEventLambdaAuthorizerContext<TAuthorizerContext>: {[ P in keyof TAuthorizerContext]: TAuthorizerContext[P] extends null ? null : string } & { integrationLatency: number; principalId: string }

Type parameters

  • TAuthorizerContext

APIGatewayEventRequestContext

APIGatewayProxyCallback

APIGatewayProxyCallback: Callback<APIGatewayProxyResult>

Works with Lambda Proxy Integration for Rest API or HTTP API integration Payload Format version 1.0

see

APIGatewayProxyCallbackV2

APIGatewayProxyCallbackV2: Callback<APIGatewayProxyResultV2>

APIGatewayProxyEvent

Works with Lambda Proxy Integration for Rest API or HTTP API integration Payload Format version 1.0

see

APIGatewayProxyHandler

Works with Lambda Proxy Integration for Rest API or HTTP API integration Payload Format version 1.0

see

APIGatewayProxyHandlerV2

APIGatewayProxyHandlerV2<T>: Handler<APIGatewayProxyEventV2, APIGatewayProxyResultV2<T>>

Type parameters

  • T = never

APIGatewayProxyResultV2

APIGatewayProxyResultV2<T>: APIGatewayProxyStructuredResultV2 | string | T

Type parameters

  • T = never

APIGatewayProxyWithCognitoAuthorizerEvent

APIGatewayProxyWithCognitoAuthorizerEvent: APIGatewayProxyEventBase<APIGatewayProxyCognitoAuthorizer>

APIGatewayProxyWithCognitoAuthorizerHandler

APIGatewayProxyWithCognitoAuthorizerHandler: Handler<APIGatewayProxyWithCognitoAuthorizerEvent, APIGatewayProxyResult>

APIGatewayProxyWithLambdaAuthorizerEvent

APIGatewayProxyWithLambdaAuthorizerEvent<TAuthorizerContext>: APIGatewayProxyEventBase<APIGatewayEventLambdaAuthorizerContext<TAuthorizerContext>>

Type parameters

  • TAuthorizerContext

APIGatewayProxyWithLambdaAuthorizerEventRequestContext

APIGatewayProxyWithLambdaAuthorizerEventRequestContext<TAuthorizerContext>: APIGatewayEventRequestContextWithAuthorizer<APIGatewayEventLambdaAuthorizerContext<TAuthorizerContext>>

Type parameters

  • TAuthorizerContext

APIGatewayProxyWithLambdaAuthorizerHandler

APIGatewayProxyWithLambdaAuthorizerHandler<TAuthorizerContext>: Handler<APIGatewayProxyWithLambdaAuthorizerEvent<TAuthorizerContext>, APIGatewayProxyResult>

Type parameters

  • TAuthorizerContext

APIGatewayRequestAuthorizerHandler

APIGatewayRequestAuthorizerWithContextHandler

APIGatewayRequestAuthorizerWithContextHandler<TAuthorizerContext>: Handler<APIGatewayRequestAuthorizerEvent, APIGatewayAuthorizerWithContextResult<TAuthorizerContext>>

Type parameters

APIGatewayTokenAuthorizerHandler

APIGatewayTokenAuthorizerWithContextHandler

APIGatewayTokenAuthorizerWithContextHandler<TAuthorizerContext>: Handler<APIGatewayTokenAuthorizerEvent, APIGatewayAuthorizerWithContextResult<TAuthorizerContext>>

Type parameters

AccountTakeOverActionType

AccountTakeOverActionType: "BLOCK" | "NO_ACTION" | "MFA" | "MFA_IF_CONFIGURED" | "MFA_REQUIRED"

AppSyncResolverHandler

AppSyncResolverHandler<T, V>: Handler<AppSyncResolverEvent<T>, V | V[]>

Type parameters

  • T

  • V

ArtifactLocation

ArtifactLocation: S3ArtifactStore

AuthResponse

AuthResponseContext

Callback

Callback<TResult>: (error?: Error | string | null, result?: TResult) => void

Type parameters

  • TResult = any

Type declaration

    • (error?: Error | string | null, result?: TResult): void
    • NodeJS-style callback parameter for the Handler type. Can be used instead of returning a promise, see the AWS documentation for the handler programming model.

      Parameters

      • Optional error: Error | string | null

        Parameter to use to provide the error payload for a failed lambda execution. See AWS documentation for error handling. If an Error instance is passed, the error payload uses the name property as the errorType, the message property as the errorMessage, and parses the stack property string into the trace array. For other values, the errorType is typeof value, the errorMessage is String(value), and trace is an empty array.

      • Optional result: TResult

        Parameter to use to provide the result payload for a successful lambda execution. Pass null or undefined for the error parameter to use this parameter.

      Returns void

CloudFormationCustomResourceEvent

CloudFormationCustomResourceHandler

CloudFormationCustomResourceHandler: Handler<CloudFormationCustomResourceEvent, void>

CloudFormationCustomResourceResponse

CloudFrontOrigin

CloudFrontOrigin: { custom?: never; s3: CloudFrontS3Origin } | { custom: CloudFrontCustomOrigin; s3?: never }

CloudFrontRequestCallback

CloudFrontRequestCallback: Callback<CloudFrontRequestResult>

CloudFrontRequestHandler

CloudFrontRequestResult

CloudFrontRequestResult: undefined | null | CloudFrontResultResponse | CloudFrontRequest

CloudFrontResponseCallback

CloudFrontResponseCallback: Callback<CloudFrontResponseResult>

CloudFrontResponseHandler

CloudFrontResponseResult

CloudFrontResponseResult: undefined | null | CloudFrontResultResponse

CloudWatchLogsHandler

CloudWatchLogsHandler: Handler<CloudWatchLogsEvent, void>

CodeBuildCacheType

CodeBuildCacheType: "NO_CACHE" | "LOCAL" | "S3"

CodeBuildCloudWatchStateHandler

CodeBuildCloudWatchStateHandler: EventBridgeHandler<"CodeBuild Build State Change", CodeBuildStateEventDetail, void>

CodeBuildEnvironmentComputeType

CodeBuildEnvironmentComputeType: "BUILD_GENERAL1_SMALL" | "BUILD_GENERAL1_MEDIUM" | "BUILD_GENERAL1_LARGE" | "BUILD_GENERAL1_2XLARGE"

CodeBuildEnvironmentPullCredentialsType

CodeBuildEnvironmentPullCredentialsType: "CODEBUILD" | "SERVICE_ROLE"

CodeBuildEnvironmentType

CodeBuildEnvironmentType: "LINUX_CONTAINER" | "LINUX_GPU_CONTAINER" | "WINDOWS_CONTAINER" | "ARM_CONTAINER"

CodeBuildEnvironmentVariableType

CodeBuildEnvironmentVariableType: "PARAMETER_STORE" | "PLAINTEXT" | "SECRETS_MANAGER"

CodeBuildPhaseStatusType

CodeBuildPhaseStatusType: "TIMED_OUT" | "STOPPED" | "FAILED" | "SUCCEEDED" | "FAULT" | "CLIENT_ERROR"

CodeBuildPhaseType

CodeBuildPhaseType: "COMPLETED" | "FINALIZING" | "UPLOAD_ARTIFACTS" | "POST_BUILD" | "BUILD" | "PRE_BUILD" | "INSTALL" | "QUEUED" | "DOWNLOAD_SOURCE" | "PROVISIONING" | "SUBMITTED"

CodeBuildSourceLocationType

CodeBuildSourceLocationType: "CODECOMMIT" | "CODEPIPELINE" | "GITHUB" | "GITHUB_ENTERPRISE" | "BITBUCKET" | "S3" | "NO_SOURCE"

CodeBuildStateType

CodeBuildStateType: "IN_PROGRESS" | "SUCCEEDED" | "FAILED" | "STOPPED"

CodePipelineActionCategory

CodePipelineActionCategory: "Approval" | "Build" | "Deploy" | "Invoke" | "Source" | "Test"

CodePipelineActionState

CodePipelineActionState: "STARTED" | "SUCCEEDED" | "FAILED" | "CANCELED"

CodePipelineCloudWatchActionHandler

CodePipelineCloudWatchActionHandler: Handler<CodePipelineCloudWatchActionEvent, void>

CodePipelineCloudWatchEvent

CodePipelineCloudWatchHandler

CodePipelineCloudWatchHandler: Handler<CodePipelineCloudWatchEvent, void>

CodePipelineCloudWatchPipelineHandler

CodePipelineCloudWatchPipelineHandler: Handler<CodePipelineCloudWatchPipelineEvent, void>

CodePipelineCloudWatchStageHandler

CodePipelineCloudWatchStageHandler: Handler<CodePipelineCloudWatchStageEvent, void>

CodePipelineHandler

CodePipelineHandler: Handler<CodePipelineEvent, void>

CodePipelineStageState

CodePipelineStageState: "STARTED" | "SUCCEEDED" | "RESUMED" | "FAILED" | "CANCELED"

CodePipelineState

CodePipelineState: "STARTED" | "SUCCEEDED" | "RESUMED" | "FAILED" | "CANCELED" | "SUPERSEDED"

CognitoUserPoolEvent

CognitoUserPoolEvent: CognitoUserPoolTriggerEvent
deprecated

Please use specific event types instead

CognitoUserPoolTriggerHandler

CognitoUserPoolTriggerHandler: Handler<CognitoUserPoolTriggerEvent>
deprecated

Please use specific event handler types instead

ConnectContactFlowCallback

ConnectContactFlowCallback: Callback<ConnectContactFlowResult>

ConnectContactFlowChannel

ConnectContactFlowChannel: "VOICE" | "CHAT"

ConnectContactFlowHandler

ConnectContactFlowInitiationMethod

ConnectContactFlowInitiationMethod: "INBOUND" | "OUTBOUND" | "TRANSFER" | "CALLBACK" | "API"

CreateAuthChallengeTriggerHandler

CreateAuthChallengeTriggerHandler: Handler<CreateAuthChallengeTriggerEvent>

CustomAuthorizerCallback

CustomAuthorizerCallback: APIGatewayAuthorizerCallback

CustomAuthorizerHandler

deprecated

Use APIGatewayAuthorizerHandler or a subtype

CustomAuthorizerResult

CustomAuthorizerResult: APIGatewayAuthorizerResult

CustomEmailSenderTriggerEvent

CustomEmailSenderTriggerHandler

CustomEmailSenderTriggerHandler: Handler<CustomEmailSenderTriggerEvent>

CustomMessageAdminCreateUserTriggerEvent

CustomMessageAdminCreateUserTriggerEvent: BaseCustomMessageTriggerEvent<"CustomMessage_AdminCreateUser">

CustomMessageAuthenticationTriggerEvent

CustomMessageAuthenticationTriggerEvent: BaseCustomMessageTriggerEvent<"CustomMessage_Authentication">

CustomMessageForgotPasswordTriggerEvent

CustomMessageForgotPasswordTriggerEvent: BaseCustomMessageTriggerEvent<"CustomMessage_ForgotPassword">

CustomMessageResendCodeTriggerEvent

CustomMessageResendCodeTriggerEvent: BaseCustomMessageTriggerEvent<"CustomMessage_ResendCode">

CustomMessageSignUpTriggerEvent

CustomMessageSignUpTriggerEvent: BaseCustomMessageTriggerEvent<"CustomMessage_SignUp">

CustomMessageTriggerEvent

CustomMessageTriggerHandler

CustomMessageTriggerHandler: Handler<CustomMessageTriggerEvent>

CustomMessageUpdateUserAttributeTriggerEvent

CustomMessageUpdateUserAttributeTriggerEvent: BaseCustomMessageTriggerEvent<"CustomMessage_UpdateUserAttribute">

CustomMessageVerifyUserAttributeTriggerEvent

CustomMessageVerifyUserAttributeTriggerEvent: BaseCustomMessageTriggerEvent<"CustomMessage_VerifyUserAttribute">

CustomerAudio

DefineAuthChallengeTriggerHandler

DefineAuthChallengeTriggerHandler: Handler<DefineAuthChallengeTriggerEvent>

DynamoDBStreamHandler

DynamoDBStreamHandler: Handler<DynamoDBStreamEvent, void>

EventBridgeHandler

EventBridgeHandler<TDetailType, TDetail, TResult>: Handler<EventBridgeEvent<TDetailType, TDetail>, TResult>

Type parameters

  • TDetailType: string

  • TDetail

  • TResult

FirehoseRecordTransformationStatus

FirehoseRecordTransformationStatus: "Ok" | "Dropped" | "ProcessingFailed"

FirehoseTransformationCallback

FirehoseTransformationCallback: Callback<FirehoseTransformationResult>

FirehoseTransformationHandler

Handler

Handler<TEvent, TResult>: (event: TEvent, context: Context, callback: Callback<TResult>) => void | Promise<TResult>

Type parameters

  • TEvent = any

  • TResult = any

Type declaration

    • (event: TEvent, context: Context, callback: Callback<TResult>): void | Promise<TResult>
    • The interface that AWS Lambda will invoke your handler with. There are more specialized types for many cases where AWS services invoke your lambda, but you can directly use this type for when you are invoking your lambda directly.

      See tme AWS documentation for more information about the runtime behavior, and the AWS Blog post introducing the async handler behavior in the 8.10 runtime.

      Parameters

      • event: TEvent
         Parsed JSON data in the lambda request payload. For an AWS service triggered
         lambda this should be in the format of a type ending in Event, for example the
         S3Handler receives an event of type S3Event.
        
      • context: Context
         Runtime contextual information of the current invocation, for example the caller
         identity, available memory and time remaining, legacy completion callbacks, and
         a mutable property controlling when the lambda execution completes.
        
      • callback: Callback<TResult>
         NodeJS-style completion callback that the AWS Lambda runtime will provide that can
         be used to provide the lambda result payload value, or any execution error. Can
         instead return a promise that resolves with the result payload value or rejects
         with the execution error.
        

      Returns void | Promise<TResult>

       A promise that resolves with the lambda result payload value, or rejects with the
       execution error. Note that if you implement your handler as an async function,
       you will automatically return a promise that will resolve with a returned value,
       or reject with a thrown value.
      

IoTEvent

IoTEvent<T>: string | number | T

Type parameters

  • T = never

IoTHandler

IoTHandler: Handler<IoTEvent, void>

IoTPreProvisioningHookHandler

KinesisStreamHandler

KinesisStreamHandler: Handler<KinesisStreamEvent, void>

LexCallback

LexCallback: Callback<LexResult>

LexDialogAction

LexHandler

LexHandler: Handler<LexEvent, LexResult>

MSKHandler

MSKHandler: Handler<MSKEvent, void>

PostAuthenticationTriggerHandler

PostAuthenticationTriggerHandler: Handler<PostAuthenticationTriggerEvent>

PostConfirmationConfirmForgotPassword

PostConfirmationConfirmForgotPassword: BasePostConfirmationTriggerEvent<"PostConfirmation_ConfirmForgotPassword">

PostConfirmationConfirmSignUpTriggerEvent

PostConfirmationConfirmSignUpTriggerEvent: BasePostConfirmationTriggerEvent<"PostConfirmation_ConfirmSignUp">

PostConfirmationTriggerEvent

PostConfirmationTriggerHandler

PostConfirmationTriggerHandler: Handler<PostConfirmationTriggerEvent>

PreAuthenticationTriggerHandler

PreAuthenticationTriggerHandler: Handler<PreAuthenticationTriggerEvent>

PreSignUpAdminCreateUserTriggerEvent

PreSignUpAdminCreateUserTriggerEvent: BasePreSignUpTriggerEvent<"PreSignUp_AdminCreateUser">

PreSignUpEmailTriggerEvent

PreSignUpEmailTriggerEvent: BasePreSignUpTriggerEvent<"PreSignUp_SignUp">

PreSignUpExternalProviderTriggerEvent

PreSignUpExternalProviderTriggerEvent: BasePreSignUpTriggerEvent<"PreSignUp_ExternalProvider">

PreSignUpTriggerEvent

PreSignUpTriggerHandler

PreSignUpTriggerHandler: Handler<PreSignUpTriggerEvent>

PreTokenGenerationAuthenticateDeviceTriggerEvent

PreTokenGenerationAuthenticateDeviceTriggerEvent: BasePreTokenGenerationTriggerEvent<"TokenGeneration_AuthenticateDevice">

PreTokenGenerationAuthenticationTriggerEvent

PreTokenGenerationAuthenticationTriggerEvent: BasePreTokenGenerationTriggerEvent<"TokenGeneration_Authentication">

PreTokenGenerationHostedAuthTriggerEvent

PreTokenGenerationHostedAuthTriggerEvent: BasePreTokenGenerationTriggerEvent<"TokenGeneration_HostedAuth">

PreTokenGenerationNewPasswordChallengeTriggerEvent

PreTokenGenerationNewPasswordChallengeTriggerEvent: BasePreTokenGenerationTriggerEvent<"TokenGeneration_NewPasswordChallenge">

PreTokenGenerationRefreshTokensTriggerEvent

PreTokenGenerationRefreshTokensTriggerEvent: BasePreTokenGenerationTriggerEvent<"TokenGeneration_RefreshTokens">

PreTokenGenerationTriggerEvent

PreTokenGenerationTriggerHandler

PreTokenGenerationTriggerHandler: Handler<PreTokenGenerationTriggerEvent>

PrincipalValue

PrincipalValue: {} | string | string[]

ProxyCallback

ProxyHandler

ProxyResult

S3BatchCallback

S3BatchCallback: Callback<S3BatchResult>

S3BatchHandler

S3BatchResultResultCode

S3BatchResultResultCode: "Succeeded" | "TemporaryFailure" | "PermanentFailure"

S3CreateEvent

S3CreateEvent: S3Event

S3Handler

S3Handler: Handler<S3Event, void>

SESHandler

SESHandler: Handler<SESEvent, void>

SNSHandler

SNSHandler: Handler<SNSEvent, void>

SQSHandler

SQSHandler: Handler<SQSEvent, void>

SQSMessageAttributeDataType

SQSMessageAttributeDataType: "String" | "Number" | "Binary" | string

ScheduledHandler

ScheduledHandler<TDetail>: EventBridgeHandler<"Scheduled Event", TDetail, void>

Type parameters

  • TDetail = any

Statement

StatementAction

StatementAction: { Action: string | string[] } | { NotAction: string | string[] }

StatementPrincipal

StatementPrincipal: MaybeStatementResource & { Principal: PrincipalValue } | { NotPrincipal: PrincipalValue }

StatementResource

StatementResource: MaybeStatementPrincipal & { Resource: string | string[] } | { NotResource: string | string[] }

UserMigrationAuthenticationTriggerEvent

UserMigrationAuthenticationTriggerEvent: BaseUserMigrationTriggerEvent<"UserMigration_Authentication">

UserMigrationForgotPasswordTriggerEvent

UserMigrationForgotPasswordTriggerEvent: BaseUserMigrationTriggerEvent<"UserMigration_ForgotPassword">

UserMigrationTriggerEvent

UserMigrationTriggerHandler

UserMigrationTriggerHandler: Handler<UserMigrationTriggerEvent>

UserStatus

UserStatus: "UNCONFIRMED" | "CONFIRMED" | "ARCHIVED" | "COMPROMISED" | "UNKNOWN" | "RESET_REQUIRED" | "FORCE_CHANGE_PASSWORD"

VerifyAuthChallengeResponseTriggerHandler

VerifyAuthChallengeResponseTriggerHandler: Handler<VerifyAuthChallengeResponseTriggerEvent>

Generated using TypeDoc