Class: Aws::ForecastService::Types::CreateDatasetGroupRequest

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 CreateDatasetGroupRequest data as a hash:

{
  dataset_group_name: "Name", # required
  domain: "RETAIL", # required, accepts RETAIL, CUSTOM, INVENTORY_PLANNING, EC2_CAPACITY, WORK_FORCE, WEB_TRAFFIC, METRICS
  dataset_arns: ["Arn"],
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#dataset_arnsArray<String>

An array of Amazon Resource Names (ARNs) of the datasets that you want to include in the dataset group.

Returns:

  • (Array<String>)


187
188
189
190
191
192
193
194
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 187

class CreateDatasetGroupRequest < Struct.new(
  :dataset_group_name,
  :domain,
  :dataset_arns,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_group_nameString

A name for the dataset group.

Returns:

  • (String)


187
188
189
190
191
192
193
194
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 187

class CreateDatasetGroupRequest < Struct.new(
  :dataset_group_name,
  :domain,
  :dataset_arns,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#domainString

The domain associated with the dataset group. When you add a dataset to a dataset group, this value and the value specified for the Domain parameter of the CreateDataset operation must match.

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

Returns:

  • (String)


187
188
189
190
191
192
193
194
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 187

class CreateDatasetGroupRequest < Struct.new(
  :dataset_group_name,
  :domain,
  :dataset_arns,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

The optional metadata that you apply to the dataset group 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 has aws 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 of aws do not count against your tags per resource limit.

Returns:



187
188
189
190
191
192
193
194
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 187

class CreateDatasetGroupRequest < Struct.new(
  :dataset_group_name,
  :domain,
  :dataset_arns,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end