listGroups method

Future<ListGroupsOutput> listGroups({ List<GroupFilter>? filters, int? maxResults, String? nextToken, })

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

May throw BadRequestException. May throw ForbiddenException. May throw InternalServerErrorException. May throw MethodNotAllowedException. May throw TooManyRequestsException.

Parameter 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::ApplicationResourceGroup
  • AWS::CloudFormation::Stack
  • AWS::EC2::CapacityReservationPool
  • AWS::EC2::HostManagement
  • AWS::NetworkFirewall::RuleGroup

Parameter 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.

Parameter 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.

Implementation

Future<ListGroupsOutput> listGroups({
  List<GroupFilter>? filters,
  int? maxResults,
  String? nextToken,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    50,
  );
  final $query = <String, List<String>>{
    if (maxResults != null) 'maxResults': [maxResults.toString()],
    if (nextToken != null) 'nextToken': [nextToken],
  };
  final $payload = <String, dynamic>{
    if (filters != null) 'Filters': filters,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'POST',
    requestUri: '/groups-list',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return ListGroupsOutput.fromJson(response);
}