Skip to content

List Dataset Labels

rekognition_list_dataset_labels R Documentation

This operation applies only to Amazon Rekognition Custom Labels

Description

This operation applies only to Amazon Rekognition Custom Labels.

Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to describe images. For more information, see Labeling images.

Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to describe images. For more information, see Labeling images in the Amazon Rekognition Custom Labels Developer Guide.

Usage

rekognition_list_dataset_labels(DatasetArn, NextToken, MaxResults)

Arguments

DatasetArn

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

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(
  DatasetLabelDescriptions = list(
    list(
      LabelName = "string",
      LabelStats = list(
        EntryCount = 123,
        BoundingBoxCount = 123
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_dataset_labels(
  DatasetArn = "string",
  NextToken = "string",
  MaxResults = 123
)

Examples

## Not run: 
# Lists the JSON line entries in an Amazon Rekognition Custom Labels
# dataset.
svc$list_dataset_labels(
  DatasetArn = "arn:aws:rekognition:us-east-1:111122223333:project/my-proj-...",
  MaxResults = 100L,
  NextToken = ""
)

## End(Not run)