API Gateway v1 (REST)

API Gateway v1 (REST APIs) — resources, methods, integrations, deployments, stages, authorizers, usage plans, domain names.

REST (XML/JSON) multi-tenant 71 operations

Quick start

# Use the SDK's apigateway client for control-plane ops; invoke via
# http://localhost:4566/restapis/{apiId}/{stage}/_user_request_/{path}
import boto3
api = boto3.client("apigateway", endpoint_url="http://localhost:4566",
                   region_name="us-east-1",
                   aws_access_key_id="test", aws_secret_access_key="test")
r = api.create_rest_api(name="demo")

Supported operations

71 operations exposed by this service as of MiniStack 1.3.14. Extracted directly from the handler dispatch in the source module.

... and 1 more create_api_key create_authorizer create_base_path_mapping create_deployment create_domain_name create_model create_resource create_rest_api create_stage create_usage_plan create_usage_plan_key DELETE delete_api_key delete_authorizer delete_base_path_mapping delete_deployment delete_domain_name delete_integration delete_integration_response delete_method delete_method_response delete_model delete_resource delete_rest_api delete_stage delete_usage_plan delete_usage_plan_key GET get_account get_api_key get_api_keys get_authorizer get_authorizers get_base_path_mapping get_base_path_mappings get_deployment get_deployments get_domain_name get_domain_names get_integration get_integration_response get_method get_method_response get_model get_models get_resource get_resources get_rest_api get_rest_apis get_stage get_stages get_usage_plan get_usage_plan_keys get_usage_plans PATCH POST PUT put_integration put_integration_response put_method put_method_response update_account update_api_key update_authorizer update_deployment update_integration update_method update_resource update_rest_api update_stage

CloudFormation

The CloudFormation engine provisions these resource types via this service:

AWS::ApiGateway::RestApi AWS::ApiGateway::Resource AWS::ApiGateway::Method AWS::ApiGateway::Deployment AWS::ApiGateway::Stage

See CloudFormation engine for intrinsic support and lifecycle details.

Known limitations

AccessLogSettings are accepted but no access logs are written.
BadRequest validation is not comprehensive for malformed templates / mappings.

Source

ministack/services/apigateway_v1.py:517-566

Read the source to verify the ops list above — dispatch tables and handler functions are the ground truth.

See also: all services · configuration · limitations.