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

Interface GetSavingsPlansUtilizationDetailsRequest.Builder

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

  • Method Details

    • timePeriod

      GetSavingsPlansUtilizationDetailsRequest.Builder timePeriod(DateInterval timePeriod)

      The time period that you want the usage and costs for. The Start date must be within 13 months. The End date must be after the Start date, and before the current date. Future dates can't be used as an End date.

      Parameters:
      timePeriod - The time period that you want the usage and costs for. The Start date must be within 13 months. The End date must be after the Start date, and before the current date. Future dates can't be used as an End date.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • timePeriod

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

      The time period that you want the usage and costs for. The Start date must be within 13 months. The End date must be after the Start date, and before the current date. Future dates can't be used as an End date.

      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:

    • filter

      GetSavingsPlansUtilizationDetailsRequest.Builder filter(Expression filter)

      Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions:

      • LINKED_ACCOUNT

      • SAVINGS_PLAN_ARN

      • REGION

      • PAYMENT_OPTION

      • INSTANCE_TYPE_FAMILY

      GetSavingsPlansUtilizationDetails uses the same Expression object as the other operations, but only AND is supported among each dimension.

      Parameters:
      filter - Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions:

      • LINKED_ACCOUNT

      • SAVINGS_PLAN_ARN

      • REGION

      • PAYMENT_OPTION

      • INSTANCE_TYPE_FAMILY

      GetSavingsPlansUtilizationDetails uses the same Expression object as the other operations, but only AND is supported among each dimension.

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

    • filter

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

      Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions:

      • LINKED_ACCOUNT

      • SAVINGS_PLAN_ARN

      • REGION

      • PAYMENT_OPTION

      • INSTANCE_TYPE_FAMILY

      GetSavingsPlansUtilizationDetails uses the same Expression object as the other operations, but only AND is supported among each dimension.

      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:

    • dataTypeWithStrings

      GetSavingsPlansUtilizationDetailsRequest.Builder dataTypeWithStrings(Collection<String> dataType)

      The data type.

      Parameters:
      dataType - The data type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataTypeWithStrings

      GetSavingsPlansUtilizationDetailsRequest.Builder dataTypeWithStrings(String... dataType)

      The data type.

      Parameters:
      dataType - The data type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataType

      GetSavingsPlansUtilizationDetailsRequest.Builder dataType(Collection<SavingsPlansDataType> dataType)

      The data type.

      Parameters:
      dataType - The data type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataType

      GetSavingsPlansUtilizationDetailsRequest.Builder dataType(SavingsPlansDataType... dataType)

      The data type.

      Parameters:
      dataType - The data type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      GetSavingsPlansUtilizationDetailsRequest.Builder nextToken(String nextToken)

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

    • maxResults

      GetSavingsPlansUtilizationDetailsRequest.Builder maxResults(Integer maxResults)

      The number of items to be returned in a response. The default is 20, with a minimum value of 1.

      Parameters:
      maxResults - The number of items to be returned in a response. The default is 20, with a minimum value of 1.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sortBy

      GetSavingsPlansUtilizationDetailsRequest.Builder sortBy(SortDefinition sortBy)

      The value that you want to sort the data by.

      The following values are supported for Key:

      • UtilizationPercentage

      • TotalCommitment

      • UsedCommitment

      • UnusedCommitment

      • NetSavings

      • AmortizedRecurringCommitment

      • AmortizedUpfrontCommitment

      The supported values for SortOrder are ASCENDING and DESCENDING.

      Parameters:
      sortBy - The value that you want to sort the data by.

      The following values are supported for Key:

      • UtilizationPercentage

      • TotalCommitment

      • UsedCommitment

      • UnusedCommitment

      • NetSavings

      • AmortizedRecurringCommitment

      • AmortizedUpfrontCommitment

      The supported values for SortOrder are ASCENDING and DESCENDING.

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

    • sortBy

      default GetSavingsPlansUtilizationDetailsRequest.Builder sortBy(Consumer<SortDefinition.Builder> sortBy)

      The value that you want to sort the data by.

      The following values are supported for Key:

      • UtilizationPercentage

      • TotalCommitment

      • UsedCommitment

      • UnusedCommitment

      • NetSavings

      • AmortizedRecurringCommitment

      • AmortizedUpfrontCommitment

      The supported values for SortOrder are ASCENDING and DESCENDING.

      This is a convenience method that creates an instance of the SortDefinition.Builder avoiding the need to create one manually via SortDefinition.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sortBy(SortDefinition).

      Parameters:
      sortBy - a consumer that will call methods on SortDefinition.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

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

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