AWS IoT Analytics
AWS IoT Analytics Documentation (API Version 2017-11-27)

Dataset

Information about a data set.

Contents

actions

The "DatasetAction" objects that automatically create the data set contents.

Type: Array of DatasetAction objects

Array Members: Fixed number of 1 item.

Required: No

arn

The ARN of the data set.

Type: String

Required: No

contentDeliveryRules

When data set 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 data set was created.

Type: Timestamp

Required: No

lastUpdateTime

The last time the data set was updated.

Type: Timestamp

Required: No

name

The name of the data set.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_]+$

Required: No

retentionPeriod

[Optional] How long, in days, message data is kept for the data set.

Type: RetentionPeriod object

Required: No

status

The status of the data set.

Type: String

Valid Values: CREATING | ACTIVE | DELETING

Required: No

triggers

The "DatasetTrigger" objects that specify when the data set 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 data set 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 https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions)

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:

On this page: