Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

x-amazon-apigateway-auth object

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

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"
        }
      }
    }
  }
}