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

Interface GetUsageForecastRequest.Builder

    • Method Detail

      • timePeriod

        GetUsageForecastRequest.Builder timePeriod​(DateInterval timePeriod)

        The start and end dates of the period that you want to retrieve usage forecast for. The start date is included in the period, but the end date isn't included in the period. 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. The start date must be equal to or later than the current date to avoid a validation error.

        Parameters:
        timePeriod - The start and end dates of the period that you want to retrieve usage forecast for. The start date is included in the period, but the end date isn't included in the period. 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. The start date must be equal to or later than the current date to avoid a validation error.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • timePeriod

        default GetUsageForecastRequest.Builder timePeriod​(Consumer<DateInterval.Builder> timePeriod)

        The start and end dates of the period that you want to retrieve usage forecast for. The start date is included in the period, but the end date isn't included in the period. 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. The start date must be equal to or later than the current date to avoid a validation error.

        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:
        timePeriod(DateInterval)

      • metric

        GetUsageForecastRequest.Builder metric​(String metric)

        Which metric Cost Explorer uses to create your forecast.

        Valid values for a GetUsageForecast call are the following:

        • USAGE_QUANTITY

        • NORMALIZED_USAGE_AMOUNT

        Parameters:
        metric - Which metric Cost Explorer uses to create your forecast.

        Valid values for a GetUsageForecast call are the following:

        • USAGE_QUANTITY

        • NORMALIZED_USAGE_AMOUNT

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

      • metric

        GetUsageForecastRequest.Builder metric​(Metric metric)

        Which metric Cost Explorer uses to create your forecast.

        Valid values for a GetUsageForecast call are the following:

        • USAGE_QUANTITY

        • NORMALIZED_USAGE_AMOUNT

        Parameters:
        metric - Which metric Cost Explorer uses to create your forecast.

        Valid values for a GetUsageForecast call are the following:

        • USAGE_QUANTITY

        • NORMALIZED_USAGE_AMOUNT

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

      • granularity

        GetUsageForecastRequest.Builder granularity​(String granularity)

        How granular you want the forecast to be. You can get 3 months of DAILY forecasts or 12 months of MONTHLY forecasts.

        The GetUsageForecast operation supports only DAILY and MONTHLY granularities.

        Parameters:
        granularity - How granular you want the forecast to be. You can get 3 months of DAILY forecasts or 12 months of MONTHLY forecasts.

        The GetUsageForecast operation supports only DAILY and MONTHLY granularities.

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

      • granularity

        GetUsageForecastRequest.Builder granularity​(Granularity granularity)

        How granular you want the forecast to be. You can get 3 months of DAILY forecasts or 12 months of MONTHLY forecasts.

        The GetUsageForecast operation supports only DAILY and MONTHLY granularities.

        Parameters:
        granularity - How granular you want the forecast to be. You can get 3 months of DAILY forecasts or 12 months of MONTHLY forecasts.

        The GetUsageForecast operation supports only DAILY and MONTHLY granularities.

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

      • filter

        GetUsageForecastRequest.Builder filter​(Expression filter)

        The filters that you want to use to filter your forecast. The GetUsageForecast API supports filtering by the following dimensions:

        • AZ

        • INSTANCE_TYPE

        • LINKED_ACCOUNT

        • LINKED_ACCOUNT_NAME

        • OPERATION

        • PURCHASE_TYPE

        • REGION

        • SERVICE

        • USAGE_TYPE

        • USAGE_TYPE_GROUP

        • RECORD_TYPE

        • OPERATING_SYSTEM

        • TENANCY

        • SCOPE

        • PLATFORM

        • SUBSCRIPTION_ID

        • LEGAL_ENTITY_NAME

        • DEPLOYMENT_OPTION

        • DATABASE_ENGINE

        • INSTANCE_TYPE_FAMILY

        • BILLING_ENTITY

        • RESERVATION_ID

        • SAVINGS_PLAN_ARN

        Parameters:
        filter - The filters that you want to use to filter your forecast. The GetUsageForecast API supports filtering by the following dimensions:

        • AZ

        • INSTANCE_TYPE

        • LINKED_ACCOUNT

        • LINKED_ACCOUNT_NAME

        • OPERATION

        • PURCHASE_TYPE

        • REGION

        • SERVICE

        • USAGE_TYPE

        • USAGE_TYPE_GROUP

        • RECORD_TYPE

        • OPERATING_SYSTEM

        • TENANCY

        • SCOPE

        • PLATFORM

        • SUBSCRIPTION_ID

        • LEGAL_ENTITY_NAME

        • DEPLOYMENT_OPTION

        • DATABASE_ENGINE

        • INSTANCE_TYPE_FAMILY

        • BILLING_ENTITY

        • RESERVATION_ID

        • SAVINGS_PLAN_ARN

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

      • filter

        default GetUsageForecastRequest.Builder filter​(Consumer<Expression.Builder> filter)

        The filters that you want to use to filter your forecast. The GetUsageForecast API supports filtering by the following dimensions:

        • AZ

        • INSTANCE_TYPE

        • LINKED_ACCOUNT

        • LINKED_ACCOUNT_NAME

        • OPERATION

        • PURCHASE_TYPE

        • REGION

        • SERVICE

        • USAGE_TYPE

        • USAGE_TYPE_GROUP

        • RECORD_TYPE

        • OPERATING_SYSTEM

        • TENANCY

        • SCOPE

        • PLATFORM

        • SUBSCRIPTION_ID

        • LEGAL_ENTITY_NAME

        • DEPLOYMENT_OPTION

        • DATABASE_ENGINE

        • INSTANCE_TYPE_FAMILY

        • BILLING_ENTITY

        • RESERVATION_ID

        • SAVINGS_PLAN_ARN

        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)

      • predictionIntervalLevel

        GetUsageForecastRequest.Builder predictionIntervalLevel​(Integer predictionIntervalLevel)

        Amazon Web Services Cost Explorer always returns the mean forecast as a single point. You can request a prediction interval around the mean by specifying a confidence level. The higher the confidence level, the more confident Cost Explorer is about the actual value falling in the prediction interval. Higher confidence levels result in wider prediction intervals.

        Parameters:
        predictionIntervalLevel - Amazon Web Services Cost Explorer always returns the mean forecast as a single point. You can request a prediction interval around the mean by specifying a confidence level. The higher the confidence level, the more confident Cost Explorer is about the actual value falling in the prediction interval. Higher confidence levels result in wider prediction intervals.
        Returns:
        Returns a reference to this object so that method calls can be chained together.