IAmazonResourceGroups Interface | AWS SDK for .NET V3

Interface for accessing ResourceGroups

Resource Groups lets you organize Amazon Web Services resources such as Amazon Elastic Compute Cloud instances, Amazon Relational Database Service databases, and Amazon Simple Storage Service buckets into groups using criteria that you define as tags. A resource group is a collection of resources that match the resource types specified in a query, and share one or more tags or portions of tags. You can create a group of resources based on their roles in your cloud infrastructure, lifecycle stages, regions, application layers, or virtually any criteria. Resource Groups enable you to automate management tasks, such as those in Amazon Web Services Systems Manager Automation documents, on tag-related resources in Amazon Web Services Systems Manager. Groups of tagged resources also let you quickly view a custom console in Amazon Web Services Systems Manager that shows Config compliance and other monitoring data about member resources.

To create a resource group, build a resource query, and specify tags that identify the criteria that members of the group have in common. Tags are key-value pairs.

For more information about Resource Groups, see the Resource Groups User Guide.

Resource Groups uses a REST-compliant API that you can use to perform the following types of operations.

Create, Read, Update, and Delete (CRUD) operations on resource groups and resource query entities
Applying, editing, and removing tags from resource groups
Resolving resource group member Amazon resource names (ARN)s so they can be returned as search results
Getting data about resources that are members of a group
Searching Amazon Web Services resources based on a resource query

Inheritance Hierarchy

Amazon.ResourceGroups.IAmazonResourceGroups

Namespace: Amazon.ResourceGroups
Assembly: AWSSDK.ResourceGroups.dll
Version: 3.x.y.z

Syntax

public interface IAmazonResourceGroups
         IAmazonService, IDisposable

The IAmazonResourceGroups type exposes the following members

