Amazon API Gateway Management (apigateway)

Additions

Actions

• CreatePortal
  
  • Description:  Grants permission to create a Portal
  • Access:  Write
  • Resources: 

    Name: Portal

    Required: Yes

  • Conditions: 

    apigateway:Request/CognitoUserPoolArn

    apigateway:Request/PortalDisplayName

    apigateway:Request/PortalDomainName

    aws:RequestTag/${TagKey}

    aws:TagKeys

• CreatePortalProduct
  
  • Description:  Grants permission to create a Portal Product
  • Access:  Write
  • Resources: 

    Name: PortalProduct

    Required: Yes

  • Conditions: 

    apigateway:Request/PortalProductDisplayName

    aws:RequestTag/${TagKey}

    aws:TagKeys

• CreateProductPage
  
  • Description:  Grants permission to create a Product Page
  • Access:  Write
  • Resources: 

    Name: ProductPage

    Required: Yes

  • Conditions: 

    apigateway:Request/ProductPageTitle

• CreateProductRestEndpointPage
  
  • Description:  Grants permission to create a Product REST Endpoint Page
  • Access:  Write
  • Resources: 

    Name: ProductRestEndpointPage

    Required: Yes

  • Conditions: 

    apigateway:Request/Method

    apigateway:Request/ProductRestEndpointPageEndpointPrefix

    apigateway:Request/RestApiId

    apigateway:Request/Stage

• CreateRoutingRule
  
  • Description:  Grants permission to create a routing rule
  • Access:  Write
  • Resources: 

    Name: RoutingRule

    Required: Yes

  • Conditions: 

    apigateway:Request/ConditionBasePaths

    apigateway:Request/Priority

    aws:ResourceTag/${TagKey}

• DeletePortal
  
  • Description:  Grants permission to delete a Portal
  • Access:  Write
  • Resources: 

    Name: Portal

    Required: Yes

• DeletePortalProduct
  
  • Description:  Grants permission to delete a Portal Product
  • Access:  Write
  • Resources: 

    Name: PortalProduct

    Required: Yes

• DeletePortalProductSharingPolicy
  
  • Description:  Grants permission to delete a Portal Product Sharing Policy
  • Access:  Permissions management
  • Resources: 

    Name: PortalProduct

    Required: Yes

• DeleteProductPage
  
  • Description:  Grants permission to delete a Product Page
  • Access:  Write
  • Resources: 

    Name: ProductPage

    Required: Yes

• DeleteProductRestEndpointPage
  
  • Description:  Grants permission to delete a Product REST Endpoint Page
  • Access:  Write
  • Resources: 

    Name: PortalProduct

    Required: Yes

    Name: ProductRestEndpointPage

    Required: Yes

• DeleteRoutingRule
  
  • Description:  Grants permission to delete a routing rule
  • Access:  Write
  • Resources: 

    Name: RoutingRule

    Required: Yes

  • Conditions: 

    apigateway:Resource/ConditionBasePaths

    apigateway:Resource/Priority

    aws:ResourceTag/${TagKey}

• DisablePortal
  
  • Description:  Grants permission to disable a Portal
  • Access:  Write
  • Resources: 

    Name: Portal

    Required: Yes

• GetPortal
  
  • Description:  Grants permission to read a Portal
  • Access:  Read
  • Resources: 

    Name: Portal

    Required: Yes

• GetPortalProduct
  
  • Description:  Grants permission to read a Portal Product
  • Access:  Read
  • Resources: 

    Name: PortalProduct

    Required: Yes

• GetPortalProductSharingPolicy
  
  • Description:  Grants permission to read a Portal Product Sharing Policy
  • Access:  Read
  • Resources: 

    Name: PortalProduct

    Required: Yes

• GetProductPage
  
  • Description:  Grants permission to read a Product Page
  • Access:  Read
  • Resources: 

    Name: PortalProduct

    Required: No

    Name: ProductPage

    Required: Yes

• GetProductRestEndpointPage
  
  • Description:  Grants permission to read a Product REST Endpoint Page
  • Access:  Read
  • Resources: 

    Name: PortalProduct

    Required: No

    Name: ProductRestEndpointPage

    Required: Yes

