[ aws . finspace-data ]

get-dataset

Description

Returns information about a Dataset.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-dataset
--dataset-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--dataset-id (string)

The unique identifier for a Dataset.

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

datasetId -> (string)

The unique identifier for a Dataset.

datasetArn -> (string)

The ARN identifier of the Dataset.

datasetTitle -> (string)

Display title for a Dataset.

kind -> (string)

The format in which Dataset data is structured.

• TABULAR – Data is structured in a tabular format.

• NON_TABULAR – Data is structured in a non-tabular format.

datasetDescription -> (string)

A description of the Dataset.

createTime -> (long)

The timestamp at which the Dataset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

lastModifiedTime -> (long)

The last time that the Dataset was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

schemaDefinition -> (structure)

Definition for a schema on a tabular Dataset.

tabularSchemaConfig -> (structure)

The configuration for a schema on a tabular Dataset.

columns -> (list)

List of column definitions.

(structure)

The definition of a column in a tabular Dataset.

dataType -> (string)

Data type of a column.

• STRING – A String data type. CHAR – A char data type. INTEGER – An integer data type. TINYINT – A tinyint data type. SMALLINT – A smallint data type. BIGINT – A bigint data type. FLOAT – A float data type. DOUBLE – A double data type. DATE – A date data type. DATETIME – A datetime data type. BOOLEAN – A boolean data type. BINARY – A binary data type.

columnName -> (string)

The name of a column.

columnDescription -> (string)

Description for a column.

primaryKeyColumns -> (list)

List of column names used for primary key.

(string)

Column Name

alias -> (string)

The unique resource identifier for a Dataset.

status -> (string)

Status of the Dataset creation.

• PENDING – Dataset is pending creation.

• FAILED – Dataset creation has failed.

• SUCCESS – Dataset creation has succeeded.

• RUNNING – Dataset creation is running.