software.amazon.awssdk.services.costexplorer.model

Class GetCostAndUsageWithResourcesRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetCostAndUsageWithResourcesRequest.Builder,GetCostAndUsageWithResourcesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetCostAndUsageWithResourcesRequest.Builder

Method Summary

Modifier and Type	Method and Description
static GetCostAndUsageWithResourcesRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Expression	filter() Filters Amazon Web Services costs by different dimensions.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
Granularity	granularity() Sets the AWS cost granularity to MONTHLY, DAILY, or HOURLY.
String	granularityAsString() Sets the AWS cost granularity to MONTHLY, DAILY, or HOURLY.
List<GroupDefinition>	groupBy() You can group Amazon Web Services costs using up to two different groups: DIMENSION, TAG, COST_CATEGORY.
boolean	hasGroupBy() Returns true if the GroupBy property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasMetrics() Returns true if the Metrics property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
List<String>	metrics() Which metrics are returned in the query.
String	nextPageToken() The token to retrieve the next set of results.
List<SdkField<?>>	sdkFields()
static Class<? extends GetCostAndUsageWithResourcesRequest.Builder>	serializableBuilderClass()
DateInterval	timePeriod() Sets the start and end dates for retrieving Amazon Web Services costs.
GetCostAndUsageWithResourcesRequest.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()

Sets the start and end dates for retrieving Amazon Web Services costs. The range must be within the last 14 days (the start date cannot be earlier than 14 days ago). 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:

Sets the start and end dates for retrieving Amazon Web Services costs. The range must be within the last 14 days (the start date cannot be earlier than 14 days ago). 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.

granularity

public final Granularity granularity()

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

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:

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

See Also:

Granularity

granularityAsString

public final String granularityAsString()

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

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:

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

See Also:

Granularity

filter

public final Expression filter()

Filters Amazon Web Services 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.

The GetCostAndUsageWithResources operation requires that you either group by or filter by a ResourceId. It requires the Expression "SERVICE = Amazon Elastic Compute Cloud - Compute" in the filter.

Returns:

Filters Amazon Web Services 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.

The GetCostAndUsageWithResources operation requires that you either group by or filter by a ResourceId. It requires the Expression "SERVICE = Amazon Elastic Compute Cloud - Compute" in the filter.

hasMetrics

public final boolean hasMetrics()

Returns true if the Metrics property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

metrics

public final List<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 the units into account. For example, if you aggregate usageQuantity across all of Amazon EC2, the results aren't meaningful because Amazon 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 GetCostAndUsageWithResources requests.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasMetrics() to see if a value was sent in this field.

Returns:

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 the units into account. For example, if you aggregate usageQuantity across all of Amazon EC2, the results aren't meaningful because Amazon 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 GetCostAndUsageWithResources requests.

hasGroupBy

public final boolean hasGroupBy()

Returns true if the GroupBy property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

groupBy

public final List<GroupDefinition> groupBy()

You can group Amazon Web Services costs using up to two different groups: DIMENSION, TAG, COST_CATEGORY.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasGroupBy() to see if a value was sent in this field.

Returns:

You can group Amazon Web Services costs using up to two different groups: DIMENSION, TAG, COST_CATEGORY.

nextPageToken

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

Returns:

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.

toBuilder

public GetCostAndUsageWithResourcesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetCostAndUsageWithResourcesRequest.Builder,GetCostAndUsageWithResourcesRequest>

Specified by:

toBuilder in class CostExplorerRequest

builder

public static GetCostAndUsageWithResourcesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetCostAndUsageWithResourcesRequest.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