Amazonka.IoTSiteWise.DescribeStorageConfiguration

Retrieves information about the storage configuration for IoT SiteWise.

Creating a Request

data DescribeStorageConfiguration

See: newDescribeStorageConfiguration smart constructor.

Constructors

DescribeStorageConfiguration'

Instances

ToHeaders DescribeStorageConfiguration

Defined in Amazonka.IoTSiteWise.DescribeStorageConfiguration

Methods

toHeaders :: DescribeStorageConfiguration -> [Header]

ToPath DescribeStorageConfiguration

Defined in Amazonka.IoTSiteWise.DescribeStorageConfiguration

Methods

toPath :: DescribeStorageConfiguration -> ByteString

ToQuery DescribeStorageConfiguration

Defined in Amazonka.IoTSiteWise.DescribeStorageConfiguration

Methods

toQuery :: DescribeStorageConfiguration -> QueryString

AWSRequest DescribeStorageConfiguration

Defined in Amazonka.IoTSiteWise.DescribeStorageConfiguration

Associated Types

type AWSResponse DescribeStorageConfiguration

Methods

request :: (Service -> Service) -> DescribeStorageConfiguration -> Request DescribeStorageConfiguration

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeStorageConfiguration -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeStorageConfiguration)))

Generic DescribeStorageConfiguration

Defined in Amazonka.IoTSiteWise.DescribeStorageConfiguration

Associated Types

type Rep DescribeStorageConfiguration :: Type -> Type

Methods

from :: DescribeStorageConfiguration -> Rep DescribeStorageConfiguration x

to :: Rep DescribeStorageConfiguration x -> DescribeStorageConfiguration

Read DescribeStorageConfiguration

Defined in Amazonka.IoTSiteWise.DescribeStorageConfiguration

Methods

readsPrec :: Int -> ReadS DescribeStorageConfiguration

readList :: ReadS [DescribeStorageConfiguration]

readPrec :: ReadPrec DescribeStorageConfiguration

readListPrec :: ReadPrec [DescribeStorageConfiguration]

Show DescribeStorageConfiguration

Defined in Amazonka.IoTSiteWise.DescribeStorageConfiguration

Methods

showsPrec :: Int -> DescribeStorageConfiguration -> ShowS

show :: DescribeStorageConfiguration -> String

showList :: [DescribeStorageConfiguration] -> ShowS

NFData DescribeStorageConfiguration

Defined in Amazonka.IoTSiteWise.DescribeStorageConfiguration

Methods

rnf :: DescribeStorageConfiguration -> ()

Eq DescribeStorageConfiguration

Defined in Amazonka.IoTSiteWise.DescribeStorageConfiguration

Methods

(==) :: DescribeStorageConfiguration -> DescribeStorageConfiguration -> Bool

(/=) :: DescribeStorageConfiguration -> DescribeStorageConfiguration -> Bool

Hashable DescribeStorageConfiguration

Defined in Amazonka.IoTSiteWise.DescribeStorageConfiguration

Methods

hashWithSalt :: Int -> DescribeStorageConfiguration -> Int

hash :: DescribeStorageConfiguration -> Int

type AWSResponse DescribeStorageConfiguration

Defined in Amazonka.IoTSiteWise.DescribeStorageConfiguration

type AWSResponse DescribeStorageConfiguration = DescribeStorageConfigurationResponse

type Rep DescribeStorageConfiguration

Defined in Amazonka.IoTSiteWise.DescribeStorageConfiguration

