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

Class: Aws::ForecastService::Types::CreateDatasetRequest

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

Overview

Note:

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

{
  dataset_name: "Name", # required
  domain: "RETAIL", # required, accepts RETAIL, CUSTOM, INVENTORY_PLANNING, EC2_CAPACITY, WORK_FORCE, WEB_TRAFFIC, METRICS
  dataset_type: "TARGET_TIME_SERIES", # required, accepts TARGET_TIME_SERIES, RELATED_TIME_SERIES, ITEM_METADATA
  data_frequency: "Frequency",
  schema: { # required
    attributes: [
      {
        attribute_name: "Name",
        attribute_type: "string", # accepts string, integer, float, timestamp
      },
    ],
  },
  encryption_config: {
    role_arn: "Arn", # required
    kms_key_arn: "KMSKeyArn", # required
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#data_frequencyString

The frequency of data collection.

Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "D" indicates every day and "15min" indicates every 15 minutes.

Returns:

  • (String)


293
294
295
296
297
298
299
300
301
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 293

class CreateDatasetRequest < Struct.new(
  :dataset_name,
  :domain,
  :dataset_type,
  :data_frequency,
  :schema,
  :encryption_config)
  include Aws::Structure
end

#dataset_nameString

A name for the dataset.

Returns:

  • (String)


293
294
295
296
297
298
299
300
301
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 293

class CreateDatasetRequest < Struct.new(
  :dataset_name,
  :domain,
  :dataset_type,
  :data_frequency,
  :schema,
  :encryption_config)
  include Aws::Structure
end

#dataset_typeString

The dataset type. Valid values depend on the chosen Domain.

Returns:

  • (String)


293
294
295
296
297
298
299
300
301
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 293

class CreateDatasetRequest < Struct.new(
  :dataset_name,
  :domain,
  :dataset_type,
  :data_frequency,
  :schema,
  :encryption_config)
  include Aws::Structure
end

#domainString

The domain associated with the dataset. The Domain and DatasetType that you choose determine the fields that must be present in the training data that you import to the dataset. For example, if you choose the RETAIL domain and TARGET_TIME_SERIES as the DatasetType, Amazon Forecast requires item_id, timestamp, and demand fields to be present in your data. For more information, see howitworks-datasets-groups.

Returns:

  • (String)


293
294
295
296
297
298
299
300
301
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 293

class CreateDatasetRequest < Struct.new(
  :dataset_name,
  :domain,
  :dataset_type,
  :data_frequency,
  :schema,
  :encryption_config)
  include Aws::Structure
end

#encryption_configTypes::EncryptionConfig

An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.



293
294
295
296
297
298
299
300
301
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 293

class CreateDatasetRequest < Struct.new(
  :dataset_name,
  :domain,
  :dataset_type,
  :data_frequency,
  :schema,
  :encryption_config)
  include Aws::Structure
end

#schemaTypes::Schema

The schema for the dataset. The schema attributes and their order must match the fields in your data. The dataset Domain and DatasetType that you choose determine the minimum required fields in your training data. For information about the required fields for a specific dataset domain and type, see howitworks-domains-ds-types.

Returns:



293
294
295
296
297
298
299
300
301
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 293

class CreateDatasetRequest < Struct.new(
  :dataset_name,
  :domain,
  :dataset_type,
  :data_frequency,
  :schema,
  :encryption_config)
  include Aws::Structure
end