aws-sdk-iotanalytics 1.11.0 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 93ffc0e3c4a474d9433ccf1084d59525569ed658
-  data.tar.gz: aa0fac8a27d6826c1b24f7120acabde703ddfa11
+  metadata.gz: 04f664e0d6b2fa5b6bf2d1e8892645dbb2f3a1ff
+  data.tar.gz: 72d7c5f4c33ca19e1637614b4a8923a34661874c
 SHA512:
-  metadata.gz: a05a63e3d17fb3b0c066b88f040834baf26609bb1bf8a1226b2e35677d5dd770240afadfc2a92705630a427bd80421f7e3a29b6ae80e93e7f22c4c96e862b480
-  data.tar.gz: c86a545fcecac719624b02b5d138e3ed1f09eefbcfbd42a23079b8494e77678a4e1237e0f23b0638523afb3b52394d67e2d61208f75ee167b986cddc8a6cc4cb
+  metadata.gz: cd1e4b40712ec35e11c26beb4e99f33bc3c54dc73c321aef8f79c7500bd35c8ac092d9364ece856a9841ac69972f6f17db65e15a788f760117d0259a5261aa95
+  data.tar.gz: 4570d2431c9194f85bf16a96e4abf5b0d761be54f9863d23bfde2f7b204f751d7159d2af08b4fd9ae3739fa6c2a74de48a35ee7c48a44be1ab60fec38540f457

data/lib/aws-sdk-iotanalytics.rb

@@ -42,6 +42,6 @@ require_relative 'aws-sdk-iotanalytics/customizations'
 # @service
 module Aws::IoTAnalytics
 
-  GEM_VERSION = '1.11.0'
+  GEM_VERSION = '1.12.0'
 
 end

data/lib/aws-sdk-iotanalytics/client.rb

@@ -214,6 +214,28 @@ module Aws::IoTAnalytics
     #   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.
+    #
     # @return [Types::BatchPutMessageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::BatchPutMessageResponse#batch_put_message_error_entries #batch_put_message_error_entries} => Array<Types::BatchPutMessageErrorEntry>
@@ -338,6 +360,8 @@ module Aws::IoTAnalytics
     #   **DataSetTrigger** objects.
     #
     # @option params [Array<Types::DatasetContentDeliveryRule>] :content_delivery_rules
+    #   When data set contents are created they are delivered to destinations
+    #   specified here.
     #
     # @option params [Types::RetentionPeriod] :retention_period
     #   \[Optional\] How long, in days, message data is kept for the data set.
@@ -442,7 +466,9 @@ module Aws::IoTAnalytics
       req.send_request(options)
     end
 
-    # Creates the content of a data set by applying a SQL action.
+    # Creates the content of a data set by applying a "queryAction" (a SQL
+    # query) or a "containerAction" (executing a containerized
+    # application).
     #
     # @option params [required, String] :dataset_name
     #   The name of the data set.
@@ -1051,6 +1077,16 @@ module Aws::IoTAnalytics
     # @option params [Integer] :max_results
     #   The maximum number of results to return in this request.
     #
+    # @option params [Time,DateTime,Date,Integer,String] :scheduled_on_or_after
+    #   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)
+    #
+    # @option params [Time,DateTime,Date,Integer,String] :scheduled_before
+    #   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)
+    #
     # @return [Types::ListDatasetContentsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::ListDatasetContentsResponse#dataset_content_summaries #dataset_content_summaries} => Array&lt;Types::DatasetContentSummary&gt;
@@ -1062,6 +1098,8 @@ module Aws::IoTAnalytics
     #     dataset_name: "DatasetName", # required
     #     next_token: "NextToken",
     #     max_results: 1,
+    #     scheduled_on_or_after: Time.now,
+    #     scheduled_before: Time.now,
     #   })
     #
     # @example Response structure
@@ -1438,7 +1476,7 @@ module Aws::IoTAnalytics
     # which can be used to manage a resource.
     #
     # @option params [required, String] :resource_arn
-    #   The ARN of the resource whose tags will be modified.
+    #   The ARN of the resource whose tags you want to modify.
     #
     # @option params [required, Array<Types::Tag>] :tags
     #   The new or modified tags for the resource.
