Cognito pre-token-generation Lambda add custom claims to ID token

By Sai Kiran Pandrala · Last verified: 2026-05-31 · Source: AWS re:Post, community Q&A, AWS docs

Running into Cognito pre-token-generation Lambda add custom claims to ID token on Amazon Cognito is one of the more searched issues on AWS re:Post and StackOverflow in the last 12 months. Here is what actually moves the needle when the AWS docs are too generic.

What cognito pre-token-generation lambda add custom claims to id token actually involves on Amazon Cognito

This task on Amazon Cognito is one of the more searched operational topics on AWS in the last 12 months. The procedure below is the path that works in a current AWS account with default IAM and standard VPC config.

The rest of this page is the structured fix path. Start with diagnose, then remediation, then the automation options so you do not have to do this by hand the next time it surfaces. Verify and safety sections at the end are the discipline that keeps the fix from regressing in production.

Diagnose first, fix second

Start by capturing the exact AWS error string. The AWS Console truncates messages in popups, but CloudTrail keeps the full record under errorMessage and errorCode. The camelCase error code (e.g. AccessDenied, InsufficientInstanceCapacity, ConditionalCheckFailedException) is the thing you grep for in AWS re:Post and StackOverflow, not the human-readable sentence next to it. Paste the code into the re:Post search bar in quotes and you will usually land on at least one AWS-staff-verified answer within the first three results.

Pull the AWS request ID from the response headers: x-amz-request-id for most services, x-amzn-RequestId for API Gateway, both x-amz-request-id and x-amz-id-2 for S3. AWS Support needs these IDs to look up your call in their internal logs - without them, the first reply on a ticket will ask you to reproduce the call and capture them. Save them with a timestamp; AWS Support cannot retrieve calls older than 90 days for most services.

Check the AWS Health Dashboard at health.aws.amazon.com for ongoing service events in your region. About one in ten user-reported outages turn out to be region-scoped AWS service degradation already being tracked. AWS Health also exposes an API and EventBridge events, so you can wire a Lambda hook that pages on-call only when the failure correlates with an active AWS Health event in the same region and service.

Solution-focused remediation path

For IAM and STS issues, the timing matters. STS sessions can take up to 60 seconds to propagate after creation. The first call right after assume-role can fail with a permission error even when the policy is correct. Add a small retry with backoff before treating the first failure as definitive.

If you cannot reproduce the failure consistently, the cause is probably a race condition or a session-cache issue. Run the call with --profile set to a fresh STS session, in a different region you control, with a single concurrent request. If it works there but fails in your normal setup, the difference is the bug.

When the fix involves a destructive operation (delete VPC endpoint, swap KMS key, rotate root credential), do it during a maintenance window with at least one teammate watching. Several Amazon Cognito operations have implicit dependencies that only show up when traffic starts flowing again. Document the rollback path before you start, not during the incident.

Automate this fix so you do not do it twice

Add a CloudWatch alarm so you know next time

The cheapest way to never see the same incident twice is a CloudWatch alarm on the metric that would have warned you. For Amazon Cognito, the relevant metrics live under AWS/cognito namespace or under custom metrics published by your Lambda or ECS task. Set thresholds based on observed normal range plus one or two standard deviations, not on round-number guesses. CloudWatch anomaly-detection alarms remove the threshold-guessing problem entirely for metrics with regular seasonality.

Wire the fix into EventBridge for self-healing

If the failure mode is recurring, automate the remediation instead of the diagnosis. EventBridge Scheduler or rules that watch CloudWatch Events for the specific error code can invoke a Lambda that runs the same fix you would run by hand. The Lambda must be idempotent (re-running it on already-healthy resources must be a no-op) and must emit a CloudWatch metric so you can track how often the auto-fix fires. A spike in auto-fix invocations is itself a signal worth alerting on.

# EventBridge rule pattern (JSON)
{ "source": ["aws.cognito"], "detail-type": ["AWS API Call via CloudTrail"], "detail": { "errorCode": ["AccessDenied", "ThrottlingException"] }
}

Automate the fix with Python and boto3

For anything you do more than twice, write a small Python script. The boto3 pattern below uses paginators (so it does not blow up on accounts with thousands of resources), explicit region binding, and a dry-run flag that defaults to True. Keep the script under 100 lines; if it grows beyond that, you are building a tool and should put it behind a Lambda with proper logging.

import boto3, sys
DRY_RUN = '--apply' not in sys.argv
client = boto3.client('cognito', region_name='us-east-1')
paginator = client.get_paginator('describe_...')
for page in paginator.paginate(): for item in page.get('Items', []): if item.get('Status') == 'FAILED': if DRY_RUN: print(f'[dry-run] would fix {item["Id"]}') else: client.modify_...(ResourceId=item['Id']) print(f'fixed {item["Id"]}')

Common pitfalls and what to watch for

The most common pitfall when fixing this on Amazon Cognito is treating it as a one-off rather than as a recurring class of incident. The same misconfiguration tends to happen again after a deployment, a role rotation, or a region migration unless the fix is codified. Add a CloudFormation hook, Service Control Policy condition, or AWS Config rule that prevents the same misconfig from being introduced again. Documentation alone does not survive turnover.

Another common trap: confirming the fix on a single resource and assuming the fleet is healthy. Loop your check across every account, region, and IAM principal that could exhibit the same symptom. If you cannot enumerate the affected scope without a script, you do not yet understand the scope.

Verify the fix worked

• Reproduce the original symptom path. If it still surfaces in any account or region or IAM role, you have not fixed it.
• Watch for 24 to 48 hours. AWS metrics and policy systems can mask issues with cached health for 6 to 12 hours, especially CloudFront and Route 53.
• Run a smoke test under realistic load. Happy-path tests miss race conditions and IAM session-cache issues.
• Capture the new state in a runbook so the next person on call does not have to rediscover this. Push it to Confluence or your team wiki, not into Slack.
• If the fix involved a permission change, run IAM Access Analyzer one more time to confirm you did not open a separate hole while closing this one.

Safety, rollback, blast radius

• Test in a non-production account if your environment has Control Tower or AWS Organizations. The cost of one sandbox account is cheaper than one rollback meeting.
• Export the existing config before changing it. Most Amazon Cognito resources support describe + export to JSON via CLI - capture that to source control before you start.
• Know your rollback path. Some Amazon Cognito operations are one-way (region migration, account-level feature opt-in, KMS key deletion past pending window). Confirm reversibility on the AWS doc before you commit.
• Be aware of cross-service impact. IAM role changes ripple to every service trusting that role. KMS key changes break every workload depending on that key. VPC endpoint changes affect every VPC consumer of that endpoint.
• Maintenance window discipline: if the change touches DNS, certificate rotation, or anything that emits TLS handshakes, line up a window with stakeholder notification, not a heroic mid-day swap.

FAQ

Related fixes

Related guides worth a look while you sort this one out:

• Cognito custom auth Lambda triggers DefineAuthChallenge CreateAuthChallenge
• Cognito pre-signup Lambda auto-confirm user skip email verification
• API Gateway JWT authorizer HTTP API for Cognito User Pool token validation
• Cognito hosted UI custom domain with ACM cert in us-east-1
• Cognito refresh token rotation enabled vs disabled
• Cognito SAML attribute mapping Email and custom attributes