Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetCostCategories

Retrieves an array of Cost Category names and values incurred cost.

Note

If some Cost Category names and values are not associated with any cost, they will not be returned by this API.

Request Syntax


{
   "CostCategoryName": "string",
   "Filter": { 
      "And": [ 
         "Expression"
      ],
      "CostCategories": { 
         "Key": "string",
         "MatchOptions": [ "string" ],
         "Values": [ "string" ]
      },
      "Dimensions": { 
         "Key": "string",
         "MatchOptions": [ "string" ],
         "Values": [ "string" ]
      },
      "Not": "Expression",
      "Or": [ 
         "Expression"
      ],
      "Tags": { 
         "Key": "string",
         "MatchOptions": [ "string" ],
         "Values": [ "string" ]
      }
   },
   "MaxResults": number,
   "NextPageToken": "string",
   "SearchString": "string",
   "SortBy": [ 
      { 
         "Key": "string",
         "SortOrder": "string"
      }
   ],
   "TimePeriod": { 
      "End": "string",
      "Start": "string"
   }
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

CostCategoryName

The unique name of the Cost Category.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 50.

Pattern: ^(?! )[\p{L}\p{N}\p{Z}-_]*(?<! )$

Required: No

Filter

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.
- 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": [ {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName", "Values": ["Value1"] } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE", "Values": ["DataTransfer"] }}} ] }
Note
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

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.

Type: Expression object

Required: No

MaxResults

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.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

NextPageToken

If the number of objects that are still available for retrieval exceeds the quota, Amazon 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.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 8192.

Pattern: [\S\s]*

Required: No

SearchString

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.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: [\S\s]*

Required: No

SortBy

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.

Type: Array of SortDefinition objects

Required: No

TimePeriod

The time period of the request.

Type: DateInterval object

Required: Yes

Response Syntax


{
   "CostCategoryNames": [ "string" ],
   "CostCategoryValues": [ "string" ],
   "NextPageToken": "string",
   "ReturnSize": number,
   "TotalSize": number
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

CostCategoryNames

The names of the Cost Categories.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 50.

Pattern: ^(?! )[\p{L}\p{N}\p{Z}-_]*(?<! )$

CostCategoryValues

The Cost Category values.

If the CostCategoryName key isn't specified in the request, the CostCategoryValues fields aren't returned.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 50.

Pattern: ^(?! )[\p{L}\p{N}\p{Z}-_]*(?<! )$

NextPageToken

Type: String

Length Constraints: Minimum length of 0. Maximum length of 8192.

Pattern: [\S\s]*

ReturnSize

The number of objects that are returned.

Type: Integer

TotalSize

The total number of objects.

Type: Integer

Errors

For information about the errors that are common to all actions, see Common Errors.

BillExpirationException

The requested report expired. Update the date interval and try again.

HTTP Status Code: 400

DataUnavailableException

The requested data is unavailable.

HTTP Status Code: 400

InvalidNextTokenException

The pagination token is invalid. Try again without a pagination token.

HTTP Status Code: 400

LimitExceededException

You made too many calls in a short period of time. Try again later.

HTTP Status Code: 400

RequestChangedException

Your request parameters changed between pages. Try again with the old parameters or without a pagination token.

HTTP Status Code: 400