Interface GetCostAndUsageRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<GetCostAndUsageRequest.Builder,
,GetCostAndUsageRequest> CostExplorerRequest.Builder
,SdkBuilder<GetCostAndUsageRequest.Builder,
,GetCostAndUsageRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
GetCostAndUsageRequest
-
Method Summary
Modifier and TypeMethodDescriptiondefault GetCostAndUsageRequest.Builder
filter
(Consumer<Expression.Builder> filter) Filters Amazon Web Services costs by different dimensions.filter
(Expression filter) Filters Amazon Web Services costs by different dimensions.granularity
(String granularity) Sets the Amazon Web Services cost granularity toMONTHLY
orDAILY
, orHOURLY
.granularity
(Granularity granularity) Sets the Amazon Web Services cost granularity toMONTHLY
orDAILY
, orHOURLY
.groupBy
(Collection<GroupDefinition> groupBy) You can group Amazon Web Services costs using up to two different groups, either dimensions, tag keys, cost categories, or any two group by types.groupBy
(Consumer<GroupDefinition.Builder>... groupBy) You can group Amazon Web Services costs using up to two different groups, either dimensions, tag keys, cost categories, or any two group by types.groupBy
(GroupDefinition... groupBy) You can group Amazon Web Services costs using up to two different groups, either dimensions, tag keys, cost categories, or any two group by types.Which metrics are returned in the query.metrics
(Collection<String> metrics) Which metrics are returned in the query.nextPageToken
(String nextPageToken) The token to retrieve the next set of results.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.default GetCostAndUsageRequest.Builder
timePeriod
(Consumer<DateInterval.Builder> timePeriod) Sets the start date and end date for retrieving Amazon Web Services costs.timePeriod
(DateInterval timePeriod) Sets the start date and end date for retrieving Amazon Web Services costs.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.costexplorer.model.CostExplorerRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
timePeriod
Sets the start date and end date for retrieving Amazon Web Services costs. The start date is inclusive, but the end date is exclusive. For example, if
start
is2017-01-01
andend
is2017-05-01
, then the cost and usage data is retrieved from2017-01-01
up to and including2017-04-30
but not including2017-05-01
.- Parameters:
timePeriod
- Sets the start date and end date for retrieving Amazon Web Services costs. The start date is inclusive, but the end date is exclusive. For example, ifstart
is2017-01-01
andend
is2017-05-01
, then the cost and usage data is retrieved from2017-01-01
up to and including2017-04-30
but not including2017-05-01
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
timePeriod
Sets the start date and end date for retrieving Amazon Web Services costs. The start date is inclusive, but the end date is exclusive. For example, if
This is a convenience method that creates an instance of thestart
is2017-01-01
andend
is2017-05-01
, then the cost and usage data is retrieved from2017-01-01
up to and including2017-04-30
but not including2017-05-01
.DateInterval.Builder
avoiding the need to create one manually viaDateInterval.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totimePeriod(DateInterval)
.- Parameters:
timePeriod
- a consumer that will call methods onDateInterval.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
granularity
Sets the Amazon Web Services cost granularity to
MONTHLY
orDAILY
, orHOURLY
. IfGranularity
isn't set, the response object doesn't include theGranularity
, eitherMONTHLY
orDAILY
, orHOURLY
.- Parameters:
granularity
- Sets the Amazon Web Services cost granularity toMONTHLY
orDAILY
, orHOURLY
. IfGranularity
isn't set, the response object doesn't include theGranularity
, eitherMONTHLY
orDAILY
, orHOURLY
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
granularity
Sets the Amazon Web Services cost granularity to
MONTHLY
orDAILY
, orHOURLY
. IfGranularity
isn't set, the response object doesn't include theGranularity
, eitherMONTHLY
orDAILY
, orHOURLY
.- Parameters:
granularity
- Sets the Amazon Web Services cost granularity toMONTHLY
orDAILY
, orHOURLY
. IfGranularity
isn't set, the response object doesn't include theGranularity
, eitherMONTHLY
orDAILY
, orHOURLY
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
filter
Filters Amazon Web Services costs by different dimensions. For example, you can specify
SERVICE
andLINKED_ACCOUNT
and get the costs that are associated with that account's usage of that service. You can nestExpression
objects to define any combination of dimension filters. For more information, see Expression.Valid values for
MatchOptions
forDimensions
areEQUALS
andCASE_SENSITIVE
.Valid values for
MatchOptions
forCostCategories
andTags
areEQUALS
,ABSENT
, andCASE_SENSITIVE
. Default values areEQUALS
andCASE_SENSITIVE
.- Parameters:
filter
- Filters Amazon Web Services costs by different dimensions. For example, you can specifySERVICE
andLINKED_ACCOUNT
and get the costs that are associated with that account's usage of that service. You can nestExpression
objects to define any combination of dimension filters. For more information, see Expression.Valid values for
MatchOptions
forDimensions
areEQUALS
andCASE_SENSITIVE
.Valid values for
MatchOptions
forCostCategories
andTags
areEQUALS
,ABSENT
, andCASE_SENSITIVE
. Default values areEQUALS
andCASE_SENSITIVE
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filter
Filters Amazon Web Services costs by different dimensions. For example, you can specify
SERVICE
andLINKED_ACCOUNT
and get the costs that are associated with that account's usage of that service. You can nestExpression
objects to define any combination of dimension filters. For more information, see Expression.Valid values for
MatchOptions
forDimensions
areEQUALS
andCASE_SENSITIVE
.Valid values for
This is a convenience method that creates an instance of theMatchOptions
forCostCategories
andTags
areEQUALS
,ABSENT
, andCASE_SENSITIVE
. Default values areEQUALS
andCASE_SENSITIVE
.Expression.Builder
avoiding the need to create one manually viaExpression.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofilter(Expression)
.- Parameters:
filter
- a consumer that will call methods onExpression.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
, andUsageQuantity
.If you return the
UsageQuantity
metric, the service aggregates all usage numbers without taking into account the units. For example, if you aggregateusageQuantity
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 and GB). To get more meaningfulUsageQuantity
metrics, filter byUsageType
orUsageTypeGroups
.Metrics
is required forGetCostAndUsage
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
, andUsageQuantity
.If you return the
UsageQuantity
metric, the service aggregates all usage numbers without taking into account the units. For example, if you aggregateusageQuantity
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 and GB). To get more meaningfulUsageQuantity
metrics, filter byUsageType
orUsageTypeGroups
.Metrics
is required forGetCostAndUsage
requests.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
, andUsageQuantity
.If you return the
UsageQuantity
metric, the service aggregates all usage numbers without taking into account the units. For example, if you aggregateusageQuantity
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 and GB). To get more meaningfulUsageQuantity
metrics, filter byUsageType
orUsageTypeGroups
.Metrics
is required forGetCostAndUsage
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
, andUsageQuantity
.If you return the
UsageQuantity
metric, the service aggregates all usage numbers without taking into account the units. For example, if you aggregateusageQuantity
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 and GB). To get more meaningfulUsageQuantity
metrics, filter byUsageType
orUsageTypeGroups
.Metrics
is required forGetCostAndUsage
requests.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
groupBy
You can group Amazon Web Services costs using up to two different groups, either dimensions, tag keys, cost categories, or any two group by types.
Valid values for the
DIMENSION
type areAZ
,INSTANCE_TYPE
,LEGAL_ENTITY_NAME
,INVOICING_ENTITY
,LINKED_ACCOUNT
,OPERATION
,PLATFORM
,PURCHASE_TYPE
,SERVICE
,TENANCY
,RECORD_TYPE
, andUSAGE_TYPE
.When you group by the
TAG
type and include a valid tag key, you get all tag values, including empty strings.- Parameters:
groupBy
- You can group Amazon Web Services costs using up to two different groups, either dimensions, tag keys, cost categories, or any two group by types.Valid values for the
DIMENSION
type areAZ
,INSTANCE_TYPE
,LEGAL_ENTITY_NAME
,INVOICING_ENTITY
,LINKED_ACCOUNT
,OPERATION
,PLATFORM
,PURCHASE_TYPE
,SERVICE
,TENANCY
,RECORD_TYPE
, andUSAGE_TYPE
.When you group by the
TAG
type and include a valid tag key, you get all tag values, including empty strings.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
groupBy
You can group Amazon Web Services costs using up to two different groups, either dimensions, tag keys, cost categories, or any two group by types.
Valid values for the
DIMENSION
type areAZ
,INSTANCE_TYPE
,LEGAL_ENTITY_NAME
,INVOICING_ENTITY
,LINKED_ACCOUNT
,OPERATION
,PLATFORM
,PURCHASE_TYPE
,SERVICE
,TENANCY
,RECORD_TYPE
, andUSAGE_TYPE
.When you group by the
TAG
type and include a valid tag key, you get all tag values, including empty strings.- Parameters:
groupBy
- You can group Amazon Web Services costs using up to two different groups, either dimensions, tag keys, cost categories, or any two group by types.Valid values for the
DIMENSION
type areAZ
,INSTANCE_TYPE
,LEGAL_ENTITY_NAME
,INVOICING_ENTITY
,LINKED_ACCOUNT
,OPERATION
,PLATFORM
,PURCHASE_TYPE
,SERVICE
,TENANCY
,RECORD_TYPE
, andUSAGE_TYPE
.When you group by the
TAG
type and include a valid tag key, you get all tag values, including empty strings.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
groupBy
You can group Amazon Web Services costs using up to two different groups, either dimensions, tag keys, cost categories, or any two group by types.
Valid values for the
DIMENSION
type areAZ
,INSTANCE_TYPE
,LEGAL_ENTITY_NAME
,INVOICING_ENTITY
,LINKED_ACCOUNT
,OPERATION
,PLATFORM
,PURCHASE_TYPE
,SERVICE
,TENANCY
,RECORD_TYPE
, andUSAGE_TYPE
.When you group by the
This is a convenience method that creates an instance of theTAG
type and include a valid tag key, you get all tag values, including empty strings.GroupDefinition.Builder
avoiding the need to create one manually viaGroupDefinition.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed togroupBy(List<GroupDefinition>)
.- Parameters:
groupBy
- a consumer that will call methods onGroupDefinition.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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.- 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 interfaceAwsRequest.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 interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-