Amazonka.IoTAnalytics.Types.Dataset

Documentation

data Dataset

Information about a dataset.

See: newDataset smart constructor.

Constructors

Dataset'

Fields

• actions :: Maybe (NonEmpty DatasetAction)

  The DatasetAction objects that automatically create the dataset contents.

• arn :: Maybe Text

  The ARN of the dataset.

• contentDeliveryRules :: Maybe [DatasetContentDeliveryRule]

  When dataset contents are created they are delivered to destinations specified here.

• creationTime :: Maybe POSIX

  When the dataset was created.

• lastUpdateTime :: Maybe POSIX

  The last time the dataset was updated.

• lateDataRules :: Maybe (NonEmpty LateDataRule)

  A list of data rules that send notifications to CloudWatch, when data arrives late. To specify lateDataRules, the dataset must use a DeltaTimer filter.

• name :: Maybe Text

  The name of the dataset.

• retentionPeriod :: Maybe RetentionPeriod

  Optional. How long, in days, message data is kept for the dataset.

• status :: Maybe DatasetStatus

  The status of the dataset.

• triggers :: Maybe [DatasetTrigger]

  The DatasetTrigger objects that specify when the dataset is automatically updated.

• versioningConfiguration :: Maybe VersioningConfiguration

  Optional. How many versions of dataset contents are kept. If not specified or set to null, only the latest version plus the latest succeeded version (if they are different) are kept for the time period specified by the retentionPeriod parameter. For more information, see Keeping Multiple Versions of IoT Analytics datasets in the IoT Analytics User Guide.

Instances

FromJSON Dataset

Defined in Amazonka.IoTAnalytics.Types.Dataset

Methods

parseJSON :: Value -> Parser Dataset

parseJSONList :: Value -> Parser [Dataset]

Generic Dataset

Defined in Amazonka.IoTAnalytics.Types.Dataset

Associated Types

type Rep Dataset :: Type -> Type

Methods

from :: Dataset -> Rep Dataset x

to :: Rep Dataset x -> Dataset

Read Dataset

Defined in Amazonka.IoTAnalytics.Types.Dataset

Methods

readsPrec :: Int -> ReadS Dataset

readList :: ReadS [Dataset]

readPrec :: ReadPrec Dataset

readListPrec :: ReadPrec [Dataset]

Show Dataset

Defined in Amazonka.IoTAnalytics.Types.Dataset

Methods

showsPrec :: Int -> Dataset -> ShowS

show :: Dataset -> String

showList :: [Dataset] -> ShowS

NFData Dataset

Defined in Amazonka.IoTAnalytics.Types.Dataset

Methods

rnf :: Dataset -> ()

Eq Dataset

Defined in Amazonka.IoTAnalytics.Types.Dataset

Methods

(==) :: Dataset -> Dataset -> Bool

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

Hashable Dataset

Defined in Amazonka.IoTAnalytics.Types.Dataset

Methods

hashWithSalt :: Int -> Dataset -> Int

hash :: Dataset -> Int

type Rep Dataset

Defined in Amazonka.IoTAnalytics.Types.Dataset

type Rep Dataset = D1 ('MetaData "Dataset" "Amazonka.IoTAnalytics.Types.Dataset" "amazonka-iot-analytics-2.0-2pxFb0PbSzA9ccOL4CofY4" 'False) (C1 ('MetaCons "Dataset'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "actions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DatasetAction))) :*: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "contentDeliveryRules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DatasetContentDeliveryRule])) :*: (S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "lastUpdateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))) :*: ((S1 ('MetaSel ('Just "lateDataRules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty LateDataRule))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "retentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RetentionPeriod)))) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DatasetStatus)) :*: (S1 ('MetaSel ('Just "triggers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DatasetTrigger])) :*: S1 ('MetaSel ('Just "versioningConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VersioningConfiguration)))))))

newDataset :: Dataset

Create a value of Dataset 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:actions:Dataset', dataset_actions - The DatasetAction objects that automatically create the dataset contents.

$sel:arn:Dataset', dataset_arn - The ARN of the dataset.

$sel:contentDeliveryRules:Dataset', dataset_contentDeliveryRules - When dataset contents are created they are delivered to destinations specified here.

$sel:creationTime:Dataset', dataset_creationTime - When the dataset was created.

$sel:lastUpdateTime:Dataset', dataset_lastUpdateTime - The last time the dataset was updated.

$sel:lateDataRules:Dataset', dataset_lateDataRules - A list of data rules that send notifications to CloudWatch, when data arrives late. To specify lateDataRules, the dataset must use a DeltaTimer filter.

$sel:name:Dataset', dataset_name - The name of the dataset.

$sel:retentionPeriod:Dataset', dataset_retentionPeriod - Optional. How long, in days, message data is kept for the dataset.

$sel:status:Dataset', dataset_status - The status of the dataset.

$sel:triggers:Dataset', dataset_triggers - The DatasetTrigger objects that specify when the dataset is automatically updated.

$sel:versioningConfiguration:Dataset', dataset_versioningConfiguration - Optional. How many versions of dataset contents are kept. If not specified or set to null, only the latest version plus the latest succeeded version (if they are different) are kept for the time period specified by the retentionPeriod parameter. For more information, see Keeping Multiple Versions of IoT Analytics datasets in the IoT Analytics User Guide.

dataset_actions :: Lens' Dataset (Maybe (NonEmpty DatasetAction))

The DatasetAction objects that automatically create the dataset contents.

dataset_arn :: Lens' Dataset (Maybe Text)

The ARN of the dataset.

dataset_contentDeliveryRules :: Lens' Dataset (Maybe [DatasetContentDeliveryRule])

When dataset contents are created they are delivered to destinations specified here.

dataset_creationTime :: Lens' Dataset (Maybe UTCTime)

When the dataset was created.

dataset_lastUpdateTime :: Lens' Dataset (Maybe UTCTime)

The last time the dataset was updated.

dataset_lateDataRules :: Lens' Dataset (Maybe (NonEmpty LateDataRule))

A list of data rules that send notifications to CloudWatch, when data arrives late. To specify lateDataRules, the dataset must use a DeltaTimer filter.

dataset_name :: Lens' Dataset (Maybe Text)

The name of the dataset.

dataset_retentionPeriod :: Lens' Dataset (Maybe RetentionPeriod)

Optional. How long, in days, message data is kept for the dataset.

dataset_status :: Lens' Dataset (Maybe DatasetStatus)

The status of the dataset.

dataset_triggers :: Lens' Dataset (Maybe [DatasetTrigger])

The DatasetTrigger objects that specify when the dataset is automatically updated.

dataset_versioningConfiguration :: Lens' Dataset (Maybe VersioningConfiguration)

Optional. How many versions of dataset contents are kept. If not specified or set to null, only the latest version plus the latest succeeded version (if they are different) are kept for the time period specified by the retentionPeriod parameter. For more information, see Keeping Multiple Versions of IoT Analytics datasets in the IoT Analytics User Guide.