View a markdown version of this page

Actions, resources, and condition keys for AWS API Portal - Service Authorization Reference

Actions, resources, and condition keys for AWS API Portal

AWS API Portal (service prefix: apiportal) provides the following service-specific operations, resources, actions, and condition keys for use in IAM permission policies.

References:

Actions defined by AWS API Portal

You can specify the following actions in the Action element of an IAM policy statement. For each action, the table lists the resource types and condition keys supported by that action. Use policies to grant permissions to perform an operation in AWS. 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.

Actions Description Resource types (*required) Condition keys Access level

AssociateManagedApis

Grants permission to associate managed APIs with a product

Product*

aws:ResourceTag/${TagKey}

Write

CreateManagedApi

Grants permission to create a managed API from a discovered API

ManagedApi*

aws:RequestTag/${TagKey}

aws:ResourceTag/${TagKey}

aws:TagKeys

Write

CreatePortal

Grants permission to create a portal

Portal*

aws:RequestTag/${TagKey}

aws:ResourceTag/${TagKey}

aws:TagKeys

Write

CreatePortalPreview

Grants permission to create a preview of a portal

Portal*

aws:ResourceTag/${TagKey}

Write

CreateProduct

Grants permission to create a product

Product*

aws:RequestTag/${TagKey}

aws:ResourceTag/${TagKey}

aws:TagKeys

Write

CreateProductApiPage

Grants permission to create an API reference page in a product

ProductApiPage*

aws:RequestTag/${TagKey}

aws:ResourceTag/${TagKey}

aws:TagKeys

Write

CreateProductPage

Grants permission to create a documentation page in a product

ProductPage*

aws:RequestTag/${TagKey}

aws:ResourceTag/${TagKey}

aws:TagKeys

Write

DeleteDiscoveryConfiguration

Grants permission to delete the API discovery configuration for an account

DiscoveryConfiguration*

aws:ResourceTag/${TagKey}

Write

DeleteManagedApi

Grants permission to delete a managed API

ManagedApi*

aws:ResourceTag/${TagKey}

Write

DeleteOrganizationDiscoveryConfiguration

Grants permission to delete the API discovery configuration for an organization

OrganizationDiscoveryConfiguration*

aws:ResourceTag/${TagKey}

Write

DeletePortal

Grants permission to delete a portal

Portal*

aws:ResourceTag/${TagKey}

Write

DeleteProduct

Grants permission to delete a product

Product*

aws:ResourceTag/${TagKey}

Write

DeleteProductApiPage

Grants permission to delete an API reference page from a product

ProductApiPage*

aws:ResourceTag/${TagKey}

Write

DeleteProductPage

Grants permission to delete a documentation page from a product

ProductPage*

aws:ResourceTag/${TagKey}

Write

DeleteProductSharingPolicy

Grants permission to delete the sharing policy of a product

ProductSharingPolicy*

aws:ResourceTag/${TagKey}

Permissions management, Write

DisassociateManagedApis

Grants permission to disassociate managed APIs from a product

Product*

aws:ResourceTag/${TagKey}

Write

GetApiInventoryItem

Grants permission to retrieve details of a discovered API in the API inventory

Read

GetDiscoveryConfiguration

Grants permission to retrieve the API discovery configuration for an account

DiscoveryConfiguration*

aws:ResourceTag/${TagKey}

Read

GetManagedApi

Grants permission to retrieve a managed API

ManagedApi*

aws:ResourceTag/${TagKey}

Read

GetOrganizationDiscoveryConfiguration

Grants permission to retrieve the API discovery configuration for an organization

OrganizationDiscoveryConfiguration*

aws:ResourceTag/${TagKey}

Read

GetPortal

Grants permission to retrieve a portal

Portal*

aws:ResourceTag/${TagKey}

Read

GetProduct

Grants permission to retrieve a product

Product*

aws:ResourceTag/${TagKey}

Read

GetProductApiPage

Grants permission to retrieve an API reference page in a product

ProductApiPage*

aws:ResourceTag/${TagKey}

Read

GetProductPage

Grants permission to retrieve a documentation page in a product

ProductPage*

aws:ResourceTag/${TagKey}

Read

GetProductSharingPolicy

Grants permission to retrieve the sharing policy of a product

ProductSharingPolicy*

aws:ResourceTag/${TagKey}

Read

ListApiInventoryItems

Grants permission to list discovered APIs in the API inventory

List

ListDiscoveryStatuses

Grants permission to list API discovery statuses

List

ListManagedApiEvents

Grants permission to list API security events for a managed API

ManagedApi*

aws:ResourceTag/${TagKey}

List

ListManagedApis

Grants permission to list managed APIs

List

ListPortals

Grants permission to list portals

List

ListProductApiPages

Grants permission to list the API reference pages in a product

Product*

aws:ResourceTag/${TagKey}

List

ListProductPages

Grants permission to list the documentation pages in a product

Product*

aws:ResourceTag/${TagKey}

List

ListProducts

Grants permission to list products

List

ListTagsForResource

Grants permission to list the tags for an API Portal resource

DiscoveryConfiguration

aws:ResourceTag/${TagKey}

Read

ManagedApi

aws:ResourceTag/${TagKey}

OrganizationDiscoveryConfiguration

aws:ResourceTag/${TagKey}

Portal

aws:ResourceTag/${TagKey}

Product

aws:ResourceTag/${TagKey}

ProductApiPage

aws:ResourceTag/${TagKey}

ProductPage

aws:ResourceTag/${TagKey}

