AWS::Forecast::DatasetGroup

Creates a dataset group, which holds a collection of related datasets. You can add datasets to the dataset group when you create the dataset group, or later by using the UpdateDatasetGroup operation.

After creating a dataset group and adding datasets, you use the dataset group when you create a predictor. For more information, see Dataset groups.

To get a list of all your datasets groups, use the ListDatasetGroups operation.

Note

The Status of a dataset group must be ACTIVE before you can use the dataset group to create a predictor. To get the status, use the DescribeDatasetGroup operation.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Forecast::DatasetGroup",
  "Properties" : {
      "DatasetArns" : [ String, ... ],
      "DatasetGroupName" : String,
      "Domain" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Forecast::DatasetGroup
Properties: 
  DatasetArns: 
    - String
  DatasetGroupName: String
  Domain: String
  Tags: 
    - Tag

Properties

DatasetArns

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

Required: No

Type: List of String

Update requires: No interruption

DatasetGroupName

The name of the dataset group.

Required: Yes

Type: String

Minimum: 1

Maximum: 63

Pattern: ^[a-zA-Z][a-zA-Z0-9_]*

Update requires: Replacement

Domain

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 Dataset groups.

Required: Yes

Type: String

Allowed values: CUSTOM | EC2_CAPACITY | INVENTORY_PLANNING | METRICS | RETAIL | WEB_TRAFFIC | WORK_FORCE

Update requires: No interruption

Tags

An array of key-value pairs to apply to this resource.

For more information, see Tag.

Required: No

Type: List of Tag

Update requires: No interruption

Return values

Fn::GetAtt

DatasetGroupArn

The Amazon Resource Name (ARN) of the dataset group.