software.amazon.awssdk.services.costexplorer.model

Interface GetCostAndUsageRequest.Builder

All Superinterfaces:

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

Enclosing class:

GetCostAndUsageRequest

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

Method Summary

Modifier and Type	Method and Description
default GetCostAndUsageRequest.Builder	filter(Consumer<Expression.Builder> filter) Filters AWS costs by different dimensions.
GetCostAndUsageRequest.Builder	filter(Expression filter) Filters AWS costs by different dimensions.
GetCostAndUsageRequest.Builder	granularity(Granularity granularity) Sets the AWS cost granularity to MONTHLY or DAILY.
GetCostAndUsageRequest.Builder	granularity(String granularity) Sets the AWS cost granularity to MONTHLY or DAILY.
GetCostAndUsageRequest.Builder	groupBy(Collection<GroupDefinition> groupBy) You can group AWS costs using up to two different groups, either dimensions, tag keys, or both.
GetCostAndUsageRequest.Builder	groupBy(Consumer<GroupDefinition.Builder>... groupBy) You can group AWS costs using up to two different groups, either dimensions, tag keys, or both.
GetCostAndUsageRequest.Builder	groupBy(GroupDefinition... groupBy) You can group AWS costs using up to two different groups, either dimensions, tag keys, or both.
GetCostAndUsageRequest.Builder	metrics(Collection<String> metrics) Which metrics are returned in the query.
GetCostAndUsageRequest.Builder	metrics(String... metrics) Which metrics are returned in the query.
GetCostAndUsageRequest.Builder	nextPageToken(String nextPageToken) The token to retrieve the next set of results.
GetCostAndUsageRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
GetCostAndUsageRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
default GetCostAndUsageRequest.Builder	timePeriod(Consumer<DateInterval.Builder> timePeriod) Sets the start and end dates for retrieving AWS costs.
GetCostAndUsageRequest.Builder	timePeriod(DateInterval timePeriod) Sets the start and end dates for retrieving AWS costs.

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

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

GetCostAndUsageRequest.Builder timePeriod(DateInterval timePeriod)

Sets the start and end dates for retrieving AWS costs. 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.

Parameters:

timePeriod - Sets the start and end dates for retrieving AWS costs. 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.

Returns:

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

timePeriod

default GetCostAndUsageRequest.Builder timePeriod(Consumer<DateInterval.Builder> timePeriod)

Sets the start and end dates for retrieving AWS costs. 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.

This is a convenience 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)

granularity

GetCostAndUsageRequest.Builder granularity(String granularity)

Sets the AWS cost granularity to MONTHLY or DAILY. If Granularity isn't set, the response object doesn't include the Granularity, either MONTHLY or DAILY.

Parameters:

granularity - Sets the AWS cost granularity to MONTHLY or DAILY. If Granularity isn't set, the response object doesn't include the Granularity, either MONTHLY or DAILY.

Returns:

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

See Also:

Granularity, Granularity

granularity

GetCostAndUsageRequest.Builder granularity(Granularity granularity)

Sets the AWS cost granularity to MONTHLY or DAILY. If Granularity isn't set, the response object doesn't include the Granularity, either MONTHLY or DAILY.

Parameters:

granularity - Sets the AWS cost granularity to MONTHLY or DAILY. If Granularity isn't set, the response object doesn't include the Granularity, either MONTHLY or DAILY.

Returns:

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

See Also:

Granularity, Granularity

filter

GetCostAndUsageRequest.Builder filter(Expression filter)

Filters AWS costs by different dimensions. For example, you can specify SERVICE and LINKED_ACCOUNT and get the costs that are associated with that account's usage of that service. You can nest Expression objects to define any combination of dimension filters. For more information, see Expression.

Parameters:

filter - Filters AWS costs by different dimensions. For example, you can specify SERVICE and LINKED_ACCOUNT and get the costs that are associated with that account's usage of that service. You can nest Expression objects to define any combination of dimension filters. For more information, see Expression.

Returns:

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

filter

default GetCostAndUsageRequest.Builder filter(Consumer<Expression.Builder> filter)

Filters AWS costs by different dimensions. For example, you can specify SERVICE and LINKED_ACCOUNT and get the costs that are associated with that account's usage of that service. You can nest Expression objects to define any combination of dimension filters. For more information, see Expression.

This is a convenience 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

GetCostAndUsageRequest.Builder metrics(Collection<String> metrics)

Which metrics are returned in the query. For more information about blended and unblended rates, see Why does the "blended" annotation appear on some line items in my bill?.

Valid values are AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost, NormalizedUsageAmount, UnblendedCost, and UsageQuantity.

If you return the UsageQuantity metric, the service aggregates all usage numbers without taking into account the units. For example, if you aggregate usageQuantity across all of EC2, the results aren't meaningful because EC2 compute hours and data transfer are measured in different units (for example, hours vs. GB). To get more meaningful UsageQuantity metrics, filter by UsageType or UsageTypeGroups.

