Amazon Forecast
Developer Guide

This is prerelease documentation for a service in preview release. It is subject to change.

CreateDatasetGroup

Creates a dataset group. You can add datasets when you create a dataset group, or you can add them later with the UpdateDatasetGroup.

For more information about datasets and dataset groups, see Datasets and Dataset Groups.

Request Syntax

{ "DatasetGroupName": "string", "DatasetNames": [ "string" ], "KMSKeyArn": "string", "RoleArn": "string" }

Request Parameters

The request accepts the following data in JSON format.

DatasetGroupName

A name for the dataset group.

Type: String

Length Constraints: Maximum length of 256.

Pattern: ^[a-zA-Z0-9\_]+$

Required: Yes

DatasetNames

An array of names of the datasets that you want to include in the dataset group.

Type: Array of strings

Length Constraints: Maximum length of 256.

Pattern: ^[a-zA-Z0-9\_]+$

Required: No

KMSKeyArn

The Amazon Resource Name (ARN) of the AWS KMS key that you want Amazon Forecast to use to decrypt the object.

Type: String

Length Constraints: Maximum length of 256.

Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$

Required: No

RoleArn

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the S3 bucket.

Cross-account pass role is not allowed. If you pass a role that doesn't belong to your account, an InvalidInputException is thrown.

Type: String

Length Constraints: Maximum length of 256.

Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$

Required: Yes

Response Syntax

{ "DatasetGroupArn": "string", "DatasetGroupName": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

DatasetGroupArn

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

Type: String

Length Constraints: Maximum length of 256.

Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$

DatasetGroupName

The name of the dataset group.

Type: String

Length Constraints: Maximum length of 256.

Pattern: ^[a-zA-Z0-9\_]+$

Errors

InternalServiceException

Request processing has failed due to some unknown error, exception, or failure.

HTTP Status Code: 400

InvalidInputException

We can't process the request because it includes an invalid value or a value that exceeds the valid range.

HTTP Status Code: 400

ResourceAlreadyExistsException

There is already a resource with this name and characteristics. Try again with different settings.

HTTP Status Code: 400

ResourceNotFoundException

We can't find a resource with that name. Check the name and try again.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: