aws_sdk_iotanalytics/client/
create_dataset.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`CreateDataset`](crate::operation::create_dataset::builders::CreateDatasetFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`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>The name of the dataset.</p><br>
7    ///   - [`actions(DatasetAction)`](crate::operation::create_dataset::builders::CreateDatasetFluentBuilder::actions) / [`set_actions(Option<Vec::<DatasetAction>>)`](crate::operation::create_dataset::builders::CreateDatasetFluentBuilder::set_actions):<br>required: **true**<br><p>A list of actions that create the dataset contents.</p><br>
8    ///   - [`triggers(DatasetTrigger)`](crate::operation::create_dataset::builders::CreateDatasetFluentBuilder::triggers) / [`set_triggers(Option<Vec::<DatasetTrigger>>)`](crate::operation::create_dataset::builders::CreateDatasetFluentBuilder::set_triggers):<br>required: **false**<br><p>A list of triggers. A trigger causes dataset contents to be populated at a specified time interval or when another dataset's contents are created. The list of triggers can be empty or contain up to five <code>DataSetTrigger</code> objects.</p><br>
9    ///   - [`content_delivery_rules(DatasetContentDeliveryRule)`](crate::operation::create_dataset::builders::CreateDatasetFluentBuilder::content_delivery_rules) / [`set_content_delivery_rules(Option<Vec::<DatasetContentDeliveryRule>>)`](crate::operation::create_dataset::builders::CreateDatasetFluentBuilder::set_content_delivery_rules):<br>required: **false**<br><p>When dataset contents are created, they are delivered to destinations specified here.</p><br>
10    ///   - [`retention_period(RetentionPeriod)`](crate::operation::create_dataset::builders::CreateDatasetFluentBuilder::retention_period) / [`set_retention_period(Option<RetentionPeriod>)`](crate::operation::create_dataset::builders::CreateDatasetFluentBuilder::set_retention_period):<br>required: **false**<br><p>Optional. How long, in days, versions of dataset contents are kept for the dataset. If not specified or set to <code>null</code>, versions of dataset contents are retained for at most 90 days. The number of versions of dataset contents retained is determined by the <code>versioningConfiguration</code> parameter. For more information, see <a href="https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions"> Keeping Multiple Versions of IoT Analytics datasets</a> in the <i>IoT Analytics User Guide</i>.</p><br>
11    ///   - [`versioning_configuration(VersioningConfiguration)`](crate::operation::create_dataset::builders::CreateDatasetFluentBuilder::versioning_configuration) / [`set_versioning_configuration(Option<VersioningConfiguration>)`](crate::operation::create_dataset::builders::CreateDatasetFluentBuilder::set_versioning_configuration):<br>required: **false**<br><p>Optional. How many versions of dataset contents are kept. If not specified or set to null, only the latest version plus the latest succeeded version (if they are different) are kept for the time period specified by the <code>retentionPeriod</code> parameter. For more information, see <a href="https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions">Keeping Multiple Versions of IoT Analytics datasets</a> in the <i>IoT Analytics User Guide</i>.</p><br>
12    ///   - [`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>Metadata which can be used to manage the dataset.</p><br>
13    ///   - [`late_data_rules(LateDataRule)`](crate::operation::create_dataset::builders::CreateDatasetFluentBuilder::late_data_rules) / [`set_late_data_rules(Option<Vec::<LateDataRule>>)`](crate::operation::create_dataset::builders::CreateDatasetFluentBuilder::set_late_data_rules):<br>required: **false**<br><p>A list of data rules that send notifications to CloudWatch, when data arrives late. To specify <code>lateDataRules</code>, the dataset must use a <a href="https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_DeltaTime.html">DeltaTimer</a> filter.</p><br>
14    /// - On success, responds with [`CreateDatasetOutput`](crate::operation::create_dataset::CreateDatasetOutput) with field(s):
15    ///   - [`dataset_name(Option<String>)`](crate::operation::create_dataset::CreateDatasetOutput::dataset_name): <p>The name of the dataset.</p>
16    ///   - [`dataset_arn(Option<String>)`](crate::operation::create_dataset::CreateDatasetOutput::dataset_arn): <p>The ARN of the dataset.</p>
17    ///   - [`retention_period(Option<RetentionPeriod>)`](crate::operation::create_dataset::CreateDatasetOutput::retention_period): <p>How long, in days, dataset contents are kept for the dataset.</p>
18    /// - On failure, responds with [`SdkError<CreateDatasetError>`](crate::operation::create_dataset::CreateDatasetError)
19    pub fn create_dataset(&self) -> crate::operation::create_dataset::builders::CreateDatasetFluentBuilder {
20        crate::operation::create_dataset::builders::CreateDatasetFluentBuilder::new(self.handle.clone())
21    }
22}
aws_sdk_iotanalytics/client/create_dataset.rs

aws_sdk_iotanalytics/client/
create_dataset.rs
