[ aws . rekognition ]

describe-dataset

Description

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.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-dataset
--dataset-arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--dataset-arn (string)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

DatasetDescription -> (structure)

The description for the dataset.

CreationTimestamp -> (timestamp)

The Unix timestamp for the time and date that the dataset was created.

LastUpdatedTimestamp -> (timestamp)

The Unix timestamp for the date and time that the dataset was last updated.

Status -> (string)

The status of the dataset.

StatusMessage -> (string)

The status message for the dataset.

StatusMessageCode -> (string)

The status message code for the dataset operation. If a service error occurs, try the API call again later. If a client error occurs, check the input parameters to the dataset API call that failed.

DatasetStats -> (structure)

The status message code for the dataset.

LabeledEntries -> (integer)

The total number of images in the dataset that have labels.

TotalEntries -> (integer)

The total number of images in the dataset.

TotalLabels -> (integer)

The total number of labels declared in the dataset.

ErrorEntries -> (integer)

The total number of entries that contain at least one error.