CostExplorer / Client / get_cost_categories

get_cost_categories#

CostExplorer.Client.get_cost_categories(**kwargs)#

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

response = client.get_cost_categories(
    SearchString='string',
    TimePeriod={
        'Start': 'string',
        'End': 'string'
    },
    CostCategoryName='string',
    Filter={
        'Or': [
            {'... recursive ...'},
        ],
        'And': [
            {'... recursive ...'},
        ],
        'Not': {'... recursive ...'},
        'Dimensions': {
            'Key': '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'|'INVOICING_ENTITY'|'ANOMALY_TOTAL_IMPACT_ABSOLUTE'|'ANOMALY_TOTAL_IMPACT_PERCENTAGE',
            'Values': [
                'string',
            ],
            'MatchOptions': [
                'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE'|'GREATER_THAN_OR_EQUAL',
            ]
        },
        'Tags': {
            'Key': 'string',
            'Values': [
                'string',
            ],
            'MatchOptions': [
                'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE'|'GREATER_THAN_OR_EQUAL',
            ]
        },
        'CostCategories': {
            'Key': 'string',
            'Values': [
                'string',
            ],
            'MatchOptions': [
                'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE'|'GREATER_THAN_OR_EQUAL',
            ]
        }
    },
    SortBy=[
        {
            'Key': 'string',
            'SortOrder': 'ASCENDING'|'DESCENDING'
        },
    ],
    MaxResults=123,
    NextPageToken='string'
)

Parameters:

SearchString (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.
TimePeriod (dict) –
[REQUIRED]

The time period of the request.
- Start (string) – [REQUIRED]
  
  The beginning of the time period. The start date is inclusive. For example, if start is 2017-01-01, Amazon Web Services retrieves cost and usage data starting at 2017-01-01 up to the end date. The start date must be equal to or no later than the current date to avoid a validation error.
- End (string) – [REQUIRED]
  
  The end of the time period. The end date is exclusive. For example, if end is 2017-05-01, Amazon Web Services retrieves cost and usage data from the start date up to, but not including, 2017-05-01.
CostCategoryName (string) – The unique name of the Cost Category.
Filter (dict) –
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.
- Or (list) –
  
  Return results that match either Dimension object.
  - (dict) –
    
    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.
- And (list) –
  
  Return results that match both Dimension objects.
  - (dict) –
    
    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.
- Not (dict) –
  
  Return results that don’t match a Dimension object.
- Dimensions (dict) –
  
  The specific Dimension to use for Expression.
  - Key (string) –
    
    The names of the metadata types that you can use to filter and group your results. For example, AZ returns a list of Availability Zones.
    
    Not all dimensions are supported in each API. Refer to the documentation for each specific API to see what is supported.
    
    LINK_ACCOUNT_NAME and SERVICE_CODE can only be used in CostCategoryRule.
    
    ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE can only be used in AnomalySubscriptions.
  - Values (list) –
    
    The metadata values that you can use to filter and group your results. You can use GetDimensionValues to find specific values.
    - (string) –
  - MatchOptions (list) –
    
    The match options that you can use to filter your results.
    
    MatchOptions is only applicable for actions related to Cost Category and Anomaly Subscriptions. Refer to the documentation for each specific API to see what is supported.
    
    The default values for MatchOptions are EQUALS and CASE_SENSITIVE.
    - (string) –
- Tags (dict) –
  
  The specific Tag to use for Expression.
  - Key (string) –
    
    The key for the tag.
  - Values (list) –
    
    The specific value of the tag.
    - (string) –
  - MatchOptions (list) –
    
    The match options that you can use to filter your results. MatchOptions is only applicable for actions related to Cost Category. The default values for MatchOptions are EQUALS and CASE_SENSITIVE.
    - (string) –
- CostCategories (dict) –
  
  The filter that’s based on CostCategory values.
  - Key (string) –
    
    The unique name of the Cost Category.
  - Values (list) –
    
    The specific value of the Cost Category.
    - (string) –
  - MatchOptions (list) –
    
    The match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is EQUALS and CASE_SENSITIVE.
    - (string) –
SortBy (list) –
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.
- (dict) –
  
  The details for how to sort the data.
  - Key (string) – [REQUIRED]
    
    The key that’s used to sort the data.
  - SortOrder (string) –
    
    The order that’s used to sort the data.
MaxResults (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.
NextPageToken (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.

Return type:

dict

Returns:

Response Syntax

{
    'NextPageToken': 'string',
    'CostCategoryNames': [
        'string',
    ],
    'CostCategoryValues': [
        'string',
    ],
    'ReturnSize': 123,
    'TotalSize': 123
}

Response Structure

(dict) –
- NextPageToken (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 marker from the prior call in your next request.
- CostCategoryNames (list) –
  
  The names of the Cost Categories.
  - (string) –
    
    The unique name of the Cost Category.
- CostCategoryValues (list) –
  
  The Cost Category values.
  
  If the CostCategoryName key isn’t specified in the request, the CostCategoryValues fields aren’t returned.
  - (string) –
    
    The default value for the cost category.
- ReturnSize (integer) –
  
  The number of objects that are returned.
- TotalSize (integer) –
  
  The total number of objects.

Exceptions

CostExplorer.Client.exceptions.LimitExceededException
CostExplorer.Client.exceptions.BillExpirationException
CostExplorer.Client.exceptions.DataUnavailableException
CostExplorer.Client.exceptions.InvalidNextTokenException
CostExplorer.Client.exceptions.RequestChangedException