Describe Dataset

rekognition_describe_dataset

R Documentation

This operation applies only to Amazon Rekognition Custom Labels

Description

This operation applies only to Amazon Rekognition Custom Labels.

Describes an Amazon Rekognition Custom Labels dataset. You can get information such as the current status of a dataset and statistics about the images and labels in a dataset.

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

Usage

rekognition_describe_dataset(DatasetArn)

Arguments

DatasetArn

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

Value

A list with the following syntax:

list(
  DatasetDescription = list(
    CreationTimestamp = as.POSIXct(
      "2015-01-01"
    ),
    LastUpdatedTimestamp = as.POSIXct(
      "2015-01-01"
    ),
    Status = "CREATE_IN_PROGRESS"|"CREATE_COMPLETE"|"CREATE_FAILED"|"UPDATE_IN_PROGRESS"|"UPDATE_COMPLETE"|"UPDATE_FAILED"|"DELETE_IN_PROGRESS",
    StatusMessage = "string",
    StatusMessageCode = "SUCCESS"|"SERVICE_ERROR"|"CLIENT_ERROR",
    DatasetStats = list(
      LabeledEntries = 123,
      TotalEntries = 123,
      TotalLabels = 123,
      ErrorEntries = 123
    )
  )
)

Request syntax

svc$describe_dataset(
  DatasetArn = "string"
)

Examples

## Not run: 
# Describes an Amazon Rekognition Custom Labels dataset.
svc$describe_dataset(
  DatasetArn = "arn:aws:rekognition:us-east-1:111122223333:project/my-proje..."
)

## End(Not run)