Get Savings Plans Utilization Details

costexplorer_get_savings_plans_utilization_details

R Documentation

Retrieves attribute data along with aggregate utilization and savings data for a given time period

Description

Retrieves attribute data along with aggregate utilization and savings data for a given time period. This doesn't support granular or grouped data (daily/monthly) in response. You can't retrieve data by dates in a single response similar to GetSavingsPlanUtilization, but you have the option to make multiple calls to GetSavingsPlanUtilizationDetails by providing individual dates. You can use get_dimension_values in SAVINGS_PLANS to determine the possible dimension values.

GetSavingsPlanUtilizationDetails internally groups data by SavingsPlansArn.

Usage

costexplorer_get_savings_plans_utilization_details(TimePeriod, Filter,
  DataType, 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.

Filter

Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions:

• LINKED_ACCOUNT

• SAVINGS_PLAN_ARN

• REGION

• PAYMENT_OPTION

• INSTANCE_TYPE_FAMILY

get_savings_plans_utilization_details uses the same Expression object as the other operations, but only AND is supported among each dimension.

DataType

The data type.

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:

• UtilizationPercentage

• TotalCommitment

• UsedCommitment

• UnusedCommitment

• NetSavings

• AmortizedRecurringCommitment

• AmortizedUpfrontCommitment

The supported values for SortOrder are ASCENDING and DESCENDING.

Value

A list with the following syntax:

list(
  SavingsPlansUtilizationDetails = list(
    list(
      SavingsPlanArn = "string",
      Attributes = list(
        "string"
      ),
      Utilization = list(
        TotalCommitment = "string",
        UsedCommitment = "string",
        UnusedCommitment = "string",
        UtilizationPercentage = "string"
      ),
      Savings = list(
        NetSavings = "string",
        OnDemandCostEquivalent = "string"
      ),
      AmortizedCommitment = list(
        AmortizedRecurringCommitment = "string",
        AmortizedUpfrontCommitment = "string",
        TotalAmortizedCommitment = "string"
      )
    )
  ),
  Total = list(
    Utilization = list(
      TotalCommitment = "string",
      UsedCommitment = "string",
      UnusedCommitment = "string",
      UtilizationPercentage = "string"
    ),
    Savings = list(
      NetSavings = "string",
      OnDemandCostEquivalent = "string"
    ),
    AmortizedCommitment = list(
      AmortizedRecurringCommitment = "string",
      AmortizedUpfrontCommitment = "string",
      TotalAmortizedCommitment = "string"
    )
  ),
  TimePeriod = list(
    Start = "string",
    End = "string"
  ),
  NextToken = "string"
)

Request syntax

svc$get_savings_plans_utilization_details(
  TimePeriod = list(
    Start = "string",
    End = "string"
  ),
  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"
      )
    )
  ),
  DataType = list(
    "ATTRIBUTES"|"UTILIZATION"|"AMORTIZED_COMMITMENT"|"SAVINGS"
  ),
  NextToken = "string",
  MaxResults = 123,
  SortBy = list(
    Key = "string",
    SortOrder = "ASCENDING"|"DESCENDING"
  )
)