• GetRoutingRule
  
  • Description:  Grants permission to read a routing rule
  • Access:  Read
  • Resources: 

    Name: RoutingRule

    Required: Yes

  • Conditions: 

    aws:ResourceTag/${TagKey}

• ListPortalProducts
  
  • Description:  Grants permission to list Portal Products
  • Access:  List
  • Resources: 

    Name: PortalProduct

    Required: Yes

• ListPortals
  
  • Description:  Grants permission to list Portals
  • Access:  List
  • Resources: 

    Name: Portal

    Required: Yes

• ListProductPages
  
  • Description:  Grants permission to list Product Pages
  • Access:  List
  • Resources: 

    Name: PortalProduct

    Required: No

    Name: ProductPage

    Required: Yes

• ListProductRestEndpointPages
  
  • Description:  Grants permission to list Product REST Endpoint Pages
  • Access:  List
  • Resources: 

    Name: PortalProduct

    Required: No

    Name: ProductRestEndpointPage

    Required: Yes

• ListRoutingRules
  
  • Description:  Grants permission to list routing rules under a domain name
  • Access:  List
  • Resources: 

    Name: RoutingRule

    Required: Yes

  • Conditions: 

    aws:ResourceTag/${TagKey}

• PreviewPortal
  
  • Description:  Grants permission to preview a Portal
  • Access:  Write
  • Resources: 

    Name: Portal

    Required: Yes

• PublishPortal
  
  • Description:  Grants permission to publish a Portal
  • Access:  Write
  • Resources: 

    Name: Portal

    Required: Yes

• PutPortalProductSharingPolicy
  
  • Description:  Grants permission to put a Portal Product Sharing Policy
  • Access:  Permissions management
  • Resources: 

    Name: PortalProduct

    Required: Yes

• UpdatePortal
  
  • Description:  Grants permission to update a Portal
  • Access:  Write
  • Resources: 

    Name: Portal

    Required: Yes

  • Conditions: 

    apigateway:Request/CognitoUserPoolArn

    apigateway:Request/PortalDisplayName

    apigateway:Request/PortalDomainName

    aws:RequestTag/${TagKey}

    aws:TagKeys

• UpdatePortalProduct
  
  • Description:  Grants permission to update a Portal Product
  • Access:  Write
  • Resources: 

    Name: PortalProduct

    Required: Yes

  • Conditions: 

    apigateway:Request/PortalProductDisplayName

    aws:RequestTag/${TagKey}

    aws:TagKeys

• UpdateProductPage
  
  • Description:  Grants permission to update a Product Page
  • Access:  Write
  • Resources: 

    Name: ProductPage

    Required: Yes

  • Conditions: 

    apigateway:Request/ProductPageTitle

• UpdateProductRestEndpointPage
  
  • Description:  Grants permission to update a Product REST Endpoint Page
  • Access:  Write
  • Resources: 

    Name: ProductRestEndpointPage

    Required: Yes

  • Conditions: 

    apigateway:Request/ProductRestEndpointPageEndpointPrefix

• UpdateRoutingRule
  
  • Description:  Grants permission to update a routing rule using the PutRoutingRule API
  • Access:  Write
  • Resources: 

    Name: RoutingRule

    Required: Yes

  • Conditions: 

    apigateway:Request/ConditionBasePaths

    apigateway:Request/Priority

    apigateway:Resource/ConditionBasePaths

    apigateway:Resource/Priority

    aws:ResourceTag/${TagKey}

Resources

• AccessLogSettings
  
  • Arn:  arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/stages/${StageName}/accesslogsettings
  • Conditions: 

    aws:ResourceTag/${TagKey}

• Api
  
  • Arn:  arn:${Partition}:apigateway:${Region}::/apis/${ApiId}
  • Conditions: 

    apigateway:Request/ApiKeyRequired

    apigateway:Request/ApiName

    apigateway:Request/AuthorizerType

    apigateway:Request/AuthorizerUri

    apigateway:Request/DisableExecuteApiEndpoint

    apigateway:Request/EndpointType

    apigateway:Request/RouteAuthorizationType

    apigateway:Resource/ApiKeyRequired

    apigateway:Resource/ApiName

    apigateway:Resource/AuthorizerType

    apigateway:Resource/AuthorizerUri

    apigateway:Resource/DisableExecuteApiEndpoint

    apigateway:Resource/EndpointType

    apigateway:Resource/RouteAuthorizationType

    aws:ResourceTag/${TagKey}

