DatasetSummary - AWS IoT SiteWise

DatasetSummary

The summary details for the dataset.

Contents

arn

The ARN of the dataset. The format is arn:${Partition}:iotsitewise:${Region}:${Account}:dataset/${DatasetId}.

Type: String

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

Pattern: ^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$

Required: Yes

creationDate

The dataset creation date, in Unix epoch time.

Type: Timestamp

Required: Yes

description

A description about the dataset, and its functionality.

Type: String

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

Pattern: ^[a-zA-Z0-9 _\-#$*!@]+$

Required: Yes

id

The ID of the dataset.

Type: String

Length Constraints: Fixed length of 36.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Required: Yes

lastUpdateDate

The date the dataset was last updated, in Unix epoch time.

Type: Timestamp

Required: Yes

name

The name of the dataset.

Type: String

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

Pattern: ^[a-zA-Z0-9 _\-#$*!@]+$

Required: Yes

status

The status of the dataset. This contains the state and any error messages. The state is ACTIVE when ready to use.

Type: DatasetStatus object

Required: Yes

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: