[ aws . personalize ]

describe-dataset

Description

Describes the given dataset. For more information on datasets, see CreateDataset .

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 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

dataset -> (structure)

A listing of the dataset’s properties.

name -> (string)

The name of the dataset.

datasetArn -> (string)

The Amazon Resource Name (ARN) of the dataset that you want metadata for.

datasetGroupArn -> (string)

The Amazon Resource Name (ARN) of the dataset group.

datasetType -> (string)

One of the following values:

  • Interactions

  • Items

  • Users

schemaArn -> (string)

The ARN of the associated schema.

status -> (string)

The status of the dataset.

A dataset can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

creationDateTime -> (timestamp)

The creation date and time (in Unix time) of the dataset.

lastUpdatedDateTime -> (timestamp)

A time stamp that shows when the dataset was updated.