• ApiMapping
  
  • Arn:  arn:${Partition}:apigateway:${Region}::/domainnames/${DomainName}/apimappings/${ApiMappingId}
  • Conditions: 

    aws:ResourceTag/${TagKey}

• ApiMappings
  
  • Arn:  arn:${Partition}:apigateway:${Region}::/domainnames/${DomainName}/apimappings
  • Conditions: 

    aws:ResourceTag/${TagKey}

• Apis
  
  • Arn:  arn:${Partition}:apigateway:${Region}::/apis
  • Conditions: 

    apigateway:Request/ApiKeyRequired

    apigateway:Request/ApiName

    apigateway:Request/AuthorizerType

    apigateway:Request/AuthorizerUri

    apigateway:Request/DisableExecuteApiEndpoint

    apigateway:Request/EndpointType

    apigateway:Request/RouteAuthorizationType

    aws:ResourceTag/${TagKey}

• AuthorizersCache
  
  • Arn:  arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/stages/${StageName}/cache/authorizers
  • Conditions: 

    aws:ResourceTag/${TagKey}

• Cors
  
  • Arn:  arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/cors
  • Conditions: 

    aws:ResourceTag/${TagKey}

• ExportedAPI
  
  • Arn:  arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/exports/${Specification}
  • Conditions: 

    aws:ResourceTag/${TagKey}

• IntegrationResponses
  
  • Arn:  arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/integrations/${IntegrationId}/integrationresponses
  • Conditions: 

    aws:ResourceTag/${TagKey}

• Integrations
  
  • Arn:  arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/integrations
  • Conditions: 

    aws:ResourceTag/${TagKey}

• ModelTemplate
  
  • Arn:  arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/models/${ModelId}/template
  • Conditions: 

    aws:ResourceTag/${TagKey}

• Portal
  
  • Arn:  arn:${Partition}:apigateway:${Region}:${Account}:/portals/${PortalId}
  • Conditions: 

    apigateway:Resource/CognitoUserPoolArn

    apigateway:Resource/PortalDisplayName

    apigateway:Resource/PortalDomainName

    apigateway:Resource/PortalPublishStatus

    aws:ResourceTag/${TagKey}

• PortalProduct
  
  • Arn:  arn:${Partition}:apigateway:${Region}:${Account}:/portalproducts/${PortalProductId}
  • Conditions: 

    apigateway:Resource/PortalProductDisplayName

    aws:ResourceTag/${TagKey}

• ProductPage
  
  • Arn:  arn:${Partition}:apigateway:${Region}:${Account}:/portalproducts/${PortalProductId}/productpages/${ProductPageId}
  • Conditions: 

    apigateway:Resource/ProductPageTitle

    aws:ResourceTag/${TagKey}

• ProductRestEndpointPage
  
  • Arn:  arn:${Partition}:apigateway:${Region}:${Account}:/portalproducts/${PortalProductId}/productrestendpointpages/${ProductRestEndpointPageId}
  • Conditions: 

    apigateway:Resource/Method

    apigateway:Resource/ProductRestEndpointPageEndpointPrefix

    apigateway:Resource/RestApiId

    apigateway:Resource/Stage

    aws:ResourceTag/${TagKey}

• Route
  
  • Arn:  arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/routes/${RouteId}
  • Conditions: 

    apigateway:Request/ApiKeyRequired

    apigateway:Request/RouteAuthorizationType

    apigateway:Resource/ApiKeyRequired

    apigateway:Resource/RouteAuthorizationType

    aws:ResourceTag/${TagKey}

• RouteRequestParameter
  
  • Arn:  arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/routes/${RouteId}/requestparameters/${RequestParameterKey}
  • Conditions: 

    aws:ResourceTag/${TagKey}

• RouteResponse
  
  • Arn:  arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/routes/${RouteId}/routeresponses/${RouteResponseId}
  • Conditions: 

    aws:ResourceTag/${TagKey}

• RouteResponses
  
  • Arn:  arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/routes/${RouteId}/routeresponses
  • Conditions: 

    aws:ResourceTag/${TagKey}

