Actions, resources, and condition keys for AWS Resource Groups

AWS Resource Groups (service prefix: resource-groups) 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 Resource Groups

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.

Actions	Description	Access level	Resource types (*required)	Condition keys	Dependent actions
AssociateResource [permission only]	Grants permission to associate a resource to an Application	Write	group*
CancelTagSyncTask	Grants permission to cancel a tag-sync task for an application group	Write	group*		resource-groups:DeleteGroup
CreateGroup	Grants permission to create a resource group with a specified name, description, and resource query	Write		aws:RequestTag/${TagKey} aws:TagKeys	cloudformation:DescribeStacks
DeleteGroup	Grants permission to delete a specified resource group	Write	group*		tag:GetResources
DeleteGroupPolicy [permission only]	Grants permission to delete a resource-based policy for the specified group	Write	group*
DisassociateResource [permission only]	Grants permission to disassociate a resource from an Application	Write	group*
GetAccountSettings	Grants permission to get the current status of optional features in Resource Groups	Read
GetGroup	Grants permission to get information of a specified resource group	Read	group*
GetGroupConfiguration	Grants permission to get the service configuration associated with the specified resource group	Read	group*
GetGroupPolicy [permission only]	Grants permission to get a resource-based policy for the specified group	Read	group*
GetGroupQuery	Grants permission to get the query associated with a specified resource group	Read	group*
GetTagSyncTask	Grants permission to get information of a specified tag-sync task	Read	group*
GetTags	Grants permission to get the tags associated with a specified resource group	Read	group*
GroupResources	Grants permission to add the specified resources to the specified group	Write	group*		resource-groups:Tag tag:TagResources
ListGroupResources	Grants permission to list the resources that are members of a specified resource group	List	group*		cloudformation:DescribeStacks cloudformation:ListStackResources tag:GetResources
ListGroupingStatuses	Grants permission to list grouping statuses for a specified application group	List	group*
ListGroups	Grants permission to list all resource groups in your account	List
ListResourceTypes [permission only]	Grants permission to list supported resource types	List
ListTagSyncTasks	Grants permission to list all tag-sync tasks in your account	List	group*
PutGroupConfiguration	Grants permission to put the service configuration associated with the specified resource group	Write	group*
PutGroupPolicy [permission only]	Grants permission to add a resource-based policy for the specified group	Write	group*
SearchResources	Grants permission to search for AWS resources matching the given query	List			cloudformation:DescribeStacks cloudformation:ListStackResources tag:GetResources
StartTagSyncTask	Grants permission to create a tag-sync task for an application group	Write	group*		iam:PassRole resource-groups:CreateGroup
Tag	Grants permission to tag a specified resource group	Tagging	group*
				aws:RequestTag/${TagKey} aws:TagKeys
UngroupResources	Grants permission to remove the specified resources from the specified group	Write	group*		resource-groups:Untag tag:UntagResources
Untag	Grants permission to remove tags associated with a specified resource group	Tagging	group*
				aws:TagKeys
UpdateAccountSettings	Grants permission to update optional features in Resource Groups	Write
UpdateGroup	Grants permission to update a specified resource group	Write	group*
UpdateGroupQuery	Grants permission to update the query associated with a specified resource group	Write	group*		cloudformation:DescribeStacks

Resource types defined by AWS Resource Groups

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
group	arn:${Partition}:resource-groups:${Region}:${Account}:group/${GroupName}	aws:ResourceTag/${TagKey}
tagSyncTask	arn:${Partition}:resource-groups:${Region}:${Account}:group/${GroupName}/tag-sync-task/${TaskId}	aws:ResourceTag/${TagKey}

Condition keys for AWS Resource Groups

AWS Resource Groups 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 AWS global condition context keys.

Condition keys	Description	Type
aws:RequestTag/${TagKey}	Filters access by the presence of tag key-value pairs in the request	String
aws:ResourceTag/${TagKey}	Filters access by tag key-value pairs attached to the resource	String
aws:TagKeys	Filters access by the presence of tag keys in the request	ArrayOfString