AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the CreateDataset operation.

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 dataset in the Amazon Rekognition Custom Labels Developer Guide.

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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Rekognition.AmazonRekognitionRequest
      Amazon.Rekognition.Model.CreateDatasetRequest

Namespace: Amazon.Rekognition.Model
Assembly: AWSSDK.Rekognition.dll
Version: 3.x.y.z

Syntax

C#
public class CreateDatasetRequest : AmazonRekognitionRequest
         IAmazonWebServiceRequest

The CreateDatasetRequest type exposes the following members

Constructors

NameDescription
Public Method CreateDatasetRequest()

Properties

NameTypeDescription
Public Property DatasetSource Amazon.Rekognition.Model.DatasetSource

Gets and sets the property DatasetSource.

The source files for the dataset. You can specify the ARN of an existing dataset or specify the Amazon S3 bucket location of an Amazon Sagemaker format manifest file. If you don't specify datasetSource, an empty dataset is created. To add labeled images to the dataset, You can use the console or call UpdateDatasetEntries.

Public Property DatasetType Amazon.Rekognition.DatasetType

Gets and sets the property DatasetType.

The type of the dataset. Specify TRAIN to create a training dataset. Specify TEST to create a test dataset.

Public Property ProjectArn System.String

Gets and sets the property ProjectArn.

The ARN of the Amazon Rekognition Custom Labels project to which you want to asssign the dataset.

Public Property Tags System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property Tags.

A set of tags (key-value pairs) that you want to attach to the dataset.

Examples

Creates an Amazon Rekognition Custom Labels dataset with a manifest file stored in an Amazon S3 bucket.

To create an Amazon Rekognition Custom Labels dataset


var client = new AmazonRekognitionClient();
var response = client.CreateDataset(new CreateDatasetRequest 
{
    DatasetSource = new DatasetSource { GroundTruthManifest = new GroundTruthManifest { S3Object = new S3Object {
        Bucket = "my-bucket",
        Name = "datasets/flowers_training/manifests/output/output.manifest"
    } } },
    DatasetType = "TRAIN",
    ProjectArn = "arn:aws:rekognition:us-east-1:111122223333:project/my-project/1690474772815"
});

string datasetArn = response.DatasetArn;

            

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5