Skip to content

Create Dataset

rekognition_create_dataset R Documentation

This operation applies only to Amazon Rekognition Custom Labels

Description

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 create_dataset is the Amazon Resource Name (ARN) for the dataset. Creating a dataset takes a while to complete. Use describe_dataset 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 list_dataset_entries 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.

Usage

rekognition_create_dataset(DatasetSource, DatasetType, ProjectArn, Tags)

Arguments

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 update_dataset_entries.

DatasetType

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

ProjectArn

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

Tags

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

Value

A list with the following syntax: 

list(
  DatasetArn = "string"
)

Request syntax

svc$create_dataset(
  DatasetSource = list(
    GroundTruthManifest = list(
      S3Object = list(
        Bucket = "string",
        Name = "string",
        Version = "string"
      )
    ),
    DatasetArn = "string"
  ),
  DatasetType = "TRAIN"|"TEST",
  ProjectArn = "string",
  Tags = list(
    "string"
  )
)

Examples

## Not run: 
# Creates an Amazon Rekognition Custom Labels dataset with a manifest file
# stored in an Amazon S3 bucket.
svc$create_dataset(
  DatasetSource = list(
    GroundTruthManifest = list(
      S3Object = list(
        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"
)

## End(Not run)