DescribeCostCategoryDefinition
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 no EffectiveOn 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.
Request Syntax
{
"CostCategoryArn": "string",
"EffectiveOn": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- CostCategoryArn
-
The unique identifier for your Cost Category.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
arn:aws[-a-z0-9]*:[a-z0-9]+:[-a-z0-9]*:[0-9]{12}:[-a-zA-Z0-9/:_]+Required: Yes
- EffectiveOn
-
The date when the Cost Category was effective.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 25.
Pattern:
^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d(([+-]\d\d:\d\d)|Z)$Required: No
Response Syntax
{
"CostCategory": {
"CostCategoryArn": "string",
"DefaultValue": "string",
"EffectiveEnd": "string",
"EffectiveStart": "string",
"Name": "string",
"ProcessingStatus": [
{
"Component": "string",
"Status": "string"
}
],
"Rules": [
{
"InheritedValue": {
"DimensionKey": "string",
"DimensionName": "string"
},
"Rule": {
"And": [
"Expression"
],
"CostCategories": {
"Key": "string",
"MatchOptions": [ "string" ],
"Values": [ "string" ]
},
"Dimensions": {
"Key": "string",
"MatchOptions": [ "string" ],
"Values": [ "string" ]
},
"Not": "Expression",
"Or": [
"Expression"
],
"Tags": {
"Key": "string",
"MatchOptions": [ "string" ],
"Values": [ "string" ]
}
},
"Type": "string",
"Value": "string"
}
],
"RuleVersion": "string",
"SplitChargeRules": [
{
"Method": "string",
"Parameters": [
{
"Type": "string",
"Values": [ "string" ]
}
],
"Source": "string",
"Targets": [ "string" ]
}
]
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- CostCategory
-
The structure of Cost Categories. This includes detailed metadata and the set of rules for the
CostCategoryobject.Type: CostCategory object
Errors
For information about the errors that are common to all actions, see Common Errors.
- LimitExceededException
-
You made too many calls in a short period of time. Try again later.
HTTP Status Code: 400
- ResourceNotFoundException
-
The specified ARN in the request doesn't exist.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
