libZSservicesZSamazonka-iot-analyticsZSamazonka-iot-analytics
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.IoTAnalytics.CreateDataset

Description

Used to create a dataset. A dataset stores data retrieved from a data store by applying a queryAction (a SQL query) or a containerAction (executing a containerized application). This operation creates the skeleton of a dataset. The dataset can be populated manually by calling CreateDatasetContent or automatically according to a trigger you specify.

Synopsis

Creating a Request

data CreateDataset Source #

See: newCreateDataset smart constructor.

Constructors

CreateDataset' 

Fields

Instances

Instances details
Eq CreateDataset Source # 
Instance details

Defined in Amazonka.IoTAnalytics.CreateDataset

Read CreateDataset Source # 
Instance details

Defined in Amazonka.IoTAnalytics.CreateDataset

Show CreateDataset Source # 
Instance details

Defined in Amazonka.IoTAnalytics.CreateDataset

Generic CreateDataset Source # 
Instance details

Defined in Amazonka.IoTAnalytics.CreateDataset

Associated Types

type Rep CreateDataset :: Type -> Type #

NFData CreateDataset Source # 
Instance details

Defined in Amazonka.IoTAnalytics.CreateDataset

Methods

rnf :: CreateDataset -> () #

Hashable CreateDataset Source # 
Instance details

Defined in Amazonka.IoTAnalytics.CreateDataset

ToJSON CreateDataset Source # 
Instance details

Defined in Amazonka.IoTAnalytics.CreateDataset

AWSRequest CreateDataset Source # 
Instance details

Defined in Amazonka.IoTAnalytics.CreateDataset

Associated Types

type AWSResponse CreateDataset #

ToHeaders CreateDataset Source # 
Instance details

Defined in Amazonka.IoTAnalytics.CreateDataset

ToPath CreateDataset Source # 
Instance details

Defined in Amazonka.IoTAnalytics.CreateDataset

ToQuery CreateDataset Source # 
Instance details

Defined in Amazonka.IoTAnalytics.CreateDataset

type Rep CreateDataset Source # 
Instance details

Defined in Amazonka.IoTAnalytics.CreateDataset

type AWSResponse CreateDataset Source # 
Instance details

Defined in Amazonka.IoTAnalytics.CreateDataset

newCreateDataset Source #

Create a value of CreateDataset 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:versioningConfiguration:CreateDataset', createDataset_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.

$sel:triggers:CreateDataset', createDataset_triggers - A list of triggers. A trigger causes dataset contents to be populated at a specified time interval or when another dataset's contents are created. The list of triggers can be empty or contain up to five DataSetTrigger objects.

$sel:retentionPeriod:CreateDataset', createDataset_retentionPeriod - Optional. How long, in days, versions of dataset contents are kept for the dataset. If not specified or set to null, versions of dataset contents are retained for at most 90 days. The number of versions of dataset contents retained is determined by the versioningConfiguration parameter. For more information, see Keeping Multiple Versions of IoT Analytics datasets in the IoT Analytics User Guide.

$sel:lateDataRules:CreateDataset', createDataset_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:contentDeliveryRules:CreateDataset', createDataset_contentDeliveryRules - When dataset contents are created, they are delivered to destinations specified here.

$sel:tags:CreateDataset', createDataset_tags - Metadata which can be used to manage the dataset.

$sel:datasetName:CreateDataset', createDataset_datasetName - The name of the dataset.

$sel:actions:CreateDataset', createDataset_actions - A list of actions that create the dataset contents.

Request Lenses

createDataset_versioningConfiguration :: Lens' CreateDataset (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.

createDataset_triggers :: Lens' CreateDataset (Maybe [DatasetTrigger]) Source #

A list of triggers. A trigger causes dataset contents to be populated at a specified time interval or when another dataset's contents are created. The list of triggers can be empty or contain up to five DataSetTrigger objects.

createDataset_retentionPeriod :: Lens' CreateDataset (Maybe RetentionPeriod) Source #

Optional. How long, in days, versions of dataset contents are kept for the dataset. If not specified or set to null, versions of dataset contents are retained for at most 90 days. The number of versions of dataset contents retained is determined by the versioningConfiguration parameter. For more information, see Keeping Multiple Versions of IoT Analytics datasets in the IoT Analytics User Guide.

createDataset_lateDataRules :: Lens' CreateDataset (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.

createDataset_contentDeliveryRules :: Lens' CreateDataset (Maybe [DatasetContentDeliveryRule]) Source #

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

createDataset_tags :: Lens' CreateDataset (Maybe (NonEmpty Tag)) Source #

Metadata which can be used to manage the dataset.

createDataset_actions :: Lens' CreateDataset (NonEmpty DatasetAction) Source #

A list of actions that create the dataset contents.

Destructuring the Response

data CreateDatasetResponse Source #

See: newCreateDatasetResponse smart constructor.

Constructors

CreateDatasetResponse' 

Fields

Instances

Instances details
Eq CreateDatasetResponse Source # 
Instance details

Defined in Amazonka.IoTAnalytics.CreateDataset

Read CreateDatasetResponse Source # 
Instance details

Defined in Amazonka.IoTAnalytics.CreateDataset

Show CreateDatasetResponse Source # 
Instance details

Defined in Amazonka.IoTAnalytics.CreateDataset

Generic CreateDatasetResponse Source # 
Instance details

Defined in Amazonka.IoTAnalytics.CreateDataset

Associated Types

type Rep CreateDatasetResponse :: Type -> Type #

NFData CreateDatasetResponse Source # 
Instance details

Defined in Amazonka.IoTAnalytics.CreateDataset

Methods

rnf :: CreateDatasetResponse -> () #

type Rep CreateDatasetResponse Source # 
Instance details

Defined in Amazonka.IoTAnalytics.CreateDataset

type Rep CreateDatasetResponse = D1 ('MetaData "CreateDatasetResponse" "Amazonka.IoTAnalytics.CreateDataset" "libZSservicesZSamazonka-iot-analyticsZSamazonka-iot-analytics" 'False) (C1 ('MetaCons "CreateDatasetResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "datasetArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "retentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RetentionPeriod))) :*: (S1 ('MetaSel ('Just "datasetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateDatasetResponse Source #

Create a value of CreateDatasetResponse 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:datasetArn:CreateDatasetResponse', createDatasetResponse_datasetArn - The ARN of the dataset.

$sel:retentionPeriod:CreateDataset', createDatasetResponse_retentionPeriod - How long, in days, dataset contents are kept for the dataset.

$sel:datasetName:CreateDataset', createDatasetResponse_datasetName - The name of the dataset.

$sel:httpStatus:CreateDatasetResponse', createDatasetResponse_httpStatus - The response's http status code.

Response Lenses

createDatasetResponse_retentionPeriod :: Lens' CreateDatasetResponse (Maybe RetentionPeriod) Source #

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