2022/03/22 - AWS Cost Explorer Service - 3 new 3 updated api methods
Changes Added three new APIs to support tagging and resource-level authorization on Cost Explorer resources: TagResource, UntagResource, ListTagsForResource. Added optional parameters to CreateCostCategoryDefinition, CreateAnomalySubscription and CreateAnomalyMonitor APIs to support Tag On Create.
Returns a list of resource tags associated with the resource specified by the Amazon Resource Name (ARN).
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource(
ResourceArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource. For a list of supported resources, see ResourceTag .
dict
Response Syntax
{
'ResourceTags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
ResourceTags (list) --
A list of tag key value pairs that are associated with the response.
(dict) --
The tag structure that contains a tag key and value.
Note
Tagging is supported only for the following Cost Explorer resource types: ` AnomalyMonitor https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalyMonitor.html`__ , ` AnomalySubscription https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalySubscription.html`__ , ` CostCategory https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_CostCategory.html`__ .
Key (string) --
The key that is associated with the tag.
Value (string) --
The value that is associated with the tag.
An API operation for adding one or more tags (key-value pairs) to a resource.
You can use the TagResource operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value you specify replaces the previous value for that tag.
Although the maximum number of array members is 200, user-tag maximum is 50. The remaining are reserved for Amazon Web Services use.
See also: AWS API Documentation
Request Syntax
client.tag_resource(
ResourceArn='string',
ResourceTags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource. For a list of supported resources, see ResourceTag .
list
[REQUIRED]
A list of tag key-value pairs to be added to the resource.
Each tag consists of a key and a value, and each key must be unique for the resource. The following restrictions apply to resource tags:
Although the maximum number of array members is 200, you can assign a maximum of 50 user-tags to one resource. The remaining are reserved for Amazon Web Services use
The maximum length of a key is 128 characters
The maximum length of a value is 256 characters
Valid characters for keys and values are: A-Z , a-z , spaces, _.:/=+-
Keys and values are case sensitive
Keys and values are trimmed for any leading or trailing whitespaces
Don’t use aws: as a prefix for your keys. This prefix is reserved for Amazon Web Services use
(dict) --
The tag structure that contains a tag key and value.
Note
Tagging is supported only for the following Cost Explorer resource types: ` AnomalyMonitor https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalyMonitor.html`__ , ` AnomalySubscription https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalySubscription.html`__ , ` CostCategory https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_CostCategory.html`__ .
Key (string) -- [REQUIRED]
The key that is associated with the tag.
Value (string) -- [REQUIRED]
The value that is associated with the tag.
dict
Response Syntax
{}
Response Structure
(dict) --
Removes one or more tags from a resource. Specify only tag key(s) in your request. Do not specify the value.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
ResourceArn='string',
ResourceTagKeys=[
'string',
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource. For a list of supported resources, see ResourceTag .
list
[REQUIRED]
A list of tag keys associated with tags that need to be removed from the resource. If you specify a tag key that does not exist, it is ignored. Although the maximum number of array members is 200, user-tag maximum is 50. The remaining are reserved for Amazon Web Services use.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
{'ResourceTags': [{'Key': 'string', 'Value': 'string'}]}
Creates a new cost anomaly detection monitor with the requested type and monitor specification.
See also: AWS API Documentation
Request Syntax
client.create_anomaly_monitor(
AnomalyMonitor={
'MonitorArn': 'string',
'MonitorName': 'string',
'CreationDate': 'string',
'LastUpdatedDate': 'string',
'LastEvaluatedDate': 'string',
'MonitorType': 'DIMENSIONAL'|'CUSTOM',
'MonitorDimension': 'SERVICE',
'MonitorSpecification': {
'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',
'Values': [
'string',
],
'MatchOptions': [
'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
]
},
'Tags': {
'Key': 'string',
'Values': [
'string',
],
'MatchOptions': [
'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
]
},
'CostCategories': {
'Key': 'string',
'Values': [
'string',
],
'MatchOptions': [
'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
]
}
},
'DimensionalValueCount': 123
},
ResourceTags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
dict
[REQUIRED]
The cost anomaly detection monitor object that you want to create.
MonitorArn (string) --
The Amazon Resource Name (ARN) value.
MonitorName (string) -- [REQUIRED]
The name of the monitor.
CreationDate (string) --
The date when the monitor was created.
LastUpdatedDate (string) --
The date when the monitor was last updated.
LastEvaluatedDate (string) --
The date when the monitor last evaluated for anomalies.
MonitorType (string) -- [REQUIRED]
The possible type values.
MonitorDimension (string) --
The dimensions to evaluate.
MonitorSpecification (dict) --
Use Expression to filter by cost or by usage. There are two patterns:
Simple dimension values - 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 Expression example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that 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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }
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 by cost or by usage. There are two patterns:
Simple dimension values - 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 Expression example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that 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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }
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 by cost or by usage. There are two patterns:
Simple dimension values - 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 Expression example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that 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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }
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.
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. 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) --
DimensionalValueCount (integer) --
The value for evaluated dimensions.
list
An optional list of tags to associate with the specified ` AnomalyMonitor https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalyMonitor.html`__ . You can use resource tags to control access to your monitor using IAM policies.
Each tag consists of a key and a value, and each key must be unique for the resource. The following restrictions apply to resource tags:
Although the maximum number of array members is 200, you can assign a maximum of 50 user-tags to one resource. The remaining are reserved for Amazon Web Services use
The maximum length of a key is 128 characters
The maximum length of a value is 256 characters
Valid characters for keys and values are: A-Z , a-z , spaces, _.:/=+-
Keys and values are case sensitive
Keys and values are trimmed for any leading or trailing whitespaces
Don’t use aws: as a prefix for your keys. This prefix is reserved for Amazon Web Services use
(dict) --
The tag structure that contains a tag key and value.
Note
Tagging is supported only for the following Cost Explorer resource types: ` AnomalyMonitor https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalyMonitor.html`__ , ` AnomalySubscription https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalySubscription.html`__ , ` CostCategory https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_CostCategory.html`__ .
Key (string) -- [REQUIRED]
The key that is associated with the tag.
Value (string) -- [REQUIRED]
The value that is associated with the tag.
dict
Response Syntax
{
'MonitorArn': 'string'
}
Response Structure
(dict) --
MonitorArn (string) --
The unique identifier of your newly created cost anomaly detection monitor.
{'ResourceTags': [{'Key': 'string', 'Value': 'string'}]}
Adds a subscription to a cost anomaly detection monitor. You can use each subscription to define subscribers with email or SNS notifications. Email subscribers can set a dollar threshold and a time frequency for receiving notifications.
See also: AWS API Documentation
Request Syntax
client.create_anomaly_subscription(
AnomalySubscription={
'SubscriptionArn': 'string',
'AccountId': 'string',
'MonitorArnList': [
'string',
],
'Subscribers': [
{
'Address': 'string',
'Type': 'EMAIL'|'SNS',
'Status': 'CONFIRMED'|'DECLINED'
},
],
'Threshold': 123.0,
'Frequency': 'DAILY'|'IMMEDIATE'|'WEEKLY',
'SubscriptionName': 'string'
},
ResourceTags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
dict
[REQUIRED]
The cost anomaly subscription object that you want to create.
SubscriptionArn (string) --
The AnomalySubscription Amazon Resource Name (ARN).
AccountId (string) --
Your unique account identifier.
MonitorArnList (list) -- [REQUIRED]
A list of cost anomaly monitors.
(string) --
Subscribers (list) -- [REQUIRED]
A list of subscribers to notify.
(dict) --
The recipient of AnomalySubscription notifications.
Address (string) --
The email address or SNS Amazon Resource Name (ARN). This depends on the Type .
Type (string) --
The notification delivery channel.
Status (string) --
Indicates if the subscriber accepts the notifications.
Threshold (float) -- [REQUIRED]
The dollar value that triggers a notification if the threshold is exceeded.
Frequency (string) -- [REQUIRED]
The frequency that anomaly reports are sent over email.
SubscriptionName (string) -- [REQUIRED]
The name for the subscription.
list
An optional list of tags to associate with the specified ` AnomalySubscription https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalySubscription.html`__ . You can use resource tags to control access to your subscription using IAM policies.
Each tag consists of a key and a value, and each key must be unique for the resource. The following restrictions apply to resource tags:
Although the maximum number of array members is 200, you can assign a maximum of 50 user-tags to one resource. The remaining are reserved for Amazon Web Services use
The maximum length of a key is 128 characters
The maximum length of a value is 256 characters
Valid characters for keys and values are: A-Z , a-z , spaces, _.:/=+-
Keys and values are case sensitive
Keys and values are trimmed for any leading or trailing whitespaces
Don’t use aws: as a prefix for your keys. This prefix is reserved for Amazon Web Services use
(dict) --
The tag structure that contains a tag key and value.
Note
Tagging is supported only for the following Cost Explorer resource types: ` AnomalyMonitor https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalyMonitor.html`__ , ` AnomalySubscription https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalySubscription.html`__ , ` CostCategory https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_CostCategory.html`__ .
Key (string) -- [REQUIRED]
The key that is associated with the tag.
Value (string) -- [REQUIRED]
The value that is associated with the tag.
dict
Response Syntax
{
'SubscriptionArn': 'string'
}
Response Structure
(dict) --
SubscriptionArn (string) --
The unique identifier of your newly created cost anomaly subscription.
{'ResourceTags': [{'Key': 'string', 'Value': 'string'}]}
Creates a new Cost Category with the requested name and rules.
See also: AWS API Documentation
Request Syntax
client.create_cost_category_definition(
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',
'Values': [
'string',
],
'MatchOptions': [
'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
]
},
'Tags': {
'Key': 'string',
'Values': [
'string',
],
'MatchOptions': [
'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
]
},
'CostCategories': {
'Key': 'string',
'Values': [
'string',
],
'MatchOptions': [
'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
]
}
},
'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',
]
},
]
},
],
ResourceTags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The unique name of the Cost Category.
string
[REQUIRED]
The rule schema version in this particular Cost Category.
list
[REQUIRED]
The Cost Category rules used to categorize costs. For more information, see CostCategoryRule .
(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 , 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 .
Or (list) --
Return results that match either Dimension object.
(dict) --
Use Expression to filter by cost or by usage. There are two patterns:
Simple dimension values - 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 Expression example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that 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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }
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 by cost or by usage. There are two patterns:
Simple dimension values - 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 Expression example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that 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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }
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.
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. 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) --
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 specify TAG , the cost category value will be 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 either REGULAR or INHERITED_VALUE . The INHERITED_VALUE rule type adds the flexibility of defining a rule that dynamically inherits the cost category value from the dimension value defined by CostCategoryInheritedValueDimension . For example, if you want to dynamically group costs based on the value of a specific tag key, first choose an inherited value rule type, then choose the tag dimension and specify the tag key to use.
string
The default value for the cost category.
list
The split charge rules 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) -- [REQUIRED]
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) -- [REQUIRED]
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) -- [REQUIRED]
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) -- [REQUIRED]
The parameter type.
Values (list) -- [REQUIRED]
The parameter values.
(string) --
list
An optional list of tags to associate with the specified ` CostCategory https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_CostCategory.html`__ . You can use resource tags to control access to your cost category using IAM policies.
Each tag consists of a key and a value, and each key must be unique for the resource. The following restrictions apply to resource tags:
Although the maximum number of array members is 200, you can assign a maximum of 50 user-tags to one resource. The remaining are reserved for Amazon Web Services use
The maximum length of a key is 128 characters
The maximum length of a value is 256 characters
Valid characters for keys and values are: A-Z , a-z , spaces, _.:/=+-
Keys and values are case sensitive
Keys and values are trimmed for any leading or trailing whitespaces
Don’t use aws: as a prefix for your keys. This prefix is reserved for Amazon Web Services use
(dict) --
The tag structure that contains a tag key and value.
Note
Tagging is supported only for the following Cost Explorer resource types: ` AnomalyMonitor https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalyMonitor.html`__ , ` AnomalySubscription https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalySubscription.html`__ , ` CostCategory https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_CostCategory.html`__ .
Key (string) -- [REQUIRED]
The key that is associated with the tag.
Value (string) -- [REQUIRED]
The value that is associated with the tag.
dict
Response Syntax
{
'CostCategoryArn': 'string',
'EffectiveStart': 'string'
}
Response Structure
(dict) --
CostCategoryArn (string) --
The unique identifier for your newly created Cost Category.
EffectiveStart (string) --
The Cost Category's effective start date.