schemas

package
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 7, 2026 License: MIT Imports: 16 Imported by: 0

Documentation

Overview

Package schemas supplies reusable AWS Lambda service event schemas.

Exports such as SqsSchema, EventBridgeSchema and APIGatewayProxyEventSchema are Parser schemas for validating decoded events. They preserve each family's documented required fields, optional fields and compatibility aliases.

Application payloads

These contracts validate the service envelope rather than every application's payload. Compose the parser/envelopes package with a payload schema to validate message bodies or selected detail fields. The guide maps supported service families and exported schema names and records known compatibility boundaries.

Importing this package does not make AWS requests or initialize service clients.

For usage and compatibility details, see the user guide.

Example
package main

import (
	"context"
	"fmt"

	"github.com/rambow-cloud/powertools-lambda-go/parser"
	"github.com/rambow-cloud/powertools-lambda-go/parser/schemas"
)

func main() {
	// SQS deliveries require at least one record. SafeParse retains validation
	// details so the caller can reject an invalid envelope before business code.
	event := map[string]any{"Records": []any{}}
	result, err := parser.SafeParse(context.Background(), event, schemas.SqsSchema)
	fmt.Println(result.Success, result.Error != nil, err)
}
Output:
false true <nil>

Index

Examples

Constants

This section is empty.

Variables

