aws_sdk_iotanalytics/client/
describe_datastore.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 [`DescribeDatastore`](crate::operation::describe_datastore::builders::DescribeDatastoreFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`datastore_name(impl Into<String>)`](crate::operation::describe_datastore::builders::DescribeDatastoreFluentBuilder::datastore_name) / [`set_datastore_name(Option<String>)`](crate::operation::describe_datastore::builders::DescribeDatastoreFluentBuilder::set_datastore_name):<br>required: **true**<br><p>The name of the data store</p><br>
7    ///   - [`include_statistics(bool)`](crate::operation::describe_datastore::builders::DescribeDatastoreFluentBuilder::include_statistics) / [`set_include_statistics(Option<bool>)`](crate::operation::describe_datastore::builders::DescribeDatastoreFluentBuilder::set_include_statistics):<br>required: **false**<br><p>If true, additional statistical information about the data store is included in the response. This feature can't be used with a data store whose S3 storage is customer-managed.</p><br>
8    /// - On success, responds with [`DescribeDatastoreOutput`](crate::operation::describe_datastore::DescribeDatastoreOutput) with field(s):
9    ///   - [`datastore(Option<Datastore>)`](crate::operation::describe_datastore::DescribeDatastoreOutput::datastore): <p>Information about the data store.</p>
10    ///   - [`statistics(Option<DatastoreStatistics>)`](crate::operation::describe_datastore::DescribeDatastoreOutput::statistics): <p>Additional statistical information about the data store. Included if the <code>includeStatistics</code> parameter is set to <code>true</code> in the request.</p>
11    /// - On failure, responds with [`SdkError<DescribeDatastoreError>`](crate::operation::describe_datastore::DescribeDatastoreError)
12    pub fn describe_datastore(&self) -> crate::operation::describe_datastore::builders::DescribeDatastoreFluentBuilder {
13        crate::operation::describe_datastore::builders::DescribeDatastoreFluentBuilder::new(self.handle.clone())
14    }
15}