class Aws::CostExplorer::Types::GetSavingsPlansCoverageRequest
@note When making an API call, you may pass GetSavingsPlansCoverageRequest
data as a hash: { time_period: { # required start: "YearMonthDay", # required end: "YearMonthDay", # required }, group_by: [ { type: "DIMENSION", # accepts DIMENSION, TAG, COST_CATEGORY key: "GroupDefinitionKey", }, ], granularity: "DAILY", # accepts DAILY, MONTHLY, HOURLY filter: { or: [ { # recursive Expression }, ], and: [ { # recursive Expression }, ], not: { # recursive Expression }, dimensions: { key: "AZ", # accepts 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 values: ["Value"], match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE }, tags: { key: "TagKey", values: ["Value"], match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE }, cost_categories: { key: "CostCategoryName", values: ["Value"], match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE }, }, metrics: ["MetricName"], next_token: "NextPageToken", max_results: 1, sort_by: { key: "SortDefinitionKey", # required sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING }, }
@!attribute [rw] time_period
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. @return [Types::DateInterval]
@!attribute [rw] group_by
You can group the data using the attributes `INSTANCE_FAMILY`, `REGION`, or `SERVICE`. @return [Array<Types::GroupDefinition>]
@!attribute [rw] granularity
The granularity of the Amazon Web Services cost data for your Savings Plans. `Granularity` can't be set if `GroupBy` is set. The `GetSavingsPlansCoverage` operation supports only `DAILY` and `MONTHLY` granularities. @return [String]
@!attribute [rw] filter
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][1] 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. Cost category is also supported. [1]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html @return [Types::Expression]
@!attribute [rw] metrics
The measurement that you want your Savings Plans coverage reported in. The only valid value is `SpendCoveredBySavingsPlans`. @return [Array<String>]
@!attribute [rw] next_token
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. @return [String]
@!attribute [rw] max_results
The number of items to be returned in a response. The default is `20`, with a minimum value of `1`. @return [Integer]
@!attribute [rw] sort_by
The value by which you want to sort the data. The following values are supported for `Key`\: * `SpendCoveredBySavingsPlan` * `OnDemandCost` * `CoveragePercentage` * `TotalCost` * `InstanceFamily` * `Region` * `Service` Supported values for `SortOrder` are `ASCENDING` or `DESCENDING`. @return [Types::SortDefinition]
@see docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/GetSavingsPlansCoverageRequest AWS API Documentation
Constants
- SENSITIVE