awsflow-apigateway

Use the APIGatewayTool language tool in VS Code to manage, inspect, and test AWS API Gateway REST APIs — resources, methods, integrations, stages, authorizers, usage plans, and more.

When to Use

• User wants to list or inspect REST APIs
• User wants to view API resources, methods, and integrations
• User wants to inspect stages, deployments, or stage variables
• User wants to view or test authorizers
• User wants to test invoke a method without deploying
• User wants to inspect usage plans, API keys, or quotas
• User wants to view custom domain names, base path mappings, or VPC links
• User wants to view models, request validators, or documentation
• User wants to export an API or get SDK artifacts
• User wants to create or delete APIs, resources, stages, authorizers, or usage plans
• User wants to update API definitions or stage settings

Tool Reference

Tool name: APIGatewayTool

Input Schema

{
  "command": "<CommandName>",
  "params": { ... }
}

Commands (68 total)

Parameters

Usage Examples

List all REST APIs

{ "command": "GetRestApis", "params": { "limit": 25 } }

Get details of a specific API

{ "command": "GetRestApi", "params": { "restApiId": "abc123def" } }

List resources for an API

{ "command": "GetResources", "params": { "restApiId": "abc123def", "limit": 100 } }

Get a specific method

{ "command": "GetMethod", "params": { "restApiId": "abc123def", "resourceId": "xyz789", "httpMethod": "GET" } }

Get integration details

{ "command": "GetIntegration", "params": { "restApiId": "abc123def", "resourceId": "xyz789", "httpMethod": "POST" } }

List stages

{ "command": "GetStages", "params": { "restApiId": "abc123def" } }

Get a specific stage

{ "command": "GetStage", "params": { "restApiId": "abc123def", "stageName": "prod" } }

List deployments

{ "command": "GetDeployments", "params": { "restApiId": "abc123def", "limit": 10 } }

Test invoke a method

{ "command": "TestInvokeMethod", "params": { "restApiId": "abc123def", "resourceId": "xyz789", "httpMethod": "GET", "pathWithQueryString": "/items?category=books" } }

Test invoke a method with body

{ "command": "TestInvokeMethod", "params": { "restApiId": "abc123def", "resourceId": "xyz789", "httpMethod": "POST", "pathWithQueryString": "/items", "body": "{\"name\": \"test\", \"price\": 9.99}", "headers": { "Content-Type": "application/json" } } }

Test invoke an authorizer

{ "command": "TestInvokeAuthorizer", "params": { "restApiId": "abc123def", "authorizerId": "auth001", "headers": { "Authorization": "Bearer eyJ..." } } }

List authorizers

{ "command": "GetAuthorizers", "params": { "restApiId": "abc123def" } }

List usage plans

{ "command": "GetUsagePlans", "params": { "limit": 10 } }

List API keys

{ "command": "GetApiKeys", "params": { "limit": 20 } }

Get custom domain names

{ "command": "GetDomainNames", "params": { "limit": 10 } }

Get VPC links

{ "command": "GetVpcLinks", "params": { "limit": 10 } }

Related Services

API Gateway integrates with many AWS services:

CloudWatch Log Group Naming

API Gateway execution logs use these log group patterns:

API-Gateway-Execution-Logs_<restApiId>/<stageName>

Access logs are configured per-stage and can go to a custom log group.

Use CloudWatchLogTool → DescribeLogGroups with logGroupNamePrefix: "API-Gateway-Execution-Logs_" to find them.

Tips

• Start with GetRestApis to discover APIs, then GetResources to see the resource tree.
• Use GetMethod → GetIntegration to see how a method is wired to a backend.
• TestInvokeMethod lets you test an API method without needing a deployment or stage — great for debugging.
• TestInvokeAuthorizer validates authorizer behavior without making a real API call.
• GetStages shows deployment history and stage variables for each stage.
• Use GetUsagePlans + GetUsagePlanKeys to audit API key throttling and quotas.