aws_sdk_forecast/client/

create_dataset.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateDataset`](crate::operation::create_dataset::builders::CreateDatasetFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`dataset_name(impl Into<String>)`](crate::operation::create_dataset::builders::CreateDatasetFluentBuilder::dataset_name) / [`set_dataset_name(Option<String>)`](crate::operation::create_dataset::builders::CreateDatasetFluentBuilder::set_dataset_name):<br>required: **true**<br><p>A name for the dataset.</p><br>
    ///   - [`domain(Domain)`](crate::operation::create_dataset::builders::CreateDatasetFluentBuilder::domain) / [`set_domain(Option<Domain>)`](crate::operation::create_dataset::builders::CreateDatasetFluentBuilder::set_domain):<br>required: **true**<br><p>The domain associated with the dataset. When you add a dataset to a dataset group, this value and the value specified for the <code>Domain</code> parameter of the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html">CreateDatasetGroup</a> operation must match.</p> <p>The <code>Domain</code> and <code>DatasetType</code> that you choose determine the fields that must be present in the training data that you import to the dataset. For example, if you choose the <code>RETAIL</code> domain and <code>TARGET_TIME_SERIES</code> as the <code>DatasetType</code>, Amazon Forecast requires <code>item_id</code>, <code>timestamp</code>, and <code>demand</code> fields to be present in your data. For more information, see <a href="https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html">Importing datasets</a>.</p><br>
    ///   - [`dataset_type(DatasetType)`](crate::operation::create_dataset::builders::CreateDatasetFluentBuilder::dataset_type) / [`set_dataset_type(Option<DatasetType>)`](crate::operation::create_dataset::builders::CreateDatasetFluentBuilder::set_dataset_type):<br>required: **true**<br><p>The dataset type. Valid values depend on the chosen <code>Domain</code>.</p><br>
    ///   - [`data_frequency(impl Into<String>)`](crate::operation::create_dataset::builders::CreateDatasetFluentBuilder::data_frequency) / [`set_data_frequency(Option<String>)`](crate::operation::create_dataset::builders::CreateDatasetFluentBuilder::set_data_frequency):<br>required: **false**<br><p>The frequency of data collection. This parameter is required for RELATED_TIME_SERIES datasets.</p> <p>Valid intervals are an integer followed by Y (Year), M (Month), W (Week), D (Day), H (Hour), and min (Minute). For example, "1D" indicates every day and "15min" indicates every 15 minutes. You cannot specify a value that would overlap with the next larger frequency. That means, for example, you cannot specify a frequency of 60 minutes, because that is equivalent to 1 hour. The valid values for each frequency are the following:</p> <ul>  <li>   <p>Minute - 1-59</p></li>  <li>   <p>Hour - 1-23</p></li>  <li>   <p>Day - 1-6</p></li>  <li>   <p>Week - 1-4</p></li>  <li>   <p>Month - 1-11</p></li>  <li>   <p>Year - 1</p></li> </ul> <p>Thus, if you want every other week forecasts, specify "2W". Or, if you want quarterly forecasts, you specify "3M".</p><br>
    ///   - [`schema(Schema)`](crate::operation::create_dataset::builders::CreateDatasetFluentBuilder::schema) / [`set_schema(Option<Schema>)`](crate::operation::create_dataset::builders::CreateDatasetFluentBuilder::set_schema):<br>required: **true**<br><p>The schema for the dataset. The schema attributes and their order must match the fields in your data. The dataset <code>Domain</code> and <code>DatasetType</code> that you choose determine the minimum required fields in your training data. For information about the required fields for a specific dataset domain and type, see <a href="https://docs.aws.amazon.com/forecast/latest/dg/howitworks-domains-ds-types.html">Dataset Domains and Dataset Types</a>.</p><br>
    ///   - [`encryption_config(EncryptionConfig)`](crate::operation::create_dataset::builders::CreateDatasetFluentBuilder::encryption_config) / [`set_encryption_config(Option<EncryptionConfig>)`](crate::operation::create_dataset::builders::CreateDatasetFluentBuilder::set_encryption_config):<br>required: **false**<br><p>An Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.</p><br>
    ///   - [`tags(Tag)`](crate::operation::create_dataset::builders::CreateDatasetFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::create_dataset::builders::CreateDatasetFluentBuilder::set_tags):<br>required: **false**<br><p>The optional metadata that you apply to the dataset to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.</p> <p>The following basic restrictions apply to tags:</p> <ul>  <li>   <p>Maximum number of tags per resource - 50.</p></li>  <li>   <p>For each resource, each tag key must be unique, and each tag key can have only one value.</p></li>  <li>   <p>Maximum key length - 128 Unicode characters in UTF-8.</p></li>  <li>   <p>Maximum value length - 256 Unicode characters in UTF-8.</p></li>  <li>   <p>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: + - = . _ : / @.</p></li>  <li>   <p>Tag keys and values are case sensitive.</p></li>  <li>   <p>Do not use <code>aws:</code>, <code>AWS:</code>, 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 <code>aws</code> 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 <code>aws</code> do not count against your tags per resource limit.</p></li> </ul><br>
    /// - On success, responds with [`CreateDatasetOutput`](crate::operation::create_dataset::CreateDatasetOutput) with field(s):
    ///   - [`dataset_arn(Option<String>)`](crate::operation::create_dataset::CreateDatasetOutput::dataset_arn): <p>The Amazon Resource Name (ARN) of the dataset.</p>
    /// - On failure, responds with [`SdkError<CreateDatasetError>`](crate::operation::create_dataset::CreateDatasetError)
    pub fn create_dataset(&self) -> crate::operation::create_dataset::builders::CreateDatasetFluentBuilder {
        crate::operation::create_dataset::builders::CreateDatasetFluentBuilder::new(self.handle.clone())
    }
}