aws_sdk_iotsitewise/client/

describe_storage_configuration.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeStorageConfiguration`](crate::operation::describe_storage_configuration::builders::DescribeStorageConfigurationFluentBuilder) operation.
    ///
    /// - The fluent builder takes no input, just [`send`](crate::operation::describe_storage_configuration::builders::DescribeStorageConfigurationFluentBuilder::send) it.
    /// - On success, responds with [`DescribeStorageConfigurationOutput`](crate::operation::describe_storage_configuration::DescribeStorageConfigurationOutput) with field(s):
    ///   - [`storage_type(StorageType)`](crate::operation::describe_storage_configuration::DescribeStorageConfigurationOutput::storage_type): <p>The storage tier that you specified for your data. The <code>storageType</code> parameter can be one of the following values:</p> <ul>  <li>   <p><code>SITEWISE_DEFAULT_STORAGE</code> – IoT SiteWise saves your data into the hot tier. The hot tier is a service-managed database.</p></li>  <li>   <p><code>MULTI_LAYER_STORAGE</code> – IoT SiteWise saves your data in both the cold tier and the hot tier. The cold tier is a customer-managed Amazon S3 bucket.</p></li> </ul>
    ///   - [`multi_layer_storage(Option<MultiLayerStorage>)`](crate::operation::describe_storage_configuration::DescribeStorageConfigurationOutput::multi_layer_storage): <p>Contains information about the storage destination.</p>
    ///   - [`disassociated_data_storage(Option<DisassociatedDataStorageState>)`](crate::operation::describe_storage_configuration::DescribeStorageConfigurationOutput::disassociated_data_storage): <p>Contains the storage configuration for time series (data streams) that aren't associated with asset properties. The <code>disassociatedDataStorage</code> can be one of the following values:</p> <ul>  <li>   <p><code>ENABLED</code> – IoT SiteWise accepts time series that aren't associated with asset properties.</p><important>    <p>After the <code>disassociatedDataStorage</code> is enabled, you can't disable it.</p>   </important></li>  <li>   <p><code>DISABLED</code> – IoT SiteWise doesn't accept time series (data streams) that aren't associated with asset properties.</p></li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/data-streams.html">Data streams</a> in the <i>IoT SiteWise User Guide</i>.</p>
    ///   - [`retention_period(Option<RetentionPeriod>)`](crate::operation::describe_storage_configuration::DescribeStorageConfigurationOutput::retention_period): <p>The number of days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.</p>
    ///   - [`configuration_status(Option<ConfigurationStatus>)`](crate::operation::describe_storage_configuration::DescribeStorageConfigurationOutput::configuration_status): <p>Contains current status information for the configuration.</p>
    ///   - [`last_update_date(Option<DateTime>)`](crate::operation::describe_storage_configuration::DescribeStorageConfigurationOutput::last_update_date): <p>The date the storage configuration was last updated, in Unix epoch time.</p>
    ///   - [`warm_tier(Option<WarmTierState>)`](crate::operation::describe_storage_configuration::DescribeStorageConfigurationOutput::warm_tier): <p>A service managed storage tier optimized for analytical queries. It stores periodically uploaded, buffered and historical data ingested with the CreaeBulkImportJob API.</p>
    ///   - [`warm_tier_retention_period(Option<WarmTierRetentionPeriod>)`](crate::operation::describe_storage_configuration::DescribeStorageConfigurationOutput::warm_tier_retention_period): <p>Set this period to specify how long your data is stored in the warm tier before it is deleted. You can set this only if cold tier is enabled.</p>
    ///   - [`disallow_ingest_null_na_n(Option<bool>)`](crate::operation::describe_storage_configuration::DescribeStorageConfigurationOutput::disallow_ingest_null_na_n): <p>Describes the configuration for ingesting NULL and NaN data. By default the feature is allowed. The feature is disallowed if the value is <code>true</code>.</p>
    /// - On failure, responds with [`SdkError<DescribeStorageConfigurationError>`](crate::operation::describe_storage_configuration::DescribeStorageConfigurationError)
    pub fn describe_storage_configuration(
        &self,
    ) -> crate::operation::describe_storage_configuration::builders::DescribeStorageConfigurationFluentBuilder {
        crate::operation::describe_storage_configuration::builders::DescribeStorageConfigurationFluentBuilder::new(self.handle.clone())
    }
}