Dataset
Information about a dataset.
Contents
- actions
-
The
DatasetActionobjects that automatically create the dataset contents.Type: Array of DatasetAction objects
Array Members: Fixed number of 1 item.
Required: No
- arn
-
The ARN of the dataset.
Type: String
Required: No
- contentDeliveryRules
-
When dataset contents are created they are delivered to destinations specified here.
Type: Array of DatasetContentDeliveryRule objects
Array Members: Minimum number of 0 items. Maximum number of 20 items.
Required: No
- creationTime
-
When the dataset was created.
Type: Timestamp
Required: No
- lastUpdateTime
-
The last time the dataset was updated.
Type: Timestamp
Required: No
- 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.Type: Array of LateDataRule objects
Array Members: Fixed number of 1 item.
Required: No
- name
-
The name of the dataset.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
(^(?!_{2}))(^[a-zA-Z0-9_]+$)Required: No
- retentionPeriod
-
Optional. How long, in days, message data is kept for the dataset.
Type: RetentionPeriod object
Required: No
- status
-
The status of the dataset.
Type: String
Valid Values:
CREATING | ACTIVE | DELETINGRequired: No
- triggers
-
The
DatasetTriggerobjects that specify when the dataset is automatically updated.Type: Array of DatasetTrigger objects
Array Members: Minimum number of 0 items. Maximum number of 5 items.
Required: No
- 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
retentionPeriodparameter. For more information, see Keeping Multiple Versions of AWS IoT Analytics datasets in the AWS IoT Analytics User Guide.Type: VersioningConfiguration object
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
