This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::Forecast::Dataset
<a name="aws-resource-forecast-dataset"></a>

Creates an Amazon Forecast dataset. 

**Important**  
Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/)

The information about the dataset that you provide helps Forecast understand how to consume the data for model training. This includes the following:
+ * `DataFrequency` * - How frequently your historical time-series data is collected.
+ * `Domain` * and * `DatasetType` * - Each dataset has an associated dataset domain and a type within the domain. Amazon Forecast provides a list of predefined domains and types within each domain. For each unique dataset domain and type within the domain, Amazon Forecast requires your data to include a minimum set of predefined fields.
+ * `Schema` * - A schema specifies the fields in the dataset, including the field name and data type.

After creating a dataset, you import your training data into it and add the dataset to a dataset group. You use the dataset group to create a predictor. For more information, see [Importing datasets](https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html).

To get a list of all your datasets, use the [ListDatasets](https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasets.html) operation.

For example Forecast datasets, see the [Amazon Forecast Sample GitHub repository](https://github.com/aws-samples/amazon-forecast-samples).

**Note**  
The `Status` of a dataset must be `ACTIVE` before you can import training data. Use the [DescribeDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html) operation to get the status.

## Syntax
<a name="aws-resource-forecast-dataset-syntax"></a>

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

### JSON
<a name="aws-resource-forecast-dataset-syntax.json"></a>

```
{
  "Type" : "AWS::Forecast::Dataset",
  "Properties" : {
      "[DataFrequency](#cfn-forecast-dataset-datafrequency)" : String,
      "[DatasetName](#cfn-forecast-dataset-datasetname)" : String,
      "[DatasetType](#cfn-forecast-dataset-datasettype)" : String,
      "[Domain](#cfn-forecast-dataset-domain)" : String,
      "[EncryptionConfig](#cfn-forecast-dataset-encryptionconfig)" : EncryptionConfig,
      "[Schema](#cfn-forecast-dataset-schema)" : Schema,
      "[Tags](#cfn-forecast-dataset-tags)" : [ TagsItems, ... ]
    }
}
```

### YAML
<a name="aws-resource-forecast-dataset-syntax.yaml"></a>

```
Type: AWS::Forecast::Dataset
Properties:
  [DataFrequency](#cfn-forecast-dataset-datafrequency): String
  [DatasetName](#cfn-forecast-dataset-datasetname): String
  [DatasetType](#cfn-forecast-dataset-datasettype): String
  [Domain](#cfn-forecast-dataset-domain): String
  [EncryptionConfig](#cfn-forecast-dataset-encryptionconfig): 
    EncryptionConfig
  [Schema](#cfn-forecast-dataset-schema): 
    Schema
  [Tags](#cfn-forecast-dataset-tags): 
    - TagsItems
```

## Properties
<a name="aws-resource-forecast-dataset-properties"></a>

`DataFrequency`  <a name="cfn-forecast-dataset-datafrequency"></a>
The frequency of data collection. This parameter is required for RELATED\$1TIME\$1SERIES datasets.  
Valid intervals are an integer followed by Y (Year), M (Month), W (Week), D (Day), H (Hour), and min (Minute). For example, "1D" indicates every day and "15min" indicates every 15 minutes. You cannot specify a value that would overlap with the next larger frequency. That means, for example, you cannot specify a frequency of 60 minutes, because that is equivalent to 1 hour. The valid values for each frequency are the following:  
+ Minute - 1-59
+ Hour - 1-23
+ Day - 1-6
+ Week - 1-4
+ Month - 1-11
+ Year - 1
Thus, if you want every other week forecasts, specify "2W". Or, if you want quarterly forecasts, you specify "3M".  
*Required*: No  
*Type*: String  
*Pattern*: `^Y|M|W|D|H|30min|15min|10min|5min|1min$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DatasetName`  <a name="cfn-forecast-dataset-datasetname"></a>
The name of the dataset.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z][a-zA-Z0-9_]*`  
*Minimum*: `1`  
*Maximum*: `63`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`DatasetType`  <a name="cfn-forecast-dataset-datasettype"></a>
The dataset type.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `TARGET_TIME_SERIES | RELATED_TIME_SERIES | ITEM_METADATA`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Domain`  <a name="cfn-forecast-dataset-domain"></a>
The domain associated with the dataset.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `RETAIL | CUSTOM | INVENTORY_PLANNING | EC2_CAPACITY | WORK_FORCE | WEB_TRAFFIC | METRICS`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EncryptionConfig`  <a name="cfn-forecast-dataset-encryptionconfig"></a>
A Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.  
*Required*: No  
*Type*: [EncryptionConfig](aws-properties-forecast-dataset-encryptionconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Schema`  <a name="cfn-forecast-dataset-schema"></a>
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 [Dataset Domains and Dataset Types](https://docs.aws.amazon.com/forecast/latest/dg/howitworks-domains-ds-types.html).  
*Required*: Yes  
*Type*: [Schema](aws-properties-forecast-dataset-schema.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-forecast-dataset-tags"></a>
An array of key-value pairs to apply to this resource.  
For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).  
*Required*: No  
*Type*: Array of [TagsItems](aws-properties-forecast-dataset-tagsitems.md)  
*Minimum*: `0`  
*Maximum*: `200`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-forecast-dataset-return-values"></a>

### Ref
<a name="aws-resource-forecast-dataset-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name.

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-forecast-dataset-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-forecast-dataset-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the dataset.

# AWS::Forecast::Dataset AttributesItems
<a name="aws-properties-forecast-dataset-attributesitems"></a>

<a name="aws-properties-forecast-dataset-attributesitems-description"></a>The `AttributesItems` property type specifies Property description not available. for an [AWS::Forecast::Dataset](aws-resource-forecast-dataset.md).

## Syntax
<a name="aws-properties-forecast-dataset-attributesitems-syntax"></a>

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

### JSON
<a name="aws-properties-forecast-dataset-attributesitems-syntax.json"></a>

```
{
  "[AttributeName](#cfn-forecast-dataset-attributesitems-attributename)" : String,
  "[AttributeType](#cfn-forecast-dataset-attributesitems-attributetype)" : String
}
```

### YAML
<a name="aws-properties-forecast-dataset-attributesitems-syntax.yaml"></a>

```
  [AttributeName](#cfn-forecast-dataset-attributesitems-attributename): String
  [AttributeType](#cfn-forecast-dataset-attributesitems-attributetype): String
```

## Properties
<a name="aws-properties-forecast-dataset-attributesitems-properties"></a>

`AttributeName`  <a name="cfn-forecast-dataset-attributesitems-attributename"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Pattern*: `^[a-zA-Z][a-zA-Z0-9_]*`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`AttributeType`  <a name="cfn-forecast-dataset-attributesitems-attributetype"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Allowed values*: `string | integer | float | timestamp | geolocation`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Forecast::Dataset EncryptionConfig
<a name="aws-properties-forecast-dataset-encryptionconfig"></a>

An AWS Key Management Service (KMS) key and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key. You can specify this optional object in the [CreateDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html) and [CreatePredictor](https://docs.aws.amazon.com/forecast/latest/dg/API_CreatePredictor.html) requests.

## Syntax
<a name="aws-properties-forecast-dataset-encryptionconfig-syntax"></a>

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

### JSON
<a name="aws-properties-forecast-dataset-encryptionconfig-syntax.json"></a>

```
{
  "[KmsKeyArn](#cfn-forecast-dataset-encryptionconfig-kmskeyarn)" : String,
  "[RoleArn](#cfn-forecast-dataset-encryptionconfig-rolearn)" : String
}
```

### YAML
<a name="aws-properties-forecast-dataset-encryptionconfig-syntax.yaml"></a>

```
  [KmsKeyArn](#cfn-forecast-dataset-encryptionconfig-kmskeyarn): String
  [RoleArn](#cfn-forecast-dataset-encryptionconfig-rolearn): String
```

## Properties
<a name="aws-properties-forecast-dataset-encryptionconfig-properties"></a>

`KmsKeyArn`  <a name="cfn-forecast-dataset-encryptionconfig-kmskeyarn"></a>
The Amazon Resource Name (ARN) of the KMS key.  
*Required*: No  
*Type*: String  
*Pattern*: `arn:aws[-a-z]*:kms:.*:key/.*`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RoleArn`  <a name="cfn-forecast-dataset-encryptionconfig-rolearn"></a>
The ARN of the IAM role that Amazon Forecast can assume to access the AWS KMS key.  
Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an `InvalidInputException` error.  
*Required*: No  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9\-\_\.\/\:]+$`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Forecast::Dataset Schema
<a name="aws-properties-forecast-dataset-schema"></a>

Defines the fields of a dataset.

## Syntax
<a name="aws-properties-forecast-dataset-schema-syntax"></a>

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

### JSON
<a name="aws-properties-forecast-dataset-schema-syntax.json"></a>

```
{
  "[Attributes](#cfn-forecast-dataset-schema-attributes)" : [ AttributesItems, ... ]
}
```

### YAML
<a name="aws-properties-forecast-dataset-schema-syntax.yaml"></a>

```
  [Attributes](#cfn-forecast-dataset-schema-attributes): 
    - AttributesItems
```

## Properties
<a name="aws-properties-forecast-dataset-schema-properties"></a>

`Attributes`  <a name="cfn-forecast-dataset-schema-attributes"></a>
An array of attributes specifying the name and type of each field in a dataset.  
*Required*: No  
*Type*: Array of [AttributesItems](aws-properties-forecast-dataset-attributesitems.md)  
*Minimum*: `1`  
*Maximum*: `100`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Forecast::Dataset TagsItems
<a name="aws-properties-forecast-dataset-tagsitems"></a>

<a name="aws-properties-forecast-dataset-tagsitems-description"></a>The `TagsItems` property type specifies Property description not available. for an [AWS::Forecast::Dataset](aws-resource-forecast-dataset.md).

## Syntax
<a name="aws-properties-forecast-dataset-tagsitems-syntax"></a>

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

### JSON
<a name="aws-properties-forecast-dataset-tagsitems-syntax.json"></a>

```
{
  "[Key](#cfn-forecast-dataset-tagsitems-key)" : String,
  "[Value](#cfn-forecast-dataset-tagsitems-value)" : String
}
```

### YAML
<a name="aws-properties-forecast-dataset-tagsitems-syntax.yaml"></a>

```
  [Key](#cfn-forecast-dataset-tagsitems-key): String
  [Value](#cfn-forecast-dataset-tagsitems-value): String
```

## Properties
<a name="aws-properties-forecast-dataset-tagsitems-properties"></a>

`Key`  <a name="cfn-forecast-dataset-tagsitems-key"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-forecast-dataset-tagsitems-value"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)