Class: Aws::IoTAnalytics::Types::CreateDatasetRequest

Inherits:

Struct

• Object
• Struct
• Aws::IoTAnalytics::Types::CreateDatasetRequest

Includes:

Structure

Defined in:

lib/aws-sdk-iotanalytics/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #actions ⇒ Array<Types::DatasetAction>

  A list of actions that create the dataset contents.

• #content_delivery_rules ⇒ Array<Types::DatasetContentDeliveryRule>

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

• #dataset_name ⇒ String

  The name of the dataset.

• #late_data_rules ⇒ Array<Types::LateDataRule>

  A list of data rules that send notifications to CloudWatch, when data arrives late.

• #retention_period ⇒ Types::RetentionPeriod

  Optional.

• #tags ⇒ Array<Types::Tag>

  Metadata which can be used to manage the dataset.

• #triggers ⇒ Array<Types::DatasetTrigger>

  A list of triggers.

• #versioning_configuration ⇒ Types::VersioningConfiguration

  Optional.

Instance Attribute Details

#actions ⇒ Array<Types::DatasetAction>

A list of actions that create the dataset contents.

Returns:

• (Array<Types::DatasetAction>)

# File 'lib/aws-sdk-iotanalytics/types.rb', line 528

class CreateDatasetRequest < Struct.new(
  :dataset_name,
  :actions,
  :triggers,
  :content_delivery_rules,
  :retention_period,
  :versioning_configuration,
  :tags,
  :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:

• (Array<Types::DatasetContentDeliveryRule>)

# File 'lib/aws-sdk-iotanalytics/types.rb', line 528

class CreateDatasetRequest < Struct.new(
  :dataset_name,
  :actions,
  :triggers,
  :content_delivery_rules,
  :retention_period,
  :versioning_configuration,
  :tags,
  :late_data_rules)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_name ⇒ String

The name of the dataset.

Returns:

• (String)

# File 'lib/aws-sdk-iotanalytics/types.rb', line 528

class CreateDatasetRequest < Struct.new(
  :dataset_name,
  :actions,
  :triggers,
  :content_delivery_rules,
  :retention_period,
  :versioning_configuration,
  :tags,
  :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:

• (Array<Types::LateDataRule>)

# File 'lib/aws-sdk-iotanalytics/types.rb', line 528

class CreateDatasetRequest < Struct.new(
  :dataset_name,
  :actions,
  :triggers,
  :content_delivery_rules,
  :retention_period,
  :versioning_configuration,
  :tags,
  :late_data_rules)
  SENSITIVE = []
  include Aws::Structure
end

#retention_period ⇒ Types::RetentionPeriod

Optional. How long, in days, versions of dataset contents are kept for the dataset. If not specified or set to ‘null`, versions of dataset contents are retained for at most 90 days. The number of versions of dataset contents retained is determined by the `versioningConfiguration` parameter. For more information, see [ Keeping Multiple Versions of IoT Analytics datasets] in the *IoT Analytics User Guide*.

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

Returns:

• (Types::RetentionPeriod)

# File 'lib/aws-sdk-iotanalytics/types.rb', line 528

class CreateDatasetRequest < Struct.new(
  :dataset_name,
  :actions,
  :triggers,
  :content_delivery_rules,
  :retention_period,
  :versioning_configuration,
  :tags,
  :late_data_rules)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

Metadata which can be used to manage the dataset.

Returns:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-iotanalytics/types.rb', line 528

class CreateDatasetRequest < Struct.new(
  :dataset_name,
  :actions,
  :triggers,
  :content_delivery_rules,
  :retention_period,
  :versioning_configuration,
  :tags,
  :late_data_rules)
  SENSITIVE = []
  include Aws::Structure
end

#triggers ⇒ Array<Types::DatasetTrigger>

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.

Returns:

• (Array<Types::DatasetTrigger>)

# File 'lib/aws-sdk-iotanalytics/types.rb', line 528

class CreateDatasetRequest < Struct.new(
  :dataset_name,
  :actions,
  :triggers,
  :content_delivery_rules,
  :retention_period,
  :versioning_configuration,
  :tags,
  :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:

• (Types::VersioningConfiguration)

# File 'lib/aws-sdk-iotanalytics/types.rb', line 528

class CreateDatasetRequest < Struct.new(
  :dataset_name,
  :actions,
  :triggers,
  :content_delivery_rules,
  :retention_period,
  :versioning_configuration,
  :tags,
  :late_data_rules)
  SENSITIVE = []
  include Aws::Structure
end