View a markdown version of this page

AWS::Rekognition::Dataset - AWS CloudFormation

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.

AWS::Rekognition::Dataset

Note

This operation applies only to Amazon Rekognition Custom Labels.

Creates a new Amazon Rekognition Custom Labels dataset. You can create a dataset by using an Amazon Sagemaker format manifest file or by copying an existing Amazon Rekognition Custom Labels dataset.

To create a training dataset for a project, specify TRAIN for the value of DatasetType. To create the test dataset for a project, specify TEST for the value of DatasetType.

The response from CreateDataset is the Amazon Resource Name (ARN) for the dataset. Creating a dataset takes a while to complete. Use DescribeDataset to check the current status. The dataset created successfully if the value of Status is CREATE_COMPLETE.

To check if any non-terminal errors occurred, call ListDatasetEntries and check for the presence of errors lists in the JSON Lines.

Dataset creation fails if a terminal error occurs (Status = CREATE_FAILED). Currently, you can't access the terminal error information.

For more information, see Creating datasets.

This operation requires permissions to perform the rekognition:CreateDataset action. If you want to copy an existing dataset, you also require permission to perform the rekognition:ListDatasetEntries action.

Syntax

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

JSON

{ "Type" : "AWS::Rekognition::Dataset", "Properties" : { "DatasetType" : String, "ProjectArn" : String, "Tags" : [ Tag, ... ] } }

YAML

Type: AWS::Rekognition::Dataset Properties: DatasetType: String ProjectArn: String Tags: - Tag

Properties

DatasetType

The type of the dataset.

Required: Yes

Type: String

Allowed values: TRAIN | TEST

Update requires: Replacement

ProjectArn

Property description not available.

Required: No

Type: String

Pattern: ^(^arn:[a-z\d-]+:rekognition:[a-z\d-]+:\d{12}:project\/[a-zA-Z0-9_.\-]{1,255}\/[0-9]+$)$

Minimum: 20

Maximum: 2048

Update requires: Replacement

Tags

Property description not available.

Required: No

Type: Array of Tag

Maximum: 200

Update requires: No interruption

Return values

Ref

Fn::GetAtt

DatasetArn

The Amazon Resource Name (ARN) for the dataset.