Type Alias AppSyncResolverEvent

AppSyncResolverEvent: {
    arguments: Record<string, any>;
    identity?:
        | {
            accountId: string;
            cognitoIdentityAuthProvider: null
            | string;
            cognitoIdentityAuthType: null | string;
            cognitoIdentityId: null | string;
            cognitoIdentityPoolId: null | string;
            sourceIp: string[];
            userArn: string;
            username: string;
        }
        | {
            claims?: any;
            defaultAuthStrategy: string;
            groups: null
            | string[];
            issuer: string;
            sourceIp: string[];
            sub: string;
            username: string;
        }
        | { claims?: any; issuer: string; sub: string }
        | { resolverContext?: any };
    info: {
        fieldName: string;
        parentTypeName: string;
        selectionSetGraphQL: string;
        selectionSetList: string[];
        variables: Record<string, any>;
    };
    prev: null
    | { result: Record<string, any> };
    request: { domainName: null | string; headers: Record<string, string> };
    source: null | Record<string, any>;
    stash: Record<string, any>;
}

A zod schema for an AppSync resolver event

Type declaration

  • arguments: Record<string, any>
  • Optionalidentity?:
        | {
            accountId: string;
            cognitoIdentityAuthProvider: null
            | string;
            cognitoIdentityAuthType: null | string;
            cognitoIdentityId: null | string;
            cognitoIdentityPoolId: null | string;
            sourceIp: string[];
            userArn: string;
            username: string;
        }
        | {
            claims?: any;
            defaultAuthStrategy: string;
            groups: null
            | string[];
            issuer: string;
            sourceIp: string[];
            sub: string;
            username: string;
        }
        | { claims?: any; issuer: string; sub: string }
        | { resolverContext?: any }
  • info: {
        fieldName: string;
        parentTypeName: string;
        selectionSetGraphQL: string;
        selectionSetList: string[];
        variables: Record<string, any>;
    }
  • prev: null | { result: Record<string, any> }
  • request: { domainName: null | string; headers: Record<string, string> }
  • source: null | Record<string, any>
  • stash: Record<string, any>

Example

{
  "arguments": {
    "id": "1973493"
  },
  "source": null,
  "identity": {
    "accountId": "012345678901",
    "cognitoIdentityAuthProvider": null,
    "cognitoIdentityAuthType": null,
    "cognitoIdentityId": null,
    "cognitoIdentityPoolId": null,
    "sourceIp": ["10.10.10.10"],
    "userArn": "arn:aws:sts::012345678901:assumed-role/role",
    "username": "AROAXYKJUOW6FHGUSK5FA:username"
  },
  "request": {
    "headers": {
      "x-forwarded-for": "1.1.1.1, 2.2.2.2",
      "cloudfront-viewer-country": "US",
      "cloudfront-is-tablet-viewer": "false",
      "via": "2.0 xxxxxxxxxxxxxxxx.cloudfront.net (CloudFront)",
      "cloudfront-forwarded-proto": "https",
      "origin": "https://us-west-1.console.aws.amazon.com",
      "content-length": "217",
      "accept-language": "en-US,en;q=0.9",
      "host": "xxxxxxxxxxxxxxxx.appsync-api.us-west-1.amazonaws.com",
      "x-forwarded-proto": "https",
      "user-agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/85.0.4183.83 Safari/537.36",
      "accept": "*!/!*",
      "cloudfront-is-mobile-viewer": "false",
      "cloudfront-is-smarttv-viewer": "false",
      "accept-encoding": "gzip, deflate, br",
      "referer": "https://us-west-1.console.aws.amazon.com/appsync/home?region=us-west-1",
      "content-type": "application/json",
      "sec-fetch-mode": "cors",
      "x-amz-cf-id": "3aykhqlUwQeANU-HGY7E_guV5EkNeMMtwyOgiA==",
      "x-amzn-trace-id": "Root=1-5f512f51-fac632066c5e848ae714",
      "authorization": "eyJraWQiOiJScWFCSlJqYVJlM0hrSnBTUFpIcVRXazNOW...",
      "sec-fetch-dest": "empty",
      "x-amz-user-agent": "AWS-Console-AppSync/",
      "cloudfront-is-desktop-viewer": "true",
      "sec-fetch-site": "cross-site",
      "x-forwarded-port": "443"
    }
  },
  "prev": {
    "result": {}
  },
  "info": {
    "selectionSetList": ["id", "field1", "field2"],
    "selectionSetGraphQL": "{\n  id\n  field1\n  field2\n}",
    "parentTypeName": "Mutation",
    "fieldName": "createSomething",
    "variables": {}
  },
  "stash": {}
}

See

https://docs.aws.amazon.com/appsync/latest/devguide/resolver-context-reference-js.html

Settings

Member Visibility