ProductSharingPolicy

aws:ResourceTag/${TagKey}

PutDiscoveryConfiguration

Grants permission to create or update the API discovery configuration for an account

DiscoveryConfiguration*

aws:RequestTag/${TagKey}

aws:ResourceTag/${TagKey}

aws:TagKeys

Write

PutOrganizationDiscoveryConfiguration

Grants permission to create or update the API discovery configuration for an organization

OrganizationDiscoveryConfiguration*

aws:RequestTag/${TagKey}

aws:ResourceTag/${TagKey}

aws:TagKeys

Write

PutProductSharingPolicy

Grants permission to create or update the sharing policy of a product

ProductSharingPolicy*

aws:RequestTag/${TagKey}

aws:ResourceTag/${TagKey}

aws:TagKeys

Permissions management, Write

StartDiscovery

Grants permission to start API discovery for a discovery configuration

DiscoveryConfiguration*

aws:ResourceTag/${TagKey}

Write

OrganizationDiscoveryConfiguration*

aws:ResourceTag/${TagKey}

StopDiscovery

Grants permission to stop API discovery for a discovery configuration

DiscoveryConfiguration*

aws:ResourceTag/${TagKey}

Write

OrganizationDiscoveryConfiguration*

aws:ResourceTag/${TagKey}

TagResource

Grants permission to add tags to an API Portal resource

DiscoveryConfiguration

aws:RequestTag/${TagKey}

aws:ResourceTag/${TagKey}

aws:TagKeys

Tagging, Write

ManagedApi

aws:RequestTag/${TagKey}

aws:ResourceTag/${TagKey}

aws:TagKeys

OrganizationDiscoveryConfiguration

aws:RequestTag/${TagKey}

aws:ResourceTag/${TagKey}

aws:TagKeys

Portal

aws:RequestTag/${TagKey}

aws:ResourceTag/${TagKey}

aws:TagKeys

Product

aws:RequestTag/${TagKey}

aws:ResourceTag/${TagKey}

aws:TagKeys

ProductApiPage

aws:RequestTag/${TagKey}

aws:ResourceTag/${TagKey}

aws:TagKeys

ProductPage

aws:RequestTag/${TagKey}

aws:ResourceTag/${TagKey}

aws:TagKeys

ProductSharingPolicy

aws:RequestTag/${TagKey}

aws:ResourceTag/${TagKey}

aws:TagKeys

UntagResource

Grants permission to remove tags from an API Portal resource

DiscoveryConfiguration

aws:ResourceTag/${TagKey}

aws:TagKeys

Tagging, Write

ManagedApi

aws:ResourceTag/${TagKey}

aws:TagKeys

OrganizationDiscoveryConfiguration

aws:ResourceTag/${TagKey}

aws:TagKeys

Portal

aws:ResourceTag/${TagKey}

aws:TagKeys

Product

aws:ResourceTag/${TagKey}

aws:TagKeys

ProductApiPage

aws:ResourceTag/${TagKey}

aws:TagKeys

ProductPage

aws:ResourceTag/${TagKey}

aws:TagKeys

ProductSharingPolicy

aws:ResourceTag/${TagKey}

aws:TagKeys

UpdatePortal

Grants permission to update a portal

Portal*

aws:ResourceTag/${TagKey}

Write

UpdatePortalPublishStatus

Grants permission to publish or unpublish a portal

Portal*

aws:ResourceTag/${TagKey}

Write

UpdateProduct

Grants permission to update a product

Product*

aws:ResourceTag/${TagKey}

Write

UpdateProductApiPage

Grants permission to update an API reference page in a product

ProductApiPage*

aws:ResourceTag/${TagKey}

Write

UpdateProductPage

Grants permission to update a documentation page in a product

ProductPage*

aws:ResourceTag/${TagKey}

Write

Resource types defined by AWS API Portal

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

DiscoveryConfiguration

arn:${Partition}:apiportal:${Region}:${Account}:discoveryconfiguration

aws:ResourceTag/${TagKey}

ManagedApi

arn:${Partition}:apiportal:${Region}:${Account}:managedapis/${ManagedApiId}

aws:ResourceTag/${TagKey}

OrganizationDiscoveryConfiguration

arn:${Partition}:apiportal:${Region}:${Account}:orgdiscoveryconfiguration

aws:ResourceTag/${TagKey}

Portal

arn:${Partition}:apiportal:${Region}:${Account}:portals/${PortalId}

aws:ResourceTag/${TagKey}

Product

arn:${Partition}:apiportal:${Region}:${Account}:products/${ProductId}

aws:ResourceTag/${TagKey}

ProductApiPage

arn:${Partition}:apiportal:${Region}:${Account}:products/${ProductId}/apipages/${ProductApiPageId}

aws:ResourceTag/${TagKey}

ProductPage

arn:${Partition}:apiportal:${Region}:${Account}:products/${ProductId}/productpages/${ProductPageId}

aws:ResourceTag/${TagKey}

ProductSharingPolicy

arn:${Partition}:apiportal:${Region}:${Account}:products/${ProductId}/sharingpolicy

aws:ResourceTag/${TagKey}

Condition keys for AWS API Portal

AWS API Portal defines the following condition keys that can be used in the Condition element of an IAM policy.

Condition keys Description Type

aws:RequestTag/${TagKey}

Filters access by a tag's key and value in a request

String

aws:ResourceTag/${TagKey}

Filters actions based on the presence of tag key-value pairs in the request

String

aws:TagKeys

Filters access by the tag keys in a request

ArrayOfString