You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CostExplorer::Types::GetCostAndUsageRequest

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

Overview

Note:

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

{
  time_period: {
    start: "YearMonthDay", # required
    end: "YearMonthDay", # required
  },
  granularity: "DAILY", # accepts DAILY, MONTHLY
  filter: {
    or: [
      {
        # recursive Expression
      },
    ],
    and: [
      {
        # recursive Expression
      },
    ],
    not: {
      # recursive Expression
    },
    dimensions: {
      key: "AZ", # accepts AZ, INSTANCE_TYPE, LINKED_ACCOUNT, OPERATION, PURCHASE_TYPE, REGION, SERVICE, 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
      values: ["Value"],
    },
    tags: {
      key: "TagKey",
      values: ["Value"],
    },
  },
  metrics: ["MetricName"],
  group_by: [
    {
      type: "DIMENSION", # accepts DIMENSION, TAG
      key: "GroupDefinitionKey",
    },
  ],
  next_page_token: "NextPageToken",
}

Instance Attribute Summary collapse

Instance Attribute Details

#filterTypes::Expression

Filters AWS costs by different dimensions. For example, you can specify SERVICE and LINKED_ACCOUNT and get the costs 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.

Returns:



417
418
419
420
421
422
423
424
425
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 417

class GetCostAndUsageRequest < Struct.new(
  :time_period,
  :granularity,
  :filter,
  :metrics,
  :group_by,
  :next_page_token)
  include Aws::Structure
end

#granularityString

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

Returns:

  • (String)


417
418
419
420
421
422
423
424
425
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 417

class GetCostAndUsageRequest < Struct.new(
  :time_period,
  :granularity,
  :filter,
  :metrics,
  :group_by,
  :next_page_token)
  include Aws::Structure
end

#group_byArray<Types::GroupDefinition>

You can group AWS costs using up to two different groups, either dimensions, tag keys, or both.

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

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

Returns:



417
418
419
420
421
422
423
424
425
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 417

class GetCostAndUsageRequest < Struct.new(
  :time_period,
  :granularity,
  :filter,
  :metrics,
  :group_by,
  :next_page_token)
  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 BlendedCost, UnblendedCost, and UsageQuantity.

If you return the UsageQuantity metric, the service aggregates all usage numbers without taking into account the units. For example, if you aggregate usageQuantity across all of EC2, the results aren't meaningful because 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.

Returns:

  • (Array<String>)


417
418
419
420
421
422
423
424
425
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 417

class GetCostAndUsageRequest < Struct.new(
  :time_period,
  :granularity,
  :filter,
  :metrics,
  :group_by,
  :next_page_token)
  include Aws::Structure
end

#next_page_tokenString

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)


417
418
419
420
421
422
423
424
425
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 417

class GetCostAndUsageRequest < Struct.new(
  :time_period,
  :granularity,
  :filter,
  :metrics,
  :group_by,
  :next_page_token)
  include Aws::Structure
end

#time_periodTypes::DateInterval

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.

Returns:



417
418
419
420
421
422
423
424
425
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 417

class GetCostAndUsageRequest < Struct.new(
  :time_period,
  :granularity,
  :filter,
  :metrics,
  :group_by,
  :next_page_token)
  include Aws::Structure
end