libZSservicesZSamazonka-iot-analyticsZSamazonka-iot-analytics
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.IoTAnalytics.Lens

Contents

Description

 
Synopsis

Operations

DescribePipeline

describePipeline_pipelineName :: Lens' DescribePipeline Text Source #

The name of the pipeline whose information is retrieved.

describePipelineResponse_pipeline :: Lens' DescribePipelineResponse (Maybe Pipeline) Source #

A Pipeline object that contains information about the pipeline.

DescribeDataset

describeDataset_datasetName :: Lens' DescribeDataset Text Source #

The name of the dataset whose information is retrieved.

describeDatasetResponse_dataset :: Lens' DescribeDatasetResponse (Maybe Dataset) Source #

An object that contains information about the dataset.

ListChannels

listChannels_nextToken :: Lens' ListChannels (Maybe Text) Source #

The token for the next set of results.

listChannels_maxResults :: Lens' ListChannels (Maybe Natural) Source #

The maximum number of results to return in this request.

The default value is 100.

listChannelsResponse_nextToken :: Lens' ListChannelsResponse (Maybe Text) Source #

The token to retrieve the next set of results, or null if there are no more results.

ListDatasetContents

listDatasetContents_nextToken :: Lens' ListDatasetContents (Maybe Text) Source #

The token for the next set of results.

listDatasetContents_scheduledBefore :: Lens' ListDatasetContents (Maybe UTCTime) Source #

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)

listDatasetContents_maxResults :: Lens' ListDatasetContents (Maybe Natural) Source #

The maximum number of results to return in this request.

listDatasetContents_scheduledOnOrAfter :: Lens' ListDatasetContents (Maybe UTCTime) Source #

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)

listDatasetContents_datasetName :: Lens' ListDatasetContents Text Source #

The name of the dataset whose contents information you want to list.

listDatasetContentsResponse_datasetContentSummaries :: Lens' ListDatasetContentsResponse (Maybe [DatasetContentSummary]) Source #

Summary information about dataset contents that have been created.

listDatasetContentsResponse_nextToken :: Lens' ListDatasetContentsResponse (Maybe Text) Source #

The token to retrieve the next set of results, or null if there are no more results.

PutLoggingOptions

putLoggingOptions_loggingOptions :: Lens' PutLoggingOptions LoggingOptions Source #

The new values of the IoT Analytics logging options.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The ARN of the resource whose tags you want to list.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (NonEmpty Tag)) Source #

The tags (metadata) that you have assigned to the resource.

DeleteChannel

deleteChannel_channelName :: Lens' DeleteChannel Text Source #

The name of the channel to delete.

UpdateChannel

updateChannel_retentionPeriod :: Lens' UpdateChannel (Maybe RetentionPeriod) Source #

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.

updateChannel_channelStorage :: Lens' UpdateChannel (Maybe ChannelStorage) Source #

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.

updateChannel_channelName :: Lens' UpdateChannel Text Source #

The name of the channel to be updated.

SampleChannelData

sampleChannelData_startTime :: Lens' SampleChannelData (Maybe UTCTime) Source #

The start of the time window from which sample messages are retrieved.

sampleChannelData_maxMessages :: Lens' SampleChannelData (Maybe Natural) Source #

The number of sample messages to be retrieved. The limit is 10. The default is also 10.

sampleChannelData_endTime :: Lens' SampleChannelData (Maybe UTCTime) Source #

The end of the time window from which sample messages are retrieved.

sampleChannelData_channelName :: Lens' SampleChannelData Text Source #

The name of the channel whose message samples are retrieved.

sampleChannelDataResponse_payloads :: Lens' SampleChannelDataResponse (Maybe (NonEmpty ByteString)) Source #

The list of message samples. Each sample message is returned as a base64-encoded string.

CancelPipelineReprocessing

cancelPipelineReprocessing_pipelineName :: Lens' CancelPipelineReprocessing Text Source #

The name of pipeline for which data reprocessing is canceled.

cancelPipelineReprocessing_reprocessingId :: Lens' CancelPipelineReprocessing Text Source #

The ID of the reprocessing task (returned by StartPipelineReprocessing).

CreateDatastore

createDatastore_fileFormatConfiguration :: Lens' CreateDatastore (Maybe FileFormatConfiguration) Source #

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.

createDatastore_datastorePartitions :: Lens' CreateDatastore (Maybe DatastorePartitions) Source #

Contains information about the partition dimensions in a data store.

createDatastore_retentionPeriod :: Lens' CreateDatastore (Maybe RetentionPeriod) Source #

How long, in days, message data is kept for the data store. When customerManagedS3 storage is selected, this parameter is ignored.

createDatastore_datastoreStorage :: Lens' CreateDatastore (Maybe DatastoreStorage) Source #

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.

createDatastore_tags :: Lens' CreateDatastore (Maybe (NonEmpty Tag)) Source #

Metadata which can be used to manage the data store.

createDatastoreResponse_retentionPeriod :: Lens' CreateDatastoreResponse (Maybe RetentionPeriod) Source #

How long, in days, message data is kept for the data store.

UpdatePipeline

