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).
Amazon variables for OpenAPI import
You can use the following Amazon variables in OpenAPI definitions. API Gateway resolves the variables when the API is imported. To specify a variable,
use ${variable-name}.
|
| Variable name |
Description |
AWS::AccountId |
The Amazon account ID that imports the API—for example, 123456789012. |
AWS::Partition |
The Amazon partition in which the API is imported. For standard Amazon Regions, the partition is aws. |
AWS::Region |
The Amazon Region in which the API is imported—for example, us-west-2. |
Amazon variables example
The following example uses Amazon variables to specify an Amazon Lambda function for an integration.
- OpenAPI 3.0
-
openapi: "3.0.1"
info:
title: "tasks-api"
version: "v1.0"
paths:
/:
get:
summary: List tasks
description: Returns a list of tasks
responses:
200:
description: "OK"
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Task"
500:
description: "Internal Server Error"
content: {}
x-amazon-apigateway-integration:
uri:
arn:${AWS::Partition}:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/arn:${AWS::Partition}:lambda:${AWS::Region}:${AWS::AccountId}:function:LambdaFunctionName/invocations
responses:
default:
statusCode: "200"
passthroughBehavior: "when_no_match"
httpMethod: "POST"
contentHandling: "CONVERT_TO_TEXT"
type: "aws_proxy"
components:
schemas:
Task:
type: object
properties:
id:
type: integer
name:
type: string
description:
type: string