package
1.47.0
Repository: https://github.com/aws/aws-lambda-go.git
Documentation: pkg.go.dev

# README

# Packages

# Functions

NewBinaryAttribute creates an DynamoDBAttributeValue containing a Binary.
NewBinarySetAttribute creates an DynamoDBAttributeValue containing a BinarySet.
NewBooleanAttribute creates an DynamoDBAttributeValue containing a Boolean.
NewListAttribute creates an DynamoDBAttributeValue containing a List.
NewMapAttribute creates an DynamoDBAttributeValue containing a Map.
NewNullAttribute creates an DynamoDBAttributeValue containing a Null.
NewNumberAttribute creates an DynamoDBAttributeValue containing a Number.
NewNumberSetAttribute creates an DynamoDBAttributeValue containing a NumberSet.
NewStringAttribute creates an DynamoDBAttributeValue containing a String.
NewStringSetAttribute creates an DynamoDBAttributeValue containing a StringSet.

# Constants

only the key attributes of the modified item.
both the new and the old item images of the item.
the entire item, as it appeared after it was modified.
the entire item, as it appeared before it was modified.
Constants used for describing the transformation result.
Constants used for describing the transformation result.
Constants used for describing the transformation result.
Deprecated: not used by any event schema.
Deprecated: not used by any event schema.
SimpleEmailContinue represents the CONTINUE disposition which tells the SES Rule Set to continue to the next rule.
SimpleEmailStopRule represents the STOP_RULE disposition which tells the SES Rule Set to stop processing this rule and continue to the next.
SimpleEmailStopRuleSet represents the STOP_RULE_SET disposition which tells the SES Rule SEt to stop processing all rules.

# Structs