• RouteSettings
  
  • Arn:  arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/stages/${StageName}/routesettings/${RouteKey}
  • Conditions: 

    aws:ResourceTag/${TagKey}

• Routes
  
  • Arn:  arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/routes
  • Conditions: 

    apigateway:Request/ApiKeyRequired

    apigateway:Request/RouteAuthorizationType

    aws:ResourceTag/${TagKey}

• RoutingRule
  
  • Arn:  arn:${Partition}:apigateway:${Region}:${Account}:/domainnames/${DomainName}/routingrules/${RoutingRuleId}
  • Conditions: 

    apigateway:Resource/ConditionBasePaths

    apigateway:Resource/Priority

    aws:ResourceTag/${TagKey}

Conditions

• apigateway:Request/AuthorizerUri
  
  • Description:  Filters access by URI of a Lambda authorizer function. Available during CreateAuthorizer and UpdateAuthorizer. Also available during import and reimport as an ArrayOfString
  • Type:  ArrayOfString
• apigateway:Request/CognitoUserPoolArn
  
  • Description:  Filters access by a Portal's CognitoUserPoolArn that is passed in the request
  • Type:  ARN
• apigateway:Request/ConditionBasePaths
  
  • Description:  Filters access by base paths defined on the condition of a routing rule. Available during the CreateRoutingRule and UpdateRoutingRule operations
  • Type:  ArrayOfString
• apigateway:Request/Method
  
  • Description:  Filters access by a ProductRestEndpointPage's HTTP Method that is passed in the request
  • Type:  String
• apigateway:Request/PortalDisplayName
  
  • Description:  Filters access by a Portal's Display Name that is passed in the request
  • Type:  String
• apigateway:Request/PortalDomainName
  
  • Description:  Filters access by a Portal's vanity domain name that is passed in the request
  • Type:  String
• apigateway:Request/PortalProductDisplayName
  
  • Description:  Filters access by a PortalProduct's Display Name that is passed in the request
  • Type:  String
• apigateway:Request/Priority
  
  • Description:  Filters access by priority of the routing rule. Available during the CreateRoutingRule and UpdateRoutingRule operations
  • Type:  Numeric
• apigateway:Request/ProductPageTitle
  
  • Description:  Filters access by a ProductPage's Title that is passed in the request
  • Type:  String
• apigateway:Request/ProductRestEndpointPageEndpointPrefix
  
  • Description:  Filters access by a ProductRestEndpointPage's EndpointPrefix that is passed in the request
  • Type:  String
• apigateway:Request/RestApiId
  
  • Description:  Filters access by a ProductRestEndpointPage's Amazon API Gateway API ID that is passed in the request
  • Type:  String
• apigateway:Request/Stage
  
  • Description:  Filters access by a ProductRestEndpointPage's Amazon API Gateway Stage Name that is passed in the request
  • Type:  String
• apigateway:Resource/AuthorizerUri
  
  • Description:  Filters access by the URI of the current Lambda authorizer associated with the current API. Available during UpdateAuthorizer and DeleteAuthorizer. Also available as a collection during reimport
  • Type:  ArrayOfString
• apigateway:Resource/CognitoUserPoolArn
  
  • Description:  Filters access by a Portal's CognitoUserPoolArn associated with the resource
  • Type:  ARN
• apigateway:Resource/ConditionBasePaths
  
  • Description:  Filters access by base paths defined on the condition of the existing routing rule. Available during the UpdateRoutingRule and DeleteRoutingRule operations
  • Type:  ArrayOfString
• apigateway:Resource/Method
  
  • Description:  Filters access by a ProductRestEndpointPage's HTTP Method associated with the resource
  • Type:  String
• apigateway:Resource/PortalDisplayName
  
  • Description:  Filters access by a Portal's Display Name associated with the resource
  • Type:  String
• apigateway:Resource/PortalDomainName
  
  • Description:  Filters access by a Portal's vanity domain name associated with the resource
  • Type:  String
• apigateway:Resource/PortalProductDisplayName
  
  • Description:  Filters access by a PortalProduct's Display Name associated with the resource
  • Type:  String
• apigateway:Resource/PortalPublishStatus
  
  • Description:  Filters access by a Portal's published status associated with the resource
  • Type:  String
