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:
-
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
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 |
|---|---|---|---|---|
Grants permission to associate managed APIs with a product |
Write |
|||
Grants permission to create a managed API from a discovered API |
Write |
|||
Grants permission to create a portal |
Write |
|||
Grants permission to create a preview of a portal |
Write |
|||
Grants permission to create a product |
Write |
|||
Grants permission to create an API reference page in a product |
Write |
|||
Grants permission to create a documentation page in a product |
Write |
|||
Grants permission to delete the API discovery configuration for an account |
Write |
|||
Grants permission to delete a managed API |
Write |
|||
Grants permission to delete the API discovery configuration for an organization |
Write |
|||
Grants permission to delete a portal |
Write |
|||
Grants permission to delete a product |
Write |
|||
Grants permission to delete an API reference page from a product |
Write |
|||
Grants permission to delete a documentation page from a product |
Write |
|||
Grants permission to delete the sharing policy of a product |
Permissions management, Write |
|||
Grants permission to disassociate managed APIs from a product |
Write |
|||
Grants permission to retrieve details of a discovered API in the API inventory |
Read |
|||
Grants permission to retrieve the API discovery configuration for an account |
Read |
|||
Grants permission to retrieve a managed API |
Read |
|||
Grants permission to retrieve the API discovery configuration for an organization |
Read |
|||
Grants permission to retrieve a portal |
Read |
|||
Grants permission to retrieve a product |
Read |
|||
Grants permission to retrieve an API reference page in a product |
Read |
|||
Grants permission to retrieve a documentation page in a product |
Read |
|||
Grants permission to retrieve the sharing policy of a product |
Read |
|||
Grants permission to list discovered APIs in the API inventory |
List |
|||
Grants permission to list API discovery statuses |
List |
|||
Grants permission to list API security events for a managed API |
List |
|||
Grants permission to list managed APIs |
List |
|||
Grants permission to list portals |
List |
|||
Grants permission to list the API reference pages in a product |
List |
|||
Grants permission to list the documentation pages in a product |
List |
|||
Grants permission to list products |
List |
|||
Grants permission to list the tags for an API Portal resource |
Read |
|||
Grants permission to create or update the API discovery configuration for an account |
Write |
|||
Grants permission to create or update the API discovery configuration for an organization |
Write |
|||
Grants permission to create or update the sharing policy of a product |
Permissions management, Write |
|||
Grants permission to start API discovery for a discovery configuration |
Write |
|||
Grants permission to stop API discovery for a discovery configuration |
Write |
|||
Grants permission to add tags to an API Portal resource |
Tagging, Write |
|||
Grants permission to remove tags from an API Portal resource |
Tagging, Write |
|||
Grants permission to update a portal |
Write |
|||
Grants permission to publish or unpublish a portal |
Write |
|||
Grants permission to update a product |
Write |
|||
Grants permission to update an API reference page in a product |
Write |
|||
Grants permission to update a documentation page in a product |
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 |
|---|---|---|
arn:${Partition}:apiportal:${Region}:${Account}:discoveryconfiguration |
||
arn:${Partition}:apiportal:${Region}:${Account}:managedapis/${ManagedApiId} |
||
arn:${Partition}:apiportal:${Region}:${Account}:orgdiscoveryconfiguration |
||
arn:${Partition}:apiportal:${Region}:${Account}:portals/${PortalId} |
||
arn:${Partition}:apiportal:${Region}:${Account}:products/${ProductId} |
||
arn:${Partition}:apiportal:${Region}:${Account}:products/${ProductId}/apipages/${ProductApiPageId} |
||
arn:${Partition}:apiportal:${Region}:${Account}:products/${ProductId}/productpages/${ProductPageId} |
||
arn:${Partition}:apiportal:${Region}:${Account}:products/${ProductId}/sharingpolicy |
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 |
|---|---|---|
Filters access by a tag's key and value in a request |
String |
|
Filters actions based on the presence of tag key-value pairs in the request |
String |
|
Filters access by the tag keys in a request |
ArrayOfString |