updatePipeline_pipelineName :: Lens' UpdatePipeline Text Source #

The name of the pipeline to update.

updatePipeline_pipelineActivities :: Lens' UpdatePipeline (NonEmpty PipelineActivity) Source #

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": { ... } }, ... ]

DeletePipeline

deletePipeline_pipelineName :: Lens' DeletePipeline Text Source #

The name of the pipeline to delete.

DeleteDataset

deleteDataset_datasetName :: Lens' DeleteDataset Text Source #

The name of the dataset to delete.

UpdateDataset

updateDataset_versioningConfiguration :: Lens' UpdateDataset (Maybe VersioningConfiguration) Source #

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.

updateDataset_triggers :: Lens' UpdateDataset (Maybe [DatasetTrigger]) Source #

A list of DatasetTrigger objects. The list can be empty or can contain up to five DatasetTrigger objects.

updateDataset_retentionPeriod :: Lens' UpdateDataset (Maybe RetentionPeriod) Source #

How long, in days, dataset contents are kept for the dataset.

updateDataset_lateDataRules :: Lens' UpdateDataset (Maybe (NonEmpty LateDataRule)) Source #

A list of data rules that send notifications to CloudWatch, when data arrives late. To specify lateDataRules, the dataset must use a DeltaTimer filter.

updateDataset_contentDeliveryRules :: Lens' UpdateDataset (Maybe [DatasetContentDeliveryRule]) Source #

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

updateDataset_datasetName :: Lens' UpdateDataset Text Source #

The name of the dataset to update.

ListPipelines

listPipelines_nextToken :: Lens' ListPipelines (Maybe Text) Source #

The token for the next set of results.

listPipelines_maxResults :: Lens' ListPipelines (Maybe Natural) Source #

The maximum number of results to return in this request.

The default value is 100.

listPipelinesResponse_nextToken :: Lens' ListPipelinesResponse (Maybe Text) Source #

The token to retrieve the next set of results, or null if there are no more results.

DeleteDatastore

deleteDatastore_datastoreName :: Lens' DeleteDatastore Text Source #

The name of the data store to delete.

UpdateDatastore

updateDatastore_fileFormatConfiguration :: Lens' UpdateDatastore (Maybe FileFormatConfiguration) Source #

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.

updateDatastore_retentionPeriod :: Lens' UpdateDatastore (Maybe RetentionPeriod) Source #

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.

updateDatastore_datastoreStorage :: Lens' UpdateDatastore (Maybe DatastoreStorage) Source #

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.

updateDatastore_datastoreName :: Lens' UpdateDatastore Text Source #

The name of the data store to be updated.

CreateDataset

createDataset_versioningConfiguration :: Lens' CreateDataset (Maybe VersioningConfiguration) Source #

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.

createDataset_triggers :: Lens' CreateDataset (Maybe [DatasetTrigger]) Source #

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.

createDataset_retentionPeriod :: Lens' CreateDataset (Maybe RetentionPeriod) Source #

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.

createDataset_lateDataRules :: Lens' CreateDataset (Maybe (NonEmpty LateDataRule)) Source #

A list of data rules that send notifications to CloudWatch, when data arrives late. To specify lateDataRules, the dataset must use a DeltaTimer filter.

createDataset_contentDeliveryRules :: Lens' CreateDataset (Maybe [DatasetContentDeliveryRule]) Source #

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

createDataset_tags :: Lens' CreateDataset (Maybe (NonEmpty Tag)) Source #

Metadata which can be used to manage the dataset.

createDataset_actions :: Lens' CreateDataset (NonEmpty DatasetAction) Source #

A list of actions that create the dataset contents.

createDatasetResponse_retentionPeriod :: Lens' CreateDatasetResponse (Maybe RetentionPeriod) Source #

How long, in days, dataset contents are kept for the dataset.

BatchPutMessage

batchPutMessage_channelName :: Lens' BatchPutMessage Text Source #

The name of the channel where the messages are sent.

batchPutMessage_messages :: Lens' BatchPutMessage [Message] Source #

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.

batchPutMessageResponse_batchPutMessageErrorEntries :: Lens' BatchPutMessageResponse (Maybe [BatchPutMessageErrorEntry]) Source #

A list of any errors encountered when sending the messages to the channel.

ListDatastores

listDatastores_nextToken :: Lens' ListDatastores (Maybe Text) Source #

The token for the next set of results.

listDatastores_maxResults :: Lens' ListDatastores (Maybe Natural) Source #

The maximum number of results to return in this request.

The default value is 100.

listDatastoresResponse_nextToken :: Lens' ListDatastoresResponse (Maybe Text) Source #

The token to retrieve the next set of results, or null if there are no more results.

CreateDatasetContent

createDatasetContent_versionId :: Lens' CreateDatasetContent (Maybe Text) Source #

The version ID of the dataset content. To specify versionId for a dataset content, the dataset must use a DeltaTimer filter.

createDatasetContentResponse_versionId :: Lens' CreateDatasetContentResponse (Maybe Text) Source #

The version ID of the dataset contents that are being created.

CreateChannel

