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

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

Overview

Note:

When making an API call, you may pass CreateDatasetRequest data as a hash:

{
  dataset_name: "DatasetName", # required
  actions: [ # required
    {
      action_name: "DatasetActionName",
      query_action: {
        sql_query: "SqlQuery", # required
        filters: [
          {
            delta_time: {
              offset_seconds: 1, # required
              time_expression: "TimeExpression", # required
            },
          },
        ],
      },
      container_action: {
        image: "Image", # required
        execution_role_arn: "RoleArn", # required
        resource_configuration: { # required
          compute_type: "ACU_1", # required, accepts ACU_1, ACU_2
          volume_size_in_gb: 1, # required
        },
        variables: [
          {
            name: "VariableName", # required
            string_value: "StringValue",
            double_value: 1.0,
            dataset_content_version_value: {
              dataset_name: "DatasetName", # required
            },
            output_file_uri_value: {
              file_name: "OutputFileName", # required
            },
          },
        ],
      },
    },
  ],
  triggers: [
    {
      schedule: {
        expression: "ScheduleExpression",
      },
      dataset: {
        name: "DatasetName", # required
      },
    },
  ],
  content_delivery_rules: [
    {
      entry_name: "EntryName",
      destination: { # required
        iot_events_destination_configuration: {
          input_name: "IotEventsInputName", # required
          role_arn: "RoleArn", # required
        },
        s3_destination_configuration: {
          bucket: "BucketName", # required
          key: "BucketKeyExpression", # required
          glue_configuration: {
            table_name: "GlueTableName", # required
            database_name: "GlueDatabaseName", # required
          },
          role_arn: "RoleArn", # required
        },
      },
    },
  ],
  retention_period: {
    unlimited: false,
    number_of_days: 1,
  },
  versioning_configuration: {
    unlimited: false,
    max_versions: 1,
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  late_data_rules: [
    {
      rule_name: "LateDataRuleName",
      rule_configuration: { # required
        delta_time_session_window_configuration: {
          timeout_in_minutes: 1, # required
        },
      },
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#actionsArray<Types::DatasetAction>

A list of actions that create the dataset contents.

Returns:



754
755
756
757
758
759
760
761
762
763
764
765
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/types.rb', line 754

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_rulesArray<Types::DatasetContentDeliveryRule>

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



754
755
756
757
758
759
760
761
762
763
764
765
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/types.rb', line 754

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_nameString

The name of the dataset.

Returns:

  • (String)


754
755
756
757
758
759
760
761
762
763
764
765
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/types.rb', line 754

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

Returns:



754
755
756
757
758
759
760
761
762
763
764
765
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/types.rb', line 754

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_periodTypes::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.



754
755
756
757
758
759
760
761
762
763
764
765
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/types.rb', line 754

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

#tagsArray<Types::Tag>

Metadata which can be used to manage the dataset.

Returns:



754
755
756
757
758
759
760
761
762
763
764
765
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/types.rb', line 754

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

#triggersArray<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:



754
755
756
757
758
759
760
761
762
763
764
765
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/types.rb', line 754

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_configurationTypes::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.



754
755
756
757
758
759
760
761
762
763
764
765
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/types.rb', line 754

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