@types/aws-lambda
- Version 8.10.146
- Published
- 167 kB
- No dependencies
- MIT license
Install
npm i @types/aws-lambda
yarn add @types/aws-lambda
pnpm add @types/aws-lambda
Overview
TypeScript definitions for aws-lambda
Index
Interfaces
Type Aliases
- AccountTakeOverActionType
- ALBCallback
- ALBHandler
- AmplifyGraphQlResolverHandler
- APIGatewayAuthorizerCallback
- APIGatewayAuthorizerEvent
- APIGatewayAuthorizerHandler
- APIGatewayAuthorizerWithContextCallback
- APIGatewayAuthorizerWithContextHandler
- APIGatewayEvent
- APIGatewayEventDefaultAuthorizerContext
- APIGatewayEventLambdaAuthorizerContext
- APIGatewayEventRequestContext
- APIGatewayProxyCallback
- APIGatewayProxyCallbackV2
- APIGatewayProxyEvent
- APIGatewayProxyEventV2
- APIGatewayProxyEventV2WithIAMAuthorizer
- APIGatewayProxyEventV2WithJWTAuthorizer
- APIGatewayProxyEventV2WithLambdaAuthorizer
- APIGatewayProxyHandler
- APIGatewayProxyHandlerV2
- APIGatewayProxyHandlerV2WithIAMAuthorizer
- APIGatewayProxyHandlerV2WithJWTAuthorizer
- APIGatewayProxyHandlerV2WithLambdaAuthorizer
- APIGatewayProxyResultV2
- APIGatewayProxyWebsocketEventV2
- APIGatewayProxyWebsocketHandlerV2
- APIGatewayProxyWithCognitoAuthorizerEvent
- APIGatewayProxyWithCognitoAuthorizerHandler
- APIGatewayProxyWithLambdaAuthorizerEvent
- APIGatewayProxyWithLambdaAuthorizerEventRequestContext
- APIGatewayProxyWithLambdaAuthorizerHandler
- APIGatewayRequestAuthorizerHandler
- APIGatewayRequestAuthorizerWithContextHandler
- APIGatewayRequestIAMAuthorizerHandlerV2
- APIGatewayRequestIAMAuthorizerV2WithContextHandler
- APIGatewayRequestSimpleAuthorizerHandlerV2
- APIGatewayRequestSimpleAuthorizerHandlerV2WithContext
- APIGatewayTokenAuthorizerHandler
- APIGatewayTokenAuthorizerWithContextHandler
- AppSyncAuthorizerHander
- AppSyncAuthorizerHandler
- AppSyncBatchResolverHandler
- AppSyncIdentity
- AppSyncResolverHandler
- ArtifactLocation
- AuthResponse
- AuthResponseContext
- AutoScalingInstanceMarketOption
- AutoScalingScaleInCallback
- AutoScalingScaleInCause
- AutoScalingScaleInHandler
- Callback
- CdkCustomResourceCallback
- CdkCustomResourceEvent
- CdkCustomResourceHandler
- CdkCustomResourceIsCompleteCallback
- CdkCustomResourceIsCompleteEvent
- CdkCustomResourceIsCompleteHandler
- CdkCustomResourceIsCompleteResponse
- CloudFormationCustomResourceEvent
- CloudFormationCustomResourceHandler
- CloudFormationCustomResourceResponse
- CloudFrontOrigin
- CloudFrontRequestCallback
- CloudFrontRequestHandler
- CloudFrontRequestResult
- CloudFrontResponseCallback
- CloudFrontResponseHandler
- CloudFrontResponseResult
- CloudFrontS3Origin
- CloudWatchAlarmHandler
- CloudWatchAlarmMetricDataQuery
- CloudWatchLogsHandler
- CodeBuildCacheType
- CodeBuildCloudWatchStateHandler
- CodeBuildEnvironmentComputeType
- CodeBuildEnvironmentPullCredentialsType
- CodeBuildEnvironmentType
- CodeBuildEnvironmentVariableType
- CodeBuildPhaseStatusType
- CodeBuildPhaseType
- CodeBuildSourceLocationType
- CodeBuildStateType
- CodeCommitHandler
- CodePipelineActionCategory
- CodePipelineActionState
- CodePipelineCloudWatchActionHandler
- CodePipelineCloudWatchEvent
- CodePipelineCloudWatchHandler
- CodePipelineCloudWatchPipelineHandler
- CodePipelineCloudWatchStageHandler
- CodePipelineHandler
- CodePipelineStageState
- CodePipelineState
- CognitoUserPoolEvent
- CognitoUserPoolTriggerHandler
- ConnectContactFlowCallback
- ConnectContactFlowChannel
- ConnectContactFlowHandler
- ConnectContactFlowInitiationMethod
- CreateAuthChallengeTriggerHandler
- CustomAuthorizerCallback
- CustomAuthorizerHandler
- CustomAuthorizerResult
- CustomEmailSenderTriggerEvent
- CustomEmailSenderTriggerHandler
- CustomerAudio
- CustomMessageAdminCreateUserTriggerEvent
- CustomMessageAuthenticationTriggerEvent
- CustomMessageForgotPasswordTriggerEvent
- CustomMessageResendCodeTriggerEvent
- CustomMessageSignUpTriggerEvent
- CustomMessageTriggerEvent
- CustomMessageTriggerHandler
- CustomMessageUpdateUserAttributeTriggerEvent
- CustomMessageVerifyUserAttributeTriggerEvent
- CustomSMSSenderTriggerEvent
- CustomSMSSenderTriggerHandler
- DefineAuthChallengeTriggerHandler
- DynamoDBStreamHandler
- EventBridgeHandler
- FirehoseRecordTransformationStatus
- FirehoseTransformationCallback
- FirehoseTransformationHandler
- GuardDutyNotificationEvent
- Handler
- IoTCustomAuthorizerHandler
- IoTEvent
- IoTHandler
- IoTPreProvisioningHookHandler
- IoTProtocolType
- KinesisStreamHandler
- KinesisStreamTumblingWindowHandler
- LambdaFunctionURLCallback
- LambdaFunctionURLEvent
- LambdaFunctionURLEventWithIAMAuthorizer
- LambdaFunctionURLHandler
- LambdaFunctionURLHandlerWithIAMAuthorizer
- LambdaFunctionURLResult
- LevV2DialogActionWithoutSlot
- LexCallback
- LexDialogAction
- LexHandler
- LexV2Callback
- LexV2DialogAction
- LexV2Handler
- LexV2IntentState
- LexV2Message
- LexV2ResultDialogAction
- LexV2Slot
- LexV2Slots
- MSKHandler
- PostAuthenticationTriggerHandler
- PostConfirmationConfirmForgotPassword
- PostConfirmationConfirmSignUpTriggerEvent
- PostConfirmationTriggerEvent
- PostConfirmationTriggerHandler
- PreAuthenticationTriggerHandler
- PreSignUpAdminCreateUserTriggerEvent
- PreSignUpEmailTriggerEvent
- PreSignUpExternalProviderTriggerEvent
- PreSignUpTriggerEvent
- PreSignUpTriggerHandler
- PreTokenGenerationAuthenticateDeviceTriggerEvent
- PreTokenGenerationAuthenticateDeviceV2TriggerEvent
- PreTokenGenerationAuthenticationTriggerEvent
- PreTokenGenerationAuthenticationV2TriggerEvent
- PreTokenGenerationHostedAuthTriggerEvent
- PreTokenGenerationHostedAuthV2TriggerEvent
- PreTokenGenerationNewPasswordChallengeTriggerEvent
- PreTokenGenerationNewPasswordChallengeV2TriggerEvent
- PreTokenGenerationRefreshTokensTriggerEvent
- PreTokenGenerationRefreshTokensV2TriggerEvent
- PreTokenGenerationTriggerEvent
- PreTokenGenerationTriggerHandler
- PreTokenGenerationV2TriggerEvent
- PreTokenGenerationV2TriggerHandler
- PrincipalValue
- ProxyCallback
- ProxyHandler
- ProxyResult
- S3BatchCallback
- S3BatchHandler
- S3BatchResultResultCode
- S3CreateEvent
- S3Handler
- S3NotificationEvent
- S3NotificationEventBridgeHandler
- S3ObjectDeletedNotificationEventDetail
- ScheduledHandler
- SecretsManagerRotationEventStep
- SecretsManagerRotationHandler
- SelfManagedKafkaHandler
- SESHandler
- SNSHandler
- SQSHandler
- SQSMessageAttributeDataType
- Statement
- StatementAction
- StatementEffect
- StatementPrincipal
- StatementResource
- TransferFamilyAuthorizerHandler
- UserMigrationAuthenticationTriggerEvent
- UserMigrationForgotPasswordTriggerEvent
- UserMigrationTriggerEvent
- UserMigrationTriggerHandler
- UserStatus
- VerifyAuthChallengeResponseTriggerHandler
Interfaces
interface AccessTokenGeneration
interface AccessTokenGeneration {}
property claimsToAddOrOverride
claimsToAddOrOverride?: StringMap | undefined;
property claimsToSuppress
claimsToSuppress?: string[] | undefined;
property scopesToAdd
scopesToAdd?: string[] | undefined;
property scopesToSuppress
scopesToSuppress?: string[] | undefined;
interface ALBEvent
interface ALBEvent {}
property body
body: string | null;
property headers
headers?: ALBEventHeaders | undefined;
property httpMethod
httpMethod: string;
property isBase64Encoded
isBase64Encoded: boolean;
property multiValueHeaders
multiValueHeaders?: ALBEventMultiValueHeaders | undefined;
property multiValueQueryStringParameters
multiValueQueryStringParameters?: | ALBEventMultiValueQueryStringParameters | undefined;
property path
path: string;
property queryStringParameters
queryStringParameters?: ALBEventQueryStringParameters | undefined;
property requestContext
requestContext: ALBEventRequestContext;
interface ALBEventHeaders
interface ALBEventHeaders {}
index signature
[name: string]: string | undefined;
interface ALBEventMultiValueHeaders
interface ALBEventMultiValueHeaders {}
index signature
[name: string]: string[] | undefined;
interface ALBEventMultiValueQueryStringParameters
interface ALBEventMultiValueQueryStringParameters {}
index signature
[name: string]: string[] | undefined;
interface ALBEventQueryStringParameters
interface ALBEventQueryStringParameters {}
index signature
[name: string]: string | undefined;
interface ALBEventRequestContext
interface ALBEventRequestContext {}
property elb
elb: { targetGroupArn: string;};
interface ALBResult
interface ALBResult {}
property body
body?: string | undefined;
property headers
headers?: { [header: string]: boolean | number | string } | undefined;
property isBase64Encoded
isBase64Encoded?: boolean | undefined;
property multiValueHeaders
multiValueHeaders?: | { [header: string]: Array<boolean | number | string> } | undefined;
property statusCode
statusCode: number;
property statusDescription
statusDescription?: string | undefined;
interface AmplifyGraphQlResolverEvent
interface AmplifyGraphQlResolverEvent< TArguments = Record<string, any>, TSource = Record<string, any>> {}
An AWS Amplify GraphQL resolver event. It differs slightly from a native ('direct') AppSync resolver event.
See Also
https://docs.amplify.aws/cli/graphql/custom-business-logic/#structure-of-the-function-event
property arguments
arguments: TArguments;
A map of GraphQL arguments passed to the field being resolved.
property fieldName
fieldName: string;
The field within the given type to resolve.
property identity
identity?: AppSyncIdentity;
The identity used to authenticate the request to AppSync.
property prev
prev: { result: { [key: string]: any } } | null;
The object returned by a possible previous pipeline resolver function.
property request
request: { headers: AppSyncResolverEventHeaders; domainName: string | null;};
The request headers
property source
source: TSource;
The parent object's value if resolving a nested field.
property typeName
typeName: string;
The name of the parent object type (data model) of the field being resolved.
interface APIGatewayAuthorizerResult
interface APIGatewayAuthorizerResult {}
property context
context?: APIGatewayAuthorizerResultContext | null | undefined;
property policyDocument
policyDocument: PolicyDocument;
property principalId
principalId: string;
property usageIdentifierKey
usageIdentifierKey?: string | null | undefined;
interface APIGatewayAuthorizerResultContext
interface APIGatewayAuthorizerResultContext {}
index signature
[name: string]: string | number | boolean | null | undefined;
interface APIGatewayAuthorizerWithContextResult
interface APIGatewayAuthorizerWithContextResult< TAuthorizerContext extends APIGatewayAuthorizerResultContext> {}
property context
context: TAuthorizerContext;
property policyDocument
policyDocument: PolicyDocument;
property principalId
principalId: string;
property usageIdentifierKey
usageIdentifierKey?: string | null | undefined;
interface APIGatewayEventClientCertificate
interface APIGatewayEventClientCertificate {}
property clientCertPem
clientCertPem: string;
property issuerDN
issuerDN: string;
property serialNumber
serialNumber: string;
property subjectDN
subjectDN: string;
property validity
validity: { notAfter: string; notBefore: string;};
interface APIGatewayEventIdentity
interface APIGatewayEventIdentity {}
property accessKey
accessKey: string | null;
property accountId
accountId: string | null;
property apiKey
apiKey: string | null;
property apiKeyId
apiKeyId: string | null;
property caller
caller: string | null;
property clientCert
clientCert: APIGatewayEventClientCertificate | null;
property cognitoAuthenticationProvider
cognitoAuthenticationProvider: string | null;
property cognitoAuthenticationType
cognitoAuthenticationType: string | null;
property cognitoIdentityId
cognitoIdentityId: string | null;
property cognitoIdentityPoolId
cognitoIdentityPoolId: string | null;
property principalOrgId
principalOrgId: string | null;
property sourceIp
sourceIp: string;
property user
user: string | null;
property userAgent
userAgent: string | null;
property userArn
userArn: string | null;
interface APIGatewayEventRequestContextIAMAuthorizer
interface APIGatewayEventRequestContextIAMAuthorizer {}
IAM Authorizer Payload
property iam
iam: { accessKey: string; accountId: string; callerId: string; cognitoIdentity: null; principalOrgId: string; userArn: string; userId: string;};
interface APIGatewayEventRequestContextJWTAuthorizer
interface APIGatewayEventRequestContextJWTAuthorizer {}
JWT Authorizer Payload
property integrationLatency
integrationLatency: number;
property jwt
jwt: { claims: { [name: string]: string | number | boolean | string[] }; scopes: string[];};
property principalId
principalId: string;
interface APIGatewayEventRequestContextLambdaAuthorizer
interface APIGatewayEventRequestContextLambdaAuthorizer<TAuthorizerContext> {}
Lambda Authorizer Payload
property lambda
lambda: TAuthorizerContext;
interface APIGatewayEventRequestContextV2
interface APIGatewayEventRequestContextV2 {}
Works with HTTP API integration Payload Format version 2.0
See Also
- https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html
property accountId
accountId: string;
property apiId
apiId: string;
property authentication
authentication?: { clientCert: APIGatewayEventClientCertificate;};
property domainName
domainName: string;
property domainPrefix
domainPrefix: string;
property http
http: { method: string; path: string; protocol: string; sourceIp: string; userAgent: string;};
property requestId
requestId: string;
property routeKey
routeKey: string;
property stage
stage: string;
property time
time: string;
property timeEpoch
timeEpoch: number;
interface APIGatewayEventRequestContextV2WithAuthorizer
interface APIGatewayEventRequestContextV2WithAuthorizer<TAuthorizer> extends APIGatewayEventRequestContextV2 {}
property authorizer
authorizer: TAuthorizer;
interface APIGatewayEventRequestContextWithAuthorizer
interface APIGatewayEventRequestContextWithAuthorizer<TAuthorizerContext> {}
property accountId
accountId: string;
property apiId
apiId: string;
property authorizer
authorizer: TAuthorizerContext;
property connectedAt
connectedAt?: number | undefined;
property connectionId
connectionId?: string | undefined;
property domainName
domainName?: string | undefined;
property domainPrefix
domainPrefix?: string | undefined;
property eventType
eventType?: string | undefined;
property extendedRequestId
extendedRequestId?: string | undefined;
property httpMethod
httpMethod: string;
property identity
identity: APIGatewayEventIdentity;
property messageDirection
messageDirection?: string | undefined;
property messageId
messageId?: string | null | undefined;
property path
path: string;
property protocol
protocol: string;
property requestId
requestId: string;
property requestTime
requestTime?: string | undefined;
property requestTimeEpoch
requestTimeEpoch: number;
property resourceId
resourceId: string;
property resourcePath
resourcePath: string;
property routeKey
routeKey?: string | undefined;
property stage
stage: string;
interface APIGatewayEventWebsocketRequestContextV2
interface APIGatewayEventWebsocketRequestContextV2 {}
Works with Websocket API integration Payload Format version 2.0
See Also
- https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-integration-requests.html
- https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-mapping-template-reference.html
property apiId
apiId: string;
property connectedAt
connectedAt: number;
property connectionId
connectionId: string;
property domainName
domainName: string;
property eventType
eventType: 'CONNECT' | 'MESSAGE' | 'DISCONNECT';
property extendedRequestId
extendedRequestId: string;
property messageDirection
messageDirection: 'IN';
property messageId
messageId: string;
property requestId
requestId: string;
property requestTime
requestTime: string;
property requestTimeEpoch
requestTimeEpoch: number;
property routeKey
routeKey: string;
property stage
stage: string;
interface APIGatewayIAMAuthorizerResult
interface APIGatewayIAMAuthorizerResult {}
IAM Authorizer Types
property context
context?: APIGatewayAuthorizerResultContext | null | undefined;
property policyDocument
policyDocument: PolicyDocument;
property principalId
principalId: string;
property usageIdentifierKey
usageIdentifierKey?: string | null | undefined;
interface APIGatewayIAMAuthorizerWithContextResult
interface APIGatewayIAMAuthorizerWithContextResult< TAuthorizerContext extends APIGatewayAuthorizerResultContext> {}
property context
context: TAuthorizerContext;
property policyDocument
policyDocument: PolicyDocument;
property principalId
principalId: string;
property usageIdentifierKey
usageIdentifierKey?: string | null | undefined;
interface APIGatewayProxyCognitoAuthorizer
interface APIGatewayProxyCognitoAuthorizer {}
property claims
claims: { [name: string]: string;};
interface APIGatewayProxyEventBase
interface APIGatewayProxyEventBase<TAuthorizerContext> {}
property body
body: string | null;
property headers
headers: APIGatewayProxyEventHeaders;
property httpMethod
httpMethod: string;
property isBase64Encoded
isBase64Encoded: boolean;
property multiValueHeaders
multiValueHeaders: APIGatewayProxyEventMultiValueHeaders;
property multiValueQueryStringParameters
multiValueQueryStringParameters: APIGatewayProxyEventMultiValueQueryStringParameters | null;
property path
path: string;
property pathParameters
pathParameters: APIGatewayProxyEventPathParameters | null;
property queryStringParameters
queryStringParameters: APIGatewayProxyEventQueryStringParameters | null;
property requestContext
requestContext: APIGatewayEventRequestContextWithAuthorizer<TAuthorizerContext>;
property resource
resource: string;
property stageVariables
stageVariables: APIGatewayProxyEventStageVariables | null;
interface APIGatewayProxyEventHeaders
interface APIGatewayProxyEventHeaders {}
index signature
[name: string]: string | undefined;
interface APIGatewayProxyEventMultiValueHeaders
interface APIGatewayProxyEventMultiValueHeaders {}
index signature
[name: string]: string[] | undefined;
interface APIGatewayProxyEventMultiValueQueryStringParameters
interface APIGatewayProxyEventMultiValueQueryStringParameters {}
index signature
[name: string]: string[] | undefined;
interface APIGatewayProxyEventPathParameters
interface APIGatewayProxyEventPathParameters {}
index signature
[name: string]: string | undefined;
interface APIGatewayProxyEventQueryStringParameters
interface APIGatewayProxyEventQueryStringParameters {}
index signature
[name: string]: string | undefined;
interface APIGatewayProxyEventStageVariables
interface APIGatewayProxyEventStageVariables {}
index signature
[name: string]: string | undefined;
interface APIGatewayProxyEventV2WithRequestContext
interface APIGatewayProxyEventV2WithRequestContext<TRequestContext> {}
Proxy Event with adaptable requestContext for different authorizer scenarios
property body
body?: string;
property cookies
cookies?: string[];
property headers
headers: APIGatewayProxyEventHeaders;
property isBase64Encoded
isBase64Encoded: boolean;
property pathParameters
pathParameters?: APIGatewayProxyEventPathParameters;
property queryStringParameters
queryStringParameters?: APIGatewayProxyEventQueryStringParameters;
property rawPath
rawPath: string;
property rawQueryString
rawQueryString: string;
property requestContext
requestContext: TRequestContext;
property routeKey
routeKey: string;
property stageVariables
stageVariables?: APIGatewayProxyEventStageVariables;
property version
version: string;
interface APIGatewayProxyResult
interface APIGatewayProxyResult {}
Works with Lambda Proxy Integration for Rest API or HTTP API integration Payload Format version 1.0
See Also
- https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html
property body
body: string;
property headers
headers?: | { [header: string]: boolean | number | string; } | undefined;
property isBase64Encoded
isBase64Encoded?: boolean | undefined;
property multiValueHeaders
multiValueHeaders?: | { [header: string]: Array<boolean | number | string>; } | undefined;
property statusCode
statusCode: number;
interface APIGatewayProxyStructuredResultV2
interface APIGatewayProxyStructuredResultV2 {}
Interface for structured response with
statusCode
andheaders
Works with HTTP API integration Payload Format version 2.0See Also
- https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html
property body
body?: string | undefined;
property cookies
cookies?: string[] | undefined;
property headers
headers?: | { [header: string]: boolean | number | string; } | undefined;
property isBase64Encoded
isBase64Encoded?: boolean | undefined;
property statusCode
statusCode?: number | undefined;
interface APIGatewayProxyWebsocketEventV2WithRequestContext
interface APIGatewayProxyWebsocketEventV2WithRequestContext<TRequestContext> {}
Proxy Websocket Event with adaptable requestContext for different authorizer scenarios
property body
body?: string;
property isBase64Encoded
isBase64Encoded: boolean;
property requestContext
requestContext: TRequestContext;
property stageVariables
stageVariables?: APIGatewayProxyEventStageVariables;
interface APIGatewayRequestAuthorizerEvent
interface APIGatewayRequestAuthorizerEvent {}
property headers
headers: APIGatewayRequestAuthorizerEventHeaders | null;
property httpMethod
httpMethod: string;
property methodArn
methodArn: string;
property multiValueHeaders
multiValueHeaders: APIGatewayRequestAuthorizerEventMultiValueHeaders | null;
property multiValueQueryStringParameters
multiValueQueryStringParameters: APIGatewayRequestAuthorizerEventMultiValueQueryStringParameters | null;
property path
path: string;
property pathParameters
pathParameters: APIGatewayRequestAuthorizerEventPathParameters | null;
property queryStringParameters
queryStringParameters: APIGatewayRequestAuthorizerEventQueryStringParameters | null;
property requestContext
requestContext: APIGatewayEventRequestContextWithAuthorizer<undefined>;
property resource
resource: string;
property stageVariables
stageVariables: APIGatewayRequestAuthorizerEventStageVariables | null;
property type
type: 'REQUEST';
interface APIGatewayRequestAuthorizerEventHeaders
interface APIGatewayRequestAuthorizerEventHeaders {}
index signature
[name: string]: string | undefined;
interface APIGatewayRequestAuthorizerEventMultiValueHeaders
interface APIGatewayRequestAuthorizerEventMultiValueHeaders {}
index signature
[name: string]: string[] | undefined;
interface APIGatewayRequestAuthorizerEventMultiValueQueryStringParameters
interface APIGatewayRequestAuthorizerEventMultiValueQueryStringParameters {}
index signature
[name: string]: string[] | undefined;
interface APIGatewayRequestAuthorizerEventPathParameters
interface APIGatewayRequestAuthorizerEventPathParameters {}
index signature
[name: string]: string | undefined;
interface APIGatewayRequestAuthorizerEventQueryStringParameters
interface APIGatewayRequestAuthorizerEventQueryStringParameters {}
index signature
[name: string]: string | undefined;
interface APIGatewayRequestAuthorizerEventStageVariables
interface APIGatewayRequestAuthorizerEventStageVariables {}
index signature
[name: string]: string | undefined;
interface APIGatewayRequestAuthorizerEventV2
interface APIGatewayRequestAuthorizerEventV2 {}
property cookies
cookies: string[];
property headers
headers?: APIGatewayRequestAuthorizerEventHeaders;
property identitySource
identitySource: string[];
property pathParameters
pathParameters?: APIGatewayRequestAuthorizerEventPathParameters;
property queryStringParameters
queryStringParameters?: APIGatewayRequestAuthorizerEventQueryStringParameters;
property rawPath
rawPath: string;
property rawQueryString
rawQueryString: string;
property requestContext
requestContext: APIGatewayEventRequestContextV2;
property routeArn
routeArn: string;
property routeKey
routeKey: string;
property stageVariables
stageVariables?: APIGatewayRequestAuthorizerEventStageVariables;
property type
type: 'REQUEST';
property version
version: string;
interface APIGatewaySimpleAuthorizerResult
interface APIGatewaySimpleAuthorizerResult {}
Simple Lambda Authorizer Types V2 spec with simple response
See Also
- https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html
property isAuthorized
isAuthorized: boolean;
interface APIGatewaySimpleAuthorizerWithContextResult
interface APIGatewaySimpleAuthorizerWithContextResult<TAuthorizerContext> extends APIGatewaySimpleAuthorizerResult {}
property context
context: TAuthorizerContext;
interface APIGatewayTokenAuthorizerEvent
interface APIGatewayTokenAuthorizerEvent {}
property authorizationToken
authorizationToken: string;
property methodArn
methodArn: string;
property type
type: 'TOKEN';
interface AppSyncAuthorizerEvent
interface AppSyncAuthorizerEvent {}
property authorizationToken
authorizationToken: string;
property requestContext
requestContext: { apiId: string; accountId: string; requestId: string; queryString: string; operationName?: string; variables: { [key: string]: any };};
property requestHeaders
requestHeaders: AppSyncAuthorizerEventHeaders;
interface AppSyncAuthorizerEventHeaders
interface AppSyncAuthorizerEventHeaders {}
index signature
[name: string]: string | undefined;
interface AppSyncAuthorizerResult
interface AppSyncAuthorizerResult<TResolverContext = undefined> {}
property deniedFields
deniedFields?: string[];
property isAuthorized
isAuthorized: boolean;
property resolverContext
resolverContext?: TResolverContext;
property ttlOverride
ttlOverride?: number;
interface AppSyncIdentityCognito
interface AppSyncIdentityCognito {}
interface AppSyncIdentityIAM
interface AppSyncIdentityIAM {}
property accountId
accountId: string;
property cognitoIdentityAuthProvider
cognitoIdentityAuthProvider: string;
property cognitoIdentityAuthType
cognitoIdentityAuthType: string;
property cognitoIdentityId
cognitoIdentityId: string;
property cognitoIdentityPoolId
cognitoIdentityPoolId: string;
property sourceIp
sourceIp: string[];
property userArn
userArn: string;
property username
username: string;
interface AppSyncIdentityLambda
interface AppSyncIdentityLambda {}
property resolverContext
resolverContext: any;
interface AppSyncIdentityOIDC
interface AppSyncIdentityOIDC {}
interface AppSyncResolverEvent
interface AppSyncResolverEvent<TArguments, TSource = Record<string, any> | null> {}
See https://docs.aws.amazon.com/appsync/latest/devguide/resolver-context-reference.html
Parameter TArguments
type of the arguments
Parameter TSource
type of the source
property arguments
arguments: TArguments;
property identity
identity?: AppSyncIdentity;
property info
info: { selectionSetList: string[]; selectionSetGraphQL: string; parentTypeName: string; fieldName: string; variables: { [key: string]: any };};
property prev
prev: { result: { [key: string]: any } } | null;
property request
request: { headers: AppSyncResolverEventHeaders; /** The API's custom domain if used for the request. */ domainName: string | null;};
property source
source: TSource;
property stash
stash: { [key: string]: any };
interface AppSyncResolverEventHeaders
interface AppSyncResolverEventHeaders {}
index signature
[name: string]: string | undefined;
interface Artifact
interface Artifact {}
interface AttributeValue
interface AttributeValue {}
property B
B?: string | undefined;
property BOOL
BOOL?: boolean | undefined;
property BS
BS?: string[] | undefined;
property L
L?: AttributeValue[] | undefined;
property M
M?: { [id: string]: AttributeValue } | undefined;
property N
N?: string | undefined;
property NS
NS?: string[] | undefined;
property NULL
NULL?: boolean | undefined;
property S
S?: string | undefined;
property SS
SS?: string[] | undefined;
interface AutoScalingInstanceRecord
interface AutoScalingInstanceRecord {}
property AvailabilityZone
AvailabilityZone: string;
property InstanceId
InstanceId: string;
property InstanceMarketOption
InstanceMarketOption: AutoScalingInstanceMarketOption;
property InstanceType
InstanceType: string;
interface AutoScalingScaleInEvent
interface AutoScalingScaleInEvent {}
An Auto Scaling Group may trigger a Scale In Event when you have attached a custom termination policy function. This event and the expected response are described in the Auto Scaling docs at:
https://docs.aws.amazon.com/autoscaling/ec2/userguide/lambda-custom-termination-policy.html
property AutoScalingGroupARN
AutoScalingGroupARN: string;
property AutoScalingGroupName
AutoScalingGroupName: string;
property CapacityToTerminate
CapacityToTerminate: AutoScalingTerminationRequest[];
property Cause
Cause: AutoScalingScaleInCause;
property HasMoreInstances
HasMoreInstances?: boolean;
property Instances
Instances: AutoScalingInstanceRecord[];
interface AutoScalingScaleInResult
interface AutoScalingScaleInResult {}
property InstanceIDs
InstanceIDs: string[];
interface AutoScalingTerminationRequest
interface AutoScalingTerminationRequest {}
property AvailabilityZone
AvailabilityZone: string;
property Capacity
Capacity: number;
property InstanceMarketOption
InstanceMarketOption: AutoScalingInstanceMarketOption;
interface BaseCustomEmailSenderTriggerEvent
interface BaseCustomEmailSenderTriggerEvent<T extends string> extends BaseTriggerEvent<T> {}
property request
request: { type: string; code: string | null; userAttributes: StringMap; clientMetadata?: StringMap | undefined;};
interface BaseCustomMessageTriggerEvent
interface BaseCustomMessageTriggerEvent<T extends string> extends BaseTriggerEvent<T> {}
property request
request: { userAttributes: StringMap; codeParameter: string; linkParameter: string; /** * This is null for all events other than the AdminCreateUser action. */ usernameParameter: string | null; clientMetadata?: StringMap | undefined;};
property response
response: { smsMessage: string | null; emailMessage: string | null; emailSubject: string | null;};
interface BaseCustomSMSSenderTriggerEvent
interface BaseCustomSMSSenderTriggerEvent<T extends string> extends BaseTriggerEvent<T> {}
property request
request: { type: string; code: string | null; userAttributes: StringMap; clientMetadata?: StringMap | undefined;};
interface BasePostConfirmationTriggerEvent
interface BasePostConfirmationTriggerEvent<T extends string> extends BaseTriggerEvent<T> {}
property request
request: { userAttributes: StringMap; clientMetadata?: StringMap | undefined;};
interface BasePreSignUpTriggerEvent
interface BasePreSignUpTriggerEvent<T extends string> extends BaseTriggerEvent<T> {}
interface BasePreTokenGenerationTriggerEvent
interface BasePreTokenGenerationTriggerEvent<T extends string> extends BaseTriggerEvent<T> {}
property request
request: { userAttributes: StringMap; groupConfiguration: GroupOverrideDetails; clientMetadata?: StringMap | undefined;};
property response
response: { claimsOverrideDetails: { claimsToAddOrOverride?: StringMap | undefined; claimsToSuppress?: string[] | undefined; groupOverrideDetails?: GroupOverrideDetails | undefined; };};
interface BasePreTokenGenerationV2TriggerEvent
interface BasePreTokenGenerationV2TriggerEvent<T extends string> extends BaseTriggerEvent<T> {}
interface BaseStatement
interface BaseStatement {}
interface BaseUserMigrationTriggerEvent
interface BaseUserMigrationTriggerEvent<T extends string> extends BaseTriggerEvent<T> {}
property request
request: { password: string; validationData?: StringMap | undefined; clientMetadata?: StringMap | undefined;};
property response
response: { userAttributes: StringMap; finalUserStatus?: UserStatus | undefined; messageAction?: 'RESEND' | 'SUPPRESS' | undefined; desiredDeliveryMediums: Array<'SMS' | 'EMAIL'>; forceAliasCreation?: boolean | undefined; enableSMSMFA?: boolean | undefined;};
interface CdkCustomResourceIsCompleteResponseSuccess
interface CdkCustomResourceIsCompleteResponseSuccess< TData extends Record<string, any> = Record<string, any>> {}
Response properties that are specifically for a successful
IsComplete
response for a CDK Custom Resource Reference: https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.custom_resources-readme.html#asynchronous-providers-iscomplete TData User-defined output properties that are retuned from any invocation
property Data
Data?: TData;
The custom resource provider-defined name-value pairs to send with the response. You can access the values provided here by name in the template with
Fn::GetAtt
. These attributes will be **merged** with the ones returned fromonEvent
.
property IsComplete
IsComplete: true;
Indicates the operation has finished.
interface CdkCustomResourceIsCompleteResponseWaiting
interface CdkCustomResourceIsCompleteResponseWaiting {}
Response properties that are specifically for a still waiting
IsComplete
response for a CDK Custom Resource Reference: https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.custom_resources-readme.html#asynchronous-providers-iscomplete
property IsComplete
IsComplete: false;
Indicates the operation has not finished.
interface CdkCustomResourceResponse
interface CdkCustomResourceResponse< TData extends Record<string, any> = Record<string, any>> {}
Response from the
OnEvent
Lambda handler for a CDK Custom Resource Reference: https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.custom_resources-readme.html#handling-lifecycle-events-onevent TData User-defined output properties that are retuned from any invocation
property Data
Data?: TData;
The custom resource provider-defined name-value pairs to send with the response. You can access the values provided here by name in the template with
Fn::GetAtt
. NOTE: If the name-value pairs contain sensitive information, you should use theNoEcho
field to mask the output of the custom resource. Otherwise, the values are visible through APIs that surface property values (such asDescribeStackEvents
).
property NoEcho
NoEcho?: boolean;
Indicates whether to mask the output of the custom resource when retrieved by using the
Fn::GetAtt
function. If set totrue
, all returned values are masked with asterisks (*****), __except for those stored in theMetadata
section of the template__. AWS CloudFormation does not transform, modify, or redact any information you include in theMetadata
section. The default value isfalse
.
property PhysicalResourceId
PhysicalResourceId?: string;
This value should be an identifier unique to the custom resource vendor, and can be up to 1 KB in size. The value must be a non-empty string and must be identical for all responses for the same resource. The value returned for a
PhysicalResourceId
can change custom resource update operations. If the value returned is the same, it is considered a normal update. If the value returned is different, AWS CloudFormation recognizes the update as a replacement and sends a delete request to the old resource.If omitted for
Create
events, the event'sRequestId
will be used. ForUpdate
, the current physical ID will be used. If a different value is returned, CloudFormation will follow with a subsequentDelete
for the previous ID (resource replacement). ForDelete
, it will always return the current physical resource ID, and if the user returns a different one, an error will occur.
index signature
[Key: string]: any;
Any other field included in the response will be passed through to
isComplete
. This can sometimes be useful to pass state between the handlers.
interface ClaimsAndScopeOverrideDetails
interface ClaimsAndScopeOverrideDetails {}
property accessTokenGeneration
accessTokenGeneration?: AccessTokenGeneration | undefined;
property groupOverrideDetails
groupOverrideDetails?: GroupOverrideDetailsV2 | undefined;
property idTokenGeneration
idTokenGeneration?: IdTokenGeneration | undefined;
interface ClientContext
interface ClientContext {}
interface ClientContextClient
interface ClientContextClient {}
property appPackageName
appPackageName: string;
property appTitle
appTitle: string;
property appVersionCode
appVersionCode: string;
property appVersionName
appVersionName: string;
property installationId
installationId: string;
interface ClientContextEnv
interface ClientContextEnv {}
property locale
locale: string;
property make
make: string;
property model
model: string;
property platform
platform: string;
property platformVersion
platformVersion: string;
interface CloudFormationCustomResourceCreateEvent
interface CloudFormationCustomResourceCreateEvent< TResourceProperties = CloudFormationCustomResourceResourcePropertiesCommon> extends CloudFormationCustomResourceEventCommon<TResourceProperties> {}
Request properties specifically for the
Create
invocation of a Lambda-backed CloudFormation Custom Resource TResourceProperties User-defined input properties passed to the Custom Resource as part of any invocation
property RequestType
RequestType: 'Create';
The request type is set by the CloudFormation stack operation (create-stack, update-stack, or delete-stack) that was initiated by the template developer for the stack that contains the custom resource.
interface CloudFormationCustomResourceDeleteEvent
interface CloudFormationCustomResourceDeleteEvent< TResourceProperties = CloudFormationCustomResourceResourcePropertiesCommon> extends CloudFormationCustomResourceEventCommon<TResourceProperties> {}
Request properties specifically for the
Delete
invocation of a Lambda-backed CloudFormation Custom Resource TResourceProperties User-defined input properties passed to the Custom Resource as part of any invocation
property PhysicalResourceId
PhysicalResourceId: string;
A required custom resource provider-defined physical ID that is unique for that provider. The value returned for a
PhysicalResourceId
can change custom resource update operations. If the value returned is the same, it is considered a normal update. If the value returned is different, AWS CloudFormation recognizes the update as a replacement and sends a delete request to the old resource.
property RequestType
RequestType: 'Delete';
The request type is set by the CloudFormation stack operation (create-stack, update-stack, or delete-stack) that was initiated by the template developer for the stack that contains the custom resource.
interface CloudFormationCustomResourceEventCommon
interface CloudFormationCustomResourceEventCommon< TResourceProperties = CloudFormationCustomResourceResourcePropertiesCommon> {}
Request properties that are common to all invocations of a Lambda-backed CloudFormation Custom Resource Reference: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/crpg-ref-requests.html#crpg-ref-request-fields TResourceProperties User-defined input properties passed to the Custom Resource as part of any invocation
property LogicalResourceId
LogicalResourceId: string;
The template developer-chosen name (logical ID) of the custom resource in the AWS CloudFormation template. This is provided to facilitate communication between the custom resource provider and the template developer.
property RequestId
RequestId: string;
A unique ID for the request. Combining the
StackId
with theRequestId
forms a value that you can use to uniquely identify a request on a particular custom resource.
property ResourceProperties
ResourceProperties: TResourceProperties & CloudFormationCustomResourceResourcePropertiesCommon;
This field contains the contents of the
Properties
object sent by the template developer. Its contents are defined by the custom resource provider.
property ResourceType
ResourceType: string;
The template developer-chosen resource type of the custom resource in the CloudFormation template. Custom resource type names can be up to 60 characters long and can include alphanumeric and the following characters:
_@-
.
property ResponseURL
ResponseURL: string;
The response URL identifies a presigned S3 bucket that receives responses from the custom resource provider to AWS CloudFormation.
property ServiceToken
ServiceToken: string;
The service token, such as an Amazon SNS topic ARN or Lambda function ARN. The service token must be from the same Region as the stack.
property StackId
StackId: string;
The Amazon Resource Name (ARN) that identifies the stack that contains the custom resource. Combining the
StackId
with theRequestId
forms a value that you can use to uniquely identify a request on a particular custom resource.
interface CloudFormationCustomResourceFailedResponse
interface CloudFormationCustomResourceFailedResponse< TData extends Record<string, any> = Record<string, any>> extends CloudFormationCustomResourceResponseCommon<TData> {}
Response properties that are specifically for a response indicating failed invocation of a Lambda-backed CloudFormation Custom Resource Reference: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/crpg-ref-responses.html TData User-defined output properties that are retuned from any invocation
interface CloudFormationCustomResourceResourcePropertiesCommon
interface CloudFormationCustomResourceResourcePropertiesCommon extends Record<string, any> {}
Named service-defined resource properties Reference: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/crpg-ref-requests.html#crpg-ref-request-properties
property ServiceTimeout
ServiceTimeout?: string;
The maximum time, in seconds, that can elapse before a custom resource operation times out. The value must be an integer from 1 to 3600. The default value is 3600 seconds (1 hour).
property ServiceToken
ServiceToken: string;
The service token, such as an Amazon SNS topic ARN or Lambda function ARN. The service token must be from the same Region as the stack.
interface CloudFormationCustomResourceResponseCommon
interface CloudFormationCustomResourceResponseCommon< TData extends Record<string, any> = Record<string, any>> {}
Response properties that are common to all invocations of a Lambda-backed CloudFormation Custom Resource Reference: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/crpg-ref-responses.html TData User-defined output properties that are retuned from any invocation
property Data
Data?: TData | undefined;
The custom resource provider-defined name-value pairs to send with the response. You can access the values provided here by name in the template with
Fn::GetAtt
. NOTE: If the name-value pairs contain sensitive information, you should use theNoEcho
field to mask the output of the custom resource. Otherwise, the values are visible through APIs that surface property values (such asDescribeStackEvents
).
property LogicalResourceId
LogicalResourceId: string;
The template developer-chosen name (logical ID) of the custom resource in the AWS CloudFormation template. This response value should be copied verbatim from the request.
property NoEcho
NoEcho?: boolean | undefined;
Indicates whether to mask the output of the custom resource when retrieved by using the
Fn::GetAtt
function. If set totrue
, all returned values are masked with asterisks (*****), __except for those stored in theMetadata
section of the template__. AWS CloudFormation does not transform, modify, or redact any information you include in theMetadata
section. The default value isfalse
.
property PhysicalResourceId
PhysicalResourceId: string;
This value should be an identifier unique to the custom resource vendor, and can be up to 1 KB in size. The value must be a non-empty string and must be identical for all responses for the same resource. The value returned for a
PhysicalResourceId
can change custom resource update operations. If the value returned is the same, it is considered a normal update. If the value returned is different, AWS CloudFormation recognizes the update as a replacement and sends a delete request to the old resource.
property RequestId
RequestId: string;
A unique ID for the request. This response value should be copied verbatim from the request.
property StackId
StackId: string;
The Amazon Resource Name (ARN) that identifies the stack that contains the custom resource. This response value should be copied verbatim from the request.
interface CloudFormationCustomResourceSuccessResponse
interface CloudFormationCustomResourceSuccessResponse< TData extends Record<string, any> = Record<string, any>> extends CloudFormationCustomResourceResponseCommon<TData> {}
Response properties that are specifically for a response indicating succesful invocation of a Lambda-backed CloudFormation Custom Resource Reference: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/crpg-ref-responses.html TData User-defined output properties that are retuned from any invocation
interface CloudFormationCustomResourceUpdateEvent
interface CloudFormationCustomResourceUpdateEvent< TResourceProperties = CloudFormationCustomResourceResourcePropertiesCommon, TOldResourceProperties = TResourceProperties> extends CloudFormationCustomResourceEventCommon<TResourceProperties> {}
Request properties specifically for the
Update
invocation of a Lambda-backed CloudFormation Custom Resource TResourceProperties User-defined input properties passed to the Custom Resource as part of any invocation TOldResourceProperties User-defined input properties passed to the Custom Resource as part of anUpdate
invocation
property OldResourceProperties
OldResourceProperties: TOldResourceProperties;
Used only for
Update
requests. Contains the resource properties that were declared previous to the update request.
property PhysicalResourceId
PhysicalResourceId: string;
A required custom resource provider-defined physical ID that is unique for that provider. The value returned for a
PhysicalResourceId
can change custom resource update operations. If the value returned is the same, it is considered a normal update. If the value returned is different, AWS CloudFormation recognizes the update as a replacement and sends a delete request to the old resource.
property RequestType
RequestType: 'Update';
The request type is set by the CloudFormation stack operation (create-stack, update-stack, or delete-stack) that was initiated by the template developer for the stack that contains the custom resource.
interface CloudFrontCustomOrigin
interface CloudFrontCustomOrigin {}
property customHeaders
customHeaders: CloudFrontHeaders;
property domainName
domainName: string;
property keepaliveTimeout
keepaliveTimeout: number;
property path
path: string;
property port
port: number;
property protocol
protocol: 'http' | 'https';
property readTimeout
readTimeout: number;
property sslProtocols
sslProtocols: string[];
interface CloudFrontEvent
interface CloudFrontEvent {}
property config
config: { readonly distributionDomainName: string; readonly distributionId: string; readonly eventType: | 'origin-request' | 'origin-response' | 'viewer-request' | 'viewer-response'; readonly requestId: string;};
interface CloudFrontFunctionsCookies
interface CloudFrontFunctionsCookies {}
See Also
https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/functions-event-structure.html#functions-event-structure-query-header-cookie
index signature
[key: string]: { value: string; attributes?: string; multiValue?: Array<{ value: string; attributes?: string }>;};
interface CloudFrontFunctionsEvent
interface CloudFrontFunctionsEvent {}
See Also
https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/functions-event-structure.html
export const handler = async (event: CloudFrontFunctionsEvent) => {var response = event.response;var headers = response.headers;// Set the cache-control headerheaders["cache-control"] = { value: "public,max-age=31536000,immutable" };// Return response to viewersreturn response};
property context
context: { /** The CloudFront domain name (for example, d111111abcdef8.cloudfront.net) of the distribution that’s associated with the event. */ distributionDomainName: string; /** The ID of the distribution (for example, EDFDVBD6EXAMPLE) that’s associated with the event. */ distributionId: string; /** The event type, either `viewer-request` or `viewer-response`. */ eventType: 'viewer-request' | 'viewer-response'; /** A string that uniquely identifies a CloudFront request (and its associated response). */ requestId: string;};
## Context object The
context
object contains contextual information about the event. It includes the following fields: -distributionDomainName
-distributionId
-eventType
-requestId
property request
request: { /** The HTTP method of the request. If your function code returns a `request`, it cannot modify this field. This is the only read-only field in the `request` object. */ method: string; /** * The relative path of the requested object. If your function modifies the `uri value, note the following: * - The new `uri` value must begin with a forward slash (`/`)`. * - When a function changes the `uri` value, it changes the object that the viewer is requesting. * - When a function changes the `uri` value, it doesn’t change the cache behavior for the request or the origin that an origin request is sent to. */ uri: string; /** * An object that represents the query string in the request. If the request doesn’t include a query string, * the `request` object still includes an empty `querystring` object. * * The `querystring` object contains one field for each query string parameter in the request. * Query string parameter names are converted to lowercase. */ querystring: CloudFrontFunctionsQuerystring; /** * An object that represents the HTTP headers in the request. If the request contains any `Cookie` headers, * those headers are not part of the `headers` object. Cookies are represented separately in the `cookies` object. * * The `headers` object contains one field for each header in the request. Header names are converted to lowercase. */ headers: CloudFrontFunctionsHeaders; /** * An object that represents the cookies in the request (`Cookie` headers). * * The `cookies` object contains one field for each cookie in the request. Cookie names are converted to lowercase. */ cookies: CloudFrontFunctionsCookies;};
## Request object The
request
object contains a representation of a viewer-to-CloudFront HTTP request. In theevent
object that’s passed to your function, therequest
object represents the actual request that CloudFront received from the viewer.If your function code returns a
request
object to CloudFront, it must use this same structure.The
request
object contains the following fields: -method
-uri
-querystring
-headers
-cookies
property response
response: { /** * The HTTP status code of the response. This value is an integer, not a string. * * If the function is associated with a _viewer response_ event type, your function code cannot change * the `statusCode` that it received. If the function is associated with a _viewer request_ event type * and [generates an HTTP response](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/writing-function-code.html#function-code-generate-response), * your function code can set the `statusCode`. */ statusCode: number; /** The HTTP status description of the response. If your function code generates a response, this field is optional. */ statusDescription?: string; /** * An object that represents the HTTP headers in the response. If the response contains any `Set-Cookie` headers, * those `headers` are not part of the headers object. Cookies are represented separately in the `cookies` object. * * The `headers` object contains one field for each header in the response. Header names are converted to lowercase. */ headers: CloudFrontFunctionsHeaders; /** * An object that represents the cookies in the response (`Set-Cookie` headers). * The `cookies` object contains one field for each cookie in the response. Cookie names are converted to lowercase. */ cookies: CloudFrontFunctionsCookies;};
## Response object
The
response
object contains a representation of a CloudFront-to-viewer HTTP response. In theevent
object that’s passed to your function, theresponse
object represents CloudFront’s actual response to a viewer request.If your function code returns a
response
object, it must use this same structure.The
response
object contains the following fields:
property version
version: string;
## Version field The version field contains a string that specifies the version of the CloudFront Functions event object. The current version is 1.0.
property viewer
viewer: { ip: string;};
## Viewer object The
viewer
object contains anip
field whose value is the IP address of the viewer (client) that sent the request. If the viewer request came through an HTTP proxy or a load balancer, the value is the IP address of the proxy or load balancer.
interface CloudFrontFunctionsHeaders
interface CloudFrontFunctionsHeaders {}
See Also
https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/functions-event-structure.html#functions-event-structure-query-header-cookie
index signature
[key: string]: { value: string; multiValue?: Array<{ value: string }> };
interface CloudFrontFunctionsQuerystring
interface CloudFrontFunctionsQuerystring {}
See Also
https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/functions-event-structure.html#functions-event-structure-query-header-cookie
index signature
[key: string]: { value: string; multiValue?: Array<{ value: string }> };
interface CloudFrontHeaders
interface CloudFrontHeaders {}
CloudFront events http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/lambda-event-structure.html Bear in mind that the "example" event structure in the page above includes both an S3 and a Custom origin, which is not strictly allowed. Only one of these per event may be present.
index signature
[name: string]: Array<{ key?: string | undefined; value: string;}>;
interface CloudFrontRequest
interface CloudFrontRequest {}
property body
body?: | { action: 'read-only' | 'replace'; data: string; encoding: 'base64' | 'text'; readonly inputTruncated: boolean; } | undefined;
property clientIp
readonly clientIp: string;
property headers
headers: CloudFrontHeaders;
property method
readonly method: string;
property origin
origin?: CloudFrontOrigin | undefined;
property querystring
querystring: string;
property uri
uri: string;
interface CloudFrontRequestEvent
interface CloudFrontRequestEvent {}
CloudFront viewer request or origin request event
https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/lambda-event-structure.html#lambda-event-structure-request
property Records
Records: CloudFrontRequestEventRecord[];
interface CloudFrontRequestEventRecord
interface CloudFrontRequestEventRecord {}
property cf
cf: CloudFrontEvent & { request: CloudFrontRequest;};
interface CloudFrontResponse
interface CloudFrontResponse {}
property headers
headers: CloudFrontHeaders;
property status
status: string;
property statusDescription
statusDescription: string;
interface CloudFrontResponseEvent
interface CloudFrontResponseEvent {}
CloudFront viewer response or origin response event
https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/lambda-event-structure.html#lambda-event-structure-response
property Records
Records: Array<{ cf: CloudFrontEvent & { readonly request: Pick< CloudFrontRequest, Exclude<keyof CloudFrontRequest, 'body'> >; response: CloudFrontResponse; };}>;
interface CloudFrontResultResponse
interface CloudFrontResultResponse {}
Generated HTTP response in viewer request event or origin request event
https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/lambda-generating-http-responses-in-requests.html#lambda-generating-http-responses-object
property body
body?: string | undefined;
property bodyEncoding
bodyEncoding?: 'text' | 'base64' | undefined;
property headers
headers?: CloudFrontHeaders | undefined;
property status
status: string;
property statusDescription
statusDescription?: string | undefined;
interface CloudFrontS3OriginAuthMethodNone
interface CloudFrontS3OriginAuthMethodNone extends CloudFrontS3OriginBase {}
property authMethod
authMethod: 'none';
property region
region?: never;
interface CloudFrontS3OriginAuthMethodOriginAccessIdentity
interface CloudFrontS3OriginAuthMethodOriginAccessIdentity extends CloudFrontS3OriginBase {}
property authMethod
authMethod: 'origin-access-identity';
property region
region: string;
interface CloudFrontS3OriginBase
interface CloudFrontS3OriginBase {}
property authMethod
authMethod: 'origin-access-identity' | 'none';
property customHeaders
customHeaders: CloudFrontHeaders;
property domainName
domainName: string;
property path
path: string;
interface CloudWatchAlarmCompositeConfiguration
interface CloudWatchAlarmCompositeConfiguration {}
property actionsSuppressor
actionsSuppressor?: string;
property actionsSuppressorExtensionPeriod
actionsSuppressorExtensionPeriod?: number;
property actionsSuppressorWaitPeriod
actionsSuppressorWaitPeriod?: number;
property alarmRule
alarmRule: string;
property description
description?: string;
interface CloudWatchAlarmConfiguration
interface CloudWatchAlarmConfiguration {}
property description
description?: string;
property metrics
metrics: CloudWatchAlarmMetricDataQuery[];
interface CloudWatchAlarmData
interface CloudWatchAlarmData {}
property alarmName
alarmName: string;
property configuration
configuration: | CloudWatchAlarmConfiguration | CloudWatchAlarmCompositeConfiguration;
property previousState
previousState: CloudWatchAlarmState;
property state
state: CloudWatchAlarmState;
interface CloudWatchAlarmEvent
interface CloudWatchAlarmEvent {}
interface CloudWatchAlarmExpression
interface CloudWatchAlarmExpression {}
property expression
expression: string;
property id
id: string;
property label
label: string;
property returnData
returnData: boolean;
interface CloudWatchAlarmMetric
interface CloudWatchAlarmMetric {}
property id
id: string;
property metricStat
metricStat: CloudWatchMetricStat;
property returnData
returnData: boolean;
interface CloudWatchAlarmState
interface CloudWatchAlarmState {}
property actionsSuppressedBy
actionsSuppressedBy?: string;
property actionsSuppressedReason
actionsSuppressedReason?: string;
property reason
reason: string;
property reasonData
reasonData?: string;
property timestamp
timestamp: string;
property value
value: string;
interface CloudWatchLogsDecodedData
interface CloudWatchLogsDecodedData {}
property logEvents
logEvents: CloudWatchLogsLogEvent[];
property logGroup
logGroup: string;
property logStream
logStream: string;
property messageType
messageType: string;
property owner
owner: string;
property subscriptionFilters
subscriptionFilters: string[];
interface CloudWatchLogsEvent
interface CloudWatchLogsEvent {}
See http://docs.aws.amazon.com/lambda/latest/dg/eventsources.html#eventsources-cloudwatch-logs
property awslogs
awslogs: CloudWatchLogsEventData;
interface CloudWatchLogsEventData
interface CloudWatchLogsEventData {}
property data
data: string;
interface CloudWatchLogsLogEvent
interface CloudWatchLogsLogEvent {}
See http://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/SubscriptionFilters.html#LambdaFunctionExample
property extractedFields
extractedFields?: CloudWatchLogsLogEventExtractedFields | undefined;
property id
id: string;
property message
message: string;
property timestamp
timestamp: number;
interface CloudWatchLogsLogEventExtractedFields
interface CloudWatchLogsLogEventExtractedFields {}
index signature
[name: string]: string | undefined;
interface CloudWatchMetric
interface CloudWatchMetric {}
property dimensions
dimensions?: Record<string, string>;
property name
name: string;
property namespace
namespace: string;
interface CloudWatchMetricStat
interface CloudWatchMetricStat {}
interface CodeBuildCloudWatchStateEvent
interface CodeBuildCloudWatchStateEvent extends EventBridgeEvent< 'CodeBuild Build State Change', CodeBuildStateEventDetail > {}
property source
source: 'aws.codebuild';
interface CodeBuildStateEventDetail
interface CodeBuildStateEventDetail {}
property "additional-information"
'additional-information': { cache: { type: CodeBuildCacheType; }; 'build-number': number; 'timeout-in-minutes': number; 'build-complete': boolean; initiator: string; 'build-start-time': string; source: { buildspec: string; location: string; type: CodeBuildSourceLocationType; }; 'source-version': string; artifact: { location: string; }; environment: { image: string; 'privileged-mode': boolean; 'image-pull-credentials-type'?: | CodeBuildEnvironmentPullCredentialsType | undefined; 'compute-type': CodeBuildEnvironmentComputeType; type: CodeBuildEnvironmentType; 'environment-variables': Array<{ name: string; type?: CodeBuildEnvironmentVariableType | undefined; value: string; }>; }; 'project-file-system-locations': []; logs: { 'group-name': string; 'stream-name': string; 'deep-link': string; }; phases: Array<{ 'phase-context'?: string[] | undefined; // Not available for COMPLETED phase-type 'start-time': string; 'end-time'?: string | undefined; // Not available for COMPLETED phase-type 'duration-in-seconds'?: number | undefined; // Not available for COMPLETED phase-type 'phase-type': CodeBuildPhaseType; 'phase-status'?: CodeBuildPhaseStatusType | undefined; // Not available for COMPLETED phase-type }>; 'queued-timeout-in-minutes': number;};
property "build-id"
'build-id': string;
property "build-status"
'build-status': CodeBuildStateType;
property "current-phase-context"
'current-phase-context': string;
property "current-phase"
'current-phase': CodeBuildPhaseType;
property "project-name"
'project-name': string;
property version
version: string;
interface CodeCommitTrigger
interface CodeCommitTrigger {}
CodeCommit events https://docs.aws.amazon.com/lambda/latest/dg/services-codecommit.html
property awsRegion
awsRegion: string;
property codecommit
codecommit: { references: Array<{ commit: string; created?: boolean; deleted?: boolean; ref: string; }>;};
property customData
customData?: string;
property eventId
eventId: string;
property eventName
eventName: string;
property eventPartNumber
eventPartNumber: number;
property eventSource
eventSource: string;
property eventSourceARN
eventSourceARN: string;
property eventTime
eventTime: string;
property eventTotalParts
eventTotalParts: number;
property eventTriggerConfigId
eventTriggerConfigId: string;
property eventTriggerName
eventTriggerName: string;
property eventVersion
eventVersion: string;
property userIdentityARN
userIdentityARN: string;
interface CodeCommitTriggerEvent
interface CodeCommitTriggerEvent {}
property Records
Records: CodeCommitTrigger[];
interface CodePipelineCloudWatchActionEvent
interface CodePipelineCloudWatchActionEvent {}
property "detail-type"
'detail-type': 'CodePipeline Action Execution State Change';
property account
account: string;
property detail
detail: { pipeline: string; version: number; 'execution-id': string; stage: string; action: string; state: CodePipelineActionState; type: { owner: 'AWS' | 'Custom' | 'ThirdParty'; category: CodePipelineActionCategory; provider: string; version: number; };};
property id
id: string;
property region
region: string;
property resources
resources: string[];
property source
source: 'aws.codepipeline';
property time
time: string;
property version
version: string;
interface CodePipelineCloudWatchPipelineEvent
interface CodePipelineCloudWatchPipelineEvent {}
CodePipeline CloudWatch Events https://docs.aws.amazon.com/codepipeline/latest/userguide/detect-state-changes-cloudwatch-events.html
The above CodePipelineEvent is when a lambda is invoked by a CodePipeline. These events are when you subscribe to CodePipeline events in CloudWatch.
Their documentation says that detail.version is a string, but it is actually an integer
property "detail-type"
'detail-type': 'CodePipeline Pipeline Execution State Change';
property account
account: string;
property detail
detail: { pipeline: string; version: number; state: CodePipelineState; 'execution-id': string;};
property id
id: string;
property region
region: string;
property resources
resources: string[];
property source
source: 'aws.codepipeline';
property time
time: string;
property version
version: string;
interface CodePipelineCloudWatchStageEvent
interface CodePipelineCloudWatchStageEvent {}
property "detail-type"
'detail-type': 'CodePipeline Stage Execution State Change';
property account
account: string;
property detail
detail: { pipeline: string; version: number; 'execution-id': string; stage: string; state: CodePipelineStageState;};
property id
id: string;
property region
region: string;
property resources
resources: string[];
property source
source: 'aws.codepipeline';
property time
time: string;
property version
version: string;
interface CodePipelineEvent
interface CodePipelineEvent {}
property "CodePipeline.job"
'CodePipeline.job': { id: string; accountId: string; data: { actionConfiguration: { configuration: { FunctionName: string; UserParameters: string; }; }; inputArtifacts: Artifact[]; outputArtifacts: Artifact[]; artifactCredentials: Credentials; encryptionKey?: (EncryptionKey & { type: 'KMS' }) | undefined; continuationToken?: string | undefined; };};
interface CognitoIdentity
interface CognitoIdentity {}
property cognitoIdentityId
cognitoIdentityId: string;
property cognitoIdentityPoolId
cognitoIdentityPoolId: string;
interface CognitoUserPoolTriggerEvent
interface CognitoUserPoolTriggerEvent {}
Cognito User Pool event
Deprecated
Please use specific event types instead http://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html
property callerContext
callerContext: { awsSdkVersion: string; clientId: string;};
property region
region: string;
property request
request: { userAttributes: { [key: string]: string }; validationData?: { [key: string]: string } | undefined; codeParameter?: string | undefined; linkParameter?: string | undefined; usernameParameter?: string | undefined; newDeviceUsed?: boolean | undefined; session?: | Array<{ challengeName: | 'CUSTOM_CHALLENGE' | 'PASSWORD_VERIFIER' | 'SMS_MFA' | 'DEVICE_SRP_AUTH' | 'DEVICE_PASSWORD_VERIFIER' | 'ADMIN_NO_SRP_AUTH' | 'SRP_A'; challengeResult: boolean; challengeMetadata?: string | undefined; }> | undefined; challengeName?: string | undefined; privateChallengeParameters?: { [key: string]: string } | undefined; challengeAnswer?: string | undefined; password?: string | undefined; clientMetadata?: { [key: string]: string } | undefined; userNotFound?: boolean | undefined;};
property response
response: { autoConfirmUser?: boolean | undefined; autoVerifyPhone?: boolean | undefined; autoVerifyEmail?: boolean | undefined; smsMessage?: string | undefined; emailMessage?: string | undefined; emailSubject?: string | undefined; challengeName?: string | undefined; issueTokens?: boolean | undefined; failAuthentication?: boolean | undefined; publicChallengeParameters?: { [key: string]: string } | undefined; privateChallengeParameters?: { [key: string]: string } | undefined; challengeMetadata?: string | undefined; answerCorrect?: boolean | undefined; userAttributes?: { [key: string]: string } | undefined; finalUserStatus?: 'CONFIRMED' | 'RESET_REQUIRED' | undefined; messageAction?: 'SUPPRESS' | undefined; desiredDeliveryMediums?: Array<'EMAIL' | 'SMS'> | undefined; forceAliasCreation?: boolean | undefined; claimsOverrideDetails?: | { claimsToAddOrOverride?: { [key: string]: string } | undefined; claimsToSuppress?: string[] | undefined; groupOverrideDetails?: | null | { groupsToOverride?: string[] | undefined; iamRolesToOverride?: string[] | undefined; preferredRole?: string | undefined; } | undefined; } | undefined;};
property triggerSource
triggerSource: | 'PreSignUp_SignUp' | 'PreSignUp_ExternalProvider' | 'PostConfirmation_ConfirmSignUp' | 'PreAuthentication_Authentication' | 'PostAuthentication_Authentication' | 'CustomMessage_SignUp' | 'CustomMessage_AdminCreateUser' | 'CustomMessage_ResendCode' | 'CustomMessage_ForgotPassword' | 'CustomMessage_UpdateUserAttribute' | 'CustomMessage_VerifyUserAttribute' | 'CustomMessage_Authentication' | 'DefineAuthChallenge_Authentication' | 'CreateAuthChallenge_Authentication' | 'VerifyAuthChallengeResponse_Authentication' | 'PreSignUp_AdminCreateUser' | 'PostConfirmation_ConfirmForgotPassword' | 'TokenGeneration_HostedAuth' | 'TokenGeneration_Authentication' | 'TokenGeneration_NewPasswordChallenge' | 'TokenGeneration_AuthenticateDevice' | 'TokenGeneration_RefreshTokens' | 'UserMigration_Authentication' | 'UserMigration_ForgotPassword';
property userName
userName?: string | undefined;
property userPoolId
userPoolId: string;
property version
version: number;
interface Condition
interface Condition {}
index signature
[key: string]: string | string[];
interface ConditionBlock
interface ConditionBlock {}
API Gateway CustomAuthorizer AuthResponse.PolicyDocument.Condition. https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-control-access-policy-language-overview.html https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_condition.html
index signature
[condition: string]: Condition | Condition[];
interface ConnectContactFlowEndpoint
interface ConnectContactFlowEndpoint {}
interface ConnectContactFlowEvent
interface ConnectContactFlowEvent {}
property Details
Details: { ContactData: { Attributes: { [key: string]: string }; Channel: ConnectContactFlowChannel; ContactId: string; CustomerEndpoint: ConnectContactFlowEndpoint | null; InitialContactId: string; InitiationMethod: ConnectContactFlowInitiationMethod; InstanceARN: string; PreviousContactId: string; Queue: ConnectContactFlowQueue | null; SystemEndpoint: ConnectContactFlowEndpoint | null; MediaStreams: { Customer: { Audio: CustomerAudio; }; }; }; Parameters: { [key: string]: string };};
property Name
Name: 'ContactFlowEvent';
interface ConnectContactFlowQueue
interface ConnectContactFlowQueue {}
interface ConnectContactFlowResult
interface ConnectContactFlowResult {}
index signature
[key: string]: string | null;
interface Context
interface Context {}
Handler context parameter. See .
property awsRequestId
awsRequestId: string;
property callbackWaitsForEmptyEventLoop
callbackWaitsForEmptyEventLoop: boolean;
property clientContext
clientContext?: ClientContext | undefined;
property functionName
functionName: string;
property functionVersion
functionVersion: string;
property identity
identity?: CognitoIdentity | undefined;
property invokedFunctionArn
invokedFunctionArn: string;
property logGroupName
logGroupName: string;
property logStreamName
logStreamName: string;
property memoryLimitInMB
memoryLimitInMB: string;
method done
done: (error?: Error, result?: any) => void;
Deprecated
Use handler callback or promise result
method fail
fail: (error: Error | string) => void;
Deprecated
Use handler callback with first argument or reject a promise result
method getRemainingTimeInMillis
getRemainingTimeInMillis: () => number;
method succeed
succeed: { (messageOrObject: any): void; (message: string, object: any): void };
Deprecated
Use handler callback with second argument or resolve a promise result
Deprecated
Use handler callback or promise result
interface CreateAuthChallengeTriggerEvent
interface CreateAuthChallengeTriggerEvent extends BaseTriggerEvent<'CreateAuthChallenge_Authentication'> {}
See Also
https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-create-auth-challenge.html
property request
request: { userAttributes: StringMap; challengeName: string; session: Array<ChallengeResult | CustomChallengeResult>; userNotFound?: boolean | undefined; clientMetadata?: StringMap | undefined;};
property response
response: { publicChallengeParameters: StringMap; privateChallengeParameters: StringMap; challengeMetadata: string;};
interface Credentials
interface Credentials {}
property accessKeyId
accessKeyId: string;
property secretAccessKey
secretAccessKey: string;
property sessionToken
sessionToken?: string | undefined;
interface CustomAuthorizerEvent
interface CustomAuthorizerEvent {}
Deprecated
Use APIGatewayAuthorizerEvent or a subtype
property apiId
apiId?: string | undefined;
property authorizationToken
authorizationToken?: string | undefined;
property domainName
domainName?: string | undefined;
property headers
headers?: { [name: string]: string } | undefined;
property httpMethod
httpMethod?: string | undefined;
property methodArn
methodArn: string;
property multiValueHeaders
multiValueHeaders?: { [name: string]: string[] } | undefined;
property multiValueQueryStringParameters
multiValueQueryStringParameters?: | { [name: string]: string[] } | null | undefined;
property path
path?: string | undefined;
property pathParameters
pathParameters?: { [name: string]: string } | null | undefined;
property queryStringParameters
queryStringParameters?: { [name: string]: string } | null | undefined;
property requestContext
requestContext?: | APIGatewayEventRequestContextWithAuthorizer<APIGatewayEventDefaultAuthorizerContext> | undefined;
property resource
resource?: string | undefined;
property stageVariables
stageVariables?: { [name: string]: string } | undefined;
property type
type: string;
interface CustomEmailSender_AccountTakeOverNotification_UserAttributes
interface CustomEmailSender_AccountTakeOverNotification_UserAttributes {}
property ACCOUNT_TAKE_OVER_ACTION
ACCOUNT_TAKE_OVER_ACTION: AccountTakeOverActionType;
property CITY
CITY?: string | undefined;
property COUNTRY
COUNTRY?: string | undefined;
property DEVICE_NAME
DEVICE_NAME?: string | undefined;
property EVENT_ID
EVENT_ID: string;
property FEEDBACK_TOKEN
FEEDBACK_TOKEN: string;
property IP_ADDRESS
IP_ADDRESS: string;
property LOGIN_TIME
LOGIN_TIME: string;
property ONE_CLICK_LINK_INVALID
ONE_CLICK_LINK_INVALID: string;
property ONE_CLICK_LINK_VALID
ONE_CLICK_LINK_VALID: string;
property USER_NAME
USER_NAME: string;
interface CustomEmailSenderAccountTakeOverNotificationTriggerEvent
interface CustomEmailSenderAccountTakeOverNotificationTriggerEvent extends BaseTriggerEvent<'CustomEmailSender_AccountTakeOverNotification'> {}
property request
request: { type: string; code: string | null; userAttributes: CustomEmailSender_AccountTakeOverNotification_UserAttributes; clientMetadata?: StringMap | undefined;};
interface CustomEmailSenderAdminCreateUserTriggerEvent
interface CustomEmailSenderAdminCreateUserTriggerEvent extends BaseCustomEmailSenderTriggerEvent<'CustomEmailSender_AdminCreateUser'> {}
interface CustomEmailSenderForgotPasswordTriggerEvent
interface CustomEmailSenderForgotPasswordTriggerEvent extends BaseCustomEmailSenderTriggerEvent<'CustomEmailSender_ForgotPassword'> {}
interface CustomEmailSenderResendCodeTriggerEvent
interface CustomEmailSenderResendCodeTriggerEvent extends BaseCustomEmailSenderTriggerEvent<'CustomEmailSender_ResendCode'> {}
interface CustomEmailSenderSignUpTriggerEvent
interface CustomEmailSenderSignUpTriggerEvent extends BaseCustomEmailSenderTriggerEvent<'CustomEmailSender_SignUp'> {}
interface CustomEmailSenderUpdateUserAttributeTriggerEvent
interface CustomEmailSenderUpdateUserAttributeTriggerEvent extends BaseCustomEmailSenderTriggerEvent<'CustomEmailSender_UpdateUserAttribute'> {}
interface CustomEmailSenderVerifyUserAttributeTriggerEvent
interface CustomEmailSenderVerifyUserAttributeTriggerEvent extends BaseCustomEmailSenderTriggerEvent<'CustomEmailSender_VerifyUserAttribute'> {}
interface CustomSMSSenderAdminCreateUserTriggerEvent
interface CustomSMSSenderAdminCreateUserTriggerEvent extends BaseCustomSMSSenderTriggerEvent<'CustomSMSSender_AdminCreateUser'> {}
interface CustomSMSSenderAuthenticationUserTriggerEvent
interface CustomSMSSenderAuthenticationUserTriggerEvent extends BaseCustomSMSSenderTriggerEvent<'CustomSMSSender_Authentication'> {}
interface CustomSMSSenderForgotPasswordTriggerEvent
interface CustomSMSSenderForgotPasswordTriggerEvent extends BaseCustomSMSSenderTriggerEvent<'CustomSMSSender_ForgotPassword'> {}
interface CustomSMSSenderResendCodeTriggerEvent
interface CustomSMSSenderResendCodeTriggerEvent extends BaseCustomSMSSenderTriggerEvent<'CustomSMSSender_ResendCode'> {}
interface CustomSMSSenderSignUpTriggerEvent
interface CustomSMSSenderSignUpTriggerEvent extends BaseCustomSMSSenderTriggerEvent<'CustomSMSSender_SignUp'> {}
interface CustomSMSSenderUpdateUserAttributeTriggerEvent
interface CustomSMSSenderUpdateUserAttributeTriggerEvent extends BaseCustomSMSSenderTriggerEvent<'CustomSMSSender_UpdateUserAttribute'> {}
interface CustomSMSSenderVerifyUserAttributeTriggerEvent
interface CustomSMSSenderVerifyUserAttributeTriggerEvent extends BaseCustomSMSSenderTriggerEvent<'CustomSMSSender_VerifyUserAttribute'> {}
interface DefineAuthChallengeTriggerEvent
interface DefineAuthChallengeTriggerEvent extends BaseTriggerEvent<'DefineAuthChallenge_Authentication'> {}
See Also
https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-define-auth-challenge.html
property request
request: { userAttributes: StringMap; session: Array<ChallengeResult | CustomChallengeResult>; userNotFound?: boolean | undefined; clientMetadata?: StringMap | undefined;};
property response
response: { challengeName?: string | undefined; failAuthentication: boolean; issueTokens: boolean;};
interface DynamoDBBatchItemFailure
interface DynamoDBBatchItemFailure {}
property itemIdentifier
itemIdentifier: string;
interface DynamoDBBatchResponse
interface DynamoDBBatchResponse {}
property batchItemFailures
batchItemFailures: DynamoDBBatchItemFailure[];
interface DynamoDBRecord
interface DynamoDBRecord {}
property awsRegion
awsRegion?: string | undefined;
property dynamodb
dynamodb?: StreamRecord | undefined;
property eventID
eventID?: string | undefined;
property eventName
eventName?: 'INSERT' | 'MODIFY' | 'REMOVE' | undefined;
property eventSource
eventSource?: string | undefined;
property eventSourceARN
eventSourceARN?: string | undefined;
property eventVersion
eventVersion?: string | undefined;
property userIdentity
userIdentity?: any;
interface DynamoDBStreamEvent
interface DynamoDBStreamEvent {}
property Records
Records: DynamoDBRecord[];
interface EncryptionKey
interface EncryptionKey {}
interface EventBridgeEvent
interface EventBridgeEvent<TDetailType extends string, TDetail> {}
property "detail-type"
'detail-type': TDetailType;
property "replay-name"
'replay-name'?: string;
property account
account: string;
property detail
detail: TDetail;
property id
id: string;
property region
region: string;
property resources
resources: string[];
property source
source: string;
property time
time: string;
property version
version: string;
interface FirehoseRecordMetadata
interface FirehoseRecordMetadata {}
property approximateArrivalTimestamp
approximateArrivalTimestamp: number;
property partitionKey
partitionKey: string;
property sequenceNumber
sequenceNumber: string;
property shardId
shardId: string;
property subsequenceNumber
subsequenceNumber: string;
interface FirehoseTransformationEvent
interface FirehoseTransformationEvent {}
property deliveryStreamArn
deliveryStreamArn: string;
property invocationId
invocationId: string;
property records
records: FirehoseTransformationEventRecord[];
property region
region: string;
property sourceKinesisStreamArn
sourceKinesisStreamArn?: string | undefined;
interface FirehoseTransformationEventRecord
interface FirehoseTransformationEventRecord {}
property approximateArrivalTimestamp
approximateArrivalTimestamp: number;
property data
data: string;
Base64 encoded
property kinesisRecordMetadata
kinesisRecordMetadata?: FirehoseRecordMetadata | undefined;
property recordId
recordId: string;
interface FirehoseTransformationMetadata
interface FirehoseTransformationMetadata {}
property partitionKeys
partitionKeys: { [name: string]: string };
interface FirehoseTransformationResult
interface FirehoseTransformationResult {}
property records
records: FirehoseTransformationResultRecord[];
interface FirehoseTransformationResultRecord
interface FirehoseTransformationResultRecord {}
interface GroupOverrideDetails
interface GroupOverrideDetails {}
property groupsToOverride
groupsToOverride?: string[] | undefined;
property iamRolesToOverride
iamRolesToOverride?: string[] | undefined;
property preferredRole
preferredRole?: string | undefined;
interface GroupOverrideDetailsV2
interface GroupOverrideDetailsV2 {}
property groupsToOverride
groupsToOverride?: string[] | undefined;
property iamRolesToOverride
iamRolesToOverride?: string[] | undefined;
property preferredRole
preferredRole?: string | undefined;
interface GuardDutyScanResultNotificationEvent
interface GuardDutyScanResultNotificationEvent extends EventBridgeEvent< 'GuardDuty Malware Protection Object Scan Result', GuardDutyScanResultNotificationEventDetail > {}
Guard Duty events https://docs.aws.amazon.com/guardduty/latest/ug/monitor-with-eventbridge-s3-malware-protection.html
property source
source: 'aws.guardduty';
interface GuardDutyScanResultNotificationEventDetail
interface GuardDutyScanResultNotificationEventDetail {}
property resourceType
resourceType: 'S3_OBJECT';
property s3ObjectDetails
s3ObjectDetails: { bucketName: string; objectKey: string; etag: string; versionId: string; s3Throttled: boolean;};
property scanResultDetails
scanResultDetails: { scanResultStatus: | 'NO_THREATS_FOUND' | 'THREAT_FOUND' | 'UNSUPPORTED' | 'ACCESS_DENIED' | 'FAILED'; threats: GuardDutyThreatDetail[] | null;};
property scanStatus
scanStatus: 'COMPLETED' | 'SKIPPED' | 'FAILED';
property schemaVersion
schemaVersion: '1.0';
interface GuardDutyThreatDetail
interface GuardDutyThreatDetail {}
property name
name: string;
interface IdTokenGeneration
interface IdTokenGeneration {}
See Also
https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-token-generation.html#cognito-user-pools-lambda-trigger-syntax-pre-token-generation
property claimsToAddOrOverride
claimsToAddOrOverride?: StringMap | undefined;
property claimsToSuppress
claimsToSuppress?: string[] | undefined;
interface IoTCustomAuthorizerEvent
interface IoTCustomAuthorizerEvent {}
property connectionMetadata
connectionMetadata: { id: string; // The connection ID. You can use this for logging.};
property protocolData
protocolData: { tls?: IoTProtocolDataTLS; http?: IoTProtocolDataHTTP; mqtt?: IoTProtocolDataMQTT;};
property protocols
protocols: IoTProtocolType[];
property signatureVerified
signatureVerified: boolean;
property token
token?: string;
interface IoTCustomAuthorizerResult
interface IoTCustomAuthorizerResult {}
IoT CustomAuthorizer AuthResponse.PolicyDocument. https://docs.aws.amazon.com/iot/latest/developerguide/config-custom-auth.html#custom-auth-lambda https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements.html#Condition
property disconnectAfterInSeconds
disconnectAfterInSeconds: number;
property isAuthenticated
isAuthenticated: boolean;
property policyDocuments
policyDocuments: PolicyDocument[];
property principalId
principalId: string;
property refreshAfterInSeconds
refreshAfterInSeconds: number;
interface IoTPreProvisioningHookEvent
interface IoTPreProvisioningHookEvent {}
property certificateId
certificateId: string;
property certificatePem
certificatePem: string;
property claimCertificateId
claimCertificateId: string;
property clientId
clientId: string;
property parameters
parameters: Record<string, string>;
property templateArn
templateArn: string;
interface IoTPreProvisioningHookResult
interface IoTPreProvisioningHookResult {}
property allowProvisioning
allowProvisioning: boolean;
property parameterOverrides
parameterOverrides: Record<string, string>;
interface IoTProtocolDataHTTP
interface IoTProtocolDataHTTP {}
property headers
headers: Record<string, string>;
property queryString
queryString: string;
interface IoTProtocolDataMQTT
interface IoTProtocolDataMQTT {}
interface IoTProtocolDataTLS
interface IoTProtocolDataTLS {}
property serverName
serverName: string;
interface KinesisStreamBatchItemFailure
interface KinesisStreamBatchItemFailure {}
property itemIdentifier
itemIdentifier: string;
interface KinesisStreamBatchResponse
interface KinesisStreamBatchResponse {}
property batchItemFailures
batchItemFailures: KinesisStreamBatchItemFailure[];
interface KinesisStreamEvent
interface KinesisStreamEvent {}
property Records
Records: KinesisStreamRecord[];
interface KinesisStreamRecord
interface KinesisStreamRecord {}
property awsRegion
awsRegion: string;
property eventID
eventID: string;
property eventName
eventName: string;
property eventSource
eventSource: string;
property eventSourceARN
eventSourceARN: string;
property eventVersion
eventVersion: string;
property invokeIdentityArn
invokeIdentityArn: string;
property kinesis
kinesis: KinesisStreamRecordPayload;
interface KinesisStreamRecordPayload
interface KinesisStreamRecordPayload {}
property approximateArrivalTimestamp
approximateArrivalTimestamp: number;
property data
data: string;
property kinesisSchemaVersion
kinesisSchemaVersion: string;
property partitionKey
partitionKey: string;
property sequenceNumber
sequenceNumber: string;
interface KinesisStreamStateResponse
interface KinesisStreamStateResponse extends Partial<KinesisStreamBatchResponse> {}
property state
state: { [key: string]: any };
interface KinesisStreamTumblingWindowEvent
interface KinesisStreamTumblingWindowEvent extends KinesisStreamEvent {}
property isFinalInvokeForWindow
isFinalInvokeForWindow: boolean;
property isWindowTerminatedEarly
isWindowTerminatedEarly: boolean;
property state
state?: { [key: string]: any };
property window
window: { start: string; end: string };
interface LexDialogActionBase
interface LexDialogActionBase {}
property message
message?: | { contentType: 'PlainText' | 'SSML' | 'CustomPayload'; content: string; } | undefined;
property responseCard
responseCard?: | { version: number; contentType: 'application/vnd.amazonaws.card.generic'; genericAttachments: LexGenericAttachment[]; } | undefined;
property type
type: 'Close' | 'ElicitIntent' | 'ElicitSlot' | 'ConfirmIntent';
interface LexDialogActionClose
interface LexDialogActionClose extends LexDialogActionBase {}
property fulfillmentState
fulfillmentState: 'Fulfilled' | 'Failed';
property type
type: 'Close';
interface LexDialogActionConfirmIntent
interface LexDialogActionConfirmIntent extends LexDialogActionBase {}
property intentName
intentName: string;
property slots
slots: { [name: string]: string | null };
property type
type: 'ConfirmIntent';
interface LexDialogActionDelegate
interface LexDialogActionDelegate {}
interface LexDialogActionElicitIntent
interface LexDialogActionElicitIntent extends LexDialogActionBase {}
property type
type: 'ElicitIntent';
interface LexDialogActionElicitSlot
interface LexDialogActionElicitSlot extends LexDialogActionBase {}
property intentName
intentName: string;
property slots
slots: { [name: string]: string | null };
property slotToElicit
slotToElicit: string;
property type
type: 'ElicitSlot';
interface LexEvent
interface LexEvent {}
property bot
bot: { name: string; alias: string; version: string;};
property currentIntent
currentIntent: { name: string; slots: LexEventSlots; slotDetails: LexSlotDetails; confirmationStatus: 'None' | 'Confirmed' | 'Denied';};
property inputTranscript
inputTranscript: string;
property invocationSource
invocationSource: 'DialogCodeHook' | 'FulfillmentCodeHook';
property messageVersion
messageVersion: '1.0';
property outputDialogMode
outputDialogMode: 'Text' | 'Voice';
property requestAttributes
requestAttributes: LexEventRequestAttributes | null;
property sessionAttributes
sessionAttributes: LexEventSessionAttributes;
property userId
userId: string;
interface LexEventRequestAttributes
interface LexEventRequestAttributes {}
index signature
[key: string]: string | undefined;
interface LexEventSessionAttributes
interface LexEventSessionAttributes {}
index signature
[key: string]: string | undefined;
interface LexEventSlots
interface LexEventSlots {}
index signature
[name: string]: string | undefined | null;
interface LexGenericAttachment
interface LexGenericAttachment {}
property attachmentLinkUrl
attachmentLinkUrl: string;
property buttons
buttons: Array<{ text: string; value: string;}>;
property imageUrl
imageUrl: string;
property subTitle
subTitle: string;
property title
title: string;
interface LexResult
interface LexResult {}
property dialogAction
dialogAction: LexDialogAction;
property sessionAttributes
sessionAttributes?: { [key: string]: string } | undefined;
interface LexSlotDetail
interface LexSlotDetail {}
property originalValue
originalValue: string;
property resolutions
resolutions: [ LexSlotResolution, LexSlotResolution?, LexSlotResolution?, LexSlotResolution?, LexSlotResolution?];
interface LexSlotDetails
interface LexSlotDetails {}
index signature
[name: string]: LexSlotDetail;
interface LexSlotResolution
interface LexSlotResolution {}
property value
value: string;
interface LexV2ActiveContext
interface LexV2ActiveContext {}
property contextAttributes
contextAttributes: Record<string, string>;
property name
name: string;
property timeToLive
timeToLive: { timeToLiveInSeconds: number; turnsToLive: number;};
interface LexV2Bot
interface LexV2Bot {}
interface LexV2ContentMessage
interface LexV2ContentMessage {}
property content
content: string;
property contentType
contentType: 'CustomPayload' | 'PlainText' | 'SSML';
interface LexV2Event
interface LexV2Event {}
property bot
bot: LexV2Bot;
property inputMode
inputMode: 'DTMF' | 'Speech' | 'Text';
property inputTranscript
inputTranscript: string;
property interpretations
interpretations: LexV2Interpretation[];
property invocationSource
invocationSource: 'DialogCodeHook' | 'FulfillmentCodeHook';
property messageVersion
messageVersion: string;
property proposedNextState
proposedNextState: { dialogAction: LexV2DialogAction; intent: LexV2Intent;};
property requestAttributes
requestAttributes?: Record<string, string>;
property responseContentType
responseContentType: string;
property sessionId
sessionId: string;
property sessionState
sessionState: LexV2SessionState;
property transcriptions
transcriptions: LexV2Transcription[];
interface LexV2ImageResponseCard
interface LexV2ImageResponseCard {}
interface LexV2ImageResponseCardButton
interface LexV2ImageResponseCardButton {}
interface LexV2ImageResponseCardMessage
interface LexV2ImageResponseCardMessage {}
property contentType
contentType: 'ImageResponseCard';
property imageResponseCard
imageResponseCard: LexV2ImageResponseCard;
interface LexV2Intent
interface LexV2Intent {}
property confirmationState
confirmationState: 'Confirmed' | 'Denied' | 'None';
property kendraResponse
kendraResponse?: any;
property name
name: string;
property slots
slots: LexV2Slots;
property state
state: LexV2IntentState;
interface LexV2Interpretation
interface LexV2Interpretation {}
property intent
intent: LexV2Intent;
property nluConfidence
nluConfidence?: number;
property sentimentResponse
sentimentResponse?: LexV2SentimentResponse;
interface LexV2ListSlotValue
interface LexV2ListSlotValue {}
interface LexV2Result
interface LexV2Result {}
property messages
messages?: LexV2Message[];
property sessionState
sessionState: { sessionAttributes?: Record<string, string>; dialogAction: LexV2ResultDialogAction; intent?: { name?: string; state: LexV2IntentState; slots?: LexV2Slots; };};
interface LexV2ScalarSlotValue
interface LexV2ScalarSlotValue {}
interface LexV2SentimentResponse
interface LexV2SentimentResponse {}
property sentiment
sentiment: string;
property sentimentScore
sentimentScore: LexV2SentimentScore;
interface LexV2SentimentScore
interface LexV2SentimentScore {}
interface LexV2SessionState
interface LexV2SessionState {}
property activeContexts
activeContexts?: LexV2ActiveContext[];
property dialogAction
dialogAction?: LexV2DialogAction;
property intent
intent: LexV2Intent;
property originatingRequestId
originatingRequestId: string;
property sessionAttributes
sessionAttributes?: Record<string, string>;
interface LexV2SlotValue
interface LexV2SlotValue {}
property interpretedValue
interpretedValue?: string;
property originalValue
originalValue: string;
property resolvedValues
resolvedValues: string[];
interface LexV2Transcription
interface LexV2Transcription {}
property resolvedContext
resolvedContext: { intent: string;};
property resolvedSlots
resolvedSlots: LexV2Slots;
property transcription
transcription: string;
property transcriptionConfidence
transcriptionConfidence: number;
interface MaybeStatementPrincipal
interface MaybeStatementPrincipal {}
property NotPrincipal
NotPrincipal?: PrincipalValue | undefined;
property Principal
Principal?: PrincipalValue | undefined;
interface MaybeStatementResource
interface MaybeStatementResource {}
property NotResource
NotResource?: string | string[] | undefined;
property Resource
Resource?: string | string[] | undefined;
interface MSKEvent
interface MSKEvent {}
property bootstrapServers
bootstrapServers: string;
property eventSource
eventSource: 'aws:kafka';
property eventSourceArn
eventSourceArn: string;
property records
records: { [topic: string]: MSKRecord[];};
interface MSKRecord
interface MSKRecord {}
interface MSKRecordHeader
interface MSKRecordHeader {}
index signature
[headerKey: string]: number[];
interface PolicyDocument
interface PolicyDocument {}
API Gateway CustomAuthorizer AuthResponse.PolicyDocument. https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-lambda-authorizer-output.html https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements.html#Condition
interface PostAuthenticationTriggerEvent
interface PostAuthenticationTriggerEvent extends BaseTriggerEvent<'PostAuthentication_Authentication'> {}
See Also
https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-post-authentication.html
property request
request: { userAttributes: StringMap; newDeviceUsed: boolean; clientMetadata?: StringMap | undefined;};
interface PreAuthenticationTriggerEvent
interface PreAuthenticationTriggerEvent extends BaseTriggerEvent<'PreAuthentication_Authentication'> {}
See Also
https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-authentication.html
property request
request: { userAttributes: StringMap; userNotFound?: boolean | undefined; validationData?: StringMap | undefined; clientMetadata?: StringMap | undefined;};
interface S3ArtifactLocation
interface S3ArtifactLocation {}
CodePipeline events https://docs.aws.amazon.com/codepipeline/latest/userguide/actions-invoke-lambda-function.html
property bucketName
bucketName: string;
property objectKey
objectKey: string;
interface S3ArtifactStore
interface S3ArtifactStore {}
property s3Location
s3Location: S3ArtifactLocation;
property type
type: 'S3';
interface S3BatchEvent
interface S3BatchEvent {}
property invocationId
invocationId: string;
property invocationSchemaVersion
invocationSchemaVersion: string;
property job
job: S3BatchEventJob;
property tasks
tasks: S3BatchEventTask[];
interface S3BatchEventJob
interface S3BatchEventJob {}
property id
id: string;
interface S3BatchEventTask
interface S3BatchEventTask {}
property s3BucketArn
s3BucketArn: string;
property s3Key
s3Key: string;
property s3VersionId
s3VersionId: string | null;
property taskId
taskId: string;
interface S3BatchResult
interface S3BatchResult {}
property invocationId
invocationId: string;
property invocationSchemaVersion
invocationSchemaVersion: string;
property results
results: S3BatchResultResult[];
property treatMissingKeysAs
treatMissingKeysAs: S3BatchResultResultCode;
interface S3BatchResultResult
interface S3BatchResultResult {}
property resultCode
resultCode: S3BatchResultResultCode;
property resultString
resultString: string;
property taskId
taskId: string;
interface S3EventRecord
interface S3EventRecord {}
property awsRegion
awsRegion: string;
property eventName
eventName: string;
property eventSource
eventSource: string;
property eventTime
eventTime: string;
property eventVersion
eventVersion: string;
property glacierEventData
glacierEventData?: S3EventRecordGlacierEventData | undefined;
property requestParameters
requestParameters: { sourceIPAddress: string;};
property responseElements
responseElements: { 'x-amz-request-id': string; 'x-amz-id-2': string;};
property s3
s3: { s3SchemaVersion: string; configurationId: string; bucket: { name: string; ownerIdentity: { principalId: string; }; arn: string; }; object: { key: string; size: number; eTag: string; versionId?: string | undefined; sequencer: string; };};
property userIdentity
userIdentity: { principalId: string;};
interface S3EventRecordGlacierEventData
interface S3EventRecordGlacierEventData {}
property restoreEventData
restoreEventData: S3EventRecordGlacierRestoreEventData;
interface S3EventRecordGlacierRestoreEventData
interface S3EventRecordGlacierRestoreEventData {}
S3Create event https://docs.aws.amazon.com/AmazonS3/latest/dev/notification-content-structure.html
property lifecycleRestorationExpiryTime
lifecycleRestorationExpiryTime: string;
property lifecycleRestoreStorageClass
lifecycleRestoreStorageClass: string;
interface S3ObjectAccessTierChangedNotificationEvent
interface S3ObjectAccessTierChangedNotificationEvent extends EventBridgeEvent< 'Object Access Tier Changed', S3ObjectAccessTierChangedNotificationEventDetail > {}
property source
source: 'aws.s3';
interface S3ObjectAccessTierChangedNotificationEventDetail
interface S3ObjectAccessTierChangedNotificationEventDetail {}
property "destination-access-tier"
'destination-access-tier': 'ARCHIVE_ACCESS' | 'DEEP_ARCHIVE_ACCESS';
property "request-id"
'request-id': string;
property bucket
bucket: { name: string;};
property object
object: { key: string; size: number; etag: string; 'version-id': string;};
property requester
requester: string;
property version
version: '0';
interface S3ObjectACLUpdatedNotificationEvent
interface S3ObjectACLUpdatedNotificationEvent extends EventBridgeEvent< 'Object ACL Updated', S3ObjectACLUpdatedNotificationEventDetail > {}
property source
source: 'aws.s3';
interface S3ObjectACLUpdatedNotificationEventDetail
interface S3ObjectACLUpdatedNotificationEventDetail {}
property "request-id"
'request-id': string;
property "source-ip-address"
'source-ip-address': string;
property bucket
bucket: { name: string;};
property object
object: { key: string; etag: string; 'version-id': string;};
property requester
requester: string;
property version
version: '0';
interface S3ObjectCreatedNotificationEvent
interface S3ObjectCreatedNotificationEvent extends EventBridgeEvent< 'Object Created', S3ObjectCreatedNotificationEventDetail > {}
property source
source: 'aws.s3';
interface S3ObjectCreatedNotificationEventDetail
interface S3ObjectCreatedNotificationEventDetail {}
property "request-id"
'request-id': string;
property "source-ip-address"
'source-ip-address': string;
property bucket
bucket: { name: string;};
property object
object: { key: string; size: number; etag: string; 'version-id': string; sequencer: string;};
property reason
reason: 'PutObject' | 'POST Object' | 'CopyObject' | 'CompleteMultipartUpload';
property requester
requester: string;
property version
version: '0';
interface S3ObjectDeletedNotificationEvent
interface S3ObjectDeletedNotificationEvent extends EventBridgeEvent< 'Object Deleted', S3ObjectDeletedNotificationEventDetail > {}
property source
source: 'aws.s3';
interface S3ObjectDeletedNotificationEventDeleteObjectDetail
interface S3ObjectDeletedNotificationEventDeleteObjectDetail {}
property "deletion-type"
'deletion-type': 'Permanently Deleted' | 'Delete Marker Created';
property "request-id"
'request-id': string;
property "source-ip-address"
'source-ip-address': string;
property bucket
bucket: { name: string;};
property object
object: { key: string; etag: string; 'version-id': string; sequencer: string;};
property reason
reason: 'DeleteObject';
property requester
requester: string;
property version
version: '0';
interface S3ObjectDeletedNotificationEventLifecycleExpirationDetail
interface S3ObjectDeletedNotificationEventLifecycleExpirationDetail {}
property "deletion-type"
'deletion-type': 'Permanently Deleted' | 'Delete Marker Created';
property "request-id"
'request-id': string;
property bucket
bucket: { name: string;};
property object
object: { key: string; etag: string; 'version-id': string; sequencer: string;};
property reason
reason: 'Lifecycle Expiration';
property requester
requester: string;
property version
version: '0';
interface S3ObjectRestoreCompletedNotificationEvent
interface S3ObjectRestoreCompletedNotificationEvent extends EventBridgeEvent< 'Object Restore Completed', S3ObjectRestoreCompletedNotificationEventDetail > {}
property source
source: 'aws.s3';
interface S3ObjectRestoreCompletedNotificationEventDetail
interface S3ObjectRestoreCompletedNotificationEventDetail {}
property "request-id"
'request-id': string;
property "restore-expiry-time"
'restore-expiry-time': string;
property "source-storage-class"
'source-storage-class': | 'STANDARD' | 'REDUCED_REDUNDANCY' | 'STANDARD_IA' | 'ONEZONE_IA' | 'INTELLIGENT_TIERING' | 'GLACIER' | 'DEEP_ARCHIVE' | 'OUTPOSTS' | 'GLACIER_IR';
property bucket
bucket: { name: string;};
property object
object: { key: string; size: number; 'version-id': string; etag: string;};
property requester
requester: 's3.amazonaws.com';
property version
version: '0';
interface S3ObjectRestoreExpiredNotificationEvent
interface S3ObjectRestoreExpiredNotificationEvent extends EventBridgeEvent< 'Object Restore Expired', S3ObjectRestoreExpiredNotificationEventDetail > {}
property source
source: 'aws.s3';
interface S3ObjectRestoreExpiredNotificationEventDetail
interface S3ObjectRestoreExpiredNotificationEventDetail {}
property "request-id"
'request-id': string;
property bucket
bucket: { name: string;};
property object
object: { key: string; 'version-id': string; etag: string;};
property requester
requester: 's3.amazonaws.com';
property version
version: '0';
interface S3ObjectRestoreInitiatedNotificationEvent
interface S3ObjectRestoreInitiatedNotificationEvent extends EventBridgeEvent< 'Object Restore Initiated', S3ObjectRestoreInitiatedNotificationEventDetail > {}
property source
source: 'aws.s3';
interface S3ObjectRestoreInitiatedNotificationEventDetail
interface S3ObjectRestoreInitiatedNotificationEventDetail {}
property "request-id"
'request-id': string;
property "source-ip-address"
'source-ip-address': string;
property "source-storage-class"
'source-storage-class': | 'STANDARD' | 'REDUCED_REDUNDANCY' | 'STANDARD_IA' | 'ONEZONE_IA' | 'INTELLIGENT_TIERING' | 'GLACIER' | 'DEEP_ARCHIVE' | 'OUTPOSTS' | 'GLACIER_IR';
property bucket
bucket: { name: string;};
property object
object: { key: string; size: number; 'version-id': string; etag: string;};
property requester
requester: string;
property version
version: '0';
interface S3ObjectStorageClassChangedNotificationEvent
interface S3ObjectStorageClassChangedNotificationEvent extends EventBridgeEvent< 'Object Storage Class Changed', S3ObjectStorageClassChangedNotificationEventDetail > {}
property source
source: 'aws.s3';
interface S3ObjectStorageClassChangedNotificationEventDetail
interface S3ObjectStorageClassChangedNotificationEventDetail {}
property "destination-storage-class"
'destination-storage-class': | 'STANDARD' | 'REDUCED_REDUNDANCY' | 'STANDARD_IA' | 'ONEZONE_IA' | 'INTELLIGENT_TIERING' | 'GLACIER' | 'DEEP_ARCHIVE' | 'OUTPOSTS' | 'GLACIER_IR';
property "request-id"
'request-id': string;
property bucket
bucket: { name: string;};
property object
object: { key: string; size: number; 'version-id': string; etag: string;};
property requester
requester: string;
property version
version: '0';
interface S3ObjectTagsAddedNotificationEvent
interface S3ObjectTagsAddedNotificationEvent extends EventBridgeEvent< 'Object Tags Added', S3ObjectTagsAddedNotificationEventDetail > {}
property source
source: 'aws.s3';
interface S3ObjectTagsAddedNotificationEventDetail
interface S3ObjectTagsAddedNotificationEventDetail {}
property "request-id"
'request-id': string;
property "source-ip-address"
'source-ip-address': string;
property bucket
bucket: { name: string;};
property object
object: { key: string; 'version-id': string; etag: string;};
property requester
requester: string;
property version
version: '0';
interface S3ObjectTagsDeletedNotificationEvent
interface S3ObjectTagsDeletedNotificationEvent extends EventBridgeEvent< 'Object Tags Deleted', S3ObjectTagsDeletedNotificationEventDetail > {}
property source
source: 'aws.s3';
interface S3ObjectTagsDeletedNotificationEventDetail
interface S3ObjectTagsDeletedNotificationEventDetail {}
property "request-id"
'request-id': string;
property "source-ip-address"
'source-ip-address': string;
property bucket
bucket: { name: string;};
property object
object: { key: string; 'version-id': string; etag: string;};
property requester
requester: string;
property version
version: '0';
interface ScheduledEvent
interface ScheduledEvent<TDetail = any> extends EventBridgeEvent<'Scheduled Event', TDetail> {}
https://docs.aws.amazon.com/lambda/latest/dg/with-scheduled-events.html
interface SecretsManagerRotationEvent
interface SecretsManagerRotationEvent {}
Secrets Manager Rotation event https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets-lambda-function-overview.html
property ClientRequestToken
ClientRequestToken: string;
property SecretId
SecretId: string;
property Step
Step: SecretsManagerRotationEventStep;
interface SelfManagedKafkaEvent
interface SelfManagedKafkaEvent {}
property bootstrapServers
bootstrapServers: string;
property eventSource
eventSource: 'SelfManagedKafka';
property records
records: { [topic: string]: SelfManagedKafkaRecord[];};
interface SelfManagedKafkaRecord
interface SelfManagedKafkaRecord {}
property headers
headers: SelfManagedKafkaRecordHeader[];
property key
key: string;
property offset
offset: number;
property partition
partition: number;
property timestamp
timestamp: number;
property timestampType
timestampType: 'CREATE_TIME' | 'LOG_APPEND_TIME';
property topic
topic: string;
property value
value: string;
interface SelfManagedKafkaRecordHeader
interface SelfManagedKafkaRecordHeader {}
index signature
[headerKey: string]: number[];
interface SESEventRecord
interface SESEventRecord {}
property eventSource
eventSource: string;
property eventVersion
eventVersion: string;
property ses
ses: SESMessage;
interface SESMail
interface SESMail {}
property commonHeaders
commonHeaders: SESMailCommonHeaders;
property destination
destination: string[];
property headers
headers: SESMailHeader[];
property headersTruncated
headersTruncated: boolean;
property messageId
messageId: string;
property source
source: string;
property timestamp
timestamp: string;
interface SESMailCommonHeaders
interface SESMailCommonHeaders {}
property bcc
bcc?: string[] | undefined;
property cc
cc?: string[] | undefined;
property date
date: string;
property from
from?: string[] | undefined;
property messageId
messageId: string;
property replyTo
replyTo?: string[] | undefined;
property returnPath
returnPath: string;
property sender
sender?: string[] | undefined;
property subject
subject?: string | undefined;
property to
to?: string[] | undefined;
interface SESMailHeader
interface SESMailHeader {}
interface SESMessage
interface SESMessage {}
interface SESReceipt
interface SESReceipt {}
property action
action: | SESReceiptS3Action | SESReceiptSnsAction | SESReceiptBounceAction | SESReceiptLambdaAction | SESReceiptStopAction | SESReceiptWorkMailAction;
property dkimVerdict
dkimVerdict: SESReceiptStatus;
property dmarcPolicy
dmarcPolicy?: 'none' | 'quarantine' | 'reject' | undefined;
property dmarcVerdict
dmarcVerdict: SESReceiptStatus;
property processingTimeMillis
processingTimeMillis: number;
property recipients
recipients: string[];
property spamVerdict
spamVerdict: SESReceiptStatus;
property spfVerdict
spfVerdict: SESReceiptStatus;
property timestamp
timestamp: string;
property virusVerdict
virusVerdict: SESReceiptStatus;
interface SESReceiptBounceAction
interface SESReceiptBounceAction {}
property message
message: string;
property sender
sender: string;
property smtpReplyCode
smtpReplyCode: string;
property statusCode
statusCode: string;
property topicArn
topicArn?: string | undefined;
property type
type: 'Bounce';
interface SESReceiptLambdaAction
interface SESReceiptLambdaAction {}
property functionArn
functionArn: string;
property invocationType
invocationType: string;
property topicArn
topicArn?: string | undefined;
property type
type: 'Lambda';
interface SESReceiptS3Action
interface SESReceiptS3Action {}
property bucketName
bucketName: string;
property objectKey
objectKey: string;
property topicArn
topicArn?: string | undefined;
property type
type: 'S3';
interface SESReceiptSnsAction
interface SESReceiptSnsAction {}
interface SESReceiptStatus
interface SESReceiptStatus {}
property status
status: 'PASS' | 'FAIL' | 'GRAY' | 'PROCESSING_FAILED' | 'DISABLED';
interface SESReceiptStopAction
interface SESReceiptStopAction {}
interface SESReceiptWorkMailAction
interface SESReceiptWorkMailAction {}
property organizationArn
organizationArn: string;
property topicArn
topicArn?: string | undefined;
property type
type: 'WorkMail';
interface SNSEventRecord
interface SNSEventRecord {}
property EventSource
EventSource: string;
property EventSubscriptionArn
EventSubscriptionArn: string;
property EventVersion
EventVersion: string;
property Sns
Sns: SNSMessage;
interface SNSMessage
interface SNSMessage {}
property Message
Message: string;
property MessageAttributes
MessageAttributes: SNSMessageAttributes;
property MessageId
MessageId: string;
property Signature
Signature: string;
property SignatureVersion
SignatureVersion: string;
property SigningCertUrl
SigningCertUrl: string;
property Subject
Subject?: string;
property Timestamp
Timestamp: string;
property Token
Token?: string;
property TopicArn
TopicArn: string;
property Type
Type: string;
property UnsubscribeUrl
UnsubscribeUrl: string;
interface SNSMessageAttribute
interface SNSMessageAttribute {}
interface SNSMessageAttributes
interface SNSMessageAttributes {}
index signature
[name: string]: SNSMessageAttribute;
interface SQSBatchItemFailure
interface SQSBatchItemFailure {}
property itemIdentifier
itemIdentifier: string;
interface SQSBatchResponse
interface SQSBatchResponse {}
property batchItemFailures
batchItemFailures: SQSBatchItemFailure[];
interface SQSMessageAttribute
interface SQSMessageAttribute {}
property binaryListValues
binaryListValues?: string[] | undefined;
property binaryValue
binaryValue?: string | undefined;
property dataType
dataType: SQSMessageAttributeDataType;
property stringListValues
stringListValues?: string[] | undefined;
property stringValue
stringValue?: string | undefined;
interface SQSMessageAttributes
interface SQSMessageAttributes {}
index signature
[name: string]: SQSMessageAttribute;
interface SQSRecord
interface SQSRecord {}
property attributes
attributes: SQSRecordAttributes;
property awsRegion
awsRegion: string;
property body
body: string;
property eventSource
eventSource: string;
property eventSourceARN
eventSourceARN: string;
property md5OfBody
md5OfBody: string;
property md5OfMessageAttributes
md5OfMessageAttributes?: string;
property messageAttributes
messageAttributes: SQSMessageAttributes;
property messageId
messageId: string;
property receiptHandle
receiptHandle: string;
interface SQSRecordAttributes
interface SQSRecordAttributes {}
property ApproximateFirstReceiveTimestamp
ApproximateFirstReceiveTimestamp: string;
property ApproximateReceiveCount
ApproximateReceiveCount: string;
property AWSTraceHeader
AWSTraceHeader?: string | undefined;
property DeadLetterQueueSourceArn
DeadLetterQueueSourceArn?: string | undefined;
property MessageDeduplicationId
MessageDeduplicationId?: string | undefined;
property MessageGroupId
MessageGroupId?: string | undefined;
property SenderId
SenderId: string;
property SentTimestamp
SentTimestamp: string;
property SequenceNumber
SequenceNumber?: string | undefined;
interface StartedCustomerAudio
interface StartedCustomerAudio {}
property StartFragmentNumber
StartFragmentNumber: string;
property StartTimestamp
StartTimestamp: string;
property StreamARN
StreamARN: string;
interface StoppedCustomerAudio
interface StoppedCustomerAudio {}
property StopFragmentNumber
StopFragmentNumber: string;
property StopTimestamp
StopTimestamp: string;
interface StreamRecord
interface StreamRecord {}
property ApproximateCreationDateTime
ApproximateCreationDateTime?: number | undefined;
property Keys
Keys?: { [key: string]: AttributeValue } | undefined;
property NewImage
NewImage?: { [key: string]: AttributeValue } | undefined;
property OldImage
OldImage?: { [key: string]: AttributeValue } | undefined;
property SequenceNumber
SequenceNumber?: string | undefined;
property SizeBytes
SizeBytes?: number | undefined;
property StreamViewType
StreamViewType?: | 'KEYS_ONLY' | 'NEW_IMAGE' | 'OLD_IMAGE' | 'NEW_AND_OLD_IMAGES' | undefined;
interface TransferFamilyAuthorizerEvent
interface TransferFamilyAuthorizerEvent {}
Transfer Family Authorizer Event. This is the event that will be passed to the Lambda function. Event message structure can be found here: https://docs.aws.amazon.com/transfer/latest/userguide/custom-lambda-idp.html While the documentation is not explicit, for key based auth, password will be undefined
interface TransferFamilyAuthorizerResult
interface TransferFamilyAuthorizerResult {}
The values that Transfer Family accepts for Lambda functions that are used for custom identity providers. For some examples, see https://docs.aws.amazon.com/transfer/latest/userguide/custom-lambda-idp.html#lambda-auth-examples
property HomeDirectory
HomeDirectory?: string | undefined;
[**Optional**]
The landing directory for a user when they log in to the server using the client.
property HomeDirectoryDetails
HomeDirectoryDetails?: string | undefined;
[**Required if
HomeDirectoryType
has a value ofLOGICAL
**]Logical directory mappings that specify which Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path.
**Note**:
HomeDirectoryDetails
is a string representation of a JSON map. This is in contrast toPosixProfile
, which is an actual JSON map object, andPublicKeys
which is a JSON array of strings. See the [code examples](https://docs.aws.amazon.com/transfer/latest/userguide/custom-lambda-idp.html#lambda-auth-examples).
property HomeDirectoryType
HomeDirectoryType?: 'PATH' | 'LOGICAL' | undefined;
[**Optional**]
The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.
- If you set it to
PATH
, the user sees the absolute Amazon S3 bucket or Amazon EFS paths as is in their file transfer protocol clients. - If you set it toLOGICAL
, you must provide mappings in theHomeDirectoryDetails
parameter to make Amazon S3 or Amazon EFS paths visible to your users.
property Policy
Policy?: string | undefined;
[**Optional**]
A session policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket.
property PosixProfile
PosixProfile?: | { /** * User ID (UID) for the POSIX profile. */ Uid: number; /** * Group ID (GID) for the POSIX profile. */ Gid: number; /** * Secondary group IDs for the POSIX profile, if any. */ SecondaryGids?: number[]; } | undefined;
[**Required for Amazon EFS backing storage**]
The full POSIX identity, including user ID (
Uid
), group ID (Gid
), and any secondary group IDs (SecondaryGids
), that controls your users' access to your Amazon EFS file systems. The POSIX permissions that are set on files and directories in your file system determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.
property PublicKeys
PublicKeys?: string[] | undefined;
[**Optional**]
A list of SSH public key values that are valid for this user. An empty list implies that this is not a valid login. Must not be returned during password authentication.
property Role
Role?: string;
[**Required if authentication was successful. The user is authenticated if and only if the Role field is not blank**]
Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 or Amazon EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.
For details on establishing a trust relationship, see [To establish a trust relationship](https://docs.aws.amazon.com/transfer/latest/userguide/requirements-roles.html#establish-trust-transfer).
interface VerifyAuthChallengeResponseTriggerEvent
interface VerifyAuthChallengeResponseTriggerEvent extends BaseTriggerEvent<'VerifyAuthChallengeResponse_Authentication'> {}
See Also
https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-verify-auth-challenge-response.html
Type Aliases
type AccountTakeOverActionType
type AccountTakeOverActionType = | 'BLOCK' | 'NO_ACTION' | 'MFA' | 'MFA_IF_CONFIGURED' | 'MFA_REQUIRED';
type ALBCallback
type ALBCallback = Callback<ALBResult>;
type ALBHandler
type ALBHandler = Handler<ALBEvent, ALBResult>;
type AmplifyGraphQlResolverHandler
type AmplifyGraphQlResolverHandler< TArguments = Record<string, any>, TSource = Record<string, any>, TResult = any> = Handler<AmplifyGraphQlResolverEvent<TArguments, TSource>, TResult>;
A handler for Amplify GraphQL Lambda resolvers. The returned result will be resolved as the value (no need to convert to a JSON string).
See Also
https://docs.amplify.aws/cli/graphql/custom-business-logic/#structure-of-the-function-event
type APIGatewayAuthorizerCallback
type APIGatewayAuthorizerCallback = Callback<APIGatewayAuthorizerResult>;
type APIGatewayAuthorizerEvent
type APIGatewayAuthorizerEvent = | APIGatewayTokenAuthorizerEvent | APIGatewayRequestAuthorizerEvent;
type APIGatewayAuthorizerHandler
type APIGatewayAuthorizerHandler = Handler< APIGatewayAuthorizerEvent, APIGatewayAuthorizerResult>;
type APIGatewayAuthorizerWithContextCallback
type APIGatewayAuthorizerWithContextCallback< TAuthorizerContext extends APIGatewayAuthorizerResultContext> = Callback<APIGatewayAuthorizerWithContextResult<TAuthorizerContext>>;
type APIGatewayAuthorizerWithContextHandler
type APIGatewayAuthorizerWithContextHandler< TAuthorizerContext extends APIGatewayAuthorizerResultContext> = Handler< APIGatewayAuthorizerEvent, APIGatewayAuthorizerWithContextResult<TAuthorizerContext>>;
type APIGatewayEvent
type APIGatewayEvent = APIGatewayProxyEvent;
type APIGatewayEventDefaultAuthorizerContext
type APIGatewayEventDefaultAuthorizerContext = | undefined | null | { [name: string]: any; };
type APIGatewayEventLambdaAuthorizerContext
type APIGatewayEventLambdaAuthorizerContext<TAuthorizerContext> = { [P in keyof TAuthorizerContext]: TAuthorizerContext[P] extends null ? null : string;} & { principalId: string; integrationLatency: number;};
type APIGatewayEventRequestContext
type APIGatewayEventRequestContext = APIGatewayEventRequestContextWithAuthorizer<APIGatewayEventDefaultAuthorizerContext>;
type APIGatewayProxyCallback
type APIGatewayProxyCallback = Callback<APIGatewayProxyResult>;
Works with Lambda Proxy Integration for Rest API or HTTP API integration Payload Format version 1.0
See Also
- https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html
type APIGatewayProxyCallbackV2
type APIGatewayProxyCallbackV2 = Callback<APIGatewayProxyResultV2>;
Works with HTTP API integration Payload Format version 2.0
See Also
- https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html
type APIGatewayProxyEvent
type APIGatewayProxyEvent = APIGatewayProxyEventBase<APIGatewayEventDefaultAuthorizerContext>;
Works with Lambda Proxy Integration for Rest API or HTTP API integration Payload Format version 1.0
See Also
- https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html
type APIGatewayProxyEventV2
type APIGatewayProxyEventV2 = APIGatewayProxyEventV2WithRequestContext<APIGatewayEventRequestContextV2>;
Default Proxy event with no Authorizer
type APIGatewayProxyEventV2WithIAMAuthorizer
type APIGatewayProxyEventV2WithIAMAuthorizer = APIGatewayProxyEventV2WithRequestContext< APIGatewayEventRequestContextV2WithAuthorizer<APIGatewayEventRequestContextIAMAuthorizer> >;
Event type when invoking Lambda function URLs with IAM authorizer
type APIGatewayProxyEventV2WithJWTAuthorizer
type APIGatewayProxyEventV2WithJWTAuthorizer = APIGatewayProxyEventV2WithRequestContext< APIGatewayEventRequestContextV2WithAuthorizer<APIGatewayEventRequestContextJWTAuthorizer> >;
type APIGatewayProxyEventV2WithLambdaAuthorizer
type APIGatewayProxyEventV2WithLambdaAuthorizer<TAuthorizerContext> = APIGatewayProxyEventV2WithRequestContext< APIGatewayEventRequestContextV2WithAuthorizer< APIGatewayEventRequestContextLambdaAuthorizer<TAuthorizerContext> > >;
type APIGatewayProxyHandler
type APIGatewayProxyHandler = Handler<APIGatewayProxyEvent, APIGatewayProxyResult>;
Works with Lambda Proxy Integration for Rest API or HTTP API integration Payload Format version 1.0
See Also
- https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html
type APIGatewayProxyHandlerV2
type APIGatewayProxyHandlerV2<T = never> = Handler< APIGatewayProxyEventV2, APIGatewayProxyResultV2<T>>;
Works with HTTP API integration Payload Format version 2.0
See Also
- https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html
type APIGatewayProxyHandlerV2WithIAMAuthorizer
type APIGatewayProxyHandlerV2WithIAMAuthorizer<T = never> = Handler< APIGatewayProxyEventV2WithIAMAuthorizer, APIGatewayProxyResultV2<T>>;
Works with HTTP API integration Payload Format version 2.0 adds IAM Authroizer to RequestContext
See Also
- https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html
type APIGatewayProxyHandlerV2WithJWTAuthorizer
type APIGatewayProxyHandlerV2WithJWTAuthorizer<T = never> = Handler< APIGatewayProxyEventV2WithJWTAuthorizer, APIGatewayProxyResultV2<T>>;
Works with HTTP API integration Payload Format version 2.0 adds JWT Authroizer to RequestContext
See Also
- https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html
type APIGatewayProxyHandlerV2WithLambdaAuthorizer
type APIGatewayProxyHandlerV2WithLambdaAuthorizer< TAuthorizerContext, T = never> = Handler< APIGatewayProxyEventV2WithLambdaAuthorizer<TAuthorizerContext>, APIGatewayProxyResultV2<T>>;
Works with HTTP API integration Payload Format version 2.0 adds Lambda Authroizer to RequestContext
See Also
- https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html
type APIGatewayProxyResultV2
type APIGatewayProxyResultV2<T = never> = | APIGatewayProxyStructuredResultV2 | string | T;
Works with HTTP API integration Payload Format version 2.0
See Also
- https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html
type APIGatewayProxyWebsocketEventV2
type APIGatewayProxyWebsocketEventV2 = APIGatewayProxyWebsocketEventV2WithRequestContext<APIGatewayEventWebsocketRequestContextV2>;
Default Websocket Proxy event with no Authorizer
type APIGatewayProxyWebsocketHandlerV2
type APIGatewayProxyWebsocketHandlerV2<T = never> = Handler< APIGatewayProxyWebsocketEventV2, APIGatewayProxyResultV2<T>>;
Works with HTTP API integration Payload Format version 2.0
See Also
- https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-integration-requests.html
- https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-mapping-template-reference.html
type APIGatewayProxyWithCognitoAuthorizerEvent
type APIGatewayProxyWithCognitoAuthorizerEvent = APIGatewayProxyEventBase<APIGatewayProxyCognitoAuthorizer>;
type APIGatewayProxyWithCognitoAuthorizerHandler
type APIGatewayProxyWithCognitoAuthorizerHandler = Handler< APIGatewayProxyWithCognitoAuthorizerEvent, APIGatewayProxyResult>;
type APIGatewayProxyWithLambdaAuthorizerEvent
type APIGatewayProxyWithLambdaAuthorizerEvent<TAuthorizerContext> = APIGatewayProxyEventBase< APIGatewayEventLambdaAuthorizerContext<TAuthorizerContext> >;
type APIGatewayProxyWithLambdaAuthorizerEventRequestContext
type APIGatewayProxyWithLambdaAuthorizerEventRequestContext<TAuthorizerContext> = APIGatewayEventRequestContextWithAuthorizer< APIGatewayEventLambdaAuthorizerContext<TAuthorizerContext> >;
type APIGatewayProxyWithLambdaAuthorizerHandler
type APIGatewayProxyWithLambdaAuthorizerHandler<TAuthorizerContext> = Handler< APIGatewayProxyWithLambdaAuthorizerEvent<TAuthorizerContext>, APIGatewayProxyResult>;
type APIGatewayRequestAuthorizerHandler
type APIGatewayRequestAuthorizerHandler = Handler< APIGatewayRequestAuthorizerEvent, APIGatewayAuthorizerResult>;
type APIGatewayRequestAuthorizerWithContextHandler
type APIGatewayRequestAuthorizerWithContextHandler< TAuthorizerContext extends APIGatewayAuthorizerResultContext> = Handler< APIGatewayRequestAuthorizerEvent, APIGatewayAuthorizerWithContextResult<TAuthorizerContext>>;
type APIGatewayRequestIAMAuthorizerHandlerV2
type APIGatewayRequestIAMAuthorizerHandlerV2 = Handler< APIGatewayRequestAuthorizerEventV2, APIGatewayIAMAuthorizerResult>;
type APIGatewayRequestIAMAuthorizerV2WithContextHandler
type APIGatewayRequestIAMAuthorizerV2WithContextHandler< TAuthorizerContext extends APIGatewayAuthorizerResultContext> = Handler< APIGatewayRequestAuthorizerEventV2, APIGatewayIAMAuthorizerWithContextResult<TAuthorizerContext>>;
type APIGatewayRequestSimpleAuthorizerHandlerV2
type APIGatewayRequestSimpleAuthorizerHandlerV2 = Handler< APIGatewayRequestAuthorizerEventV2, APIGatewaySimpleAuthorizerResult>;
type APIGatewayRequestSimpleAuthorizerHandlerV2WithContext
type APIGatewayRequestSimpleAuthorizerHandlerV2WithContext<TAuthorizerContext> = Handler< APIGatewayRequestAuthorizerEventV2, APIGatewaySimpleAuthorizerWithContextResult<TAuthorizerContext> >;
type APIGatewayTokenAuthorizerHandler
type APIGatewayTokenAuthorizerHandler = Handler< APIGatewayTokenAuthorizerEvent, APIGatewayAuthorizerResult>;
type APIGatewayTokenAuthorizerWithContextHandler
type APIGatewayTokenAuthorizerWithContextHandler< TAuthorizerContext extends APIGatewayAuthorizerResultContext> = Handler< APIGatewayTokenAuthorizerEvent, APIGatewayAuthorizerWithContextResult<TAuthorizerContext>>;
type AppSyncAuthorizerHander
type AppSyncAuthorizerHander<TResolverContext = undefined> = AppSyncAuthorizerHandler<TResolverContext>;
Deprecated
type AppSyncAuthorizerHandler
type AppSyncAuthorizerHandler<TResolverContext = undefined> = Handler< AppSyncAuthorizerEvent, AppSyncAuthorizerResult<TResolverContext>>;
See https://docs.aws.amazon.com/appsync/latest/devguide/security-authz.html#aws-lambda-authorization
Parameter TResolverContext
type of the resolverContext object that you can return from the handler
type AppSyncBatchResolverHandler
type AppSyncBatchResolverHandler< TArguments, TResult, TSource = Record<string, any> | null> = Handler<Array<AppSyncResolverEvent<TArguments, TSource>>, TResult[]>;
type AppSyncIdentity
type AppSyncIdentity = | AppSyncIdentityIAM | AppSyncIdentityCognito | AppSyncIdentityOIDC | AppSyncIdentityLambda | undefined | null;
type AppSyncResolverHandler
type AppSyncResolverHandler< TArguments, TResult, TSource = Record<string, any> | null> = Handler<AppSyncResolverEvent<TArguments, TSource>, TResult>;
type ArtifactLocation
type ArtifactLocation = S3ArtifactStore;
type AuthResponse
type AuthResponse = APIGatewayAuthorizerResult;
type AuthResponseContext
type AuthResponseContext = APIGatewayAuthorizerResultContext;
type AutoScalingInstanceMarketOption
type AutoScalingInstanceMarketOption = 'spot' | 'on-demand';
type AutoScalingScaleInCallback
type AutoScalingScaleInCallback = Callback<AutoScalingScaleInResult>;
type AutoScalingScaleInCause
type AutoScalingScaleInCause = | 'SCALE_IN' | 'INSTANCE_REFRESH' | 'MAX_INSTANCE_LIFETIME' | 'REBALANCE';
type AutoScalingScaleInHandler
type AutoScalingScaleInHandler = Handler< AutoScalingScaleInEvent, AutoScalingScaleInResult>;
type Callback
type Callback<TResult = any> = ( 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 for the handler programming model.
Parameter error
Parameter to use to provide the error payload for a failed lambda execution. See for error handling. If an Error instance is passed, the error payload uses the
name
property as theerrorType
, themessage
property as theerrorMessage
, and parses thestack
property string into thetrace
array. For other values, theerrorType
istypeof value
, theerrorMessage
isString(value)
, andtrace
is an empty array.Parameter result
Parameter to use to provide the result payload for a successful lambda execution. Pass
null
orundefined
for theerror
parameter to use this parameter.
type CdkCustomResourceCallback
type CdkCustomResourceCallback<TData extends Record<string, any>> = Callback< CdkCustomResourceResponse<TData>>;
Lambda
OnEvent
callback function for a CDK Custom Resource TData User-defined output properties that are retuned from any invocation
type CdkCustomResourceEvent
type CdkCustomResourceEvent< TResourceProperties = CloudFormationCustomResourceResourcePropertiesCommon, TOldResourceProperties = TResourceProperties> = CloudFormationCustomResourceEvent< TResourceProperties, TOldResourceProperties> & { /** * The response URL identifies a presigned S3 bucket that receives responses from the custom resource provider to AWS CloudFormation. * * **This URL should not be used.** * The CDK Provider Framework will call this URL automatically based on the response produced by the Lambda handler. */ ResponseURL: string;};
Request event sent to the Lambda
OnEvent
handler for a CDK Custom Resource Reference: https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.custom_resources-readme.html#handling-lifecycle-events-onevent TResourceProperties User-defined input properties passed to the Custom Resource as part of any invocation TOldResourceProperties User-defined input properties passed to the Custom Resource as part of anUpdate
invocation
type CdkCustomResourceHandler
type CdkCustomResourceHandler< TResourceProperties = CloudFormationCustomResourceResourcePropertiesCommon, TData extends Record<string, any> = Record<string, any>, TOldResourceProperties = TResourceProperties> = Handler< CdkCustomResourceEvent<TResourceProperties, TOldResourceProperties>, CdkCustomResourceResponse<TData>>;
Lambda handler function for the
OnEvent
CDK Custom Resource Reference: https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.custom_resources-readme.html#handling-lifecycle-events-oneventNOTE: this is not to be confused with traditional CloudFormation custom resources. TResourceProperties User-defined input properties passed to the Custom Resource as part of any invocation TData User-defined output properties that are retuned from any invocation TOldResourceProperties User-defined input properties passed to the Custom Resource as part of an
Update
invocation
type CdkCustomResourceIsCompleteCallback
type CdkCustomResourceIsCompleteCallback< TData extends Record<string, any> = Record<string, any>> = Callback<CdkCustomResourceIsCompleteResponse<TData>>;
Lambda
IsComplete
callback function for a CDK Custom Resource TData User-defined output properties that are retuned from any invocation
type CdkCustomResourceIsCompleteEvent
type CdkCustomResourceIsCompleteEvent< TResourceProperties = CloudFormationCustomResourceResourcePropertiesCommon, TData extends Record<string, any> = Record<string, any>, TOldResourceProperties = TResourceProperties> = CdkCustomResourceEvent<TResourceProperties, TOldResourceProperties> & CdkCustomResourceResponse<TData>;
Request event sent to the Lambda
IsComplete
handler for an asynchronous CDK Custom Resource The input event to isComplete includes all request fields, combined with all fields returned from onEvent. If PhysicalResourceId has not been explicitly returned from onEvent, it's value will be calculated based on heuristics. Reference: https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.custom_resources-readme.html#asynchronous-providers-iscomplete TResourceProperties User-defined input properties passed to the Custom Resource as part of any invocation TData User-defined output properties that are retuned from any invocation TOldResourceProperties User-defined input properties passed to the Custom Resource as part of anUpdate
invocation
type CdkCustomResourceIsCompleteHandler
type CdkCustomResourceIsCompleteHandler< TResourceProperties = CloudFormationCustomResourceResourcePropertiesCommon, TOnEventData extends Record<string, any> = Record<string, any>, TOldResourceProperties = TResourceProperties, TIsCompleteData extends Record<string, any> = TOnEventData> = Handler< CdkCustomResourceIsCompleteEvent< TResourceProperties, TOnEventData, TOldResourceProperties >, CdkCustomResourceIsCompleteResponse<TIsCompleteData>>;
Lambda
IsComplete
handler function for asynchronous CDK Custom Resources Reference: https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.custom_resources-readme.html#asynchronous-providers-iscomplete TResourceProperties User-defined input properties passed to the Custom Resource as part of any invocation TOnEventData User-defined output properties that are retuned from any invocation of theOnEvent
function TOldResourceProperties User-defined input properties passed to the Custom Resource as part of anUpdate
invocation TIsCompleteData User-defined output properties that are retuned from any invocation of theIsComplete
function
type CdkCustomResourceIsCompleteResponse
type CdkCustomResourceIsCompleteResponse< TData extends Record<string, any> = Record<string, any>> = | CdkCustomResourceIsCompleteResponseSuccess<TData> | CdkCustomResourceIsCompleteResponseWaiting;
Common response properties from the
IsComplete
Lambda handler for a CDK Custom Resource Reference: https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.custom_resources-readme.html#asynchronous-providers-iscomplete TData User-defined output properties that are retuned from any invocation
type CloudFormationCustomResourceEvent
type CloudFormationCustomResourceEvent< TResourceProperties = CloudFormationCustomResourceResourcePropertiesCommon, TOldResourceProperties = TResourceProperties> = | CloudFormationCustomResourceCreateEvent<TResourceProperties> | CloudFormationCustomResourceUpdateEvent< TResourceProperties, TOldResourceProperties > | CloudFormationCustomResourceDeleteEvent<TResourceProperties>;
Request event sent to the Lambda handler for a Lambda-backed CloudFormation Custom Resource Reference: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/crpg-ref-requests.html#crpg-ref-request-fields TResourceProperties User-defined input properties passed to the Custom Resource as part of any invocation TOldResourceProperties User-defined input properties passed to the Custom Resource as part of an
Update
invocation
type CloudFormationCustomResourceHandler
type CloudFormationCustomResourceHandler< TResourceProperties = CloudFormationCustomResourceResourcePropertiesCommon, TOldResourceProperties = TResourceProperties> = Handler< CloudFormationCustomResourceEvent<TResourceProperties, TOldResourceProperties>, void>;
Lambda handler function for a Lambda-backed CloudFormation Custom Resource
NOTE: responses are *not* returned from the Lambda handler but rather they are sent to the event ResponseURL. TResourceProperties User-defined input properties passed to the Custom Resource as part of any invocation TOldResourceProperties User-defined input properties passed to the Custom Resource as part of an
Update
invocation
type CloudFormationCustomResourceResponse
type CloudFormationCustomResourceResponse< TData extends Record<string, any> = Record<string, any>> = | CloudFormationCustomResourceSuccessResponse<TData> | CloudFormationCustomResourceFailedResponse<TData>;
Response from a Lambda handler for a Lambda-backed CloudFormation Custom Resource Reference: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/crpg-ref-responses.html
NOTE: responses are *not* returned from the Lambda handler but rather they are sent to the event ResponseURL. TData User-defined output properties that are retuned from any invocation
type CloudFrontOrigin
type CloudFrontOrigin = | { s3: CloudFrontS3Origin; custom?: never | undefined } | { custom: CloudFrontCustomOrigin; s3?: never | undefined };
type CloudFrontRequestCallback
type CloudFrontRequestCallback = Callback<CloudFrontRequestResult>;
type CloudFrontRequestHandler
type CloudFrontRequestHandler = Handler< CloudFrontRequestEvent, CloudFrontRequestResult>;
type CloudFrontRequestResult
type CloudFrontRequestResult = | undefined | null | CloudFrontResultResponse | CloudFrontRequest;
type CloudFrontResponseCallback
type CloudFrontResponseCallback = Callback<CloudFrontResponseResult>;
type CloudFrontResponseHandler
type CloudFrontResponseHandler = Handler< CloudFrontResponseEvent, CloudFrontResponseResult>;
type CloudFrontResponseResult
type CloudFrontResponseResult = undefined | null | CloudFrontResultResponse;
type CloudFrontS3Origin
type CloudFrontS3Origin = | CloudFrontS3OriginAuthMethodNone | CloudFrontS3OriginAuthMethodOriginAccessIdentity;
type CloudWatchAlarmHandler
type CloudWatchAlarmHandler = Handler<CloudWatchAlarmEvent, void>;
type CloudWatchAlarmMetricDataQuery
type CloudWatchAlarmMetricDataQuery = | CloudWatchAlarmMetric | CloudWatchAlarmExpression;
type CloudWatchLogsHandler
type CloudWatchLogsHandler = Handler<CloudWatchLogsEvent, void>;
type CodeBuildCacheType
type CodeBuildCacheType = 'NO_CACHE' | 'LOCAL' | 'S3';
type CodeBuildCloudWatchStateHandler
type CodeBuildCloudWatchStateHandler = EventBridgeHandler< 'CodeBuild Build State Change', CodeBuildStateEventDetail, void>;
type CodeBuildEnvironmentComputeType
type CodeBuildEnvironmentComputeType = | 'BUILD_GENERAL1_SMALL' | 'BUILD_GENERAL1_MEDIUM' | 'BUILD_GENERAL1_LARGE' | 'BUILD_GENERAL1_2XLARGE';
type CodeBuildEnvironmentPullCredentialsType
type CodeBuildEnvironmentPullCredentialsType = 'CODEBUILD' | 'SERVICE_ROLE';
type CodeBuildEnvironmentType
type CodeBuildEnvironmentType = | 'LINUX_CONTAINER' | 'LINUX_GPU_CONTAINER' | 'WINDOWS_CONTAINER' | 'ARM_CONTAINER';
type CodeBuildEnvironmentVariableType
type CodeBuildEnvironmentVariableType = | 'PARAMETER_STORE' | 'PLAINTEXT' | 'SECRETS_MANAGER';
type CodeBuildPhaseStatusType
type CodeBuildPhaseStatusType = | 'TIMED_OUT' | 'STOPPED' | 'FAILED' | 'SUCCEEDED' | 'FAULT' | 'CLIENT_ERROR';
type CodeBuildPhaseType
type CodeBuildPhaseType = | 'COMPLETED' | 'FINALIZING' | 'UPLOAD_ARTIFACTS' | 'POST_BUILD' | 'BUILD' | 'PRE_BUILD' | 'INSTALL' | 'QUEUED' | 'DOWNLOAD_SOURCE' | 'PROVISIONING' | 'SUBMITTED';
type CodeBuildSourceLocationType
type CodeBuildSourceLocationType = | 'CODECOMMIT' | 'CODEPIPELINE' | 'GITHUB' | 'GITHUB_ENTERPRISE' | 'BITBUCKET' | 'S3' | 'NO_SOURCE';
type CodeBuildStateType
type CodeBuildStateType = 'IN_PROGRESS' | 'SUCCEEDED' | 'FAILED' | 'STOPPED';
type CodeCommitHandler
type CodeCommitHandler = Handler<CodeCommitTrigger, void>;
type CodePipelineActionCategory
type CodePipelineActionCategory = | 'Approval' | 'Build' | 'Deploy' | 'Invoke' | 'Source' | 'Test';
type CodePipelineActionState
type CodePipelineActionState = 'STARTED' | 'SUCCEEDED' | 'FAILED' | 'CANCELED';
type CodePipelineCloudWatchActionHandler
type CodePipelineCloudWatchActionHandler = Handler< CodePipelineCloudWatchActionEvent, void>;
type CodePipelineCloudWatchEvent
type CodePipelineCloudWatchEvent = | CodePipelineCloudWatchPipelineEvent | CodePipelineCloudWatchStageEvent | CodePipelineCloudWatchActionEvent;
type CodePipelineCloudWatchHandler
type CodePipelineCloudWatchHandler = Handler<CodePipelineCloudWatchEvent, void>;
type CodePipelineCloudWatchPipelineHandler
type CodePipelineCloudWatchPipelineHandler = Handler< CodePipelineCloudWatchPipelineEvent, void>;
type CodePipelineCloudWatchStageHandler
type CodePipelineCloudWatchStageHandler = Handler< CodePipelineCloudWatchStageEvent, void>;
type CodePipelineHandler
type CodePipelineHandler = Handler<CodePipelineEvent, void>;
type CodePipelineStageState
type CodePipelineStageState = | 'STARTED' | 'SUCCEEDED' | 'RESUMED' | 'FAILED' | 'CANCELED';
type CodePipelineState
type CodePipelineState = | 'STARTED' | 'SUCCEEDED' | 'RESUMED' | 'FAILED' | 'CANCELED' | 'SUPERSEDED';
type CognitoUserPoolEvent
type CognitoUserPoolEvent = CognitoUserPoolTriggerEvent;
Deprecated
Please use specific event types instead
type CognitoUserPoolTriggerHandler
type CognitoUserPoolTriggerHandler = Handler<CognitoUserPoolTriggerEvent>;
Deprecated
Please use specific event handler types instead
type ConnectContactFlowCallback
type ConnectContactFlowCallback = Callback<ConnectContactFlowResult>;
type ConnectContactFlowChannel
type ConnectContactFlowChannel = 'VOICE' | 'CHAT';
type ConnectContactFlowHandler
type ConnectContactFlowHandler = Handler< ConnectContactFlowEvent, ConnectContactFlowResult>;
type ConnectContactFlowInitiationMethod
type ConnectContactFlowInitiationMethod = | 'INBOUND' | 'OUTBOUND' | 'TRANSFER' | 'CALLBACK' | 'API';
type CreateAuthChallengeTriggerHandler
type CreateAuthChallengeTriggerHandler = Handler<CreateAuthChallengeTriggerEvent>;
type CustomAuthorizerCallback
type CustomAuthorizerCallback = APIGatewayAuthorizerCallback;
type CustomAuthorizerHandler
type CustomAuthorizerHandler = Handler< CustomAuthorizerEvent, APIGatewayAuthorizerResult>;
Deprecated
Use APIGatewayAuthorizerHandler or a subtype
type CustomAuthorizerResult
type CustomAuthorizerResult = APIGatewayAuthorizerResult;
type CustomEmailSenderTriggerEvent
type CustomEmailSenderTriggerEvent = | CustomEmailSenderSignUpTriggerEvent | CustomEmailSenderResendCodeTriggerEvent | CustomEmailSenderForgotPasswordTriggerEvent | CustomEmailSenderUpdateUserAttributeTriggerEvent | CustomEmailSenderVerifyUserAttributeTriggerEvent | CustomEmailSenderAdminCreateUserTriggerEvent | CustomEmailSenderAccountTakeOverNotificationTriggerEvent;
See Also
https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-custom-email-sender.html
type CustomEmailSenderTriggerHandler
type CustomEmailSenderTriggerHandler = Handler<CustomEmailSenderTriggerEvent>;
type CustomerAudio
type CustomerAudio = | null // If Media Streaming has never been started. | StartedCustomerAudio // If Media Streaming has been started, but not stopped. | (StartedCustomerAudio & StoppedCustomerAudio);
type CustomMessageAdminCreateUserTriggerEvent
type CustomMessageAdminCreateUserTriggerEvent = BaseCustomMessageTriggerEvent<'CustomMessage_AdminCreateUser'>;
type CustomMessageAuthenticationTriggerEvent
type CustomMessageAuthenticationTriggerEvent = BaseCustomMessageTriggerEvent<'CustomMessage_Authentication'>;
type CustomMessageForgotPasswordTriggerEvent
type CustomMessageForgotPasswordTriggerEvent = BaseCustomMessageTriggerEvent<'CustomMessage_ForgotPassword'>;
type CustomMessageResendCodeTriggerEvent
type CustomMessageResendCodeTriggerEvent = BaseCustomMessageTriggerEvent<'CustomMessage_ResendCode'>;
type CustomMessageSignUpTriggerEvent
type CustomMessageSignUpTriggerEvent = BaseCustomMessageTriggerEvent<'CustomMessage_SignUp'>;
type CustomMessageTriggerEvent
type CustomMessageTriggerEvent = | CustomMessageSignUpTriggerEvent | CustomMessageAdminCreateUserTriggerEvent | CustomMessageResendCodeTriggerEvent | CustomMessageForgotPasswordTriggerEvent | CustomMessageUpdateUserAttributeTriggerEvent | CustomMessageVerifyUserAttributeTriggerEvent | CustomMessageAuthenticationTriggerEvent;
See Also
https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-custom-message.html
type CustomMessageTriggerHandler
type CustomMessageTriggerHandler = Handler<CustomMessageTriggerEvent>;
type CustomMessageUpdateUserAttributeTriggerEvent
type CustomMessageUpdateUserAttributeTriggerEvent = BaseCustomMessageTriggerEvent<'CustomMessage_UpdateUserAttribute'>;
type CustomMessageVerifyUserAttributeTriggerEvent
type CustomMessageVerifyUserAttributeTriggerEvent = BaseCustomMessageTriggerEvent<'CustomMessage_VerifyUserAttribute'>;
type CustomSMSSenderTriggerEvent
type CustomSMSSenderTriggerEvent = | CustomSMSSenderSignUpTriggerEvent | CustomSMSSenderResendCodeTriggerEvent | CustomSMSSenderForgotPasswordTriggerEvent | CustomSMSSenderUpdateUserAttributeTriggerEvent | CustomSMSSenderVerifyUserAttributeTriggerEvent | CustomSMSSenderAdminCreateUserTriggerEvent | CustomSMSSenderAuthenticationUserTriggerEvent;
See Also
https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-custom-sms-sender.html
type CustomSMSSenderTriggerHandler
type CustomSMSSenderTriggerHandler = Handler<CustomSMSSenderTriggerEvent>;
type DefineAuthChallengeTriggerHandler
type DefineAuthChallengeTriggerHandler = Handler<DefineAuthChallengeTriggerEvent>;
type DynamoDBStreamHandler
type DynamoDBStreamHandler = Handler< DynamoDBStreamEvent, DynamoDBBatchResponse | void>;
type EventBridgeHandler
type EventBridgeHandler<TDetailType extends string, TDetail, TResult> = Handler< EventBridgeEvent<TDetailType, TDetail>, TResult>;
type FirehoseRecordTransformationStatus
type FirehoseRecordTransformationStatus = 'Ok' | 'Dropped' | 'ProcessingFailed';
type FirehoseTransformationCallback
type FirehoseTransformationCallback = Callback<FirehoseTransformationResult>;
type FirehoseTransformationHandler
type FirehoseTransformationHandler = Handler< FirehoseTransformationEvent, FirehoseTransformationResult>;
type GuardDutyNotificationEvent
type GuardDutyNotificationEvent = GuardDutyScanResultNotificationEvent;
type Handler
type Handler<TEvent = any, TResult = any> = ( event: TEvent, context: Context, callback: Callback<TResult> // eslint-disable-next-line @typescript-eslint/no-invalid-void-type) => 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 the for more information about the runtime behavior, and the introducing the async handler behavior in the 8.10 runtime.
Parameter event
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.
Parameter 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.
Parameter callback
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. 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.
Example 1
Defining a custom handler type import { Handler } from 'aws-lambda'
interface NameEvent { fullName: string } interface NameResult { firstName: string middleNames: string lastName: string } type PersonHandler = Handler<NameEvent, NameResult>
export const handler: PersonHandler = async (event) => { const names = event.fullName.split(' ') const firstName = names.shift() const lastName = names.pop() return { firstName, middleNames: names, lastName } }
Example 2
Logs the contents of the event object and returns the location of the logs import { Handler } from 'aws-lambda'
export const handler: Handler = async (event, context) => { console.log("EVENT: \n" + JSON.stringify(event, null, 2)) return context.logStreamName }
Example 3
AWS SDK with Async Function and Promises import { Handler } from 'aws-lambda' import AWS from 'aws-sdk'
const s3 = new AWS.S3()
export const handler: Handler = async (event) => { const response = await s3.listBuckets().promise() return response?.Buckets.map((bucket) => bucket.Name) }
Example 4
HTTP Request with Callback import { Handler } from 'aws-lambda' import https from 'https'
let url = "https://docs.aws.amazon.com/lambda/latest/dg/welcome.html"
export const handler: Handler<void, number> = (event, context, callback) => { https.get(url, (res) => { callback(null, res.statusCode) }).on('error', (e) => { callback(Error(e)) }) }
type IoTCustomAuthorizerHandler
type IoTCustomAuthorizerHandler = Handler< IoTCustomAuthorizerEvent, IoTCustomAuthorizerResult>;
type IoTEvent
type IoTEvent<T = never> = string | number | T;
type IoTHandler
type IoTHandler = Handler<IoTEvent, void>;
type IoTPreProvisioningHookHandler
type IoTPreProvisioningHookHandler = Handler< IoTPreProvisioningHookEvent, IoTPreProvisioningHookResult>;
type IoTProtocolType
type IoTProtocolType = 'http' | 'mqtt' | 'tls';
type KinesisStreamHandler
type KinesisStreamHandler = Handler< KinesisStreamEvent, KinesisStreamBatchResponse | void>;
type KinesisStreamTumblingWindowHandler
type KinesisStreamTumblingWindowHandler = Handler< KinesisStreamTumblingWindowEvent, // eslint-disable-next-line @typescript-eslint/no-invalid-void-type KinesisStreamStateResponse | void>;
type LambdaFunctionURLCallback
type LambdaFunctionURLCallback = APIGatewayProxyCallbackV2;
Works with Lambda Function URL format which is currently the same as HTTP API integration Payload Format version 2.0
See Also
- https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html
type LambdaFunctionURLEvent
type LambdaFunctionURLEvent = APIGatewayProxyEventV2;
Default Lambda Function URL event with no Authorizer
type LambdaFunctionURLEventWithIAMAuthorizer
type LambdaFunctionURLEventWithIAMAuthorizer = APIGatewayProxyEventV2WithRequestContext< APIGatewayEventRequestContextV2WithAuthorizer<APIGatewayEventRequestContextIAMAuthorizer> >;
type LambdaFunctionURLHandler
type LambdaFunctionURLHandler<T = never> = Handler< LambdaFunctionURLEvent, LambdaFunctionURLResult<T>>;
Works with Lambda Function URL format which is currently the same as HTTP API integration Payload Format version 2.0
See Also
- https://docs.aws.amazon.com/lambda/latest/dg/urls-invocation.html#urls-payloads
type LambdaFunctionURLHandlerWithIAMAuthorizer
type LambdaFunctionURLHandlerWithIAMAuthorizer<T = never> = Handler< LambdaFunctionURLEventWithIAMAuthorizer, LambdaFunctionURLResult<T>>;
Works with Lambda Function URL format which is currently the same as HTTP API integration Payload Format version 2.0
See Also
- https://docs.aws.amazon.com/lambda/latest/dg/urls-invocation.html#urls-payloads
type LambdaFunctionURLResult
type LambdaFunctionURLResult<T = never> = APIGatewayProxyResultV2<T>;
Works with Lambda Function URL format which is currently the same as HTTP API integration Payload Format version 2.0
See Also
- https://docs.aws.amazon.com/lambda/latest/dg/urls-invocation.html#urls-payloads
type LevV2DialogActionWithoutSlot
type LevV2DialogActionWithoutSlot = | { type: 'Close' } | { type: 'ConfirmIntent' } | { type: 'Delegate' } | { type: 'ElicitIntent' };
type LexCallback
type LexCallback = Callback<LexResult>;
type LexDialogAction
type LexDialogAction = | LexDialogActionClose | LexDialogActionElicitIntent | LexDialogActionElicitSlot | LexDialogActionConfirmIntent | LexDialogActionDelegate;
type LexHandler
type LexHandler = Handler<LexEvent, LexResult>;
type LexV2Callback
type LexV2Callback = Callback<LexV2Result>;
type LexV2DialogAction
type LexV2DialogAction = | (LevV2DialogActionWithoutSlot & { slotToElicit?: never }) | { type: 'ElicitSlot'; slotToElicit: string };
type LexV2Handler
type LexV2Handler = Handler<LexV2Event, LexV2Result>;
type LexV2IntentState
type LexV2IntentState = | 'Failed' | 'Fulfilled' | 'FulfillmentInProgress' | 'InProgress' | 'ReadyForFulfillment' | 'Waiting';
type LexV2Message
type LexV2Message = LexV2ContentMessage | LexV2ImageResponseCardMessage;
type LexV2ResultDialogAction
type LexV2ResultDialogAction = | (LevV2DialogActionWithoutSlot & { slotToElicit?: never }) | { type: 'ElicitSlot'; slotToElicit: string; slotElicitationStyle?: 'Default' | 'SpellByLetter' | 'SpellByWord'; };
type LexV2Slot
type LexV2Slot = LexV2ScalarSlotValue | LexV2ListSlotValue;
type LexV2Slots
type LexV2Slots = Record<string, LexV2Slot | null>;
type MSKHandler
type MSKHandler = Handler<MSKEvent, void>;
type PostAuthenticationTriggerHandler
type PostAuthenticationTriggerHandler = Handler<PostAuthenticationTriggerEvent>;
type PostConfirmationConfirmForgotPassword
type PostConfirmationConfirmForgotPassword = BasePostConfirmationTriggerEvent<'PostConfirmation_ConfirmForgotPassword'>;
type PostConfirmationConfirmSignUpTriggerEvent
type PostConfirmationConfirmSignUpTriggerEvent = BasePostConfirmationTriggerEvent<'PostConfirmation_ConfirmSignUp'>;
type PostConfirmationTriggerEvent
type PostConfirmationTriggerEvent = | PostConfirmationConfirmSignUpTriggerEvent | PostConfirmationConfirmForgotPassword;
See Also
https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-post-confirmation.html
type PostConfirmationTriggerHandler
type PostConfirmationTriggerHandler = Handler<PostConfirmationTriggerEvent>;
type PreAuthenticationTriggerHandler
type PreAuthenticationTriggerHandler = Handler<PreAuthenticationTriggerEvent>;
type PreSignUpAdminCreateUserTriggerEvent
type PreSignUpAdminCreateUserTriggerEvent = BasePreSignUpTriggerEvent<'PreSignUp_AdminCreateUser'>;
type PreSignUpEmailTriggerEvent
type PreSignUpEmailTriggerEvent = BasePreSignUpTriggerEvent<'PreSignUp_SignUp'>;
type PreSignUpExternalProviderTriggerEvent
type PreSignUpExternalProviderTriggerEvent = BasePreSignUpTriggerEvent<'PreSignUp_ExternalProvider'>;
type PreSignUpTriggerEvent
type PreSignUpTriggerEvent = | PreSignUpEmailTriggerEvent | PreSignUpExternalProviderTriggerEvent | PreSignUpAdminCreateUserTriggerEvent;
See Also
https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-sign-up.html
type PreSignUpTriggerHandler
type PreSignUpTriggerHandler = Handler<PreSignUpTriggerEvent>;
type PreTokenGenerationAuthenticateDeviceTriggerEvent
type PreTokenGenerationAuthenticateDeviceTriggerEvent = BasePreTokenGenerationTriggerEvent<'TokenGeneration_AuthenticateDevice'>;
type PreTokenGenerationAuthenticateDeviceV2TriggerEvent
type PreTokenGenerationAuthenticateDeviceV2TriggerEvent = BasePreTokenGenerationV2TriggerEvent<'TokenGeneration_AuthenticateDevice'>;
type PreTokenGenerationAuthenticationTriggerEvent
type PreTokenGenerationAuthenticationTriggerEvent = BasePreTokenGenerationTriggerEvent<'TokenGeneration_Authentication'>;
type PreTokenGenerationAuthenticationV2TriggerEvent
type PreTokenGenerationAuthenticationV2TriggerEvent = BasePreTokenGenerationV2TriggerEvent<'TokenGeneration_Authentication'>;
type PreTokenGenerationHostedAuthTriggerEvent
type PreTokenGenerationHostedAuthTriggerEvent = BasePreTokenGenerationTriggerEvent<'TokenGeneration_HostedAuth'>;
type PreTokenGenerationHostedAuthV2TriggerEvent
type PreTokenGenerationHostedAuthV2TriggerEvent = BasePreTokenGenerationV2TriggerEvent<'TokenGeneration_HostedAuth'>;
type PreTokenGenerationNewPasswordChallengeTriggerEvent
type PreTokenGenerationNewPasswordChallengeTriggerEvent = BasePreTokenGenerationTriggerEvent<'TokenGeneration_NewPasswordChallenge'>;
type PreTokenGenerationNewPasswordChallengeV2TriggerEvent
type PreTokenGenerationNewPasswordChallengeV2TriggerEvent = BasePreTokenGenerationV2TriggerEvent<'TokenGeneration_NewPasswordChallenge'>;
type PreTokenGenerationRefreshTokensTriggerEvent
type PreTokenGenerationRefreshTokensTriggerEvent = BasePreTokenGenerationTriggerEvent<'TokenGeneration_RefreshTokens'>;
type PreTokenGenerationRefreshTokensV2TriggerEvent
type PreTokenGenerationRefreshTokensV2TriggerEvent = BasePreTokenGenerationV2TriggerEvent<'TokenGeneration_RefreshTokens'>;
type PreTokenGenerationTriggerEvent
type PreTokenGenerationTriggerEvent = | PreTokenGenerationHostedAuthTriggerEvent | PreTokenGenerationAuthenticationTriggerEvent | PreTokenGenerationNewPasswordChallengeTriggerEvent | PreTokenGenerationAuthenticateDeviceTriggerEvent | PreTokenGenerationRefreshTokensTriggerEvent;
See Also
https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-token-generation.html
type PreTokenGenerationTriggerHandler
type PreTokenGenerationTriggerHandler = Handler<PreTokenGenerationTriggerEvent>;
type PreTokenGenerationV2TriggerEvent
type PreTokenGenerationV2TriggerEvent = | PreTokenGenerationHostedAuthV2TriggerEvent | PreTokenGenerationAuthenticationV2TriggerEvent | PreTokenGenerationNewPasswordChallengeV2TriggerEvent | PreTokenGenerationAuthenticateDeviceV2TriggerEvent | PreTokenGenerationRefreshTokensV2TriggerEvent;
See Also
https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-token-generation.html
type PreTokenGenerationV2TriggerHandler
type PreTokenGenerationV2TriggerHandler = Handler<PreTokenGenerationV2TriggerEvent>;
type PrincipalValue
type PrincipalValue = { [key: string]: string | string[] } | string | string[];
type ProxyCallback
type ProxyCallback = APIGatewayProxyCallback;
type ProxyHandler
type ProxyHandler = APIGatewayProxyHandler;
type ProxyResult
type ProxyResult = APIGatewayProxyResult;
type S3BatchCallback
type S3BatchCallback = Callback<S3BatchResult>;
type S3BatchHandler
type S3BatchHandler = Handler<S3BatchEvent, S3BatchResult>;
S3 Batch Operations event https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-invoke-lambda.html
type S3BatchResultResultCode
type S3BatchResultResultCode = 'Succeeded' | 'TemporaryFailure' | 'PermanentFailure';
type S3CreateEvent
type S3CreateEvent = S3Event;
type S3Handler
type S3Handler = Handler<S3Event, void>;
type S3NotificationEvent
type S3NotificationEvent = | S3ObjectAccessTierChangedNotificationEvent | S3ObjectACLUpdatedNotificationEvent | S3ObjectCreatedNotificationEvent | S3ObjectDeletedNotificationEvent | S3ObjectRestoreCompletedNotificationEvent | S3ObjectRestoreExpiredNotificationEvent | S3ObjectRestoreInitiatedNotificationEvent | S3ObjectStorageClassChangedNotificationEvent | S3ObjectTagsAddedNotificationEvent | S3ObjectTagsDeletedNotificationEvent;
type S3NotificationEventBridgeHandler
type S3NotificationEventBridgeHandler< EventType extends S3NotificationEvent = S3NotificationEvent> = Handler< EventBridgeEvent<EventType['detail-type'], EventType['detail']> & { source: 'aws.s3'; }, void>;
type S3ObjectDeletedNotificationEventDetail
type S3ObjectDeletedNotificationEventDetail = | S3ObjectDeletedNotificationEventLifecycleExpirationDetail | S3ObjectDeletedNotificationEventDeleteObjectDetail;
type ScheduledHandler
type ScheduledHandler<TDetail = any> = EventBridgeHandler< 'Scheduled Event', TDetail, void>;
type SecretsManagerRotationEventStep
type SecretsManagerRotationEventStep = | 'createSecret' | 'setSecret' | 'testSecret' | 'finishSecret';
type SecretsManagerRotationHandler
type SecretsManagerRotationHandler = Handler<SecretsManagerRotationEvent, void>;
type SelfManagedKafkaHandler
type SelfManagedKafkaHandler = Handler<SelfManagedKafkaEvent, void>;
type SESHandler
type SESHandler = Handler<SESEvent, void>;
type SNSHandler
type SNSHandler = Handler<SNSEvent, void>;
type SQSHandler
type SQSHandler = Handler<SQSEvent, SQSBatchResponse | void>;
type SQSMessageAttributeDataType
type SQSMessageAttributeDataType = 'String' | 'Number' | 'Binary' | string;
type Statement
type Statement = BaseStatement & StatementAction & (StatementResource | StatementPrincipal);
API Gateway CustomAuthorizer AuthResponse.PolicyDocument.Statement. https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-control-access-policy-language-overview.html https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements.html
type StatementAction
type StatementAction = | { Action: string | string[] } | { NotAction: string | string[] };
type StatementEffect
type StatementEffect = 'Allow' | 'Deny';
type StatementPrincipal
type StatementPrincipal = MaybeStatementResource & ({ Principal: PrincipalValue } | { NotPrincipal: PrincipalValue });
type StatementResource
type StatementResource = MaybeStatementPrincipal & ({ Resource: string | string[] } | { NotResource: string | string[] });
type TransferFamilyAuthorizerHandler
type TransferFamilyAuthorizerHandler = Handler< TransferFamilyAuthorizerEvent, TransferFamilyAuthorizerResult>;
Use this only if you want to use callbacks. AWS [recommends against](https://docs.aws.amazon.com/lambda/latest/dg/nodejs-handler.html) using those, so you might want to use async/await instead, like this:
const handler = async (event: TransferFamilyAuthorizerEvent): Promise<TransferFamilyAuthorizerResult> => {... add your logic here}
type UserMigrationAuthenticationTriggerEvent
type UserMigrationAuthenticationTriggerEvent = BaseUserMigrationTriggerEvent<'UserMigration_Authentication'>;
type UserMigrationForgotPasswordTriggerEvent
type UserMigrationForgotPasswordTriggerEvent = BaseUserMigrationTriggerEvent<'UserMigration_ForgotPassword'>;
type UserMigrationTriggerEvent
type UserMigrationTriggerEvent = | UserMigrationAuthenticationTriggerEvent | UserMigrationForgotPasswordTriggerEvent;
See Also
https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-migrate-user.html
type UserMigrationTriggerHandler
type UserMigrationTriggerHandler = Handler<UserMigrationTriggerEvent>;
type UserStatus
type UserStatus = | 'UNCONFIRMED' | 'CONFIRMED' | 'ARCHIVED' | 'COMPROMISED' | 'UNKNOWN' | 'RESET_REQUIRED' | 'FORCE_CHANGE_PASSWORD';
type VerifyAuthChallengeResponseTriggerHandler
type VerifyAuthChallengeResponseTriggerHandler = Handler<VerifyAuthChallengeResponseTriggerEvent>;
Package Files (59)
- common/api-gateway.d.ts
- common/cloudfront.d.ts
- handler.d.ts
- index.d.ts
- trigger/alb.d.ts
- trigger/amplify-resolver.d.ts
- trigger/api-gateway-authorizer.d.ts
- trigger/api-gateway-proxy.d.ts
- trigger/appsync-resolver.d.ts
- trigger/autoscaling.d.ts
- trigger/cdk-custom-resource.d.ts
- trigger/cloudformation-custom-resource.d.ts
- trigger/cloudfront-request.d.ts
- trigger/cloudfront-response.d.ts
- trigger/cloudwatch-alarm.d.ts
- trigger/cloudwatch-events.d.ts
- trigger/cloudwatch-logs.d.ts
- trigger/codebuild-cloudwatch-state.d.ts
- trigger/codecommit.d.ts
- trigger/codepipeline-cloudwatch-action.d.ts
- trigger/codepipeline-cloudwatch-pipeline.d.ts
- trigger/codepipeline-cloudwatch-stage.d.ts
- trigger/codepipeline-cloudwatch.d.ts
- trigger/codepipeline.d.ts
- trigger/cognito-user-pool-trigger/create-auth-challenge.d.ts
- trigger/cognito-user-pool-trigger/custom-email-sender.d.ts
- trigger/cognito-user-pool-trigger/custom-message.d.ts
- trigger/cognito-user-pool-trigger/custom-sms-sender.d.ts
- trigger/cognito-user-pool-trigger/define-auth-challenge.d.ts
- trigger/cognito-user-pool-trigger/index.d.ts
- trigger/cognito-user-pool-trigger/post-authentication.d.ts
- trigger/cognito-user-pool-trigger/post-confirmation.d.ts
- trigger/cognito-user-pool-trigger/pre-authentication.d.ts
- trigger/cognito-user-pool-trigger/pre-signup.d.ts
- trigger/cognito-user-pool-trigger/pre-token-generation-v2.d.ts
- trigger/cognito-user-pool-trigger/pre-token-generation.d.ts
- trigger/cognito-user-pool-trigger/user-migration.d.ts
- trigger/cognito-user-pool-trigger/verify-auth-challenge-response.d.ts
- trigger/connect-contact-flow.d.ts
- trigger/dynamodb-stream.d.ts
- trigger/eventbridge.d.ts
- trigger/guard-duty-event-notification.d.ts
- trigger/iot-authorizer.d.ts
- trigger/iot.d.ts
- trigger/kinesis-firehose-transformation.d.ts
- trigger/kinesis-stream.d.ts
- trigger/lambda-function-url.d.ts
- trigger/lex-v2.d.ts
- trigger/lex.d.ts
- trigger/msk.d.ts
- trigger/s3-batch.d.ts
- trigger/s3-event-notification.d.ts
- trigger/s3.d.ts
- trigger/secretsmanager.d.ts
- trigger/self-managed-kafka.d.ts
- trigger/ses.d.ts
- trigger/sns.d.ts
- trigger/sqs.d.ts
- trigger/transfer-family-authorizer.d.ts
Dependencies (0)
No dependencies.
Dev Dependencies (0)
No dev dependencies.
Peer Dependencies (0)
No peer dependencies.
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/aws-lambda
.
- Markdown[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@types/aws-lambda)
- HTML<a href="https://www.jsdocs.io/package/@types/aws-lambda"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 11744 ms. - Missing or incorrect documentation? Open an issue for this package.