![]() |
![]()
| ![]() |
![]()
NAMEPaws::CostExplorer::GetReservationUtilization - Arguments for method GetReservationUtilization on Paws::CostExplorer DESCRIPTIONThis class represents the parameters used for calling the method GetReservationUtilization on the AWS Cost Explorer Service service. Use the attributes of this class as arguments to method GetReservationUtilization. You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetReservationUtilization. SYNOPSISmy $ce = Paws->service('CostExplorer'); my $GetReservationUtilizationResponse = $ce->GetReservationUtilization( TimePeriod => { End => 'MyYearMonthDay', # max: 40 Start => 'MyYearMonthDay', # max: 40 }, Filter => { And => [ <Expression>, ... ], # OPTIONAL CostCategories => { Key => 'MyCostCategoryName', # min: 1, max: 50; OPTIONAL MatchOptions => [ 'EQUALS', ... # values: EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE ], # OPTIONAL Values => [ 'MyValue', ... # max: 1024 ], # OPTIONAL }, # OPTIONAL Dimensions => { Key => 'AZ' , # values: 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; OPTIONAL MatchOptions => [ 'EQUALS', ... # values: EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE ], # OPTIONAL Values => [ 'MyValue', ... # max: 1024 ], # OPTIONAL }, # OPTIONAL Not => <Expression>, Or => [ <Expression>, ... ], # OPTIONAL Tags => { Key => 'MyTagKey', # max: 1024; OPTIONAL MatchOptions => [ 'EQUALS', ... # values: EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE ], # OPTIONAL Values => [ 'MyValue', ... # max: 1024 ], # OPTIONAL }, # OPTIONAL }, # OPTIONAL Granularity => 'DAILY', # OPTIONAL GroupBy => [ { Key => 'MyGroupDefinitionKey', # max: 1024; OPTIONAL Type => 'DIMENSION', # values: DIMENSION, TAG, COST_CATEGORY; OPTIONAL }, ... ], # OPTIONAL MaxResults => 1, # OPTIONAL NextPageToken => 'MyNextPageToken', # OPTIONAL SortBy => { Key => 'MySortDefinitionKey', # max: 1024 SortOrder => 'ASCENDING', # values: ASCENDING, DESCENDING; OPTIONAL }, # OPTIONAL ); # Results: my $NextPageToken = $GetReservationUtilizationResponse->NextPageToken; my $Total = $GetReservationUtilizationResponse->Total; my $UtilizationsByTime = $GetReservationUtilizationResponse->UtilizationsByTime; # Returns a L<Paws::CostExplorer::GetReservationUtilizationResponse> object. Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/ce/GetReservationUtilization> ATTRIBUTESFilter => Paws::CostExplorer::ExpressionFilters utilization data by dimensions. You can filter by the following dimensions:
"GetReservationUtilization" uses the same Expression (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html) object as the other operations, but only "AND" is supported among each dimension, and nesting is supported up to only one level deep. If there are multiple values for a dimension, they are OR'd together. Granularity => StrIf "GroupBy" is set, "Granularity" can't be set. If "Granularity" isn't set, the response object doesn't include "Granularity", either "MONTHLY" or "DAILY". If both "GroupBy" and "Granularity" aren't set, "GetReservationUtilization" defaults to "DAILY". The "GetReservationUtilization" operation supports only "DAILY" and "MONTHLY" granularities. Valid values are: "DAILY", "MONTHLY", "HOURLY" GroupBy => ArrayRef[Paws::CostExplorer::GroupDefinition]Groups only by "SUBSCRIPTION_ID". Metadata is included. MaxResults => IntThe maximum number of objects that you returned for this request. If more objects are available, in the response, AWS provides a NextPageToken value that you can use in a subsequent call to get the next batch of objects. NextPageToken => StrThe token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size. SortBy => Paws::CostExplorer::SortDefinitionThe value by which you want to sort the data. The following values are supported for "Key":
Supported values for "SortOrder" are "ASCENDING" or "DESCENDING". REQUIRED TimePeriod => Paws::CostExplorer::DateIntervalSets the start and end dates for retrieving RI utilization. The start date is inclusive, but the end date is exclusive. For example, if "start" is "2017-01-01" and "end" is "2017-05-01", then the cost and usage data is retrieved from "2017-01-01" up to and including "2017-04-30" but not including "2017-05-01". SEE ALSOThis class forms part of Paws, documenting arguments for method GetReservationUtilization in Paws::CostExplorer BUGS and CONTRIBUTIONSThe source code is located here: <https://github.com/pplu/aws-sdk-perl> Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>
|