Skip to content

List Dataset Entries

rekognition_list_dataset_entries R Documentation

This operation applies only to Amazon Rekognition Custom Labels

Description

This operation applies only to Amazon Rekognition Custom Labels.

Lists the entries (images) within a dataset. An entry is a JSON Line that contains the information for a single image, including the image location, assigned labels, and object location bounding boxes. For more information, see Creating a manifest file.

JSON Lines in the response include information about non-terminal errors found in the dataset. Non terminal errors are reported in errors lists within each JSON Line. The same information is reported in the training and testing validation result manifests that Amazon Rekognition Custom Labels creates during model training.

You can filter the response in variety of ways, such as choosing which labels to return and returning JSON Lines created after a specific date.

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

Usage

rekognition_list_dataset_entries(DatasetArn, ContainsLabels, Labeled,
  SourceRefContains, HasErrors, NextToken, MaxResults)

Arguments

DatasetArn

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

ContainsLabels

Specifies a label filter for the response. The response includes an entry only if one or more of the labels in ContainsLabels exist in the entry.

Labeled

Specify true to get only the JSON Lines where the image is labeled. Specify false to get only the JSON Lines where the image isn't labeled. If you don't specify Labeled, list_dataset_entries returns JSON Lines for labeled and unlabeled images.

SourceRefContains

If specified, list_dataset_entries only returns JSON Lines where the value of SourceRefContains is part of the source-ref field. The source-ref field contains the Amazon S3 location of the image. You can use SouceRefContains for tasks such as getting the JSON Line for a single image, or gettting JSON Lines for all images within a specific folder.

HasErrors

Specifies an error filter for the response. Specify True to only include entries that have errors.

NextToken

If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

MaxResults

The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.

Value

A list with the following syntax: 

list(
  DatasetEntries = list(
    "string"
  ),
  NextToken = "string"
)

Request syntax

svc$list_dataset_entries(
  DatasetArn = "string",
  ContainsLabels = list(
    "string"
  ),
  Labeled = TRUE|FALSE,
  SourceRefContains = "string",
  HasErrors = TRUE|FALSE,
  NextToken = "string",
  MaxResults = 123
)

Examples

## Not run: 
# Lists the JSON line entries in an Amazon Rekognition Custom Labels
# dataset.
svc$list_dataset_entries(
  ContainsLabels = list(
    "camellia"
  ),
  DatasetArn = "arn:aws:rekognition:us-east-1:111122223333:project/my-proj-...",
  HasErrors = TRUE,
  Labeled = TRUE,
  MaxResults = 100L,
  NextToken = "",
  SourceRefContains = "camellia4.jpg"
)

## End(Not run)