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

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 GetCostCategoriesRequest data as a hash:

{
  search_string: "SearchString",
  time_period: { # required
    start: "YearMonthDay", # required
    end: "YearMonthDay", # required
  },
  cost_category_name: "CostCategoryName",
  filter: {
    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
    },
  },
  sort_by: [
    {
      key: "SortDefinitionKey", # required
      sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
    },
  ],
  max_results: 1,
  next_page_token: "NextPageToken",
}

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) 


2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
 
# File 'lib/aws-sdk-costexplorer/types.rb', line 2495

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 by cost or by usage. There are two patterns:

  • Simple dimension values - 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 `Expression` example looks like:

    ‘{ “Dimensions”: { “Key”: “REGION”, “Values”: [ “us-east-1”, “us-west-1” ] } }`

    The list of dimension values are OR’d together to retrieve cost or usage data. You can create ‘Expression` and `DimensionValues` objects using either `with*` methods or `set*` methods in multiple lines.

  • Compound dimension values 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. This allows you to filter on more advanced options. For example, you can filter on `((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer)`. The `Expression` for that looks like this:

    ‘{ “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.

    </note>

    ‘ { “And”: [ … ], “DimensionValues”: { “Dimension”: “USAGE_TYPE”, “Values”: [ “DataTransfer” ] } } `

<note markdown=“1”> For the ‘GetRightsizingRecommendation` action, a combination of OR and NOT is not supported. OR is not 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 are not supported. Dimensions are limited to ‘LINKED_ACCOUNT`.

</note>

Returns:



2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
 
# File 'lib/aws-sdk-costexplorer/types.rb', line 2495

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 ‘SortBy` is provided in the request.

The maximum number of objects that to be returned for this request. If ‘MaxResults` is not specified with `SortBy`, the request will return 1000 results as the default value for this parameter.

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

Returns:

  • (Integer) 


2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
 
# File 'lib/aws-sdk-costexplorer/types.rb', line 2495

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 limit, AWS returns a NextPageToken value in the response. To retrieve the next batch of objects, provide the NextPageToken from the prior call in your next request.

Returns:

  • (String) 


2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
 
# File 'lib/aws-sdk-costexplorer/types.rb', line 2495

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 do not specify a ‘CostCategoryName`, `SearchString` will be used to filter Cost Category names that match the `SearchString` pattern. If you do specifiy a `CostCategoryName`, `SearchString` will be used to filter Cost Category values that match the `SearchString` pattern.

Returns:

  • (String) 


2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
 
# File 'lib/aws-sdk-costexplorer/types.rb', line 2495

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 by which you want to sort the data.

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

  • ‘BlendedCost`

  • ‘UnblendedCost`

  • ‘AmortizedCost`

  • ‘NetAmortizedCost`

  • ‘NetUnblendedCost`

  • ‘UsageQuantity`

  • ‘NormalizedUsageAmount`

Supported values for ‘SortOrder` are `ASCENDING` or `DESCENDING`.

When using ‘SortBy`, `NextPageToken` and `SearchString` are not supported.

Returns:



2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
 
# File 'lib/aws-sdk-costexplorer/types.rb', line 2495

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:



2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
 
# File 'lib/aws-sdk-costexplorer/types.rb', line 2495

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