The following tables list the Amazon Resource Names (ARNs) for API Gateway resources. To learn more about using ARNs in AWS Identity and Access Management policies, see How Amazon API Gateway works with IAM and Control access to a REST API with IAM permissions.
HTTP API and WebSocket API resources
Resource | ARN |
---|---|
AccessLogSettings |
|
Api |
|
Apis |
|
ApiMapping |
|
ApiMappings |
|
Authorizer |
|
Authorizers |
|
Cors |
|
Deployment |
|
Deployments |
|
DomainName |
|
DomainNames |
|
ExportedAPI |
|
Integration |
|
Integrations |
|
IntegrationResponse |
|
IntegrationResponses |
|
Model |
|
Models |
|
ModelTemplate |
|
Route |
|
Routes |
|
RouteRequestParameter |
|
RouteResponse |
|
RouteResponses |
|
RouteSettings |
|
Stage |
|
Stages |
|
VpcLink |
|
VpcLinks |
|
REST API resources
Resource | ARN |
---|---|
Account |
|
ApiKey |
|
ApiKeys |
|
Authorizer |
|
Authorizers |
|
BasePathMapping |
|
BasePathMappings |
|
ClientCertificate |
|
ClientCertificates |
|
Deployment |
|
Deployments |
|
DocumentationPart |
|
DocumentationParts |
|
DocumentationVersion |
|
DocumentationVersions |
|
DomainName |
|
DomainNameAccessAssociation |
|
DomainNameAccessAssociations |
|
DomainNames |
|
GatewayResponse |
|
GatewayResponses |
|
Integration |
|
IntegrationResponse |
|
Method |
|
MethodResponse |
|
Model |
|
Models |
|
PrivateDomainName |
|
RequestValidator |
|
RequestValidators |
|
Resource |
|
Resources |
|
RestApi |
|
RestApis |
|
Stage |
|
Stages |
|
Tags |
|
Template |
|
UsagePlan |
|
UsagePlans |
|
UsagePlanKey |
|
UsagePlanKeys |
|
VpcLink |
|
VpcLinks |
|
execute-api
(HTTP APIs, WebSocket APIs, and REST APIs)
Resource | ARN |
---|---|
WebSocket API endpoint |
|
HTTP API and REST API endpoint * |
|
Lambda authorizer ** |
|
* The ARN for the $default
route endpoint for HTTP APIs is arn:
.partition
:execute-api:region
:account-id
:api-id
/*
/$default
** This ARN is applicable only when setting the SourceArn
condition in the
resource policy
for a Lambda authorizer function. For an example, see Create a Lambda
authorizer.