createChannel_retentionPeriod :: Lens' CreateChannel (Maybe RetentionPeriod) Source #

How long, in days, message data is kept for the channel. When customerManagedS3 storage is selected, this parameter is ignored.

createChannel_channelStorage :: Lens' CreateChannel (Maybe ChannelStorage) Source #

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.

createChannel_tags :: Lens' CreateChannel (Maybe (NonEmpty Tag)) Source #

Metadata which can be used to manage the channel.

createChannelResponse_retentionPeriod :: Lens' CreateChannelResponse (Maybe RetentionPeriod) Source #

How long, in days, message data is kept for the channel.

DeleteDatasetContent

deleteDatasetContent_versionId :: Lens' DeleteDatasetContent (Maybe Text) Source #

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.

deleteDatasetContent_datasetName :: Lens' DeleteDatasetContent Text Source #

The name of the dataset whose content is deleted.

DescribeDatastore

describeDatastore_includeStatistics :: Lens' DescribeDatastore (Maybe Bool) Source #

If true, additional statistical information about the data store is included in the response. This feature can't be used with a data store whose S3 storage is customer-managed.

describeDatastoreResponse_statistics :: Lens' DescribeDatastoreResponse (Maybe DatastoreStatistics) Source #

Additional statistical information about the data store. Included if the includeStatistics parameter is set to true in the request.

GetDatasetContent

getDatasetContent_versionId :: Lens' GetDatasetContent (Maybe Text) Source #

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.

getDatasetContent_datasetName :: Lens' GetDatasetContent Text Source #

The name of the dataset whose contents are retrieved.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The ARN of the resource whose tags you want to modify.

tagResource_tags :: Lens' TagResource (NonEmpty Tag) Source #

The new or modified tags for the resource.

ListDatasets

listDatasets_nextToken :: Lens' ListDatasets (Maybe Text) Source #

The token for the next set of results.

listDatasets_maxResults :: Lens' ListDatasets (Maybe Natural) Source #

The maximum number of results to return in this request.

The default value is 100.

listDatasetsResponse_nextToken :: Lens' ListDatasetsResponse (Maybe Text) Source #

The token to retrieve the next set of results, or null if there are no more results.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

The ARN of the resource whose tags you want to remove.

untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text) Source #

The keys of those tags which you want to remove.

RunPipelineActivity

runPipelineActivity_pipelineActivity :: Lens' RunPipelineActivity PipelineActivity Source #

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.

runPipelineActivity_payloads :: Lens' RunPipelineActivity (NonEmpty ByteString) Source #

The sample message payloads on which the pipeline activity is run.

runPipelineActivityResponse_logResult :: Lens' RunPipelineActivityResponse (Maybe Text) Source #

In case the pipeline activity fails, the log message that is generated.

runPipelineActivityResponse_payloads :: Lens' RunPipelineActivityResponse (Maybe (NonEmpty ByteString)) Source #

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.)

DescribeChannel

describeChannel_includeStatistics :: Lens' DescribeChannel (Maybe Bool) Source #

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.

describeChannel_channelName :: Lens' DescribeChannel Text Source #

The name of the channel whose information is retrieved.

describeChannelResponse_channel :: Lens' DescribeChannelResponse (Maybe Channel) Source #

An object that contains information about the channel.

describeChannelResponse_statistics :: Lens' DescribeChannelResponse (Maybe ChannelStatistics) Source #

Statistics about the channel. Included if the includeStatistics parameter is set to true in the request.

CreatePipeline

createPipeline_tags :: Lens' CreatePipeline (Maybe (NonEmpty Tag)) Source #

Metadata which can be used to manage the pipeline.

createPipeline_pipelineActivities :: Lens' CreatePipeline (NonEmpty PipelineActivity) Source #

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": { ... } }, ... ]

StartPipelineReprocessing

startPipelineReprocessing_startTime :: Lens' StartPipelineReprocessing (Maybe UTCTime) Source #

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.

startPipelineReprocessing_endTime :: Lens' StartPipelineReprocessing (Maybe UTCTime) Source #

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.

startPipelineReprocessing_channelMessages :: Lens' StartPipelineReprocessing (Maybe ChannelMessages) Source #

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.

startPipelineReprocessing_pipelineName :: Lens' StartPipelineReprocessing Text Source #

The name of the pipeline on which to start reprocessing.

startPipelineReprocessingResponse_reprocessingId :: Lens' StartPipelineReprocessingResponse (Maybe Text) Source #

The ID of the pipeline reprocessing activity that was started.

DescribeLoggingOptions

Types

AddAttributesActivity

addAttributesActivity_name :: Lens' AddAttributesActivity Text Source #

The name of the addAttributes activity.

addAttributesActivity_attributes :: Lens' AddAttributesActivity (HashMap Text Text) Source #

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.

BatchPutMessageErrorEntry

batchPutMessageErrorEntry_messageId :: Lens' BatchPutMessageErrorEntry (Maybe Text) Source #

The ID of the message that caused the error. See the value corresponding to the messageId key in the message object.

Channel

channel_creationTime :: Lens' Channel (Maybe UTCTime) Source #

When the channel was created.

