aws-sdk-forecast 1.101.0

AWS SDK for Amazon Forecast Service
Documentation
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeForecastExportJob`](crate::operation::describe_forecast_export_job::builders::DescribeForecastExportJobFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`forecast_export_job_arn(impl Into<String>)`](crate::operation::describe_forecast_export_job::builders::DescribeForecastExportJobFluentBuilder::forecast_export_job_arn) / [`set_forecast_export_job_arn(Option<String>)`](crate::operation::describe_forecast_export_job::builders::DescribeForecastExportJobFluentBuilder::set_forecast_export_job_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the forecast export job.</p><br>
    /// - On success, responds with [`DescribeForecastExportJobOutput`](crate::operation::describe_forecast_export_job::DescribeForecastExportJobOutput) with field(s):
    ///   - [`forecast_export_job_arn(Option<String>)`](crate::operation::describe_forecast_export_job::DescribeForecastExportJobOutput::forecast_export_job_arn): <p>The ARN of the forecast export job.</p>
    ///   - [`forecast_export_job_name(Option<String>)`](crate::operation::describe_forecast_export_job::DescribeForecastExportJobOutput::forecast_export_job_name): <p>The name of the forecast export job.</p>
    ///   - [`forecast_arn(Option<String>)`](crate::operation::describe_forecast_export_job::DescribeForecastExportJobOutput::forecast_arn): <p>The Amazon Resource Name (ARN) of the exported forecast.</p>
    ///   - [`destination(Option<DataDestination>)`](crate::operation::describe_forecast_export_job::DescribeForecastExportJobOutput::destination): <p>The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.</p>
    ///   - [`message(Option<String>)`](crate::operation::describe_forecast_export_job::DescribeForecastExportJobOutput::message): <p>If an error occurred, an informational message about the error.</p>
    ///   - [`status(Option<String>)`](crate::operation::describe_forecast_export_job::DescribeForecastExportJobOutput::status): <p>The status of the forecast export job. 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 forecast export job must be <code>ACTIVE</code> before you can access the forecast in your S3 bucket.</p> </note>
    ///   - [`creation_time(Option<DateTime>)`](crate::operation::describe_forecast_export_job::DescribeForecastExportJobOutput::creation_time): <p>When the forecast export job was created.</p>
    ///   - [`last_modification_time(Option<DateTime>)`](crate::operation::describe_forecast_export_job::DescribeForecastExportJobOutput::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>
    ///   - [`format(Option<String>)`](crate::operation::describe_forecast_export_job::DescribeForecastExportJobOutput::format): <p>The format of the exported data, CSV or PARQUET.</p>
    /// - On failure, responds with [`SdkError<DescribeForecastExportJobError>`](crate::operation::describe_forecast_export_job::DescribeForecastExportJobError)
    pub fn describe_forecast_export_job(&self) -> crate::operation::describe_forecast_export_job::builders::DescribeForecastExportJobFluentBuilder {
        crate::operation::describe_forecast_export_job::builders::DescribeForecastExportJobFluentBuilder::new(self.handle.clone())
    }
}