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

Inherits:

Struct

• Object
• Struct
• Aws::CostExplorer::Types::GetCostAndUsageRequest

Includes:

Structure

Defined in:

lib/aws-sdk-costexplorer/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #billing_view_arn ⇒ String

  The Amazon Resource Name (ARN) that uniquely identifies a specific billing view.

• #filter ⇒ Types::Expression

  Filters Amazon Web Services costs by different dimensions.

• #granularity ⇒ String

  Sets the Amazon Web Services cost granularity to MONTHLY or DAILY, or HOURLY.

• #group_by ⇒ Array<Types::GroupDefinition>

  You can group Amazon Web Services costs using up to two different groups, either dimensions, tag keys, cost categories, or any two group by types.

• #metrics ⇒ Array<String>

  Which metrics are returned in the query.

• #next_page_token ⇒ String

  The token to retrieve the next set of results.

• #time_period ⇒ Types::DateInterval

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

Instance Attribute Details

#billing_view_arn ⇒ String

The Amazon Resource Name (ARN) that uniquely identifies a specific billing view. The ARN is used to specify which particular billing view you want to interact with or retrieve information from when making API calls related to Amazon Web Services Billing and Cost Management features. The BillingViewArn can be retrieved by calling the ListBillingViews API.

# File 'lib/aws-sdk-costexplorer/types.rb', line 2906

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

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

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

# File 'lib/aws-sdk-costexplorer/types.rb', line 2906

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

#granularity ⇒ String

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

# File 'lib/aws-sdk-costexplorer/types.rb', line 2906

class GetCostAndUsageRequest < Struct.new(
  :time_period,
  :granularity,
  :filter,
  :metrics,
  :group_by,
  :billing_view_arn,
  :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, either dimensions, tag keys, cost categories, or any two group by types.

Valid values for the DIMENSION type are AZ, INSTANCE_TYPE, LEGAL_ENTITY_NAME, INVOICING_ENTITY, LINKED_ACCOUNT, OPERATION, PLATFORM, PURCHASE_TYPE, SERVICE, TENANCY, RECORD_TYPE, and USAGE_TYPE.

When you group by the TAG type and include a valid tag key, you get all tag values, including empty strings.

# File 'lib/aws-sdk-costexplorer/types.rb', line 2906

class GetCostAndUsageRequest < Struct.new(
  :time_period,
  :granularity,
  :filter,
  :metrics,
  :group_by,
  :billing_view_arn,
  :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 into account the units. 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 and GB). To get more meaningful UsageQuantity metrics, filter by UsageType or UsageTypeGroups.

</note>

Metrics is required for GetCostAndUsage requests.

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

# File 'lib/aws-sdk-costexplorer/types.rb', line 2906

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

#next_page_token ⇒ String

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.

# File 'lib/aws-sdk-costexplorer/types.rb', line 2906

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

#time_period ⇒ Types::DateInterval

Sets the start date and end date for retrieving Amazon Web Services 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.

# File 'lib/aws-sdk-costexplorer/types.rb', line 2906

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