API Gateway Amazon Resource Name (ARN) 參考資料

下表列出 API Gateway 資源的 Amazon Resource Name (ARN)。若要進一步了解如何在 AWS Identity and Access Management 策略中使用 ARN，請參閱Amazon API 網關如何與 IAM和控制對RESTAPI具有IAM權限的訪問。

API 和 WebSocket API 資源

資源	ARN
AccessLogSettings	arn:partition:apigateway:region::/apis/api-id/stages/stage-name/accesslogsettings
Api	arn:partition:apigateway:region::/apis/api-id
Apis	arn:partition:apigateway:region::/apis
ApiMapping	arn:partition:apigateway:region::/domainnames/domain-name/apimappings/id
ApiMappings	arn:partition:apigateway:region::/domainnames/domain-name/apimappings
授權方	arn:partition:apigateway:region::/apis/api-id/authorizers/id
Authorizers	arn:partition:apigateway:region::/apis/api-id/authorizers
Cors	arn:partition:apigateway:region::/apis/api-id/cors
部署	arn:partition:apigateway:region::/apis/api-id/deployments/id
部署	arn:partition:apigateway:region::/apis/api-id/deployments
DomainName	arn:partition:apigateway:region::/domainnames/domain-name
DomainNames	arn:partition:apigateway:region::/domainnames
ExportedAPI	arn:partition:apigateway:region::/apis/api-id/exports/specification
整合	arn:partition:apigateway:region::/apis/api-id/integrations/integration-id
整合	arn:partition:apigateway:region::/apis/api-id/integrations
IntegrationResponse	arn:partition:apigateway:region::/apis/api-id/integrationresponses/integration-response
IntegrationResponses	arn:partition:apigateway:region::/apis/api-id/integrationresponses
模型	arn:partition:apigateway:region::/apis/api-id/models/id
模型	arn:partition:apigateway:region::/apis/api-id/models
ModelTemplate	arn:partition:apigateway:region::/apis/api-id/models/id/template
路由	arn:partition:apigateway:region::/apis/api-id/routes/id
路由	arn:partition:apigateway:region::/apis/api-id/routes
RouteRequestParameter	arn:partition:apigateway:region::/apis/api-id/routes/id/requestparameters/key
RouteResponse	arn:partition:apigateway:region::/apis/api-id/routes/id/routeresponses/id
RouteResponses	arn:partition:apigateway:region::/apis/api-id/routes/id/routeresponses
RouteSettings	arn:partition:apigateway:region::/apis/api-id/stages/stage-name/routesettings/route-key
階段	arn:partition:apigateway:region::/apis/api-id/stages/stage-name
階段	arn:partition:apigateway:region::/apis/api-id/stages
VpcLink	arn:partition:apigateway:region::/vpclinks/vpclink-id
VpcLinks	arn:partition:apigateway:region::/vpclinks

REST API 資源

資源	ARN
帳戶	arn:partition:apigateway:region::/account
ApiKey	arn:partition:apigateway:region::/apikeys/id
ApiKeys	arn:partition:apigateway:region::/apikeys
授權方	arn:partition:apigateway:region::/restapis/api-id/authorizers/id
Authorizers	arn:partition:apigateway:region::/restapis/api-id/authorizers
BasePathMapping	arn:partition:apigateway:region::/domainnames/domain-name/basepathmappings/basepath
BasePathMappings	arn:partition:apigateway:region::/domainnames/domain-name/basepathmappings
ClientCertificate	arn:partition:apigateway:region::/clientcertificates/id
ClientCertificates	arn:partition:apigateway:region::/clientcertificates
部署	arn:partition:apigateway:region::/restapis/api-id/deployments/id
部署	arn:partition:apigateway:region::/restapis/api-id/deployments
DocumentationPart	arn:partition:apigateway:region::/restapis/api-id/documentation/parts/id
DocumentationParts	arn:partition:apigateway:region::/restapis/api-id/documentation/parts
DocumentationVersion	arn:partition:apigateway:region::/restapis/api-id/documentation/versions/version
DocumentationVersions	arn:partition:apigateway:region::/restapis/api-id/documentation/versions
DomainName	arn:partition:apigateway:region::/domainnames/domain-name
DomainNames	arn:partition:apigateway:region::/domainnames
GatewayResponse	arn:partition:apigateway:region::/restapis/api-id/gatewayresponses/response-type
GatewayResponses	arn:partition:apigateway:region::/restapis/api-id/gatewayresponses
整合	arn:partition:apigateway:region::/restapis/api-id/resources/resource-id/methods/http-method/integration
IntegrationResponse	arn:partition:apigateway:region::/restapis/api-id/resources/resource-id/methods/http-method/integration/responses/status-code
方法	arn:partition:apigateway:region::/restapis/api-id/resources/resource-id/methods/http-method
MethodResponse	arn:partition:apigateway:region::/restapis/api-id/resources/resource-id/methods/http-method/responses/status-code
模型	arn:partition:apigateway:region::/restapis/api-id/models/model-name
模型	arn:partition:apigateway:region::/restapis/api-id/models
RequestValidator	arn:partition:apigateway:region::/restapis/api-id/requestvalidators/id
RequestValidators	arn:partition:apigateway:region::/restapis/api-id/requestvalidators
資源	arn:partition:apigateway:region::/restapis/api-id/resources/id
資源	arn:partition:apigateway:region::/restapis/api-id/resources
RestApi	arn:partition:apigateway:region::/restapis/api-id
RestApis	arn:partition:apigateway:region::/restapis
階段	arn:partition:apigateway:region::/restapis/api-id/stages/stage-name
階段	arn:partition:apigateway:region::/restapis/api-id/stages
標籤	arn:partition:apigateway:region::/tags/url-encoded-resource-arn
範本	arn:partition:apigateway:region::/restapis/models/model-name/template
UsagePlan	arn:partition:apigateway:region::/usageplans/usageplan-id
UsagePlans	arn:partition:apigateway:region::/usageplans
UsagePlanKey	arn:partition:apigateway:region::/usageplans/usageplan-id/keys/id
UsagePlanKeys	arn:partition:apigateway:region::/usageplans/usageplan-id/keys
VpcLink	arn:partition:apigateway:region::/vpclinks/vpclink-id
VpcLinks	arn:partition:apigateway:region::/vpclinks

execute-api（HTTP API， WebSocket API 和其餘 API）

資源	ARN
WebSocket API 端點	arn:partition:execute-api:region:account-id:api-id/stage/route-key
HTTP API 和 REST API 端點 *	arn:partition:execute-api:region:account-id:api-id/stage/http-method/resource-path
Lambda 授權方 **	arn:partition:execute-api:region:account-id:api-id/authorizers/authorizer-id

* HTTP API 的 $default 路由端點的 ARN 為 arn:partition:execute-api:region:account-id:api-id/*/$default。

** 此 ARN 僅適用於在資源政策中設定 Lambda 授權方功能的 SourceArn 條件。如需範例，請參閱建立 Lambda 授權方。