Struct aws_sdk_forecast::client::fluent_builders::CreateForecastExportJob

pub struct CreateForecastExportJob { /* private fields */ }

Fluent builder constructing a request to CreateForecastExportJob.

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

_ _

where 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 forecast export jobs, use the ListForecastExportJobs 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 DescribeForecastExportJob operation.

Implementations

impl CreateForecastExportJob

pub async fn customize(
    self
) -> Result<CustomizableOperation<CreateForecastExportJob, AwsResponseRetryClassifier>, SdkError<CreateForecastExportJobError>>

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<CreateForecastExportJobOutput, SdkError<CreateForecastExportJobError>>

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

The name for the forecast export job.

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

The name for the forecast export job.

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

The Amazon Resource Name (ARN) of the forecast that you want to export.

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

The Amazon Resource Name (ARN) of the forecast that you want 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.

The optional metadata that you apply to the forecast export job to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

• Maximum number of tags per resource - 50.

• For each resource, each tag key must be unique, and each tag key can have only one value.

• Maximum key length - 128 Unicode characters in UTF-8.

• Maximum value length - 256 Unicode characters in UTF-8.

• If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

• Tag keys and values are case sensitive.

• Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.

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

The optional metadata that you apply to the forecast export job to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

• Maximum number of tags per resource - 50.

• For each resource, each tag key must be unique, and each tag key can have only one value.

• Maximum key length - 128 Unicode characters in UTF-8.

• Maximum value length - 256 Unicode characters in UTF-8.

• If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

• Tag keys and values are case sensitive.

• Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.

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

The format of the exported data, CSV or PARQUET. The default value is CSV.

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

The format of the exported data, CSV or PARQUET. The default value is CSV.

Trait Implementations

impl Clone for CreateForecastExportJob

fn clone(&self) -> CreateForecastExportJob

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateForecastExportJob

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

Formats the value using the given formatter.