• apigateway:Resource/Priority
  
  • Description:  Filters access by priority of the existing routing rule. Available during the UpdateRoutingRule and DeleteRoutingRule operations
  • Type:  Numeric
• apigateway:Resource/ProductPageTitle
  
  • Description:  Filters access by a ProductPage's Title associated with the resource
  • Type:  String
• apigateway:Resource/ProductRestEndpointPageEndpointPrefix
  
  • Description:  Filters access by a ProductRestEndpointPage's EndpointPrefix associated with the resource
  • Type:  String
• apigateway:Resource/RestApiId
  
  • Description:  Filters access by a ProductRestEndpointPage's Amazon API Gateway API ID associated with the resource
  • Type:  String
• apigateway:Resource/Stage
  
  • Description:  Filters access by a ProductRestEndpointPage's Amazon API Gateway Stage Name associated with the resource
  • Type:  String

Updates

Resources

• ClientCertificates
  
  Arn
  
  • Old: arn:${Partition}:apigateway:${Region}::/restapis/${RestApiId}/authorizers/${AuthorizerId}
    New: arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/authorizers/${AuthorizerId} arn:${Partition}:apigateway:${Region}::/restapis/${RestApiId}/authorizers/${AuthorizerId}
  Conditions
  
  • ＋ apigateway:Request/AuthorizerUri
  • ＋ apigateway:Resource/AuthorizerUri
• Deployment
  
  Arn
  
  • Old: arn:${Partition}:apigateway:${Region}::/restapis/${RestApiId}/authorizers
    New: arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/authorizers arn:${Partition}:apigateway:${Region}::/restapis/${RestApiId}/authorizers
  Conditions
  
  • ＋ apigateway:Request/AuthorizerUri
• DomainNames
  
  Arn
  
  • Old: arn:${Partition}:apigateway:${Region}::/restapis/${RestApiId}/deployments/${DeploymentId}
    New: arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/deployments/${DeploymentId} arn:${Partition}:apigateway:${Region}::/restapis/${RestApiId}/deployments/${DeploymentId}
• DomainNameAccessAssociation
  
  Arn
  
  • Old: arn:${Partition}:apigateway:${Region}::/restapis/${RestApiId}/deployments
    New: arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/deployments arn:${Partition}:apigateway:${Region}::/restapis/${RestApiId}/deployments
• PrivateDomainName
  
  Arn
  
  • Old: arn:${Partition}:apigateway:${Region}::/restapis/${RestApiId}/resources/${ResourceId}/methods/${HttpMethodType}/integration
    New: arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/integrations/${IntegrationId} arn:${Partition}:apigateway:${Region}::/restapis/${RestApiId}/resources/${ResourceId}/methods/${HttpMethodType}/integration
• RequestValidator
  
  Arn
  
  • Old: arn:${Partition}:apigateway:${Region}::/restapis/${RestApiId}/resources/${ResourceId}/methods/${HttpMethodType}/integration/responses/${StatusCode}
    New: arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/integrations/${IntegrationId}/integrationresponses/${IntegrationResponseId} arn:${Partition}:apigateway:${Region}::/restapis/${RestApiId}/resources/${ResourceId}/methods/${HttpMethodType}/integration/responses/${StatusCode}
• RestApis
  
  Arn
  
  • Old: arn:${Partition}:apigateway:${Region}::/restapis/${RestApiId}/models/${ModelName}
    New: arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/models/${ModelId} arn:${Partition}:apigateway:${Region}::/restapis/${RestApiId}/models/${ModelName}
• Stage
  
  Arn
  
  • Old: arn:${Partition}:apigateway:${Region}::/restapis/${RestApiId}/models
    New: arn:${Partition}:apigateway:${Region}::/apis/${ApiId}/models arn:${Partition}:apigateway:${Region}::/restapis/${RestApiId}/models

Actions

• RejectAccessAssociation
  
  Resources
  
  • ＋ AccessLogSettings
  • ＋ Api
  • ＋ ApiMapping
  • ＋ AuthorizersCache
  • ＋ Cors
  • ＋ Route
  • ＋ RouteRequestParameter
  • ＋ RouteResponse
  • ＋ RouteSettings