AccessTokenGeneration allows lambda to modify the access token.
ALBTargetGroupRequest contains data originating from the ALB Lambda target group integration.
ALBTargetGroupRequestContext contains the information to identify the load balancer invoking the lambda.
ALBTargetGroupResponse configures the response to be returned by the ALB Lambda target group for the request.
APIGatewayCustomAuthorizerContext represents the expected format of an API Gateway custom authorizer response.
APIGatewayCustomAuthorizerRequest contains data coming in to a custom API Gateway authorizer function.
APIGatewayCustomAuthorizerRequestTypeRequest contains data coming in to a custom API Gateway authorizer function.
APIGatewayCustomAuthorizerRequestTypeRequestContext represents the expected format of an API Gateway custom authorizer response.
APIGatewayCustomAuthorizerRequestTypeRequestIdentity contains identity information for the request caller including certificate information if using mTLS.
APIGatewayCustomAuthorizerRequestTypeRequestIdentityClientCert contains certificate information for the request caller if using mTLS.
APIGatewayCustomAuthorizerRequestTypeRequestIdentityClientCertValidity contains certificate validity information for the request caller if using mTLS.
APIGatewayCustomAuthorizerResponse represents the expected format of an API Gateway authorization response.
APIGatewayProxyRequest contains data coming from the API Gateway proxy.
APIGatewayProxyRequestContext contains the information to identify the AWS account and resources invoking the Lambda function.
APIGatewayProxyResponse configures the response to be returned by API Gateway for the request.
APIGatewayRequestIdentity contains identity information for the request caller.
APIGatewayV2CustomAuthorizerSimpleResponse represents the simple format of an API Gateway V2 authorization response.
APIGatewayV2HTTPRequest contains data coming from the new HTTP API Gateway.
APIGatewayV2HTTPRequestContext contains the information to identify the AWS account and resources invoking the Lambda function.
APIGatewayV2HTTPRequestContextAuthentication contains authentication context information for the request caller including client certificate information if using mTLS.
APIGatewayV2HTTPRequestContextAuthenticationClientCert contains client certificate information for the request caller if using mTLS.
APIGatewayV2HTTPRequestContextAuthenticationClientCertValidity contains client certificate validity information for the request caller if using mTLS.
APIGatewayV2HTTPRequestContextAuthorizerCognitoIdentity contains Cognito identity information for the request context.
APIGatewayV2HTTPRequestContextAuthorizerDescription contains authorizer information for the request context.
APIGatewayV2HTTPRequestContextAuthorizerIAMDescription contains IAM information for the request context.
APIGatewayV2HTTPRequestContextAuthorizerJWTDescription contains JWT authorizer information for the request context.
APIGatewayV2HTTPRequestContextHTTPDescription contains HTTP information for the request context.
APIGatewayV2HTTPResponse configures the response to be returned by API Gateway V2 for the request.
APIGatewayWebsocketProxyRequest contains data coming from the API Gateway proxy.
APIGatewayWebsocketProxyRequestContext contains the information to identify the AWS account and resources invoking the Lambda function.
AppSyncCognitoIdentity contains information about the caller authed via Cognito.
AppSyncIAMIdentity contains information about the caller authed via IAM.
AppSyncLambdaAuthorizerRequest contains an authorization request from AppSync.
AppSyncLambdaAuthorizerRequestContext contains the parameters of the AppSync invocation which triggered this authorization request.
AppSyncLambdaAuthorizerResponse represents the expected format of an authorization response to AppSync.
Deprecated: AppSyncResolverTemplate does not represent resolver events sent by AppSync.
AutoScalingEvent struct is used to parse the json for auto scaling event types //.
ClaimsAndScopeOverrideDetails allows lambda to add, suppress or override V2 claims and scopes in the token.
ClaimsOverrideDetails allows lambda to add, suppress or override claims in the token.
CloudWatchEvent is the outer structure of an event sent via EventBridge serverless service.
CloudwatchLogsData is an unmarshal'd, ungzip'd, cloudwatch logs event.
CloudwatchLogsEvent represents raw data from a cloudwatch logs event.
CloudwatchLogsLogEvent represents a log entry from cloudwatch logs.
CloudwatchLogsRawData contains gzipped base64 json representing the bulk of a cloudwatch logs event.
CodeBuildArtifact represents the artifact provided to build.
CodeBuildEnvironment represents the environment for a build.
CodeBuildEnvironmentVariable encapsulate environment variables for the code build.
CodeBuildEvent is documented at: https://docs.aws.amazon.com/codebuild/latest/userguide/sample-build-notifications.html#sample-build-notifications-ref.
CodeBuildEventAdditionalInformation represents additional information to the code build event.
CodeBuildEventDetail represents the all details related to the code build event.
CodeBuildLogs gives the log details of a code build.
CodeBuildPhase represents the phase of a build and its details.
CodeBuildSource represent the code source will be build.
CodeCommitCodeCommit represents a CodeCommit object in a record.
CodeCommitEvent represents a CodeCommit event.
CodeCommitRecord represents a CodeCommit record.
CodeCommitReference represents a Reference object in a CodeCommit object.
CodePipelineActionConfiguration represents an Action Configuration.
CodePipelineArtifactCredentials represents CodePipeline artifact credentials.
CodePipelineConfiguration represents a configuration for an Action Configuration.
CodePipelineData represents a job from an AWS CodePipeline event.
CodePipelineInputArtifact represents an input artifact.
CodePipelineInputLocation represents a input location.
CodePipelineJob represents a job from an AWS CodePipeline event.
CodePipelineJobEvent contains data from an event sent from AWS CodePipeline.
CodePipelineOutputArtifact represents an output artifact.
CodePipelineOutputLocation represents a output location.
CodePipelineS3Location represents an s3 input location.
CognitoDatasetRecord represents a record from an Amazon Cognito Sync event.
CognitoEvent contains data from an event sent from Amazon Cognito Sync.
CognitoEventUserPoolsCallerContext contains information about the caller.
CognitoEventUserPoolsChallengeResult represents a challenge that is presented to the user in the authentication process that is underway, along with the corresponding result.
CognitoEventUserPoolsCreateAuthChallenge sent by Amazon Cognito User Pools to create a challenge to present to the user.
CognitoEventUserPoolsCreateAuthChallengeRequest defines create auth challenge request parameters.
CognitoEventUserPoolsCreateAuthChallengeResponse defines create auth challenge response rarameters.
CognitoEventUserPoolsCustomMessage is sent by Amazon Cognito User Pools before a verification or MFA message is sent, allowing a user to customize the message dynamically.
CognitoEventUserPoolsCustomMessageRequest contains the request portion of a CustomMessage event.
CognitoEventUserPoolsCustomMessageResponse contains the response portion of a CustomMessage event.
CognitoEventUserPoolsDefineAuthChallenge sent by Amazon Cognito User Pools to initiate custom authentication flow.
CognitoEventUserPoolsDefineAuthChallengeRequest defines auth challenge request parameters.
CognitoEventUserPoolsDefineAuthChallengeResponse defines auth challenge response parameters.
CognitoEventUserPoolsHeader contains common data from events sent by Amazon Cognito User Pools.
CognitoEventUserPoolsMigrateUser is sent by Amazon Cognito User Pools when a user does not exist in the user pool at the time of sign-in with a password, or in the forgot-password flow.
CognitoEventUserPoolsMigrateUserRequest contains the request portion of a MigrateUser event.
CognitoEventUserPoolsMigrateUserResponse contains the response portion of a MigrateUser event.
CognitoEventUserPoolsPostAuthentication is sent by Amazon Cognito User Pools after a user is authenticated, allowing the Lambda to add custom logic.
CognitoEventUserPoolsPostAuthenticationRequest contains the request portion of a PostAuthentication event.
CognitoEventUserPoolsPostAuthenticationResponse contains the response portion of a PostAuthentication event.
CognitoEventUserPoolsPostConfirmation is sent by Amazon Cognito User Pools after a user is confirmed, allowing the Lambda to send custom messages or add custom logic.
CognitoEventUserPoolsPostConfirmationRequest contains the request portion of a PostConfirmation event.
CognitoEventUserPoolsPostConfirmationResponse contains the response portion of a PostConfirmation event.
CognitoEventUserPoolsPreAuthentication is sent by Amazon Cognito User Pools when a user submits their information to be authenticated, allowing you to perform custom validations to accept or deny the sign in request.
CognitoEventUserPoolsPreAuthenticationRequest contains the request portion of a PreAuthentication event.
CognitoEventUserPoolsPreAuthenticationResponse contains the response portion of a PreAuthentication event.
CognitoEventUserPoolsPreSignup is sent by Amazon Cognito User Pools when a user attempts to register (sign up), allowing a Lambda to perform custom validation to accept or deny the registration request.
CognitoEventUserPoolsPreSignupRequest contains the request portion of a PreSignup event.
CognitoEventUserPoolsPreSignupResponse contains the response portion of a PreSignup event.
CognitoEventUserPoolsPreTokenGen is sent by Amazon Cognito User Pools when a user attempts to retrieve credentials, allowing a Lambda to perform insert, suppress or override claims.
CognitoEventUserPoolsPreTokenGenRequest contains request portion of PreTokenGen event.
CognitoEventUserPoolsPreTokenGenResponse contains the response portion of a PreTokenGen event.
CognitoEventUserPoolsPreTokenGenV2 is sent by Amazon Cognito User Pools when a user attempts to retrieve credentials, allowing a Lambda to perform insert, suppress or override claims and scopes.
CognitoEventUserPoolsPreTokenGenV2Request contains request portion of V2 PreTokenGen event.
CognitoEventUserPoolsPreTokenGenV2Response contains the response portion of a V2 PreTokenGen event.
CognitoEventUserPoolsVerifyAuthChallenge sent by Amazon Cognito User Pools to verify if the response from the end user for a custom Auth Challenge is valid or not.
CognitoEventUserPoolsVerifyAuthChallengeRequest defines verify auth challenge request parameters.
CognitoEventUserPoolsVerifyAuthChallengeResponse defines verify auth challenge response parameters.
ConfigEvent contains data from an event sent from AWS Config.
ConnectContactData holds all of the contact information for the user that invoked the Connect event.
ConnectDetails holds the details of a Connect event.
ConnectEndpoint represents routing information.
ConnectEvent contains the data structure for a Connect event.
ConnectQueue represents a queue object.
DynamoDBAttributeValue provides convenient access for a value stored in DynamoDB.
DynamoDBBatchItemFailure is the individual record which failed processing.
The DynamoDBEvent stream event handled to Lambda http://docs.aws.amazon.com/lambda/latest/dg/eventsources.html#eventsources-ddb-update.
DynamoDBEventRecord stores information about each record of a DynamoDB stream event.
DynamoDBEventResponse is the outer structure to report batch item failures for DynamoDBEvent.
DynamoDBStreamRecord represents a description of a single data modification that was performed on an item in a DynamoDB table.
DynamoDBTimeWindowEvent represents an Amazon Dynamodb event when using time windows ref.
DynamoDBTimeWindowEventResponse is the outer structure to report batch item failures for DynamoDBTimeWindowEvent.
ELBContext contains the information to identify the ARN invoking the lambda.
GroupConfiguration allows lambda to override groups, roles and set a preferred role.
IAMPolicyDocument represents an IAM policy document.
IAMPolicyStatement represents one statement from IAM policy with action, effect and resource.
IDTokenGeneration allows lambda to modify the ID token.
IncompatibleDynamoDBTypeError is the error passed in a panic when calling an accessor for an incompatible type.
IoTCoreCustomAuthorizerRequest represents the request to an IoT Core custom authorizer.
IoTCoreCustomAuthorizerResponse represents the response from an IoT Core custom authorizer.
IoTCustomAuthorizerRequest contains data coming in to a custom IoT device gateway authorizer function.
IoTCustomAuthorizerResponse represents the expected format of an IoT device gateway authorization response.
IoTOneClickEvent represents a click event published by clicking button type device.
IoTPreProvisionHookRequest contains the request parameters for the IoT Pre-Provisioning Hook.
IoTPreProvisionHookResponse contains the response parameters for the IoT Pre-Provisioning Hook.
KinesisBatchItemFailure is the individual record which failed processing.
KinesisEventResponse is the outer structure to report batch item failures for KinesisEvent.
KinesisFirehoseEvent represents the input event from Amazon Kinesis Firehose.
KinesisTimeWindowEvent represents an Amazon Dynamodb event when using time windows ref.
KinesisTimeWindowEventResponse is the outer structure to report batch item failures for KinesisTimeWindowEvent.
LambdaFunctionURLRequest contains data coming from the HTTP request to a Lambda Function URL.
LambdaFunctionURLRequestContext contains the information to identify the AWS account and resources invoking the Lambda function.
LambdaFunctionURLRequestContextAuthorizerDescription contains authorizer information for the request context.
LambdaFunctionURLRequestContextAuthorizerIAMDescription contains IAM information for the request context.
LambdaFunctionURLRequestContextHTTPDescription contains HTTP information for the request context.
LambdaFunctionURLResponse configures the HTTP response to be returned by Lambda Function URL for the request.
LambdaFunctionURLStreamingResponse models the response to a Lambda Function URL when InvokeMode is RESPONSE_STREAM.
MilliSecondsEpochTime serializes a time.Time in JSON as a UNIX epoch time in milliseconds.
RFC3339EpochTime serializes a time.Time in JSON as an ISO 8601 string.
S3BatchJob whichs have the job id.
S3BatchJobEvent encapsulates the detail of a s3 batch job.
S3BatchJobEventV2 encapsulates the detail of a s3 batch job.
S3BatchJobResponse is the response of a iven s3 batch job with the results.
S3BatchJobResult represents the result of a given task.
S3BatchJobTask represents one task in the s3 batch job and have all task details.
S3BatchJobTaskV2 represents one task in the s3 batch job and have all task details.
S3BatchJobV2 whichs have the job id.
S3Event which wrap an array of S3EventRecord.
S3EventRecord which wrap record data.
SecondsEpochTime serializes a time.Time in JSON as a UNIX epoch time in seconds.
SecretsManagerSecretRotationEvent is the event passed to a Lambda function to handle automatic secret rotation.
SimpleEmailDisposition disposition return for SES to control rule functions.
SimpleEmailEvent is the outer structure of an event sent via SES.
SimpleEmailReceiptAction is a logical union of fields present in all action Types.
SQSBatchItemFailure is the individual record which failed processing.
SQSEventResponse is the outer structure to report batch item failures for SQSEvent.
TimeWindowEventResponseProperties is the object that captures response properties that relate to the tumbling windows feature Kinesis: https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-windows DDB: https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-ddb-windows.
TimeWindowProperties is the object that captures properties that relate to the tumbling windows feature Kinesis: https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-windows DDB: https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-ddb-windows.
UnsupportedDynamoDBTypeError is the error returned when trying to unmarshal a DynamoDB Attribute type not recognized by this library.
Window is the object that captures the time window for the records in the event when using the tumbling windows feature Kinesis: https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-windows DDB: https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-ddb-windows.

# Type aliases

APIGatewayCustomAuthorizerPolicy represents an IAM policy.
Deprecated: not used by any event schema.
CodeBuildNumber represents the number of the build.
CodeBuildPhaseStatus represents the status of code build phase (i.e.
CodeBuildPhaseType represents the type of the code build phase (i.e.
CodeBuildTime represents the time of the build.
CodePipelineJob has been incorrectly assigned as CodePipelineEvent - https://github.com/aws/aws-lambda-go/issues/244 This maintains backwards compatability until a v2 release.
ConnectResponse is the structure that Connect expects to get back from Lambda.
DynamoDBDataType specifies the type supported natively by DynamoDB for an attribute.
Deprecated: Use IoTCoreHTTPContext.
Deprecated: Use IoTCoreMQTTContext.
Deprecated: Use IotCoreTLSContext.
JSONNumberBytes represents array of bytes in Headers field.
SimpleEmailDispositionValue enumeration representing the dispostition value for SES.