[ aws . finspace-data ]

list-datasets

Description

Lists all of the active Datasets that a user has access to.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-datasets is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: datasets

Synopsis

  list-datasets
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

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

datasets -> (list)

List of Datasets.

(structure)

The structure for a Dataset.

datasetId -> (string)

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

Description for a Dataset.

ownerInfo -> (structure)

Contact information for a Dataset owner.

name -> (string)

Name of the Dataset owner.

phoneNumber -> (string)

Phone number for the Dataset owner.

email -> (string)

Email address for the Dataset owner.

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)

Name for 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.

nextToken -> (string)

A token indicating where a results page should begin.