Struct aws_sdk_forecast::client::fluent_builders::CreateWhatIfAnalysis

pub struct CreateWhatIfAnalysis { /* private fields */ }

Fluent builder constructing a request to CreateWhatIfAnalysis.

What-if analysis is a scenario modeling technique where you make a hypothetical change to a time series and compare the forecasts generated by these changes against the baseline, unchanged time series. It is important to remember that the purpose of a what-if analysis is to understand how a forecast can change given different modifications to the baseline time series.

For example, imagine you are a clothing retailer who is considering an end of season sale to clear space for new styles. After creating a baseline forecast, you can use a what-if analysis to investigate how different sales tactics might affect your goals. You could create a scenario where everything is given a 25% markdown and another where everything is given a fixed dollar markdown. You can create a scenario where the sale lasts for 1 week and another where the sale lasts for 1 month. Your what-if analysis enables you to compare many different scenarios against each other.

Note that a what-if analysis is meant to display what the forecasting model has learned and how it will behave in the scenarios that you are evaluating. Do not blindly use the results of the what-if analysis to make business decisions. For instance, forecasts might not be accurate for novel scenarios where there is no reference available to determine whether a forecast is good.

The TimeSeriesSelector object defines the items that you want in the what-if analysis.

Implementations

impl CreateWhatIfAnalysis

pub async fn customize(
    self
) -> Result<CustomizableOperation<CreateWhatIfAnalysis, AwsResponseRetryClassifier>, SdkError<CreateWhatIfAnalysisError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<CreateWhatIfAnalysisOutput, SdkError<CreateWhatIfAnalysisError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn what_if_analysis_name(self, input: impl Into<String>) -> Self

The name of the what-if analysis. Each name must be unique.

pub fn set_what_if_analysis_name(self, input: Option<String>) -> Self

The name of the what-if analysis. Each name must be unique.

pub fn forecast_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) of the baseline forecast.

pub fn set_forecast_arn(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) of the baseline forecast.

pub fn time_series_selector(self, input: TimeSeriesSelector) -> Self

Defines the set of time series that are used in the what-if analysis with a TimeSeriesIdentifiers object. What-if analyses are performed only for the time series in this object.

The TimeSeriesIdentifiers object needs the following information:

• DataSource

• Format

• Schema

pub fn set_time_series_selector(self, input: Option<TimeSeriesSelector>) -> Self

Defines the set of time series that are used in the what-if analysis with a TimeSeriesIdentifiers object. What-if analyses are performed only for the time series in this object.

The TimeSeriesIdentifiers object needs the following information:

• DataSource

• Format

• Schema

pub fn tags(self, input: Tag) -> Self

Appends an item to Tags.

To override the contents of this collection use set_tags.

A list of tags to apply to the what if forecast.

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

A list of tags to apply to the what if forecast.

Trait Implementations

impl Clone for CreateWhatIfAnalysis

fn clone(&self) -> CreateWhatIfAnalysis

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateWhatIfAnalysis

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.