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

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

Overview

Note:

When making an API call, you may pass GetCostAndUsageWithResourcesRequest data as a hash:

{
  time_period: { # required
    start: "YearMonthDay", # required
    end: "YearMonthDay", # required
  },
  granularity: "DAILY", # required, accepts DAILY, MONTHLY, HOURLY
  filter: { # required
    or: [
      {
        # recursive Expression
      },
    ],
    and: [
      {
        # recursive Expression
      },
    ],
    not: {
      # recursive Expression
    },
    dimensions: {
      key: "AZ", # accepts AZ, INSTANCE_TYPE, LINKED_ACCOUNT, LINKED_ACCOUNT_NAME, OPERATION, PURCHASE_TYPE, REGION, SERVICE, SERVICE_CODE, USAGE_TYPE, USAGE_TYPE_GROUP, RECORD_TYPE, OPERATING_SYSTEM, TENANCY, SCOPE, PLATFORM, SUBSCRIPTION_ID, LEGAL_ENTITY_NAME, DEPLOYMENT_OPTION, DATABASE_ENGINE, CACHE_ENGINE, INSTANCE_TYPE_FAMILY, BILLING_ENTITY, RESERVATION_ID, RESOURCE_ID, RIGHTSIZING_TYPE, SAVINGS_PLANS_TYPE, SAVINGS_PLAN_ARN, PAYMENT_OPTION, AGREEMENT_END_DATE_TIME_AFTER, AGREEMENT_END_DATE_TIME_BEFORE
      values: ["Value"],
      match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
    },
    tags: {
      key: "TagKey",
      values: ["Value"],
      match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
    },
    cost_categories: {
      key: "CostCategoryName",
      values: ["Value"],
      match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
    },
  },
  metrics: ["MetricName"],
  group_by: [
    {
      type: "DIMENSION", # accepts DIMENSION, TAG, COST_CATEGORY
      key: "GroupDefinitionKey",
    },
  ],
  next_page_token: "NextPageToken",
}

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ Types::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.

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

Returns:



2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
 
# File 'lib/aws-sdk-costexplorer/types.rb', line 2284

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

#granularity ⇒ String

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

Returns:

  • (String) 


2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
 
# File 'lib/aws-sdk-costexplorer/types.rb', line 2284

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

#group_by ⇒ Array<Types::GroupDefinition>

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

Returns:



2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
 
# File 'lib/aws-sdk-costexplorer/types.rb', line 2284

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

#metrics ⇒ Array<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, hours vs. 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>) 


2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
 
# File 'lib/aws-sdk-costexplorer/types.rb', line 2284

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

#next_page_token ⇒ String

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.

Returns:

  • (String) 


2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
 
# File 'lib/aws-sdk-costexplorer/types.rb', line 2284

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

#time_period ⇒ Types::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:



2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
 
# File 'lib/aws-sdk-costexplorer/types.rb', line 2284

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