Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . personalize ]

create-dataset-group

Description

Creates an empty dataset group. A dataset group contains related datasets that supply data for training a model. A dataset group can contain at most three datasets, one for each type of dataset:

  • Interactions
  • Items
  • Users

To train a model (create a solution), a dataset group that contains an Interactions dataset is required. Call CreateDataset to add a dataset to the group.

A dataset group can be in one of the following states:

  • CREATE PENDING CREATE IN_PROGRESS ACTIVE -or- CREATE FAILED
  • DELETE PENDING

To get the status of the dataset group, call DescribeDatasetGroup . If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the creation failed.

Note

You must wait until the status of the dataset group is ACTIVE before adding a dataset to the group.

You can specify an AWS Key Management Service (KMS) key to encrypt the datasets in the group. If you specify a KMS key, you must also include an AWS Identity and Access Management (IAM) role that has permission to access the key.

APIs that require a dataset group ARN in the request
  • CreateDataset
  • CreateEventTracker
  • CreateSolution
Related APIs
  • ListDatasetGroups
  • DescribeDatasetGroup
  • DeleteDatasetGroup

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-dataset-group
--name <value>
[--role-arn <value>]
[--kms-key-arn <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--name (string)

The name for the new dataset group.

--role-arn (string)

The ARN of the IAM role that has permissions to access the KMS key. Supplying an IAM role is only valid when also specifying a KMS key.

--kms-key-arn (string)

The Amazon Resource Name (ARN) of a KMS key used to encrypt the datasets.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

datasetGroupArn -> (string)

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