x-amazon-apigateway-auth object - Amazon API Gateway
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).

x-amazon-apigateway-auth object

Defines an authorization type to be applied for authorization of method invocations in API Gateway.

Properties
Property name Type Description
type string Specifies the authorization type. Specify "NONE" for open access. Specify "AWS_IAM" to use IAM permissions. Values are case insensitive.

x-amazon-apigateway-auth example

The following example sets the authorization type for an API method.

OpenAPI 3.0.1
{ "openapi": "3.0.1", "info": { "title": "openapi3", "version": "1.0" }, "paths": { "/protected-by-iam": { "get": { "x-amazon-apigateway-auth": { "type": "AWS_IAM" } } } } }