You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::IoTAnalytics::Types::UpdateDatasetRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing UpdateDatasetRequest as input to an Aws::Client method, you can use a vanilla 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,
  },
  late_data_rules: [
    {
      rule_name: "LateDataRuleName",
      rule_configuration: { # required
        delta_time_session_window_configuration: {
          timeout_in_minutes: 1, # required
        },
      },
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#actions ⇒ Array<Types::DatasetAction>

A list of DatasetAction objects.

Returns:

#content_delivery_rules ⇒ Array<Types::DatasetContentDeliveryRule>

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

Returns:

#dataset_name ⇒ String

The name of the data set to update.

Returns:

  • (String) —

    The name of the data set to update.

#late_data_rules ⇒ Array<Types::LateDataRule>

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

Returns:

  • (Array<Types::LateDataRule>) —

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

#retention_period ⇒ Types::RetentionPeriod

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

Returns:

#triggers ⇒ Array<Types::DatasetTrigger>

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

Returns:

#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 AWS IoT Analytics Data Sets in the AWS IoT Analytics User Guide.

Returns: