aws_sdk_iotsitewise/client/
describe_dataset.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeDataset`](crate::operation::describe_dataset::builders::DescribeDatasetFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`dataset_id(impl Into<String>)`](crate::operation::describe_dataset::builders::DescribeDatasetFluentBuilder::dataset_id) / [`set_dataset_id(Option<String>)`](crate::operation::describe_dataset::builders::DescribeDatasetFluentBuilder::set_dataset_id):<br>required: **true**<br><p>The ID of the dataset.</p><br>
    /// - On success, responds with [`DescribeDatasetOutput`](crate::operation::describe_dataset::DescribeDatasetOutput) with field(s):
    ///   - [`dataset_id(String)`](crate::operation::describe_dataset::DescribeDatasetOutput::dataset_id): <p>The ID of the dataset.</p>
    ///   - [`dataset_arn(String)`](crate::operation::describe_dataset::DescribeDatasetOutput::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_name(String)`](crate::operation::describe_dataset::DescribeDatasetOutput::dataset_name): <p>The name of the dataset.</p>
    ///   - [`dataset_description(String)`](crate::operation::describe_dataset::DescribeDatasetOutput::dataset_description): <p>A description about the dataset, and its functionality.</p>
    ///   - [`dataset_source(Option<DatasetSource>)`](crate::operation::describe_dataset::DescribeDatasetOutput::dataset_source): <p>The data source for the dataset.</p>
    ///   - [`dataset_status(Option<DatasetStatus>)`](crate::operation::describe_dataset::DescribeDatasetOutput::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>
    ///   - [`dataset_creation_date(DateTime)`](crate::operation::describe_dataset::DescribeDatasetOutput::dataset_creation_date): <p>The dataset creation date, in Unix epoch time.</p>
    ///   - [`dataset_last_update_date(DateTime)`](crate::operation::describe_dataset::DescribeDatasetOutput::dataset_last_update_date): <p>The date the dataset was last updated, in Unix epoch time.</p>
    ///   - [`dataset_version(Option<String>)`](crate::operation::describe_dataset::DescribeDatasetOutput::dataset_version): <p>The version of the dataset.</p>
    /// - On failure, responds with [`SdkError<DescribeDatasetError>`](crate::operation::describe_dataset::DescribeDatasetError)
    pub fn describe_dataset(&self) -> crate::operation::describe_dataset::builders::DescribeDatasetFluentBuilder {
        crate::operation::describe_dataset::builders::DescribeDatasetFluentBuilder::new(self.handle.clone())
    }
}