aws_sdk_iotsitewise/client/
update_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 [`UpdateDataset`](crate::operation::update_dataset::builders::UpdateDatasetFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`dataset_id(impl Into<String>)`](crate::operation::update_dataset::builders::UpdateDatasetFluentBuilder::dataset_id) / [`set_dataset_id(Option<String>)`](crate::operation::update_dataset::builders::UpdateDatasetFluentBuilder::set_dataset_id):<br>required: **true**<br><p>The ID of the dataset.</p><br>
7    ///   - [`dataset_name(impl Into<String>)`](crate::operation::update_dataset::builders::UpdateDatasetFluentBuilder::dataset_name) / [`set_dataset_name(Option<String>)`](crate::operation::update_dataset::builders::UpdateDatasetFluentBuilder::set_dataset_name):<br>required: **true**<br><p>The name of the dataset.</p><br>
8    ///   - [`dataset_description(impl Into<String>)`](crate::operation::update_dataset::builders::UpdateDatasetFluentBuilder::dataset_description) / [`set_dataset_description(Option<String>)`](crate::operation::update_dataset::builders::UpdateDatasetFluentBuilder::set_dataset_description):<br>required: **false**<br><p>A description about the dataset, and its functionality.</p><br>
9    ///   - [`dataset_source(DatasetSource)`](crate::operation::update_dataset::builders::UpdateDatasetFluentBuilder::dataset_source) / [`set_dataset_source(Option<DatasetSource>)`](crate::operation::update_dataset::builders::UpdateDatasetFluentBuilder::set_dataset_source):<br>required: **true**<br><p>The data source for the dataset.</p><br>
10    ///   - [`client_token(impl Into<String>)`](crate::operation::update_dataset::builders::UpdateDatasetFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::update_dataset::builders::UpdateDatasetFluentBuilder::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>
11    /// - On success, responds with [`UpdateDatasetOutput`](crate::operation::update_dataset::UpdateDatasetOutput) with field(s):
12    ///   - [`dataset_id(Option<String>)`](crate::operation::update_dataset::UpdateDatasetOutput::dataset_id): <p>The ID of the dataset.</p>
13    ///   - [`dataset_arn(Option<String>)`](crate::operation::update_dataset::UpdateDatasetOutput::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>
14    ///   - [`dataset_status(Option<DatasetStatus>)`](crate::operation::update_dataset::UpdateDatasetOutput::dataset_status): <p>The status of the dataset. This contains the state and any error messages. State is <code>UPDATING</code> after a successfull call to this API, and any associated error message. The state is <code>ACTIVE</code> when ready to use.</p>
15    /// - On failure, responds with [`SdkError<UpdateDatasetError>`](crate::operation::update_dataset::UpdateDatasetError)
16    pub fn update_dataset(&self) -> crate::operation::update_dataset::builders::UpdateDatasetFluentBuilder {
17        crate::operation::update_dataset::builders::UpdateDatasetFluentBuilder::new(self.handle.clone())
18    }
19}