#[non_exhaustive]pub struct CreateForecastInputBuilder { /* private fields */ }
Expand description
A builder for CreateForecastInput
.
Implementations§
source§impl CreateForecastInputBuilder
impl CreateForecastInputBuilder
sourcepub fn forecast_name(self, input: impl Into<String>) -> Self
pub fn forecast_name(self, input: impl Into<String>) -> Self
A name for the forecast.
This field is required.sourcepub fn set_forecast_name(self, input: Option<String>) -> Self
pub fn set_forecast_name(self, input: Option<String>) -> Self
A name for the forecast.
sourcepub fn get_forecast_name(&self) -> &Option<String>
pub fn get_forecast_name(&self) -> &Option<String>
A name for the forecast.
sourcepub fn predictor_arn(self, input: impl Into<String>) -> Self
pub fn predictor_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the predictor to use to generate the forecast.
This field is required.sourcepub fn set_predictor_arn(self, input: Option<String>) -> Self
pub fn set_predictor_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the predictor to use to generate the forecast.
sourcepub fn get_predictor_arn(&self) -> &Option<String>
pub fn get_predictor_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the predictor to use to generate the forecast.
sourcepub fn forecast_types(self, input: impl Into<String>) -> Self
pub fn forecast_types(self, input: impl Into<String>) -> Self
Appends an item to forecast_types
.
To override the contents of this collection use set_forecast_types
.
The quantiles at which probabilistic forecasts are generated. You can currently specify up to 5 quantiles per forecast. Accepted values include 0.01 to 0.99
(increments of .01 only) and mean
. The mean forecast is different from the median (0.50) when the distribution is not symmetric (for example, Beta and Negative Binomial).
The default quantiles are the quantiles you specified during predictor creation. If you didn't specify quantiles, the default values are ["0.1", "0.5", "0.9"]
.
sourcepub fn set_forecast_types(self, input: Option<Vec<String>>) -> Self
pub fn set_forecast_types(self, input: Option<Vec<String>>) -> Self
The quantiles at which probabilistic forecasts are generated. You can currently specify up to 5 quantiles per forecast. Accepted values include 0.01 to 0.99
(increments of .01 only) and mean
. The mean forecast is different from the median (0.50) when the distribution is not symmetric (for example, Beta and Negative Binomial).
The default quantiles are the quantiles you specified during predictor creation. If you didn't specify quantiles, the default values are ["0.1", "0.5", "0.9"]
.
sourcepub fn get_forecast_types(&self) -> &Option<Vec<String>>
pub fn get_forecast_types(&self) -> &Option<Vec<String>>
The quantiles at which probabilistic forecasts are generated. You can currently specify up to 5 quantiles per forecast. Accepted values include 0.01 to 0.99
(increments of .01 only) and mean
. The mean forecast is different from the median (0.50) when the distribution is not symmetric (for example, Beta and Negative Binomial).
The default quantiles are the quantiles you specified during predictor creation. If you didn't specify quantiles, the default values are ["0.1", "0.5", "0.9"]
.
Appends an item to tags
.
To override the contents of this collection use set_tags
.
The optional metadata that you apply to the forecast 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 hasaws
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 ofaws
do not count against your tags per resource limit.
The optional metadata that you apply to the forecast 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 hasaws
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 ofaws
do not count against your tags per resource limit.
The optional metadata that you apply to the forecast 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 hasaws
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 ofaws
do not count against your tags per resource limit.
sourcepub fn time_series_selector(self, input: TimeSeriesSelector) -> Self
pub fn time_series_selector(self, input: TimeSeriesSelector) -> Self
Defines the set of time series that are used to create the forecasts in a TimeSeriesIdentifiers
object.
The TimeSeriesIdentifiers
object needs the following information:
-
DataSource
-
Format
-
Schema
sourcepub fn set_time_series_selector(self, input: Option<TimeSeriesSelector>) -> Self
pub fn set_time_series_selector(self, input: Option<TimeSeriesSelector>) -> Self
Defines the set of time series that are used to create the forecasts in a TimeSeriesIdentifiers
object.
The TimeSeriesIdentifiers
object needs the following information:
-
DataSource
-
Format
-
Schema
sourcepub fn get_time_series_selector(&self) -> &Option<TimeSeriesSelector>
pub fn get_time_series_selector(&self) -> &Option<TimeSeriesSelector>
Defines the set of time series that are used to create the forecasts in a TimeSeriesIdentifiers
object.
The TimeSeriesIdentifiers
object needs the following information:
-
DataSource
-
Format
-
Schema
sourcepub fn build(self) -> Result<CreateForecastInput, BuildError>
pub fn build(self) -> Result<CreateForecastInput, BuildError>
Consumes the builder and constructs a CreateForecastInput
.
source§impl CreateForecastInputBuilder
impl CreateForecastInputBuilder
sourcepub async fn send_with(
self,
client: &Client
) -> Result<CreateForecastOutput, SdkError<CreateForecastError, HttpResponse>>
pub async fn send_with( self, client: &Client ) -> Result<CreateForecastOutput, SdkError<CreateForecastError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
source§impl Clone for CreateForecastInputBuilder
impl Clone for CreateForecastInputBuilder
source§fn clone(&self) -> CreateForecastInputBuilder
fn clone(&self) -> CreateForecastInputBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for CreateForecastInputBuilder
impl Debug for CreateForecastInputBuilder
source§impl Default for CreateForecastInputBuilder
impl Default for CreateForecastInputBuilder
source§fn default() -> CreateForecastInputBuilder
fn default() -> CreateForecastInputBuilder
source§impl PartialEq for CreateForecastInputBuilder
impl PartialEq for CreateForecastInputBuilder
source§fn eq(&self, other: &CreateForecastInputBuilder) -> bool
fn eq(&self, other: &CreateForecastInputBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for CreateForecastInputBuilder
Auto Trait Implementations§
impl Freeze for CreateForecastInputBuilder
impl RefUnwindSafe for CreateForecastInputBuilder
impl Send for CreateForecastInputBuilder
impl Sync for CreateForecastInputBuilder
impl Unpin for CreateForecastInputBuilder
impl UnwindSafe for CreateForecastInputBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more