[ aws . finspace-data ]

create-data-view

Description

Creates a Dataview for a Dataset.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-data-view
[--client-token <value>]
--dataset-id <value>
[--auto-update | --no-auto-update]
[--sort-columns <value>]
[--partition-columns <value>]
[--as-of-timestamp <value>]
--destination-type-params <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--client-token (string)

A token that ensures idempotency. This token expires in 10 minutes.

--dataset-id (string)

The unique Dataset identifier that is used to create a Dataview.

--auto-update | --no-auto-update (boolean)

Flag to indicate Dataview should be updated automatically.

--sort-columns (list)

Columns to be used for sorting the data.

(string)

1 - 255 character String

Syntax:

"string" "string" ...

--partition-columns (list)

Ordered set of column names used to partition data.

(string)

1 - 255 character String

Syntax:

"string" "string" ...

--as-of-timestamp (long)

Beginning time to use for the Dataview. 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.

--destination-type-params (structure)

Options that define the destination type for the Dataview.

destinationType -> (string)

Destination type for a Dataview.

• GLUE_TABLE – Glue table destination type.

• S3 – S3 destination type.

s3DestinationExportFileFormat -> (string)

Dataview export file format.

• PARQUET – Parquet export file format.

• DELIMITED_TEXT – Delimited text export file format.

s3DestinationExportFileFormatOptions -> (map)

Format Options for S3 Destination type.

Here is an example of how you could specify the s3DestinationExportFileFormatOptions

{ "header": "true", "delimiter": ",", "compression": "gzip" }

key -> (string)

value -> (string)

Shorthand Syntax:

destinationType=string,s3DestinationExportFileFormat=string,s3DestinationExportFileFormatOptions={KeyName1=string,KeyName2=string}

JSON Syntax:

{
  "destinationType": "string",
  "s3DestinationExportFileFormat": "PARQUET"|"DELIMITED_TEXT",
  "s3DestinationExportFileFormatOptions": {"string": "string"
    ...}
}

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

datasetId -> (string)

The unique identifier of the Dataset used for the Dataview.

dataViewId -> (string)

The unique identifier for the created Dataview.