Properties

	Name	Type	Description
	Paginators	Amazon.ResourceGroups.Model.IResourceGroupsPaginatorFactory	Paginators for the service

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

	Name	Description
	CancelTagSyncTask(CancelTagSyncTaskRequest)	Cancels the specified tag-sync task. Minimum permissions To run this command, you must have the following permissions: `resource-groups:CancelTagSyncTask` on the application group `resource-groups:DeleteGroup`
	CancelTagSyncTaskAsync(CancelTagSyncTaskRequest, CancellationToken)	Cancels the specified tag-sync task. Minimum permissions To run this command, you must have the following permissions: `resource-groups:CancelTagSyncTask` on the application group `resource-groups:DeleteGroup`
	CreateGroup(CreateGroupRequest)	Creates a resource group with the specified name and description. You can optionally include either a resource query or a service configuration. For more information about constructing a resource query, see Build queries and groups in Resource Groups in the Resource Groups User Guide. For more information about service-linked groups and service configurations, see Service configurations for Resource Groups. Minimum permissions To run this command, you must have the following permissions: `resource-groups:CreateGroup`
	CreateGroupAsync(CreateGroupRequest, CancellationToken)	Creates a resource group with the specified name and description. You can optionally include either a resource query or a service configuration. For more information about constructing a resource query, see Build queries and groups in Resource Groups in the Resource Groups User Guide. For more information about service-linked groups and service configurations, see Service configurations for Resource Groups. Minimum permissions To run this command, you must have the following permissions: `resource-groups:CreateGroup`
	DeleteGroup(DeleteGroupRequest)	Deletes the specified resource group. Deleting a resource group does not delete any resources that are members of the group; it only deletes the group structure. Minimum permissions To run this command, you must have the following permissions: `resource-groups:DeleteGroup`
	DeleteGroupAsync(DeleteGroupRequest, CancellationToken)	Deletes the specified resource group. Deleting a resource group does not delete any resources that are members of the group; it only deletes the group structure. Minimum permissions To run this command, you must have the following permissions: `resource-groups:DeleteGroup`
	DetermineServiceOperationEndpoint(AmazonWebServiceRequest)	Returns the endpoint that will be used for a particular request.
	GetAccountSettings(GetAccountSettingsRequest)	Retrieves the current status of optional features in Resource Groups.
	GetAccountSettingsAsync(GetAccountSettingsRequest, CancellationToken)	Retrieves the current status of optional features in Resource Groups.
	GetGroup(GetGroupRequest)	Returns information about a specified resource group. Minimum permissions To run this command, you must have the following permissions: `resource-groups:GetGroup`
	GetGroupAsync(GetGroupRequest, CancellationToken)	Returns information about a specified resource group. Minimum permissions To run this command, you must have the following permissions: `resource-groups:GetGroup`
	GetGroupConfiguration(GetGroupConfigurationRequest)	Retrieves the service configuration associated with the specified resource group. For details about the service configuration syntax, see Service configurations for Resource Groups. Minimum permissions To run this command, you must have the following permissions: `resource-groups:GetGroupConfiguration`
	GetGroupConfigurationAsync(GetGroupConfigurationRequest, CancellationToken)	Retrieves the service configuration associated with the specified resource group. For details about the service configuration syntax, see Service configurations for Resource Groups. Minimum permissions To run this command, you must have the following permissions: `resource-groups:GetGroupConfiguration`
	GetGroupQuery(GetGroupQueryRequest)	Retrieves the resource query associated with the specified resource group. For more information about resource queries, see Create a tag-based group in Resource Groups. Minimum permissions To run this command, you must have the following permissions: `resource-groups:GetGroupQuery`
	GetGroupQueryAsync(GetGroupQueryRequest, CancellationToken)	Retrieves the resource query associated with the specified resource group. For more information about resource queries, see Create a tag-based group in Resource Groups. Minimum permissions To run this command, you must have the following permissions: `resource-groups:GetGroupQuery`
	GetTags(GetTagsRequest)	Returns a list of tags that are associated with a resource group, specified by an Amazon resource name (ARN). Minimum permissions To run this command, you must have the following permissions: `resource-groups:GetTags`
	GetTagsAsync(GetTagsRequest, CancellationToken)	Returns a list of tags that are associated with a resource group, specified by an Amazon resource name (ARN). Minimum permissions To run this command, you must have the following permissions: `resource-groups:GetTags`
	GetTagSyncTask(GetTagSyncTaskRequest)	Returns information about a specified tag-sync task. Minimum permissions To run this command, you must have the following permissions: `resource-groups:GetTagSyncTask` on the application group
	GetTagSyncTaskAsync(GetTagSyncTaskRequest, CancellationToken)	Returns information about a specified tag-sync task. Minimum permissions To run this command, you must have the following permissions: `resource-groups:GetTagSyncTask` on the application group
	GroupResources(GroupResourcesRequest)	Adds the specified resources to the specified group. You can only use this operation with the following groups: `AWS::EC2::HostManagement` `AWS::EC2::CapacityReservationPool` `AWS::ResourceGroups::ApplicationGroup` Other resource group types and resource types are not currently supported by this operation. Minimum permissions To run this command, you must have the following permissions: `resource-groups:GroupResources`
	GroupResourcesAsync(GroupResourcesRequest, CancellationToken)	Adds the specified resources to the specified group. You can only use this operation with the following groups: `AWS::EC2::HostManagement` `AWS::EC2::CapacityReservationPool` `AWS::ResourceGroups::ApplicationGroup` Other resource group types and resource types are not currently supported by this operation. Minimum permissions To run this command, you must have the following permissions: `resource-groups:GroupResources`
	ListGroupingStatuses(ListGroupingStatusesRequest)	Returns the status of the last grouping or ungrouping action for each resource in the specified application group.
	ListGroupingStatusesAsync(ListGroupingStatusesRequest, CancellationToken)	Returns the status of the last grouping or ungrouping action for each resource in the specified application group.
	ListGroupResources(ListGroupResourcesRequest)	Returns a list of Amazon resource names (ARNs) of the resources that are members of a specified resource group. Minimum permissions To run this command, you must have the following permissions: `resource-groups:ListGroupResources` `cloudformation:DescribeStacks` `cloudformation:ListStackResources` `tag:GetResources`
	ListGroupResourcesAsync(ListGroupResourcesRequest, CancellationToken)	Returns a list of Amazon resource names (ARNs) of the resources that are members of a specified resource group. Minimum permissions To run this command, you must have the following permissions: `resource-groups:ListGroupResources` `cloudformation:DescribeStacks` `cloudformation:ListStackResources` `tag:GetResources`
	ListGroups(ListGroupsRequest)	Returns a list of existing Resource Groups in your account. Minimum permissions To run this command, you must have the following permissions: `resource-groups:ListGroups`
	ListGroupsAsync(ListGroupsRequest, CancellationToken)	Returns a list of existing Resource Groups in your account. Minimum permissions To run this command, you must have the following permissions: `resource-groups:ListGroups`
	ListTagSyncTasks(ListTagSyncTasksRequest)	Returns a list of tag-sync tasks. Minimum permissions To run this command, you must have the following permissions: `resource-groups:ListTagSyncTasks` with the group passed in the filters as the resource or * if using no filters
	ListTagSyncTasksAsync(ListTagSyncTasksRequest, CancellationToken)	Returns a list of tag-sync tasks. Minimum permissions To run this command, you must have the following permissions: `resource-groups:ListTagSyncTasks` with the group passed in the filters as the resource or * if using no filters
	PutGroupConfiguration(PutGroupConfigurationRequest)	Attaches a service configuration to the specified group. This occurs asynchronously, and can take time to complete. You can use GetGroupConfiguration to check the status of the update. Minimum permissions To run this command, you must have the following permissions: `resource-groups:PutGroupConfiguration`
	PutGroupConfigurationAsync(PutGroupConfigurationRequest, CancellationToken)	Attaches a service configuration to the specified group. This occurs asynchronously, and can take time to complete. You can use GetGroupConfiguration to check the status of the update. Minimum permissions To run this command, you must have the following permissions: `resource-groups:PutGroupConfiguration`
	SearchResources(SearchResourcesRequest)	Returns a list of Amazon Web Services resource identifiers that matches the specified query. The query uses the same format as a resource query in a CreateGroup or UpdateGroupQuery operation. Minimum permissions To run this command, you must have the following permissions: `resource-groups:SearchResources` `cloudformation:DescribeStacks` `cloudformation:ListStackResources` `tag:GetResources`
	SearchResourcesAsync(SearchResourcesRequest, CancellationToken)	Returns a list of Amazon Web Services resource identifiers that matches the specified query. The query uses the same format as a resource query in a CreateGroup or UpdateGroupQuery operation. Minimum permissions To run this command, you must have the following permissions: `resource-groups:SearchResources` `cloudformation:DescribeStacks` `cloudformation:ListStackResources` `tag:GetResources`
	StartTagSyncTask(StartTagSyncTaskRequest)	Creates a new tag-sync task to onboard and sync resources tagged with a specific tag key-value pair to an application. To start a tag-sync task, you need a resource tagging role. The resource tagging role grants permissions to tag and untag applications resources and must include a trust policy that allows Resource Groups to assume the role and perform resource tagging tasks on your behalf. For instructions on creating a tag-sync task, see Create a tag-sync using the Resource Groups API in the Amazon Web Services Service Catalog AppRegistry Administrator Guide. Minimum permissions To run this command, you must have the following permissions: `resource-groups:StartTagSyncTask` on the application group `resource-groups:CreateGroup` `iam:PassRole` on the role provided in the request
	StartTagSyncTaskAsync(StartTagSyncTaskRequest, CancellationToken)	Creates a new tag-sync task to onboard and sync resources tagged with a specific tag key-value pair to an application. To start a tag-sync task, you need a resource tagging role. The resource tagging role grants permissions to tag and untag applications resources and must include a trust policy that allows Resource Groups to assume the role and perform resource tagging tasks on your behalf. For instructions on creating a tag-sync task, see Create a tag-sync using the Resource Groups API in the Amazon Web Services Service Catalog AppRegistry Administrator Guide. Minimum permissions To run this command, you must have the following permissions: `resource-groups:StartTagSyncTask` on the application group `resource-groups:CreateGroup` `iam:PassRole` on the role provided in the request
	Tag(TagRequest)	Adds tags to a resource group with the specified Amazon resource name (ARN). Existing tags on a resource group are not changed if they are not specified in the request parameters. Do not store personally identifiable information (PII) or other confidential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be used for private or sensitive data. Minimum permissions To run this command, you must have the following permissions: `resource-groups:Tag`
	TagAsync(TagRequest, CancellationToken)	Adds tags to a resource group with the specified Amazon resource name (ARN). Existing tags on a resource group are not changed if they are not specified in the request parameters. Do not store personally identifiable information (PII) or other confidential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be used for private or sensitive data. Minimum permissions To run this command, you must have the following permissions: `resource-groups:Tag`
	UngroupResources(UngroupResourcesRequest)	Removes the specified resources from the specified group. This operation works only with static groups that you populated using the GroupResources operation. It doesn't work with any resource groups that are automatically populated by tag-based or CloudFormation stack-based queries. Minimum permissions To run this command, you must have the following permissions: `resource-groups:UngroupResources`
	UngroupResourcesAsync(UngroupResourcesRequest, CancellationToken)	Removes the specified resources from the specified group. This operation works only with static groups that you populated using the GroupResources operation. It doesn't work with any resource groups that are automatically populated by tag-based or CloudFormation stack-based queries. Minimum permissions To run this command, you must have the following permissions: `resource-groups:UngroupResources`
	Untag(UntagRequest)	Deletes tags from a specified resource group. Minimum permissions To run this command, you must have the following permissions: `resource-groups:Untag`
	UntagAsync(UntagRequest, CancellationToken)	Deletes tags from a specified resource group. Minimum permissions To run this command, you must have the following permissions: `resource-groups:Untag`
	UpdateAccountSettings(UpdateAccountSettingsRequest)	Turns on or turns off optional features in Resource Groups. The preceding example shows that the request to turn on group lifecycle events is `IN_PROGRESS`. You can call the GetAccountSettings operation to check for completion by looking for `GroupLifecycleEventsStatus` to change to `ACTIVE`.
	UpdateAccountSettingsAsync(UpdateAccountSettingsRequest, CancellationToken)	Turns on or turns off optional features in Resource Groups. The preceding example shows that the request to turn on group lifecycle events is `IN_PROGRESS`. You can call the GetAccountSettings operation to check for completion by looking for `GroupLifecycleEventsStatus` to change to `ACTIVE`.
	UpdateGroup(UpdateGroupRequest)	Updates the description for an existing group. You cannot update the name of a resource group. Minimum permissions To run this command, you must have the following permissions: `resource-groups:UpdateGroup`
	UpdateGroupAsync(UpdateGroupRequest, CancellationToken)	Updates the description for an existing group. You cannot update the name of a resource group. Minimum permissions To run this command, you must have the following permissions: `resource-groups:UpdateGroup`
	UpdateGroupQuery(UpdateGroupQueryRequest)	Updates the resource query of a group. For more information about resource queries, see Create a tag-based group in Resource Groups. Minimum permissions To run this command, you must have the following permissions: `resource-groups:UpdateGroupQuery`
	UpdateGroupQueryAsync(UpdateGroupQueryRequest, CancellationToken)	Updates the resource query of a group. For more information about resource queries, see Create a tag-based group in Resource Groups. Minimum permissions To run this command, you must have the following permissions: `resource-groups:UpdateGroupQuery`

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5