Struct aws_sdk_forecast::operation::create_forecast_export_job::builders::CreateForecastExportJobInputBuilder

#[non_exhaustive]
pub struct CreateForecastExportJobInputBuilder { /* private fields */ }

A builder for CreateForecastExportJobInput.

Implementations

impl CreateForecastExportJobInputBuilder

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

The name for the forecast export job.

This field is required.

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

The name for the forecast export job.

pub fn get_forecast_export_job_name(&self) -> &Option<String>

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.

This field is required.

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 get_forecast_arn(&self) -> &Option<String>

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 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 Key Management Service (KMS) key. The IAM role must allow Amazon Forecast permission to access the key.

This field is required.

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

The location where you want to save the forecast and an 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 Key Management Service (KMS) key. The IAM role must allow Amazon Forecast permission to access the key.

pub fn get_destination(&self) -> &Option<DataDestination>

The location where you want to save the forecast and an 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 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 Amazon Web Services 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 Amazon Web Services 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 get_tags(&self) -> &Option<Vec<Tag>>

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 Amazon Web Services 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.

pub fn get_format(&self) -> &Option<String>

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

pub fn build(self) -> Result<CreateForecastExportJobInput, BuildError>

Consumes the builder and constructs a CreateForecastExportJobInput.

impl CreateForecastExportJobInputBuilder

pub async fn send_with( self, client: &Client ) -> Result<CreateForecastExportJobOutput, SdkError<CreateForecastExportJobError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for CreateForecastExportJobInputBuilder

fn clone(&self) -> CreateForecastExportJobInputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateForecastExportJobInputBuilder

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

Formats the value using the given formatter.

impl Default for CreateForecastExportJobInputBuilder

fn default() -> CreateForecastExportJobInputBuilder

Returns the “default value” for a type.

impl PartialEq for CreateForecastExportJobInputBuilder

fn eq(&self, other: &CreateForecastExportJobInputBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateForecastExportJobInputBuilder