CostExplorer / Client / list_cost_category_definitions

list_cost_category_definitions#

CostExplorer.Client.list_cost_category_definitions(**kwargs)#

Returns the name, Amazon Resource Name (ARN), NumberOfRules and effective dates of all Cost Categories defined in the account. You have the option to use EffectiveOn to return a list of Cost Categories that were active on a specific date. If there is no EffectiveOn specified, you’ll see Cost Categories that are effective on the current date. If Cost Category is still effective, EffectiveEnd is omitted in the response. ListCostCategoryDefinitions supports pagination. The request can have a MaxResults range up to 100.

Request Syntax

response = client.list_cost_category_definitions(
    EffectiveOn='string',
    NextToken='string',
    MaxResults=123
)

Parameters:

EffectiveOn (string) – The date when the Cost Category was effective.
NextToken (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.
MaxResults (integer) – The number of entries a paginated response contains.

Return type:

dict

Returns:

Response Syntax

{
    'CostCategoryReferences': [
        {
            'CostCategoryArn': 'string',
            'Name': 'string',
            'EffectiveStart': 'string',
            'EffectiveEnd': 'string',
            'NumberOfRules': 123,
            'ProcessingStatus': [
                {
                    'Component': 'COST_EXPLORER',
                    'Status': 'PROCESSING'|'APPLIED'
                },
            ],
            'Values': [
                'string',
            ],
            'DefaultValue': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- CostCategoryReferences (list) –
  
  A reference to a Cost Category that contains enough information to identify the Cost Category.
  - (dict) –
    
    A reference to a Cost Category containing only enough information to identify the Cost Category.
    
    You can use this information to retrieve the full Cost Category information using DescribeCostCategory.
    - CostCategoryArn (string) –
      
      The unique identifier for your Cost Category.
    - Name (string) –
      
      The unique name of the Cost Category.
    - EffectiveStart (string) –
      
      The Cost Category’s effective start date.
    - EffectiveEnd (string) –
      
      The Cost Category’s effective end date.
    - NumberOfRules (integer) –
      
      The number of rules that are associated with a specific Cost Category.
    - ProcessingStatus (list) –
      
      The list of processing statuses for Cost Management products for a specific cost category.
      - (dict) –
        
        The list of processing statuses for Cost Management products for a specific cost category.
        
        Component (string) –
        
        The Cost Management product name of the applied status.
        
        Status (string) –
        
        The process status for a specific cost category.
    - Values (list) –
      
      A list of unique cost category values in a specific cost category.
      - (string) –
        
        The default value for the cost category.
    - DefaultValue (string) –
      
      The default value for the cost category.
- NextToken (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.

Exceptions

CostExplorer.Client.exceptions.LimitExceededException