API Gateway private API resource policy with VPC endpoint condition

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

Engineers running Amazon API Gateway hit API Gateway private API resource policy with VPC endpoint condition often enough that there is a stable fix pattern. This page captures it in the order AWS support would run it during a real incident.

What api gateway private api resource policy with vpc endpoint condition actually involves on Amazon API Gateway

This task on Amazon API Gateway 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.

Identify

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.

Run aws sts get-caller-identity first. About one in five 'why does this not work' tickets are actually 'I am in the wrong account' or 'my session expired and the SDK is using stale creds'. The 5-second sanity check costs nothing and saves real time when the answer is that simple.

Solution-focused remediation path

When the failure happens in production but not in dev, do not just compare the IAM policy. Compare the SCP / RCP at the OU level, the permission boundary on the role, and the resource-based policy on the target. One of those is almost always different between accounts. AWS Config conformance packs make this comparison routine.

Most Amazon API Gateway failures fall into one of three buckets: IAM permission gap, networking path break (security group, NACL, or VPC endpoint policy), or service-limit / quota hit. Run that mental triage first - it covers around 80 percent of real-world cases. If the failure does not fit any of the three, it is likely a service-side regression worth opening a re:Post or support ticket for.

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 API Gateway 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 Systems Manager Automation runbook

For multi-step fixes that include a manual approval, use SSM Automation. Document the fix as a runbook with aws:approve steps where a human signs off and aws:executeAwsApi steps where the runbook calls the AWS API. Approvers are notified by SNS; the runbook execution shows up in CloudTrail with the approver's identity attached. This makes audit trails easy and stops production fixes from being one-person operations.

Automate the fix with the AWS CLI

The CLI one-liner pattern for Amazon API Gateway operations is roughly: aws api describe-... --query ... to read state, aws api modify-... --no-dry-run to apply the change, and aws api describe-... --query ... again to verify. Wrap it in a shell script that sets a region variable at the top and exits on first error with set -euo pipefail so a partial run does not leave the account in a half-fixed state.

# Template - replace placeholders with your account specifics
export AWS_REGION=us-east-1
export AWS_PROFILE=prod
aws api describe-... --query 'Resources[?Status==`FAILED`].[Id,Reason]' --output table
aws api modify-... --resource-id RESOURCE_ID --no-dry-run
aws api describe-... --resource-id RESOURCE_ID --query 'Status'

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 API Gateway, the relevant metrics live under AWS/api 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.

Pitfalls to dodge

The pitfall most teams hit on Amazon API Gateway is moving too fast and skipping the read-only validation step. Before any write, list the current state and save it. AWS APIs are eventually consistent for many resource types, so the validation snapshot is your only reliable reference if you need to undo. Save the output of the describe call to S3, not to your laptop.

Second pitfall: confusing IAM permission errors with networking errors. AccessDenied can be IAM (policy missing), networking (VPC endpoint policy blocking the call), or KMS (key policy missing). The error string looks identical for all three. Distinguish by looking at the CloudTrail event's errorCode and the encoded authorization message; do not assume IAM is the culprit just because the message says AccessDenied.

Resolve

• 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 API Gateway resources support describe + export to JSON via CLI - capture that to source control before you start.
• Know your rollback path. Some Amazon API Gateway 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:

• Fix 403 Forbidden from Lambda authorizer IAM policy doc allow vs deny
• Egress-only Internet Gateway for IPv6 private subnets at zero cost
• Replace NAT Gateway with VPC Gateway Endpoint for S3 and DynamoDB
• API Gateway AccessDeniedException not authorized to perform execute-api Invoke
• API Gateway binary media types upload PDF returns base64 garbage
• API Gateway canary deployments on REST stage with 10 percent traffic split