AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the GetReservationUtilization operation. Retrieves the reservation utilization for your account. Management account in an organization have access to member accounts. You can filter data by dimensions in a time period. You can use GetDimensionValues to determine the possible dimension values. Currently, you can group only by SUBSCRIPTION_ID.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.CostExplorer.AmazonCostExplorerRequest
      Amazon.CostExplorer.Model.GetReservationUtilizationRequest

Namespace: Amazon.CostExplorer.Model
Assembly: AWSSDK.CostExplorer.dll
Version: 3.x.y.z

Syntax

C#
public class GetReservationUtilizationRequest : AmazonCostExplorerRequest
         IAmazonWebServiceRequest

The GetReservationUtilizationRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property Filter Amazon.CostExplorer.Model.Expression

Gets and sets the property Filter.

Filters utilization data by dimensions. You can filter by the following dimensions:

  • AZ

  • CACHE_ENGINE

  • DEPLOYMENT_OPTION

  • INSTANCE_TYPE

  • LINKED_ACCOUNT

  • OPERATING_SYSTEM

  • PLATFORM

  • REGION

  • SERVICE

  • SCOPE

  • TENANCY

GetReservationUtilization uses the same Expression 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.

Public Property Granularity Amazon.CostExplorer.Granularity

Gets and sets the property Granularity.

If 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.

Public Property GroupBy System.Collections.Generic.List<Amazon.CostExplorer.Model.GroupDefinition>

Gets and sets the property GroupBy.

Groups only by SUBSCRIPTION_ID. Metadata is included.

Public Property MaxResults System.Int32

Gets and sets the property MaxResults.

The maximum number of objects that you returned for this request. If more objects are available, in the response, Amazon Web Services provides a NextPageToken value that you can use in a subsequent call to get the next batch of objects.

Public Property NextPageToken System.String

Gets and sets the property NextPageToken.

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.

Public Property SortBy Amazon.CostExplorer.Model.SortDefinition

Gets and sets the property SortBy.

The value that you want to sort the data by.

The following values are supported for Key:

  • UtilizationPercentage

  • UtilizationPercentageInUnits

  • PurchasedHours

  • PurchasedUnits

  • TotalActualHours

  • TotalActualUnits

  • UnusedHours

  • UnusedUnits

  • OnDemandCostOfRIHoursUsed

  • NetRISavings

  • TotalPotentialRISavings

  • AmortizedUpfrontFee

  • AmortizedRecurringFee

  • TotalAmortizedFee

  • RICostForUnusedHours

  • RealizedSavings

  • UnrealizedSavings

The supported values for SortOrder are ASCENDING and DESCENDING.

Public Property TimePeriod Amazon.CostExplorer.Model.DateInterval

Gets and sets the property TimePeriod.

Sets the start and end dates for retrieving Reserved Instance (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.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5