Get Savings Plans Coverage

costexplorer_get_savings_plans_coverage

R Documentation

Retrieves the Savings Plans covered for your account

Description

Retrieves the Savings Plans covered for your account. This enables you to see how much of your cost is covered by a Savings Plan. An organization’s management account can see the coverage of the associated member accounts. This supports dimensions, Cost Categories, and nested expressions. For any time period, you can filter data for Savings Plans usage with the following dimensions:

• LINKED_ACCOUNT

• REGION

• SERVICE

• INSTANCE_FAMILY

To determine valid values for a dimension, use the get_dimension_values operation.

Usage

costexplorer_get_savings_plans_coverage(TimePeriod, GroupBy,
  Granularity, Filter, Metrics, NextToken, MaxResults, SortBy)

Arguments

TimePeriod	[required] 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.
GroupBy	You can group the data using the attributes INSTANCE_FAMILY, REGION, or SERVICE.
Granularity	The granularity of the Amazon Web Services cost data for your Savings Plans. Granularity can't be set if GroupBy is set. The get_savings_plans_coverage operation supports only DAILY and MONTHLY granularities.
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 get_savings_plans_coverage uses the same Expression 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.
Metrics	The measurement that you want your Savings Plans coverage reported in. The only valid value is SpendCoveredBySavingsPlans.
NextToken	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.
MaxResults	The number of items to be returned in a response. The default is 20, with a minimum value of 1.
SortBy	The value that you want to sort the data by. The following values are supported for Key: SpendCoveredBySavingsPlan OnDemandCost CoveragePercentage TotalCost InstanceFamily Region Service The supported values for SortOrder are ASCENDING and DESCENDING.

Value

A list with the following syntax:

list(
  SavingsPlansCoverages = list(
    list(
      Attributes = list(
        "string"
      ),
      Coverage = list(
        SpendCoveredBySavingsPlans = "string",
        OnDemandCost = "string",
        TotalCost = "string",
        CoveragePercentage = "string"
      ),
      TimePeriod = list(
        Start = "string",
        End = "string"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$get_savings_plans_coverage(
  TimePeriod = list(
    Start = "string",
    End = "string"
  ),
  GroupBy = list(
    list(
      Type = "DIMENSION"|"TAG"|"COST_CATEGORY",
      Key = "string"
    )
  ),
  Granularity = "DAILY"|"MONTHLY"|"HOURLY",
  Filter = list(
    Or = list(
      list()
    ),
    And = list(
      list()
    ),
    Not = list(),
    Dimensions = list(
      Key = "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"|"INVOICING_ENTITY"|"ANOMALY_TOTAL_IMPACT_ABSOLUTE"|"ANOMALY_TOTAL_IMPACT_PERCENTAGE",
      Values = list(
        "string"
      ),
      MatchOptions = list(
        "EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE"|"GREATER_THAN_OR_EQUAL"
      )
    ),
    Tags = list(
      Key = "string",
      Values = list(
        "string"
      ),
      MatchOptions = list(
        "EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE"|"GREATER_THAN_OR_EQUAL"
      )
    ),
    CostCategories = list(
      Key = "string",
      Values = list(
        "string"
      ),
      MatchOptions = list(
        "EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE"|"GREATER_THAN_OR_EQUAL"
      )
    )
  ),
  Metrics = list(
    "string"
  ),
  NextToken = "string",
  MaxResults = 123,
  SortBy = list(
    Key = "string",
    SortOrder = "ASCENDING"|"DESCENDING"
  )
)