Metrics is required for GetCostAndUsage requests.

Parameters:

metrics - Which metrics are returned in the query. For more information about blended and unblended rates, see Why does the "blended" annotation appear on some line items in my bill?.

Valid values are AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost, NormalizedUsageAmount, UnblendedCost, and UsageQuantity.

If you return the UsageQuantity metric, the service aggregates all usage numbers without taking into account the units. For example, if you aggregate usageQuantity across all of EC2, the results aren't meaningful because EC2 compute hours and data transfer are measured in different units (for example, hours vs. GB). To get more meaningful UsageQuantity metrics, filter by UsageType or UsageTypeGroups.

Metrics is required for GetCostAndUsage requests.

Returns:

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

metrics

GetCostAndUsageRequest.Builder metrics(String... metrics)

Which metrics are returned in the query. For more information about blended and unblended rates, see Why does the "blended" annotation appear on some line items in my bill?.

Valid values are AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost, NormalizedUsageAmount, UnblendedCost, and UsageQuantity.

If you return the UsageQuantity metric, the service aggregates all usage numbers without taking into account the units. For example, if you aggregate usageQuantity across all of EC2, the results aren't meaningful because EC2 compute hours and data transfer are measured in different units (for example, hours vs. GB). To get more meaningful UsageQuantity metrics, filter by UsageType or UsageTypeGroups.

Metrics is required for GetCostAndUsage requests.

Parameters:

metrics - Which metrics are returned in the query. For more information about blended and unblended rates, see Why does the "blended" annotation appear on some line items in my bill?.

Valid values are AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost, NormalizedUsageAmount, UnblendedCost, and UsageQuantity.

If you return the UsageQuantity metric, the service aggregates all usage numbers without taking into account the units. For example, if you aggregate usageQuantity across all of EC2, the results aren't meaningful because EC2 compute hours and data transfer are measured in different units (for example, hours vs. GB). To get more meaningful UsageQuantity metrics, filter by UsageType or UsageTypeGroups.

Metrics is required for GetCostAndUsage requests.

Returns:

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

groupBy

GetCostAndUsageRequest.Builder groupBy(Collection<GroupDefinition> groupBy)

You can group AWS costs using up to two different groups, either dimensions, tag keys, or both.

When you group by tag key, you get all tag values, including empty strings.

Valid values are AZ, INSTANCE_TYPE, LEGAL_ENTITY_NAME, LINKED_ACCOUNT, OPERATION, PLATFORM, PURCHASE_TYPE, SERVICE, TAGS, TENANCY, and USAGE_TYPE.

Parameters:

groupBy - You can group AWS costs using up to two different groups, either dimensions, tag keys, or both.

When you group by tag key, you get all tag values, including empty strings.

Valid values are AZ, INSTANCE_TYPE, LEGAL_ENTITY_NAME, LINKED_ACCOUNT, OPERATION, PLATFORM, PURCHASE_TYPE, SERVICE, TAGS, TENANCY, and USAGE_TYPE.

Returns:

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

groupBy

GetCostAndUsageRequest.Builder groupBy(GroupDefinition... groupBy)

You can group AWS costs using up to two different groups, either dimensions, tag keys, or both.

When you group by tag key, you get all tag values, including empty strings.

Valid values are AZ, INSTANCE_TYPE, LEGAL_ENTITY_NAME, LINKED_ACCOUNT, OPERATION, PLATFORM, PURCHASE_TYPE, SERVICE, TAGS, TENANCY, and USAGE_TYPE.

Parameters:

groupBy - You can group AWS costs using up to two different groups, either dimensions, tag keys, or both.

When you group by tag key, you get all tag values, including empty strings.

Valid values are AZ, INSTANCE_TYPE, LEGAL_ENTITY_NAME, LINKED_ACCOUNT, OPERATION, PLATFORM, PURCHASE_TYPE, SERVICE, TAGS, TENANCY, and USAGE_TYPE.

Returns:

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

groupBy

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

You can group AWS costs using up to two different groups, either dimensions, tag keys, or both.

When you group by tag key, you get all tag values, including empty strings.

Valid values are AZ, INSTANCE_TYPE, LEGAL_ENTITY_NAME, LINKED_ACCOUNT, OPERATION, PLATFORM, PURCHASE_TYPE, SERVICE, TAGS, TENANCY, and USAGE_TYPE.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #groupBy(List).

Parameters:

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

Returns:

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

See Also:

#groupBy(List)

nextPageToken

GetCostAndUsageRequest.Builder nextPageToken(String nextPageToken)

The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.

Parameters:

nextPageToken - The token to retrieve the next set of results. AWS 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.

overrideConfiguration

GetCostAndUsageRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

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

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.