Datastore - AWS IoT Analytics
ContentsSee Also

Datastore

Information about a data store.

Contents

arn

The ARN of the data store.

Type: String

Required: No

creationTime

When the data store was created.

Type: Timestamp

Required: No

datastorePartitions

Contains information about the partition dimensions in a data store.

Type: DatastorePartitions object

Required: No

fileFormatConfiguration

Contains the configuration information of file formats. AWS IoT Analytics data stores support JSON and Parquet.

The default file format is JSON. You can specify only one format.

You can't change the file format after you create the data store.

Type: FileFormatConfiguration object

Required: No

lastMessageArrivalTime

The last time when a new message arrived in the data store.

AWS IoT Analytics updates this value at most once per minute for Amazon Simple Storage Service one data store. Hence, the lastMessageArrivalTime value is an approximation.

This feature only applies to messages that arrived in the data store after October 23, 2020.

Type: Timestamp

Required: No

lastUpdateTime

The last time the data store was updated.

Type: Timestamp

Required: No

name

The name of the data store.

Type: String

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

Pattern: (^(?!_{2}))(^[a-zA-Z0-9_]+$)

Required: No

retentionPeriod

How long, in days, message data is kept for the data store. When customerManagedS3 storage is selected, this parameter is ignored.

Type: RetentionPeriod object

Required: No

status

The status of a data store:

CREATING

The data store is being created.

ACTIVE

The data store has been created and can be used.

DELETING

The data store is being deleted.

Type: String

Valid Values: CREATING | ACTIVE | DELETING

Required: No

storage

Where data in a data store is stored.. You can choose serviceManagedS3 storage, customerManagedS3 storage, or iotSiteWiseMultiLayerStorage storage. The default is serviceManagedS3. You can't change the choice of Amazon S3 storage after your data store is created.

Type: DatastoreStorage object

Required: No

See Also

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