channel_status :: Lens' Channel (Maybe ChannelStatus) Source #

The status of the channel.

channel_lastMessageArrivalTime :: Lens' Channel (Maybe UTCTime) Source #

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.

channel_arn :: Lens' Channel (Maybe Text) Source #

The ARN of the channel.

channel_storage :: Lens' Channel (Maybe ChannelStorage) Source #

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.

channel_retentionPeriod :: Lens' Channel (Maybe RetentionPeriod) Source #

How long, in days, message data is kept for the channel.

channel_name :: Lens' Channel (Maybe Text) Source #

The name of the channel.

channel_lastUpdateTime :: Lens' Channel (Maybe UTCTime) Source #

When the channel was last updated.

ChannelActivity

channelActivity_next :: Lens' ChannelActivity (Maybe Text) Source #

The next activity in the pipeline.

channelActivity_name :: Lens' ChannelActivity Text Source #

The name of the channel activity.

channelActivity_channelName :: Lens' ChannelActivity Text Source #

The name of the channel from which the messages are processed.

ChannelMessages

channelMessages_s3Paths :: Lens' ChannelMessages (Maybe (NonEmpty Text)) Source #

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

ChannelStatistics

ChannelStorage

channelStorage_serviceManagedS3 :: Lens' ChannelStorage (Maybe ServiceManagedChannelS3Storage) Source #

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.

channelStorage_customerManagedS3 :: Lens' ChannelStorage (Maybe CustomerManagedChannelS3Storage) Source #

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.

ChannelStorageSummary

channelStorageSummary_serviceManagedS3 :: Lens' ChannelStorageSummary (Maybe ServiceManagedChannelS3StorageSummary) Source #

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

ChannelSummary

channelSummary_lastMessageArrivalTime :: Lens' ChannelSummary (Maybe UTCTime) Source #

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.

channelSummary_lastUpdateTime :: Lens' ChannelSummary (Maybe UTCTime) Source #

The last time the channel was updated.

Column

column_name :: Lens' Column Text Source #

The name of the column.

column_type :: Lens' Column Text Source #

The type of data. For more information about the supported data types, see Common data types in the Glue Developer Guide.

ContainerDatasetAction

containerDatasetAction_variables :: Lens' ContainerDatasetAction (Maybe [Variable]) Source #

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.

containerDatasetAction_image :: Lens' ContainerDatasetAction Text Source #

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.

containerDatasetAction_executionRoleArn :: Lens' ContainerDatasetAction Text Source #

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.

containerDatasetAction_resourceConfiguration :: Lens' ContainerDatasetAction ResourceConfiguration Source #

Configuration of the resource that executes the containerAction.

CustomerManagedChannelS3Storage

customerManagedChannelS3Storage_keyPrefix :: Lens' CustomerManagedChannelS3Storage (Maybe Text) Source #

