Paws::CostExplorer::GetSavingsPlansCoverage - Arguments for method GetSavingsPlansCoverage on Paws::CostExplorer
This class represents the parameters used for calling the method GetSavingsPlansCoverage on the AWS Cost Explorer Service service. Use the attributes of this class as arguments to method GetSavingsPlansCoverage.
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetSavingsPlansCoverage.
my $ce = Paws->service('CostExplorer'); my $GetSavingsPlansCoverageResponse = $ce->GetSavingsPlansCoverage( 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 Metrics => [ 'MyMetricName', ... # max: 1024 ], # OPTIONAL NextToken => 'MyNextPageToken', # OPTIONAL SortBy => { Key => 'MySortDefinitionKey', # max: 1024 SortOrder => 'ASCENDING', # values: ASCENDING, DESCENDING; OPTIONAL }, # OPTIONAL ); # Results: my $NextToken = $GetSavingsPlansCoverageResponse->NextToken; my $SavingsPlansCoverages = $GetSavingsPlansCoverageResponse->SavingsPlansCoverages; # Returns a L<Paws::CostExplorer::GetSavingsPlansCoverageResponse> 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/GetSavingsPlansCoverage
Filters Savings Plans coverage data by dimensions. You can filter data for Savings Plans usage with the following dimensions:
LINKED_ACCOUNT
REGION
SERVICE
INSTANCE_FAMILY
GetSavingsPlansCoverage 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. If there are multiple values for a dimension, they are OR'd together.
GetSavingsPlansCoverage
AND
Cost category is also supported.
The granularity of the Amazon Web Services cost data for your Savings Plans. Granularity can't be set if GroupBy is set.
Granularity
GroupBy
The GetSavingsPlansCoverage operation supports only DAILY and MONTHLY granularities.
DAILY
MONTHLY
Valid values are: "DAILY", "MONTHLY", "HOURLY"
"DAILY"
"MONTHLY"
"HOURLY"
You can group the data using the attributes INSTANCE_FAMILY, REGION, or SERVICE.
The number of items to be returned in a response. The default is 20, with a minimum value of 1.
20
1
The measurement that you want your Savings Plans coverage reported in. The only valid value is SpendCoveredBySavingsPlans.
SpendCoveredBySavingsPlans
The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
The value by which you want to sort the data.
The following values are supported for Key:
Key
SpendCoveredBySavingsPlan
OnDemandCost
CoveragePercentage
TotalCost
InstanceFamily
Region
Service
Supported values for SortOrder are ASCENDING or DESCENDING.
SortOrder
ASCENDING
DESCENDING
The time period that you want the usage and costs for. The Start date must be within 13 months. The End date must be after the Start date, and before the current date. Future dates can't be used as an End date.
Start
End
This class forms part of Paws, documenting arguments for method GetSavingsPlansCoverage in Paws::CostExplorer
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
To install Paws, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Paws
CPAN shell
perl -MCPAN -e shell install Paws
For more information on module installation, please visit the detailed CPAN module installation guide.