[ aws . finspace-data ]

create-changeset

Description

Creates a new Changeset in a FinSpace Dataset.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-changeset
[--client-token <value>]
--dataset-id <value>
--change-type <value>
--source-params <value>
--format-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 identifier for the FinSpace Dataset where the Changeset will be created.

--change-type (string)

The option to indicate how a Changeset will be applied to a Dataset.

• REPLACE – Changeset will be considered as a replacement to all prior loaded Changesets.

• APPEND – Changeset will be considered as an addition to the end of all prior loaded Changesets.

• MODIFY – Changeset is considered as a replacement to a specific prior ingested Changeset.

Possible values:

• REPLACE

• APPEND

• MODIFY

--source-params (map)

Options that define the location of the data being ingested (s3SourcePath ) and the source of the changeset (sourceType ).

Both s3SourcePath and sourceType are required attributes.

Here is an example of how you could specify the sourceParams :

"sourceParams": { "s3SourcePath": "s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv", "sourceType": "S3" }

The S3 path that you specify must allow the FinSpace role access. To do that, you first need to configure the IAM policy on S3 bucket. For more information, see Loading data from an Amazon S3 Bucket using the FinSpace API section.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--format-params (map)

Options that define the structure of the source file(s) including the format type (formatType ), header row (withHeader ), data separation character (separator ) and the type of compression (compression ).

formatType is a required attribute and can have the following values:

• PARQUET – Parquet source file format.

• CSV – CSV source file format.

• JSON – JSON source file format.

• XML – XML source file format.

Here is an example of how you could specify the formatParams :

"formatParams": { "formatType": "CSV", "withHeader": "true", "separator": ",", "compression":"None" }

Note that if you only provide formatType as CSV , the rest of the attributes will automatically default to CSV values as following:

{ "withHeader": "true", "separator": "," }

For more information about supported file formats, see Supported Data Types and File Formats in the FinSpace User Guide.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"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 for the FinSpace Dataset where the Changeset is created.

changesetId -> (string)

The unique identifier of the Changeset that is created.