Actions, resources, and condition keys for AWS Trusted Advisor

AWS Trusted Advisor (service prefix: trustedadvisor) 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 Trusted Advisor

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 Access level column of the Actions table describes how the action is classified (List, Read, Permissions management, or Tagging). This classification can help you understand the level of access that an action grants when you use it in a policy. For more information about access levels, see Access levels in policy summaries.

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.

Note

The IAM Trusted Advisor policy description details apply only to the Trusted Advisor console. If you want to manage programmatic access to Trusted Advisor, use the Trusted Advisor operations in the AWS Support API.

Actions	Description	Access level	Resource types (*required)	Condition keys	Dependent actions
BatchUpdateRecommendationResourceExclusion	Grants permission to update one or more exclusion status for a list of recommendation resources	Write
CreateEngagement	Grants permission to create an engagement	Write
CreateEngagementAttachment	Grants permission to create an engagement attachment	Write
CreateEngagementCommunication	Grants permission to create an engagement communication	Write
DeleteNotificationConfigurationForDelegatedAdmin	Grants permission to the organization management account to delete email notification preferences from a delegated administrator account for Trusted Advisor Priority	Write
DescribeAccount [permission only]	Grants permission to view the AWS Support plan and various AWS Trusted Advisor preferences	Read
DescribeAccountAccess [permission only]	Grants permission to view if the AWS account has enabled or disabled AWS Trusted Advisor	Read
DescribeCheckItems	Grants permission to view details for the check items	Read	checks*
DescribeCheckRefreshStatuses	Grants permission to view the refresh statuses for AWS Trusted Advisor checks	Read	checks*
DescribeCheckStatusHistoryChanges [permission only]	Grants permission to view the results and changed statuses for checks in the last 30 days	Read	checks*
DescribeCheckSummaries	Grants permission to view AWS Trusted Advisor check summaries	Read	checks*
DescribeChecks	Grants permission to view details for AWS Trusted Advisor checks	Read
DescribeNotificationConfigurations	Grants permission to get your email notification preferences for Trusted Advisor Priority	Read
DescribeNotificationPreferences [permission only]	Grants permission to view the notification preferences for the AWS account	Read
DescribeOrganization [permission only]	Grants permission to view if the AWS account meets the requirements to enable the organizational view feature	Read
DescribeOrganizationAccounts [permission only]	Grants permission to view the linked AWS accounts that are in the organization	Read
DescribeReports [permission only]	Grants permission to view details for organizational view reports, such as the report name, runtime, date created, status, and format	Read
DescribeRisk	Grants permission to view risk details in AWS Trusted Advisor Priority	Read
DescribeRiskResources	Grants permission to view affected resources for a risk in AWS Trusted Advisor Priority	Read
DescribeRisks	Grants permission to view risks in AWS Trusted Advisor Priority	Read
DescribeServiceMetadata [permission only]	Grants permission to view information about organizational view reports, such as the AWS Regions, check categories, check names, and resource statuses	Read
DownloadRisk	Grants permission to download a file that contains details about the risk in AWS Trusted Advisor Priority	Read
ExcludeCheckItems [permission only]	Grants permission to exclude recommendations for AWS Trusted Advisor checks	Write	checks*
GenerateReport [permission only]	Grants permission to create a report for AWS Trusted Advisor checks in your organization	Write
GetEngagement	Grants permission to view an engagment	Read
GetEngagementAttachment	Grants permission to view an engagment attachment	Read
GetEngagementType	Grants permission to view a specific engagement type	Read
GetOrganizationRecommendation	Grants permission to get a specific recommendation within an AWS Organization's organization. This API supports only prioritized recommendations	Read
GetRecommendation	Grants permission to get a specific Recommendation	Read
IncludeCheckItems [permission only]	Grants permission to include recommendations for AWS Trusted Advisor checks	Write	checks*
ListAccountsForParent [permission only]	Grants permission to view, in the Trusted Advisor console, all of the accounts in an AWS organization that are contained by a root or organizational unit (OU)	Read
ListChecks	Grants permission to list a filterable set of Checks	List
ListEngagementCommunications	Grants permission to view all communications for an engagement	Read
ListEngagementTypes	Grants permission to view all engagement types	Read
ListEngagements	Grants permission to view all engagements	Read
ListOrganizationRecommendationAccounts	Grants permission to list the accounts that own the resources for an AWS Organization aggregate recommendation. This API only supports prioritized recommendations	List
ListOrganizationRecommendationResources	Grants permission to list Resources of a Recommendation within an AWS Organization. This API only supports prioritized recommendations	List
ListOrganizationRecommendations	Grants permission to list a filterable set of Recommendations within an AWS Organization. This API only supports prioritized recommendations	List
ListOrganizationalUnitsForParent [permission only]	Grants permission to view, in the Trusted Advisor console, all of the organizational units (OUs) in a parent organizational unit or root	Read
ListRecommendationResources	Grants permission to list Resources of a Recommendation	List
ListRecommendations	Grants permission to list a filterable set of Recommendations	List
ListRoots [permission only]	Grants permission to view, in the Trusted Advisor console, all of the roots that are defined in an AWS organization	Read
RefreshCheck	Grants permission to refresh an AWS Trusted Advisor check	Write	checks*
SetAccountAccess [permission only]	Grants permission to enable or disable AWS Trusted Advisor for the account	Write
SetOrganizationAccess [permission only]	Grants permission to enable the organizational view feature for AWS Trusted Advisor	Write
UpdateEngagement	Grants permission to update the details of an engagement	Write
UpdateEngagementStatus	Grants permission to update the status of an engagement	Write
UpdateNotificationConfigurations	Grants permission to create or update your email notification preferences for Trusted Advisor Priority	Write
UpdateNotificationPreferences [permission only]	Grants permission to update notification preferences for AWS Trusted Advisor	Write
UpdateOrganizationRecommendationLifecycle	Grants permission to update the lifecyle of a Recommendation within an AWS Organization. This API only supports prioritized recommendations	Write
UpdateRecommendationLifecycle	Grants permission to update the lifecyle of a Recommendation. This API only supports prioritized recommendations	Write
UpdateRiskStatus	Grants permission to update the risk status in AWS Trusted Advisor Priority	Write

Resource types defined by AWS Trusted Advisor

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.

Note

The ARN for the checks resource type should not include a region. In the format instead of '${Region}' use a '*' or the policy will not work correctly.

Resource types	ARN	Condition keys
checks	arn:${Partition}:trustedadvisor:${Region}:${Account}:checks/${CategoryCode}/${CheckId}

Condition keys for AWS Trusted Advisor

Trusted Advisor has no service-specific context keys that can be used in the Condition element of policy statements. For the list of the global context keys that are available to all services, see AWS global condition context keys.