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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing GetCostAndUsageWithResourcesRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  time_period: { # required
    start: "YearMonthDay", # required
    end: "YearMonthDay", # required
  },
  granularity: "DAILY", # accepts DAILY, MONTHLY, HOURLY
  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, BILLING_ENTITY, RESERVATION_ID, RESOURCE_ID, RIGHTSIZING_TYPE, SAVINGS_PLANS_TYPE, SAVINGS_PLAN_ARN, PAYMENT_OPTION
      values: ["Value"],
    },
    tags: {
      key: "TagKey",
      values: ["Value"],
    },
    cost_categories: {
      key: "CostCategoryName",
      values: ["Value"],
    },
  },
  metrics: ["MetricName"],
  group_by: [
    {
      type: "DIMENSION", # accepts DIMENSION, TAG, COST_CATEGORY
      key: "GroupDefinitionKey",
    },
  ],
  next_page_token: "NextPageToken",
}

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.

Returns:

#granularityString

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.

Possible values:

  • DAILY
  • MONTHLY
  • HOURLY

Returns:

  • (String)

    Sets the AWS cost granularity to MONTHLY, DAILY, or HOURLY.

#group_byArray<Types::GroupDefinition>

You can group Amazon Web Services costs using up to two different groups: either dimensions, tag keys, or both.

Returns:

  • (Array<Types::GroupDefinition>)

    You can group Amazon Web Services costs using up to two different groups: either dimensions, tag keys, or both.

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

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.

Metrics is required for GetCostAndUsageWithResources requests.

Returns:

  • (Array<String>)

    Which metrics are returned in the query.

#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)

    The token to retrieve the next set of results.

#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:

  • (Types::DateInterval)

    Sets the start and end dates for retrieving Amazon Web Services costs.