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 format: '{ "messageId": "string", "payload": "string"}'.
Note that the field names of message payloads (data) that you send to AWS 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 greater 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.
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.
EstimatedResourceSize size
The estimated size of the channel.
ServiceManagedChannelS3Storage serviceManagedS3
Use this to store channel data in an S3 bucket managed by the AWS IoT Analytics service.
CustomerManagedChannelS3Storage customerManagedS3
Use this to store channel data in an S3 bucket that you manage.
ServiceManagedChannelS3StorageSummary serviceManagedS3
Used to store channel data in an S3 bucket managed by the AWS IoT Analytics service.
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.
String image
The ARN of the Docker container stored in your account. The Docker container contains an application and needed support libraries and is used to generate data set contents.
String executionRoleArn
The ARN of the role which gives permission to the system to access needed resources in order to run the "containerAction". This includes, at minimum, permission to retrieve the data set contents which are the input to the containerized application.
ResourceConfiguration resourceConfiguration
Configuration of the resource which executes the "containerAction".
List<E> variables
The values of variables used within 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.
RetentionPeriod retentionPeriod
How long, in days, message data is kept for the channel.
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 data set.
String versionId
The version ID of the data set contents which are being created.
String datasetName
The name of the data set.
List<E> actions
A list of actions that create the data set contents.
List<E> triggers
A list of triggers. A trigger causes data set contents to be populated at a specified time interval or when another data set's contents are created. The list of triggers can be empty or contain up to five DataSetTrigger objects.
List<E> contentDeliveryRules
When data set contents are created they are delivered to destinations specified here.
RetentionPeriod retentionPeriod
[Optional] How long, in days, versions of data set contents are kept for the data set. If not specified or set to
null, versions of data set contents are retained for at most 90 days. The number of versions of data set contents
retained is determined by the versioningConfiguration parameter. (For more information, see
https://docs
.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions)
VersioningConfiguration versioningConfiguration
[Optional] How many versions of data set 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 https://docs.aws.amazon.com/iotanalytics/latest/userguide/ getting-started.html#aws-iot-analytics-dataset-versions)
List<E> tags
Metadata which can be used to manage the data set.
String datasetName
The name of the data set.
String datasetArn
The ARN of the data set.
RetentionPeriod retentionPeriod
How long, in days, data set contents are kept for the data set.
String datastoreName
The name of the data store.
DatastoreStorage datastoreStorage
Where data store data is stored.
RetentionPeriod retentionPeriod
How long, in days, message data is kept for the data store.
List<E> tags
Metadata which can be used to manage the 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 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": { ... } }, ... ]
List<E> tags
Metadata which can be used to manage the pipeline.
String bucket
The name of the Amazon S3 bucket in which channel data is stored.
String keyPrefix
The prefix used to create the keys of the channel data objects. Each object in an Amazon S3 bucket has a key that is its unique identifier within the bucket (each object in a bucket has exactly one key).
String roleArn
The ARN of the role which grants AWS IoT Analytics permission to interact with your Amazon S3 resources.
String bucket
The name of the Amazon S3 bucket in which channel data is stored.
String keyPrefix
The prefix used to create the keys of the channel data objects. Each object in an Amazon S3 bucket has a key that is its unique identifier within the bucket (each object in a bucket has exactly one key).
String roleArn
The ARN of the role which grants AWS IoT Analytics permission to interact with your Amazon S3 resources.
String bucket
The name of the Amazon S3 bucket in which data store data is stored.
String keyPrefix
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 within the bucket (each object in a bucket has exactly one key).
String roleArn
The ARN of the role which grants AWS IoT Analytics permission to interact with your Amazon S3 resources.
String bucket
The name of the Amazon S3 bucket in which data store data is stored.
String keyPrefix
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 within the bucket (each object in a bucket has exactly one key).
String roleArn
The ARN of the role which grants AWS IoT Analytics permission to interact with your Amazon S3 resources.
String name
The name of the data set.
String arn
The ARN of the data set.
List<E> actions
The "DatasetAction" objects that automatically create the data set contents.
List<E> triggers
The "DatasetTrigger" objects that specify when the data set is automatically updated.
List<E> contentDeliveryRules
When data set contents are created they are delivered to destinations specified here.
String status
The status of the data set.
Date creationTime
When the data set was created.
Date lastUpdateTime
The last time the data set was updated.
RetentionPeriod retentionPeriod
[Optional] How long, in days, message data is kept for the data set.
VersioningConfiguration versioningConfiguration
[Optional] How many versions of data set 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 https://docs.aws.amazon.com/iotanalytics/latest/userguide/ getting-started.html#aws-iot-analytics-dataset-versions)
String actionName
The name of the data set action by which data set contents are automatically created.
SqlQueryDatasetAction queryAction
An "SqlQueryDatasetAction" object that uses an SQL query to automatically create data set contents.
ContainerDatasetAction containerAction
Information which allows the system to run a containerized application in order to create the data set contents. The application must be in a Docker container along with any needed support libraries.
IotEventsDestinationConfiguration iotEventsDestinationConfiguration
Configuration information for delivery of data set contents to AWS IoT Events.
S3DestinationConfiguration s3DestinationConfiguration
Configuration information for delivery of data set contents to Amazon S3.
String entryName
The name of the data set content delivery rules entry.
DatasetContentDeliveryDestination destination
The destination to which data set contents are delivered.
String version
The version of the data set contents.
DatasetContentStatus status
The status of the data set contents.
Date creationTime
The actual time the creation of the data set contents was started.
Date scheduleTime
The time the creation of the data set contents was scheduled to start.
String datasetName
The name of the data set whose latest contents are used as input to the notebook or application.
String datasetName
The name of the data set.
String status
The status of the data set.
Date creationTime
The time the data set was created.
Date lastUpdateTime
The last time the data set was updated.
List<E> triggers
A list of triggers. A trigger causes data set content to be populated at a specified time interval or when another data set 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 data set whose content creation triggers the creation of this data set's contents.
String name
The name of the data store.
DatastoreStorage storage
Where data store data is stored.
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.
Date creationTime
When the data store was created.
Date lastUpdateTime
The last time the data store was updated.
EstimatedResourceSize size
The estimated size of the data store.
ServiceManagedDatastoreS3Storage serviceManagedS3
Use this to store data store data in an S3 bucket managed by the AWS IoT Analytics service.
CustomerManagedDatastoreS3Storage customerManagedS3
Use this to store data store data in an S3 bucket that you manage.
ServiceManagedDatastoreS3StorageSummary serviceManagedS3
Used to store data store data in an S3 bucket managed by the AWS IoT Analytics service.
CustomerManagedDatastoreS3StorageSummary customerManagedS3
Used to store data store data in an S3 bucket that you manage.
String datastoreName
The name of the data store.
DatastoreStorageSummary datastoreStorage
Where data store data 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.
String channelName
The name of the channel to delete.
String datasetName
The name of the data set whose content is deleted.
String versionId
The version of the data set 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 data set 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 data set contents using message data from a specified time frame, some message data may still be "in flight" when processing begins, and so will 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 time frame will be included with the next time frame. Without this, missed message data would be excluded from processing during the next time frame as well, because its timestamp places it within the previous time frame.
String timeExpression
An expression by which the time of the message data may be determined. This may be the name of a timestamp field, or a SQL expression which is used to derive the time the message data was generated.
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 data set whose information is retrieved.
Dataset dataset
An object that contains information about the data set.
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 AWS 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.
String datasetName
The name of the data set whose contents are retrieved.
String versionId
The version of the data set 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 data set. 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 data set content.
String tableName
The name of the table in your AWS Glue Data Catalog which is used to perform the ETL (extract, transform and load) operations. (An AWS Glue Data Catalog table contains partitioned data and descriptions of data sources and targets.)
String databaseName
The name of the database in your AWS Glue Data Catalog in which the table is located. (An AWS Glue Data Catalog database contains Glue Data tables.)
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 AWS 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 datasetName
The name of the data set 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 data set 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 data set 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 wish to assign to the message. Each "messageId" must be unique within each batch sent.
ByteBuffer payload
The payload of the message. This may 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 data set contents are stored, usually the URI of a file in an S3 bucket.
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
Creates 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 AWS IoT device registry to your message.
DeviceShadowEnrichActivity deviceShadowEnrich
Adds information from the AWS IoT Device Shadows 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 AWS 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=16GiB) or ACU_2 (vCPU=8, memory=32GiB).
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 'datastore' 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 Amazon S3 bucket to which data set contents are delivered.
String key
The key of the data set contents object. Each object in an Amazon S3 bucket has a key that is its unique identifier within the bucket (each object in a bucket has exactly one key).
GlueConfiguration glueConfiguration
Configuration information for coordination with the AWS Glue ETL (extract, transform and load) service.
String roleArn
The ARN of the role which grants AWS IoT Analytics permission to interact with your Amazon S3 and AWS 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 reprocessingId
The ID of the pipeline reprocessing activity that was started.
String name
The name of the data set whose content generation triggers the new data set content generation.
String channelName
The name of the channel to be updated.
ChannelStorage channelStorage
Where channel data is stored.
RetentionPeriod retentionPeriod
How long, in days, message data is kept for the channel.
String datasetName
The name of the data set 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 data set contents are created they are delivered to destinations specified here.
RetentionPeriod retentionPeriod
How long, in days, data set contents are kept for the data set.
VersioningConfiguration versioningConfiguration
[Optional] How many versions of data set 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 https://docs.aws.amazon.com/iotanalytics/latest/userguide/ getting-started.html#aws-iot-analytics-dataset-versions)
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.
DatastoreStorage datastoreStorage
Where data store data is stored.
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 data set content version.
OutputFileUriValue outputFileUriValue
The value of the variable as a structure that specifies an output file URI.
Copyright © 2019. All rights reserved.