update_cost_category_definition
(**kwargs)¶Updates an existing Cost Category. Changes made to the Cost Category rules will be used to categorize the current month’s expenses and future expenses. This won’t change categorization for the previous months.
See also: AWS API Documentation
Request Syntax
response = client.update_cost_category_definition(
CostCategoryArn='string',
EffectiveStart='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'
},
],
DefaultValue='string',
SplitChargeRules=[
{
'Source': 'string',
'Targets': [
'string',
],
'Method': 'FIXED'|'PROPORTIONAL'|'EVEN',
'Parameters': [
{
'Type': 'ALLOCATION_PERCENTAGES',
'Values': [
'string',
]
},
]
},
]
)
[REQUIRED]
The unique identifier for your Cost Category.
[REQUIRED]
The rule schema version in this particular Cost Category.
[REQUIRED]
The Expression
object used to categorize costs. For more information, see CostCategoryRule.
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.
The default value for the cost category.
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
, and LINKED_ACCOUNT_NAME
.
Root level OR
isn't supported. We recommend that you create a separate rule instead.
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 .
Return results that match either Dimension
object.
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:
CostCategories
, Tags
, and Dimensions
.CostCategories
field to define a filter that acts on Cost Categories.Tags
field to define a filter that acts on Cost Allocation Tags.Dimensions
field to define a filter that acts on the DimensionValues.REGION==us-east-1 OR REGION==us-west-1
. For GetRightsizingRecommendation
, the Region is a full name (for example, REGION==US East (N. Virginia)
.Expression
for this example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } }
OR
when applying the filter.Expression
for this example is as follows: { "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", "MatchOptions": [ "STARTS_WITH" ], "Values": [ "a" ] } }
Expression
types with logical operations.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.((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer)
.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
.
Return results that match both Dimension
objects.
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:
CostCategories
, Tags
, and Dimensions
.CostCategories
field to define a filter that acts on Cost Categories.Tags
field to define a filter that acts on Cost Allocation Tags.Dimensions
field to define a filter that acts on the DimensionValues.REGION==us-east-1 OR REGION==us-west-1
. For GetRightsizingRecommendation
, the Region is a full name (for example, REGION==US East (N. Virginia)
.Expression
for this example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } }
OR
when applying the filter.Expression
for this example is as follows: { "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", "MatchOptions": [ "STARTS_WITH" ], "Values": [ "a" ] } }
Expression
types with logical operations.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.((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer)
.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
.
Return results that don't match a Dimension
object.
The specific Dimension
to use for Expression
.
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.
The metadata values that you can use to filter and group your results. You can use GetDimensionValues
to find specific values.
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
.
The specific Tag
to use for Expression
.
The key for the tag.
The specific value of the tag.
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
.
The filter that's based on CostCategory
values.
The unique name of the Cost Category.
The specific value of the Cost Category.
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
.
The value the line item is categorized as if the line item contains the matched dimension.
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 specify TAG
, the cost category value is based on the value of the specified tag key.
The key to extract cost category values.
You can define the CostCategoryRule
rule type as either REGULAR
or INHERITED_VALUE
. The INHERITED_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 by CostCategoryInheritedValueDimension
. 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.
The split charge rules used to allocate your charges between your Cost Category values.
Use the split charge rule to split the cost of one Cost Category value across several other target values.
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.
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.
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.
The parameters for a split charge method. This is only required for the FIXED
method.
The parameters for a split charge method.
The parameter type.
The parameter values.
dict
Response Syntax
{
'CostCategoryArn': 'string',
'EffectiveStart': 'string'
}
Response Structure
(dict) --
CostCategoryArn (string) --
The unique identifier for your Cost Category.
EffectiveStart (string) --
The Cost Category's effective start date. It can only be a billing start date (first day of the month).
Exceptions
CostExplorer.Client.exceptions.ResourceNotFoundException
CostExplorer.Client.exceptions.ServiceQuotaExceededException
CostExplorer.Client.exceptions.LimitExceededException