Interface GetCostAndUsageRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<GetCostAndUsageRequest.Builder,GetCostAndUsageRequest>, CostExplorerRequest.Builder, SdkBuilder<GetCostAndUsageRequest.Builder,GetCostAndUsageRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
GetCostAndUsageRequest
@Mutable @NotThreadSafe public static interface GetCostAndUsageRequest.Builder extends CostExplorerRequest.Builder, SdkPojo, CopyableBuilder<GetCostAndUsageRequest.Builder,GetCostAndUsageRequest>

  • Method Details

    • timePeriod

      GetCostAndUsageRequest.Builder timePeriod(DateInterval 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 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 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 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 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 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 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:

    • granularity

      GetCostAndUsageRequest.Builder granularity(String granularity)

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

      Parameters:
      granularity - Sets the Amazon Web Services cost granularity to MONTHLY or DAILY, or HOURLY. If Granularity isn't set, the response object doesn't include the Granularity, either MONTHLY or DAILY, or HOURLY.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • granularity

      GetCostAndUsageRequest.Builder granularity(Granularity granularity)

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

      Parameters:
      granularity - Sets the Amazon Web Services cost granularity to MONTHLY or DAILY, or HOURLY. If Granularity isn't set, the response object doesn't include the Granularity, either MONTHLY or DAILY, or HOURLY.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • filter

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

      Valid values for MatchOptions for Dimensions are EQUALS and CASE_SENSITIVE.

      Valid values for MatchOptions for CostCategories, Tags, and ProductAttributes are EQUALS, ABSENT, and CASE_SENSITIVE. Default values are EQUALS and CASE_SENSITIVE.

      You can filter by product attributes with or without grouping by them. If you filter or group by product attributes, the results include only the costs of supported services, and a SERVICE filter is optional. For more information, see ProductAttributeValues.

      If you include a SERVICE filter, it must apply to the whole request: combine it with other filters by using And, and include it in every branch of an Or. A SERVICE filter inside Not doesn't meet this requirement, and the request fails with a ValidationException.

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

      Valid values for MatchOptions for Dimensions are EQUALS and CASE_SENSITIVE.

      Valid values for MatchOptions for CostCategories, Tags, and ProductAttributes are EQUALS, ABSENT, and CASE_SENSITIVE. Default values are EQUALS and CASE_SENSITIVE.

      You can filter by product attributes with or without grouping by them. If you filter or group by product attributes, the results include only the costs of supported services, and a SERVICE filter is optional. For more information, see ProductAttributeValues.

      If you include a SERVICE filter, it must apply to the whole request: combine it with other filters by using And, and include it in every branch of an Or. A SERVICE filter inside Not doesn't meet this requirement, and the request fails with a ValidationException.

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

      Valid values for MatchOptions for Dimensions are EQUALS and CASE_SENSITIVE.

      Valid values for MatchOptions for CostCategories, Tags, and ProductAttributes are EQUALS, ABSENT, and CASE_SENSITIVE. Default values are EQUALS and CASE_SENSITIVE.

      You can filter by product attributes with or without grouping by them. If you filter or group by product attributes, the results include only the costs of supported services, and a SERVICE filter is optional. For more information, see ProductAttributeValues.

      If you include a SERVICE filter, it must apply to the whole request: combine it with other filters by using And, and include it in every branch of an Or. A SERVICE filter inside Not doesn't meet this requirement, and the request fails with a ValidationException.

      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:

    • 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 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 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 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 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 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 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 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 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 Amazon Web Services costs using up to two different groups, either dimensions, tag keys, cost categories, product attributes, or any two group by types.

      Valid values for the DIMENSION type are AZ, INSTANCE_TYPE, LEGAL_ENTITY_NAME, INVOICING_ENTITY, LINKED_ACCOUNT, OPERATION, PLATFORM, PURCHASE_TYPE, SERVICE, TENANCY, RECORD_TYPE, and USAGE_TYPE.

      When you group by the TAG type and include a valid tag key, you get all tag values, including empty strings.

      To group by the PRODUCT_ATTRIBUTE type, set Key to a product attribute key, such as model. For the keys of each supported service, see ProductAttributeValues. The results include only the costs of supported services, and if you have no such costs, the response contains no groups.

      In the response, each group key has the format key$value, for example, model$Claude Sonnet 5. Costs that have no value for the key are in the group key$, for example, model$. Remove the key$ prefix before you use a value in a ProductAttributes filter. Keys are case-sensitive: if you group by a key that doesn't exist, such as Model, all of your costs of supported services are in the group Model$.

      Parameters:
      groupBy - You can group Amazon Web Services costs using up to two different groups, either dimensions, tag keys, cost categories, product attributes, or any two group by types.

      Valid values for the DIMENSION type are AZ, INSTANCE_TYPE, LEGAL_ENTITY_NAME, INVOICING_ENTITY, LINKED_ACCOUNT, OPERATION, PLATFORM, PURCHASE_TYPE, SERVICE, TENANCY, RECORD_TYPE, and USAGE_TYPE.

      When you group by the TAG type and include a valid tag key, you get all tag values, including empty strings.

      To group by the PRODUCT_ATTRIBUTE type, set Key to a product attribute key, such as model. For the keys of each supported service, see ProductAttributeValues. The results include only the costs of supported services, and if you have no such costs, the response contains no groups.

      In the response, each group key has the format key$value, for example, model$Claude Sonnet 5. Costs that have no value for the key are in the group key$, for example, model$. Remove the key$ prefix before you use a value in a ProductAttributes filter. Keys are case-sensitive: if you group by a key that doesn't exist, such as Model, all of your costs of supported services are in the group Model$.

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

    • groupBy

      GetCostAndUsageRequest.Builder groupBy(GroupDefinition... groupBy)

      You can group Amazon Web Services costs using up to two different groups, either dimensions, tag keys, cost categories, product attributes, or any two group by types.

      Valid values for the DIMENSION type are AZ, INSTANCE_TYPE, LEGAL_ENTITY_NAME, INVOICING_ENTITY, LINKED_ACCOUNT, OPERATION, PLATFORM, PURCHASE_TYPE, SERVICE, TENANCY, RECORD_TYPE, and USAGE_TYPE.

      When you group by the TAG type and include a valid tag key, you get all tag values, including empty strings.

      To group by the PRODUCT_ATTRIBUTE type, set Key to a product attribute key, such as model. For the keys of each supported service, see ProductAttributeValues. The results include only the costs of supported services, and if you have no such costs, the response contains no groups.

      In the response, each group key has the format key$value, for example, model$Claude Sonnet 5. Costs that have no value for the key are in the group key$, for example, model$. Remove the key$ prefix before you use a value in a ProductAttributes filter. Keys are case-sensitive: if you group by a key that doesn't exist, such as Model, all of your costs of supported services are in the group Model$.

      Parameters:
      groupBy - You can group Amazon Web Services costs using up to two different groups, either dimensions, tag keys, cost categories, product attributes, or any two group by types.

      Valid values for the DIMENSION type are AZ, INSTANCE_TYPE, LEGAL_ENTITY_NAME, INVOICING_ENTITY, LINKED_ACCOUNT, OPERATION, PLATFORM, PURCHASE_TYPE, SERVICE, TENANCY, RECORD_TYPE, and USAGE_TYPE.

      When you group by the TAG type and include a valid tag key, you get all tag values, including empty strings.

      To group by the PRODUCT_ATTRIBUTE type, set Key to a product attribute key, such as model. For the keys of each supported service, see ProductAttributeValues. The results include only the costs of supported services, and if you have no such costs, the response contains no groups.

      In the response, each group key has the format key$value, for example, model$Claude Sonnet 5. Costs that have no value for the key are in the group key$, for example, model$. Remove the key$ prefix before you use a value in a ProductAttributes filter. Keys are case-sensitive: if you group by a key that doesn't exist, such as Model, all of your costs of supported services are in the group Model$.

      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 Amazon Web Services costs using up to two different groups, either dimensions, tag keys, cost categories, product attributes, or any two group by types.

      Valid values for the DIMENSION type are AZ, INSTANCE_TYPE, LEGAL_ENTITY_NAME, INVOICING_ENTITY, LINKED_ACCOUNT, OPERATION, PLATFORM, PURCHASE_TYPE, SERVICE, TENANCY, RECORD_TYPE, and USAGE_TYPE.

      When you group by the TAG type and include a valid tag key, you get all tag values, including empty strings.

      To group by the PRODUCT_ATTRIBUTE type, set Key to a product attribute key, such as model. For the keys of each supported service, see ProductAttributeValues. The results include only the costs of supported services, and if you have no such costs, the response contains no groups.

      In the response, each group key has the format key$value, for example, model$Claude Sonnet 5. Costs that have no value for the key are in the group key$, for example, model$. Remove the key$ prefix before you use a value in a ProductAttributes filter. Keys are case-sensitive: if you group by a key that doesn't exist, such as Model, all of your costs of supported services are in the group Model$.

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

      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:

    • billingViewArn

      GetCostAndUsageRequest.Builder billingViewArn(String billingViewArn)

      The Amazon Resource Name (ARN) that uniquely identifies a specific billing view. The ARN is used to specify which particular billing view you want to interact with or retrieve information from when making API calls related to Amazon Web Services Billing and Cost Management features. The BillingViewArn can be retrieved by calling the ListBillingViews API.

      Parameters:
      billingViewArn - The Amazon Resource Name (ARN) that uniquely identifies a specific billing view. The ARN is used to specify which particular billing view you want to interact with or retrieve information from when making API calls related to Amazon Web Services Billing and Cost Management features. The BillingViewArn can be retrieved by calling the ListBillingViews API.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextPageToken

      GetCostAndUsageRequest.Builder nextPageToken(String 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 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.