(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 (/).

customerManagedChannelS3Storage_bucket :: Lens' CustomerManagedChannelS3Storage Text Source #

The name of the S3 bucket in which channel data is stored.

customerManagedChannelS3Storage_roleArn :: Lens' CustomerManagedChannelS3Storage Text Source #

The ARN of the role that grants IoT Analytics permission to interact with your Amazon S3 resources.

CustomerManagedChannelS3StorageSummary

customerManagedChannelS3StorageSummary_keyPrefix :: Lens' CustomerManagedChannelS3StorageSummary (Maybe Text) Source #

(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 (/).

customerManagedChannelS3StorageSummary_roleArn :: Lens' CustomerManagedChannelS3StorageSummary (Maybe Text) Source #

The ARN of the role that grants IoT Analytics permission to interact with your Amazon S3 resources.

CustomerManagedDatastoreS3Storage

customerManagedDatastoreS3Storage_keyPrefix :: Lens' CustomerManagedDatastoreS3Storage (Maybe Text) Source #

(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 (/).

customerManagedDatastoreS3Storage_bucket :: Lens' CustomerManagedDatastoreS3Storage Text Source #

The name of the Amazon S3 bucket where your data is stored.

customerManagedDatastoreS3Storage_roleArn :: Lens' CustomerManagedDatastoreS3Storage Text Source #

The ARN of the role that grants IoT Analytics permission to interact with your Amazon S3 resources.

CustomerManagedDatastoreS3StorageSummary

customerManagedDatastoreS3StorageSummary_keyPrefix :: Lens' CustomerManagedDatastoreS3StorageSummary (Maybe Text) Source #

(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 (/).

customerManagedDatastoreS3StorageSummary_roleArn :: Lens' CustomerManagedDatastoreS3StorageSummary (Maybe Text) Source #

The ARN of the role that grants IoT Analytics permission to interact with your Amazon S3 resources.

Dataset

dataset_creationTime :: Lens' Dataset (Maybe UTCTime) Source #

When the dataset was created.

dataset_status :: Lens' Dataset (Maybe DatasetStatus) Source #

The status of the dataset.

dataset_versioningConfiguration :: Lens' Dataset (Maybe VersioningConfiguration) Source #

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.

dataset_arn :: Lens' Dataset (Maybe Text) Source #

The ARN of the dataset.

dataset_actions :: Lens' Dataset (Maybe (NonEmpty DatasetAction)) Source #

The DatasetAction objects that automatically create the dataset contents.

dataset_triggers :: Lens' Dataset (Maybe [DatasetTrigger]) Source #

The DatasetTrigger objects that specify when the dataset is automatically updated.

dataset_retentionPeriod :: Lens' Dataset (Maybe RetentionPeriod) Source #

Optional. How long, in days, message data is kept for the dataset.

dataset_lateDataRules :: Lens' Dataset (Maybe (NonEmpty LateDataRule)) Source #

A list of data rules that send notifications to CloudWatch, when data arrives late. To specify lateDataRules, the dataset must use a DeltaTimer filter.

dataset_name :: Lens' Dataset (Maybe Text) Source #

The name of the dataset.

dataset_contentDeliveryRules :: Lens' Dataset (Maybe [DatasetContentDeliveryRule]) Source #

When dataset contents are created they are delivered to destinations specified here.

dataset_lastUpdateTime :: Lens' Dataset (Maybe UTCTime) Source #

The last time the dataset was updated.

DatasetAction

datasetAction_queryAction :: Lens' DatasetAction (Maybe SqlQueryDatasetAction) Source #

An SqlQueryDatasetAction object that uses an SQL query to automatically create dataset contents.

datasetAction_actionName :: Lens' DatasetAction (Maybe Text) Source #

The name of the dataset action by which dataset contents are automatically created.

datasetAction_containerAction :: Lens' DatasetAction (Maybe ContainerDatasetAction) Source #

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.

DatasetActionSummary

datasetActionSummary_actionName :: Lens' DatasetActionSummary (Maybe Text) Source #

The name of the action that automatically creates the dataset's contents.

datasetActionSummary_actionType :: Lens' DatasetActionSummary (Maybe DatasetActionType) Source #

The type of action by which the dataset's contents are automatically created.

DatasetContentDeliveryDestination

DatasetContentDeliveryRule

datasetContentDeliveryRule_entryName :: Lens' DatasetContentDeliveryRule (Maybe Text) Source #

The name of the dataset content delivery rules entry.

DatasetContentStatus

datasetContentStatus_state :: Lens' DatasetContentStatus (Maybe DatasetContentState) Source #

The state of the dataset contents. Can be one of READY, CREATING, SUCCEEDED, or FAILED.

datasetContentStatus_reason :: Lens' DatasetContentStatus (Maybe Text) Source #

The reason the dataset contents are in this state.

DatasetContentSummary

datasetContentSummary_creationTime :: Lens' DatasetContentSummary (Maybe UTCTime) Source #

The actual time the creation of the dataset contents was started.

datasetContentSummary_scheduleTime :: Lens' DatasetContentSummary (Maybe UTCTime) Source #

The time the creation of the dataset contents was scheduled to start.

datasetContentSummary_completionTime :: Lens' DatasetContentSummary (Maybe UTCTime) Source #

The time the dataset content status was updated to SUCCEEDED or FAILED.

DatasetContentVersionValue

datasetContentVersionValue_datasetName :: Lens' DatasetContentVersionValue Text Source #

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

DatasetEntry

datasetEntry_entryName :: Lens' DatasetEntry (Maybe Text) Source #

The name of the dataset item.

datasetEntry_dataURI :: Lens' DatasetEntry (Maybe Text) Source #

The presigned URI of the dataset item.

DatasetSummary

datasetSummary_creationTime :: Lens' DatasetSummary (Maybe UTCTime) Source #

The time the dataset was created.

datasetSummary_triggers :: Lens' DatasetSummary (Maybe [DatasetTrigger]) Source #

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

datasetSummary_lastUpdateTime :: Lens' DatasetSummary (Maybe UTCTime) Source #

The last time the dataset was updated.

DatasetTrigger

datasetTrigger_dataset :: Lens' DatasetTrigger (Maybe TriggeringDataset) Source #

The dataset whose content creation triggers the creation of this dataset's contents.

datasetTrigger_schedule :: Lens' DatasetTrigger (Maybe Schedule) Source #

The Schedule when the trigger is initiated.

Datastore

datastore_creationTime :: Lens' Datastore (Maybe UTCTime) Source #

When the data store was created.

datastore_status :: Lens' Datastore (Maybe DatastoreStatus) Source #

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.

datastore_lastMessageArrivalTime :: Lens' Datastore (Maybe UTCTime) Source #

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.

datastore_arn :: Lens' Datastore (Maybe Text) Source #

The ARN of the data store.

datastore_fileFormatConfiguration :: Lens' Datastore (Maybe FileFormatConfiguration) Source #

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.

datastore_datastorePartitions :: Lens' Datastore (Maybe DatastorePartitions) Source #

Contains information about the partition dimensions in a data store.

datastore_storage :: Lens' Datastore (Maybe DatastoreStorage) Source #

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.

datastore_retentionPeriod :: Lens' Datastore (Maybe RetentionPeriod) Source #

How long, in days, message data is kept for the data store. When customerManagedS3 storage is selected, this parameter is ignored.

datastore_name :: Lens' Datastore (Maybe Text) Source #

The name of the data store.

datastore_lastUpdateTime :: Lens' Datastore (Maybe UTCTime) Source #

The last time the data store was updated.

DatastoreActivity

datastoreActivity_name :: Lens' DatastoreActivity Text Source #

The name of the datastore activity.

datastoreActivity_datastoreName :: Lens' DatastoreActivity Text Source #

The name of the data store where processed messages are stored.

DatastoreIotSiteWiseMultiLayerStorage

DatastoreIotSiteWiseMultiLayerStorageSummary

DatastorePartition

datastorePartition_attributePartition :: Lens' DatastorePartition (Maybe Partition) Source #

A partition dimension defined by an attributeName.

datastorePartition_timestampPartition :: Lens' DatastorePartition (Maybe TimestampPartition) Source #

A partition dimension defined by a timestamp attribute.

DatastorePartitions

datastorePartitions_partitions :: Lens' DatastorePartitions (Maybe [DatastorePartition]) Source #

A list of partition dimensions in a data store.

DatastoreStatistics

DatastoreStorage

datastoreStorage_serviceManagedS3 :: Lens' DatastoreStorage (Maybe ServiceManagedDatastoreS3Storage) Source #

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.

datastoreStorage_customerManagedS3 :: Lens' DatastoreStorage (Maybe CustomerManagedDatastoreS3Storage) Source #

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.

datastoreStorage_iotSiteWiseMultiLayerStorage :: Lens' DatastoreStorage (Maybe DatastoreIotSiteWiseMultiLayerStorage) Source #

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.

DatastoreStorageSummary

DatastoreSummary

datastoreSummary_lastMessageArrivalTime :: Lens' DatastoreSummary (Maybe UTCTime) Source #

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.

datastoreSummary_datastorePartitions :: Lens' DatastoreSummary (Maybe DatastorePartitions) Source #

Contains information about the partition dimensions in a data store.

datastoreSummary_fileFormatType :: Lens' DatastoreSummary (Maybe FileFormatType) Source #

The file format of the data in the data store.

datastoreSummary_lastUpdateTime :: Lens' DatastoreSummary (Maybe UTCTime) Source #

The last time the data store was updated.

DeltaTime

deltaTime_offsetSeconds :: Lens' DeltaTime Int Source #

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.

deltaTime_timeExpression :: Lens' DeltaTime Text Source #

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.

DeltaTimeSessionWindowConfiguration

deltaTimeSessionWindowConfiguration_timeoutInMinutes :: Lens' DeltaTimeSessionWindowConfiguration Natural Source #

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.

DeviceRegistryEnrichActivity

deviceRegistryEnrichActivity_name :: Lens' DeviceRegistryEnrichActivity Text Source #

The name of the deviceRegistryEnrich activity.

deviceRegistryEnrichActivity_attribute :: Lens' DeviceRegistryEnrichActivity Text Source #

The name of the attribute that is added to the message.

deviceRegistryEnrichActivity_thingName :: Lens' DeviceRegistryEnrichActivity Text Source #

The name of the IoT device whose registry information is added to the message.

deviceRegistryEnrichActivity_roleArn :: Lens' DeviceRegistryEnrichActivity Text Source #

The ARN of the role that allows access to the device's registry information.

DeviceShadowEnrichActivity

deviceShadowEnrichActivity_name :: Lens' DeviceShadowEnrichActivity Text Source #

The name of the deviceShadowEnrich activity.

deviceShadowEnrichActivity_attribute :: Lens' DeviceShadowEnrichActivity Text Source #

The name of the attribute that is added to the message.

deviceShadowEnrichActivity_thingName :: Lens' DeviceShadowEnrichActivity Text Source #

The name of the IoT device whose shadow information is added to the message.

deviceShadowEnrichActivity_roleArn :: Lens' DeviceShadowEnrichActivity Text Source #

The ARN of the role that allows access to the device's shadow.

EstimatedResourceSize

estimatedResourceSize_estimatedOn :: Lens' EstimatedResourceSize (Maybe UTCTime) Source #

The time when the estimate of the size of the resource was made.

FileFormatConfiguration

fileFormatConfiguration_jsonConfiguration :: Lens' FileFormatConfiguration (Maybe JsonConfiguration) Source #

Contains the configuration information of the JSON format.

fileFormatConfiguration_parquetConfiguration :: Lens' FileFormatConfiguration (Maybe ParquetConfiguration) Source #

Contains the configuration information of the Parquet format.

FilterActivity

filterActivity_next :: Lens' FilterActivity (Maybe Text) Source #

The next activity in the pipeline.

filterActivity_name :: Lens' FilterActivity Text Source #

The name of the filter activity.

filterActivity_filter :: Lens' FilterActivity Text Source #

An expression that looks like a SQL WHERE clause that must return a Boolean value. Messages that satisfy the condition are passed to the next activity.

GlueConfiguration

glueConfiguration_tableName :: Lens' GlueConfiguration Text Source #

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.

glueConfiguration_databaseName :: Lens' GlueConfiguration Text Source #

The name of the database in your Glue Data Catalog in which the table is located. An Glue Data Catalog database contains metadata tables.

IotEventsDestinationConfiguration

iotEventsDestinationConfiguration_inputName :: Lens' IotEventsDestinationConfiguration Text Source #

The name of the IoT Events input to which dataset contents are delivered.

iotEventsDestinationConfiguration_roleArn :: Lens' IotEventsDestinationConfiguration Text Source #

The ARN of the role that grants IoT Analytics permission to deliver dataset contents to an IoT Events input.

IotSiteWiseCustomerManagedDatastoreS3Storage

iotSiteWiseCustomerManagedDatastoreS3Storage_keyPrefix :: Lens' IotSiteWiseCustomerManagedDatastoreS3Storage (Maybe Text) Source #

(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 (/).

IotSiteWiseCustomerManagedDatastoreS3StorageSummary

iotSiteWiseCustomerManagedDatastoreS3StorageSummary_keyPrefix :: Lens' IotSiteWiseCustomerManagedDatastoreS3StorageSummary (Maybe Text) Source #

(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 (/).

JsonConfiguration

LambdaActivity

lambdaActivity_next :: Lens' LambdaActivity (Maybe Text) Source #

The next activity in the pipeline.

lambdaActivity_name :: Lens' LambdaActivity Text Source #

The name of the lambda activity.

lambdaActivity_lambdaName :: Lens' LambdaActivity Text Source #

The name of the Lambda function that is run on the message.

lambdaActivity_batchSize :: Lens' LambdaActivity Natural Source #

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.

LateDataRule

lateDataRule_ruleName :: Lens' LateDataRule (Maybe Text) Source #

The name of the late data rule.

lateDataRule_ruleConfiguration :: Lens' LateDataRule LateDataRuleConfiguration Source #

The information needed to configure the late data rule.

LateDataRuleConfiguration

LoggingOptions

loggingOptions_roleArn :: Lens' LoggingOptions Text Source #

The ARN of the role that grants permission to IoT Analytics to perform logging.

loggingOptions_level :: Lens' LoggingOptions LoggingLevel Source #

The logging level. Currently, only ERROR is supported.

loggingOptions_enabled :: Lens' LoggingOptions Bool Source #

If true, logging is enabled for IoT Analytics.

MathActivity

mathActivity_next :: Lens' MathActivity (Maybe Text) Source #

The next activity in the pipeline.

mathActivity_name :: Lens' MathActivity Text Source #

The name of the math activity.

mathActivity_attribute :: Lens' MathActivity Text Source #

The name of the attribute that contains the result of the math operation.

mathActivity_math :: Lens' MathActivity Text Source #

An expression that uses one or more existing attributes and must return an integer value.

Message

message_messageId :: Lens' Message Text Source #

The ID you want to assign to the message. Each messageId must be unique within each batch sent.

message_payload :: Lens' Message ByteString Source #

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.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

OutputFileUriValue

outputFileUriValue_fileName :: Lens' OutputFileUriValue Text Source #

The URI of the location where dataset contents are stored, usually the URI of a file in an S3 bucket.

ParquetConfiguration

Partition

partition_attributeName :: Lens' Partition Text Source #

The name of the attribute that defines a partition dimension.

Pipeline

pipeline_creationTime :: Lens' Pipeline (Maybe UTCTime) Source #

When the pipeline was created.

pipeline_arn :: Lens' Pipeline (Maybe Text) Source #

The ARN of the pipeline.

pipeline_activities :: Lens' Pipeline (Maybe (NonEmpty PipelineActivity)) Source #

The activities that perform transformations on the messages.

pipeline_name :: Lens' Pipeline (Maybe Text) Source #

The name of the pipeline.

pipeline_reprocessingSummaries :: Lens' Pipeline (Maybe [ReprocessingSummary]) Source #

A summary of information about the pipeline reprocessing.

pipeline_lastUpdateTime :: Lens' Pipeline (Maybe UTCTime) Source #

The last time the pipeline was updated.

PipelineActivity

pipelineActivity_selectAttributes :: Lens' PipelineActivity (Maybe SelectAttributesActivity) Source #

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

pipelineActivity_channel :: Lens' PipelineActivity (Maybe ChannelActivity) Source #

Determines the source of the messages to be processed.

pipelineActivity_addAttributes :: Lens' PipelineActivity (Maybe AddAttributesActivity) Source #

Adds other attributes based on existing attributes in the message.

pipelineActivity_deviceRegistryEnrich :: Lens' PipelineActivity (Maybe DeviceRegistryEnrichActivity) Source #

Adds data from the IoT device registry to your message.

pipelineActivity_lambda :: Lens' PipelineActivity (Maybe LambdaActivity) Source #

Runs a Lambda function to modify the message.

pipelineActivity_datastore :: Lens' PipelineActivity (Maybe DatastoreActivity) Source #

Specifies where to store the processed message data.

pipelineActivity_deviceShadowEnrich :: Lens' PipelineActivity (Maybe DeviceShadowEnrichActivity) Source #

Adds information from the IoT Device Shadow service to a message.

pipelineActivity_filter :: Lens' PipelineActivity (Maybe FilterActivity) Source #

Filters a message based on its attributes.

pipelineActivity_math :: Lens' PipelineActivity (Maybe MathActivity) Source #

Computes an arithmetic expression using the message's attributes and adds it to the message.

PipelineSummary

pipelineSummary_reprocessingSummaries :: Lens' PipelineSummary (Maybe [ReprocessingSummary]) Source #

A summary of information about the pipeline reprocessing.

pipelineSummary_lastUpdateTime :: Lens' PipelineSummary (Maybe UTCTime) Source #

When the pipeline was last updated.

QueryFilter

queryFilter_deltaTime :: Lens' QueryFilter (Maybe DeltaTime) Source #

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

RemoveAttributesActivity

removeAttributesActivity_name :: Lens' RemoveAttributesActivity Text Source #

The name of the removeAttributes activity.

removeAttributesActivity_attributes :: Lens' RemoveAttributesActivity (NonEmpty Text) Source #

A list of 1-50 attributes to remove from the message.

ReprocessingSummary

reprocessingSummary_creationTime :: Lens' ReprocessingSummary (Maybe UTCTime) Source #

The time the pipeline reprocessing was created.

reprocessingSummary_id :: Lens' ReprocessingSummary (Maybe Text) Source #

The reprocessingId returned by StartPipelineReprocessing.

ResourceConfiguration

resourceConfiguration_computeType :: Lens' ResourceConfiguration ComputeType Source #

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).

resourceConfiguration_volumeSizeInGB :: Lens' ResourceConfiguration Natural Source #

The size, in GB, of the persistent storage available to the resource instance used to execute the containerAction (min: 1, max: 50).

RetentionPeriod

retentionPeriod_unlimited :: Lens' RetentionPeriod (Maybe Bool) Source #

If true, message data is kept indefinitely.

retentionPeriod_numberOfDays :: Lens' RetentionPeriod (Maybe Natural) Source #

The number of days that message data is kept. The unlimited parameter must be false.

S3DestinationConfiguration

s3DestinationConfiguration_glueConfiguration :: Lens' S3DestinationConfiguration (Maybe GlueConfiguration) Source #

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

s3DestinationConfiguration_bucket :: Lens' S3DestinationConfiguration Text Source #

The name of the S3 bucket to which dataset contents are delivered.

s3DestinationConfiguration_key :: Lens' S3DestinationConfiguration Text Source #

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.

s3DestinationConfiguration_roleArn :: Lens' S3DestinationConfiguration Text Source #

The ARN of the role that grants IoT Analytics permission to interact with your Amazon S3 and Glue resources.

Schedule

schedule_expression :: Lens' Schedule (Maybe Text) Source #

The expression that defines when to trigger an update. For more information, see Schedule Expressions for Rules in the Amazon CloudWatch Events User Guide.

SchemaDefinition

schemaDefinition_columns :: Lens' SchemaDefinition (Maybe [Column]) Source #

Specifies one or more columns that store your data.

Each schema can have up to 100 columns. Each column can have up to 100 nested types.

SelectAttributesActivity

selectAttributesActivity_name :: Lens' SelectAttributesActivity Text Source #

The name of the selectAttributes activity.

selectAttributesActivity_attributes :: Lens' SelectAttributesActivity (NonEmpty Text) Source #

A list of the attributes to select from the message.

ServiceManagedChannelS3Storage

ServiceManagedChannelS3StorageSummary

ServiceManagedDatastoreS3Storage

ServiceManagedDatastoreS3StorageSummary

SqlQueryDatasetAction

Tag

tag_key :: Lens' Tag Text Source #

The tag's key.

tag_value :: Lens' Tag Text Source #

The tag's value.

TimestampPartition

timestampPartition_timestampFormat :: Lens' TimestampPartition (Maybe Text) Source #

The timestamp format of a partition defined by a timestamp. The default format is seconds since epoch (January 1, 1970 at midnight UTC time).

timestampPartition_attributeName :: Lens' TimestampPartition Text Source #

The attribute name of the partition defined by a timestamp.

TriggeringDataset

triggeringDataset_name :: Lens' TriggeringDataset Text Source #

The name of the dataset whose content generation triggers the new dataset content generation.

Variable

variable_outputFileUriValue :: Lens' Variable (Maybe OutputFileUriValue) Source #

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

variable_doubleValue :: Lens' Variable (Maybe Double) Source #

The value of the variable as a double (numeric).

variable_stringValue :: Lens' Variable (Maybe Text) Source #

The value of the variable as a string.

variable_datasetContentVersionValue :: Lens' Variable (Maybe DatasetContentVersionValue) Source #

The value of the variable as a structure that specifies a dataset content version.

variable_name :: Lens' Variable Text Source #

The name of the variable.

VersioningConfiguration

versioningConfiguration_unlimited :: Lens' VersioningConfiguration (Maybe Bool) Source #

If true, unlimited versions of dataset contents are kept.

versioningConfiguration_maxVersions :: Lens' VersioningConfiguration (Maybe Natural) Source #

How many versions of dataset contents are kept. The unlimited parameter must be false.