AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the ListGroups operation. Returns a list of existing Resource Groups in your account.

Minimum permissions

To run this command, you must have the following permissions:

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.ResourceGroups.AmazonResourceGroupsRequest
      Amazon.ResourceGroups.Model.ListGroupsRequest

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

Syntax

C#
public class ListGroupsRequest : AmazonResourceGroupsRequest
         IAmazonWebServiceRequest

The ListGroupsRequest type exposes the following members

Constructors

NameDescription
Public Method ListGroupsRequest()

Properties

NameTypeDescription
Public Property Filters System.Collections.Generic.List<Amazon.ResourceGroups.Model.GroupFilter>

Gets and sets the property Filters.

Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation.

  • resource-type - Filter the results to include only those resource groups that have the specified resource type in their ResourceTypeFilter. For example, AWS::EC2::Instance would return any resource group with a ResourceTypeFilter that includes AWS::EC2::Instance.

  • configuration-type - Filter the results to include only those groups that have the specified configuration types attached. The current supported values are:

    • AWS::ResourceGroups::ApplicationGroup

    • AWS::AppRegistry::Application

    • AWS::AppRegistry::ApplicationResourceGroups

    • AWS::CloudFormation::Stack

    • AWS::EC2::CapacityReservationPool

    • AWS::EC2::HostManagement

    • AWS::NetworkFirewall::RuleGroup

Public Property MaxResults System.Int32

Gets and sets the property MaxResults.

The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Public Property NextToken System.String

Gets and sets the property NextToken.

The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value provided by a previous call's NextToken response to indicate where the output should continue from.

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