aws_sdk_forecast/client/
create_dataset_group.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateDatasetGroup`](crate::operation::create_dataset_group::builders::CreateDatasetGroupFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`dataset_group_name(impl Into<String>)`](crate::operation::create_dataset_group::builders::CreateDatasetGroupFluentBuilder::dataset_group_name) / [`set_dataset_group_name(Option<String>)`](crate::operation::create_dataset_group::builders::CreateDatasetGroupFluentBuilder::set_dataset_group_name):<br>required: **true**<br><p>A name for the dataset group.</p><br>
    ///   - [`domain(Domain)`](crate::operation::create_dataset_group::builders::CreateDatasetGroupFluentBuilder::domain) / [`set_domain(Option<Domain>)`](crate::operation::create_dataset_group::builders::CreateDatasetGroupFluentBuilder::set_domain):<br>required: **true**<br><p>The domain associated with the dataset group. 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_CreateDataset.html">CreateDataset</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 training data that you import to a 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 that <code>item_id</code>, <code>timestamp</code>, and <code>demand</code> fields are present in your data. For more information, see <a href="https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html">Dataset groups</a>.</p><br>
    ///   - [`dataset_arns(impl Into<String>)`](crate::operation::create_dataset_group::builders::CreateDatasetGroupFluentBuilder::dataset_arns) / [`set_dataset_arns(Option<Vec::<String>>)`](crate::operation::create_dataset_group::builders::CreateDatasetGroupFluentBuilder::set_dataset_arns):<br>required: **false**<br><p>An array of Amazon Resource Names (ARNs) of the datasets that you want to include in the dataset group.</p><br>
    ///   - [`tags(Tag)`](crate::operation::create_dataset_group::builders::CreateDatasetGroupFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::create_dataset_group::builders::CreateDatasetGroupFluentBuilder::set_tags):<br>required: **false**<br><p>The optional metadata that you apply to the dataset group 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 [`CreateDatasetGroupOutput`](crate::operation::create_dataset_group::CreateDatasetGroupOutput) with field(s):
    ///   - [`dataset_group_arn(Option<String>)`](crate::operation::create_dataset_group::CreateDatasetGroupOutput::dataset_group_arn): <p>The Amazon Resource Name (ARN) of the dataset group.</p>
    /// - On failure, responds with [`SdkError<CreateDatasetGroupError>`](crate::operation::create_dataset_group::CreateDatasetGroupError)
    pub fn create_dataset_group(&self) -> crate::operation::create_dataset_group::builders::CreateDatasetGroupFluentBuilder {
        crate::operation::create_dataset_group::builders::CreateDatasetGroupFluentBuilder::new(self.handle.clone())
    }
}