API Gateway v1 (REST)

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

REST-JSON multi-tenant 81 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

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

CreateApiKey CreateAuthorizer CreateBasePathMapping CreateDeployment CreateDocumentationPart CreateDomainName CreateModel CreateResource CreateRestApi CreateStage CreateUsagePlan CreateUsagePlanKey DeleteApiKey DeleteAuthorizer DeleteBasePathMapping DeleteDeployment DeleteDocumentationPart DeleteDomainName DeleteGatewayResponse DeleteIntegration DeleteIntegrationResponse DeleteMethod DeleteMethodResponse DeleteModel DeleteResource DeleteRestApi DeleteStage DeleteUsagePlan DeleteUsagePlanKey GetAccount GetApiKey GetApiKeys GetAuthorizer GetAuthorizers GetBasePathMapping GetBasePathMappings GetDeployment GetDeployments GetDocumentationPart GetDocumentationParts GetDomainName GetDomainNames GetExport GetGatewayResponse GetGatewayResponses GetIntegration GetIntegrationResponse GetMethod GetMethodResponse GetModel GetModels GetResource GetResources GetRestApi GetRestApis GetStage GetStages GetTags GetUsagePlan GetUsagePlanKey GetUsagePlanKeys GetUsagePlans PutGatewayResponse PutIntegration PutIntegrationResponse PutMethod PutMethodResponse TagResource UntagResource UpdateAccount UpdateApiKey UpdateAuthorizer UpdateDeployment UpdateDocumentationPart UpdateIntegration UpdateMethod UpdateModel UpdateResource UpdateRestApi UpdateStage UpdateUsagePlan

CloudFormation

The CloudFormation engine provisions these resource types via this service:

AWS::ApiGateway::Account AWS::ApiGateway::Authorizer AWS::ApiGateway::BasePathMapping AWS::ApiGateway::Deployment AWS::ApiGateway::DocumentationPart AWS::ApiGateway::DocumentationVersion AWS::ApiGateway::DomainName AWS::ApiGateway::GatewayResponse AWS::ApiGateway::Method AWS::ApiGateway::Model AWS::ApiGateway::RequestValidator AWS::ApiGateway::Resource AWS::ApiGateway::RestApi AWS::ApiGateway::Stage AWS::ApiGateway::ApiKey AWS::ApiGateway::UsagePlan AWS::ApiGateway::UsagePlanKey

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

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

See also: all services · configuration · limitations.