software.amazon.awssdk.services.costexplorer.model

Interface GetSavingsPlansCoverageRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<GetSavingsPlansCoverageRequest.Builder,GetSavingsPlansCoverageRequest>, CostExplorerRequest.Builder, SdkBuilder<GetSavingsPlansCoverageRequest.Builder,GetSavingsPlansCoverageRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

GetSavingsPlansCoverageRequest

public static interface GetSavingsPlansCoverageRequest.Builder
extends CostExplorerRequest.Builder, SdkPojo, CopyableBuilder<GetSavingsPlansCoverageRequest.Builder,GetSavingsPlansCoverageRequest>

Method Summary

Modifier and Type	Method and Description
default GetSavingsPlansCoverageRequest.Builder	filter(Consumer<Expression.Builder> filter) Filters Savings Plans coverage data by dimensions.
GetSavingsPlansCoverageRequest.Builder	filter(Expression filter) Filters Savings Plans coverage data by dimensions.
GetSavingsPlansCoverageRequest.Builder	granularity(Granularity granularity) The granularity of the Amazon Web Services cost data for your Savings Plans.
GetSavingsPlansCoverageRequest.Builder	granularity(String granularity) The granularity of the Amazon Web Services cost data for your Savings Plans.
GetSavingsPlansCoverageRequest.Builder	groupBy(Collection<GroupDefinition> groupBy) You can group the data using the attributes INSTANCE_FAMILY, REGION, or SERVICE.
GetSavingsPlansCoverageRequest.Builder	groupBy(Consumer<GroupDefinition.Builder>... groupBy) You can group the data using the attributes INSTANCE_FAMILY, REGION, or SERVICE.
GetSavingsPlansCoverageRequest.Builder	groupBy(GroupDefinition... groupBy) You can group the data using the attributes INSTANCE_FAMILY, REGION, or SERVICE.
GetSavingsPlansCoverageRequest.Builder	maxResults(Integer maxResults) The number of items to be returned in a response.
GetSavingsPlansCoverageRequest.Builder	metrics(Collection<String> metrics) The measurement that you want your Savings Plans coverage reported in.
GetSavingsPlansCoverageRequest.Builder	metrics(String... metrics) The measurement that you want your Savings Plans coverage reported in.
GetSavingsPlansCoverageRequest.Builder	nextToken(String nextToken) The token to retrieve the next set of results.
GetSavingsPlansCoverageRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
GetSavingsPlansCoverageRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
default GetSavingsPlansCoverageRequest.Builder	sortBy(Consumer<SortDefinition.Builder> sortBy) The value that you want to sort the data by.
GetSavingsPlansCoverageRequest.Builder	sortBy(SortDefinition sortBy) The value that you want to sort the data by.
default GetSavingsPlansCoverageRequest.Builder	timePeriod(Consumer<DateInterval.Builder> timePeriod) The time period that you want the usage and costs for.
GetSavingsPlansCoverageRequest.Builder	timePeriod(DateInterval timePeriod) The time period that you want the usage and costs for.

Methods inherited from interface software.amazon.awssdk.services.costexplorer.model.CostExplorerRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

timePeriod

GetSavingsPlansCoverageRequest.Builder timePeriod(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

timePeriod

default GetSavingsPlansCoverageRequest.Builder timePeriod(Consumer<DateInterval.Builder> 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.

This is a convenience method that creates an instance of the DateInterval.Builder avoiding the need to create one manually via DateInterval.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to timePeriod(DateInterval).

Parameters:

timePeriod - a consumer that will call methods on DateInterval.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

timePeriod(DateInterval)

groupBy

GetSavingsPlansCoverageRequest.Builder groupBy(Collection<GroupDefinition> groupBy)

You can group the data using the attributes INSTANCE_FAMILY, REGION, or SERVICE.

Parameters:

groupBy - You can group the data using the attributes INSTANCE_FAMILY, REGION, or SERVICE.

Returns:

Returns a reference to this object so that method calls can be chained together.

groupBy

GetSavingsPlansCoverageRequest.Builder groupBy(GroupDefinition... groupBy)

You can group the data using the attributes INSTANCE_FAMILY, REGION, or SERVICE.

Parameters:

groupBy - You can group the data using the attributes INSTANCE_FAMILY, REGION, or SERVICE.

Returns:

Returns a reference to this object so that method calls can be chained together.

groupBy

GetSavingsPlansCoverageRequest.Builder groupBy(Consumer<GroupDefinition.Builder>... groupBy)

You can group the data using the attributes INSTANCE_FAMILY, REGION, or SERVICE.

This is a convenience method that creates an instance of the GroupDefinition.Builder avoiding the need to create one manually via GroupDefinition.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #groupBy(List).

Parameters:

groupBy - a consumer that will call methods on GroupDefinition.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#groupBy(java.util.Collection)

granularity

GetSavingsPlansCoverageRequest.Builder granularity(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Granularity, Granularity

granularity

GetSavingsPlansCoverageRequest.Builder granularity(Granularity 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Granularity, Granularity

filter

GetSavingsPlansCoverageRequest.Builder filter(Expression 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 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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

filter

default GetSavingsPlansCoverageRequest.Builder filter(Consumer<Expression.Builder> 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 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.

This is a convenience method that creates an instance of the Expression.Builder avoiding the need to create one manually via Expression.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filter(Expression).

Parameters:

filter - a consumer that will call methods on Expression.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

filter(Expression)

metrics

GetSavingsPlansCoverageRequest.Builder metrics(Collection<String> metrics)

The measurement that you want your Savings Plans coverage reported in. The only valid value is SpendCoveredBySavingsPlans.

Parameters:

metrics - The measurement that you want your Savings Plans coverage reported in. The only valid value is SpendCoveredBySavingsPlans.

Returns:

Returns a reference to this object so that method calls can be chained together.

metrics

GetSavingsPlansCoverageRequest.Builder metrics(String... metrics)

The measurement that you want your Savings Plans coverage reported in. The only valid value is SpendCoveredBySavingsPlans.

Parameters:

metrics - The measurement that you want your Savings Plans coverage reported in. The only valid value is SpendCoveredBySavingsPlans.

Returns:

Returns a reference to this object so that method calls can be chained together.

nextToken

GetSavingsPlansCoverageRequest.Builder nextToken(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

maxResults

GetSavingsPlansCoverageRequest.Builder maxResults(Integer maxResults)

The number of items to be returned in a response. The default is 20, with a minimum value of 1.

Parameters:

maxResults - The number of items to be returned in a response. The default is 20, with a minimum value of 1.

Returns:

Returns a reference to this object so that method calls can be chained together.

sortBy

GetSavingsPlansCoverageRequest.Builder sortBy(SortDefinition 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

sortBy

default GetSavingsPlansCoverageRequest.Builder sortBy(Consumer<SortDefinition.Builder> 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.

This is a convenience method that creates an instance of the SortDefinition.Builder avoiding the need to create one manually via SortDefinition.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sortBy(SortDefinition).

Parameters:

sortBy - a consumer that will call methods on SortDefinition.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

sortBy(SortDefinition)

overrideConfiguration

GetSavingsPlansCoverageRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

GetSavingsPlansCoverageRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder