The AWS IoT Analytics API contains several data types that various actions use. This section describes each data type in detail.
NoteThe order of each element in a data type structure is not guaranteed. Applications should not assume a particular order.
The following data types are supported:
• AddAttributesActivity (p. 99)
• BatchPutMessageErrorEntry (p. 100)
• Channel (p. 101)
• ChannelActivity (p. 103)
• ChannelMessages (p. 104)
• ChannelStatistics (p. 105)
• ChannelStorage (p. 106)
• ChannelStorageSummary (p. 107)
• ChannelSummary (p. 108)
• Column (p. 110)
• ContainerDatasetAction (p. 111)
• CustomerManagedChannelS3Storage (p. 112)
• CustomerManagedChannelS3StorageSummary (p. 113)
• CustomerManagedDatastoreS3Storage (p. 114)
• CustomerManagedDatastoreS3StorageSummary (p. 115)
• Dataset (p. 116)
• DatasetAction (p. 118)
• DatasetActionSummary (p. 119)
• DatasetContentDeliveryDestination (p. 120)
• DatasetContentDeliveryRule (p. 121)
• DatasetContentStatus (p. 122)
• DatasetContentSummary (p. 123)
• DatasetContentVersionValue (p. 124)
• DatasetEntry (p. 125)
• DatasetSummary (p. 126)
• DatasetTrigger (p. 128)
• Datastore (p. 129)
• DatastoreActivity (p. 132)
• DatastoreIotSiteWiseMultiLayerStorage (p. 133)
• DatastoreIotSiteWiseMultiLayerStorageSummary (p. 134)
• DatastorePartition (p. 135)
• DatastorePartitions (p. 136)
• DatastoreStatistics (p. 137)
• DatastoreStorage (p. 138)
• DatastoreStorageSummary (p. 139)
• DatastoreSummary (p. 140)
• DeltaTime (p. 142)
• DeltaTimeSessionWindowConfiguration (p. 143)
• DeviceRegistryEnrichActivity (p. 144)
• DeviceShadowEnrichActivity (p. 146)
• EstimatedResourceSize (p. 148)
• FileFormatConfiguration (p. 149)
• FilterActivity (p. 150)
• GlueConfiguration (p. 151)
• IotEventsDestinationConfiguration (p. 152)
• IotSiteWiseCustomerManagedDatastoreS3Storage (p. 153)
• IotSiteWiseCustomerManagedDatastoreS3StorageSummary (p. 154)
• JsonConfiguration (p. 155)
• LambdaActivity (p. 156)
• LateDataRule (p. 158)
• LateDataRuleConfiguration (p. 159)
• LoggingOptions (p. 160)
• MathActivity (p. 161)
• Message (p. 162)
• OutputFileUriValue (p. 163)
• ParquetConfiguration (p. 164)
• Partition (p. 165)
• Pipeline (p. 166)
• PipelineActivity (p. 168)
• PipelineSummary (p. 170)
• QueryFilter (p. 171)
• RemoveAttributesActivity (p. 172)
• ReprocessingSummary (p. 173)
• ResourceConfiguration (p. 174)
• RetentionPeriod (p. 175)
• S3DestinationConfiguration (p. 176)
• Schedule (p. 178)
• SchemaDefinition (p. 179)
• SelectAttributesActivity (p. 180)
• ServiceManagedChannelS3Storage (p. 181)
• ServiceManagedChannelS3StorageSummary (p. 182)
• ServiceManagedDatastoreS3Storage (p. 183)
• ServiceManagedDatastoreS3StorageSummary (p. 184)
• SqlQueryDatasetAction (p. 185)
• Tag (p. 186)
• TimestampPartition (p. 187)
• TriggeringDataset (p. 188)
• Variable (p. 189)
• VersioningConfiguration (p. 191)
AddAttributesActivity
AddAttributesActivity
An activity that adds other attributes based on existing attributes in the message.
Contents
attributes
A list of 1-50 AttributeNameMapping objects that map an existing attribute to a new attribute.
NoteThe existing attributes remain in the message, so if you want to remove the originals, use RemoveAttributeActivity.
Type: String to string map
Map Entries: Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 256.
Value Length Constraints: Minimum length of 1. Maximum length of 256.
Required: Yes name
The name of the addAttributes activity.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: Yes next
The next activity in the pipeline.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
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
BatchPutMessageErrorEntry
BatchPutMessageErrorEntry
Contains informations about errors.
Contents
errorCode
The code associated with the error.
Type: String Required: No errorMessage
The message associated with the error.
Type: String Required: No messageId
The ID of the message that caused the error. See the value corresponding to the messageId key in the message object.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
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
Channel
Channel
A collection of data from an MQTT topic. Channels archive the raw, unprocessed messages before publishing the data to a pipeline.
Contents
arn
The ARN of the channel.
Type: String Required: No creationTime
When the channel was created.
Type: Timestamp Required: No lastMessageArrivalTime
The last time when a new message arrived in the channel.
AWS IoT Analytics updates this value at most once per minute for one channel. 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
When the channel was last updated.
Type: Timestamp Required: No name
The name of the channel.
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 channel.
Type: RetentionPeriod (p. 175) object Required: No
See Also
status
The status of the channel.
Type: String
Valid Values: CREATING | ACTIVE | DELETING Required: No
storage
Where channel data is stored. You can choose one of serviceManagedS3 or customerManagedS3 storage. If not specified, the default is serviceManagedS3. You can't change this storage option after the channel is created.
Type: ChannelStorage (p. 106) 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
ChannelActivity
ChannelActivity
The activity that determines the source of the messages to be processed.
Contents
channelName
The name of the channel from which the messages are processed.
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 channel activity.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: Yes next
The next activity in the pipeline.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
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
ChannelMessages
ChannelMessages
Specifies one or more sets of channel messages.
Contents
s3Paths
Specifies one or more keys that identify the Amazon Simple Storage Service (Amazon S3) objects that save your channel messages.
You must use the full path for the key.
Example path: channel/mychannel/__dt=2020-02-29
00:00:00/1582940490000_1582940520000_123456789012_mychannel_0_2118.0.json.gz Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: ^[a-zA-Z0-9/_!'(){}\*\s\.\-\=\:]+$
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
ChannelStatistics
ChannelStatistics
Statistics information about the channel.
Contents
size
The estimated size of the channel.
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
ChannelStorage
ChannelStorage
Where channel data is stored. You may choose one of serviceManagedS3, customerManagedS3 storage. If not specified, the default is serviceManagedS3. This can't be changed after creation of the channel.
Contents
customerManagedS3
Used to store channel data in an S3 bucket that you manage. If customer managed storage is selected, the retentionPeriod parameter is ignored. You can't change the choice of S3 storage after the data store is created.
Type: CustomerManagedChannelS3Storage (p. 112) object Required: No
serviceManagedS3
Used to store channel data in an S3 bucket managed by AWS IoT Analytics. You can't change the choice of S3 storage after the data store is created.
Type: ServiceManagedChannelS3Storage (p. 181) 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
ChannelStorageSummary
ChannelStorageSummary
Where channel data is stored.
Contents
customerManagedS3
Used to store channel data in an S3 bucket that you manage.
Type: CustomerManagedChannelS3StorageSummary (p. 113) object Required: No
serviceManagedS3
Used to store channel data in an S3 bucket managed by AWS IoT Analytics.
Type: ServiceManagedChannelS3StorageSummary (p. 182) 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
ChannelSummary
ChannelSummary
A summary of information about a channel.
Contents
channelName
The name of the channel.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: (^(?!_{2}))(^[a-zA-Z0-9_]+$) Required: No
channelStorage
Where channel data is stored.
Type: ChannelStorageSummary (p. 107) object Required: No
creationTime
When the channel was created.
Type: Timestamp Required: No lastMessageArrivalTime
The last time when a new message arrived in the channel.
AWS IoT Analytics updates this value at most once per minute for one channel. 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 channel was updated.
Type: Timestamp Required: No status
The status of the channel.
Type: String
Valid Values: CREATING | ACTIVE | DELETING Required: No
See Also
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
Column
Column
Contains information about a column that stores your data.
Contents
name
The name of the column.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[A-Za-z_]([A-Za-z0-9]*|[A-Za-z0-9][A-Za-z0-9_]*)$
Required: Yes type
The type of data. For more information about the supported data types, see Common data types in the AWS Glue Developer Guide.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 131072.
Pattern: ^[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*$
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
ContainerDatasetAction
ContainerDatasetAction
Information required to run the containerAction to produce dataset contents.
Contents
executionRoleArn
The ARN of the role that gives permission to the system to access required resources to run the containerAction. This includes, at minimum, permission to retrieve the dataset contents that are the input to the containerized application.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Required: Yes image
The ARN of the Docker container stored in your account. The Docker container contains an application and required support libraries and is used to generate dataset contents.
Type: String
Length Constraints: Maximum length of 255.
Required: Yes resourceConfiguration
Configuration of the resource that executes the containerAction.
Type: ResourceConfiguration (p. 174) object Required: Yes
variables
The values of variables used in the context of the execution of the containerized application (basically, parameters passed to the application). Each variable must have a name and a value given by one of stringValue, datasetContentVersionValue, or outputFileUriValue.
Type: Array of Variable (p. 189) objects
Array Members: Minimum number of 0 items. Maximum number of 50 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