CustomerManagedDatastoreS3Storage
S3-customer-managed; When you choose customer-managed storage, the retentionPeriod
parameter is ignored. You can't change the choice of Amazon S3 storage after your data store is created.
Contents
bucket
The name of the Amazon S3 bucket where your data is stored.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
Pattern: ^[a-zA-Z0-9.\-_]*$
Required: Yes keyPrefix
(Optional) The prefix used to create the keys of the data store data objects. Each object in an Amazon S3 bucket has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-zA-Z0-9!_.*'()/{}:-]*/$
Required: No roleArn
The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 resources.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
CustomerManagedDatastoreS3StorageSummary
CustomerManagedDatastoreS3StorageSummary
Contains information about the data store that you manage.
Contents
bucket
The name of the Amazon S3 bucket where your data is stored.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
Pattern: ^[a-zA-Z0-9.\-_]*$
Required: No keyPrefix
(Optional) The prefix used to create the keys of the data store data objects. Each object in an Amazon S3 bucket has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-zA-Z0-9!_.*'()/{}:-]*/$
Required: No roleArn
The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 resources.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Dataset
Dataset
Information about a dataset.
Contents
actions
The DatasetAction objects that automatically create the dataset contents.
Type: Array of DatasetAction (p. 118) 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 (p. 121) 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 (p. 158) objects Array Members: Fixed number of 1 item.
Required: No name
The name of the dataset.
See Also
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 (p. 175) object Required: No
status
The status of the dataset.
Type: String
Valid Values: CREATING | ACTIVE | DELETING Required: No
triggers
The DatasetTrigger objects that specify when the dataset is automatically updated.
Type: Array of DatasetTrigger (p. 128) 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 retentionPeriod parameter. For more information, see Keeping Multiple Versions of AWS IoT Analytics datasets in the AWS IoT Analytics User Guide.
Type: VersioningConfiguration (p. 191) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
DatasetAction
DatasetAction
A DatasetAction object that specifies how dataset contents are automatically created.
Contents
actionName
The name of the dataset action by which dataset contents are automatically created.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: ^[a-zA-Z0-9_]+$
Required: No containerAction
Information that allows the system to run a containerized application to create the dataset contents.
The application must be in a Docker container along with any required support libraries.
Type: ContainerDatasetAction (p. 111) object Required: No
queryAction
An SqlQueryDatasetAction object that uses an SQL query to automatically create dataset contents.
Type: SqlQueryDatasetAction (p. 185) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
DatasetActionSummary
DatasetActionSummary
Information about the action that automatically creates the dataset's contents.
Contents
actionName
The name of the action that automatically creates the dataset's contents.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: ^[a-zA-Z0-9_]+$
Required: No actionType
The type of action by which the dataset's contents are automatically created.
Type: String
Valid Values: QUERY | CONTAINER Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
DatasetContentDeliveryDestination
DatasetContentDeliveryDestination
The destination to which dataset contents are delivered.
Contents
iotEventsDestinationConfiguration
Configuration information for delivery of dataset contents to AWS IoT Events.
Type: IotEventsDestinationConfiguration (p. 152) object Required: No
s3DestinationConfiguration
Configuration information for delivery of dataset contents to Amazon S3.
Type: S3DestinationConfiguration (p. 176) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
DatasetContentDeliveryRule
DatasetContentDeliveryRule
When dataset contents are created, they are delivered to destination specified here.
Contents
destination
The destination to which dataset contents are delivered.
Type: DatasetContentDeliveryDestination (p. 120) object Required: Yes
entryName
The name of the dataset content delivery rules entry.
Type: String Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
DatasetContentStatus
DatasetContentStatus
The state of the dataset contents and the reason they are in this state.
Contents
reason
The reason the dataset contents are in this state.
Type: String Required: No state
The state of the dataset contents. Can be one of READY, CREATING, SUCCEEDED, or FAILED.
Type: String
Valid Values: CREATING | SUCCEEDED | FAILED Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
DatasetContentSummary
DatasetContentSummary
Summary information about dataset contents.
Contents
completionTime
The time the dataset content status was updated to SUCCEEDED or FAILED.
Type: Timestamp Required: No creationTime
The actual time the creation of the dataset contents was started.
Type: Timestamp Required: No scheduleTime
The time the creation of the dataset contents was scheduled to start.
Type: Timestamp Required: No status
The status of the dataset contents.
Type: DatasetContentStatus (p. 122) object Required: No
version
The version of the dataset contents.
Type: String
Length Constraints: Minimum length of 7. Maximum length of 36.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
DatasetContentVersionValue
DatasetContentVersionValue
The dataset whose latest contents are used as input to the notebook or application.
Contents
datasetName
The name of the dataset whose latest contents are used as input to the notebook or application.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: (^(?!_{2}))(^[a-zA-Z0-9_]+$) Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
DatasetEntry
DatasetEntry
The reference to a dataset entry.
Contents
dataURI
The presigned URI of the dataset item.
Type: String Required: No entryName
The name of the dataset item.
Type: String Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
DatasetSummary
DatasetSummary
A summary of information about a dataset.
Contents
actions
A list of DataActionSummary objects.
Type: Array of DatasetActionSummary (p. 119) objects Array Members: Fixed number of 1 item.
Required: No creationTime
The time the dataset was created.
Type: Timestamp Required: No datasetName
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
lastUpdateTime
The last time the dataset was updated.
Type: Timestamp Required: No status
The status of the dataset.
Type: String
Valid Values: CREATING | ACTIVE | DELETING Required: No
triggers
A list of triggers. A trigger causes dataset content to be populated at a specified time interval or when another dataset is populated. The list of triggers can be empty or contain up to five DataSetTrigger objects
Type: Array of DatasetTrigger (p. 128) objects
Array Members: Minimum number of 0 items. Maximum number of 5 items.
See Also
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
DatasetTrigger
DatasetTrigger
The DatasetTrigger that specifies when the dataset is automatically updated.
Contents
dataset
The dataset whose content creation triggers the creation of this dataset's contents.
Type: TriggeringDataset (p. 188) object Required: No
schedule
The Schedule when the trigger is initiated.
Type: Schedule (p. 178) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Datastore
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 (p. 136) 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 (p. 149) 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
See Also
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 (p. 175) 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 (p. 138) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
See Also
DatastoreActivity
DatastoreActivity
The datastore activity that specifies where to store the processed data.
Contents
datastoreName
The name of the data store where processed messages are stored.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: (^(?!_{2}))(^[a-zA-Z0-9_]+$) Required: Yes
name
The name of the datastore activity.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
DatastoreIotSiteWiseMultiLayerStorage
DatastoreIotSiteWiseMultiLayerStorage
Used to store data used by AWS IoT SiteWise in an Amazon S3 bucket that you manage. You can't change the choice of Amazon S3 storage after your data store is created.
Contents
customerManagedS3Storage
Used to store data used by AWS IoT SiteWise in an Amazon S3 bucket that you manage.
Type: IotSiteWiseCustomerManagedDatastoreS3Storage (p. 153) object Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
DatastoreIotSiteWiseMultiLayerStorageSummary
DatastoreIotSiteWiseMultiLayerStorageSummary
Contains information about the data store that you manage, which stores data used by AWS IoT SiteWise.
Contents
customerManagedS3Storage
Used to store data used by AWS IoT SiteWise in an Amazon S3 bucket that you manage.
Type: IotSiteWiseCustomerManagedDatastoreS3StorageSummary (p. 154) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
DatastorePartition
DatastorePartition
A single dimension to partition a data store. The dimension must be an AttributePartition or a TimestampPartition.
Contents
attributePartition
A partition dimension defined by an attributeName.
Type: Partition (p. 165) object Required: No
timestampPartition
A partition dimension defined by a timestamp attribute.
Type: TimestampPartition (p. 187) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
DatastorePartitions
DatastorePartitions
Contains information about the partition dimensions in a data store.
Contents
partitions
A list of partition dimensions in a data store.
Type: Array of DatastorePartition (p. 135) objects
Array Members: Minimum number of 0 items. Maximum number of 25 items.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
DatastoreStatistics
DatastoreStatistics
Statistical information about the data store.
Contents
size
The estimated size of the data store.
Type: EstimatedResourceSize (p. 148) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
DatastoreStorage
DatastoreStorage
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.
Contents
customerManagedS3
S3-customer-managed; When you choose customer-managed storage, the retentionPeriod parameter is ignored. You can't change the choice of Amazon S3 storage after your data store is created.
Type: CustomerManagedDatastoreS3Storage (p. 114) object Required: No
iotSiteWiseMultiLayerStorage
Used to store data used by AWS IoT SiteWise in an Amazon S3 bucket that you manage. You can't change the choice of Amazon S3 storage after your data store is created.
Type: DatastoreIotSiteWiseMultiLayerStorage (p. 133) object Required: No
serviceManagedS3
Used to store data in an Amazon S3 bucket managed by AWS IoT Analytics. You can't change the choice of Amazon S3 storage after your data store is created.
Type: ServiceManagedDatastoreS3Storage (p. 183) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
DatastoreStorageSummary
DatastoreStorageSummary
Contains information about your data store.
Contents
customerManagedS3
Used to store data in an Amazon S3 bucket managed by AWS IoT Analytics.
Type: CustomerManagedDatastoreS3StorageSummary (p. 115) object Required: No
iotSiteWiseMultiLayerStorage
Used to store data used by AWS IoT SiteWise in an Amazon S3 bucket that you manage.
Type: DatastoreIotSiteWiseMultiLayerStorageSummary (p. 134) object Required: No
serviceManagedS3
Used to store data in an Amazon S3 bucket managed by AWS IoT Analytics.
Type: ServiceManagedDatastoreS3StorageSummary (p. 184) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
DatastoreSummary
DatastoreSummary
A summary of information about a data store.
Contents
creationTime
When the data store was created.
Type: Timestamp Required: No datastoreName
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
datastorePartitions
Contains information about the partition dimensions in a data store.
Type: DatastorePartitions (p. 136) object Required: No
datastoreStorage
Where data in a data store is stored.
Type: DatastoreStorageSummary (p. 139) object Required: No
fileFormatType
The file format of the data in the data store.
Type: String
Valid Values: JSON | PARQUET 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
See Also
lastUpdateTime
The last time the data store was updated.
Type: Timestamp Required: No status
The status of the data store.
Type: String
Valid Values: CREATING | ACTIVE | DELETING Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
DeltaTime
DeltaTime
Used to limit data to that which has arrived since the last execution of the action.
Contents
offsetSeconds
The number of seconds of estimated in-flight lag time of message data. When you create dataset contents using message data from a specified timeframe, some message data might still be in flight when processing begins, and so do not arrive in time to be processed. Use this field to make allowances for the in flight time of your message data, so that data not processed from a previous timeframe is included with the next timeframe. Otherwise, missed message data would be excluded from processing during the next timeframe too, because its timestamp places it within the previous timeframe.
Type: Integer Required: Yes timeExpression
An expression by which the time of the message data might be determined. This can be the name of a timestamp field or a SQL expression that is used to derive the time the message data was
An expression by which the time of the message data might be determined. This can be the name of a timestamp field or a SQL expression that is used to derive the time the message data was