getCostAndUsageWithResources method

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

Retrieves cost and usage metrics with resources 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. This API is currently available for the Amazon Elastic Compute Cloud – Compute service only.

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

Parameter filter : Filters Amazon Web Services 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.

The GetCostAndUsageWithResources operation requires that you either group by or filter by a ResourceId. It requires the Expression "SERVICE = Amazon Elastic Compute Cloud - Compute" in the filter.

Parameter timePeriod : Sets the start and end dates for retrieving Amazon Web Services costs. The range must be within the last 14 days (the start date cannot be earlier than 14 days ago). 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 granularity : Sets the AWS cost granularity to MONTHLY, DAILY, or HOURLY. If Granularity isn't set, the response object doesn't include the Granularity, MONTHLY, DAILY, or HOURLY.

Parameter groupBy : You can group Amazon Web Services costs using up to two different groups: DIMENSION, TAG, COST_CATEGORY.

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 GetCostAndUsageWithResources requests.

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<GetCostAndUsageWithResourcesResponse> getCostAndUsageWithResources({
  required Expression filter,
  required DateInterval timePeriod,
  Granularity? granularity,
  List<GroupDefinition>? groupBy,
  List<String>? metrics,
  String? nextPageToken,
}) async {
  ArgumentError.checkNotNull(filter, 'filter');
  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.GetCostAndUsageWithResources'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'Filter': filter,
      'TimePeriod': timePeriod,
      if (granularity != null) 'Granularity': granularity.toValue(),
      if (groupBy != null) 'GroupBy': groupBy,
      if (metrics != null) 'Metrics': metrics,
      if (nextPageToken != null) 'NextPageToken': nextPageToken,
    },
  );

  return GetCostAndUsageWithResourcesResponse.fromJson(jsonResponse.body);
}