Skip to content

PutStorageConfigurationResponse

Source code in docs_src/capo_iotsitewise/types/put_storage_configuration_response.py
class PutStorageConfigurationResponse(TypedDict, closed=True):
    storage_type: "capo_iotsitewise.types.storage_type.StorageType"
    """<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: NotRequired[
        "capo_iotsitewise.types.multi_layer_storage.MultiLayerStorage"
    ]
    """<p>Contains information about the storage destination.</p>"""
    disassociated_data_storage: NotRequired[
        "capo_iotsitewise.types.disassociated_data_storage_state.DisassociatedDataStorageState"
    ]
    """<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: NotRequired[
        "capo_iotsitewise.types.retention_period.RetentionPeriod"
    ]
    configuration_status: (
        "capo_iotsitewise.types.configuration_status.ConfigurationStatus"
    )
    warm_tier: NotRequired["capo_iotsitewise.types.warm_tier_state.WarmTierState"]
    """<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: NotRequired[
        "capo_iotsitewise.types.warm_tier_retention_period.WarmTierRetentionPeriod"
    ]
    """<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: NotRequired[
        "capo_iotsitewise.types.disallow_ingest_null_na_n.DisallowIngestNullNaN"
    ]
    """<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>"""

configuration_status instance-attribute

configuration_status: ConfigurationStatus

disallow_ingest_null_na_n instance-attribute

disallow_ingest_null_na_n: NotRequired[DisallowIngestNullNaN]

Describes the configuration for ingesting NULL and NaN data. By default the feature is allowed. The feature is disallowed if the value is true.

disassociated_data_storage instance-attribute

disassociated_data_storage: NotRequired[DisassociatedDataStorageState]

Contains the storage configuration for time series (data streams) that aren't associated with asset properties. The disassociatedDataStorage can be one of the following values:

  • ENABLED – IoT SiteWise accepts time series that aren't associated with asset properties.

    After the disassociatedDataStorage is enabled, you can't disable it.

  • DISABLED – IoT SiteWise doesn't accept time series (data streams) that aren't associated with asset properties.

For more information, see Data streams in the IoT SiteWise User Guide.

multi_layer_storage instance-attribute

multi_layer_storage: NotRequired[MultiLayerStorage]

Contains information about the storage destination.

retention_period instance-attribute

retention_period: NotRequired[RetentionPeriod]

storage_type instance-attribute

storage_type: StorageType

The storage tier that you specified for your data. The storageType parameter can be one of the following values:

  • SITEWISE_DEFAULT_STORAGE – IoT SiteWise saves your data into the hot tier. The hot tier is a service-managed database.

  • MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold tier and the hot tier. The cold tier is a customer-managed Amazon S3 bucket.

warm_tier instance-attribute

warm_tier: NotRequired[WarmTierState]

A service managed storage tier optimized for analytical queries. It stores periodically uploaded, buffered and historical data ingested with the CreaeBulkImportJob API.

warm_tier_retention_period instance-attribute

warm_tier_retention_period: NotRequired[WarmTierRetentionPeriod]

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.