amazonka-iotsitewise-2.0: Amazon IoT SiteWise SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.IoTSiteWise.PutStorageConfiguration

Description

Configures storage settings for IoT SiteWise.

Synopsis

Creating a Request

data PutStorageConfiguration Source #

See: newPutStorageConfiguration smart constructor.

Constructors

PutStorageConfiguration' 

Fields

  • disassociatedDataStorage :: Maybe 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.

  • multiLayerStorage :: Maybe MultiLayerStorage

    Identifies a storage destination. If you specified MULTI_LAYER_STORAGE for the storage type, you must specify a MultiLayerStorage object.

  • retentionPeriod :: Maybe RetentionPeriod
     
  • storageType :: 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.

Instances

Instances details
ToJSON PutStorageConfiguration Source # 
Instance details

Defined in Amazonka.IoTSiteWise.PutStorageConfiguration

ToHeaders PutStorageConfiguration Source # 
Instance details

Defined in Amazonka.IoTSiteWise.PutStorageConfiguration

ToPath PutStorageConfiguration Source # 
Instance details

Defined in Amazonka.IoTSiteWise.PutStorageConfiguration

ToQuery PutStorageConfiguration Source # 
Instance details

Defined in Amazonka.IoTSiteWise.PutStorageConfiguration

AWSRequest PutStorageConfiguration Source # 
Instance details

Defined in Amazonka.IoTSiteWise.PutStorageConfiguration

Generic PutStorageConfiguration Source # 
Instance details

Defined in Amazonka.IoTSiteWise.PutStorageConfiguration

Associated Types

type Rep PutStorageConfiguration :: Type -> Type #

Read PutStorageConfiguration Source # 
Instance details

Defined in Amazonka.IoTSiteWise.PutStorageConfiguration

Show PutStorageConfiguration Source # 
Instance details

Defined in Amazonka.IoTSiteWise.PutStorageConfiguration

NFData PutStorageConfiguration Source # 
Instance details

Defined in Amazonka.IoTSiteWise.PutStorageConfiguration

Methods

rnf :: PutStorageConfiguration -> () #

Eq PutStorageConfiguration Source # 
Instance details

Defined in Amazonka.IoTSiteWise.PutStorageConfiguration

Hashable PutStorageConfiguration Source # 
Instance details

Defined in Amazonka.IoTSiteWise.PutStorageConfiguration

type AWSResponse PutStorageConfiguration Source # 
Instance details

Defined in Amazonka.IoTSiteWise.PutStorageConfiguration

type Rep PutStorageConfiguration Source # 
Instance details

Defined in Amazonka.IoTSiteWise.PutStorageConfiguration

type Rep PutStorageConfiguration = D1 ('MetaData "PutStorageConfiguration" "Amazonka.IoTSiteWise.PutStorageConfiguration" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" 'False) (C1 ('MetaCons "PutStorageConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "disassociatedDataStorage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DisassociatedDataStorageState)) :*: S1 ('MetaSel ('Just "multiLayerStorage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MultiLayerStorage))) :*: (S1 ('MetaSel ('Just "retentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RetentionPeriod)) :*: S1 ('MetaSel ('Just "storageType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 StorageType))))

newPutStorageConfiguration Source #

Create a value of PutStorageConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

PutStorageConfiguration, putStorageConfiguration_disassociatedDataStorage - 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.

PutStorageConfiguration, putStorageConfiguration_multiLayerStorage - Identifies a storage destination. If you specified MULTI_LAYER_STORAGE for the storage type, you must specify a MultiLayerStorage object.

PutStorageConfiguration, putStorageConfiguration_retentionPeriod - Undocumented member.

PutStorageConfiguration, putStorageConfiguration_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.

Request Lenses

putStorageConfiguration_disassociatedDataStorage :: Lens' PutStorageConfiguration (Maybe DisassociatedDataStorageState) Source #

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.

putStorageConfiguration_multiLayerStorage :: Lens' PutStorageConfiguration (Maybe MultiLayerStorage) Source #

Identifies a storage destination. If you specified MULTI_LAYER_STORAGE for the storage type, you must specify a MultiLayerStorage object.

putStorageConfiguration_storageType :: Lens' PutStorageConfiguration StorageType Source #

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.

Destructuring the Response

data PutStorageConfigurationResponse Source #

See: newPutStorageConfigurationResponse smart constructor.

Constructors

PutStorageConfigurationResponse' 

Fields

  • disassociatedDataStorage :: Maybe 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.

  • multiLayerStorage :: Maybe MultiLayerStorage

    Contains information about the storage destination.

  • retentionPeriod :: Maybe RetentionPeriod
     
  • httpStatus :: Int

    The response's http status code.

  • storageType :: 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.
  • configurationStatus :: ConfigurationStatus
     

Instances

Instances details
Generic PutStorageConfigurationResponse Source # 
Instance details

Defined in Amazonka.IoTSiteWise.PutStorageConfiguration

Associated Types

type Rep PutStorageConfigurationResponse :: Type -> Type #

Read PutStorageConfigurationResponse Source # 
Instance details

Defined in Amazonka.IoTSiteWise.PutStorageConfiguration

Show PutStorageConfigurationResponse Source # 
Instance details

Defined in Amazonka.IoTSiteWise.PutStorageConfiguration

NFData PutStorageConfigurationResponse Source # 
Instance details

Defined in Amazonka.IoTSiteWise.PutStorageConfiguration

Eq PutStorageConfigurationResponse Source # 
Instance details

Defined in Amazonka.IoTSiteWise.PutStorageConfiguration

type Rep PutStorageConfigurationResponse Source # 
Instance details

Defined in Amazonka.IoTSiteWise.PutStorageConfiguration

type Rep PutStorageConfigurationResponse = D1 ('MetaData "PutStorageConfigurationResponse" "Amazonka.IoTSiteWise.PutStorageConfiguration" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" 'False) (C1 ('MetaCons "PutStorageConfigurationResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "disassociatedDataStorage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DisassociatedDataStorageState)) :*: (S1 ('MetaSel ('Just "multiLayerStorage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MultiLayerStorage)) :*: S1 ('MetaSel ('Just "retentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RetentionPeriod)))) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "storageType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 StorageType) :*: S1 ('MetaSel ('Just "configurationStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ConfigurationStatus)))))

newPutStorageConfigurationResponse Source #

Create a value of PutStorageConfigurationResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

PutStorageConfiguration, putStorageConfigurationResponse_disassociatedDataStorage - 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.

PutStorageConfiguration, putStorageConfigurationResponse_multiLayerStorage - Contains information about the storage destination.

PutStorageConfiguration, putStorageConfigurationResponse_retentionPeriod - Undocumented member.

$sel:httpStatus:PutStorageConfigurationResponse', putStorageConfigurationResponse_httpStatus - The response's http status code.

PutStorageConfiguration, putStorageConfigurationResponse_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.

$sel:configurationStatus:PutStorageConfigurationResponse', putStorageConfigurationResponse_configurationStatus - Undocumented member.

Response Lenses

putStorageConfigurationResponse_disassociatedDataStorage :: Lens' PutStorageConfigurationResponse (Maybe DisassociatedDataStorageState) Source #

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.

putStorageConfigurationResponse_storageType :: Lens' PutStorageConfigurationResponse StorageType Source #

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.