AWS::Personalize::Dataset
Creates an empty dataset and adds it to the specified dataset group. Use CreateDatasetImportJob to import your training data to a dataset.
There are three types of datasets:
-
Interactions
-
Items
-
Users
Each dataset type has an associated schema with required field types.
Only the Interactions
dataset is required in order to train a
model (also referred to as creating a solution).
A dataset can be in one of the following states:
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
-
DELETE PENDING > DELETE IN_PROGRESS
To get the status of the dataset, call DescribeDataset.
Related APIs
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::Personalize::Dataset", "Properties" : { "DatasetGroupArn" :
String
, "DatasetImportJob" :DatasetImportJob
, "DatasetType" :String
, "Name" :String
, "SchemaArn" :String
} }
YAML
Type: AWS::Personalize::Dataset Properties: DatasetGroupArn:
String
DatasetImportJob:DatasetImportJob
DatasetType:String
Name:String
SchemaArn:String
Properties
DatasetGroupArn
-
The Amazon Resource Name (ARN) of the dataset group.
Required: Yes
Type: String
Maximum:
256
Pattern:
arn:([a-z\d-]+):personalize:.*:.*:.+
Update requires: Replacement
DatasetImportJob
-
Describes a job that imports training data from a data source (Amazon S3 bucket) to an Amazon Personalize dataset.
Required: No
Type: DatasetImportJob
Update requires: No interruption
DatasetType
-
One of the following values:
-
Interactions
-
Items
-
Users
Required: Yes
Type: String
Maximum:
256
Update requires: Replacement
-
Name
-
The name of the dataset.
Required: Yes
Type: String
Minimum:
1
Maximum:
63
Pattern:
^[a-zA-Z0-9][a-zA-Z0-9\-_]*
Update requires: Replacement
SchemaArn
-
The ARN of the associated schema.
Required: Yes
Type: String
Maximum:
256
Pattern:
arn:([a-z\d-]+):personalize:.*:.*:.+
Update requires: Replacement
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref
returns the name of the resource.
For more information about using the Ref
function, see Ref.
Fn::GetAtt
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 Fn::GetAtt.