1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeWhatIfForecast`](crate::operation::describe_what_if_forecast::builders::DescribeWhatIfForecastFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`what_if_forecast_arn(impl Into<String>)`](crate::operation::describe_what_if_forecast::builders::DescribeWhatIfForecastFluentBuilder::what_if_forecast_arn) / [`set_what_if_forecast_arn(Option<String>)`](crate::operation::describe_what_if_forecast::builders::DescribeWhatIfForecastFluentBuilder::set_what_if_forecast_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the what-if forecast that you are interested in.</p><br>
    /// - On success, responds with [`DescribeWhatIfForecastOutput`](crate::operation::describe_what_if_forecast::DescribeWhatIfForecastOutput) with field(s):
    ///   - [`what_if_forecast_name(Option<String>)`](crate::operation::describe_what_if_forecast::DescribeWhatIfForecastOutput::what_if_forecast_name): <p>The name of the what-if forecast.</p>
    ///   - [`what_if_forecast_arn(Option<String>)`](crate::operation::describe_what_if_forecast::DescribeWhatIfForecastOutput::what_if_forecast_arn): <p>The Amazon Resource Name (ARN) of the what-if forecast.</p>
    ///   - [`what_if_analysis_arn(Option<String>)`](crate::operation::describe_what_if_forecast::DescribeWhatIfForecastOutput::what_if_analysis_arn): <p>The Amazon Resource Name (ARN) of the what-if analysis that contains this forecast.</p>
    ///   - [`estimated_time_remaining_in_minutes(Option<i64>)`](crate::operation::describe_what_if_forecast::DescribeWhatIfForecastOutput::estimated_time_remaining_in_minutes): <p>The approximate time remaining to complete the what-if forecast, in minutes.</p>
    ///   - [`status(Option<String>)`](crate::operation::describe_what_if_forecast::DescribeWhatIfForecastOutput::status): <p>The status of the what-if forecast. States include:</p> <ul>  <li>   <p><code>ACTIVE</code></p></li>  <li>   <p><code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>, <code>CREATE_FAILED</code></p></li>  <li>   <p><code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code></p></li>  <li>   <p><code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>, <code>DELETE_FAILED</code></p></li> </ul><note>  <p>The <code>Status</code> of the what-if forecast must be <code>ACTIVE</code> before you can access the forecast.</p> </note>
    ///   - [`message(Option<String>)`](crate::operation::describe_what_if_forecast::DescribeWhatIfForecastOutput::message): <p>If an error occurred, an informational message about the error.</p>
    ///   - [`creation_time(Option<DateTime>)`](crate::operation::describe_what_if_forecast::DescribeWhatIfForecastOutput::creation_time): <p>When the what-if forecast was created.</p>
    ///   - [`last_modification_time(Option<DateTime>)`](crate::operation::describe_what_if_forecast::DescribeWhatIfForecastOutput::last_modification_time): <p>The last time the resource was modified. The timestamp depends on the status of the job:</p> <ul>  <li>   <p><code>CREATE_PENDING</code> - The <code>CreationTime</code>.</p></li>  <li>   <p><code>CREATE_IN_PROGRESS</code> - The current timestamp.</p></li>  <li>   <p><code>CREATE_STOPPING</code> - The current timestamp.</p></li>  <li>   <p><code>CREATE_STOPPED</code> - When the job stopped.</p></li>  <li>   <p><code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or failed.</p></li> </ul>
    ///   - [`time_series_transformations(Option<Vec::<TimeSeriesTransformation>>)`](crate::operation::describe_what_if_forecast::DescribeWhatIfForecastOutput::time_series_transformations): <p>An array of <code>Action</code> and <code>TimeSeriesConditions</code> elements that describe what transformations were applied to which time series.</p>
    ///   - [`time_series_replacements_data_source(Option<TimeSeriesReplacementsDataSource>)`](crate::operation::describe_what_if_forecast::DescribeWhatIfForecastOutput::time_series_replacements_data_source): <p>An array of <code>S3Config</code>, <code>Schema</code>, and <code>Format</code> elements that describe the replacement time series.</p>
    ///   - [`forecast_types(Option<Vec::<String>>)`](crate::operation::describe_what_if_forecast::DescribeWhatIfForecastOutput::forecast_types): <p>The quantiles at which probabilistic forecasts are generated. You can specify up to five quantiles per what-if forecast in the <code>CreateWhatIfForecast</code> operation. If you didn't specify quantiles, the default values are <code>\["0.1", "0.5", "0.9"\]</code>.</p>
    /// - On failure, responds with [`SdkError<DescribeWhatIfForecastError>`](crate::operation::describe_what_if_forecast::DescribeWhatIfForecastError)
    pub fn describe_what_if_forecast(&self) -> crate::operation::describe_what_if_forecast::builders::DescribeWhatIfForecastFluentBuilder {
        crate::operation::describe_what_if_forecast::builders::DescribeWhatIfForecastFluentBuilder::new(self.handle.clone())
    }
}