Actions, resources, and condition keys for Amazon API Gateway Management
Amazon API Gateway Management (service prefix: apigateway) provides the following
service-specific operations, resources, actions, and condition keys for use in IAM permission
policies.
References:
-
Learn how to configure this service.
-
View a list of the API operations available for this service.
-
Learn how to secure this service and its resources by using IAM permission policies.
-
View the programmatic service authorization reference
for this service.
Topics
API operations defined by Amazon API Gateway Management
The following table maps API operations to the IAM actions they authorize. Only condition keys that have static values for the given API and action are listed; for the full set of condition keys supported by each action, see the Actions table.
| Operation | IAM action | Condition key | Possible value(s) | Access level |
|---|---|---|---|---|
|
CreateApiKey |
Write |
|||
Write |
||||
|
CreateAuthorizer |
Write |
|||
iam:PassedToService |
apigateway.amazonaws.com |
Write |
||
|
CreateBasePathMapping |
Write |
|||
|
CreateDeployment |
Write |
|||
|
CreateDocumentationPart |
Write |
|||
|
CreateDocumentationVersion |
Write |
|||
|
CreateDomainName |
Permissions management, Write |
|||
Write |
||||
Write |
||||
Permissions management, Write |
||||
|
CreateDomainNameAccessAssociation |
Permissions management, Write |
|||
Write |
||||
Write |
||||
|
CreateModel |
Write |
|||
|
CreateRequestValidator |
Write |
|||
|
CreateResource |
Write |
|||
|
CreateRestApi |
Write |
|||
Write |
||||
Permissions management, Write |
||||
|
CreateStage |
Write |
|||
Write |
||||
|
CreateUsagePlan |
Write |
|||
Write |
||||
|
CreateUsagePlanKey |
Write |
|||
|
CreateVpcLink |
Write |
|||
Write |
||||
|
DeleteApiKey |
Write |
|||
|
DeleteAuthorizer |
Write |
|||
|
DeleteBasePathMapping |
Write |
|||
|
DeleteClientCertificate |
Write |
|||
|
DeleteDeployment |
Write |
|||
|
DeleteDocumentationPart |
Write |
|||
|
DeleteDocumentationVersion |
Write |
|||
|
DeleteDomainName |
Write |
|||
Permissions management, Write |
||||
|
DeleteDomainNameAccessAssociation |
Write |
|||
|
DeleteGatewayResponse |
Write |
|||
|
DeleteIntegration |
Write |
|||
|
DeleteIntegrationResponse |
Write |
|||
|
DeleteMethod |
Write |
|||
|
DeleteMethodResponse |
Write |
|||
|
DeleteModel |
Write |
|||
|
DeleteRequestValidator |
Write |
|||
|
DeleteResource |
Write |
|||
|
DeleteRestApi |
Write |
|||
|
DeleteStage |
Write |
|||
|
DeleteUsagePlan |
Write |
|||
|
DeleteUsagePlanKey |
Write |
|||
|
DeleteVpcLink |
Write |
|||
|
FlushStageAuthorizersCache |
Write |
|||
|
FlushStageCache |
Write |
|||
|
GenerateClientCertificate |
Write |
|||
Write |
||||
|
GetAccount |
Read |
|||
|
GetApiKey |
Read |
|||
|
GetApiKeys |
Read |
|||
|
GetAuthorizer |
Read |
|||
|
GetAuthorizers |
Read |
|||
|
GetBasePathMapping |
Read |
|||
|
GetBasePathMappings |
Read |
|||
|
GetClientCertificate |
Read |
|||
|
GetClientCertificates |
Read |
|||
|
GetDeployment |
Read |
|||
|
GetDeployments |
Read |
|||
|
GetDocumentationPart |
Read |
|||
|
GetDocumentationParts |
Read |
|||
|
GetDocumentationVersion |
Read |
|||
|
GetDocumentationVersions |
Read |
|||
|
GetDomainName |
Read |
|||
|
GetDomainNameAccessAssociations |
Read |
|||
|
GetDomainNames |
Read |
|||
|
GetExport |
Read |
|||
|
GetGatewayResponse |
Read |
|||
|
GetGatewayResponses |
Read |
|||
|
GetIntegration |
Read |
|||
|
GetIntegrationResponse |
Read |
|||
|
GetMethod |
Read |
|||
|
GetMethodResponse |
Read |
|||
|
GetModel |
Read |
|||
|
GetModelTemplate |
Read |
|||
|
GetModels |
Read |
|||
|
GetRequestValidator |
Read |
|||
|
GetRequestValidators |
Read |
|||
|
GetResource |
Read |
|||
|
GetResources |
Read |
|||
|
GetRestApi |
Read |
|||
|
GetRestApis |
Read |
|||
|
GetSdk |
Read |
|||
|
GetSdkType |
Read |
|||
|
GetSdkTypes |
Read |
|||
|
GetStage |
Read |
|||
|
GetStages |
Read |
|||
|
GetTags |
Read |
|||
|
GetUsage |
Read |
|||
|
GetUsagePlan |
Read |
|||
|
GetUsagePlanKey |
Read |
|||
|
GetUsagePlanKeys |
Read |
|||
|
GetUsagePlans |
Read |
|||
|
GetVpcLink |
Read |
|||
|
GetVpcLinks |
Read |
|||
|
ImportApiKeys |
Write |
|||
|
ImportDocumentationParts |
Write |
|||
|
ImportRestApi |
Write |
|||
Permissions management, Write |
||||
iam:PassedToService |
apigateway.amazonaws.com |
Write |
||
|
PutGatewayResponse |
Write |
|||
|
PutIntegration |
Write |
|||
iam:PassedToService |
apigateway.amazonaws.com |
Write |
||
|
PutIntegrationResponse |
Write |
|||
|
PutMethod |
Write |
|||
|
PutMethodResponse |
Write |
|||
|
PutRestApi |
Write |
|||
Permissions management, Write |
||||
iam:PassedToService |
apigateway.amazonaws.com |
Write |
||
|
RejectDomainNameAccessAssociation |
Permissions management, Write |
|||
|
TagResource |
Write |
|||
Write |
||||
Write |
||||
|
TestInvokeAuthorizer |
Write |
|||
|
TestInvokeMethod |
Write |
|||
|
UntagResource |
Write |
|||
Write |
||||
|
UpdateAccount |
Write |
|||
iam:PassedToService |
apigateway.amazonaws.com |
Write |
||
|
UpdateApiKey |
Write |
|||
|
UpdateAuthorizer |
Write |
|||
iam:PassedToService |
apigateway.amazonaws.com |
Write |
||
|
UpdateBasePathMapping |
Write |
|||
|
UpdateClientCertificate |
Write |
|||
|
UpdateDeployment |
Write |
|||
|
UpdateDocumentationPart |
Write |
|||
|
UpdateDocumentationVersion |
Write |
|||
|
UpdateDomainName |
Permissions management, Write |
|||
Write |
||||
Permissions management, Write |
||||
Permissions management, Write |
||||
Permissions management, Write |
||||
|
UpdateGatewayResponse |
Write |
|||
|
UpdateIntegration |
Write |
|||
iam:PassedToService |
apigateway.amazonaws.com |
Write |
||
|
UpdateIntegrationResponse |
Write |
|||
|
UpdateMethod |
Write |
|||
|
UpdateMethodResponse |
Write |
|||
|
UpdateModel |
Write |
|||
|
UpdateRequestValidator |
Write |
|||
|
UpdateResource |
Write |
|||
|
UpdateRestApi |
Write |
|||
Permissions management, Write |
||||
|
UpdateStage |
Write |
|||
|
UpdateUsage |
Write |
|||
|
UpdateUsagePlan |
Write |
|||
|
UpdateVpcLink |
Write |
Actions defined by Amazon API Gateway Management
You can specify the following actions in the Action element of an IAM
policy statement. Use policies to grant permissions to perform an operation in Amazon. When
you use an action in a policy, you usually allow or deny access to the API operation or CLI
command with the same name. However, in some cases, a single action controls access to more
than one operation. Alternatively, some operations require several different actions.
Resource types defined by Amazon API Gateway Management
The following resource types are defined by this service and can be used in the
Resource element of IAM permission policy statements.
| Resource types | ARN | Condition keys |
|---|---|---|
arn:${Partition}:apigateway:${Region}::/account |
||
arn:${Partition}:apigateway:${Region}::/apikeys/${ApiKeyId} |
||
arn:${Partition}:apigateway:${Region}::/apikeys |
||
arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/authorizers/${AuthorizerId}, arn:${Partition}:apigateway:${Region}::/restapis/${RestApiId}/authorizers/${AuthorizerId} |
apigateway:Request/AuthorizerType |
|
arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/authorizers, arn:${Partition}:apigateway:${Region}::/restapis/${RestApiId}/authorizers |
||
arn:${Partition}:apigateway:${Region}::/domainnames/${DomainName}/basepathmappings/${BasePath} |
||
arn:${Partition}:apigateway:${Region}::/domainnames/${DomainName}/basepathmappings |
||
arn:${Partition}:apigateway:${Region}::/clientcertificates/${ClientCertificateId} |
||
arn:${Partition}:apigateway:${Region}::/clientcertificates |
||
arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/deployments/${DeploymentId}, arn:${Partition}:apigateway:${Region}::/restapis/${RestApiId}/deployments/${DeploymentId} |
||
arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/deployments, arn:${Partition}:apigateway:${Region}::/restapis/${RestApiId}/deployments |
||
arn:${Partition}:apigateway:${Region}::/restapis/${RestApiId}/documentation/parts/${DocumentationPartId} |
||
arn:${Partition}:apigateway:${Region}::/restapis/${RestApiId}/documentation/parts |
||
arn:${Partition}:apigateway:${Region}::/restapis/${RestApiId}/documentation/versions/${DocumentationVersionId} |
||
arn:${Partition}:apigateway:${Region}::/restapis/${RestApiId}/documentation/versions |
||
arn:${Partition}:apigateway:${Region}::/domainnames/${DomainName} |
apigateway:Request/EndpointType apigateway:Request/MtlsTrustStoreUri apigateway:Request/MtlsTrustStoreVersion apigateway:Request/SecurityPolicy apigateway:Resource/EndpointType apigateway:Resource/MtlsTrustStoreUri apigateway:Resource/MtlsTrustStoreVersion apigateway:Resource/RoutingMode |
|
arn:${Partition}:apigateway:${Region}:${Account}:/domainnameaccessassociations/domainname/${DomainName}/${SourceType}/${SourceId} |
||
arn:${Partition}:apigateway:${Region}:${Account}:/domainnameaccessassociations |
apigateway:Request/AccessAssociationSource |
|
arn:${Partition}:apigateway:${Region}::/domainnames |
apigateway:Request/EndpointType apigateway:Request/MtlsTrustStoreUri apigateway:Request/MtlsTrustStoreVersion apigateway:Request/SecurityPolicy |
|
arn:${Partition}:apigateway:${Region}::/restapis/${RestApiId}/gatewayresponses/${ResponseType} |
||
arn:${Partition}:apigateway:${Region}::/restapis/${RestApiId}/gatewayresponses |
||
arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/integrations/${IntegrationId}, arn:${Partition}:apigateway:${Region}::/restapis/${RestApiId}/resources/${ResourceId}/methods/${HttpMethodType}/integration |
||
arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/integrations/${IntegrationId}/integrationresponses/${IntegrationResponseId}, arn:${Partition}:apigateway:${Region}::/restapis/${RestApiId}/resources/${ResourceId}/methods/${HttpMethodType}/integration/responses/${StatusCode} |
||
arn:${Partition}:apigateway:${Region}::/restapis/${RestApiId}/resources/${ResourceId}/methods/${HttpMethodType} |
apigateway:Request/ApiKeyRequired apigateway:Request/RouteAuthorizationType apigateway:Resource/ApiKeyRequired |
|
arn:${Partition}:apigateway:${Region}::/restapis/${RestApiId}/resources/${ResourceId}/methods/${HttpMethodType}/responses/${StatusCode} |
||
arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/models/${ModelId}, arn:${Partition}:apigateway:${Region}::/restapis/${RestApiId}/models/${ModelName} |
||
arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/models, arn:${Partition}:apigateway:${Region}::/restapis/${RestApiId}/models |
||
arn:${Partition}:apigateway:${Region}::/domainnames/${DomainName}+${DomainIdentifier}/basepathmappings/${BasePath} |
||
arn:${Partition}:apigateway:${Region}::/domainnames/${DomainName}+${DomainIdentifier}/basepathmappings |
||
arn:${Partition}:apigateway:${Region}:${Account}:/domainnames/${DomainName}+${DomainIdentifier} |
apigateway:Request/EndpointType apigateway:Resource/EndpointType |
|
arn:${Partition}:apigateway:${Region}::/restapis/${RestApiId}/requestvalidators/${RequestValidatorId} |
||
arn:${Partition}:apigateway:${Region}::/restapis/${RestApiId}/requestvalidators |
||
arn:${Partition}:apigateway:${Region}::/restapis/${RestApiId}/resources/${ResourceId} |
||
arn:${Partition}:apigateway:${Region}::/restapis/${RestApiId}/resources |
||
arn:${Partition}:apigateway:${Region}::/restapis/${RestApiId} |
apigateway:Request/ApiKeyRequired apigateway:Request/AuthorizerType apigateway:Request/DisableExecuteApiEndpoint apigateway:Request/EndpointType apigateway:Request/RouteAuthorizationType apigateway:Request/SecurityPolicy apigateway:Resource/ApiKeyRequired apigateway:Resource/AuthorizerType apigateway:Resource/DisableExecuteApiEndpoint apigateway:Resource/EndpointType apigateway:Resource/RouteAuthorizationType |
|
arn:${Partition}:apigateway:${Region}::/restapis |
apigateway:Request/ApiKeyRequired apigateway:Request/AuthorizerType apigateway:Request/DisableExecuteApiEndpoint apigateway:Request/EndpointType apigateway:Request/RouteAuthorizationType |
|
arn:${Partition}:apigateway:${Region}::/restapis/${RestApiId}/stages/${StageName}/sdks/${SdkType} |
||
arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/stages/${StageName}, arn:${Partition}:apigateway:${Region}::/restapis/${RestApiId}/stages/${StageName} |
apigateway:Request/AccessLoggingDestination apigateway:Request/AccessLoggingFormat apigateway:Resource/AccessLoggingDestination |
|
arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/stages, arn:${Partition}:apigateway:${Region}::/restapis/${RestApiId}/stages |
apigateway:Request/AccessLoggingDestination |
|
arn:${Partition}:apigateway:${Region}::/tags/${UrlEncodedResourceARN} |
||
arn:${Partition}:apigateway:${Region}::/restapis/models/${ModelName}/template |
||
arn:${Partition}:apigateway:${Region}::/usageplans/${UsagePlanId} |
||
arn:${Partition}:apigateway:${Region}::/usageplans/${UsagePlanId}/keys/${Id} |
||
arn:${Partition}:apigateway:${Region}::/usageplans/${UsagePlanId}/keys |
||
arn:${Partition}:apigateway:${Region}::/usageplans |
||
arn:${Partition}:apigateway:${Region}::/vpclinks/${VpcLinkId} |
||
arn:${Partition}:apigateway:${Region}::/vpclinks |
Condition keys for Amazon API Gateway Management
Amazon API Gateway Management defines the following condition keys that can be used in the
Condition element of an IAM policy.
| Condition keys | Description | Type |
|---|---|---|
Filters access by access association source. Available during the CreateDomainNameAccessAssociation operation |
String |
|
Filters access by access log destination. Available during the CreateStage and UpdateStage operations |
String |
|
Filters access by access log format. Available during the CreateStage and UpdateStage operations |
String |
|
Filters access by whether an API key is required or not. Available during the CreateMethod and PutMethod operations. Also available as a collection during import and reimport |
ArrayOfBool |
|
Filters access by API name. Available during the CreateRestApi and UpdateRestApi operations |
String |
|
Filters access by type of authorizer in the request, for example TOKEN, REQUEST, JWT. Available during CreateAuthorizer and UpdateAuthorizer. Also available during import and reimport as an ArrayOfString |
ArrayOfString |
|
Filters access by status of the default execute-api endpoint. Available during the CreateRestApi and DeleteRestApi operations |
Bool |
|
Filters access by domain name ARN. Available during the CreateDomainNameAccessAssociation operation |
ARN |
|
Filters access by endpoint type. Available during the CreateDomainName, UpdateDomainName, CreateRestApi, and UpdateRestApi operations |
ArrayOfString |
|
Filters access by URI of the truststore used for mutual TLS authentication. Available during the CreateDomainName and UpdateDomainName operations |
String |
|
Filters access by version of the truststore used for mutual TLS authentication. Available during the CreateDomainName and UpdateDomainName operations |
String |
|
Filters access by authorization type, for example NONE, AWS_IAM, CUSTOM, JWT, COGNITO_USER_POOLS. Available during the CreateMethod and PutMethod operations Also available as a collection during import |
ArrayOfString |
|
Filters access by routing mode of the domain name. Available during the CreateDomainName and UpdateDomainName operations |
String |
|
Filters access by TLS version. Available during the CreateDomain and UpdateDomain operations |
ArrayOfString |
|
Filters access by stage name of the deployment that you attempt to create. Available during the CreateDeployment operation |
String |
|
Filters access by access log destination of the current Stage resource. Available during the UpdateStage and DeleteStage operations |
String |
|
Filters access by access log format of the current Stage resource. Available during the UpdateStage and DeleteStage operations |
String |
|
Filters access by whether an API key is required or not for the existing Method resource. Available during the PutMethod and DeleteMethod operations. Also available as a collection during reimport |
ArrayOfBool |
|
Filters access by API name of the existing RestApi resource. Available during UpdateRestApi and DeleteRestApi operations |
String |
|
Filters access by the current type of authorizer, for example TOKEN, REQUEST, JWT. Available during UpdateAuthorizer and DeleteAuthorizer operations. Also available during reimport as an ArrayOfString |
ArrayOfString |
|
Filters access by status of the default execute-api endpoint of the current RestApi resource. Available during UpdateRestApi and DeleteRestApi operations |
Bool |
|
Filters access by endpoint type. Available during the UpdateDomainName, DeleteDomainName, UpdateRestApi, and DeleteRestApi operations |
ArrayOfString |
|
Filters access by URI of the truststore used for mutual TLS authentication. Available during UpdateDomainName and DeleteDomainName operations |
String |
|
Filters access by version of the truststore used for mutual TLS authentication. Available during UpdateDomainName and DeleteDomainName operations |
String |
|
Filters access by authorization type of the existing Method resource, for example NONE, AWS_IAM, CUSTOM, JWT, COGNITO_USER_POOLS. Available during the PutMethod and DeleteMethod operations. Also available as a collection during reimport |
ArrayOfString |
|
Filters access by routing mode of the domain name. Available during the UpdateDomainName and DeleteDomainName operations |
String |
|
Filters access by TLS version. Available during UpdateDomain and DeleteDomain operations |
ArrayOfString |
|
Filters access by the tag key-value pairs in the request |
String |
|
Filters access by the tags attached to the resource |
String |
|
Filters access by the tag keys in the request |
ArrayOfString |