Actions, resources, and condition keys for AWS Performance Insights

AWS Performance Insights (service prefix: pi) provides the following service-specific resources, actions, and condition context 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.

Actions defined by AWS 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 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.

The Resource types column of the Actions table indicates whether each action supports resource-level permissions. If there is no value for this column, you must specify all resources ("*") to which the policy applies in the Resource element of your policy statement. If the column includes a resource type, then you can specify an ARN of that type in a statement with that action. If the action has one or more required resources, the caller must have permission to use the action with those resources. Required resources are indicated in the table with an asterisk (*). If you limit resource access with the Resource element in an IAM policy, you must include an ARN or pattern for each required resource type. Some actions support multiple resource types. If the resource type is optional (not indicated as required), then you can choose to use one of the optional resource types.

The Condition keys column of the Actions table includes keys that you can specify in a policy statement's Condition element. For more information on the condition keys that are associated with resources for the service, see the Condition keys column of the Resource types table.

Note

Resource condition keys are listed in the Resource types table. You can find a link to the resource type that applies to an action in the Resource types (*required) column of the Actions table. The resource type in the Resource types table includes the Condition keys column, which are the resource condition keys that apply to an action in the Actions table.

For details about the columns in the following table, see Actions table.

Actions	Description	Access level	Resource types (*required)	Condition keys	Dependent actions
CreatePerformanceAnalysisReport	Grants permission to call CreatePerformanceAnalysisReport API to create a Performance Analysis Report for a specified DB instance	Write	perf-reports-resource*
				aws:RequestTag/${TagKey} aws:TagKeys
DeletePerformanceAnalysisReport	Grants permission to call DeletePerformanceAnalysisReport API to delete a Performance Analysis Report for a specified DB instance	Write	perf-reports-resource*
DescribeDimensionKeys	Grants permission to call DescribeDimensionKeys API to retrieve the top N dimension keys for a metric for a specific time period	Read	metric-resource*
				pi:Dimensions
GetDimensionKeyDetails	Grants permission to call GetDimensionKeyDetails API to retrieve the attributes of the specified dimension group	Read	metric-resource*
				pi:Dimensions
GetPerformanceAnalysisReport	Grants permission to call GetPerformanceAnalysisReport API to retrieve a Performance Analysis Report for a specified DB instance	Read	perf-reports-resource*
GetResourceMetadata	Grants permission to call GetResourceMetadata API to retrieve the metadata for different features	Read	metric-resource*
GetResourceMetrics	Grants permission to call GetResourceMetrics API to retrieve PI metrics for a set of data sources, over a time period	Read	metric-resource*
				pi:Dimensions
ListAvailableResourceDimensions	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	metric-resource*
ListAvailableResourceMetrics	Grants permission to call ListAvailableResourceMetrics API to retrieve metrics of the specified types that can be queried for a specified DB instance	Read	metric-resource*
ListPerformanceAnalysisReports	Grants permission to call ListPerformanceAnalysisReports API to list Performance Analysis Reports for a specified DB instance	List	perf-reports-resource*
ListTagsForResource	Grants permission to call ListTagsForResource API to list tags for a resource	List	perf-reports-resource*
TagResource	Grants permission to call TagResource API to tag a resource	Tagging	perf-reports-resource*
				aws:RequestTag/${TagKey} aws:TagKeys
UntagResource	Grants permission to call UntagResource API to untag a resource	Tagging	perf-reports-resource*
				aws:TagKeys

Resource types defined by AWS Performance Insights

The following resource types are defined by this service and can be used in the Resource element of IAM permission policy statements. Each action in the Actions table identifies the resource types that can be specified with that action. A resource type can also define which condition keys you can include in a policy. These keys are displayed in the last column of the Resource types table. For details about the columns in the following table, see Resource types table.

Resource types	ARN	Condition keys
metric-resource	arn:${Partition}:pi:${Region}:${Account}:metrics/${ServiceType}/${Identifier}
perf-reports-resource	arn:${Partition}:pi:${Region}:${Account}:perf-reports/${ServiceType}/${Identifier}/${ReportId}	aws:ResourceTag/${TagKey}

Condition keys for AWS Performance Insights

AWS Performance Insights defines the following condition keys that can be used in the Condition element of an IAM policy. You can use these keys to further refine the conditions under which the policy statement applies. For details about the columns in the following table, see Condition keys table.

To view the global condition keys that are available to all services, see Available global condition keys.

Condition keys	Description	Type
aws:RequestTag/${TagKey}	Filters access by the tags that are passed in the request	String
aws:ResourceTag/${TagKey}	Filters access by the tags associated with the resource	String
aws:TagKeys	Filters access by the tag keys that are passed in the request	ArrayOfString
pi:Dimensions	Filters access by the requested dimensions	ArrayOfString