API Gateway extensions for Amazon SAM - Amazon Serverless Application Model
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

API Gateway extensions for Amazon SAM

Specifically designed for Amazon, API Gateway extensions provide additional customizations and functionality for designing and managing APIs. API Gateway extensions are extensions to the OpenAPI specification that support the Amazon-specific authorization and API Gateway-specific API integrations. For more information about API Gateway extensions, refer to API Gateway Extensions to OpenAPI.

Amazon SAM supports a subset of API Gateway extensions. To see which API Gateway extensions are supported by Amazon SAM, refer to the following table.

API Gateway Extension Supported by Amazon SAM
x-amazon-apigateway-any-method Object Yes
x-amazon-apigateway-api-key-source Property No
x-amazon-apigateway-auth Object Yes
x-amazon-apigateway-authorizer Object Yes
x-amazon-apigateway-authtype Property Yes
x-amazon-apigateway-binary-media-types Property Yes
x-amazon-apigateway-documentation Object No
x-amazon-apigateway-endpoint-configuration Object No
x-amazon-apigateway-gateway-responses Object Yes
x-amazon-apigateway-gateway-responses.gatewayResponse Object Yes
x-amazon-apigateway-gateway-responses.responseParameters Object Yes
x-amazon-apigateway-gateway-responses.responseTemplates Object Yes
x-amazon-apigateway-integration Object Yes
x-amazon-apigateway-integration.requestTemplates Object Yes
x-amazon-apigateway-integration.requestParameters Object No
x-amazon-apigateway-integration.responses Object Yes
x-amazon-apigateway-integration.response Object Yes
x-amazon-apigateway-integration.responseTemplates Object Yes
x-amazon-apigateway-integration.responseParameters Object Yes
x-amazon-apigateway-request-validator Property No
x-amazon-apigateway-request-validators Object No
x-amazon-apigateway-request-validators.requestValidator Object No