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

Interface GetCostForecastRequest.Builder

    • Method Detail

      • timePeriod

        GetCostForecastRequest.Builder timePeriod​(DateInterval timePeriod)

        The period of time that you want the forecast to cover. The start date must be equal to or no later than the current date to avoid a validation error.

        Parameters:
        timePeriod - The period of time that you want the forecast to cover. The start date must be equal to or no 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.

      • granularity

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

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

        GetCostForecastRequest.Builder filter​(Expression filter)

        The filters that you want to use to filter your forecast. The GetCostForecast 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 GetCostForecast 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 GetCostForecastRequest.Builder filter​(Consumer<Expression.Builder> filter)

        The filters that you want to use to filter your forecast. The GetCostForecast 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

        GetCostForecastRequest.Builder predictionIntervalLevel​(Integer predictionIntervalLevel)

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