listSharedReportGroups method

Future<ListSharedReportGroupsOutput> listSharedReportGroups({ int? maxResults, String? nextToken, SharedResourceSortByType? sortBy, SortOrderType? sortOrder, })

Gets a list of report groups that are shared with other AWS accounts or users.

May throw InvalidInputException.

Parameter maxResults : The maximum number of paginated shared report groups 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 report groups shared with the current AWS account or user. Valid values include:

• ARN: List based on the ARN.
• MODIFIED_TIME: List based on when information about the shared report group was last changed.

Parameter sortOrder : The order in which to list shared report groups. Valid values include:

• ASCENDING: List in ascending order.
• DESCENDING: List in descending order.

Implementation

Future<ListSharedReportGroupsOutput> listSharedReportGroups({
  int? maxResults,
  String? nextToken,
  SharedResourceSortByType? 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.ListSharedReportGroups'
  };
  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 ListSharedReportGroupsOutput.fromJson(jsonResponse.body);
}