API Reference
    Preparing search index...

    Variable PreTokenGenerationTriggerSchemaV1Const

    PreTokenGenerationTriggerSchemaV1: ZodObject<
        {
            callerContext: ZodObject<
                { awsSdkVersion: ZodString; clientId: ZodString },
                "strip",
                ZodTypeAny,
                { awsSdkVersion: string; clientId: string },
                { awsSdkVersion: string; clientId: string },
            >;
            region: ZodString;
            response: ZodObject<{}, "strip", ZodTypeAny, {}, {}>;
            triggerSource: ZodString;
            userName: ZodOptional<ZodString>;
            userPoolId: ZodString;
            version: ZodString;
        } & {
            request: ZodObject<
                {
                    clientMetadata: ZodOptional<ZodRecord<ZodString, ZodString>>;
                    groupConfiguration: ZodObject<
                        {
                            groupsToOverride: ZodArray<ZodString, "many">;
                            iamRolesToOverride: ZodArray<ZodString, "many">;
                            preferredRole: ZodOptional<ZodString>;
                        },
                        "strip",
                        ZodTypeAny,
                        {
                            groupsToOverride: string[];
                            iamRolesToOverride: string[];
                            preferredRole?: string;
                        },
                        {
                            groupsToOverride: string[];
                            iamRolesToOverride: string[];
                            preferredRole?: string;
                        },
                    >;
                    userAttributes: ZodRecord<ZodString, ZodString>;
                },
                "strip",
                ZodTypeAny,
                {
                    clientMetadata?: Record<string, string>;
                    groupConfiguration: {
                        groupsToOverride: string[];
                        iamRolesToOverride: string[];
                        preferredRole?: string;
                    };
                    userAttributes: Record<string, string>;
                },
                {
                    clientMetadata?: Record<string, string>;
                    groupConfiguration: {
                        groupsToOverride: string[];
                        iamRolesToOverride: string[];
                        preferredRole?: string;
                    };
                    userAttributes: Record<string, string>;
                },
            >;
        },
        "strip",
        ZodTypeAny,
        {
            callerContext: { awsSdkVersion: string; clientId: string };
            region: string;
            request: {
                clientMetadata?: Record<string, string>;
                groupConfiguration: {
                    groupsToOverride: string[];
                    iamRolesToOverride: string[];
                    preferredRole?: string;
                };
                userAttributes: Record<string, string>;
            };
            response: {};
            triggerSource: string;
            userName?: string;
            userPoolId: string;
            version: string;
        },
        {
            callerContext: { awsSdkVersion: string; clientId: string };
            region: string;
            request: {
                clientMetadata?: Record<string, string>;
                groupConfiguration: {
                    groupsToOverride: string[];
                    iamRolesToOverride: string[];
                    preferredRole?: string;
                };
                userAttributes: Record<string, string>;
            };
            response: {};
            triggerSource: string;
            userName?: string;
            userPoolId: string;
            version: string;
        },
    > = ...

    A zod schema for a Cognito Pre-Token Generation trigger event (version 1).

    {
    "version": "1",
    "triggerSource": "TokenGeneration_Authentication",
    "region": "us-east-1",
    "userPoolId": "us-east-1_ABC123",
    "userName": "johndoe",
    "callerContext": {
    "awsSdkVersion": "2.814.0",
    "clientId": "client123"
    },
    "request": {
    "userAttributes": { "string": "string" },
    "groupConfiguration": {
    "groupsToOverride": [ "string", "string" ],
    "iamRolesToOverride": [ "string", "string" ],
    "preferredRole": "string"
    },
    "clientMetadata": { "string": "string" }
    },
    "response": {}
    }