getConsolidatedReport method

Future<GetConsolidatedReportOutput> getConsolidatedReport({
  1. required ReportFormat format,
  2. bool? includeSharedResources,
  3. int? maxResults,
  4. String? nextToken,
})

Get a consolidated report of your workloads.

You can optionally choose to include workloads that have been shared with you.

May throw AccessDeniedException. May throw ConflictException. May throw InternalServerException. May throw ThrottlingException. May throw ValidationException.

Parameter format : The format of the consolidated report.

For PDF, Base64String is returned. For JSON, Metrics is returned.

Parameter includeSharedResources : Set to true to have shared resources included in the report.

Parameter maxResults : The maximum number of results to return for this request.

Implementation

Future<GetConsolidatedReportOutput> getConsolidatedReport({
  required ReportFormat format,
  bool? includeSharedResources,
  int? maxResults,
  String? nextToken,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    15,
  );
  final $query = <String, List<String>>{
    'Format': [format.value],
    if (includeSharedResources != null)
      'IncludeSharedResources': [includeSharedResources.toString()],
    if (maxResults != null) 'MaxResults': [maxResults.toString()],
    if (nextToken != null) 'NextToken': [nextToken],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri: '/consolidatedReport',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return GetConsolidatedReportOutput.fromJson(response);
}