« blib/lib/Paws/CostExplorer/CostCategoryReference.pm
↑ Summary
blib/lib/Paws/CostExplorer/CostCategoryValues.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CostExplorer::CostCategoryRule; | ||
| 3 | use Moose; | ||
| 4 | has InheritedValue => (is => 'ro', isa => 'Paws::CostExplorer::CostCategoryInheritedValueDimension'); | ||
| 5 | has Rule => (is => 'ro', isa => 'Paws::CostExplorer::Expression'); | ||
| 6 | has Type => (is => 'ro', isa => 'Str'); | ||
| 7 | has Value => (is => 'ro', isa => 'Str'); | ||
| 8 | |||
| 9 | 1; | ||
| 10 | |||
| 11 | ### main pod documentation begin ### | ||
| 12 | |||
| 13 | =head1 NAME | ||
| 14 | |||
| 15 | Paws::CostExplorer::CostCategoryRule | ||
| 16 | |||
| 17 | =head1 USAGE | ||
| 18 | |||
| 19 | This class represents one of two things: | ||
| 20 | |||
| 21 | =head3 Arguments in a call to a service | ||
| 22 | |||
| 23 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 24 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 25 | |||
| 26 | As an example, if Att1 is expected to be a Paws::CostExplorer::CostCategoryRule object: | ||
| 27 | |||
| 28 | $service_obj->Method(Att1 => { InheritedValue => $value, ..., Value => $value }); | ||
| 29 | |||
| 30 | =head3 Results returned from an API call | ||
| 31 | |||
| 32 | Use accessors for each attribute. If Att1 is expected to be an Paws::CostExplorer::CostCategoryRule object: | ||
| 33 | |||
| 34 | $result = $service_obj->Method(...); | ||
| 35 | $result->Att1->InheritedValue | ||
| 36 | |||
| 37 | =head1 DESCRIPTION | ||
| 38 | |||
| 39 | Rules are processed in order. If there are multiple rules that match | ||
| 40 | the line item, then the first rule to match is used to determine that | ||
| 41 | Cost Category value. | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 InheritedValue => L<Paws::CostExplorer::CostCategoryInheritedValueDimension> | ||
| 47 | |||
| 48 | The value the line item will be categorized as, if the line item | ||
| 49 | contains the matched dimension. | ||
| 50 | |||
| 51 | |||
| 52 | =head2 Rule => L<Paws::CostExplorer::Expression> | ||
| 53 | |||
| 54 | An Expression | ||
| 55 | (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html) | ||
| 56 | object used to categorize costs. This supports dimensions, tags, and | ||
| 57 | nested expressions. Currently the only dimensions supported are | ||
| 58 | C<LINKED_ACCOUNT>, C<SERVICE_CODE>, C<RECORD_TYPE>, and | ||
| 59 | C<LINKED_ACCOUNT_NAME>. | ||
| 60 | |||
| 61 | Root level C<OR> is not supported. We recommend that you create a | ||
| 62 | separate rule instead. | ||
| 63 | |||
| 64 | C<RECORD_TYPE> is a dimension used for Cost Explorer APIs, and is also | ||
| 65 | supported for Cost Category expressions. This dimension uses different | ||
| 66 | terms, depending on whether you're using the console or API/JSON | ||
| 67 | editor. For a detailed comparison, see Term Comparisons | ||
| 68 | (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/manage-cost-categories.html#cost-categories-terms) | ||
| 69 | in the I<AWS Billing and Cost Management User Guide>. | ||
| 70 | |||
| 71 | |||
| 72 | =head2 Type => Str | ||
| 73 | |||
| 74 | You can define the C<CostCategoryRule> rule type as either C<REGULAR> | ||
| 75 | or C<INHERITED_VALUE>. The C<INHERITED_VALUE> rule type adds the | ||
| 76 | flexibility of defining a rule that dynamically inherits the cost | ||
| 77 | category value from the dimension value defined by | ||
| 78 | C<CostCategoryInheritedValueDimension>. For example, if you wanted to | ||
| 79 | dynamically group costs based on the value of a specific tag key, you | ||
| 80 | would first choose an inherited value rule type, then choose the tag | ||
| 81 | dimension and specify the tag key to use. | ||
| 82 | |||
| 83 | |||
| 84 | =head2 Value => Str | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head1 SEE ALSO | ||
| 91 | |||
| 92 | This class forms part of L<Paws>, describing an object used in L<Paws::CostExplorer> | ||
| 93 | |||
| 94 | =head1 BUGS and CONTRIBUTIONS | ||
| 95 | |||
| 96 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 97 | |||
| 98 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 99 | |||
| 100 | =cut | ||
| 101 |