listReportGroups method

Future<ListReportGroupsOutput> listReportGroups({ int? maxResults, String? nextToken, ReportGroupSortByType? sortBy, SortOrderType? sortOrder, })

Gets a list ARNs for the report groups in the current AWS account.

May throw InvalidInputException.

Parameter maxResults : The maximum number of paginated report groups returned per response. Use nextToken to iterate pages in the list of returned ReportGroup objects. The default value is 100.

Parameter nextToken : During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

Parameter sortBy : The criterion to be used to list build report groups. Valid values include:

• CREATED_TIME: List based on when each report group was created.
• LAST_MODIFIED_TIME: List based on when each report group was last changed.
• NAME: List based on each report group's name.

Parameter sortOrder : Used to specify the order to sort the list of returned report groups. Valid values are ASCENDING and DESCENDING.

Implementation

Future<ListReportGroupsOutput> listReportGroups({
  int? maxResults,
  String? nextToken,
  ReportGroupSortByType? sortBy,
  SortOrderType? sortOrder,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    100,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'CodeBuild_20161006.ListReportGroups'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      if (maxResults != null) 'maxResults': maxResults,
      if (nextToken != null) 'nextToken': nextToken,
      if (sortBy != null) 'sortBy': sortBy.toValue(),
      if (sortOrder != null) 'sortOrder': sortOrder.toValue(),
    },
  );

  return ListReportGroupsOutput.fromJson(jsonResponse.body);
}