API Gateway Amazon リソースネーム (ARN) リファレンス

以下の表では、API Gateway リソースの Amazon リソースネーム (ARN) を示しています。AWS Identity and Access Management ポリシーでの ARN の使用の詳細については、「Amazon API Gateway と IAM の連携方法」および「IAM アクセス許可により API へのアクセスを制御する」を参照してください。

HTTP API および WebSocket API リソース

リソース	ARN
AccessLogSettings	arn:partition:apigateway:region::/apis/api-id/stages/stage-name/accesslogsettings
Api	arn:partition:apigateway:region::/apis/api-id
API	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
オーソライザー	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
Integration	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
オーソライザー	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
Integration	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、および REST 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 オーソライザーの作成」を参照してください。