Struct aws_sdk_forecast::client::fluent_builders::CreateWhatIfForecastExport

pub struct CreateWhatIfForecastExport { /* private fields */ }

Fluent builder constructing a request to CreateWhatIfForecastExport.

Exports a forecast created by the CreateWhatIfForecast operation to your Amazon Simple Storage Service (Amazon S3) bucket. The forecast file name will match the following conventions:

≈ _ _

The component is in Java SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ).

You must specify a DataDestination object that includes an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles.

For more information, see howitworks-forecast.

To get a list of all your what-if forecast export jobs, use the ListWhatIfForecastExports operation.

The Status of the forecast export job must be ACTIVE before you can access the forecast in your Amazon S3 bucket. To get the status, use the DescribeWhatIfForecastExport operation.

Implementations

impl CreateWhatIfForecastExport

pub async fn customize(
    self
) -> Result<CustomizableOperation<CreateWhatIfForecastExport, AwsResponseRetryClassifier>, SdkError<CreateWhatIfForecastExportError>>

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<CreateWhatIfForecastExportOutput, SdkError<CreateWhatIfForecastExportError>>

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_forecast_export_name(self, input: impl Into<String>) -> Self

The name of the what-if forecast to export.

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

The name of the what-if forecast to export.

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

Appends an item to WhatIfForecastArns.

To override the contents of this collection use set_what_if_forecast_arns.

The list of what-if forecast Amazon Resource Names (ARNs) to export.

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

The list of what-if forecast Amazon Resource Names (ARNs) to export.

pub fn destination(self, input: DataDestination) -> Self

The location where you want to save the forecast and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the location. The forecast must be exported to an Amazon S3 bucket.

If encryption is used, Destination must include an AWS Key Management Service (KMS) key. The IAM role must allow Amazon Forecast permission to access the key.

pub fn set_destination(self, input: Option<DataDestination>) -> Self

The location where you want to save the forecast and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the location. The forecast must be exported to an Amazon S3 bucket.

If encryption is used, Destination must include an AWS Key Management Service (KMS) key. The IAM role must allow Amazon Forecast permission to access the key.

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.

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

The format of the exported data, CSV or PARQUET.

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

The format of the exported data, CSV or PARQUET.

Trait Implementations

impl Clone for CreateWhatIfForecastExport

fn clone(&self) -> CreateWhatIfForecastExport

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateWhatIfForecastExport

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

Formats the value using the given formatter.