Actions, resources, and condition keys for Amazon Performance Insights
Amazon Performance Insights (service prefix: pi) 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 Performance Insights
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 |
|---|---|---|---|---|
|
CreatePerformanceAnalysisReport |
Write |
|||
Tagging, Write |
||||
|
DeletePerformanceAnalysisReport |
Write |
|||
|
DescribeDimensionKeys |
Read |
|||
|
GetDimensionKeyDetails |
Read |
|||
|
GetPerformanceAnalysisReport |
Read |
|||
|
GetResourceMetadata |
Read |
|||
|
GetResourceMetrics |
Read |
|||
|
ListAvailableResourceDimensions |
Read |
|||
Read |
||||
Read |
||||
Read |
||||
|
ListAvailableResourceMetrics |
Read |
|||
|
ListPerformanceAnalysisReportRecommendations |
List |
|||
|
ListPerformanceAnalysisReports |
List |
|||
List |
||||
|
ListTagsForResource |
List |
|||
|
TagResource |
Tagging, Write |
|||
|
UntagResource |
Tagging, Write |
Actions defined by Amazon Performance Insights
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.
| Actions | Description | Resource types (*required) | Condition keys | Access level |
|---|---|---|---|---|
Grants permission to call CreatePerformanceAnalysisReport API to create a Performance Analysis Report for a specified DB instance |
Write |
|||
Grants permission to call DeletePerformanceAnalysisReport API to delete a Performance Analysis Report for a specified DB instance |
Write |
|||
Grants permission to call DescribeDimensionKeys API to retrieve the top N dimension keys for a metric for a specific time period |
Read |
|||
Grants permission to call GetDimensionKeyDetails API to retrieve the attributes of the specified dimension group |
Read |
|||
Grants permission to call GetPerformanceAnalysisReport API to retrieve a Performance Analysis Report for a specified DB instance |
Read |
|||
Grants permission to call GetResourceMetadata API to retrieve the metadata for different features |
Read |
|||
Grants permission to call GetResourceMetrics API to retrieve PI metrics for a set of data sources, over a time period |
Read |
|||
Grants permission to call ListAvailableResourceDimensions API to retrieve the dimensions that can be queried for each specified metric type on a specified DB instance |
Read |
|||
Grants permission to call ListAvailableResourceMetrics API to retrieve metrics of the specified types that can be queried for a specified DB instance |
Read |
|||
Grants permission to call ListPerformanceAnalysisReportRecommendations API to retrieve a Performance Analysis Report Recommendations for a specified DB instance |
List |
|||
Grants permission to call ListPerformanceAnalysisReports API to list Performance Analysis Reports for a specified DB instance |
List |
|||
Grants permission to call ListTagsForResource API to list tags for a resource |
List |
|||
Grants permission to call TagResource API to tag a resource |
Tagging, Write |
|||
Grants permission to call UntagResource API to untag a resource |
Tagging, Write |
Resource types defined by Amazon Performance Insights
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}:pi:${Region}:${Account}:metrics/${ServiceType}/${Identifier} |
||
arn:${Partition}:pi:${Region}:${Account}:perf-reports/${ServiceType}/${Identifier}/${ReportId} |
Condition keys for Amazon Performance Insights
Amazon Performance Insights defines the following condition keys that can be used in the
Condition element of an IAM policy.
| Condition keys | Description | Type |
|---|---|---|
Filters access by the tags that are passed in the request |
String |
|
Filters access by the tags associated with the resource |
String |
|
Filters access by the tag keys that are passed in the request |
ArrayOfString |
|
Filters access by the requested dimensions |
ArrayOfString |