aws_sdk_iotsitewise/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_id(impl Into<String>)`](crate::operation::create_dataset::builders::CreateDatasetFluentBuilder::dataset_id) / [`set_dataset_id(Option<String>)`](crate::operation::create_dataset::builders::CreateDatasetFluentBuilder::set_dataset_id):<br>required: **false**<br><p>The ID of the dataset.</p><br>
    ///   - [`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>
    ///   - [`dataset_description(impl Into<String>)`](crate::operation::create_dataset::builders::CreateDatasetFluentBuilder::dataset_description) / [`set_dataset_description(Option<String>)`](crate::operation::create_dataset::builders::CreateDatasetFluentBuilder::set_dataset_description):<br>required: **false**<br><p>A description about the dataset, and its functionality.</p><br>
    ///   - [`dataset_source(DatasetSource)`](crate::operation::create_dataset::builders::CreateDatasetFluentBuilder::dataset_source) / [`set_dataset_source(Option<DatasetSource>)`](crate::operation::create_dataset::builders::CreateDatasetFluentBuilder::set_dataset_source):<br>required: **true**<br><p>The data source for the dataset.</p><br>
    ///   - [`client_token(impl Into<String>)`](crate::operation::create_dataset::builders::CreateDatasetFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::create_dataset::builders::CreateDatasetFluentBuilder::set_client_token):<br>required: **false**<br><p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p><br>
    ///   - [`tags(impl Into<String>, impl Into<String>)`](crate::operation::create_dataset::builders::CreateDatasetFluentBuilder::tags) / [`set_tags(Option<HashMap::<String, String>>)`](crate::operation::create_dataset::builders::CreateDatasetFluentBuilder::set_tags):<br>required: **false**<br><p>A list of key-value pairs that contain metadata for the access policy. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html">Tagging your IoT SiteWise resources</a> in the <i>IoT SiteWise User Guide</i>.</p><br>
    /// - On success, responds with [`CreateDatasetOutput`](crate::operation::create_dataset::CreateDatasetOutput) with field(s):
    ///   - [`dataset_id(String)`](crate::operation::create_dataset::CreateDatasetOutput::dataset_id): <p>The ID of the dataset.</p>
    ///   - [`dataset_arn(String)`](crate::operation::create_dataset::CreateDatasetOutput::dataset_arn): <p>The <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">ARN</a> of the dataset. The format is <code>arn:${Partition}:iotsitewise:${Region}:${Account}:dataset/${DatasetId}</code>.</p>
    ///   - [`dataset_status(Option<DatasetStatus>)`](crate::operation::create_dataset::CreateDatasetOutput::dataset_status): <p>The status of the dataset. This contains the state and any error messages. State is <code>CREATING</code> after a successfull call to this API, and any associated error message. The state is <code>ACTIVE</code> when ready to use.</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())
    }
}