String name
The name of the addAttributes activity.
Map<K,V> attributes
A list of 1-50 AttributeNameMapping objects that map an existing attribute to a new attribute.
The existing attributes remain in the message, so if you want to remove the originals, use
RemoveAttributeActivity.
String next
The next activity in the pipeline.
String channelName
The name of the channel where the messages are sent.
List<E> messages
The list of messages to be sent. Each message has the format: { "messageId": "string", "payload": "string"}.
The field names of message payloads (data) that you send to IoT Analytics:
Must contain only alphanumeric characters and undescores (_). No other special characters are allowed.
Must begin with an alphabetic character or single underscore (_).
Cannot contain hyphens (-).
In regular expression terms: "^[A-Za-z_]([A-Za-z0-9]*|[A-Za-z0-9][A-Za-z0-9_]*)$".
Cannot be more than 255 characters.
Are case insensitive. (Fields named foo and FOO in the same payload are considered duplicates.)
For example, {"temp_01": 29} or {"_temp_01": 29} are valid, but {"temp-01": 29}, {"01_temp": 29} or {"__temp_01": 29} are invalid in message payloads.
String name
The name of the channel.
ChannelStorage 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.
String arn
The ARN of the channel.
String status
The status of the channel.
RetentionPeriod retentionPeriod
How long, in days, message data is kept for the channel.
Date creationTime
When the channel was created.
Date lastUpdateTime
When the channel was last updated.
Date lastMessageArrivalTime
The last time when a new message arrived in the channel.
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.
List<E> 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
EstimatedResourceSize size
The estimated size of the channel.
ServiceManagedChannelS3Storage serviceManagedS3
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.
CustomerManagedChannelS3Storage 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.
ServiceManagedChannelS3StorageSummary serviceManagedS3
Used to store channel data in an S3 bucket managed by IoT Analytics.
CustomerManagedChannelS3StorageSummary customerManagedS3
Used to store channel data in an S3 bucket that you manage.
String channelName
The name of the channel.
ChannelStorageSummary channelStorage
Where channel data is stored.
String status
The status of the channel.
Date creationTime
When the channel was created.
Date lastUpdateTime
The last time the channel was updated.
Date lastMessageArrivalTime
The last time when a new message arrived in the channel.
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.
String name
The name of the column.
String type
The type of data. For more information about the supported data types, see Common data types in the Glue Developer Guide.
String 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.
String 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.
ResourceConfiguration resourceConfiguration
Configuration of the resource that executes the containerAction.
List<E> 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.
String channelName
The name of the channel.
ChannelStorage channelStorage
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.
RetentionPeriod retentionPeriod
How long, in days, message data is kept for the channel. When customerManagedS3 storage is selected,
this parameter is ignored.
List<E> tags
Metadata which can be used to manage the channel.
String channelName
The name of the channel.
String channelArn
The ARN of the channel.
RetentionPeriod retentionPeriod
How long, in days, message data is kept for the channel.
String datasetName
The name of the dataset.
String versionId
The version ID of the dataset content. To specify versionId for a dataset content, the dataset must
use a DeltaTimer
filter.
String versionId
The version ID of the dataset contents that are being created.
String datasetName
The name of the dataset.
List<E> actions
A list of actions that create the dataset contents.
List<E> triggers
A list of triggers. A trigger causes dataset contents to be populated at a specified time interval or when
another dataset's contents are created. The list of triggers can be empty or contain up to five
DataSetTrigger objects.
List<E> contentDeliveryRules
When dataset contents are created, they are delivered to destinations specified here.
RetentionPeriod retentionPeriod
Optional. How long, in days, versions of dataset contents are kept for the dataset. If not specified or set to
null, versions of dataset contents are retained for at most 90 days. The number of versions of
dataset contents retained is determined by the versioningConfiguration parameter. For more
information, see Keeping Multiple Versions of IoT Analytics datasets in the IoT Analytics User Guide.
VersioningConfiguration 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 IoT Analytics datasets in the IoT Analytics User Guide.
List<E> tags
Metadata which can be used to manage the dataset.
List<E> 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.
String datasetName
The name of the dataset.
String datasetArn
The ARN of the dataset.
RetentionPeriod retentionPeriod
How long, in days, dataset contents are kept for the dataset.
String datastoreName
The name of the data store.
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.
RetentionPeriod retentionPeriod
How long, in days, message data is kept for the data store. When customerManagedS3 storage is
selected, this parameter is ignored.
List<E> tags
Metadata which can be used to manage the data store.
FileFormatConfiguration 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.
DatastorePartitions datastorePartitions
Contains information about the partition dimensions in a data store.
String datastoreName
The name of the data store.
String datastoreArn
The ARN of the data store.
RetentionPeriod retentionPeriod
How long, in days, message data is kept for the data store.
String pipelineName
The name of the pipeline.
List<E> pipelineActivities
A list of PipelineActivity objects. Activities perform transformations on your messages, such as
removing, renaming or adding message attributes; filtering messages based on attribute values; invoking your
Lambda unctions on messages for advanced processing; or performing mathematical transformations to normalize
device data.
The list can be 2-25 PipelineActivity objects and must contain both a channel and a
datastore activity. Each entry in the list must contain only one activity. For example:
pipelineActivities = [ { "channel": { ... } }, { "lambda": { ... } }, ... ]
List<E> tags
Metadata which can be used to manage the pipeline.
String bucket
The name of the S3 bucket in which channel data is stored.
String keyPrefix
(Optional) The prefix used to create the keys of the channel data objects. Each object in an 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 (/).
String roleArn
The ARN of the role that grants IoT Analytics permission to interact with your Amazon S3 resources.
String bucket
The name of the S3 bucket in which channel data is stored.
String keyPrefix
(Optional) The prefix used to create the keys of the channel data objects. Each object in an S3 bucket has a key that is its unique identifier within the bucket (each object in a bucket has exactly one key). The prefix must end with a forward slash (/).
String roleArn
The ARN of the role that grants IoT Analytics permission to interact with your Amazon S3 resources.
String bucket
The name of the Amazon S3 bucket where your data is stored.
String 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 (/).
String roleArn
The ARN of the role that grants IoT Analytics permission to interact with your Amazon S3 resources.
String bucket
The name of the Amazon S3 bucket where your data is stored.
String 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 (/).
String roleArn
The ARN of the role that grants IoT Analytics permission to interact with your Amazon S3 resources.
String name
The name of the dataset.
String arn
The ARN of the dataset.
List<E> actions
The DatasetAction objects that automatically create the dataset contents.
List<E> triggers
The DatasetTrigger objects that specify when the dataset is automatically updated.
List<E> contentDeliveryRules
When dataset contents are created they are delivered to destinations specified here.
String status
The status of the dataset.
Date creationTime
When the dataset was created.
Date lastUpdateTime
The last time the dataset was updated.
RetentionPeriod retentionPeriod
Optional. How long, in days, message data is kept for the dataset.
VersioningConfiguration 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 IoT Analytics datasets in the IoT Analytics User Guide.
List<E> 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.
String actionName
The name of the dataset action by which dataset contents are automatically created.
SqlQueryDatasetAction queryAction
An SqlQueryDatasetAction object that uses an SQL query to automatically create dataset contents.
ContainerDatasetAction 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.
IotEventsDestinationConfiguration iotEventsDestinationConfiguration
Configuration information for delivery of dataset contents to IoT Events.
S3DestinationConfiguration s3DestinationConfiguration
Configuration information for delivery of dataset contents to Amazon S3.
String entryName
The name of the dataset content delivery rules entry.
DatasetContentDeliveryDestination destination
The destination to which dataset contents are delivered.
String version
The version of the dataset contents.
DatasetContentStatus status
The status of the dataset contents.
Date creationTime
The actual time the creation of the dataset contents was started.
Date scheduleTime
The time the creation of the dataset contents was scheduled to start.
Date completionTime
The time the dataset content status was updated to SUCCEEDED or FAILED.
String datasetName
The name of the dataset whose latest contents are used as input to the notebook or application.
String datasetName
The name of the dataset.
String status
The status of the dataset.
Date creationTime
The time the dataset was created.
Date lastUpdateTime
The last time the dataset was updated.
List<E> 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
List<E> actions
A list of DataActionSummary objects.
Schedule schedule
The Schedule when the trigger is initiated.
TriggeringDataset dataset
The dataset whose content creation triggers the creation of this dataset's contents.
String name
The name of the data store.
DatastoreStorage 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.
String arn
The ARN of the data store.
String status
The status of a data store:
The data store is being created.
The data store has been created and can be used.
The data store is being deleted.
RetentionPeriod retentionPeriod
How long, in days, message data is kept for the data store. When customerManagedS3 storage is
selected, this parameter is ignored.
Date creationTime
When the data store was created.
Date lastUpdateTime
The last time the data store was updated.
Date lastMessageArrivalTime
The last time when a new message arrived in the data store.
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.
FileFormatConfiguration 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.
DatastorePartitions datastorePartitions
Contains information about the partition dimensions in a data store.
IotSiteWiseCustomerManagedDatastoreS3Storage customerManagedS3Storage
Used to store data used by IoT SiteWise in an Amazon S3 bucket that you manage.
IotSiteWiseCustomerManagedDatastoreS3StorageSummary customerManagedS3Storage
Used to store data used by IoT SiteWise in an Amazon S3 bucket that you manage.
Partition attributePartition
A partition dimension defined by an attributeName.
TimestampPartition timestampPartition
A partition dimension defined by a timestamp attribute.
EstimatedResourceSize size
The estimated size of the data store.
ServiceManagedDatastoreS3Storage serviceManagedS3
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.
CustomerManagedDatastoreS3Storage 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.
DatastoreIotSiteWiseMultiLayerStorage iotSiteWiseMultiLayerStorage
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.
ServiceManagedDatastoreS3StorageSummary serviceManagedS3
Used to store data in an Amazon S3 bucket managed by IoT Analytics.
CustomerManagedDatastoreS3StorageSummary customerManagedS3
Used to store data in an Amazon S3 bucket managed by IoT Analytics.
DatastoreIotSiteWiseMultiLayerStorageSummary iotSiteWiseMultiLayerStorage
Used to store data used by IoT SiteWise in an Amazon S3 bucket that you manage.
String datastoreName
The name of the data store.
DatastoreStorageSummary datastoreStorage
Where data in a data store is stored.
String status
The status of the data store.
Date creationTime
When the data store was created.
Date lastUpdateTime
The last time the data store was updated.
Date lastMessageArrivalTime
The last time when a new message arrived in the data store.
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.
String fileFormatType
The file format of the data in the data store.
DatastorePartitions datastorePartitions
Contains information about the partition dimensions in a data store.
String channelName
The name of the channel to delete.
String datasetName
The name of the dataset whose content is deleted.
String versionId
The version of the dataset whose content is deleted. You can also use the strings "$LATEST" or "$LATEST_SUCCEEDED" to delete the latest or latest successfully completed data set. If not specified, "$LATEST_SUCCEEDED" is the default.
String datasetName
The name of the dataset to delete.
String datastoreName
The name of the data store to delete.
String pipelineName
The name of the pipeline to delete.
Integer 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.
String 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 generated.
Integer timeoutInMinutes
A time interval. You can use timeoutInMinutes so that IoT Analytics can batch up late data
notifications that have been generated since the last execution. IoT Analytics sends one batch of notifications
to Amazon CloudWatch Events at one time.
For more information about how to write a timestamp expression, see Date and Time Functions and Operators, in the Presto 0.172 Documentation.
String channelName
The name of the channel whose information is retrieved.
Boolean includeStatistics
If true, additional statistical information about the channel is included in the response. This feature can't be used with a channel whose S3 storage is customer-managed.
Channel channel
An object that contains information about the channel.
ChannelStatistics statistics
Statistics about the channel. Included if the includeStatistics parameter is set to
true in the request.
String datasetName
The name of the dataset whose information is retrieved.
Dataset dataset
An object that contains information about the dataset.
Datastore datastore
Information about the data store.
DatastoreStatistics statistics
Additional statistical information about the data store. Included if the includeStatistics parameter
is set to true in the request.
LoggingOptions loggingOptions
The current settings of the IoT Analytics logging options.
String pipelineName
The name of the pipeline whose information is retrieved.
Pipeline pipeline
A Pipeline object that contains information about the pipeline.
String name
The name of the deviceRegistryEnrich activity.
String attribute
The name of the attribute that is added to the message.
String thingName
The name of the IoT device whose registry information is added to the message.
String roleArn
The ARN of the role that allows access to the device's registry information.
String next
The next activity in the pipeline.
String name
The name of the deviceShadowEnrich activity.
String attribute
The name of the attribute that is added to the message.
String thingName
The name of the IoT device whose shadow information is added to the message.
String roleArn
The ARN of the role that allows access to the device's shadow.
String next
The next activity in the pipeline.
JsonConfiguration jsonConfiguration
Contains the configuration information of the JSON format.
ParquetConfiguration parquetConfiguration
Contains the configuration information of the Parquet format.
String datasetName
The name of the dataset whose contents are retrieved.
String versionId
The version of the dataset whose contents are retrieved. You can also use the strings "$LATEST" or "$LATEST_SUCCEEDED" to retrieve the contents of the latest or latest successfully completed dataset. If not specified, "$LATEST_SUCCEEDED" is the default.
List<E> entries
A list of DatasetEntry objects.
Date timestamp
The time when the request was made.
DatasetContentStatus status
The status of the dataset content.
String tableName
The name of the table in your Glue Data Catalog that is used to perform the ETL operations. An Glue Data Catalog table contains partitioned data and descriptions of data sources and targets.
String databaseName
The name of the database in your Glue Data Catalog in which the table is located. An Glue Data Catalog database contains metadata tables.
String bucket
The name of the Amazon S3 bucket where your data is stored.
String 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 (/).
String bucket
The name of the Amazon S3 bucket where your data is stored.
String 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 (/).
String name
The name of the lambda activity.
String lambdaName
The name of the Lambda function that is run on the message.
Integer batchSize
The number of messages passed to the Lambda function for processing.
The Lambda function must be able to process all of these messages within five minutes, which is the maximum timeout duration for Lambda functions.
String next
The next activity in the pipeline.
String ruleName
The name of the late data rule.
LateDataRuleConfiguration ruleConfiguration
The information needed to configure the late data rule.
DeltaTimeSessionWindowConfiguration deltaTimeSessionWindowConfiguration
The information needed to configure a delta time session window.
String datasetName
The name of the dataset whose contents information you want to list.
String nextToken
The token for the next set of results.
Integer maxResults
The maximum number of results to return in this request.
Date scheduledOnOrAfter
A filter to limit results to those dataset contents whose creation is scheduled on or after the given time. See
the field triggers.schedule in the CreateDataset request. (timestamp)
Date scheduledBefore
A filter to limit results to those dataset contents whose creation is scheduled before the given time. See the
field triggers.schedule in the CreateDataset request. (timestamp)
String resourceArn
The ARN of the resource whose tags you want to list.
String name
The name of the math activity.
String attribute
The name of the attribute that contains the result of the math operation.
String math
An expression that uses one or more existing attributes and must return an integer value.
String next
The next activity in the pipeline.
String messageId
The ID you want to assign to the message. Each messageId must be unique within each batch sent.
ByteBuffer payload
The payload of the message. This can be a JSON string or a base64-encoded string representing binary data, in which case you must decode it by means of a pipeline activity.
String fileName
The URI of the location where dataset contents are stored, usually the URI of a file in an S3 bucket.
SchemaDefinition schemaDefinition
Information needed to define a schema.
String attributeName
The name of the attribute that defines a partition dimension.
String name
The name of the pipeline.
String arn
The ARN of the pipeline.
List<E> activities
The activities that perform transformations on the messages.
List<E> reprocessingSummaries
A summary of information about the pipeline reprocessing.
Date creationTime
When the pipeline was created.
Date lastUpdateTime
The last time the pipeline was updated.
ChannelActivity channel
Determines the source of the messages to be processed.
LambdaActivity lambda
Runs a Lambda function to modify the message.
DatastoreActivity datastore
Specifies where to store the processed message data.
AddAttributesActivity addAttributes
Adds other attributes based on existing attributes in the message.
RemoveAttributesActivity removeAttributes
Removes attributes from a message.
SelectAttributesActivity selectAttributes
Used to create a new message using only the specified attributes from the original message.
FilterActivity filter
Filters a message based on its attributes.
MathActivity math
Computes an arithmetic expression using the message's attributes and adds it to the message.
DeviceRegistryEnrichActivity deviceRegistryEnrich
Adds data from the IoT device registry to your message.
DeviceShadowEnrichActivity deviceShadowEnrich
Adds information from the IoT Device Shadow service to a message.
String pipelineName
The name of the pipeline.
List<E> reprocessingSummaries
A summary of information about the pipeline reprocessing.
Date creationTime
When the pipeline was created.
Date lastUpdateTime
When the pipeline was last updated.
LoggingOptions loggingOptions
The new values of the IoT Analytics logging options.
DeltaTime deltaTime
Used to limit data to that which has arrived since the last execution of the action.
String computeType
The type of the compute resource used to execute the containerAction. Possible values are:
ACU_1 (vCPU=4, memory=16 GiB) or ACU_2 (vCPU=8, memory=32 GiB).
Integer volumeSizeInGB
The size, in GB, of the persistent storage available to the resource instance used to execute the
containerAction (min: 1, max: 50).
PipelineActivity pipelineActivity
The pipeline activity that is run. This must not be a channel activity or a data store activity because these activities are used in a pipeline only to load the original message and to store the (possibly) transformed message. If a Lambda activity is specified, only short-running Lambda functions (those with a timeout of less than 30 seconds or less) can be used.
List<E> payloads
The sample message payloads on which the pipeline activity is run.
List<E> payloads
The enriched or transformed sample message payloads as base64-encoded strings. (The results of running the pipeline activity on each input sample message payload, encoded in base64.)
String logResult
In case the pipeline activity fails, the log message that is generated.
String bucket
The name of the S3 bucket to which dataset contents are delivered.
String key
The key of the dataset contents object in an S3 bucket. Each object has a key that is a unique identifier. Each object has exactly one key.
You can create a unique key with the following options:
Use !{iotanalytics:scheduleTime} to insert the time of a scheduled SQL query run.
Use !{iotanalytics:versionId} to insert a unique hash that identifies a dataset content.
Use !{iotanalytics:creationTime} to insert the creation time of a dataset content.
The following example creates a unique key for a CSV file:
dataset/mydataset/!{iotanalytics:scheduleTime}/!{iotanalytics:versionId}.csv
If you don't use !{iotanalytics:versionId} to specify the key, you might get duplicate keys. For
example, you might have two dataset contents with the same scheduleTime but different
versionIds. This means that one dataset content overwrites the other.
GlueConfiguration glueConfiguration
Configuration information for coordination with Glue, a fully managed extract, transform and load (ETL) service.
String roleArn
The ARN of the role that grants IoT Analytics permission to interact with your Amazon S3 and Glue resources.
String channelName
The name of the channel whose message samples are retrieved.
Integer maxMessages
The number of sample messages to be retrieved. The limit is 10. The default is also 10.
Date startTime
The start of the time window from which sample messages are retrieved.
Date endTime
The end of the time window from which sample messages are retrieved.
String expression
The expression that defines when to trigger an update. For more information, see Schedule Expressions for Rules in the Amazon CloudWatch Events User Guide.
String pipelineName
The name of the pipeline on which to start reprocessing.
Date startTime
The start time (inclusive) of raw message data that is reprocessed.
If you specify a value for the startTime parameter, you must not use the
channelMessages object.
Date endTime
The end time (exclusive) of raw message data that is reprocessed.
If you specify a value for the endTime parameter, you must not use the channelMessages
object.
ChannelMessages channelMessages
Specifies one or more sets of channel messages that you want to reprocess.
If you use the channelMessages object, you must not specify a value for startTime and
endTime.
String reprocessingId
The ID of the pipeline reprocessing activity that was started.
String name
The name of the dataset whose content generation triggers the new dataset content generation.
String channelName
The name of the channel to be updated.
ChannelStorage channelStorage
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.
RetentionPeriod retentionPeriod
How long, in days, message data is kept for the channel. The retention period can't be updated if the channel's Amazon S3 storage is customer-managed.
String datasetName
The name of the dataset to update.
List<E> actions
A list of DatasetAction objects.
List<E> triggers
A list of DatasetTrigger objects. The list can be empty or can contain up to five
DatasetTrigger objects.
List<E> contentDeliveryRules
When dataset contents are created, they are delivered to destinations specified here.
RetentionPeriod retentionPeriod
How long, in days, dataset contents are kept for the dataset.
VersioningConfiguration 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 IoT Analytics datasets in the IoT Analytics User Guide.
List<E> 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.
String datastoreName
The name of the data store to be updated.
RetentionPeriod retentionPeriod
How long, in days, message data is kept for the data store. The retention period can't be updated if the data store's Amazon S3 storage is customer-managed.
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.
FileFormatConfiguration 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.
String pipelineName
The name of the pipeline to update.
List<E> pipelineActivities
A list of PipelineActivity objects. Activities perform transformations on your messages, such as
removing, renaming or adding message attributes; filtering messages based on attribute values; invoking your
Lambda functions on messages for advanced processing; or performing mathematical transformations to normalize
device data.
The list can be 2-25 PipelineActivity objects and must contain both a channel and a
datastore activity. Each entry in the list must contain only one activity. For example:
pipelineActivities = [ { "channel": { ... } }, { "lambda": { ... } }, ... ]
String name
The name of the variable.
String stringValue
The value of the variable as a string.
Double doubleValue
The value of the variable as a double (numeric).
DatasetContentVersionValue datasetContentVersionValue
The value of the variable as a structure that specifies a dataset content version.
OutputFileUriValue outputFileUriValue
The value of the variable as a structure that specifies an output file URI.
Copyright © 2021. All rights reserved.