Package software.amazon.awssdk.services.costexplorer.model

Interface GetCostAndUsageWithResourcesRequest.Builder

    • Method Detail

      • timePeriod

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

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • granularity

        GetCostAndUsageWithResourcesRequest.Builder granularity​(String granularity)

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

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

      • granularity

        GetCostAndUsageWithResourcesRequest.Builder granularity​(Granularity granularity)

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

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

      • filter

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

        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.

        Valid values for MatchOptions for Dimensions are EQUALS and CASE_SENSITIVE.

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

        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.

        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.

        Valid values for MatchOptions for Dimensions are EQUALS and CASE_SENSITIVE.

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

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

      • filter

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

        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.

        Valid values for MatchOptions for Dimensions are EQUALS and CASE_SENSITIVE.

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

        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

        GetCostAndUsageWithResourcesRequest.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 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, hour or GB). To get more meaningful UsageQuantity metrics, filter by UsageType or UsageTypeGroups.

        Metrics is required for GetCostAndUsageWithResources 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 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, hour or GB). To get more meaningful UsageQuantity metrics, filter by UsageType or UsageTypeGroups.

        Metrics is required for GetCostAndUsageWithResources requests.

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

      • metrics

        GetCostAndUsageWithResourcesRequest.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 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, hour or GB). To get more meaningful UsageQuantity metrics, filter by UsageType or UsageTypeGroups.

        Metrics is required for GetCostAndUsageWithResources 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 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, hour or GB). To get more meaningful UsageQuantity metrics, filter by UsageType or UsageTypeGroups.

        Metrics is required for GetCostAndUsageWithResources requests.

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

      • groupBy

        GetCostAndUsageWithResourcesRequest.Builder groupBy​(Collection<GroupDefinition> groupBy)

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

        Parameters:
        groupBy - You can group Amazon Web Services costs using up to two different groups: DIMENSION, TAG, COST_CATEGORY.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • groupBy

        GetCostAndUsageWithResourcesRequest.Builder groupBy​(GroupDefinition... groupBy)

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

        Parameters:
        groupBy - You can group Amazon Web Services costs using up to two different groups: DIMENSION, TAG, COST_CATEGORY.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • nextPageToken

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