Class: Aws::CostExplorer::Types::GetCostAndUsageWithResourcesRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-costexplorer/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#filterTypes::Expression

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][1

‘“SERVICE = Amazon Elastic Compute Cloud - Compute”`

in the filter.

Valid values for ‘MatchOptions` for `Dimensions` are `EQUALS` and `CASE_SENSITIVE`.

Valid values for ‘MatchOptions` for `CostCategories` and `Tags` are `EQUALS`, `ABSENT`, and `CASE_SENSITIVE`. Default values are `EQUALS` and `CASE_SENSITIVE`.

[1]: docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html

Returns:



2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
# File 'lib/aws-sdk-costexplorer/types.rb', line 2384

class GetCostAndUsageWithResourcesRequest < Struct.new(
  :time_period,
  :granularity,
  :filter,
  :metrics,
  :group_by,
  :next_page_token)
  SENSITIVE = []
  include Aws::Structure
end

#granularityString

Sets the Amazon Web Services cost granularity to ‘MONTHLY`, `DAILY`, or `HOURLY`. If `Granularity` isn’t set, the response object doesn’t include the ‘Granularity`, `MONTHLY`, `DAILY`, or `HOURLY`.

Returns:

  • (String)


2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
# File 'lib/aws-sdk-costexplorer/types.rb', line 2384

class GetCostAndUsageWithResourcesRequest < Struct.new(
  :time_period,
  :granularity,
  :filter,
  :metrics,
  :group_by,
  :next_page_token)
  SENSITIVE = []
  include Aws::Structure
end

#group_byArray<Types::GroupDefinition>

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

Returns:



2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
# File 'lib/aws-sdk-costexplorer/types.rb', line 2384

class GetCostAndUsageWithResourcesRequest < Struct.new(
  :time_period,
  :granularity,
  :filter,
  :metrics,
  :group_by,
  :next_page_token)
  SENSITIVE = []
  include Aws::Structure
end

#metricsArray<String>

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`.

<note markdown=“1”> If you return the ‘UsageQuantity` metric, the service aggregates all usage numbers without taking the units into account. For example, if you aggregate `usageQuantity` across all of Amazon EC2, the results aren’t meaningful because Amazon EC2 compute hours and data transfer are measured in different units (for example, hour or GB). To get more meaningful ‘UsageQuantity` metrics, filter by `UsageType` or `UsageTypeGroups`.

</note>

‘Metrics` is required for `GetCostAndUsageWithResources` requests.

[1]: aws.amazon.com/premiumsupport/knowledge-center/blended-rates-intro/

Returns:

  • (Array<String>)


2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
# File 'lib/aws-sdk-costexplorer/types.rb', line 2384

class GetCostAndUsageWithResourcesRequest < Struct.new(
  :time_period,
  :granularity,
  :filter,
  :metrics,
  :group_by,
  :next_page_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_page_tokenString

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

Returns:

  • (String)


2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
# File 'lib/aws-sdk-costexplorer/types.rb', line 2384

class GetCostAndUsageWithResourcesRequest < Struct.new(
  :time_period,
  :granularity,
  :filter,
  :metrics,
  :group_by,
  :next_page_token)
  SENSITIVE = []
  include Aws::Structure
end

#time_periodTypes::DateInterval

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`.

Returns:



2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
# File 'lib/aws-sdk-costexplorer/types.rb', line 2384

class GetCostAndUsageWithResourcesRequest < Struct.new(
  :time_period,
  :granularity,
  :filter,
  :metrics,
  :group_by,
  :next_page_token)
  SENSITIVE = []
  include Aws::Structure
end