getCostAndUsage method

Future<GetCostAndUsageResponse> getCostAndUsage({ required List<String> metrics, required DateInterval timePeriod, Expression? filter, Granularity? granularity, List<GroupDefinition>? groupBy, String? nextPageToken, })

Retrieves cost and usage metrics for your account. You can specify which cost and usage-related metric, such as BlendedCosts or UsageQuantity, that you want the request to return. You can also filter and group your data by various dimensions, such as SERVICE or AZ, in a specific time range. For a complete list of valid dimensions, see the GetDimensionValues operation. Management account in an organization in AWS Organizations have access to all member accounts.

For information about filter limitations, see Quotas and restrictions in the Billing and Cost Management User Guide.

May throw LimitExceededException. May throw BillExpirationException. May throw DataUnavailableException. May throw InvalidNextTokenException. May throw RequestChangedException.

Parameter metrics : Which metrics are returned in the query. For more information about blended and unblended rates, see Why does the "blended" annotation appear on some line items in my bill?.

Valid values are AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost, NormalizedUsageAmount, UnblendedCost, and UsageQuantity. Metrics is required for GetCostAndUsage requests.

Parameter timePeriod : Sets the start and end dates for retrieving AWS costs. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.

Parameter filter : Filters AWS costs by different dimensions. For example, you can specify SERVICE and LINKED_ACCOUNT and get the costs that are associated with that account's usage of that service. You can nest Expression objects to define any combination of dimension filters. For more information, see Expression.

Parameter granularity : Sets the AWS cost granularity to MONTHLY or DAILY, or HOURLY. If Granularity isn't set, the response object doesn't include the Granularity, either MONTHLY or DAILY, or HOURLY.

Parameter groupBy : You can group AWS costs using up to two different groups, either dimensions, tag keys, cost categories, or any two group by types.

When you group by tag key, you get all tag values, including empty strings.

Valid values are AZ, INSTANCE_TYPE, LEGAL_ENTITY_NAME, LINKED_ACCOUNT, OPERATION, PLATFORM, PURCHASE_TYPE, SERVICE, TAGS, TENANCY, RECORD_TYPE, and USAGE_TYPE.

Parameter nextPageToken : The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.

Implementation

Future<GetCostAndUsageResponse> getCostAndUsage({
  required List<String> metrics,
  required DateInterval timePeriod,
  Expression? filter,
  Granularity? granularity,
  List<GroupDefinition>? groupBy,
  String? nextPageToken,
}) async {
  ArgumentError.checkNotNull(metrics, 'metrics');
  ArgumentError.checkNotNull(timePeriod, 'timePeriod');
  _s.validateStringLength(
    'nextPageToken',
    nextPageToken,
    0,
    8192,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AWSInsightsIndexService.GetCostAndUsage'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'Metrics': metrics,
      'TimePeriod': timePeriod,
      if (filter != null) 'Filter': filter,
      if (granularity != null) 'Granularity': granularity.toValue(),
      if (groupBy != null) 'GroupBy': groupBy,
      if (nextPageToken != null) 'NextPageToken': nextPageToken,
    },
  );

  return GetCostAndUsageResponse.fromJson(jsonResponse.body);
}