You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::ForecastService::Types::CreateDatasetRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::ForecastService::Types::CreateDatasetRequest
- Defined in:
- (unknown)
Overview
When passing CreateDatasetRequest as input to an Aws::Client method, you can use a vanilla 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
},
tags: [
{
key: "TagKey", # required
value: "TagValue", # required
},
],
}
Instance Attribute Summary collapse
-
#data_frequency ⇒ String
The frequency of data collection.
-
#dataset_name ⇒ String
A name for the dataset.
-
#dataset_type ⇒ String
The dataset type.
-
#domain ⇒ String
The domain associated with the dataset.
-
#encryption_config ⇒ Types::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.
-
#schema ⇒ Types::Schema
The schema for the dataset.
-
#tags ⇒ Array<Types::Tag>
The optional metadata that you apply to the dataset to help you categorize and organize them.
Instance Attribute Details
#data_frequency ⇒ String
The frequency of data collection. This parameter is required for RELATED_TIME_SERIES datasets.
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.
#dataset_name ⇒ String
A name for the dataset.
#dataset_type ⇒ String
The dataset type. Valid values depend on the chosen Domain
.
Possible values:
- TARGET_TIME_SERIES
- RELATED_TIME_SERIES
- ITEM_METADATA
#domain ⇒ String
The domain associated with the dataset. When you add a dataset to a
dataset group, this value and the value specified for the Domain
parameter of the CreateDatasetGroup operation must match.
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.
Possible values:
- RETAIL
- CUSTOM
- INVENTORY_PLANNING
- EC2_CAPACITY
- WORK_FORCE
- WEB_TRAFFIC
- METRICS
#encryption_config ⇒ Types::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.
#schema ⇒ Types::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.
#tags ⇒ Array<Types::Tag>
The optional metadata that you apply to the dataset to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50.
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8.
Maximum value length - 256 Unicode characters in UTF-8.
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case sensitive.
Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value hasaws
as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix ofaws
do not count against your tags per resource limit.