listReportsForReportGroup method

Future<ListReportsForReportGroupOutput> listReportsForReportGroup({ required String reportGroupArn, ReportFilter? filter, int? maxResults, String? nextToken, SortOrderType? sortOrder, })

Returns a list of ARNs for the reports that belong to a ReportGroup.

May throw InvalidInputException. May throw ResourceNotFoundException.

Parameter reportGroupArn : The ARN of the report group for which you want to return report ARNs.

Parameter filter : A ReportFilter object used to filter the returned reports.

Parameter maxResults : The maximum number of paginated reports in this report group returned per response. Use nextToken to iterate pages in the list of returned Report 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 sortOrder : Use to specify whether the results are returned in ascending or descending order.

Implementation

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

  return ListReportsForReportGroupOutput.fromJson(jsonResponse.body);
}