Class: Aws::CostExplorer::Types::GetCostCategoriesRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cost_category_name ⇒ String

The unique name of the Cost Category.

Returns:

  • (String) 


2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
 
# File 'lib/aws-sdk-costexplorer/types.rb', line 2490

class GetCostCategoriesRequest < Struct.new(
  :search_string,
  :time_period,
  :cost_category_name,
  :filter,
  :sort_by,
  :max_results,
  :next_page_token)
  SENSITIVE = []
  include Aws::Structure
end

#filter ⇒ Types::Expression

Use ‘Expression` to filter in various Cost Explorer APIs.

Not all ‘Expression` types are supported in each API. Refer to the documentation for each specific API to see what is supported.

There are two patterns:

  • Simple dimension values.

    • There are three types of simple dimension values: ‘CostCategories`, `Tags`, and `Dimensions`.

      • Specify the ‘CostCategories` field to define a filter that acts on Cost Categories.

      • Specify the ‘Tags` field to define a filter that acts on Cost Allocation Tags.

      • Specify the ‘Dimensions` field to define a filter that acts on the [ `DimensionValues` ][1].

    • For each filter type, you can set the dimension name and values for the filters that you plan to use.

      • For example, you can filter for ‘REGION==us-east-1 OR REGION==us-west-1`. For `GetRightsizingRecommendation`, the Region is a full name (for example, `REGION==US East (N. Virginia)`.

      • The corresponding ‘Expression` for this example is as follows: `{ “Dimensions”: { “Key”: “REGION”, “Values”: [ “us-east-1”, “us-west-1” ] } }`

      • As shown in the previous example, lists of dimension values are combined with ‘OR` when applying the filter.

    • You can also set different match options to further control how the filter behaves. Not all APIs support match options. Refer to the documentation for each specific API to see what is supported.

      • For example, you can filter for linked account names that start with “a”.

      • The corresponding ‘Expression` for this example is as follows: `{ “Dimensions”: { “Key”: “LINKED_ACCOUNT_NAME”, “MatchOptions”: [ “STARTS_WITH” ], “Values”: [ “a” ] } }`

  • Compound ‘Expression` types with logical operations.

    • You can use multiple ‘Expression` types and the logical operators `AND/OR/NOT` to create a list of one or more `Expression` objects. By doing this, you can filter by more advanced options.

    • For example, you can filter by ‘((REGION == us-east-1 OR REGION

      us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE !=

      DataTransfer)‘.

    • The corresponding ‘Expression` for this example is as follows: `{ “And”: [ [ {“Dimensions”: { “Key”: “REGION”, “Values”: [ “us-east-1”, “us-west-1” ] }, {“Tags”: { “Key”: “TagName”, “Values”: [“Value1”] } } ]}, {“Dimensions”: { “Key”: “USAGE_TYPE”, “Values”:

      “DataTransfer”

      }} ] } ‘

    <note markdown=“1”> Because each ‘Expression` can have only one operator, the service returns an error if more than one is specified. The following example shows an `Expression` object that creates an error: ` { “And”: [ … ], “Dimensions”: { “Key”: “USAGE_TYPE”, “Values”: [ “DataTransfer” ] } } `

    The following is an example of the corresponding error message:

    ‘“Expression has more than one roots. Only one root operator is allowed for each expression: And, Or, Not, Dimensions, Tags, CostCategories”`

    </note>

<note markdown=“1”> For the ‘GetRightsizingRecommendation` action, a combination of OR and NOT isn’t supported. OR isn’t supported between different dimensions, or dimensions and tags. NOT operators aren’t supported. Dimensions are also limited to ‘LINKED_ACCOUNT`, `REGION`, or `RIGHTSIZING_TYPE`.

For the `GetReservationPurchaseRecommendation` action, only NOT is

supported. AND and OR aren’t supported. Dimensions are limited to ‘LINKED_ACCOUNT`.

</note>

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

Returns:



2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
 
# File 'lib/aws-sdk-costexplorer/types.rb', line 2490

class GetCostCategoriesRequest < Struct.new(
  :search_string,
  :time_period,
  :cost_category_name,
  :filter,
  :sort_by,
  :max_results,
  :next_page_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

This field is only used when the ‘SortBy` value is provided in the request.

The maximum number of objects that are returned for this request. If ‘MaxResults` isn’t specified with the ‘SortBy` value, the request returns 1000 results as the default value for this parameter.

For ‘GetCostCategories`, MaxResults has an upper quota of 1000.

Returns:

  • (Integer) 


2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
 
# File 'lib/aws-sdk-costexplorer/types.rb', line 2490

class GetCostCategoriesRequest < Struct.new(
  :search_string,
  :time_period,
  :cost_category_name,
  :filter,
  :sort_by,
  :max_results,
  :next_page_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_page_token ⇒ String

If the number of objects that are still available for retrieval exceeds the quota, Amazon Web Services returns a NextPageToken value in the response. To retrieve the next batch of objects, provide the NextPageToken from the previous call in your next request.

Returns:

  • (String) 


2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
 
# File 'lib/aws-sdk-costexplorer/types.rb', line 2490

class GetCostCategoriesRequest < Struct.new(
  :search_string,
  :time_period,
  :cost_category_name,
  :filter,
  :sort_by,
  :max_results,
  :next_page_token)
  SENSITIVE = []
  include Aws::Structure
end

#search_string ⇒ String

The value that you want to search the filter values for.

If you don’t specify a ‘CostCategoryName`, `SearchString` is used to filter Cost Category names that match the `SearchString` pattern. If you specify a `CostCategoryName`, `SearchString` is used to filter Cost Category values that match the `SearchString` pattern.

Returns:

  • (String) 


2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
 
# File 'lib/aws-sdk-costexplorer/types.rb', line 2490

class GetCostCategoriesRequest < Struct.new(
  :search_string,
  :time_period,
  :cost_category_name,
  :filter,
  :sort_by,
  :max_results,
  :next_page_token)
  SENSITIVE = []
  include Aws::Structure
end

#sort_by ⇒ Array<Types::SortDefinition>

The value that you sort the data by.

The key represents the cost and usage metrics. The following values are supported:

  • ‘BlendedCost`

  • ‘UnblendedCost`

  • ‘AmortizedCost`

  • ‘NetAmortizedCost`

  • ‘NetUnblendedCost`

  • ‘UsageQuantity`

  • ‘NormalizedUsageAmount`

The supported key values for the ‘SortOrder` value are `ASCENDING` and `DESCENDING`.

When you use the ‘SortBy` value, the `NextPageToken` and `SearchString` key values aren’t supported.

Returns:



2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
 
# File 'lib/aws-sdk-costexplorer/types.rb', line 2490

class GetCostCategoriesRequest < Struct.new(
  :search_string,
  :time_period,
  :cost_category_name,
  :filter,
  :sort_by,
  :max_results,
  :next_page_token)
  SENSITIVE = []
  include Aws::Structure
end

#time_period ⇒ Types::DateInterval

The time period of the request.

Returns:



2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
 
# File 'lib/aws-sdk-costexplorer/types.rb', line 2490

class GetCostCategoriesRequest < Struct.new(
  :search_string,
  :time_period,
  :cost_category_name,
  :filter,
  :sort_by,
  :max_results,
  :next_page_token)
  SENSITIVE = []
  include Aws::Structure
end