Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.IoTAnalytics.UpdateDataset

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Updates the settings of a dataset.

Synopsis

data UpdateDataset = UpdateDataset' {
- contentDeliveryRules :: Maybe [DatasetContentDeliveryRule]
- lateDataRules :: Maybe (NonEmpty LateDataRule)
- retentionPeriod :: Maybe RetentionPeriod
- triggers :: Maybe [DatasetTrigger]
- versioningConfiguration :: Maybe VersioningConfiguration
- datasetName :: Text
- actions :: NonEmpty DatasetAction
}
newUpdateDataset :: Text -> NonEmpty DatasetAction -> UpdateDataset
updateDataset_contentDeliveryRules :: Lens' UpdateDataset (Maybe [DatasetContentDeliveryRule])
updateDataset_lateDataRules :: Lens' UpdateDataset (Maybe (NonEmpty LateDataRule))
updateDataset_retentionPeriod :: Lens' UpdateDataset (Maybe RetentionPeriod)
updateDataset_triggers :: Lens' UpdateDataset (Maybe [DatasetTrigger])
updateDataset_versioningConfiguration :: Lens' UpdateDataset (Maybe VersioningConfiguration)
updateDataset_datasetName :: Lens' UpdateDataset Text
updateDataset_actions :: Lens' UpdateDataset (NonEmpty DatasetAction)
data UpdateDatasetResponse = UpdateDatasetResponse' {
}
newUpdateDatasetResponse :: UpdateDatasetResponse

Creating a Request

data UpdateDataset Source #

See: newUpdateDataset smart constructor.

Constructors

UpdateDataset'

Fields

contentDeliveryRules :: Maybe [DatasetContentDeliveryRule]
When dataset contents are created, they are delivered to destinations specified here.
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.
retentionPeriod :: Maybe RetentionPeriod
How long, in days, dataset contents are kept for the dataset.
triggers :: Maybe [DatasetTrigger]
A list of DatasetTrigger objects. The list can be empty or can contain up to five DatasetTrigger objects.
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.
datasetName :: Text
The name of the dataset to update.
actions :: NonEmpty DatasetAction
A list of DatasetAction objects.

Instances

Instances details

