| 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.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
- data CreateDataset = CreateDataset' {
- contentDeliveryRules :: Maybe [DatasetContentDeliveryRule]
- lateDataRules :: Maybe (NonEmpty LateDataRule)
- retentionPeriod :: Maybe RetentionPeriod
- tags :: Maybe (NonEmpty Tag)
- triggers :: Maybe [DatasetTrigger]
- versioningConfiguration :: Maybe VersioningConfiguration
- datasetName :: Text
- actions :: NonEmpty DatasetAction
- newCreateDataset :: Text -> NonEmpty DatasetAction -> CreateDataset
- createDataset_contentDeliveryRules :: Lens' CreateDataset (Maybe [DatasetContentDeliveryRule])
- createDataset_lateDataRules :: Lens' CreateDataset (Maybe (NonEmpty LateDataRule))
- createDataset_retentionPeriod :: Lens' CreateDataset (Maybe RetentionPeriod)
- createDataset_tags :: Lens' CreateDataset (Maybe (NonEmpty Tag))
- createDataset_triggers :: Lens' CreateDataset (Maybe [DatasetTrigger])
- createDataset_versioningConfiguration :: Lens' CreateDataset (Maybe VersioningConfiguration)
- createDataset_datasetName :: Lens' CreateDataset Text
- createDataset_actions :: Lens' CreateDataset (NonEmpty DatasetAction)
- data CreateDatasetResponse = CreateDatasetResponse' {}
- newCreateDatasetResponse :: Int -> CreateDatasetResponse
- createDatasetResponse_datasetArn :: Lens' CreateDatasetResponse (Maybe Text)
- createDatasetResponse_datasetName :: Lens' CreateDatasetResponse (Maybe Text)
- createDatasetResponse_retentionPeriod :: Lens' CreateDatasetResponse (Maybe RetentionPeriod)
- createDatasetResponse_httpStatus :: Lens' CreateDatasetResponse Int
Creating a Request
data CreateDataset Source #
See: newCreateDataset smart constructor.
Constructors
| CreateDataset' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> NonEmpty DatasetAction | |
| -> CreateDataset |
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:
CreateDataset, createDataset_contentDeliveryRules - When dataset contents are created, they are delivered to destinations
specified here.
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.
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:tags:CreateDataset', createDataset_tags - Metadata which can be used to manage the dataset.
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.
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.
CreateDataset, createDataset_datasetName - The name of the dataset.
CreateDataset, createDataset_actions - A list of actions that create the dataset contents.
Request Lenses
createDataset_contentDeliveryRules :: Lens' CreateDataset (Maybe [DatasetContentDeliveryRule]) Source #
When dataset contents are created, they are delivered to destinations specified here.
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_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_tags :: Lens' CreateDataset (Maybe (NonEmpty Tag)) Source #
Metadata which can be used to manage the dataset.
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_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_datasetName :: Lens' CreateDataset Text Source #
The name of 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
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.
CreateDataset, createDatasetResponse_datasetName - The name of the dataset.
CreateDataset, createDatasetResponse_retentionPeriod - How long, in days, dataset contents are kept for the dataset.
$sel:httpStatus:CreateDatasetResponse', createDatasetResponse_httpStatus - The response's http status code.
Response Lenses
createDatasetResponse_datasetArn :: Lens' CreateDatasetResponse (Maybe Text) Source #
The ARN of the dataset.
createDatasetResponse_datasetName :: Lens' CreateDatasetResponse (Maybe Text) Source #
The name of the dataset.
createDatasetResponse_retentionPeriod :: Lens' CreateDatasetResponse (Maybe RetentionPeriod) Source #
How long, in days, dataset contents are kept for the dataset.
createDatasetResponse_httpStatus :: Lens' CreateDatasetResponse Int Source #
The response's http status code.