Module types

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.

ChannelStorageSummary

Where channel data is stored.

ChannelSummary

A summary of information about a channel.

Column

Contains information about a column that stores your data.

ContainerDatasetAction

Information required to run the containerAction to produce dataset contents.

CustomerManagedChannelS3Storage

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.

CustomerManagedChannelS3StorageSummary

Used to store channel data in an S3 bucket that you manage.

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.

CustomerManagedDatastoreS3StorageSummary

Contains information about the data store that you manage.

Dataset

Information about a dataset.

DatasetAction

A DatasetAction object that specifies how dataset contents are automatically created.

DatasetActionSummary

Information about the action that automatically creates the dataset's contents.

DatasetContentDeliveryDestination

The destination to which dataset contents are delivered.

DatasetContentDeliveryRule

When dataset contents are created, they are delivered to destination specified here.

DatasetContentStatus

The state of the dataset contents and the reason they are in this state.

DatasetContentSummary

Summary information about dataset contents.

DatasetContentVersionValue

The dataset whose latest contents are used as input to the notebook or application.

DatasetEntry

The reference to a dataset entry.

DatasetSummary

A summary of information about a dataset.

DatasetTrigger

The DatasetTrigger that specifies when the dataset is automatically updated.

Datastore

Information about a data store.

DatastoreActivity

The datastore activity that specifies where to store the processed data.

DatastoreIotSiteWiseMultiLayerStorage

Used to store data used by 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.

DatastoreIotSiteWiseMultiLayerStorageSummary

Contains information about the data store that you manage, which stores data used by IoT SiteWise.

DatastorePartition

A single dimension to partition a data store. The dimension must be an AttributePartition or a TimestampPartition.

DatastorePartitions

Contains information about the partition dimensions in a data store.

DatastoreStatistics

Statistical information about the data store.

DatastoreStorageSummary

Contains information about your data store.

DatastoreSummary

A summary of information about a data store.

DeltaTime

Used to limit data to that which has arrived since the last execution of the action.

DeltaTimeSessionWindowConfiguration

A structure that contains the configuration information of a delta time session window.

DeltaTime specifies a time interval. You can use DeltaTime to create dataset contents with data that has arrived in the data store since the last execution. For an example of DeltaTime, see Creating a SQL dataset with a delta window (CLI) in the IoT Analytics User Guide.

DeviceRegistryEnrichActivity

An activity that adds data from the IoT device registry to your message.

DeviceShadowEnrichActivity

An activity that adds information from the IoT Device Shadow service to a message.

EstimatedResourceSize

The estimated size of the resource.

FileFormatConfiguration

Contains the configuration information of file formats. 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.

FilterActivity

An activity that filters a message based on its attributes.

GlueConfiguration

Configuration information for coordination with Glue, a fully managed extract, transform and load (ETL) service.

IotEventsDestinationConfiguration

Configuration information for delivery of dataset contents to IoT Events.

IotSiteWiseCustomerManagedDatastoreS3Storage

Used to store data used by 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.

IotSiteWiseCustomerManagedDatastoreS3StorageSummary

Contains information about the data store that you manage, which stores data used by IoT SiteWise.

JsonConfiguration

Contains the configuration information of the JSON format.

LambdaActivity

An activity that runs a Lambda function to modify the message.

LateDataRule

A structure that contains the name and configuration information of a late data rule.

LateDataRuleConfiguration

The information needed to configure a delta time session window.

LoggingOptions

Information about logging options.

MathActivity

An activity that computes an arithmetic expression using the message's attributes.

Message

Information about a message.

OutputFileUriValue

The value of the variable as a structure that specifies an output file URI.

ParquetConfiguration

Contains the configuration information of the Parquet format.

Partition

A partition dimension defined by an attribute.

Pipeline

Contains information about a pipeline.

PipelineActivity

An activity that performs a transformation on a message.

PipelineSummary

A summary of information about a pipeline.

QueryFilter

Information that is used to filter message data, to segregate it according to the timeframe in which it arrives.

RemoveAttributesActivity

An activity that removes attributes from a message.

ReprocessingSummary

Information about pipeline reprocessing.

ResourceConfiguration

The configuration of the resource used to execute the containerAction.

RetentionPeriod

How long, in days, message data is kept.

S3DestinationConfiguration

Configuration information for delivery of dataset contents to Amazon Simple Storage Service (Amazon S3).

Schedule

The schedule for when to trigger an update.

SchemaDefinition

Information needed to define a schema.

SelectAttributesActivity

Used to create a new message using only the specified attributes from the original message.

ServiceManagedChannelS3Storage

Used to store channel data in an S3 bucket managed by IoT Analytics. You can't change the choice of S3 storage after the data store is created.

ServiceManagedChannelS3StorageSummary

Used to store channel data in an S3 bucket managed by IoT Analytics.

ServiceManagedDatastoreS3Storage

Used to store data in an Amazon S3 bucket managed by IoT Analytics. You can't change the choice of Amazon S3 storage after your data store is created.

ServiceManagedDatastoreS3StorageSummary

Contains information about the data store that is managed by IoT Analytics.

SqlQueryDatasetAction

The SQL query to modify the message.

Tag

A set of key-value pairs that are used to manage the resource.

TimestampPartition

A partition dimension defined by a timestamp attribute.

TriggeringDataset

Information about the dataset whose content generation triggers the new dataset content generation.

Variable

An instance of a variable to be passed to the containerAction execution. Each variable must have a name and a value given by one of stringValue, datasetContentVersionValue, or outputFileUriValue.

VersioningConfiguration

Information about the versioning of dataset contents.

Enums§

ChannelStatus: When writing a match expression against ChannelStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ComputeType: When writing a match expression against ComputeType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
DatasetActionType: When writing a match expression against DatasetActionType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
DatasetContentState: When writing a match expression against DatasetContentState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
DatasetStatus: When writing a match expression against DatasetStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
DatastoreStatus: When writing a match expression against DatastoreStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
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.
FileFormatType: When writing a match expression against FileFormatType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
LoggingLevel: When writing a match expression against LoggingLevel, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ReprocessingStatus: When writing a match expression against ReprocessingStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

Module types

Module types Copy item path

Modules§

Structs§

Enums§

Module types