CostExplorer / Client / describe_cost_category_definition
describe_cost_category_definition#
- CostExplorer.Client.describe_cost_category_definition(**kwargs)#
Returns the name, Amazon Resource Name (ARN), rules, definition, and effective dates of a Cost Category that’s defined in the account.
You have the option to use
EffectiveOn
to return a Cost Category that’s active on a specific date. If there’s noEffectiveOn
specified, you see a Cost Category that’s effective on the current date. If Cost Category is still effective,EffectiveEnd
is omitted in the response.See also: AWS API Documentation
Request Syntax
response = client.describe_cost_category_definition( CostCategoryArn='string', EffectiveOn='string' )
- Parameters:
CostCategoryArn (string) –
[REQUIRED]
The unique identifier for your Cost Category.
EffectiveOn (string) – The date when the Cost Category was effective.
- Return type:
dict
- Returns:
Response Syntax
{ 'CostCategory': { 'CostCategoryArn': 'string', 'EffectiveStart': 'string', 'EffectiveEnd': 'string', 'Name': 'string', 'RuleVersion': 'CostCategoryExpression.v1', 'Rules': [ { 'Value': 'string', 'Rule': { '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', ] } }, 'InheritedValue': { 'DimensionName': 'LINKED_ACCOUNT_NAME'|'TAG', 'DimensionKey': 'string' }, 'Type': 'REGULAR'|'INHERITED_VALUE' }, ], 'SplitChargeRules': [ { 'Source': 'string', 'Targets': [ 'string', ], 'Method': 'FIXED'|'PROPORTIONAL'|'EVEN', 'Parameters': [ { 'Type': 'ALLOCATION_PERCENTAGES', 'Values': [ 'string', ] }, ] }, ], 'ProcessingStatus': [ { 'Component': 'COST_EXPLORER', 'Status': 'PROCESSING'|'APPLIED' }, ], 'DefaultValue': 'string' } }
Response Structure
(dict) –
CostCategory (dict) –
The structure of Cost Categories. This includes detailed metadata and the set of rules for the
CostCategory
object.CostCategoryArn (string) –
The unique identifier for your Cost Category.
EffectiveStart (string) –
The effective start date of your Cost Category.
EffectiveEnd (string) –
The effective end date of your Cost Category.
Name (string) –
The unique name of the Cost Category.
RuleVersion (string) –
The rule schema version in this particular Cost Category.
Rules (list) –
The rules are processed in order. If there are multiple rules that match the line item, then the first rule to match is used to determine that Cost Category value.
(dict) –
Rules are processed in order. If there are multiple rules that match the line item, then the first rule to match is used to determine that Cost Category value.
Value (string) –
The default value for the cost category.
Rule (dict) –
An Expression object used to categorize costs. This supports dimensions, tags, and nested expressions. Currently the only dimensions supported are
LINKED_ACCOUNT
,SERVICE_CODE
,RECORD_TYPE
,LINKED_ACCOUNT_NAME
,REGION
, andUSAGE_TYPE
.RECORD_TYPE
is a dimension used for Cost Explorer APIs, and is also supported for Cost Category expressions. This dimension uses different terms, depending on whether you’re using the console or API/JSON editor. For a detailed comparison, see Term Comparisons in the Billing and Cost Management User Guide.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
, andDimensions
.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
. ForGetRightsizingRecommendation
, 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 operatorsAND/OR/NOT
to create a list of one or moreExpression
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 anExpression
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 toLINKED_ACCOUNT
,REGION
, orRIGHTSIZING_TYPE
.For the
GetReservationPurchaseRecommendation
action, only NOT is supported. AND and OR aren’t supported. Dimensions are limited toLINKED_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
, andDimensions
.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
. ForGetRightsizingRecommendation
, 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 operatorsAND/OR/NOT
to create a list of one or moreExpression
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 anExpression
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 toLINKED_ACCOUNT
,REGION
, orRIGHTSIZING_TYPE
.For the
GetReservationPurchaseRecommendation
action, only NOT is supported. AND and OR aren’t supported. Dimensions are limited toLINKED_ACCOUNT
.
Not (dict) –
Return results that don’t match a
Dimension
object.Dimensions (dict) –
The specific
Dimension
to use forExpression
.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
andSERVICE_CODE
can only be used in CostCategoryRule.ANOMALY_TOTAL_IMPACT_ABSOLUTE
andANOMALY_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
areEQUALS
andCASE_SENSITIVE
.(string) –
Tags (dict) –
The specific
Tag
to use forExpression
.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 forMatchOptions
areEQUALS
andCASE_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
isEQUALS
andCASE_SENSITIVE
.(string) –
InheritedValue (dict) –
The value the line item is categorized as if the line item contains the matched dimension.
DimensionName (string) –
The name of the dimension that’s used to group costs.
If you specify
LINKED_ACCOUNT_NAME
, the cost category value is based on account name. If you specifyTAG
, the cost category value is based on the value of the specified tag key.DimensionKey (string) –
The key to extract cost category values.
Type (string) –
You can define the
CostCategoryRule
rule type as eitherREGULAR
orINHERITED_VALUE
. TheINHERITED_VALUE
rule type adds the flexibility to define a rule that dynamically inherits the cost category value. This value is from the dimension value that’s defined byCostCategoryInheritedValueDimension
. For example, suppose that you want to costs to be dynamically grouped based on the value of a specific tag key. First, choose an inherited value rule type, and then choose the tag dimension and specify the tag key to use.
SplitChargeRules (list) –
The split charge rules that are used to allocate your charges between your Cost Category values.
(dict) –
Use the split charge rule to split the cost of one Cost Category value across several other target values.
Source (string) –
The Cost Category value that you want to split. That value can’t be used as a source or a target in other split charge rules. To indicate uncategorized costs, you can use an empty string as the source.
Targets (list) –
The Cost Category values that you want to split costs across. These values can’t be used as a source in other split charge rules.
(string) –
Method (string) –
The method that’s used to define how to split your source costs across your targets.
Proportional
- Allocates charges across your targets based on the proportional weighted cost of each target.Fixed
- Allocates charges across your targets based on your defined allocation percentage.>
Even
- Allocates costs evenly across all targets.Parameters (list) –
The parameters for a split charge method. This is only required for the
FIXED
method.(dict) –
The parameters for a split charge method.
Type (string) –
The parameter type.
Values (list) –
The parameter values.
(string) –
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.
DefaultValue (string) –
The default value for the cost category.
Exceptions
CostExplorer.Client.exceptions.ResourceNotFoundException
CostExplorer.Client.exceptions.LimitExceededException