Update Dataset Entries

rekognition_update_dataset_entries

R Documentation

This operation applies only to Amazon Rekognition Custom Labels

Description

This operation applies only to Amazon Rekognition Custom Labels.

Adds or updates one or more entries (images) in a dataset. An entry is a JSON Line which contains the information for a single image, including the image location, assigned labels, and object location bounding boxes. For more information, see Image-Level labels in manifest files and Object localization in manifest files in the Amazon Rekognition Custom Labels Developer Guide.

If the source-ref field in the JSON line references an existing image, the existing image in the dataset is updated. If source-ref field doesn't reference an existing image, the image is added as a new image to the dataset.

You specify the changes that you want to make in the Changes input parameter. There isn't a limit to the number JSON Lines that you can change, but the size of Changes must be less than 5MB.

update_dataset_entries returns immediatly, but the dataset update might take a while to complete. Use describe_dataset to check the current status. The dataset updated successfully if the value of Status is UPDATE_COMPLETE.

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

Dataset update fails if a terminal error occurs (Status = UPDATE_FAILED). Currently, you can't access the terminal error information from the Amazon Rekognition Custom Labels SDK.

This operation requires permissions to perform the rekognition:UpdateDatasetEntries action.

Usage

rekognition_update_dataset_entries(DatasetArn, Changes)

Arguments

DatasetArn

[required] The Amazon Resource Name (ARN) of the dataset that you want to update.

Changes

[required] The changes that you want to make to the dataset.

Value

An empty list.

Request syntax

svc$update_dataset_entries(
  DatasetArn = "string",
  Changes = list(
    GroundTruth = raw
  )
)

Examples

## Not run: 
# Adds dataset entries to an Amazon Rekognition Custom Labels dataset.
svc$update_dataset_entries(
  Changes = list(
    GroundTruth = "{\"source-ref\":\"s3://custom-labels-console-us-east-1-1111..."
  ),
  DatasetArn = "arn:aws:rekognition:us-east-1:111122223333:project/my-proj-..."
)

## End(Not run)