@@ -1467,10 +1505,10 @@ module Aws::IoTAnalytics
     # Removes the given tags (metadata) from the resource.
     #
     # @option params [required, String] :resource_arn
-    #   The ARN of the resource whose tags will be removed.
+    #   The ARN of the resource whose tags you want to remove.
     #
     # @option params [required, Array<String>] :tag_keys
-    #   The keys of those tags which will be removed.
+    #   The keys of those tags which you want to remove.
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
@@ -1528,6 +1566,8 @@ module Aws::IoTAnalytics
     #   contain up to five **DataSetTrigger** objects.
     #
     # @option params [Array<Types::DatasetContentDeliveryRule>] :content_delivery_rules
+    #   When data set contents are created they are delivered to destinations
+    #   specified here.
     #
     # @option params [Types::RetentionPeriod] :retention_period
     #   How long, in days, message data is kept for the data set.
@@ -1739,7 +1779,7 @@ module Aws::IoTAnalytics
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-iotanalytics'
-      context[:gem_version] = '1.11.0'
+      context[:gem_version] = '1.12.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-iotanalytics/client_api.rb

@@ -514,6 +514,8 @@ module Aws::IoTAnalytics
     ListDatasetContentsRequest.add_member(:dataset_name, Shapes::ShapeRef.new(shape: DatasetName, required: true, location: "uri", location_name: "datasetName"))
     ListDatasetContentsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "nextToken"))
     ListDatasetContentsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location: "querystring", location_name: "maxResults"))
+    ListDatasetContentsRequest.add_member(:scheduled_on_or_after, Shapes::ShapeRef.new(shape: Timestamp, location: "querystring", location_name: "scheduledOnOrAfter"))
+    ListDatasetContentsRequest.add_member(:scheduled_before, Shapes::ShapeRef.new(shape: Timestamp, location: "querystring", location_name: "scheduledBefore"))
     ListDatasetContentsRequest.struct_class = Types::ListDatasetContentsRequest
 
     ListDatasetContentsResponse.add_member(:dataset_content_summaries, Shapes::ShapeRef.new(shape: DatasetContentSummaries, location_name: "datasetContentSummaries"))

data/lib/aws-sdk-iotanalytics/types.rb

