Struct aws_sdk_forecast::client::fluent_builders::CreatePredictorBacktestExportJob

pub struct CreatePredictorBacktestExportJob { /* private fields */ }

Fluent builder constructing a request to CreatePredictorBacktestExportJob.

Exports backtest forecasts and accuracy metrics generated by the CreateAutoPredictor or CreatePredictor operations. Two folders containing CSV or Parquet files are exported to your specified S3 bucket.

The export file names will match the following conventions:

_ _ .csv

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

You must specify a DataDestination object that includes an Amazon S3 bucket and 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.

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

Implementations

impl CreatePredictorBacktestExportJob

pub async fn customize(
    self
) -> Result<CustomizableOperation<CreatePredictorBacktestExportJob, AwsResponseRetryClassifier>, SdkError<CreatePredictorBacktestExportJobError>>

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<CreatePredictorBacktestExportJobOutput, SdkError<CreatePredictorBacktestExportJobError>>

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

The name for the backtest export job.

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

The name for the backtest export job.

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

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

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

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

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

The destination for an export job. Provide an S3 path, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to access the location, and an AWS Key Management Service (KMS) key (optional).

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

The destination for an export job. Provide an S3 path, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to access the location, and an AWS Key Management Service (KMS) key (optional).

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

Appends an item to Tags.

To override the contents of this collection use set_tags.

Optional metadata to help you categorize and organize your backtests. Each tag consists of a key and an optional value, both of which you define. Tag keys and values are case sensitive.

The following restrictions apply to tags:

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

• Maximum number of tags per resource: 50.

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

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

• Accepted characters: all letters and numbers, spaces representable in UTF-8, and + - = . _ : / @. If your tagging schema is used across other services and resources, the character restrictions of those services also apply.

• Key prefixes cannot include any upper or lowercase combination of aws: or AWS:. Values can have this prefix. If a tag value has aws as its prefix but the key does not, 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. You cannot edit or delete tag keys with this prefix.

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

Optional metadata to help you categorize and organize your backtests. Each tag consists of a key and an optional value, both of which you define. Tag keys and values are case sensitive.

The following restrictions apply to tags:

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

• Maximum number of tags per resource: 50.

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

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

• Accepted characters: all letters and numbers, spaces representable in UTF-8, and + - = . _ : / @. If your tagging schema is used across other services and resources, the character restrictions of those services also apply.

• Key prefixes cannot include any upper or lowercase combination of aws: or AWS:. Values can have this prefix. If a tag value has aws as its prefix but the key does not, 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. You cannot edit or delete tag keys with this prefix.

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 CreatePredictorBacktestExportJob

fn clone(&self) -> CreatePredictorBacktestExportJob

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreatePredictorBacktestExportJob

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

Formats the value using the given formatter.