Package software.amazon.awssdk.services.costexplorer.model

Class GetSavingsPlansUtilizationRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.costexplorer.model.CostExplorerRequest

software.amazon.awssdk.services.costexplorer.model.GetSavingsPlansUtilizationRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetSavingsPlansUtilizationRequest.Builder,GetSavingsPlansUtilizationRequest>

@Generated("software.amazon.awssdk:codegen")
public final class GetSavingsPlansUtilizationRequest
extends CostExplorerRequest
implements ToCopyableBuilder<GetSavingsPlansUtilizationRequest.Builder,GetSavingsPlansUtilizationRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetSavingsPlansUtilizationRequest.Builder

Method Summary

Modifier and Type	Method	Description
static GetSavingsPlansUtilizationRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Expression	filter()	Filters Savings Plans utilization coverage data for active Savings Plans dimensions.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
Granularity	granularity()	The granularity of the Amazon Web Services utillization data for your Savings Plans.
String	granularityAsString()	The granularity of the Amazon Web Services utillization data for your Savings Plans.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends GetSavingsPlansUtilizationRequest.Builder>	serializableBuilderClass()
SortDefinition	sortBy()	The value that you want to sort the data by.
DateInterval	timePeriod()	The time period that you want the usage and costs for.
GetSavingsPlansUtilizationRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

timePeriod

public final DateInterval timePeriod()

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.

Returns:

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.

granularity

public final Granularity granularity()

The granularity of the Amazon Web Services utillization data for your Savings Plans.

The GetSavingsPlansUtilization operation supports only DAILY and MONTHLY granularities.

If the service returns an enum value that is not available in the current SDK version, granularity will return Granularity.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from granularityAsString().

Returns:

The granularity of the Amazon Web Services utillization data for your Savings Plans.

The GetSavingsPlansUtilization operation supports only DAILY and MONTHLY granularities.

See Also:

Granularity

granularityAsString

public final String granularityAsString()

The granularity of the Amazon Web Services utillization data for your Savings Plans.

The GetSavingsPlansUtilization operation supports only DAILY and MONTHLY granularities.

If the service returns an enum value that is not available in the current SDK version, granularity will return Granularity.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from granularityAsString().

Returns:

The granularity of the Amazon Web Services utillization data for your Savings Plans.

The GetSavingsPlansUtilization operation supports only DAILY and MONTHLY granularities.

See Also:

Granularity

filter

public final Expression 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

• SAVINGS_PLANS_TYPE

• REGION

• PAYMENT_OPTION

• INSTANCE_TYPE_FAMILY

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

Returns:

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

• LINKED_ACCOUNT

• SAVINGS_PLAN_ARN

• SAVINGS_PLANS_TYPE

• REGION

• PAYMENT_OPTION

• INSTANCE_TYPE_FAMILY

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

sortBy

public final SortDefinition sortBy()

The value that you want to sort the data by.

The following values are supported for Key:

• UtilizationPercentage

• TotalCommitment

• UsedCommitment

• UnusedCommitment

• NetSavings

The supported values for SortOrder are ASCENDING and DESCENDING.

Returns:

The value that you want to sort the data by.

The following values are supported for Key:

• UtilizationPercentage

• TotalCommitment

• UsedCommitment

• UnusedCommitment

• NetSavings

The supported values for SortOrder are ASCENDING and DESCENDING.

toBuilder

public GetSavingsPlansUtilizationRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetSavingsPlansUtilizationRequest.Builder,GetSavingsPlansUtilizationRequest>

Specified by:

toBuilder in class CostExplorerRequest

builder

public static GetSavingsPlansUtilizationRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetSavingsPlansUtilizationRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo