API Reference
    Preparing search index...

    Type Alias AppSyncEventsEvent

    Event type for AppSync Events.

    For strongly typed validation and parsing at runtime, check out the @aws-lambda-powertools/parser package.

    type AppSyncEventsEvent = {
        error: null;
        events: unknown;
        identity: null | Record<string, unknown>;
        info: {
            channel: { path: string; segments: string[] };
            channelNamespace: { name: string };
            operation: "PUBLISH" | "SUBSCRIBE";
        };
        outErrors: unknown[];
        prev: null;
        request: { domainName: null; headers: Record<string, string> };
        result: null;
        stash: Record<string, unknown>;
    }
    Index

    Properties

    error events identity info outErrors prev request result stash

    Properties

    error: null
    events: unknown
    identity: null | Record<string, unknown>

    The identity field varies based on the authentication type used for the AppSync API. When using an API key, it will be null. When using IAM, it will contain the AWS credentials of the user. When using Cognito, it will contain the Cognito user pool information. When using a Lambda authorizer, it will contain the information returned by the authorizer.

    info: {
        channel: { path: string; segments: string[] };
        channelNamespace: { name: string };
        operation: "PUBLISH" | "SUBSCRIBE";
    }
    outErrors: unknown[]
    prev: null
    request: { domainName: null; headers: Record<string, string> }
    result: null
    stash: Record<string, unknown>

    Settings

    Member Visibility

    On This Page

    Properties