View Source
var APIGatewayCert = parser.Object(
	field("clientCertPem", parser.String()), field("subjectDN", parser.String()), field("issuerDN", parser.String()), field("serialNumber", parser.String()),
	field("validity", parser.Object(field("notBefore", parser.String()), field("notAfter", parser.String()))),
)
View Source
var APIGatewayEventRequestContextSchema = parser.Refine[any](gatewayRequestContext, func(input any) bool {
	value := input.(map[string]any)
	message := value["messageId"]
	return message == nil || message == "" || value["eventType"] == "MESSAGE"
}, "messageId is available only when `eventType` is MESSAGE")
View Source
var APIGatewayHttpMethod = parser.Enum("GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "OPTIONS")
View Source
var APIGatewayProxyEventSchema = parser.Object(
	field("resource", parser.String()), field("path", parser.String()), field("httpMethod", APIGatewayHttpMethod), nullish("headers", APIGatewayRecord),
	nullish("multiValueHeaders", parser.Dictionary(APIGatewayStringArray)), field("queryStringParameters", parser.Nullable(APIGatewayRecord)),
	field("multiValueQueryStringParameters", parser.Nullable(parser.Dictionary(APIGatewayStringArray))), nullish("pathParameters", APIGatewayRecord), nullish("stageVariables", APIGatewayRecord),
	field("requestContext", APIGatewayEventRequestContextSchema), field("body", parser.Nullable(parser.String())), field("isBase64Encoded", parser.Boolean()),
)
View Source
var APIGatewayProxyEventV2Schema = parser.Object(
	field("version", parser.String()), field("routeKey", parser.String()), field("rawPath", parser.String()), field("rawQueryString", parser.String()), optional("cookies", APIGatewayStringArray),
	field("headers", APIGatewayRecord), optional("queryStringParameters", APIGatewayRecord), field("requestContext", APIGatewayRequestContextV2Schema), optional("body", parser.String()),
	nullish("pathParameters", APIGatewayRecord), field("isBase64Encoded", parser.Boolean()), nullish("stageVariables", APIGatewayRecord),
)
View Source
var APIGatewayProxyWebsocketEventSchema = parser.Object(
	field("type", parser.String()), field("methodArn", parser.String()), nullish("headers", APIGatewayRecord), field("multiValueHeaders", parser.Dictionary(APIGatewayStringArray)),
	field("queryStringParameters", parser.Nullable(APIGatewayRecord)), field("multiValueQueryStringParameters", parser.Nullable(parser.Dictionary(APIGatewayStringArray))), nullish("stageVariables", APIGatewayRecord),
	field("requestContext", parser.Object(
		field("routeKey", parser.String()), field("eventType", parser.Enum("CONNECT", "DISCONNECT", "MESSAGE")), field("extendedRequestId", parser.String()), field("requestTime", parser.String()),
		field("messageDirection", parser.Enum("IN", "OUT")), field("stage", parser.String()), field("connectedAt", parser.Number()), field("requestTimeEpoch", parser.Number()),
		field("identity", parser.Object(field("sourceIp", parser.String()), optional("userAgent", parser.String()))), field("requestId", parser.String()), field("domainName", parser.String()), field("connectionId", parser.String()), field("apiId", parser.String()),
	)), field("isBase64Encoded", parser.Boolean()), nullish("body", parser.String()),
)
View Source
var APIGatewayRecord = parser.Dictionary(parser.String())
View Source
var APIGatewayRequestAuthorizerEventSchema = parser.Object(
	field("type", parser.Literal("REQUEST")), field("methodArn", parser.String()), field("resource", parser.String()), field("path", parser.String()), field("httpMethod", APIGatewayHttpMethod),
	field("headers", APIGatewayRecord), field("multiValueHeaders", parser.Dictionary(APIGatewayStringArray)), field("queryStringParameters", APIGatewayRecord),
	field("multiValueQueryStringParameters", parser.Dictionary(APIGatewayStringArray)), field("pathParameters", APIGatewayRecord), field("stageVariables", APIGatewayRecord),
	field("requestContext", APIGatewayEventRequestContextSchema), optional("domainName", parser.String()), optional("deploymentId", parser.String()), optional("apiId", parser.String()),
)
View Source
var APIGatewayRequestAuthorizerEventV2Schema = parser.Object(
	field("version", parser.Literal("2.0")), field("type", parser.Literal("REQUEST")), field("routeArn", parser.String()), nullish("identitySource", APIGatewayStringArray),
	field("routeKey", parser.String()), field("rawPath", parser.String()), field("rawQueryString", parser.String()), optional("cookies", APIGatewayStringArray),
	optional("headers", APIGatewayRecord), optional("queryStringParameters", APIGatewayRecord), field("requestContext", APIGatewayRequestContextV2Schema),
	nullish("pathParameters", APIGatewayRecord), nullish("stageVariables", APIGatewayRecord),
)
View Source
var APIGatewayRequestAuthorizerV2Schema = parser.Object(
	optional("jwt", parser.Object(field("claims", parser.Dictionary(parser.Unknown())), field("scopes", parser.Nullable(APIGatewayStringArray)))),
	optional("iam", parser.Object(optional("accessKey", parser.String()), optional("accountId", parser.String()), optional("callerId", parser.String()), nullish("principalOrgId", parser.String()), optional("userArn", parser.String()), optional("userId", parser.String()),
		nullish("cognitoIdentity", parser.Object(field("amr", APIGatewayStringArray), field("identityId", parser.String()), field("identityPoolId", parser.String()))))),
	nullish("lambda", parser.Dictionary(parser.Unknown())),
)
View Source
var APIGatewayRequestContextV2Schema = parser.Object(
	field("accountId", parser.String()), field("apiId", parser.String()), optional("authorizer", APIGatewayRequestAuthorizerV2Schema),
	nullish("authentication", parser.Object(optional("clientCert", APIGatewayCert))), field("domainName", parser.String()), field("domainPrefix", parser.String()),
	field("http", parser.Object(field("method", APIGatewayHttpMethod), field("path", parser.String()), field("protocol", parser.String()), field("sourceIp", gatewaySourceIP), field("userAgent", parser.String()))),
	field("requestId", parser.String()), field("routeKey", parser.String()), field("stage", parser.String()), field("time", parser.String()), field("timeEpoch", parser.Number()),
)
View Source
var APIGatewayStringArray = array(parser.String())
View Source
var APIGatewayTokenAuthorizerEventSchema = parser.Object(field("type", parser.Literal("TOKEN")), field("authorizationToken", parser.String()), field("methodArn", parser.String()))
View Source
var AlbMultiValueHeadersSchema = AlbSchema.Extend(field("multiValueHeaders", parser.Dictionary(APIGatewayStringArray)), field("multiValueQueryStringParameters", parser.Dictionary(APIGatewayStringArray)))
View Source
var AlbSchema = parser.Object(
	field("httpMethod", parser.String()), field("path", parser.String()), field("body", parser.String()), field("isBase64Encoded", parser.Boolean()),
	optional("headers", APIGatewayRecord), optional("multiValueHeaders", parser.Dictionary(APIGatewayStringArray)), optional("queryStringParameters", APIGatewayRecord), optional("multiValueQueryStringParameters", parser.Dictionary(APIGatewayStringArray)),
	field("requestContext", parser.Object(field("elb", parser.Object(field("targetGroupArn", parser.String()))))),
)
View Source
var AppSyncBatchResolverSchema = array(AppSyncResolverSchema)
View Source
var AppSyncCognitoIdentity = parser.Object(
	field("sub", parser.String()), field("issuer", parser.String()), field("username", parser.String()),
	field("claims", parser.Dictionary(parser.Unknown())), field("sourceIp", array(ipAddress(4))),
	field("defaultAuthStrategy", parser.Nullable(parser.String())), field("groups", parser.Nullable(array(parser.String()))),
)
View Source
var AppSyncEventsBaseSchema = parser.Object(
	field("identity", parser.Union(parser.Null(), AppSyncCognitoIdentity, AppSyncIamIdentity, AppSyncLambdaAuthIdentity, AppSyncOidcIdentity)),
	field("result", parser.Null()), field("request", AppSyncEventsRequestSchema), field("info", AppSyncEventsInfoSchema),
	field("error", parser.Null()), field("prev", parser.Null()), field("stash", parser.Object()),
	field("outErrors", array(parser.Unknown())), field("events", parser.Null()),
)
View Source
var AppSyncEventsInfoSchema = parser.Object(
	field("channel", parser.Object(field("path", parser.String()), field("segments", array(parser.String())))),
	field("channelNamespace", parser.Object(field("name", parser.String()))),
	field("operation", parser.Union(parser.Literal("PUBLISH"), parser.Literal("SUBSCRIBE"))),
)
View Source
var AppSyncEventsPublishSchema = AppSyncEventsBaseSchema.Extend(
	field("info", AppSyncEventsInfoSchema.Extend(field("operation", parser.Literal("PUBLISH")))),
	field("events", array(parser.Object(field("payload", parser.Dictionary(parser.Unknown())), field("id", parser.String())), 1)),
)
View Source
var AppSyncEventsRequestSchema = parser.Object(optional("headers", parser.Dictionary(parser.String())), field("domainName", parser.Nullable(parser.String())))
View Source
var AppSyncEventsSubscribeSchema = AppSyncEventsBaseSchema.Extend(field("info", AppSyncEventsInfoSchema.Extend(field("operation", parser.Literal("SUBSCRIBE")))), field("events", parser.Null()))
View Source
var AppSyncIamIdentity = parser.Object(
	field("accountId", parser.String()), field("cognitoIdentityPoolId", parser.Nullable(parser.String())),
	field("cognitoIdentityId", parser.Nullable(parser.String())), field("sourceIp", array(parser.String())),
	field("username", parser.String()), field("userArn", parser.String()),
	field("cognitoIdentityAuthType", parser.Nullable(parser.String())), field("cognitoIdentityAuthProvider", parser.Nullable(parser.String())),
)
View Source
var AppSyncLambdaAuthIdentity = parser.Object(field("handlerContext", parser.Dictionary(parser.Unknown())))
View Source
var AppSyncLambdaIdentity = parser.Object(field("resolverContext", parser.Unknown()))
View Source
var AppSyncOidcIdentity = parser.Object(field("claims", parser.Unknown()), field("issuer", parser.String()), field("sub", parser.String()))
View Source
var AppSyncResolverSchema = parser.Object(
	field("arguments", parser.Dictionary(parser.Unknown())),
	optional("identity", parser.Union(AppSyncCognitoIdentity, AppSyncIamIdentity, AppSyncOidcIdentity, AppSyncLambdaIdentity)),
	field("source", parser.Nullable(parser.Dictionary(parser.Unknown()))),
	field("request", parser.Object(field("domainName", parser.Nullable(parser.String())), field("headers", parser.Dictionary(parser.String())))),
	field("info", parser.Object(
		field("selectionSetList", array(parser.String())), field("selectionSetGraphQL", parser.String()),
		field("parentTypeName", parser.String()), field("fieldName", parser.String()), field("variables", parser.Dictionary(parser.Unknown())),
	)),
	field("prev", parser.Nullable(parser.Object(field("result", parser.Dictionary(parser.Unknown()))))),
	field("stash", parser.Dictionary(parser.Unknown())),
)
View Source
var ChallengeResultSchema = parser.Object(
	field("challengeName", parser.Union(
		parser.Literal("CUSTOM_CHALLENGE"), parser.Literal("SRP_A"), parser.Literal("PASSWORD_VERIFIER"), parser.Literal("SMS_MFA"), parser.Literal("EMAIL_OTP"),
		parser.Literal("SOFTWARE_TOKEN_MFA"), parser.Literal("DEVICE_SRP_AUTH"), parser.Literal("DEVICE_PASSWORD_VERIFIER"), parser.Literal("ADMIN_NO_SRP_AUTH"),
	)), field("challengeResult", parser.Boolean()), optional("challengeMetadata", parser.String()),
)
View Source
var CloudFormationCustomResourceCreateSchema = cloudFormationBase.Extend(field("RequestType", parser.Literal("Create")))
View Source
var CloudFormationCustomResourceDeleteSchema = cloudFormationBase.Extend(field("RequestType", parser.Literal("Delete")), field("PhysicalResourceId", parser.String()))
View Source
var CloudFormationCustomResourceUpdateSchema = cloudFormationBase.Extend(field("RequestType", parser.Literal("Update")), field("OldResourceProperties", parser.Dictionary(parser.Unknown())), field("PhysicalResourceId", parser.String()))
View Source
var CloudWatchLogEventSchema = parser.Object(field("id", parser.String()), field("timestamp", parser.Number()), field("message", parser.String()))
View Source
var CloudWatchLogsDecodeSchema = parser.Object(
	field("messageType", parser.String()), field("owner", parser.String()), field("logGroup", parser.String()), field("logStream", parser.String()),
	field("subscriptionFilters", array(parser.String())), field("logEvents", array(CloudWatchLogEventSchema, 1)),
)
View Source
var CloudWatchLogsSchema = parser.Object(field("awslogs", parser.Object(field("data", cloudwatchData))))
View Source
var CognitoTriggerBaseSchema = parser.Object(
	field("version", parser.String()), field("triggerSource", parser.String()), field("region", parser.String()),
	field("userPoolId", parser.String()), optional("userName", parser.String()),
	field("callerContext", parser.Object(field("awsSdkVersion", parser.String()), field("clientId", parser.Nullable(parser.String())))),
	field("request", parser.Object()), field("response", parser.Object()),
)
View Source
var ConnectOutboundCampaignsCustomerProfileSchema = parser.Object(field("ProfileId", parser.String()), field("CustomerData", parser.String()), field("IdempotencyToken", parser.String()))
View Source
var ConnectOutboundCampaignsSchema = parser.Object(
	field("InvocationMetadata", parser.Object(field("CampaignContext", parser.Object(field("CampaignId", parser.String()), field("RunId", parser.String()), field("ActionId", parser.String()), field("CampaignName", parser.String()))))),
	field("Items", parser.Object(field("CustomerProfiles", array(ConnectOutboundCampaignsCustomerProfileSchema)))),
)
View Source
var CreateAuthChallengeTriggerSchema = CognitoTriggerBaseSchema.Extend(
	field("triggerSource", parser.Literal("CreateAuthChallenge_Authentication")),
	field("request", parser.Object(cognitoUserAttributes, field("challengeName", parser.String()), cognitoSession, cognitoClientMetadata, cognitoUserNotFound)),
	field("response", parser.Object(nullish("publicChallengeParameters", parser.Dictionary(parser.String())), nullish("privateChallengeParameters", parser.Dictionary(parser.String())), nullish("challengeMetadata", parser.String()))),
)
View Source
var CustomEmailSenderTriggerSchema = CognitoTriggerBaseSchema.Extend(
	field("triggerSource", parser.Enum("CustomEmailSender_SignUp", "CustomEmailSender_Authentication", "CustomEmailSender_ForgotPassword", "CustomEmailSender_ResendCode", "CustomEmailSender_UpdateUserAttribute", "CustomEmailSender_VerifyUserAttribute", "CustomEmailSender_AdminCreateUser", "CustomEmailSender_AccountTakeOverNotification")),
	field("request", parser.Object(field("type", parser.Literal("customEmailSenderRequestV1")), field("code", parser.String()), cognitoClientMetadata, cognitoUserAttributes)),
	nullish("response", parser.Object()),
)
View Source
var CustomMessageTriggerSchema = CognitoTriggerBaseSchema.Extend(
	field("request", parser.Object(cognitoUserAttributes, field("codeParameter", parser.String()), field("linkParameter", parser.Nullable(parser.String())), field("usernameParameter", parser.Nullable(parser.String())), cognitoClientMetadata)),
	field("response", parser.Object(field("smsMessage", parser.Nullable(parser.String())), field("emailMessage", parser.Nullable(parser.String())), field("emailSubject", parser.Nullable(parser.String())))),
)
View Source
var CustomSMSSenderTriggerSchema = CognitoTriggerBaseSchema.Extend(
	field("triggerSource", parser.Enum("CustomSMSSender_SignUp", "CustomSMSSender_Authentication", "CustomSMSSender_ForgotPassword", "CustomSMSSender_ResendCode", "CustomSMSSender_UpdateUserAttribute", "CustomSMSSender_VerifyUserAttribute", "CustomSMSSender_AdminCreateUser")),
	field("request", parser.Object(field("type", parser.Literal("customSMSSenderRequestV1")), field("code", parser.String()), cognitoClientMetadata, cognitoUserAttributes)),
	nullish("response", parser.Object()),
)
View Source
var DefineAuthChallengeTriggerSchema = CognitoTriggerBaseSchema.Extend(
	field("triggerSource", parser.Literal("DefineAuthChallenge_Authentication")),
	field("request", parser.Object(cognitoUserAttributes, cognitoSession, cognitoClientMetadata, cognitoUserNotFound)),
	field("response", parser.Object(nullish("challengeName", parser.String()), nullish("issueTokens", parser.Boolean()), nullish("failAuthentication", parser.Boolean()))),
)
View Source
var DynamoDBStreamChangeRecord = parser.Pipe[any, any](DynamoDBStreamChangeRecordBase, unmarshallImages)
View Source
var DynamoDBStreamChangeRecordBase = parser.Object(
	optional("ApproximateCreationDateTime", parser.Number()), field("Keys", parser.Dictionary(parser.Dictionary(parser.Unknown()))),
	optional("NewImage", parser.Dictionary(parser.Unknown())), optional("OldImage", parser.Dictionary(parser.Unknown())),
	field("SequenceNumber", parser.String()), field("SizeBytes", parser.Number()), field("StreamViewType", parser.Enum("NEW_IMAGE", "OLD_IMAGE", "NEW_AND_OLD_IMAGES", "KEYS_ONLY")),
)
View Source
var DynamoDBStreamRecord = parser.Object(
	field("eventID", parser.String()), field("eventName", parser.Enum("INSERT", "MODIFY", "REMOVE")), field("eventVersion", parser.String()),
	field("eventSource", parser.Literal("aws:dynamodb")), field("awsRegion", parser.String()), field("eventSourceARN", parser.String()),
	field("dynamodb", DynamoDBStreamChangeRecord), optional("userIdentity", UserIdentity),
)
View Source
var DynamoDBStreamSchema = parser.Object(append([]parser.Field{field("Records", array(DynamoDBStreamRecord, 1))}, windowFields(parser.String())...)...)
View Source
var DynamoDBStreamToKinesisChangeRecord = DynamoDBStreamChangeRecordBase.Omit("SequenceNumber", "StreamViewType")
View Source
var DynamoDBStreamToKinesisRecord = DynamoDBStreamRecord.Extend(
	field("recordFormat", parser.Literal("application/json")), field("tableName", parser.String()), nullish("userIdentity", UserIdentity),
	field("dynamodb", parser.Pipe[any, any](DynamoDBStreamToKinesisChangeRecord, unmarshallImages)),
).Omit("eventVersion", "eventSourceARN")
View Source
var EventBridgeSchema = parser.Object(
	parser.Field{Name: "version", Schema: parser.String()},
	parser.Field{Name: "id", Schema: parser.String()},
	parser.Field{Name: "source", Schema: parser.String()},
	parser.Field{Name: "account", Schema: parser.String()},
	parser.Field{Name: "time", Schema: isoDateTime},
	parser.Field{Name: "region", Schema: parser.String()},
	parser.Field{Name: "resources", Schema: parser.Any(parser.Array(parser.String()))},
	parser.Field{Name: "detail-type", Schema: parser.String()},
	parser.Field{Name: "detail", Schema: parser.Unknown()},
	parser.Field{Name: "replay-name", Schema: parser.String(), Optional: true},
)
View Source
var KafkaMskEventSchema = kafkaBase.Extend(field("eventSource", parser.Literal("aws:kafka")), field("eventSourceArn", parser.String()))
View Source
var KafkaRecordSchema = parser.Object(field("topic", parser.String()), field("partition", parser.Number()), field("offset", parser.Number()), field("timestamp", parser.Number()), field("timestampType", parser.String()), optional("key", kafkaText), field("value", kafkaText), field("headers", array(parser.Dictionary(kafkaHeader))))
View Source
var KafkaSelfManagedEventSchema = kafkaBase.Extend(field("eventSource", parser.Literal("SelfManagedKafka")))
View Source
var KinesisDataStreamRecord = parser.Object(
	field("eventSource", parser.Literal("aws:kinesis")), field("eventVersion", parser.String()), field("eventID", parser.String()),
	field("eventName", parser.Literal("aws:kinesis:record")), field("awsRegion", parser.String()), field("invokeIdentityArn", parser.String()),
	field("eventSourceARN", parser.String()), field("kinesis", KinesisDataStreamRecordPayload),
)
View Source
var KinesisDataStreamRecordPayload = parser.Object(
	field("kinesisSchemaVersion", parser.String()), field("partitionKey", parser.String()), field("sequenceNumber", parser.String()),
	field("approximateArrivalTimestamp", parser.Number()), field("data", parser.Base64Encoded(parser.Unknown())),
)
View Source
var KinesisDataStreamSchema = parser.Object(append([]parser.Field{field("Records", array(KinesisDataStreamRecord, 1))}, windowFields(parser.Unknown())...)...)
View Source
var KinesisDynamoDBStreamSchema = parser.Object(field("Records", array(KinesisDataStreamRecord.Extend(
	field("kinesis", KinesisDataStreamRecordPayload.Extend(field("data", parser.Pipe[any, any](parser.Base64Encoded(parser.Unknown()), DynamoDBStreamToKinesisRecord)))),
))))
View Source
var KinesisFirehoseRecordSchema = firehoseRecordBase.Extend(field("data", base64Text))
View Source
var KinesisFirehoseSchema = firehoseBase.Extend(field("records", array(KinesisFirehoseRecordSchema, 1)))
View Source
var KinesisFirehoseSqsRecordSchema = firehoseRecordBase.Extend(field("data", firehoseSqsData))
View Source
var KinesisFirehoseSqsSchema = firehoseBase.Extend(field("records", array(KinesisFirehoseSqsRecordSchema, 1)))
View Source
var LambdaFunctionUrlSchema = APIGatewayProxyEventV2Schema.Extend()

Lambda Function URLs use the reference HTTP API v2 event contract.

View Source
var MigrateUserTriggerSchema = CognitoTriggerBaseSchema.Extend(
	field("userName", parser.String()),
	field("request", parser.Object(field("password", parser.String()), optional("validationData", parser.Dictionary(parser.String())), cognitoClientMetadata)),
	field("response", parser.Object(
		field("userAttributes", parser.Nullable(parser.Dictionary(parser.String()))), field("finalUserStatus", parser.Nullable(parser.String())),
		field("messageAction", parser.Nullable(parser.String())), field("desiredDeliveryMediums", parser.Nullable(array(parser.String()))),
		field("forceAliasCreation", parser.Nullable(parser.Boolean())), field("enableSMSMFA", parser.Nullable(parser.Boolean())),
	)),
)
View Source
var PostAuthenticationTriggerSchema = CognitoTriggerBaseSchema.Extend(
	field("triggerSource", parser.Literal("PostAuthentication_Authentication")),
	field("request", parser.Object(cognitoUserAttributes, optional("newDeviceUsed", parser.Boolean()), cognitoClientMetadata)),
)
View Source
var PostConfirmationTriggerSchema = CognitoTriggerBaseSchema.Extend(
	field("triggerSource", parser.Enum("PostConfirmation_ConfirmSignUp", "PostConfirmation_ConfirmForgotPassword")),
	field("request", parser.Object(cognitoUserAttributes, cognitoClientMetadata)), field("response", parser.Object()),
)
View Source
var PreAuthenticationTriggerSchema = CognitoTriggerBaseSchema.Extend(
	field("triggerSource", parser.Literal("PreAuthentication_Authentication")),
	field("request", parser.Object(cognitoUserAttributes, nullish("validationData", parser.Dictionary(parser.String())), cognitoUserNotFound)),
	field("response", parser.Object()),
)
View Source
var PreSignupTriggerSchema = CognitoTriggerBaseSchema.Extend(
	field("triggerSource", parser.Enum("PreSignUp_SignUp", "PreSignUp_AdminCreateUser", "PreSignUp_ExternalProvider")),
	field("request", parser.Object(cognitoUserAttributes, field("validationData", parser.Nullable(parser.Dictionary(parser.String()))), cognitoClientMetadata, cognitoUserNotFound)),
	field("response", parser.Object(field("autoConfirmUser", parser.Literal(false)), field("autoVerifyEmail", parser.Literal(false)), field("autoVerifyPhone", parser.Literal(false)))),
)
View Source
var PreTokenGenerationTriggerGroupConfigurationSchema = parser.Object(
	field("groupsToOverride", array(parser.String())), field("iamRolesToOverride", array(parser.String())), field("preferredRole", parser.Nullable(parser.String())),
)
View Source
var PreTokenGenerationTriggerRequestSchema = parser.Object(cognitoUserAttributes, field("groupConfiguration", PreTokenGenerationTriggerGroupConfigurationSchema), cognitoClientMetadata)
View Source
var PreTokenGenerationTriggerSchemaV1 = CognitoTriggerBaseSchema.Extend(field("request", PreTokenGenerationTriggerRequestSchema))
View Source
var PreTokenGenerationTriggerSchemaV2AndV3 = CognitoTriggerBaseSchema.Extend(field("request", PreTokenGenerationTriggerRequestSchema.Extend(optional("scopes", array(parser.String())))))
View Source
var S3EventNotificationEventBridgeSchema = EventBridgeSchema.Extend(field("detail", s3EventBridgeDetail))
View Source
var S3ObjectLambdaEventSchema = parser.Object(field("xAmzRequestId", parser.String()),
	field("getObjectContext", parser.Object(field("inputS3Url", parser.String()), field("outputRoute", parser.String()), field("outputToken", parser.String()))),
	field("configuration", parser.Object(field("accessPointArn", parser.String()), field("supportingAccessPointArn", parser.String()), field("payload", parser.Union(parser.String(), parser.Object())))),
	field("userRequest", parser.Object(field("url", parser.String()), field("headers", parser.Dictionary(parser.String())))),
	field("userIdentity", parser.Object(field("type", parser.String()), field("accountId", parser.String()), field("accessKeyId", parser.String()), optional("userName", parser.String()), field("principalId", parser.String()), field("arn", parser.String()), optional("sessionContext", s3SessionContext))), field("protocolVersion", parser.String()),
)
View Source
var S3Schema = parser.Object(field("Records", array(s3Record, 1)))
View Source
var S3SqsEventNotificationSchema = parser.Object(field("Records", array(SqsRecordSchema.Extend(field("body", parser.JSONStringified[any](S3Schema))), 1)))
View Source
var SesRecordSchema = parser.Object(field("eventSource", parser.Literal("aws:ses")), field("eventVersion", parser.String()), field("ses", parser.Object(field("mail", sesMail), field("receipt", sesReceipt))))
View Source
var SesSchema = parser.Object(field("Records", array(SesRecordSchema, 1)))
View Source
var SnsNotificationSchema = parser.Object(
	nullish("Subject", parser.String()), field("TopicArn", parser.String()), field("UnsubscribeUrl", absoluteURL),
	optional("UnsubscribeURL", absoluteURL), optional("SigningCertUrl", absoluteURL), optional("SigningCertURL", absoluteURL),
	field("Type", parser.Literal("Notification")), optional("MessageAttributes", parser.Dictionary(snsMsgAttribute)),
	field("Message", parser.String()), field("MessageId", parser.String()), optional("Signature", parser.String()),
	optional("SignatureVersion", parser.String()), field("Timestamp", isoDateTime),
)
View Source
var SnsRecordSchema = parser.Object(field("EventSource", parser.Literal("aws:sns")), field("EventVersion", parser.String()), field("EventSubscriptionArn", parser.String()), field("Sns", SnsNotificationSchema))
View Source
var SnsSchema = parser.Object(field("Records", array(SnsRecordSchema, 1)))
View Source
var SnsSqsNotificationSchema = SnsNotificationSchema.Extend(optional("UnsubscribeURL", parser.String()), optional("SigningCertURL", absoluteURL)).Omit("UnsubscribeUrl", "SigningCertUrl")
View Source
var SqsAttributesSchema = parser.Object(
	parser.Field{Name: "ApproximateReceiveCount", Schema: parser.String()},
	parser.Field{Name: "ApproximateFirstReceiveTimestamp", Schema: parser.String()},
	parser.Field{Name: "MessageDeduplicationId", Schema: parser.String(), Optional: true},
	parser.Field{Name: "MessageGroupId", Schema: parser.String(), Optional: true},
	parser.Field{Name: "SenderId", Schema: parser.String()},
	parser.Field{Name: "SentTimestamp", Schema: parser.String()},
	parser.Field{Name: "SequenceNumber", Schema: parser.String(), Optional: true},
	parser.Field{Name: "AWSTraceHeader", Schema: parser.String(), Optional: true},
	parser.Field{Name: "DeadLetterQueueSourceArn", Schema: parser.String(), Optional: true},
)
View Source
var SqsMsgAttributeDataTypeSchema = parser.Union(parser.Literal("String"), parser.Literal("Number"), parser.Literal("Binary"), parser.String())
View Source
var SqsMsgAttributeSchema = parser.Object(
	parser.Field{Name: "stringValue", Schema: parser.Nullable(parser.String()), Optional: true},
	parser.Field{Name: "binaryValue", Schema: parser.Nullable(parser.String()), Optional: true},
	parser.Field{Name: "stringListValues", Schema: parser.Any(parser.Array(parser.String())), Optional: true},
	parser.Field{Name: "binaryListValues", Schema: parser.Any(parser.Array(parser.String())), Optional: true},
	parser.Field{Name: "dataType", Schema: SqsMsgAttributeDataTypeSchema},
)
View Source
var SqsRecordSchema = parser.Object(
	parser.Field{Name: "messageId", Schema: parser.String()},
	parser.Field{Name: "receiptHandle", Schema: parser.String()},
	parser.Field{Name: "body", Schema: parser.String()},
	parser.Field{Name: "attributes", Schema: SqsAttributesSchema},
	parser.Field{Name: "messageAttributes", Schema: parser.Dictionary(SqsMsgAttributeSchema)},
	parser.Field{Name: "md5OfBody", Schema: parser.String()},
	parser.Field{Name: "md5OfMessageAttributes", Schema: parser.Nullable(parser.String()), Optional: true},
	parser.Field{Name: "eventSource", Schema: parser.Literal("aws:sqs")},
	parser.Field{Name: "eventSourceARN", Schema: parser.String()},
	parser.Field{Name: "awsRegion", Schema: parser.String()},
)
View Source
var SqsSchema = parser.Object(parser.Field{Name: "Records", Schema: parser.Any(parser.Array(SqsRecordSchema, 1))})
View Source
var TransferFamilySchema = parser.Object(field("username", parser.String()), field("password", parser.String()), field("protocol", parser.String()), field("serverId", parser.String()), field("sourceIp", ipAddress(4)))
View Source
var UserIdentity = parser.Object(field("type", parser.Enum("Service")), field("principalId", parser.Literal("dynamodb.amazonaws.com")))
View Source
var VerifyAuthChallengeTriggerSchema = CognitoTriggerBaseSchema.Extend(
	field("triggerSource", parser.Literal("VerifyAuthChallengeResponse_Authentication")),
	field("request", parser.Object(cognitoUserAttributes, field("privateChallengeParameters", parser.Dictionary(parser.String())), field("challengeAnswer", parser.String()), cognitoClientMetadata, cognitoUserNotFound)),
	field("response", parser.Object(field("answerCorrect", parser.Nullable(parser.Boolean())))),
)
View Source
var VpcLatticeSchema = parser.Object(field("method", APIGatewayHttpMethod), field("raw_path", parser.String()), field("body", parser.String()), field("is_base64_encoded", parser.Boolean()), field("headers", APIGatewayRecord), field("query_string_parameters", APIGatewayRecord))
View Source
var VpcLatticeV2Schema = parser.Object(field("version", parser.String()), field("path", parser.String()), field("method", APIGatewayHttpMethod), field("headers", latticeV2Values), optional("queryStringParameters", latticeV2Values), optional("body", parser.String()), optional("isBase64Encoded", parser.Boolean()), field("requestContext", latticeContext), optional("requestId", parser.String()))

Functions

This section is empty.

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL