Referência de nome de recurso da Amazon (ARN) do API Gateway

As tabelas a seguir listam os nomes de recursos da Amazon (ARNs) para recursos do API Gateway. Para saber mais sobre como usar ARNs em políticas do AWS Identity and Access Management, consulte Como o Amazon API Gateway funciona com o IAM e Controlar o acesso a uma API REST com permissões do IAM.

Recursos de API HTTP e API WebSocket

Recurso	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
Autorizador	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
Implantação	arn:partition:apigateway:region::/apis/api-id/deployments/id
Implantações	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
Integração	arn:partition:apigateway:region::/apis/api-id/integrations/integration-id
Integrações	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
Modelo	arn:partition:apigateway:region::/apis/api-id/models/id
Modelos	arn:partition:apigateway:region::/apis/api-id/models
ModelTemplate	arn:partition:apigateway:region::/apis/api-id/models/id/template
Rota	arn:partition:apigateway:region::/apis/api-id/routes/id
Rotas	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
Estágio	arn:partition:apigateway:region::/apis/api-id/stages/stage-name
Estágios	arn:partition:apigateway:region::/apis/api-id/stages
VpcLink	arn:partition:apigateway:region::/vpclinks/vpclink-id
VpcLinks	arn:partition:apigateway:region::/vpclinks

Recursos de API REST

Recurso	ARN
Conta	arn:partition:apigateway:region::/account
ApiKey	arn:partition:apigateway:region::/apikeys/id
ApiKeys	arn:partition:apigateway:region::/apikeys
Autorizador	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
Implantação	arn:partition:apigateway:region::/restapis/api-id/deployments/id
Implantações	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
Integração	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
Método	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
Modelo	arn:partition:apigateway:region::/restapis/api-id/models/model-name
Modelos	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
Recurso	arn:partition:apigateway:region::/restapis/api-id/resources/id
Recursos	arn:partition:apigateway:region::/restapis/api-id/resources
RestApi	arn:partition:apigateway:region::/restapis/api-id
RestApis	arn:partition:apigateway:region::/restapis
Estágio	arn:partition:apigateway:region::/restapis/api-id/stages/stage-name
Estágios	arn:partition:apigateway:region::/restapis/api-id/stages
Tags	arn:partition:apigateway:region::/tags/url-encoded-resource-arn
Modelo	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 (APIs HTTP, WebSocket e REST)

Recurso	ARN
Endpoint de API WebSocket	arn:partition:execute-api:region:account-id:api-id/stage/route-key
Endpoint de API REST e API HTTP*	arn:partition:execute-api:region:account-id:api-id/stage/http-method/resource-path
Autorizador do Lambda**	arn:partition:execute-api:region:account-id:api-id/authorizers/authorizer-id

* O ARN do endpoint da rota $default para APIs HTTP é arn:partition:execute-api:region:account-id:api-id/*/$default.

* Esse ARN é aplicável somente ao definir a condição SourceArn na política de recursos de uma função de autorizador do Lambda. Para ver um exemplo, consulte Criar um autorizador do Lambda.