Class: Aws::IoTAnalytics::Types::Dataset

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-iotanalytics/types.rb

Overview

Information about a dataset.

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#actions ⇒ Array<Types::DatasetAction>

The ‘DatasetAction` objects that automatically create the dataset contents.

Returns:



850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
 
# File 'lib/aws-sdk-iotanalytics/types.rb', line 850

class Dataset < Struct.new(
  :name,
  :arn,
  :actions,
  :triggers,
  :content_delivery_rules,
  :status,
  :creation_time,
  :last_update_time,
  :retention_period,
  :versioning_configuration,
  :late_data_rules)
  SENSITIVE = []
  include Aws::Structure
end

#arn ⇒ String

The ARN of the dataset.

Returns:

  • (String) 


850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
 
# File 'lib/aws-sdk-iotanalytics/types.rb', line 850

class Dataset < Struct.new(
  :name,
  :arn,
  :actions,
  :triggers,
  :content_delivery_rules,
  :status,
  :creation_time,
  :last_update_time,
  :retention_period,
  :versioning_configuration,
  :late_data_rules)
  SENSITIVE = []
  include Aws::Structure
end

#content_delivery_rules ⇒ Array<Types::DatasetContentDeliveryRule>

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

Returns:



850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
 
# File 'lib/aws-sdk-iotanalytics/types.rb', line 850

class Dataset < Struct.new(
  :name,
  :arn,
  :actions,
  :triggers,
  :content_delivery_rules,
  :status,
  :creation_time,
  :last_update_time,
  :retention_period,
  :versioning_configuration,
  :late_data_rules)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ Time

When the dataset was created.

Returns:

  • (Time) 


850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
 
# File 'lib/aws-sdk-iotanalytics/types.rb', line 850

class Dataset < Struct.new(
  :name,
  :arn,
  :actions,
  :triggers,
  :content_delivery_rules,
  :status,
  :creation_time,
  :last_update_time,
  :retention_period,
  :versioning_configuration,
  :late_data_rules)
  SENSITIVE = []
  include Aws::Structure
end

#last_update_time ⇒ Time

The last time the dataset was updated.

Returns:

  • (Time) 


850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
 
# File 'lib/aws-sdk-iotanalytics/types.rb', line 850

class Dataset < Struct.new(
  :name,
  :arn,
  :actions,
  :triggers,
  :content_delivery_rules,
  :status,
  :creation_time,
  :last_update_time,
  :retention_period,
  :versioning_configuration,
  :late_data_rules)
  SENSITIVE = []
  include Aws::Structure
end

#late_data_rules ⇒ Array<Types::LateDataRule>

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

[1]: docs.aws.amazon.com/iotanalytics/latest/APIReference/API_DeltaTime.html

Returns:



850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
 
# File 'lib/aws-sdk-iotanalytics/types.rb', line 850

class Dataset < Struct.new(
  :name,
  :arn,
  :actions,
  :triggers,
  :content_delivery_rules,
  :status,
  :creation_time,
  :last_update_time,
  :retention_period,
  :versioning_configuration,
  :late_data_rules)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the dataset.

Returns:

  • (String) 


850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
 
# File 'lib/aws-sdk-iotanalytics/types.rb', line 850

class Dataset < Struct.new(
  :name,
  :arn,
  :actions,
  :triggers,
  :content_delivery_rules,
  :status,
  :creation_time,
  :last_update_time,
  :retention_period,
  :versioning_configuration,
  :late_data_rules)
  SENSITIVE = []
  include Aws::Structure
end

#retention_period ⇒ Types::RetentionPeriod

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

Returns:



850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
 
# File 'lib/aws-sdk-iotanalytics/types.rb', line 850

class Dataset < Struct.new(
  :name,
  :arn,
  :actions,
  :triggers,
  :content_delivery_rules,
  :status,
  :creation_time,
  :last_update_time,
  :retention_period,
  :versioning_configuration,
  :late_data_rules)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the dataset.

Returns:

  • (String) 


850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
 
# File 'lib/aws-sdk-iotanalytics/types.rb', line 850

class Dataset < Struct.new(
  :name,
  :arn,
  :actions,
  :triggers,
  :content_delivery_rules,
  :status,
  :creation_time,
  :last_update_time,
  :retention_period,
  :versioning_configuration,
  :late_data_rules)
  SENSITIVE = []
  include Aws::Structure
end

#triggers ⇒ Array<Types::DatasetTrigger>

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

Returns:



850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
 
# File 'lib/aws-sdk-iotanalytics/types.rb', line 850

class Dataset < Struct.new(
  :name,
  :arn,
  :actions,
  :triggers,
  :content_delivery_rules,
  :status,
  :creation_time,
  :last_update_time,
  :retention_period,
  :versioning_configuration,
  :late_data_rules)
  SENSITIVE = []
  include Aws::Structure
end

#versioning_configuration ⇒ Types::VersioningConfiguration

Optional. How many versions of dataset contents are kept. If not specified or set to null, only the latest version plus the latest succeeded version (if they are different) are kept for the time period specified by the ‘retentionPeriod` parameter. For more information, see [ Keeping Multiple Versions of IoT Analytics datasets] in the *IoT Analytics User Guide*.

[1]: docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions

Returns:



850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
 
# File 'lib/aws-sdk-iotanalytics/types.rb', line 850

class Dataset < Struct.new(
  :name,
  :arn,
  :actions,
  :triggers,
  :content_delivery_rules,
  :status,
  :creation_time,
  :last_update_time,
  :retention_period,
  :versioning_configuration,
  :late_data_rules)
  SENSITIVE = []
  include Aws::Structure
end