ToJSON UpdateDataset Source #
Instance details Defined in Amazonka.IoTAnalytics.UpdateDataset Methods toJSON :: UpdateDataset -> Value # toEncoding :: UpdateDataset -> Encoding # toJSONList :: [UpdateDataset] -> Value # toEncodingList :: [UpdateDataset] -> Encoding #
ToHeaders UpdateDataset Source #
Instance details Defined in Amazonka.IoTAnalytics.UpdateDataset Methods toHeaders :: UpdateDataset -> [Header] #
ToPath UpdateDataset Source #
Instance details Defined in Amazonka.IoTAnalytics.UpdateDataset Methods toPath :: UpdateDataset -> ByteString #
ToQuery UpdateDataset Source #
Instance details Defined in Amazonka.IoTAnalytics.UpdateDataset Methods toQuery :: UpdateDataset -> QueryString #
AWSRequest UpdateDataset Source #
Instance details Defined in Amazonka.IoTAnalytics.UpdateDataset Associated Types type AWSResponse UpdateDataset # Methods request :: (Service -> Service) -> UpdateDataset -> Request UpdateDataset # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateDataset -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateDataset))) #
Generic UpdateDataset Source #
Instance details Defined in Amazonka.IoTAnalytics.UpdateDataset Associated Types type Rep UpdateDataset :: Type -> Type # Methods from :: UpdateDataset -> Rep UpdateDataset x # to :: Rep UpdateDataset x -> UpdateDataset #
Read UpdateDataset Source #
Instance details Defined in Amazonka.IoTAnalytics.UpdateDataset Methods readsPrec :: Int -> ReadS UpdateDataset # readList :: ReadS [UpdateDataset] # readPrec :: ReadPrec UpdateDataset # readListPrec :: ReadPrec [UpdateDataset] #
Show UpdateDataset Source #
Instance details Defined in Amazonka.IoTAnalytics.UpdateDataset Methods showsPrec :: Int -> UpdateDataset -> ShowS # show :: UpdateDataset -> String # showList :: [UpdateDataset] -> ShowS #
NFData UpdateDataset Source #
Instance details Defined in Amazonka.IoTAnalytics.UpdateDataset Methods rnf :: UpdateDataset -> () #
Eq UpdateDataset Source #
Instance details Defined in Amazonka.IoTAnalytics.UpdateDataset Methods (==) :: UpdateDataset -> UpdateDataset -> Bool # (/=) :: UpdateDataset -> UpdateDataset -> Bool #
Hashable UpdateDataset Source #
Instance details Defined in Amazonka.IoTAnalytics.UpdateDataset Methods hashWithSalt :: Int -> UpdateDataset -> Int # hash :: UpdateDataset -> Int #
type AWSResponse UpdateDataset Source #
Instance details Defined in Amazonka.IoTAnalytics.UpdateDataset type AWSResponse UpdateDataset = UpdateDatasetResponse
type Rep UpdateDataset Source #
Instance details Defined in Amazonka.IoTAnalytics.UpdateDataset type Rep UpdateDataset = D1 ('MetaData "UpdateDataset" "Amazonka.IoTAnalytics.UpdateDataset" "amazonka-iot-analytics-2.0-2pxFb0PbSzA9ccOL4CofY4" 'False) (C1 ('MetaCons "UpdateDataset'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "contentDeliveryRules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DatasetContentDeliveryRule])) :: (S1 ('MetaSel ('Just "lateDataRules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty LateDataRule))) :: S1 ('MetaSel ('Just "retentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RetentionPeriod)))) :: ((S1 ('MetaSel ('Just "triggers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DatasetTrigger])) :: S1 ('MetaSel ('Just "versioningConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VersioningConfiguration))) :: (S1 ('MetaSel ('Just "datasetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "actions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty DatasetAction))))))

newUpdateDataset Source #

Arguments

:: Text	`UpdateDataset`
-> NonEmpty DatasetAction	`UpdateDataset`
-> UpdateDataset

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

UpdateDataset, updateDataset_contentDeliveryRules - When dataset contents are created, they are delivered to destinations specified here.

UpdateDataset, updateDataset_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.

UpdateDataset, updateDataset_retentionPeriod - How long, in days, dataset contents are kept for the dataset.

UpdateDataset, updateDataset_triggers - A list of DatasetTrigger objects. The list can be empty or can contain up to five DatasetTrigger objects.

UpdateDataset, updateDataset_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.

UpdateDataset, updateDataset_datasetName - The name of the dataset to update.

UpdateDataset, updateDataset_actions - A list of DatasetAction objects.

Request Lenses

updateDataset_contentDeliveryRules :: Lens' UpdateDataset (Maybe [DatasetContentDeliveryRule]) Source #

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

updateDataset_lateDataRules :: Lens' UpdateDataset (Maybe (NonEmpty LateDataRule)) Source #

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

updateDataset_retentionPeriod :: Lens' UpdateDataset (Maybe RetentionPeriod) Source #

How long, in days, dataset contents are kept for the dataset.

updateDataset_triggers :: Lens' UpdateDataset (Maybe [DatasetTrigger]) Source #

A list of DatasetTrigger objects. The list can be empty or can contain up to five DatasetTrigger objects.

updateDataset_versioningConfiguration :: Lens' UpdateDataset (Maybe VersioningConfiguration) Source #

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.

updateDataset_datasetName :: Lens' UpdateDataset Text Source #

The name of the dataset to update.

updateDataset_actions :: Lens' UpdateDataset (NonEmpty DatasetAction) Source #

A list of DatasetAction objects.

Destructuring the Response

data UpdateDatasetResponse Source #

See: newUpdateDatasetResponse smart constructor.

Constructors

UpdateDatasetResponse'

Instances

Instances details

Generic UpdateDatasetResponse Source #
Instance details Defined in Amazonka.IoTAnalytics.UpdateDataset Associated Types type Rep UpdateDatasetResponse :: Type -> Type # Methods from :: UpdateDatasetResponse -> Rep UpdateDatasetResponse x # to :: Rep UpdateDatasetResponse x -> UpdateDatasetResponse #
Read UpdateDatasetResponse Source #
Instance details Defined in Amazonka.IoTAnalytics.UpdateDataset Methods readsPrec :: Int -> ReadS UpdateDatasetResponse # readList :: ReadS [UpdateDatasetResponse] # readPrec :: ReadPrec UpdateDatasetResponse # readListPrec :: ReadPrec [UpdateDatasetResponse] #
Show UpdateDatasetResponse Source #
Instance details Defined in Amazonka.IoTAnalytics.UpdateDataset Methods showsPrec :: Int -> UpdateDatasetResponse -> ShowS # show :: UpdateDatasetResponse -> String # showList :: [UpdateDatasetResponse] -> ShowS #
NFData UpdateDatasetResponse Source #
Instance details Defined in Amazonka.IoTAnalytics.UpdateDataset Methods rnf :: UpdateDatasetResponse -> () #
Eq UpdateDatasetResponse Source #
Instance details Defined in Amazonka.IoTAnalytics.UpdateDataset Methods (==) :: UpdateDatasetResponse -> UpdateDatasetResponse -> Bool # (/=) :: UpdateDatasetResponse -> UpdateDatasetResponse -> Bool #
type Rep UpdateDatasetResponse Source #
Instance details Defined in Amazonka.IoTAnalytics.UpdateDataset type Rep UpdateDatasetResponse = D1 ('MetaData "UpdateDatasetResponse" "Amazonka.IoTAnalytics.UpdateDataset" "amazonka-iot-analytics-2.0-2pxFb0PbSzA9ccOL4CofY4" 'False) (C1 ('MetaCons "UpdateDatasetResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newUpdateDatasetResponse :: UpdateDatasetResponse Source #

Create a value of UpdateDatasetResponse with all optional fields omitted.

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