@@ -89,6 +89,28 @@ module Aws::IoTAnalytics
     # @!attribute [rw] 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.
     #   @return [Array<Types::Message>]
     #
     class BatchPutMessageRequest < Struct.new(
@@ -470,6 +492,8 @@ module Aws::IoTAnalytics
     #   @return [Array<Types::DatasetTrigger>]
     #
     # @!attribute [rw] content_delivery_rules
+    #   When data set contents are created they are delivered to
+    #   destinations specified here.
     #   @return [Array<Types::DatasetContentDeliveryRule>]
     #
     # @!attribute [rw] retention_period
@@ -702,6 +726,8 @@ module Aws::IoTAnalytics
     #   @return [Array<Types::DatasetTrigger>]
     #
     # @!attribute [rw] content_delivery_rules
+    #   When data set contents are created they are delivered to
+    #   destinations specified here.
     #   @return [Array<Types::DatasetContentDeliveryRule>]
     #
     # @!attribute [rw] status
@@ -734,8 +760,8 @@ module Aws::IoTAnalytics
       include Aws::Structure
     end
 
-    # A "DatasetAction" object specifying the query that creates the data
-    # set content.
+    # A "DatasetAction" object that specifies how data set contents are
+    # automatically created.
     #
     # @note When making an API call, you may pass DatasetAction
     #   data as a hash:
@@ -782,8 +808,8 @@ module Aws::IoTAnalytics
     #   @return [String]
     #
     # @!attribute [rw] query_action
-    #   An "SqlQueryDatasetAction" object that contains the SQL query to
-    #   modify the message.
+    #   An "SqlQueryDatasetAction" object that uses an SQL query to
+    #   automatically create data set contents.
     #   @return [Types::SqlQueryDatasetAction]
     #
     # @!attribute [rw] container_action
@@ -816,6 +842,8 @@ module Aws::IoTAnalytics
       include Aws::Structure
     end
 
+    # The destination to which data set contents are delivered.
+    #
     # @note When making an API call, you may pass DatasetContentDeliveryDestination
     #   data as a hash:
     #
@@ -827,6 +855,8 @@ module Aws::IoTAnalytics
     #       }
     #
     # @!attribute [rw] iot_events_destination_configuration
+    #   Configuration information for delivery of data set contents to AWS
+    #   IoT Events.
     #   @return [Types::IotEventsDestinationConfiguration]
     #
     class DatasetContentDeliveryDestination < Struct.new(
@@ -834,6 +864,9 @@ module Aws::IoTAnalytics
       include Aws::Structure
     end
 
+    # When data set contents are created they are delivered to destination
+    # specified here.
+    #
     # @note When making an API call, you may pass DatasetContentDeliveryRule
     #   data as a hash:
     #
@@ -848,9 +881,11 @@ module Aws::IoTAnalytics
     #       }
     #
     # @!attribute [rw] entry_name
+    #   The name of the data set content delivery rules entry.
     #   @return [String]
     #
     # @!attribute [rw] destination
+    #   The destination to which data set contents are delivered.
     #   @return [Types::DatasetContentDeliveryDestination]
     #
     class DatasetContentDeliveryRule < Struct.new(
@@ -904,8 +939,8 @@ module Aws::IoTAnalytics
       include Aws::Structure
     end
 
-    # The data set whose latest contents will be used as input to the
-    # notebook or application.
+    # The data set whose latest contents are used as input to the notebook
+    # or application.
     #
     # @note When making an API call, you may pass DatasetContentVersionValue
     #   data as a hash:
@@ -915,8 +950,8 @@ module Aws::IoTAnalytics
     #       }
     #
     # @!attribute [rw] dataset_name
-    #   The name of the data set whose latest contents will be used as input
-    #   to the notebook or application.
+    #   The name of the data set whose latest contents are used as input to
+    #   the notebook or application.
     #   @return [String]
     #
     class DatasetContentVersionValue < Struct.new(
@@ -999,8 +1034,8 @@ module Aws::IoTAnalytics
     #   @return [Types::Schedule]
     #
     # @!attribute [rw] dataset
-    #   The data set whose content creation will trigger the creation of
-    #   this data set's contents.
+    #   The data set whose content creation triggers the creation of this
+    #   data set's contents.
     #   @return [Types::TriggeringDataset]
     #
     class DatasetTrigger < Struct.new(
@@ -1208,15 +1243,8 @@ module Aws::IoTAnalytics
       include Aws::Structure
     end
 
-    # 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 the 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.
+    # Used to limit data to that which has arrived since the last execution
+    # of the action.
     #
     # @note When making an API call, you may pass DeltaTime
     #   data as a hash:
@@ -1228,7 +1256,15 @@ module Aws::IoTAnalytics
     #
     # @!attribute [rw] offset_seconds
     #   The number of seconds of estimated "in flight" lag time of message
-    #   data.
+    #   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.
     #   @return [Integer]
     #
     # @!attribute [rw] time_expression
@@ -1563,6 +1599,9 @@ module Aws::IoTAnalytics
       include Aws::Structure
     end
 
+    # Configuration information for delivery of data set contents to AWS IoT
+    # Events.
+    #
     # @note When making an API call, you may pass IotEventsDestinationConfiguration
     #   data as a hash:
     #
@@ -1572,9 +1611,13 @@ module Aws::IoTAnalytics
     #       }
     #
     # @!attribute [rw] input_name
+    #   The name of the AWS IoT Events input to which data set contents are
+    #   delivered.
     #   @return [String]
     #
     # @!attribute [rw] role_arn
+    #   The ARN of the role which grants AWS IoT Analytics permission to
+    #   deliver data set contents to an AWS IoT Events input.
     #   @return [String]
     #
     class IotEventsDestinationConfiguration < Struct.new(
@@ -1669,6 +1712,8 @@ module Aws::IoTAnalytics
     #         dataset_name: "DatasetName", # required
     #         next_token: "NextToken",
     #         max_results: 1,
+    #         scheduled_on_or_after: Time.now,
+    #         scheduled_before: Time.now,
     #       }
     #
     # @!attribute [rw] dataset_name
@@ -1684,10 +1729,24 @@ module Aws::IoTAnalytics
     #   The maximum number of results to return in this request.
     #   @return [Integer]
     #
+    # @!attribute [rw] scheduled_on_or_after
+    #   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)
+    #   @return [Time]
+    #
+    # @!attribute [rw] scheduled_before
+    #   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)
+    #   @return [Time]
+    #
     class ListDatasetContentsRequest < Struct.new(
       :dataset_name,
       :next_token,
-      :max_results)
+      :max_results,
+      :scheduled_on_or_after,
+      :scheduled_before)
       include Aws::Structure
     end
 
@@ -1897,7 +1956,7 @@ module Aws::IoTAnalytics
     #   @return [String]
     #
     # @!attribute [rw] attribute
-    #   The name of the attribute that will contain the result of the math
+    #   The name of the attribute that contains the result of the math
     #   operation.
     #   @return [String]
     #
@@ -1945,8 +2004,8 @@ module Aws::IoTAnalytics
       include Aws::Structure
     end
 
-    # The URI of the location where data set contents are stored, usually
-    # the URI of a file in an S3 bucket.
+    # The value of the variable as a structure that specifies an output file
+    # URI.
     #
     # @note When making an API call, you may pass OutputFileUriValue
     #   data as a hash:
@@ -2184,15 +2243,7 @@ module Aws::IoTAnalytics
     #
     # @!attribute [rw] delta_time
     #   Used to limit data to that which has arrived since the last
-    #   execution of the action. 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 you 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.
+    #   execution of the action.
     #   @return [Types::DeltaTime]
     #
     class QueryFilter < Struct.new(
@@ -2613,7 +2664,7 @@ module Aws::IoTAnalytics
     #       }
     #
     # @!attribute [rw] resource_arn
-    #   The ARN of the resource whose tags will be modified.
+    #   The ARN of the resource whose tags you want to modify.
     #   @return [String]
     #
     # @!attribute [rw] tags
@@ -2628,8 +2679,8 @@ module Aws::IoTAnalytics
 
     class TagResourceResponse < Aws::EmptyStructure; end
 
-    # Information about the data set whose content generation will trigger
-    # the new data set content generation.
+    # Information about the data set whose content generation triggers the
+    # new data set content generation.
     #
     # @note When making an API call, you may pass TriggeringDataset
     #   data as a hash:
@@ -2639,8 +2690,8 @@ module Aws::IoTAnalytics
     #       }
     #
     # @!attribute [rw] name
-    #   The name of the data set whose content generation will trigger the
-    #   new data set content generation.
+    #   The name of the data set whose content generation triggers the new
+    #   data set content generation.
     #   @return [String]
     #
     class TriggeringDataset < Struct.new(
@@ -2657,11 +2708,11 @@ module Aws::IoTAnalytics
     #       }
     #
     # @!attribute [rw] resource_arn
-    #   The ARN of the resource whose tags will be removed.
+    #   The ARN of the resource whose tags you want to remove.
     #   @return [String]
     #
     # @!attribute [rw] tag_keys
-    #   The keys of those tags which will be removed.
+    #   The keys of those tags which you want to remove.
     #   @return [Array<String>]
     #
     class UntagResourceRequest < Struct.new(
@@ -2780,6 +2831,8 @@ module Aws::IoTAnalytics
     #   @return [Array<Types::DatasetTrigger>]
     #
     # @!attribute [rw] content_delivery_rules
+    #   When data set contents are created they are delivered to
+    #   destinations specified here.
     #   @return [Array<Types::DatasetContentDeliveryRule>]
     #
     # @!attribute [rw] retention_period

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-iotanalytics
 version: !ruby/object:Gem::Version
-  version: 1.11.0
+  version: 1.12.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-27 00:00:00.000000000 Z
+date: 2019-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core