type Rep DescribeStorageConfiguration = D1 ('MetaData "DescribeStorageConfiguration" "Amazonka.IoTSiteWise.DescribeStorageConfiguration" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" 'False) (C1 ('MetaCons "DescribeStorageConfiguration'" 'PrefixI 'False) (U1 :: Type -> Type))

newDescribeStorageConfiguration :: DescribeStorageConfiguration

Create a value of DescribeStorageConfiguration with all optional fields omitted.

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

Destructuring the Response

data DescribeStorageConfigurationResponse

See: newDescribeStorageConfigurationResponse smart constructor.

Constructors

DescribeStorageConfigurationResponse'

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.

• lastUpdateDate :: Maybe POSIX

  The date the storage configuration was last updated, in Unix epoch time.

• multiLayerStorage :: Maybe MultiLayerStorage

  Contains information about the storage destination.

• retentionPeriod :: Maybe RetentionPeriod

  How many days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.

• 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

Generic DescribeStorageConfigurationResponse

Defined in Amazonka.IoTSiteWise.DescribeStorageConfiguration

Associated Types

type Rep DescribeStorageConfigurationResponse :: Type -> Type

Methods

from :: DescribeStorageConfigurationResponse -> Rep DescribeStorageConfigurationResponse x

to :: Rep DescribeStorageConfigurationResponse x -> DescribeStorageConfigurationResponse

Read DescribeStorageConfigurationResponse

Defined in Amazonka.IoTSiteWise.DescribeStorageConfiguration

Methods

readsPrec :: Int -> ReadS DescribeStorageConfigurationResponse

readList :: ReadS [DescribeStorageConfigurationResponse]

readPrec :: ReadPrec DescribeStorageConfigurationResponse

readListPrec :: ReadPrec [DescribeStorageConfigurationResponse]

Show DescribeStorageConfigurationResponse

Defined in Amazonka.IoTSiteWise.DescribeStorageConfiguration

Methods

showsPrec :: Int -> DescribeStorageConfigurationResponse -> ShowS

show :: DescribeStorageConfigurationResponse -> String

showList :: [DescribeStorageConfigurationResponse] -> ShowS

NFData DescribeStorageConfigurationResponse

Defined in Amazonka.IoTSiteWise.DescribeStorageConfiguration

Methods

rnf :: DescribeStorageConfigurationResponse -> ()

Eq DescribeStorageConfigurationResponse

Defined in Amazonka.IoTSiteWise.DescribeStorageConfiguration

Methods

(==) :: DescribeStorageConfigurationResponse -> DescribeStorageConfigurationResponse -> Bool

(/=) :: DescribeStorageConfigurationResponse -> DescribeStorageConfigurationResponse -> Bool

type Rep DescribeStorageConfigurationResponse

Defined in Amazonka.IoTSiteWise.DescribeStorageConfiguration

type Rep DescribeStorageConfigurationResponse = D1 ('MetaData "DescribeStorageConfigurationResponse" "Amazonka.IoTSiteWise.DescribeStorageConfiguration" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" 'False) (C1 ('MetaCons "DescribeStorageConfigurationResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "disassociatedDataStorage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DisassociatedDataStorageState)) :*: (S1 ('MetaSel ('Just "lastUpdateDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: 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)))))

newDescribeStorageConfigurationResponse

Arguments

:: Int

$sel:httpStatus:DescribeStorageConfigurationResponse'

-> StorageType

$sel:storageType:DescribeStorageConfigurationResponse'

-> ConfigurationStatus

$sel:configurationStatus:DescribeStorageConfigurationResponse'

-> DescribeStorageConfigurationResponse

Create a value of DescribeStorageConfigurationResponse 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:

$sel:disassociatedDataStorage:DescribeStorageConfigurationResponse', describeStorageConfigurationResponse_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.

DescribeStorageConfigurationResponse, describeStorageConfigurationResponse_lastUpdateDate - The date the storage configuration was last updated, in Unix epoch time.

$sel:multiLayerStorage:DescribeStorageConfigurationResponse', describeStorageConfigurationResponse_multiLayerStorage - Contains information about the storage destination.

$sel:retentionPeriod:DescribeStorageConfigurationResponse', describeStorageConfigurationResponse_retentionPeriod - How many days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.

$sel:httpStatus:DescribeStorageConfigurationResponse', describeStorageConfigurationResponse_httpStatus - The response's http status code.

$sel:storageType:DescribeStorageConfigurationResponse', describeStorageConfigurationResponse_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:DescribeStorageConfigurationResponse', describeStorageConfigurationResponse_configurationStatus - Undocumented member.

Response Lenses

describeStorageConfigurationResponse_disassociatedDataStorage :: Lens' DescribeStorageConfigurationResponse (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.

describeStorageConfigurationResponse_lastUpdateDate :: Lens' DescribeStorageConfigurationResponse (Maybe UTCTime)

The date the storage configuration was last updated, in Unix epoch time.

describeStorageConfigurationResponse_multiLayerStorage :: Lens' DescribeStorageConfigurationResponse (Maybe MultiLayerStorage)

Contains information about the storage destination.

describeStorageConfigurationResponse_retentionPeriod :: Lens' DescribeStorageConfigurationResponse (Maybe RetentionPeriod)

How many days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.

describeStorageConfigurationResponse_httpStatus :: Lens' DescribeStorageConfigurationResponse Int

The response's http status code.

describeStorageConfigurationResponse_storageType :: Lens' DescribeStorageConfigurationResponse 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.

describeStorageConfigurationResponse_configurationStatus :: Lens' DescribeStorageConfigurationResponse ConfigurationStatus

Undocumented member.